Skip to content

Commit 0d3e999

Browse files
Update typescript definitions
1 parent e211be4 commit 0d3e999

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/diffbot.d.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ declare class Diffbot {
2222
* @param {string} [options.proxy] Used to specify the IP address of a custom proxy that will be used to fetch the target page, instead of Diffbot's default IPs/proxies. (Ex: &proxy=168.212.226.204)
2323
* @param {string} [options.proxyAuth] Used to specify the authentication parameters that will be used with the proxy specified in the &proxy parameter. (Ex: &proxyAuth=username:password)
2424
* @param {string} [options.body] Optional HTML markup to pass as POST body
25+
* @param {string} [options.customJS] This functionality is currently in beta. See docs for details: https://docs.diffbot.com/docs/en/api-analyze#custom-javascript
2526
* @returns {Object} The analyze query results
2627
*/
2728
analyze(options: {
@@ -36,6 +37,7 @@ declare class Diffbot {
3637
proxy?: string;
3738
proxyAuth?: string;
3839
body?: string;
40+
customJS?: string;
3941
}): any;
4042
/**
4143
* Execute an article API call
@@ -52,6 +54,7 @@ declare class Diffbot {
5254
* @param {string} [options.proxyAuth] Used to specify the authentication parameters that will be used with the proxy specified in the &proxy parameter. (Ex: &proxyAuth=username:password)
5355
* @param {string[]} [options.naturalLanguage] Used to request the output of the Diffbot Natural Language API in the field naturalLanguage. Example: &naturalLanguage=entities,facts,categories,sentiment.
5456
* @param {string} [options.body] Optional HTML markup to pass as POST body
57+
* @param {string} [options.customJS] This functionality is currently in beta. See docs for details: https://docs.diffbot.com/docs/en/api-article#custom-javascript
5558
* @returns {Object} The article query results
5659
*/
5760
article(options: {
@@ -67,6 +70,7 @@ declare class Diffbot {
6770
proxyAuth?: string;
6871
naturalLanguage?: string[];
6972
body?: string;
73+
customJS?: string;
7074
}): any;
7175
/**
7276
* Execute a discussion API call
@@ -79,6 +83,7 @@ declare class Diffbot {
7983
* @param {string} [options.proxy] Used to specify the IP address of a custom proxy that will be used to fetch the target page, instead of Diffbot's default IPs/proxies. (Ex: &proxy=168.212.226.204)
8084
* @param {string} [options.proxyAuth] Used to specify the authentication parameters that will be used with the proxy specified in the &proxy parameter. (Ex: &proxyAuth=username:password)
8185
* @param {string} [options.body] Optional HTML markup to pass as POST body
86+
* @param {string} [options.customJS] This functionality is currently in beta. See docs for details: https://docs.diffbot.com/docs/en/api-discussion#custom-javascript
8287
* @returns {Object} The discussion query results
8388
*/
8489
discussion(options: {
@@ -90,6 +95,7 @@ declare class Diffbot {
9095
proxy?: string;
9196
proxyAuth?: string;
9297
body?: string;
98+
customJS?: string;
9399
}): any;
94100
/**
95101
* Execute an event API call
@@ -124,6 +130,7 @@ declare class Diffbot {
124130
* @param {string} [options.proxy] Used to specify the IP address of a custom proxy that will be used to fetch the target page, instead of Diffbot's default IPs/proxies. (Ex: &proxy=168.212.226.204)
125131
* @param {string} [options.proxyAuth] Used to specify the authentication parameters that will be used with the proxy specified in the &proxy parameter. (Ex: &proxyAuth=username:password)
126132
* @param {string} [options.body] Optional HTML markup to pass as POST body
133+
* @param {string} [options.customJS] This functionality is currently in beta. See docs for details: https://docs.diffbot.com/docs/en/api-image#custom-javascript
127134
* @returns {Object} The image query results
128135
*/
129136
image(options: {
@@ -134,6 +141,7 @@ declare class Diffbot {
134141
proxy?: string;
135142
proxyAuth?: string;
136143
body?: string;
144+
customJS?: string;
137145
}): any;
138146
/**
139147
* Execute a product API call
@@ -146,6 +154,7 @@ declare class Diffbot {
146154
* @param {string} [options.proxy] Used to specify the IP address of a custom proxy that will be used to fetch the target page, instead of Diffbot's default IPs/proxies. (Ex: &proxy=168.212.226.204)
147155
* @param {string} [options.proxyAuth] Used to specify the authentication parameters that will be used with the proxy specified in the &proxy parameter. (Ex: &proxyAuth=username:password)
148156
* @param {string} [options.body] Optional HTML markup to pass as POST body
157+
* @param {string} [options.customJS] This functionality is currently in beta. See docs for details: https://docs.diffbot.com/docs/en/api-product#custom-javascript
149158
* @returns {Object} The product query results
150159
*/
151160
product(options: {
@@ -157,6 +166,7 @@ declare class Diffbot {
157166
proxy?: string;
158167
proxyAuth?: string;
159168
body?: string;
169+
customJS?: string;
160170
}): any;
161171
/**
162172
* Execute a video API call
@@ -168,6 +178,7 @@ declare class Diffbot {
168178
* @param {string} [options.proxy] Used to specify the IP address of a custom proxy that will be used to fetch the target page, instead of Diffbot's default IPs/proxies. (Ex: &proxy=168.212.226.204)
169179
* @param {string} [options.proxyAuth] Used to specify the authentication parameters that will be used with the proxy specified in the &proxy parameter. (Ex: &proxyAuth=username:password)
170180
* @param {string} [options.body] Optional HTML markup to pass as POST body
181+
* @param {string} [options.customJS] This functionality is currently in beta. See docs for details: https://docs.diffbot.com/docs/en/api-video#custom-javascript
171182
* @returns {Object} The video query results
172183
*/
173184
video(options: {
@@ -178,6 +189,7 @@ declare class Diffbot {
178189
proxy?: string;
179190
proxyAuth?: string;
180191
body?: string;
192+
customJS?: string;
181193
}): any;
182194
/**
183195
* Execute a query against the Knowledge Graph

0 commit comments

Comments
 (0)