apify-client 2.20.1-beta.7 → 2.20.1-beta.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apify_client.d.ts +237 -25
- package/dist/apify_client.d.ts.map +1 -1
- package/dist/apify_client.js +234 -25
- package/dist/apify_client.js.map +1 -1
- package/dist/bundle.js +2042 -253
- package/dist/bundle.js.map +1 -1
- package/dist/resource_clients/actor.d.ts +322 -31
- package/dist/resource_clients/actor.d.ts.map +1 -1
- package/dist/resource_clients/actor.js +167 -19
- package/dist/resource_clients/actor.js.map +1 -1
- package/dist/resource_clients/actor_collection.d.ts +34 -3
- package/dist/resource_clients/actor_collection.d.ts.map +1 -1
- package/dist/resource_clients/actor_collection.js +34 -3
- package/dist/resource_clients/actor_collection.js.map +1 -1
- package/dist/resource_clients/actor_env_var.d.ts +34 -3
- package/dist/resource_clients/actor_env_var.d.ts.map +1 -1
- package/dist/resource_clients/actor_env_var.js +34 -3
- package/dist/resource_clients/actor_env_var.js.map +1 -1
- package/dist/resource_clients/actor_env_var_collection.d.ts +37 -3
- package/dist/resource_clients/actor_env_var_collection.d.ts.map +1 -1
- package/dist/resource_clients/actor_env_var_collection.js +37 -3
- package/dist/resource_clients/actor_env_var_collection.js.map +1 -1
- package/dist/resource_clients/actor_version.d.ts +42 -6
- package/dist/resource_clients/actor_version.d.ts.map +1 -1
- package/dist/resource_clients/actor_version.js +42 -6
- package/dist/resource_clients/actor_version.js.map +1 -1
- package/dist/resource_clients/actor_version_collection.d.ts +35 -3
- package/dist/resource_clients/actor_version_collection.d.ts.map +1 -1
- package/dist/resource_clients/actor_version_collection.js +35 -3
- package/dist/resource_clients/actor_version_collection.js.map +1 -1
- package/dist/resource_clients/build.d.ts +123 -11
- package/dist/resource_clients/build.d.ts.map +1 -1
- package/dist/resource_clients/build.js +93 -11
- package/dist/resource_clients/build.js.map +1 -1
- package/dist/resource_clients/build_collection.d.ts +27 -2
- package/dist/resource_clients/build_collection.d.ts.map +1 -1
- package/dist/resource_clients/build_collection.js +27 -2
- package/dist/resource_clients/build_collection.js.map +1 -1
- package/dist/resource_clients/dataset.d.ts +221 -15
- package/dist/resource_clients/dataset.d.ts.map +1 -1
- package/dist/resource_clients/dataset.js +185 -15
- package/dist/resource_clients/dataset.js.map +1 -1
- package/dist/resource_clients/dataset_collection.d.ts +32 -3
- package/dist/resource_clients/dataset_collection.d.ts.map +1 -1
- package/dist/resource_clients/dataset_collection.js +32 -3
- package/dist/resource_clients/dataset_collection.js.map +1 -1
- package/dist/resource_clients/key_value_store.d.ts +219 -26
- package/dist/resource_clients/key_value_store.d.ts.map +1 -1
- package/dist/resource_clients/key_value_store.js +172 -25
- package/dist/resource_clients/key_value_store.js.map +1 -1
- package/dist/resource_clients/key_value_store_collection.d.ts +32 -3
- package/dist/resource_clients/key_value_store_collection.d.ts.map +1 -1
- package/dist/resource_clients/key_value_store_collection.js +32 -3
- package/dist/resource_clients/key_value_store_collection.js.map +1 -1
- package/dist/resource_clients/log.d.ts +34 -3
- package/dist/resource_clients/log.d.ts.map +1 -1
- package/dist/resource_clients/log.js +34 -3
- package/dist/resource_clients/log.js.map +1 -1
- package/dist/resource_clients/request_queue.d.ts +290 -19
- package/dist/resource_clients/request_queue.d.ts.map +1 -1
- package/dist/resource_clients/request_queue.js +233 -19
- package/dist/resource_clients/request_queue.js.map +1 -1
- package/dist/resource_clients/request_queue_collection.d.ts +31 -3
- package/dist/resource_clients/request_queue_collection.d.ts.map +1 -1
- package/dist/resource_clients/request_queue_collection.js +31 -3
- package/dist/resource_clients/request_queue_collection.js.map +1 -1
- package/dist/resource_clients/run.d.ts +224 -27
- package/dist/resource_clients/run.d.ts.map +1 -1
- package/dist/resource_clients/run.js +200 -27
- package/dist/resource_clients/run.js.map +1 -1
- package/dist/resource_clients/run_collection.d.ts +27 -2
- package/dist/resource_clients/run_collection.d.ts.map +1 -1
- package/dist/resource_clients/run_collection.js +27 -2
- package/dist/resource_clients/run_collection.js.map +1 -1
- package/dist/resource_clients/schedule.d.ts +65 -4
- package/dist/resource_clients/schedule.d.ts.map +1 -1
- package/dist/resource_clients/schedule.js +42 -4
- package/dist/resource_clients/schedule.js.map +1 -1
- package/dist/resource_clients/schedule_collection.d.ts +35 -3
- package/dist/resource_clients/schedule_collection.d.ts.map +1 -1
- package/dist/resource_clients/schedule_collection.js +35 -3
- package/dist/resource_clients/schedule_collection.js.map +1 -1
- package/dist/resource_clients/store_collection.d.ts +26 -2
- package/dist/resource_clients/store_collection.d.ts.map +1 -1
- package/dist/resource_clients/store_collection.js +26 -2
- package/dist/resource_clients/store_collection.js.map +1 -1
- package/dist/resource_clients/task.d.ts +110 -11
- package/dist/resource_clients/task.d.ts.map +1 -1
- package/dist/resource_clients/task.js +83 -11
- package/dist/resource_clients/task.js.map +1 -1
- package/dist/resource_clients/task_collection.d.ts +35 -8
- package/dist/resource_clients/task_collection.d.ts.map +1 -1
- package/dist/resource_clients/task_collection.js +35 -8
- package/dist/resource_clients/task_collection.js.map +1 -1
- package/dist/resource_clients/user.d.ts +41 -4
- package/dist/resource_clients/user.d.ts.map +1 -1
- package/dist/resource_clients/user.js +41 -4
- package/dist/resource_clients/user.js.map +1 -1
- package/dist/resource_clients/webhook.d.ts +66 -5
- package/dist/resource_clients/webhook.d.ts.map +1 -1
- package/dist/resource_clients/webhook.js +48 -5
- package/dist/resource_clients/webhook.js.map +1 -1
- package/dist/resource_clients/webhook_collection.d.ts +34 -3
- package/dist/resource_clients/webhook_collection.d.ts.map +1 -1
- package/dist/resource_clients/webhook_collection.js +34 -3
- package/dist/resource_clients/webhook_collection.js.map +1 -1
- package/dist/resource_clients/webhook_dispatch.d.ts +22 -1
- package/dist/resource_clients/webhook_dispatch.d.ts.map +1 -1
- package/dist/resource_clients/webhook_dispatch.js +22 -1
- package/dist/resource_clients/webhook_dispatch.js.map +1 -1
- package/dist/resource_clients/webhook_dispatch_collection.d.ts +24 -2
- package/dist/resource_clients/webhook_dispatch_collection.d.ts.map +1 -1
- package/dist/resource_clients/webhook_dispatch_collection.js +24 -2
- package/dist/resource_clients/webhook_dispatch_collection.js.map +1 -1
- package/dist/utils.d.ts +42 -0
- package/dist/utils.d.ts.map +1 -1
- package/dist/utils.js.map +1 -1
- package/package.json +1 -1
package/dist/apify_client.d.ts
CHANGED
|
@@ -28,8 +28,25 @@ import { WebhookDispatchClient } from './resource_clients/webhook_dispatch';
|
|
|
28
28
|
import { WebhookDispatchCollectionClient } from './resource_clients/webhook_dispatch_collection';
|
|
29
29
|
import { Statistics } from './statistics';
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* The official JavaScript client for the Apify API.
|
|
32
|
+
*
|
|
33
|
+
* Provides programmatic access to all Apify platform resources including Actors, runs, datasets,
|
|
34
|
+
* key-value stores, request queues, and more. Works in both Node.js and browser environments.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* ```javascript
|
|
38
|
+
* import { ApifyClient } from 'apify-client';
|
|
39
|
+
*
|
|
40
|
+
* const client = new ApifyClient({ token: 'my-token' });
|
|
41
|
+
*
|
|
42
|
+
* // Start an Actor and wait for it to finish
|
|
43
|
+
* const run = await client.actor('my-actor-id').call();
|
|
44
|
+
*
|
|
45
|
+
* // Fetch dataset items
|
|
46
|
+
* const { items } = await client.dataset(run.defaultDatasetId).listItems();
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @see https://docs.apify.com/api/v2
|
|
33
50
|
*/
|
|
34
51
|
export declare class ApifyClient {
|
|
35
52
|
baseUrl: string;
|
|
@@ -41,99 +58,294 @@ export declare class ApifyClient {
|
|
|
41
58
|
constructor(options?: ApifyClientOptions);
|
|
42
59
|
private _options;
|
|
43
60
|
/**
|
|
44
|
-
*
|
|
61
|
+
* Returns a client for managing Actors in your account.
|
|
62
|
+
*
|
|
63
|
+
* Provides access to the Actor collection, allowing you to list, create, and search for Actors.
|
|
64
|
+
*
|
|
65
|
+
* @returns A client for the Actors collection
|
|
66
|
+
* @see https://docs.apify.com/api/v2/acts-get
|
|
45
67
|
*/
|
|
46
68
|
actors(): ActorCollectionClient;
|
|
47
69
|
/**
|
|
48
|
-
*
|
|
70
|
+
* Returns a client for a specific Actor.
|
|
71
|
+
*
|
|
72
|
+
* Use this to get, update, delete, start, or call an Actor, as well as manage its builds,
|
|
73
|
+
* runs, versions, and webhooks.
|
|
74
|
+
*
|
|
75
|
+
* @param id - Actor ID or username/name
|
|
76
|
+
* @returns A client for the specific Actor
|
|
77
|
+
* @see https://docs.apify.com/api/v2/act-get
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```javascript
|
|
81
|
+
* // Call an Actor and wait for it to finish
|
|
82
|
+
* const run = await client.actor('apify/web-scraper').call({ url: 'https://example.com' });
|
|
83
|
+
* ```
|
|
49
84
|
*/
|
|
50
85
|
actor(id: string): ActorClient;
|
|
51
86
|
/**
|
|
52
|
-
*
|
|
87
|
+
* Returns a client for managing Actor builds in your account.
|
|
88
|
+
*
|
|
89
|
+
* Lists all builds across all of your Actors.
|
|
90
|
+
*
|
|
91
|
+
* @returns A client for Actor builds collection
|
|
92
|
+
* @see https://docs.apify.com/api/v2/actor-builds-get
|
|
53
93
|
*/
|
|
54
94
|
builds(): BuildCollectionClient;
|
|
55
95
|
/**
|
|
56
|
-
*
|
|
96
|
+
* Returns a client for a specific Actor build.
|
|
97
|
+
*
|
|
98
|
+
* Use this to get details about a build, wait for it to finish, or access its logs.
|
|
99
|
+
*
|
|
100
|
+
* @param id - Build ID
|
|
101
|
+
* @returns A client for the specified build
|
|
102
|
+
* @see https://docs.apify.com/api/v2/actor-build-get
|
|
57
103
|
*/
|
|
58
104
|
build(id: string): BuildClient;
|
|
59
105
|
/**
|
|
60
|
-
*
|
|
106
|
+
* Returns a client for managing datasets in your account.
|
|
107
|
+
*
|
|
108
|
+
* Datasets store structured data results from Actor runs. Use this to list or create datasets.
|
|
109
|
+
*
|
|
110
|
+
* @returns A client for the Datasets collection
|
|
111
|
+
* @see https://docs.apify.com/api/v2/datasets-get
|
|
61
112
|
*/
|
|
62
113
|
datasets(): DatasetCollectionClient;
|
|
63
114
|
/**
|
|
64
|
-
*
|
|
115
|
+
* Returns a client for a specific dataset.
|
|
116
|
+
*
|
|
117
|
+
* Use this to read, write, and manage items in the dataset. Datasets contain structured
|
|
118
|
+
* data stored as individual items (records).
|
|
119
|
+
*
|
|
120
|
+
* @template Data - Type of items stored in the dataset
|
|
121
|
+
* @param id - Dataset ID or name
|
|
122
|
+
* @returns A client for the specific Dataset
|
|
123
|
+
* @see https://docs.apify.com/api/v2/dataset-get
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* ```javascript
|
|
127
|
+
* // Push items to a dataset
|
|
128
|
+
* await client.dataset('my-dataset').pushItems([
|
|
129
|
+
* { url: 'https://example.com', title: 'Example' },
|
|
130
|
+
* { url: 'https://test.com', title: 'Test' }
|
|
131
|
+
* ]);
|
|
132
|
+
*
|
|
133
|
+
* // Retrieve items
|
|
134
|
+
* const { items } = await client.dataset('my-dataset').listItems();
|
|
135
|
+
* ```
|
|
65
136
|
*/
|
|
66
137
|
dataset<Data extends Record<string | number, any> = Record<string | number, unknown>>(id: string): DatasetClient<Data>;
|
|
67
138
|
/**
|
|
68
|
-
*
|
|
139
|
+
* Returns a client for managing key-value stores in your account.
|
|
140
|
+
*
|
|
141
|
+
* Key-value stores are used to store arbitrary data records or files.
|
|
142
|
+
*
|
|
143
|
+
* @returns A client for the Key-value stores collection
|
|
144
|
+
* @see https://docs.apify.com/api/v2/key-value-stores-get
|
|
69
145
|
*/
|
|
70
146
|
keyValueStores(): KeyValueStoreCollectionClient;
|
|
71
147
|
/**
|
|
72
|
-
*
|
|
148
|
+
* Returns a client for a specific key-value store.
|
|
149
|
+
*
|
|
150
|
+
* Use this to read, write, and delete records in the store. Key-value stores can hold
|
|
151
|
+
* any type of data including text, JSON, images, and other files.
|
|
152
|
+
*
|
|
153
|
+
* @param id - Key-value store ID or name
|
|
154
|
+
* @returns A client for the specific key-value store
|
|
155
|
+
* @see https://docs.apify.com/api/v2/key-value-store-get
|
|
156
|
+
*
|
|
157
|
+
* @example
|
|
158
|
+
* ```javascript
|
|
159
|
+
* // Save a record
|
|
160
|
+
* await client.keyValueStore('my-store').setRecord({ key: 'OUTPUT', value: { foo: 'bar' } });
|
|
161
|
+
*
|
|
162
|
+
* // Get a record
|
|
163
|
+
* const record = await client.keyValueStore('my-store').getRecord('OUTPUT');
|
|
164
|
+
* ```
|
|
73
165
|
*/
|
|
74
166
|
keyValueStore(id: string): KeyValueStoreClient;
|
|
75
167
|
/**
|
|
76
|
-
*
|
|
168
|
+
* Returns a client for accessing logs of an Actor build or run.
|
|
169
|
+
*
|
|
170
|
+
* @param buildOrRunId - Build ID or run ID
|
|
171
|
+
* @returns A client for accessing logs
|
|
172
|
+
* @see https://docs.apify.com/api/v2/log-get
|
|
77
173
|
*/
|
|
78
174
|
log(buildOrRunId: string): LogClient;
|
|
79
175
|
/**
|
|
80
|
-
*
|
|
176
|
+
* Returns a client for managing request queues in your account.
|
|
177
|
+
*
|
|
178
|
+
* Request queues store URLs to be crawled, along with their metadata.
|
|
179
|
+
*
|
|
180
|
+
* @returns A client for the Request queues collection
|
|
181
|
+
* @see https://docs.apify.com/api/v2/request-queues-get
|
|
81
182
|
*/
|
|
82
183
|
requestQueues(): RequestQueueCollectionClient;
|
|
83
184
|
/**
|
|
84
|
-
*
|
|
185
|
+
* Returns a client for a specific request queue.
|
|
186
|
+
*
|
|
187
|
+
* Use this to add, retrieve, and manage requests in the queue. Request queues are used
|
|
188
|
+
* by web crawlers to manage URLs that need to be visited.
|
|
189
|
+
*
|
|
190
|
+
* @param id - Request queue ID or name
|
|
191
|
+
* @param options - Configuration options for the request queue client
|
|
192
|
+
* @returns A client for the specific Request queue
|
|
193
|
+
* @see https://docs.apify.com/api/v2/request-queue-get
|
|
194
|
+
*
|
|
195
|
+
* @example
|
|
196
|
+
* ```javascript
|
|
197
|
+
* // Add requests to a queue
|
|
198
|
+
* const queue = client.requestQueue('my-queue');
|
|
199
|
+
* await queue.addRequest({ url: 'https://example.com', uniqueKey: 'example' });
|
|
200
|
+
*
|
|
201
|
+
* // Get and lock the next request
|
|
202
|
+
* const { items } = await queue.listAndLockHead({ lockSecs: 60 });
|
|
203
|
+
* ```
|
|
85
204
|
*/
|
|
86
205
|
requestQueue(id: string, options?: RequestQueueUserOptions): RequestQueueClient;
|
|
87
206
|
/**
|
|
88
|
-
*
|
|
207
|
+
* Returns a client for managing Actor runs in your account.
|
|
208
|
+
*
|
|
209
|
+
* Lists all runs across all of your Actors.
|
|
210
|
+
*
|
|
211
|
+
* @returns A client for the run collection
|
|
212
|
+
* @see https://docs.apify.com/api/v2/actor-runs-get
|
|
89
213
|
*/
|
|
90
214
|
runs(): RunCollectionClient;
|
|
91
215
|
/**
|
|
92
|
-
*
|
|
216
|
+
* Returns a client for a specific Actor run.
|
|
217
|
+
*
|
|
218
|
+
* Use this to get details about a run, wait for it to finish, abort it, or access its
|
|
219
|
+
* dataset, key-value store, and request queue.
|
|
220
|
+
*
|
|
221
|
+
* @param id - Run ID
|
|
222
|
+
* @returns A client for the specified run
|
|
223
|
+
* @see https://docs.apify.com/api/v2/actor-run-get
|
|
224
|
+
*
|
|
225
|
+
* @example
|
|
226
|
+
* ```javascript
|
|
227
|
+
* // Wait for a run to finish
|
|
228
|
+
* const run = await client.run('run-id').waitForFinish();
|
|
229
|
+
*
|
|
230
|
+
* // Access run's dataset
|
|
231
|
+
* const { items } = await client.run('run-id').dataset().listItems();
|
|
232
|
+
* ```
|
|
93
233
|
*/
|
|
94
234
|
run(id: string): RunClient;
|
|
95
235
|
/**
|
|
96
|
-
*
|
|
236
|
+
* Returns a client for managing Actor tasks in your account.
|
|
237
|
+
*
|
|
238
|
+
* Tasks are pre-configured Actor runs with stored input that can be executed repeatedly.
|
|
239
|
+
*
|
|
240
|
+
* @returns A client for the task collection
|
|
241
|
+
* @see https://docs.apify.com/api/v2/actor-tasks-get
|
|
97
242
|
*/
|
|
98
243
|
tasks(): TaskCollectionClient;
|
|
99
244
|
/**
|
|
100
|
-
*
|
|
245
|
+
* Returns a client for a specific Actor task.
|
|
246
|
+
*
|
|
247
|
+
* Use this to get, update, delete, or run a task with pre-configured input.
|
|
248
|
+
*
|
|
249
|
+
* @param id - Task ID or username/task-name
|
|
250
|
+
* @returns A client for the specified task
|
|
251
|
+
* @see https://docs.apify.com/api/v2/actor-task-get
|
|
252
|
+
*
|
|
253
|
+
* @example
|
|
254
|
+
* ```javascript
|
|
255
|
+
* // Run a task and wait for it to finish
|
|
256
|
+
* const run = await client.task('my-task').call();
|
|
257
|
+
* ```
|
|
101
258
|
*/
|
|
102
259
|
task(id: string): TaskClient;
|
|
103
260
|
/**
|
|
104
|
-
*
|
|
261
|
+
* Returns a client for managing schedules in your account.
|
|
262
|
+
*
|
|
263
|
+
* Schedules automatically start Actor or task runs at specified times.
|
|
264
|
+
*
|
|
265
|
+
* @returns A client for the Schedules collection
|
|
266
|
+
* @see https://docs.apify.com/api/v2/schedules-get
|
|
105
267
|
*/
|
|
106
268
|
schedules(): ScheduleCollectionClient;
|
|
107
269
|
/**
|
|
108
|
-
*
|
|
270
|
+
* Returns a client for a specific schedule.
|
|
271
|
+
*
|
|
272
|
+
* Use this to get, update, or delete a schedule.
|
|
273
|
+
*
|
|
274
|
+
* @param id - Schedule ID
|
|
275
|
+
* @returns A client for the specific Schedule
|
|
276
|
+
* @see https://docs.apify.com/api/v2/schedule-get
|
|
109
277
|
*/
|
|
110
278
|
schedule(id: string): ScheduleClient;
|
|
111
279
|
/**
|
|
112
|
-
*
|
|
280
|
+
* Returns a client for accessing user data.
|
|
281
|
+
*
|
|
282
|
+
* By default, returns information about the current user (determined by the API token).
|
|
283
|
+
*
|
|
284
|
+
* @param id - User ID or username. Defaults to 'me' (current user)
|
|
285
|
+
* @returns A client for the user
|
|
286
|
+
* @see https://docs.apify.com/api/v2/user-get
|
|
113
287
|
*/
|
|
114
288
|
user(id?: string): UserClient;
|
|
115
289
|
/**
|
|
116
|
-
*
|
|
290
|
+
* Returns a client for managing webhooks in your account.
|
|
291
|
+
*
|
|
292
|
+
* Webhooks notify external services when specific events occur (e.g., Actor run finishes).
|
|
293
|
+
*
|
|
294
|
+
* @returns A client for the Webhooks collection
|
|
295
|
+
* @see https://docs.apify.com/api/v2/webhooks-get
|
|
117
296
|
*/
|
|
118
297
|
webhooks(): WebhookCollectionClient;
|
|
119
298
|
/**
|
|
120
|
-
*
|
|
299
|
+
* Returns a client for a specific webhook.
|
|
300
|
+
*
|
|
301
|
+
* Use this to get, update, delete, or test a webhook.
|
|
302
|
+
*
|
|
303
|
+
* @param id - Webhook ID
|
|
304
|
+
* @returns A client for the specific webhook
|
|
305
|
+
* @see https://docs.apify.com/api/v2/webhook-get
|
|
121
306
|
*/
|
|
122
307
|
webhook(id: string): WebhookClient;
|
|
123
308
|
/**
|
|
124
|
-
*
|
|
309
|
+
* Returns a client for viewing webhook dispatches in your account.
|
|
310
|
+
*
|
|
311
|
+
* Webhook dispatches represent individual invocations of webhooks.
|
|
312
|
+
*
|
|
313
|
+
* @returns A client for the webhook dispatches collection
|
|
314
|
+
* @see https://docs.apify.com/api/v2/webhook-dispatches-get
|
|
125
315
|
*/
|
|
126
316
|
webhookDispatches(): WebhookDispatchCollectionClient;
|
|
127
317
|
/**
|
|
128
|
-
*
|
|
318
|
+
* Returns a client for a specific webhook dispatch.
|
|
319
|
+
*
|
|
320
|
+
* @param id - Webhook dispatch ID
|
|
321
|
+
* @returns A client for the specific webhook dispatch
|
|
322
|
+
* @see https://docs.apify.com/api/v2/webhook-dispatch-get
|
|
129
323
|
*/
|
|
130
324
|
webhookDispatch(id: string): WebhookDispatchClient;
|
|
131
325
|
/**
|
|
132
|
-
*
|
|
326
|
+
* Returns a client for browsing Actors in Apify Store.
|
|
327
|
+
*
|
|
328
|
+
* Use this to search and retrieve information about public Actors.
|
|
329
|
+
*
|
|
330
|
+
* @returns A client for the Apify Store
|
|
331
|
+
* @see https://docs.apify.com/api/v2/store-actors-get
|
|
133
332
|
*/
|
|
134
333
|
store(): StoreCollectionClient;
|
|
334
|
+
/**
|
|
335
|
+
* Sets a status message for the current Actor run.
|
|
336
|
+
*
|
|
337
|
+
* This is a convenience method that updates the status message of the run specified by
|
|
338
|
+
* the `ACTOR_RUN_ID` environment variable. Only works when called from within an Actor run.
|
|
339
|
+
*
|
|
340
|
+
* @param message - The status message to set
|
|
341
|
+
* @param options - Additional options for the status message
|
|
342
|
+
* @throws {Error} If `ACTOR_RUN_ID` environment variable is not set
|
|
343
|
+
*/
|
|
135
344
|
setStatusMessage(message: string, options?: SetStatusMessageOptions): Promise<void>;
|
|
136
345
|
}
|
|
346
|
+
/**
|
|
347
|
+
* Configuration options for ApifyClient.
|
|
348
|
+
*/
|
|
137
349
|
export interface ApifyClientOptions {
|
|
138
350
|
/** @default https://api.apify.com */
|
|
139
351
|
baseUrl?: string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apify_client.d.ts","sourceRoot":"","sources":["../src/apify_client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAI9D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAGtC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,6BAA6B,EAAE,MAAM,+CAA+C,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,4BAA4B,EAAE,MAAM,6CAA6C,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,+BAA+B,EAAE,MAAM,gDAAgD,CAAC;AACjG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C
|
|
1
|
+
{"version":3,"file":"apify_client.d.ts","sourceRoot":"","sources":["../src/apify_client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAI9D,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAGtC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,EAAE,6BAA6B,EAAE,MAAM,+CAA+C,CAAC;AAC9F,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,4BAA4B,EAAE,MAAM,6CAA6C,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,+BAA+B,EAAE,MAAM,gDAAgD,CAAC;AACjG,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,WAAW;IACpB,OAAO,EAAE,MAAM,CAAC;IAEhB,aAAa,EAAE,MAAM,CAAC;IAEtB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,KAAK,EAAE,UAAU,CAAC;IAElB,MAAM,EAAE,GAAG,CAAC;IAEZ,UAAU,EAAE,UAAU,CAAC;gBAEX,OAAO,GAAE,kBAAuB;IA8C5C,OAAO,CAAC,QAAQ;IAShB;;;;;;;OAOG;IACH,MAAM,IAAI,qBAAqB;IAI/B;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW;IAS9B;;;;;;;OAOG;IACH,MAAM,IAAI,qBAAqB;IAI/B;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,WAAW;IAS9B;;;;;;;OAOG;IACH,QAAQ,IAAI,uBAAuB;IAInC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,OAAO,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAChF,EAAE,EAAE,MAAM,GACX,aAAa,CAAC,IAAI,CAAC;IAStB;;;;;;;OAOG;IACH,cAAc,IAAI,6BAA6B;IAI/C;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,mBAAmB;IAS9C;;;;;;OAMG;IACH,GAAG,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS;IASpC;;;;;;;OAOG;IACH,aAAa,IAAI,4BAA4B;IAI7C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,uBAA4B,GAAG,kBAAkB;IAiBnF;;;;;;;OAOG;IACH,IAAI,IAAI,mBAAmB;IAO3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS;IAS1B;;;;;;;OAOG;IACH,KAAK,IAAI,oBAAoB;IAI7B;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU;IAS5B;;;;;;;OAOG;IACH,SAAS,IAAI,wBAAwB;IAIrC;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc;IASpC;;;;;;;;OAQG;IACH,IAAI,CAAC,EAAE,SAA2B,GAAG,UAAU;IAS/C;;;;;;;OAOG;IACH,QAAQ,IAAI,uBAAuB;IAInC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,aAAa;IASlC;;;;;;;OAOG;IACH,iBAAiB,IAAI,+BAA+B;IAIpD;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB;IASlD;;;;;;;OAOG;IACH,KAAK,IAAI,qBAAqB;IAI9B;;;;;;;;;OASG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;CAU5F;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB;IACnB,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,kBAAkB;IAClB,mBAAmB,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACnD,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACvC"}
|