apify-client 3.0.0-beta.76 → 3.0.0-beta.78
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/bundle.js +10 -10
- package/dist/bundle.js.map +1 -1
- package/dist/generated/api.d.ts +1831 -320
- package/dist/generated/schemas.d.ts +1462 -119
- package/dist/generated/schemas.js +358 -41
- package/dist/models.d.ts +11 -61
- package/dist/schemas.d.ts +167 -0
- package/dist/schemas.js +7 -0
- package/package.json +2 -2
package/dist/generated/api.d.ts
CHANGED
|
@@ -81,7 +81,7 @@ export interface paths {
|
|
|
81
81
|
*
|
|
82
82
|
* To provide the authentication token, we recommend using the request's
|
|
83
83
|
* `Authorization` header, rather than the URL. For details,
|
|
84
|
-
* see [Authentication](https://docs.apify.com/api/v2
|
|
84
|
+
* see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
85
85
|
*
|
|
86
86
|
* ### Make an Actor public
|
|
87
87
|
*
|
|
@@ -150,15 +150,15 @@ export interface paths {
|
|
|
150
150
|
/**
|
|
151
151
|
* Get list of Actor versions
|
|
152
152
|
* @description Gets the list of versions of a specific Actor. The response is a JSON object
|
|
153
|
-
* with the list of
|
|
153
|
+
* with the list of `Version` objects, where each
|
|
154
154
|
* contains basic information about a single version.
|
|
155
155
|
*/
|
|
156
156
|
get: operations["actor_versions_get"];
|
|
157
157
|
put?: never;
|
|
158
158
|
/**
|
|
159
159
|
* Create Actor version
|
|
160
|
-
* @description Creates a version of an Actor using values specified in a
|
|
161
|
-
* object
|
|
160
|
+
* @description Creates a version of an Actor using values specified in a `Version`
|
|
161
|
+
* object passed as JSON in the POST
|
|
162
162
|
* payload.
|
|
163
163
|
*
|
|
164
164
|
* The request must specify `versionNumber` and `sourceType` parameters (as
|
|
@@ -166,8 +166,8 @@ export interface paths {
|
|
|
166
166
|
* header.
|
|
167
167
|
*
|
|
168
168
|
* Each `sourceType` requires its own additional properties to be passed to the
|
|
169
|
-
* JSON payload object. These are outlined in the
|
|
170
|
-
* object
|
|
169
|
+
* JSON payload object. These are outlined in the `Version`
|
|
170
|
+
* object table below and in more detail in
|
|
171
171
|
* the [Apify
|
|
172
172
|
* documentation](https://docs.apify.com/platform/actors/development/deployment/source-types).
|
|
173
173
|
*
|
|
@@ -184,8 +184,8 @@ export interface paths {
|
|
|
184
184
|
* }
|
|
185
185
|
* ```
|
|
186
186
|
*
|
|
187
|
-
* The response is the
|
|
188
|
-
* returned by the [Get version](
|
|
187
|
+
* The response is the `Version` object as
|
|
188
|
+
* returned by the [Get Actor version](https://docs.apify.com/api/v2/actor-version-get) endpoint.
|
|
189
189
|
*/
|
|
190
190
|
post: operations["actor_versions_post"];
|
|
191
191
|
delete?: never;
|
|
@@ -203,12 +203,12 @@ export interface paths {
|
|
|
203
203
|
};
|
|
204
204
|
/**
|
|
205
205
|
* Get Actor version
|
|
206
|
-
* @description Gets a
|
|
206
|
+
* @description Gets a `Version` object that contains all the details about a specific version of an Actor.
|
|
207
207
|
*/
|
|
208
208
|
get: operations["actor_version_get"];
|
|
209
209
|
/**
|
|
210
210
|
* Update Actor version
|
|
211
|
-
* @description Updates Actor version using values specified by a
|
|
211
|
+
* @description Updates Actor version using values specified by a `Version` object passed as JSON in the POST payload.
|
|
212
212
|
*
|
|
213
213
|
* If the object does not define a specific property, its value will not be
|
|
214
214
|
* updated.
|
|
@@ -217,17 +217,17 @@ export interface paths {
|
|
|
217
217
|
* header!
|
|
218
218
|
*
|
|
219
219
|
* When providing your API authentication token, we recommend using the
|
|
220
|
-
* request's `Authorization` header, rather than the URL.
|
|
221
|
-
*
|
|
220
|
+
* request's `Authorization` header, rather than the URL.
|
|
221
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
222
222
|
*
|
|
223
|
-
* The response is the
|
|
224
|
-
* returned by the [Get version](
|
|
223
|
+
* The response is the `Version` object as
|
|
224
|
+
* returned by the [Get Actor version](https://docs.apify.com/api/v2/actor-version-get) endpoint.
|
|
225
225
|
*/
|
|
226
226
|
put: operations["actor_version_put"];
|
|
227
227
|
/**
|
|
228
228
|
* Update Actor version (POST)
|
|
229
|
-
* @description Updates Actor version using values specified by a
|
|
230
|
-
* This endpoint is an alias for the [
|
|
229
|
+
* @description Updates Actor version using values specified by a `Version` object passed as JSON in the POST payload.
|
|
230
|
+
* This endpoint is an alias for the [Update Actor version](https://docs.apify.com/api/v2/actor-version-put) endpoint and behaves identically.
|
|
231
231
|
*/
|
|
232
232
|
post: operations["actor_version_post"];
|
|
233
233
|
/**
|
|
@@ -240,6 +240,33 @@ export interface paths {
|
|
|
240
240
|
patch?: never;
|
|
241
241
|
trace?: never;
|
|
242
242
|
};
|
|
243
|
+
"/v2/actors/{actorId}/versions/{versionNumber}/build-on-push": {
|
|
244
|
+
parameters: {
|
|
245
|
+
query?: never;
|
|
246
|
+
header?: never;
|
|
247
|
+
path?: never;
|
|
248
|
+
cookie?: never;
|
|
249
|
+
};
|
|
250
|
+
get?: never;
|
|
251
|
+
/**
|
|
252
|
+
* Update Actor version build on push
|
|
253
|
+
* @description Turns automatic builds on push on or off for an Actor version whose source is a git repository.
|
|
254
|
+
*
|
|
255
|
+
* Enabling registers a push webhook on the repository through the connected git account given by `providerId`, so
|
|
256
|
+
* that every push to the repository builds the version. Disabling turns the webhook off on GitHub, or removes it
|
|
257
|
+
* on GitLab and Bitbucket.
|
|
258
|
+
*
|
|
259
|
+
* You need write access to the Actor. The version must have its source type set to a git repository, and the
|
|
260
|
+
* connected account must have permission to manage the repository's webhooks.
|
|
261
|
+
*/
|
|
262
|
+
put: operations["actor_version_buildOnPush_put"];
|
|
263
|
+
post?: never;
|
|
264
|
+
delete?: never;
|
|
265
|
+
options?: never;
|
|
266
|
+
head?: never;
|
|
267
|
+
patch?: never;
|
|
268
|
+
trace?: never;
|
|
269
|
+
};
|
|
243
270
|
"/v2/actors/{actorId}/versions/{versionNumber}/env-vars": {
|
|
244
271
|
parameters: {
|
|
245
272
|
query?: never;
|
|
@@ -250,14 +277,14 @@ export interface paths {
|
|
|
250
277
|
/**
|
|
251
278
|
* Get list of environment variables of Actor version
|
|
252
279
|
* @description Gets the list of environment variables for a specific version of an Actor.
|
|
253
|
-
* The response is a JSON object with the list of
|
|
280
|
+
* The response is a JSON object with the list of `EnvVar` objects, where each contains basic information about a single environment variable.
|
|
254
281
|
*/
|
|
255
282
|
get: operations["actor_version_envVars_get"];
|
|
256
283
|
put?: never;
|
|
257
284
|
/**
|
|
258
285
|
* Create environment variable in Actor version
|
|
259
|
-
* @description Creates an environment variable of an Actor using values specified in
|
|
260
|
-
*
|
|
286
|
+
* @description Creates an environment variable of an Actor using values specified in an
|
|
287
|
+
* `EnvVar` object passed as
|
|
261
288
|
* JSON in the POST payload.
|
|
262
289
|
*
|
|
263
290
|
* The request must specify `name` and `value` parameters (as strings) in the
|
|
@@ -270,9 +297,8 @@ export interface paths {
|
|
|
270
297
|
* }
|
|
271
298
|
* ```
|
|
272
299
|
*
|
|
273
|
-
* The response is the
|
|
274
|
-
* object
|
|
275
|
-
* variable](#/reference/actors/environment-variable-object/get-environment-variable)
|
|
300
|
+
* The response is the `EnvVar`
|
|
301
|
+
* object as returned by the [Get environment variable of Actor version](https://docs.apify.com/api/v2/actor-version-env-var-get)
|
|
276
302
|
* endpoint.
|
|
277
303
|
*/
|
|
278
304
|
post: operations["actor_version_envVars_post"];
|
|
@@ -291,7 +317,7 @@ export interface paths {
|
|
|
291
317
|
};
|
|
292
318
|
/**
|
|
293
319
|
* Get environment variable of Actor version
|
|
294
|
-
* @description Gets
|
|
320
|
+
* @description Gets an `EnvVar` object that
|
|
295
321
|
* contains all the details about a specific environment variable of an Actor.
|
|
296
322
|
*
|
|
297
323
|
* If `isSecret` is set to `true`, then `value` will never be returned.
|
|
@@ -299,8 +325,8 @@ export interface paths {
|
|
|
299
325
|
get: operations["actor_version_envVar_get"];
|
|
300
326
|
/**
|
|
301
327
|
* Update environment variable in Actor version
|
|
302
|
-
* @description Updates Actor environment variable using values specified by
|
|
303
|
-
* object
|
|
328
|
+
* @description Updates Actor environment variable using values specified by an `EnvVar`
|
|
329
|
+
* object
|
|
304
330
|
* passed as JSON in the POST payload.
|
|
305
331
|
* If the object does not define a specific property, its value will not be
|
|
306
332
|
* updated.
|
|
@@ -309,20 +335,20 @@ export interface paths {
|
|
|
309
335
|
* header!
|
|
310
336
|
*
|
|
311
337
|
* When providing your API authentication token, we recommend using the
|
|
312
|
-
* request's `Authorization` header, rather than the URL.
|
|
313
|
-
*
|
|
338
|
+
* request's `Authorization` header, rather than the URL.
|
|
339
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
314
340
|
*
|
|
315
|
-
* The response is the
|
|
316
|
-
* [Get environment variable](
|
|
341
|
+
* The response is the `EnvVar` object as returned by the
|
|
342
|
+
* [Get environment variable of Actor version](https://docs.apify.com/api/v2/actor-version-env-var-get)
|
|
317
343
|
* endpoint.
|
|
318
344
|
*/
|
|
319
345
|
put: operations["actor_version_envVar_put"];
|
|
320
346
|
/**
|
|
321
347
|
* Update environment variable in Actor version (POST)
|
|
322
|
-
* @description Updates Actor environment variable using values specified by
|
|
323
|
-
* object
|
|
348
|
+
* @description Updates Actor environment variable using values specified by an `EnvVar`
|
|
349
|
+
* object
|
|
324
350
|
* passed as JSON in the POST payload.
|
|
325
|
-
* This endpoint is an alias for the [
|
|
351
|
+
* This endpoint is an alias for the [Update environment variable in Actor version](https://docs.apify.com/api/v2/actor-version-env-var-put) endpoint and behaves identically.
|
|
326
352
|
*/
|
|
327
353
|
post: operations["actor_version_envVar_post"];
|
|
328
354
|
/**
|
|
@@ -362,6 +388,31 @@ export interface paths {
|
|
|
362
388
|
patch?: never;
|
|
363
389
|
trace?: never;
|
|
364
390
|
};
|
|
391
|
+
"/v2/actors/{actorId}/oauth-connections": {
|
|
392
|
+
parameters: {
|
|
393
|
+
query?: never;
|
|
394
|
+
header?: never;
|
|
395
|
+
path?: never;
|
|
396
|
+
cookie?: never;
|
|
397
|
+
};
|
|
398
|
+
/**
|
|
399
|
+
* Get list of Actor OAuth connections
|
|
400
|
+
* @description Gets the OAuth connections configured on the Actor. Each connection defines an OAuth provider that users of the
|
|
401
|
+
* Actor can connect their accounts through. Only public credential fields are returned, never the client secret.
|
|
402
|
+
*
|
|
403
|
+
* An Actor has at most 5 connections, so the list is not paginated.
|
|
404
|
+
*
|
|
405
|
+
* You need read access to the Actor.
|
|
406
|
+
*/
|
|
407
|
+
get: operations["actor_oauthConnections_get"];
|
|
408
|
+
put?: never;
|
|
409
|
+
post?: never;
|
|
410
|
+
delete?: never;
|
|
411
|
+
options?: never;
|
|
412
|
+
head?: never;
|
|
413
|
+
patch?: never;
|
|
414
|
+
trace?: never;
|
|
415
|
+
};
|
|
365
416
|
"/v2/actors/{actorId}/builds": {
|
|
366
417
|
parameters: {
|
|
367
418
|
query?: never;
|
|
@@ -388,7 +439,7 @@ export interface paths {
|
|
|
388
439
|
* Build Actor
|
|
389
440
|
* @description Builds an Actor.
|
|
390
441
|
* The response is the build object as returned by the
|
|
391
|
-
* [Get build](
|
|
442
|
+
* [Get Actor build](https://docs.apify.com/api/v2/actor-build-get) endpoint.
|
|
392
443
|
*/
|
|
393
444
|
post: operations["actors_builds_post"];
|
|
394
445
|
delete?: never;
|
|
@@ -434,9 +485,9 @@ export interface paths {
|
|
|
434
485
|
* Get OpenAPI definition of Actor build
|
|
435
486
|
* @description Get the OpenAPI definition for Actor builds. Two similar endpoints are available:
|
|
436
487
|
*
|
|
437
|
-
* - [
|
|
488
|
+
* - [Get OpenAPI definition of Actor build](https://docs.apify.com/api/v2/actor-openapi-json-get) (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
|
|
438
489
|
*
|
|
439
|
-
* - [
|
|
490
|
+
* - [Get OpenAPI definition of Actor build](https://docs.apify.com/api/v2/actor-build-openapi-json-get) (`/v2/actor-builds/{buildId}/openapi.json`): Requires only `buildId`.
|
|
440
491
|
*
|
|
441
492
|
* Get the OpenAPI definition for a specific Actor build.
|
|
442
493
|
*
|
|
@@ -445,7 +496,7 @@ export interface paths {
|
|
|
445
496
|
*
|
|
446
497
|
* :::note
|
|
447
498
|
*
|
|
448
|
-
* You can also use the [
|
|
499
|
+
* You can also use the [Get OpenAPI definition of Actor build](https://docs.apify.com/api/v2/actor-build-openapi-json-get) endpoint (`/v2/actor-builds/{buildId}/openapi.json`) to get the OpenAPI definition for a build.
|
|
449
500
|
*
|
|
450
501
|
* :::
|
|
451
502
|
*/
|
|
@@ -498,7 +549,7 @@ export interface paths {
|
|
|
498
549
|
* Abort Actor build
|
|
499
550
|
* @deprecated
|
|
500
551
|
* @description **[DEPRECATED]** API endpoints related to build of the Actor were moved
|
|
501
|
-
* under new namespace
|
|
552
|
+
* under new namespace `actor-builds` ([Manage Actor builds](https://docs.apify.com/api/v2/actor-builds)). Aborts an
|
|
502
553
|
* Actor build and returns an object that contains all the details about the
|
|
503
554
|
* build.
|
|
504
555
|
*
|
|
@@ -545,18 +596,17 @@ export interface paths {
|
|
|
545
596
|
* The Actor is started with the default options; you can override them using
|
|
546
597
|
* various URL query parameters.
|
|
547
598
|
*
|
|
548
|
-
* The response is the Run object as returned by the [Get
|
|
549
|
-
* run](#/reference/actor-runs/run-object-and-its-storages/get-run) API
|
|
599
|
+
* The response is the Run object as returned by the [Get Actor run](https://docs.apify.com/api/v2/actor-run-get) API
|
|
550
600
|
* endpoint.
|
|
551
601
|
*
|
|
552
602
|
* If you want to wait for the run to finish and receive the actual output of
|
|
553
|
-
* the Actor as the response, please use
|
|
554
|
-
* synchronously](
|
|
555
|
-
* instead.
|
|
603
|
+
* the Actor as the response, please use the [Run Actor synchronously and get key-value store record](https://docs.apify.com/api/v2/actor-run-sync-post)
|
|
604
|
+
* or [Run Actor synchronously and get dataset items](https://docs.apify.com/api/v2/actor-run-sync-get-dataset-items-post)
|
|
605
|
+
* endpoint instead.
|
|
556
606
|
*
|
|
557
607
|
* To fetch the Actor run results that are typically stored in the default
|
|
558
608
|
* dataset, you'll need to pass the ID received in the `defaultDatasetId` field
|
|
559
|
-
* received in the response JSON to the [Get dataset items](
|
|
609
|
+
* received in the response JSON to the [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get)
|
|
560
610
|
* API endpoint.
|
|
561
611
|
*/
|
|
562
612
|
post: operations["actors_runs_post"];
|
|
@@ -592,8 +642,7 @@ export interface paths {
|
|
|
592
642
|
* If the connection breaks, you will not receive any information about the run
|
|
593
643
|
* and its status.
|
|
594
644
|
*
|
|
595
|
-
* To run the Actor asynchronously, use the [Run
|
|
596
|
-
* Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
|
|
645
|
+
* To run the Actor asynchronously, use the [Run Actor](https://docs.apify.com/api/v2/actors-runs-post) API endpoint instead.
|
|
597
646
|
*/
|
|
598
647
|
get: operations["actor_runSync_get"];
|
|
599
648
|
put?: never;
|
|
@@ -622,8 +671,7 @@ export interface paths {
|
|
|
622
671
|
* If the connection breaks, you will not receive any information about the run
|
|
623
672
|
* and its status.
|
|
624
673
|
*
|
|
625
|
-
* To run the Actor asynchronously, use the [Run
|
|
626
|
-
* Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
|
|
674
|
+
* To run the Actor asynchronously, use the [Run Actor](https://docs.apify.com/api/v2/actors-runs-post) API endpoint instead.
|
|
627
675
|
*/
|
|
628
676
|
post: operations["actor_runSync_post"];
|
|
629
677
|
delete?: never;
|
|
@@ -646,8 +694,7 @@ export interface paths {
|
|
|
646
694
|
* otherwise the API endpoint returns a timeout error.
|
|
647
695
|
* The Actor is not passed any input.
|
|
648
696
|
*
|
|
649
|
-
* It allows to send all possible options in parameters from [Get
|
|
650
|
-
* Items](#/reference/datasets/item-collection/get-items) API endpoint.
|
|
697
|
+
* It allows to send all possible options in parameters from [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get) API endpoint.
|
|
651
698
|
*
|
|
652
699
|
* Beware that it might be impossible to maintain an idle HTTP connection for a
|
|
653
700
|
* long period of time,
|
|
@@ -656,8 +703,7 @@ export interface paths {
|
|
|
656
703
|
* If the connection breaks, you will not receive any information about the run
|
|
657
704
|
* and its status.
|
|
658
705
|
*
|
|
659
|
-
* To run the Actor asynchronously, use the [Run
|
|
660
|
-
* Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
|
|
706
|
+
* To run the Actor asynchronously, use the [Run Actor](https://docs.apify.com/api/v2/actors-runs-post) API endpoint instead.
|
|
661
707
|
*/
|
|
662
708
|
get: operations["actor_runSyncGetDatasetItems_get"];
|
|
663
709
|
put?: never;
|
|
@@ -670,8 +716,7 @@ export interface paths {
|
|
|
670
716
|
* The HTTP response contains the Actors dataset items, while the format of
|
|
671
717
|
* items depends on specifying dataset items' `format` parameter.
|
|
672
718
|
*
|
|
673
|
-
* You can send all the same options in parameters as the [Get
|
|
674
|
-
* Items](#/reference/datasets/item-collection/get-items) API endpoint.
|
|
719
|
+
* You can send all the same options in parameters as the [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get) API endpoint.
|
|
675
720
|
*
|
|
676
721
|
* The Actor is started with the default options; you can override them using
|
|
677
722
|
* URL query parameters.
|
|
@@ -685,8 +730,7 @@ export interface paths {
|
|
|
685
730
|
* If the connection breaks, you will not receive any information about the run
|
|
686
731
|
* and its status.
|
|
687
732
|
*
|
|
688
|
-
* To run the Actor asynchronously, use the [Run
|
|
689
|
-
* Actor](#/reference/actors/run-collection/run-actor) API endpoint instead.
|
|
733
|
+
* To run the Actor asynchronously, use the [Run Actor](https://docs.apify.com/api/v2/actors-runs-post) API endpoint instead.
|
|
690
734
|
*/
|
|
691
735
|
post: operations["actor_runSyncGetDatasetItems_post"];
|
|
692
736
|
delete?: never;
|
|
@@ -731,7 +775,8 @@ export interface paths {
|
|
|
731
775
|
/**
|
|
732
776
|
* Resurrect Actor run
|
|
733
777
|
* @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
|
|
734
|
-
* new namespace
|
|
778
|
+
* new namespace `actor-runs`
|
|
779
|
+
* ([Manage Actor runs](https://docs.apify.com/api/v2/actor-runs)). Resurrects a finished
|
|
735
780
|
* Actor run and returns an object that contains all the details about the
|
|
736
781
|
* resurrected run.
|
|
737
782
|
*
|
|
@@ -771,17 +816,17 @@ export interface paths {
|
|
|
771
816
|
* Using the `status` query parameter you can ensure to only get a run with a certain status
|
|
772
817
|
* (e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means
|
|
773
818
|
* by which they were started (e.g. `origin=API`). The output of this endpoint and other query
|
|
774
|
-
* parameters are the same as in the [
|
|
819
|
+
* parameters are the same as in the [Get Actor run](https://docs.apify.com/api/v2/actor-run-get) endpoint.
|
|
775
820
|
*
|
|
776
821
|
* ##### Convenience endpoints for last Actor run
|
|
777
822
|
*
|
|
778
|
-
* * [
|
|
823
|
+
* * [Last Actor run's default dataset](https://docs.apify.com/api/v2/last-actor-runs-default-dataset)
|
|
779
824
|
*
|
|
780
|
-
* * [
|
|
825
|
+
* * [Last Actor run's default key-value store](https://docs.apify.com/api/v2/last-actor-runs-default-key-value-store)
|
|
781
826
|
*
|
|
782
|
-
* * [
|
|
827
|
+
* * [Last Actor run's default request queue](https://docs.apify.com/api/v2/last-actor-runs-default-request-queue)
|
|
783
828
|
*
|
|
784
|
-
* * [
|
|
829
|
+
* * [Last Actor run's log](https://docs.apify.com/api/v2/last-actor-runs-log)
|
|
785
830
|
*/
|
|
786
831
|
get: operations["actor_runs_last_get"];
|
|
787
832
|
put?: never;
|
|
@@ -1288,7 +1333,7 @@ export interface paths {
|
|
|
1288
1333
|
* @description Aborts the last run of the specified Actor and returns an object that
|
|
1289
1334
|
* contains all the details about the run.
|
|
1290
1335
|
*
|
|
1291
|
-
* This endpoint is a shortcut for [Abort run](
|
|
1336
|
+
* This endpoint is a shortcut for [Abort Actor run](https://docs.apify.com/api/v2/actor-run-abort-post)
|
|
1292
1337
|
* on the Actor's last run. Only runs that are starting or running are aborted.
|
|
1293
1338
|
* For runs with status `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call
|
|
1294
1339
|
* does nothing.
|
|
@@ -1314,7 +1359,7 @@ export interface paths {
|
|
|
1314
1359
|
* @description Transforms the last run of the specified Actor into a run of another Actor with
|
|
1315
1360
|
* a new input.
|
|
1316
1361
|
*
|
|
1317
|
-
* This endpoint is a shortcut for [Metamorph run](
|
|
1362
|
+
* This endpoint is a shortcut for [Metamorph Actor run](https://docs.apify.com/api/v2/actor-run-metamorph-post)
|
|
1318
1363
|
* on the Actor's last run.
|
|
1319
1364
|
*/
|
|
1320
1365
|
post: operations["actor_runs_last_metamorph_post"];
|
|
@@ -1338,7 +1383,7 @@ export interface paths {
|
|
|
1338
1383
|
* @description Reboots the last run of the specified Actor and returns an object that
|
|
1339
1384
|
* contains all the details about the rebooted run.
|
|
1340
1385
|
*
|
|
1341
|
-
* This endpoint is a shortcut for [Reboot run](
|
|
1386
|
+
* This endpoint is a shortcut for [Reboot Actor run](https://docs.apify.com/api/v2/actor-run-reboot-post)
|
|
1342
1387
|
* on the Actor's last run. Only runs with status `RUNNING` can be rebooted. The run's
|
|
1343
1388
|
* container will be restarted, so any data not persisted in the key-value store, dataset,
|
|
1344
1389
|
* or request queue will be lost.
|
|
@@ -1361,7 +1406,8 @@ export interface paths {
|
|
|
1361
1406
|
* Get Actor run
|
|
1362
1407
|
* @deprecated
|
|
1363
1408
|
* @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
|
|
1364
|
-
* new namespace
|
|
1409
|
+
* new namespace `actor-runs`
|
|
1410
|
+
* ([Manage Actor runs](https://docs.apify.com/api/v2/actor-runs)).
|
|
1365
1411
|
*
|
|
1366
1412
|
* Gets an object that contains all the details about a specific run of an Actor.
|
|
1367
1413
|
*
|
|
@@ -1395,7 +1441,8 @@ export interface paths {
|
|
|
1395
1441
|
* Abort Actor run
|
|
1396
1442
|
* @deprecated
|
|
1397
1443
|
* @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
|
|
1398
|
-
* new namespace
|
|
1444
|
+
* new namespace `actor-runs`
|
|
1445
|
+
* ([Manage Actor runs](https://docs.apify.com/api/v2/actor-runs)). Aborts an Actor run and
|
|
1399
1446
|
* returns an object that contains all the details about the run.
|
|
1400
1447
|
*
|
|
1401
1448
|
* Only runs that are starting or running are aborted. For runs with status
|
|
@@ -1421,7 +1468,8 @@ export interface paths {
|
|
|
1421
1468
|
* Metamorph Actor run
|
|
1422
1469
|
* @deprecated
|
|
1423
1470
|
* @description **[DEPRECATED]** API endpoints related to run of the Actor were moved under
|
|
1424
|
-
* new namespace
|
|
1471
|
+
* new namespace `actor-runs`
|
|
1472
|
+
* ([Manage Actor runs](https://docs.apify.com/api/v2/actor-runs)). Transforms an Actor run
|
|
1425
1473
|
* into a run of another Actor with a new input.
|
|
1426
1474
|
*
|
|
1427
1475
|
* This is useful if you want to use another Actor to finish the work
|
|
@@ -1566,14 +1614,14 @@ export interface paths {
|
|
|
1566
1614
|
* If the object does not define a specific property, its value is not updated.
|
|
1567
1615
|
*
|
|
1568
1616
|
* The response is the full task input as returned by the
|
|
1569
|
-
* [Get task input](
|
|
1617
|
+
* [Get Actor task input](https://docs.apify.com/api/v2/actor-task-input-get) endpoint.
|
|
1570
1618
|
*
|
|
1571
1619
|
* The request needs to specify the `Content-Type: application/json` HTTP
|
|
1572
1620
|
* header!
|
|
1573
1621
|
*
|
|
1574
1622
|
* When providing your API authentication token, we recommend using the
|
|
1575
|
-
* request's `Authorization` header, rather than the URL.
|
|
1576
|
-
*
|
|
1623
|
+
* request's `Authorization` header, rather than the URL.
|
|
1624
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
1577
1625
|
*/
|
|
1578
1626
|
put: operations["actorTask_input_put"];
|
|
1579
1627
|
post?: never;
|
|
@@ -1645,18 +1693,17 @@ export interface paths {
|
|
|
1645
1693
|
* input property, the Actor run uses the default value defined by the task (or Actor's input
|
|
1646
1694
|
* schema if not defined by the task).
|
|
1647
1695
|
*
|
|
1648
|
-
* The response is the Actor Run object as returned by the [Get
|
|
1649
|
-
* run](#/reference/actor-runs/run-object-and-its-storages/get-run) endpoint.
|
|
1696
|
+
* The response is the Actor Run object as returned by the [Get Actor run](https://docs.apify.com/api/v2/actor-run-get) endpoint.
|
|
1650
1697
|
*
|
|
1651
1698
|
* If you want to wait for the run to finish and receive the actual output of
|
|
1652
|
-
* the Actor run as the response, use
|
|
1653
|
-
* synchronously](
|
|
1654
|
-
* instead.
|
|
1699
|
+
* the Actor run as the response, use the [Run Actor task synchronously and get key-value store record](https://docs.apify.com/api/v2/actor-task-run-sync-post)
|
|
1700
|
+
* or [Run Actor task synchronously and get dataset items](https://docs.apify.com/api/v2/actor-task-run-sync-get-dataset-items-post)
|
|
1701
|
+
* endpoint instead.
|
|
1655
1702
|
*
|
|
1656
1703
|
* To fetch the Actor run results that are typically stored in the default
|
|
1657
1704
|
* dataset, you'll need to pass the ID received in the `defaultDatasetId` field
|
|
1658
1705
|
* received in the response JSON to the
|
|
1659
|
-
* [Get dataset items](
|
|
1706
|
+
* [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get) API endpoint.
|
|
1660
1707
|
*/
|
|
1661
1708
|
post: operations["actorTask_runs_post"];
|
|
1662
1709
|
delete?: never;
|
|
@@ -1695,7 +1742,7 @@ export interface paths {
|
|
|
1695
1742
|
* and its status.
|
|
1696
1743
|
*
|
|
1697
1744
|
* To run the Task asynchronously, use the
|
|
1698
|
-
* [Run task
|
|
1745
|
+
* [Run Actor task](https://docs.apify.com/api/v2/actor-task-runs-post)
|
|
1699
1746
|
* endpoint instead.
|
|
1700
1747
|
*/
|
|
1701
1748
|
get: operations["actorTask_runSync_get"];
|
|
@@ -1735,8 +1782,7 @@ export interface paths {
|
|
|
1735
1782
|
* Just make sure to specify `Content-Type` header to be `application/json` and
|
|
1736
1783
|
* input to be an object.
|
|
1737
1784
|
*
|
|
1738
|
-
* To run the task asynchronously, use the [Run
|
|
1739
|
-
* task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
|
|
1785
|
+
* To run the task asynchronously, use the [Run Actor task](https://docs.apify.com/api/v2/actor-task-runs-post) API endpoint instead.
|
|
1740
1786
|
*/
|
|
1741
1787
|
post: operations["actorTask_runSync_post"];
|
|
1742
1788
|
delete?: never;
|
|
@@ -1760,8 +1806,7 @@ export interface paths {
|
|
|
1760
1806
|
* otherwise the HTTP request fails with a timeout error (this won't abort
|
|
1761
1807
|
* the run itself).
|
|
1762
1808
|
*
|
|
1763
|
-
* You can send all the same options in parameters as the [Get
|
|
1764
|
-
* Items](#/reference/datasets/item-collection/get-items) API endpoint.
|
|
1809
|
+
* You can send all the same options in parameters as the [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get) API endpoint.
|
|
1765
1810
|
*
|
|
1766
1811
|
* Beware that it might be impossible to maintain an idle HTTP connection for
|
|
1767
1812
|
* an extended period, due to client timeout or network conditions. Make sure your HTTP client is
|
|
@@ -1770,8 +1815,7 @@ export interface paths {
|
|
|
1770
1815
|
* If the connection breaks, you will not receive any information about the run
|
|
1771
1816
|
* and its status.
|
|
1772
1817
|
*
|
|
1773
|
-
* To run the Task asynchronously, use the [Run task
|
|
1774
|
-
* asynchronously](#/reference/actor-tasks/run-collection/run-task) endpoint
|
|
1818
|
+
* To run the Task asynchronously, use the [Run Actor task](https://docs.apify.com/api/v2/actor-task-runs-post) endpoint
|
|
1775
1819
|
* instead.
|
|
1776
1820
|
*/
|
|
1777
1821
|
get: operations["actorTask_runSyncGetDatasetItems_get"];
|
|
@@ -1791,8 +1835,7 @@ export interface paths {
|
|
|
1791
1835
|
* input property, the Actor run uses the default value defined by the task (or the Actor's
|
|
1792
1836
|
* input schema if not defined by the task).
|
|
1793
1837
|
*
|
|
1794
|
-
* You can send all the same options in parameters as the [Get
|
|
1795
|
-
* Items](#/reference/datasets/item-collection/get-items) API endpoint.
|
|
1838
|
+
* You can send all the same options in parameters as the [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get) API endpoint.
|
|
1796
1839
|
*
|
|
1797
1840
|
* Beware that it might be impossible to maintain an idle HTTP connection for
|
|
1798
1841
|
* an extended period, due to client timeout or network conditions. Make sure your HTTP client is
|
|
@@ -1807,8 +1850,7 @@ export interface paths {
|
|
|
1807
1850
|
* Just make sure to specify the `Content-Type` header as `application/json`
|
|
1808
1851
|
* and that the input is an object.
|
|
1809
1852
|
*
|
|
1810
|
-
* To run the task asynchronously, use the [Run
|
|
1811
|
-
* task](#/reference/actor-tasks/run-collection/run-task) API endpoint instead.
|
|
1853
|
+
* To run the task asynchronously, use the [Run Actor task](https://docs.apify.com/api/v2/actor-task-runs-post) API endpoint instead.
|
|
1812
1854
|
*/
|
|
1813
1855
|
post: operations["actorTask_runSyncGetDatasetItems_post"];
|
|
1814
1856
|
delete?: never;
|
|
@@ -1837,17 +1879,17 @@ export interface paths {
|
|
|
1837
1879
|
* Using the `status` query parameter you can ensure to only get a run with a certain status
|
|
1838
1880
|
* (e.g. `status=SUCCEEDED`). Similarly, the `origin` query parameter filters runs by the means
|
|
1839
1881
|
* by which they were started (e.g. `origin=API`). The output of this endpoint and other query
|
|
1840
|
-
* parameters are the same as in the [
|
|
1882
|
+
* parameters are the same as in the [Get Actor run](https://docs.apify.com/api/v2/actor-run-get) endpoint.
|
|
1841
1883
|
*
|
|
1842
1884
|
* ##### Convenience endpoints for last Actor task run
|
|
1843
1885
|
*
|
|
1844
|
-
* * [
|
|
1886
|
+
* * [Last Actor task run's default dataset](https://docs.apify.com/api/v2/last-actor-task-runs-default-dataset)
|
|
1845
1887
|
*
|
|
1846
|
-
* * [
|
|
1888
|
+
* * [Last Actor task run's default key-value store](https://docs.apify.com/api/v2/last-actor-task-runs-default-key-value-store)
|
|
1847
1889
|
*
|
|
1848
|
-
* * [
|
|
1890
|
+
* * [Last Actor task run's default request queue](https://docs.apify.com/api/v2/last-actor-task-runs-default-request-queue)
|
|
1849
1891
|
*
|
|
1850
|
-
* * [
|
|
1892
|
+
* * [Last Actor task run's log](https://docs.apify.com/api/v2/last-actor-task-runs-log)
|
|
1851
1893
|
*/
|
|
1852
1894
|
get: operations["actorTask_runs_last_get"];
|
|
1853
1895
|
put?: never;
|
|
@@ -1894,7 +1936,7 @@ export interface paths {
|
|
|
1894
1936
|
* @description Aborts the last run of the specified Actor task and returns an object that
|
|
1895
1937
|
* contains all the details about the run.
|
|
1896
1938
|
*
|
|
1897
|
-
* This endpoint is a shortcut for [Abort run](
|
|
1939
|
+
* This endpoint is a shortcut for [Abort Actor run](https://docs.apify.com/api/v2/actor-run-abort-post)
|
|
1898
1940
|
* on the Actor task's last run. Only runs that are starting or running are aborted.
|
|
1899
1941
|
* For runs with status `FINISHED`, `FAILED`, `ABORTING` and `TIMED-OUT` this call
|
|
1900
1942
|
* does nothing.
|
|
@@ -1920,7 +1962,7 @@ export interface paths {
|
|
|
1920
1962
|
* @description Transforms the last run of the specified Actor task into a run of another Actor with
|
|
1921
1963
|
* a new input.
|
|
1922
1964
|
*
|
|
1923
|
-
* This endpoint is a shortcut for [Metamorph run](
|
|
1965
|
+
* This endpoint is a shortcut for [Metamorph Actor run](https://docs.apify.com/api/v2/actor-run-metamorph-post)
|
|
1924
1966
|
* on the Actor task's last run.
|
|
1925
1967
|
*/
|
|
1926
1968
|
post: operations["actorTask_runs_last_metamorph_post"];
|
|
@@ -1944,7 +1986,7 @@ export interface paths {
|
|
|
1944
1986
|
* @description Reboots the last run of the specified Actor task and returns an object that
|
|
1945
1987
|
* contains all the details about the rebooted run.
|
|
1946
1988
|
*
|
|
1947
|
-
* This endpoint is a shortcut for [Reboot run](
|
|
1989
|
+
* This endpoint is a shortcut for [Reboot Actor run](https://docs.apify.com/api/v2/actor-run-reboot-post)
|
|
1948
1990
|
* on the Actor task's last run. Only runs with status `RUNNING` can be rebooted. The run's
|
|
1949
1991
|
* container will be restarted, so any data not persisted in the key-value store, dataset,
|
|
1950
1992
|
* or request queue will be lost.
|
|
@@ -2459,11 +2501,11 @@ export interface paths {
|
|
|
2459
2501
|
*
|
|
2460
2502
|
* ##### Convenience endpoints for Actor run default storages
|
|
2461
2503
|
*
|
|
2462
|
-
* * [
|
|
2504
|
+
* * [Default dataset](https://docs.apify.com/api/v2/default-dataset)
|
|
2463
2505
|
*
|
|
2464
|
-
* * [
|
|
2506
|
+
* * [Default key-value store](https://docs.apify.com/api/v2/default-key-value-store)
|
|
2465
2507
|
*
|
|
2466
|
-
* * [
|
|
2508
|
+
* * [Default request queue](https://docs.apify.com/api/v2/default-request-queue)
|
|
2467
2509
|
*
|
|
2468
2510
|
* Gets an object that contains all the details about a
|
|
2469
2511
|
* specific run of an Actor.
|
|
@@ -2669,7 +2711,7 @@ export interface paths {
|
|
|
2669
2711
|
* @description Updates the default dataset associated with an Actor run.
|
|
2670
2712
|
*
|
|
2671
2713
|
* This endpoint is a shortcut for getting the run's `defaultDatasetId` and then using the
|
|
2672
|
-
* [
|
|
2714
|
+
* [Update dataset](https://docs.apify.com/api/v2/dataset-put) endpoint.
|
|
2673
2715
|
*/
|
|
2674
2716
|
put: operations["actorRun_dataset_put"];
|
|
2675
2717
|
post?: never;
|
|
@@ -2678,7 +2720,7 @@ export interface paths {
|
|
|
2678
2720
|
* @description Deletes default dataset associated with an Actor run.
|
|
2679
2721
|
*
|
|
2680
2722
|
* This endpoint is a shortcut for getting the last run's `defaultDatasetId` and then using the
|
|
2681
|
-
* [
|
|
2723
|
+
* [Delete dataset](https://docs.apify.com/api/v2/dataset-delete) endpoint.
|
|
2682
2724
|
*/
|
|
2683
2725
|
delete: operations["actorRun_dataset_delete"];
|
|
2684
2726
|
options?: never;
|
|
@@ -3253,15 +3295,15 @@ export interface paths {
|
|
|
3253
3295
|
* Get OpenAPI definition of Actor build
|
|
3254
3296
|
* @description Get the OpenAPI definition for Actor builds. Two similar endpoints are available:
|
|
3255
3297
|
*
|
|
3256
|
-
* - [
|
|
3257
|
-
* - [
|
|
3298
|
+
* - [Get OpenAPI definition of Actor build](https://docs.apify.com/api/v2/actor-openapi-json-get) (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`): Requires both `actorId` and `buildId`. Use `default` as the `buildId` to get the OpenAPI schema for the default Actor build.
|
|
3299
|
+
* - [Get OpenAPI definition of Actor build](https://docs.apify.com/api/v2/actor-build-openapi-json-get) (`/v2/actor-builds/{buildId}/openapi.json`): Requires only `buildId`.
|
|
3258
3300
|
*
|
|
3259
3301
|
* Get the OpenAPI definition for a specific Actor build.
|
|
3260
3302
|
* Authentication is based on the build's unique ID. No authentication token is required.
|
|
3261
3303
|
*
|
|
3262
3304
|
* :::note
|
|
3263
3305
|
*
|
|
3264
|
-
* You can also use the [
|
|
3306
|
+
* You can also use the [Get OpenAPI definition of Actor build](https://docs.apify.com/api/v2/actor-openapi-json-get) endpoint (`/v2/actors/{actorId}/builds/{buildId}/openapi.json`) to get the OpenAPI definition for a build.
|
|
3265
3307
|
*
|
|
3266
3308
|
* :::
|
|
3267
3309
|
*/
|
|
@@ -3274,6 +3316,53 @@ export interface paths {
|
|
|
3274
3316
|
patch?: never;
|
|
3275
3317
|
trace?: never;
|
|
3276
3318
|
};
|
|
3319
|
+
"/v2/actor-oauth-accounts/{connectionId}/accounts": {
|
|
3320
|
+
parameters: {
|
|
3321
|
+
query?: never;
|
|
3322
|
+
header?: never;
|
|
3323
|
+
path?: never;
|
|
3324
|
+
cookie?: never;
|
|
3325
|
+
};
|
|
3326
|
+
/**
|
|
3327
|
+
* Get list of Actor OAuth accounts
|
|
3328
|
+
* @description Gets the accounts you connected through the Actor OAuth connection, including their OAuth tokens. Only accounts
|
|
3329
|
+
* that finished authorization are returned.
|
|
3330
|
+
*
|
|
3331
|
+
* There are at most 5 accounts per user and connection, so the list is not paginated.
|
|
3332
|
+
*/
|
|
3333
|
+
get: operations["actorOAuthAccounts_get"];
|
|
3334
|
+
put?: never;
|
|
3335
|
+
post?: never;
|
|
3336
|
+
delete?: never;
|
|
3337
|
+
options?: never;
|
|
3338
|
+
head?: never;
|
|
3339
|
+
patch?: never;
|
|
3340
|
+
trace?: never;
|
|
3341
|
+
};
|
|
3342
|
+
"/v2/actor-oauth-accounts/{accountId}": {
|
|
3343
|
+
parameters: {
|
|
3344
|
+
query?: never;
|
|
3345
|
+
header?: never;
|
|
3346
|
+
path?: never;
|
|
3347
|
+
cookie?: never;
|
|
3348
|
+
};
|
|
3349
|
+
/**
|
|
3350
|
+
* Get Actor OAuth account
|
|
3351
|
+
* @description Gets an account connected through an Actor OAuth connection, including its OAuth tokens.
|
|
3352
|
+
*
|
|
3353
|
+
* This endpoint only accepts the API token of an Actor run (the `APIFY_TOKEN` environment variable of the run).
|
|
3354
|
+
* The run must belong to the Actor that the account's OAuth connection is configured on, and the account must
|
|
3355
|
+
* belong to the user the run's token acts for. Any other token gets a `403` error.
|
|
3356
|
+
*/
|
|
3357
|
+
get: operations["actorOAuthAccount_get"];
|
|
3358
|
+
put?: never;
|
|
3359
|
+
post?: never;
|
|
3360
|
+
delete?: never;
|
|
3361
|
+
options?: never;
|
|
3362
|
+
head?: never;
|
|
3363
|
+
patch?: never;
|
|
3364
|
+
trace?: never;
|
|
3365
|
+
};
|
|
3277
3366
|
"/v2/key-value-stores": {
|
|
3278
3367
|
parameters: {
|
|
3279
3368
|
query?: never;
|
|
@@ -3336,8 +3425,7 @@ export interface paths {
|
|
|
3336
3425
|
* @description Updates a key-value store's name and general resource access level using a value specified by a JSON object
|
|
3337
3426
|
* passed in the PUT payload.
|
|
3338
3427
|
*
|
|
3339
|
-
* The response is the updated key-value store object, as returned by the [Get
|
|
3340
|
-
* store](#/reference/key-value-stores/store-object/get-store) API endpoint.
|
|
3428
|
+
* The response is the updated key-value store object, as returned by the [Get key-value store](https://docs.apify.com/api/v2/key-value-store-get) API endpoint.
|
|
3341
3429
|
*/
|
|
3342
3430
|
put: operations["keyValueStore_put"];
|
|
3343
3431
|
post?: never;
|
|
@@ -3410,7 +3498,7 @@ export interface paths {
|
|
|
3410
3498
|
* @description Gets a value stored in the key-value store under a specific key.
|
|
3411
3499
|
*
|
|
3412
3500
|
* The response body has the same `Content-Encoding` header as it was set in
|
|
3413
|
-
* [
|
|
3501
|
+
* [Set key-value store record](https://docs.apify.com/api/v2/key-value-store-record-put).
|
|
3414
3502
|
*
|
|
3415
3503
|
* If the request does not define the `Accept-Encoding` HTTP header with the
|
|
3416
3504
|
* right encoding, the record will be decompressed.
|
|
@@ -3448,7 +3536,7 @@ export interface paths {
|
|
|
3448
3536
|
* Set key-value store record (POST)
|
|
3449
3537
|
* @description Stores a value under a specific key to the key-value store.
|
|
3450
3538
|
*
|
|
3451
|
-
* This endpoint is an alias for the [
|
|
3539
|
+
* This endpoint is an alias for the [Set key-value store record](https://docs.apify.com/api/v2/key-value-store-record-put) endpoint and behaves identically.
|
|
3452
3540
|
*/
|
|
3453
3541
|
post: operations["keyValueStore_record_post"];
|
|
3454
3542
|
/**
|
|
@@ -3513,7 +3601,7 @@ export interface paths {
|
|
|
3513
3601
|
* @description Returns dataset object for given dataset ID.
|
|
3514
3602
|
*
|
|
3515
3603
|
* This does not return dataset items, only information about the storage itself.
|
|
3516
|
-
* To retrieve dataset items, use the [
|
|
3604
|
+
* To retrieve dataset items, use the [Get dataset items](https://docs.apify.com/api/v2/dataset-items-get) endpoint.
|
|
3517
3605
|
*
|
|
3518
3606
|
* :::note
|
|
3519
3607
|
*
|
|
@@ -3811,7 +3899,7 @@ export interface paths {
|
|
|
3811
3899
|
* passed in the PUT payload.
|
|
3812
3900
|
*
|
|
3813
3901
|
* The response is the updated request queue object, as returned by the
|
|
3814
|
-
* [Get request queue](
|
|
3902
|
+
* [Get request queue](https://docs.apify.com/api/v2/request-queue-get) API endpoint.
|
|
3815
3903
|
*/
|
|
3816
3904
|
put: operations["requestQueue_put"];
|
|
3817
3905
|
post?: never;
|
|
@@ -4138,14 +4226,14 @@ export interface paths {
|
|
|
4138
4226
|
* updated.
|
|
4139
4227
|
*
|
|
4140
4228
|
* The response is the full webhook object as returned by the
|
|
4141
|
-
* [Get webhook](
|
|
4229
|
+
* [Get webhook](https://docs.apify.com/api/v2/webhook-get) endpoint.
|
|
4142
4230
|
*
|
|
4143
4231
|
* The request needs to specify the `Content-Type: application/json` HTTP
|
|
4144
4232
|
* header!
|
|
4145
4233
|
*
|
|
4146
4234
|
* When providing your API authentication token, we recommend using the
|
|
4147
|
-
* request's `Authorization` header, rather than the URL.
|
|
4148
|
-
*
|
|
4235
|
+
* request's `Authorization` header, rather than the URL.
|
|
4236
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
4149
4237
|
*/
|
|
4150
4238
|
put: operations["webhook_put"];
|
|
4151
4239
|
post?: never;
|
|
@@ -4272,8 +4360,8 @@ export interface paths {
|
|
|
4272
4360
|
* The request needs to specify the `Content-Type: application/json` HTTP header!
|
|
4273
4361
|
*
|
|
4274
4362
|
* When providing your API authentication token, we recommend using the
|
|
4275
|
-
* request's `Authorization` header, rather than the URL.
|
|
4276
|
-
*
|
|
4363
|
+
* request's `Authorization` header, rather than the URL.
|
|
4364
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
4277
4365
|
*/
|
|
4278
4366
|
post: operations["schedules_post"];
|
|
4279
4367
|
delete?: never;
|
|
@@ -4301,14 +4389,14 @@ export interface paths {
|
|
|
4301
4389
|
* its value will not be updated.
|
|
4302
4390
|
*
|
|
4303
4391
|
* The response is the full schedule object as returned by the
|
|
4304
|
-
* [Get schedule](
|
|
4392
|
+
* [Get schedule](https://docs.apify.com/api/v2/schedule-get) endpoint.
|
|
4305
4393
|
*
|
|
4306
4394
|
* **The request needs to specify the `Content-Type: application/json` HTTP
|
|
4307
4395
|
* header!**
|
|
4308
4396
|
*
|
|
4309
4397
|
* When providing your API authentication token, we recommend using the
|
|
4310
|
-
* request's `Authorization` header, rather than the URL.
|
|
4311
|
-
*
|
|
4398
|
+
* request's `Authorization` header, rather than the URL.
|
|
4399
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
4312
4400
|
*/
|
|
4313
4401
|
put: operations["schedule_put"];
|
|
4314
4402
|
post?: never;
|
|
@@ -4322,6 +4410,29 @@ export interface paths {
|
|
|
4322
4410
|
patch?: never;
|
|
4323
4411
|
trace?: never;
|
|
4324
4412
|
};
|
|
4413
|
+
"/v2/schedules/{scheduleId}/invoke": {
|
|
4414
|
+
parameters: {
|
|
4415
|
+
query?: never;
|
|
4416
|
+
header?: never;
|
|
4417
|
+
path?: never;
|
|
4418
|
+
cookie?: never;
|
|
4419
|
+
};
|
|
4420
|
+
get?: never;
|
|
4421
|
+
put?: never;
|
|
4422
|
+
/**
|
|
4423
|
+
* Invoke schedule
|
|
4424
|
+
* @description Immediately runs all actions of the schedule, the same way as the **Run now** button in Apify Console.
|
|
4425
|
+
*
|
|
4426
|
+
* The invocation is recorded in the [schedule log](https://docs.apify.com/api/v2/schedule-log-get). It doesn't change the schedule's
|
|
4427
|
+
* `lastRunAt` or `nextRunAt`. The response doesn't contain the started runs.
|
|
4428
|
+
*/
|
|
4429
|
+
post: operations["schedule_invoke_post"];
|
|
4430
|
+
delete?: never;
|
|
4431
|
+
options?: never;
|
|
4432
|
+
head?: never;
|
|
4433
|
+
patch?: never;
|
|
4434
|
+
trace?: never;
|
|
4435
|
+
};
|
|
4325
4436
|
"/v2/schedules/{scheduleId}/log": {
|
|
4326
4437
|
parameters: {
|
|
4327
4438
|
query?: never;
|
|
@@ -4355,8 +4466,7 @@ export interface paths {
|
|
|
4355
4466
|
* @description Gets the list of public Actors in Apify Store. You can use `search`
|
|
4356
4467
|
* parameter to search Actors by string in title, name, description, username
|
|
4357
4468
|
* and readme.
|
|
4358
|
-
* If you need detailed info about a specific Actor, use the [Get
|
|
4359
|
-
* Actor](#/reference/actors/actor-object/get-actor) endpoint.
|
|
4469
|
+
* If you need detailed info about a specific Actor, use the [Get Actor](https://docs.apify.com/api/v2/actor-get) endpoint.
|
|
4360
4470
|
*
|
|
4361
4471
|
* The endpoint supports pagination using the `limit` and `offset` parameters.
|
|
4362
4472
|
* It will not return more than 1,000 records.
|
|
@@ -4403,6 +4513,10 @@ export interface paths {
|
|
|
4403
4513
|
* can be seen on public profile pages (e.g. https://apify.com/apify).
|
|
4404
4514
|
*
|
|
4405
4515
|
* This operation requires no authentication token.
|
|
4516
|
+
*
|
|
4517
|
+
* When the request is authenticated with an API token of the requested user account, or with a token
|
|
4518
|
+
* that impersonates it, the response also contains the private information, the same as in
|
|
4519
|
+
* [Get private user data](https://docs.apify.com/api/v2/users-me-get). Tokens with limited permissions never receive it.
|
|
4406
4520
|
*/
|
|
4407
4521
|
get: operations["user_get"];
|
|
4408
4522
|
put?: never;
|
|
@@ -4491,6 +4605,138 @@ export interface paths {
|
|
|
4491
4605
|
patch?: never;
|
|
4492
4606
|
trace?: never;
|
|
4493
4607
|
};
|
|
4608
|
+
"/v2/users/{userId}/usage/monthly": {
|
|
4609
|
+
parameters: {
|
|
4610
|
+
query?: never;
|
|
4611
|
+
header?: never;
|
|
4612
|
+
path?: never;
|
|
4613
|
+
cookie?: never;
|
|
4614
|
+
};
|
|
4615
|
+
/**
|
|
4616
|
+
* Get user's monthly usage by ID
|
|
4617
|
+
* @description Returns the same summary of monthly usage as [Get user's monthly usage](https://docs.apify.com/api/v2/users-me-usage-monthly-get),
|
|
4618
|
+
* for an account given by its ID or username.
|
|
4619
|
+
*
|
|
4620
|
+
* You can only access your own account, or the organization your API token belongs to. API tokens with
|
|
4621
|
+
* limited permissions can't use this endpoint.
|
|
4622
|
+
*
|
|
4623
|
+
* Using the `date` parameter will show the usage in the monthly usage cycle that
|
|
4624
|
+
* includes that date.
|
|
4625
|
+
*/
|
|
4626
|
+
get: operations["users_usage_monthly_get"];
|
|
4627
|
+
put?: never;
|
|
4628
|
+
post?: never;
|
|
4629
|
+
delete?: never;
|
|
4630
|
+
options?: never;
|
|
4631
|
+
head?: never;
|
|
4632
|
+
patch?: never;
|
|
4633
|
+
trace?: never;
|
|
4634
|
+
};
|
|
4635
|
+
"/v2/users/{userId}/limits": {
|
|
4636
|
+
parameters: {
|
|
4637
|
+
query?: never;
|
|
4638
|
+
header?: never;
|
|
4639
|
+
path?: never;
|
|
4640
|
+
cookie?: never;
|
|
4641
|
+
};
|
|
4642
|
+
/**
|
|
4643
|
+
* Get user's limits by ID
|
|
4644
|
+
* @description Returns the same summary of limits as [Get user's limits](https://docs.apify.com/api/v2/users-me-limits-get), for an account given by
|
|
4645
|
+
* its ID or username.
|
|
4646
|
+
*
|
|
4647
|
+
* You can only access your own account, or the organization your API token belongs to. API tokens with
|
|
4648
|
+
* limited permissions can't use this endpoint.
|
|
4649
|
+
*/
|
|
4650
|
+
get: operations["users_limits_get"];
|
|
4651
|
+
/**
|
|
4652
|
+
* Update user's limits by ID
|
|
4653
|
+
* @description Updates the same limits as [Update user's limits](https://docs.apify.com/api/v2/users-me-limits-put), for an account given by its ID
|
|
4654
|
+
* or username.
|
|
4655
|
+
*
|
|
4656
|
+
* You can only access your own account, or the organization your API token belongs to. API tokens with
|
|
4657
|
+
* limited permissions can't use this endpoint.
|
|
4658
|
+
* For an organization, you also need the permission to manage the organization.
|
|
4659
|
+
*/
|
|
4660
|
+
put: operations["users_limits_put"];
|
|
4661
|
+
post?: never;
|
|
4662
|
+
delete?: never;
|
|
4663
|
+
options?: never;
|
|
4664
|
+
head?: never;
|
|
4665
|
+
patch?: never;
|
|
4666
|
+
trace?: never;
|
|
4667
|
+
};
|
|
4668
|
+
"/v2/integrations/git": {
|
|
4669
|
+
parameters: {
|
|
4670
|
+
query?: never;
|
|
4671
|
+
header?: never;
|
|
4672
|
+
path?: never;
|
|
4673
|
+
cookie?: never;
|
|
4674
|
+
};
|
|
4675
|
+
/**
|
|
4676
|
+
* Get git provider integrations
|
|
4677
|
+
* @description Gets your connected git provider accounts (GitHub App, GitLab and Bitbucket), each with the workspaces you can
|
|
4678
|
+
* create a repository in. Only authorized accounts are returned, and accounts whose access was revoked are left
|
|
4679
|
+
* out.
|
|
4680
|
+
*
|
|
4681
|
+
* Use the `id` of an integration as the `providerId` in the
|
|
4682
|
+
* [Create git repository](https://docs.apify.com/api/v2/integrations-git-create-repo-post) and
|
|
4683
|
+
* [Register deployment key](https://docs.apify.com/api/v2/integrations-git-register-deployment-key-post) endpoints.
|
|
4684
|
+
*/
|
|
4685
|
+
get: operations["integrations_git_get"];
|
|
4686
|
+
put?: never;
|
|
4687
|
+
post?: never;
|
|
4688
|
+
delete?: never;
|
|
4689
|
+
options?: never;
|
|
4690
|
+
head?: never;
|
|
4691
|
+
patch?: never;
|
|
4692
|
+
trace?: never;
|
|
4693
|
+
};
|
|
4694
|
+
"/v2/integrations/git/{providerId}/create-repo": {
|
|
4695
|
+
parameters: {
|
|
4696
|
+
query?: never;
|
|
4697
|
+
header?: never;
|
|
4698
|
+
path?: never;
|
|
4699
|
+
cookie?: never;
|
|
4700
|
+
};
|
|
4701
|
+
get?: never;
|
|
4702
|
+
put?: never;
|
|
4703
|
+
/**
|
|
4704
|
+
* Create git repository
|
|
4705
|
+
* @description Creates a repository through a connected git account and commits the initial files into it, either the given
|
|
4706
|
+
* `files` or the files of an Actor template archive (`templateArchiveUrl`).
|
|
4707
|
+
*/
|
|
4708
|
+
post: operations["integrations_git_createRepo_post"];
|
|
4709
|
+
delete?: never;
|
|
4710
|
+
options?: never;
|
|
4711
|
+
head?: never;
|
|
4712
|
+
patch?: never;
|
|
4713
|
+
trace?: never;
|
|
4714
|
+
};
|
|
4715
|
+
"/v2/integrations/git/{providerId}/register-deployment-key": {
|
|
4716
|
+
parameters: {
|
|
4717
|
+
query?: never;
|
|
4718
|
+
header?: never;
|
|
4719
|
+
path?: never;
|
|
4720
|
+
cookie?: never;
|
|
4721
|
+
};
|
|
4722
|
+
get?: never;
|
|
4723
|
+
put?: never;
|
|
4724
|
+
/**
|
|
4725
|
+
* Register deployment key
|
|
4726
|
+
* @description Registers the Actor's deployment key (a read-only SSH key generated for every Actor) on a repository through a
|
|
4727
|
+
* connected git account, so that Apify can clone the repository when building the Actor.
|
|
4728
|
+
*
|
|
4729
|
+
* You need write access to the Actor. The repository's host must match the provider of the connected account.
|
|
4730
|
+
* If the key is already registered on the repository, nothing changes. On GitHub, registering the key on another
|
|
4731
|
+
* repository removes it from the previously linked one.
|
|
4732
|
+
*/
|
|
4733
|
+
post: operations["integrations_git_registerDeploymentKey_post"];
|
|
4734
|
+
delete?: never;
|
|
4735
|
+
options?: never;
|
|
4736
|
+
head?: never;
|
|
4737
|
+
patch?: never;
|
|
4738
|
+
trace?: never;
|
|
4739
|
+
};
|
|
4494
4740
|
"/v2/browser-info": {
|
|
4495
4741
|
parameters: {
|
|
4496
4742
|
query?: never;
|
|
@@ -4762,6 +5008,8 @@ export interface components {
|
|
|
4762
5008
|
type?: components["schemas"]["ErrorType"];
|
|
4763
5009
|
/** @description Human-readable error message describing what went wrong. */
|
|
4764
5010
|
message?: string;
|
|
5011
|
+
/** @description Additional machine-readable details about the error. Present only for some error types. */
|
|
5012
|
+
data?: Record<string, unknown>;
|
|
4765
5013
|
};
|
|
4766
5014
|
/** ErrorResponse */
|
|
4767
5015
|
ErrorResponse: {
|
|
@@ -4896,6 +5144,13 @@ export interface components {
|
|
|
4896
5144
|
restartOnError?: boolean | null;
|
|
4897
5145
|
/** @description Maximum number of items the run might produce. */
|
|
4898
5146
|
maxItems?: number | null;
|
|
5147
|
+
/**
|
|
5148
|
+
* @description Maximum cost in USD that a pay-per-event run can charge to the user.
|
|
5149
|
+
* @example 5
|
|
5150
|
+
*/
|
|
5151
|
+
maxTotalChargeUsd?: number | null;
|
|
5152
|
+
/** @description Whether `maxTotalChargeUsd` was set explicitly by the user. */
|
|
5153
|
+
isMaxTotalChargeUsdSetByUser?: boolean | null;
|
|
4899
5154
|
forcePermissionLevel?: components["schemas"]["ActorPermissionLevel"] | null;
|
|
4900
5155
|
};
|
|
4901
5156
|
/** ActorStandby */
|
|
@@ -4916,6 +5171,15 @@ export interface components {
|
|
|
4916
5171
|
disableStandbyFieldsOverride?: boolean | null;
|
|
4917
5172
|
/** @description Whether to pass the Actor's input to the standby run. If `false`, the standby runs start with no input. */
|
|
4918
5173
|
shouldPassActorInput?: boolean | null;
|
|
5174
|
+
/**
|
|
5175
|
+
* @description Whether each user gets their own standby runs (`SINGLE_TENANT`) or runs are shared across users (`MULTI_TENANT`). Set by Apify.
|
|
5176
|
+
* @example SINGLE_TENANT
|
|
5177
|
+
*/
|
|
5178
|
+
tenancy?: string | null;
|
|
5179
|
+
/** @description Whether standby requests can be authenticated with an Apify Console session. Set by Apify. */
|
|
5180
|
+
isConsoleAuthEnabled?: boolean | null;
|
|
5181
|
+
/** @description Whether standby requests can be made without an API token. Set by Apify. */
|
|
5182
|
+
isTokenlessEnabled?: boolean | null;
|
|
4919
5183
|
};
|
|
4920
5184
|
/** ExampleRunInput */
|
|
4921
5185
|
ExampleRunInput: {
|
|
@@ -5007,6 +5271,11 @@ export interface components {
|
|
|
5007
5271
|
* @example false
|
|
5008
5272
|
*/
|
|
5009
5273
|
isSecret?: boolean | null;
|
|
5274
|
+
/**
|
|
5275
|
+
* @description A short hash of the secret value, to detect value changes. Returned only for secret environment variables, in place of `value`.
|
|
5276
|
+
* @example a1b2c3
|
|
5277
|
+
*/
|
|
5278
|
+
valueHash?: string;
|
|
5010
5279
|
};
|
|
5011
5280
|
/** Version */
|
|
5012
5281
|
Version: {
|
|
@@ -5037,6 +5306,12 @@ export interface components {
|
|
|
5037
5306
|
tarballUrl?: string | null;
|
|
5038
5307
|
/** @description URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`. */
|
|
5039
5308
|
gitHubGistUrl?: string | null;
|
|
5309
|
+
/** @description ID of the GitHub webhook that triggers a build on push. Present when build on push is enabled for a GitHub repository. */
|
|
5310
|
+
githubWebhookId?: number | null;
|
|
5311
|
+
/** @description ID of the GitLab webhook that triggers a build on push. Present when build on push is enabled for a GitLab repository. */
|
|
5312
|
+
gitlabWebhookId?: number | null;
|
|
5313
|
+
/** @description ID of the Bitbucket webhook that triggers a build on push. Present when build on push is enabled for a Bitbucket repository. */
|
|
5314
|
+
bitbucketWebhookId?: string | null;
|
|
5040
5315
|
};
|
|
5041
5316
|
/** CommonActorPricingInfo */
|
|
5042
5317
|
CommonActorPricingInfo: {
|
|
@@ -5059,6 +5334,8 @@ export interface components {
|
|
|
5059
5334
|
notifiedAboutFutureChangeAt?: Date | null;
|
|
5060
5335
|
/** Format: date-time */
|
|
5061
5336
|
notifiedAboutChangeAt?: Date | null;
|
|
5337
|
+
/** Format: date-time */
|
|
5338
|
+
notifiedAboutRentalToPpePriceChangeAt?: Date | null;
|
|
5062
5339
|
reasonForChange?: string | null;
|
|
5063
5340
|
isPriceChangeNotificationSuppressed?: boolean;
|
|
5064
5341
|
forceContainsSignificantPriceChange?: boolean;
|
|
@@ -5107,6 +5384,11 @@ export interface components {
|
|
|
5107
5384
|
};
|
|
5108
5385
|
};
|
|
5109
5386
|
minimalMaxTotalChargeUsd?: number | null;
|
|
5387
|
+
/**
|
|
5388
|
+
* @description If `true`, the platform usage of the run is charged to the user running the Actor, in addition to the event prices.
|
|
5389
|
+
* @example false
|
|
5390
|
+
*/
|
|
5391
|
+
isPPEPlatformUsagePaidByUser?: boolean | null;
|
|
5110
5392
|
} & {
|
|
5111
5393
|
/**
|
|
5112
5394
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -5297,7 +5579,7 @@ export interface components {
|
|
|
5297
5579
|
*/
|
|
5298
5580
|
isDeprecated?: boolean | null;
|
|
5299
5581
|
/**
|
|
5300
|
-
* @description The Actor's public SSH key, used as a deployment key for private Git repositories.
|
|
5582
|
+
* @description The Actor's public SSH key, used as a deployment key for private Git repositories. Returned only by the get Actor endpoint.
|
|
5301
5583
|
* @example ssh-rsa AAAA ...
|
|
5302
5584
|
*/
|
|
5303
5585
|
deploymentKey?: string;
|
|
@@ -5491,6 +5773,20 @@ export interface components {
|
|
|
5491
5773
|
/** @description URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`. */
|
|
5492
5774
|
gitHubGistUrl?: string;
|
|
5493
5775
|
};
|
|
5776
|
+
/** UpdateBuildOnPushRequest */
|
|
5777
|
+
UpdateBuildOnPushRequest: {
|
|
5778
|
+
/**
|
|
5779
|
+
* @description The connected git account to register the push webhook through: `github-app` for the GitHub App, or the ID
|
|
5780
|
+
* of a connected GitLab or Bitbucket integration, as returned by the [Get git provider integrations](https://docs.apify.com/api/v2/integrations-git-get) endpoint.
|
|
5781
|
+
* @example github-app
|
|
5782
|
+
*/
|
|
5783
|
+
providerId: string;
|
|
5784
|
+
/**
|
|
5785
|
+
* @description `true` registers the push webhook so that pushes to the repository build the version; `false` turns it off.
|
|
5786
|
+
* @example true
|
|
5787
|
+
*/
|
|
5788
|
+
enabled: boolean;
|
|
5789
|
+
};
|
|
5494
5790
|
/** ListOfEnvVars */
|
|
5495
5791
|
ListOfEnvVars: {
|
|
5496
5792
|
/** @example 5 */
|
|
@@ -5520,6 +5816,85 @@ export interface components {
|
|
|
5520
5816
|
/** @example hgdKZtadYvn4mBpoi */
|
|
5521
5817
|
actorRunId?: string | null;
|
|
5522
5818
|
};
|
|
5819
|
+
/**
|
|
5820
|
+
* WebhookSlackMessage
|
|
5821
|
+
* @description Slack message configuration. Present only when `actionType` is `SLACK_MESSAGE`.
|
|
5822
|
+
*/
|
|
5823
|
+
WebhookSlackMessage: {
|
|
5824
|
+
/** @example kLcd8Z4dzXN1z3QzS */
|
|
5825
|
+
userIntegrationId?: string;
|
|
5826
|
+
/** @example C01234ABCDE */
|
|
5827
|
+
channelId?: string;
|
|
5828
|
+
/** @example Actor run {{resource.id}} finished. */
|
|
5829
|
+
messageTemplate?: string;
|
|
5830
|
+
};
|
|
5831
|
+
/**
|
|
5832
|
+
* WebhookDatasetTransformation
|
|
5833
|
+
* @description Selects which dataset item fields are included in the output.
|
|
5834
|
+
*/
|
|
5835
|
+
WebhookDatasetTransformation: {
|
|
5836
|
+
/**
|
|
5837
|
+
* @example [
|
|
5838
|
+
* "title",
|
|
5839
|
+
* "url"
|
|
5840
|
+
* ]
|
|
5841
|
+
*/
|
|
5842
|
+
fields?: string[];
|
|
5843
|
+
/**
|
|
5844
|
+
* @example [
|
|
5845
|
+
* "html"
|
|
5846
|
+
* ]
|
|
5847
|
+
*/
|
|
5848
|
+
omit?: string[];
|
|
5849
|
+
};
|
|
5850
|
+
/**
|
|
5851
|
+
* WebhookGoogleMail
|
|
5852
|
+
* @description Gmail email configuration. Present only when `actionType` is `GOOGLE_MAIL`.
|
|
5853
|
+
*/
|
|
5854
|
+
WebhookGoogleMail: {
|
|
5855
|
+
/** @example kLcd8Z4dzXN1z3QzS */
|
|
5856
|
+
userIntegrationId?: string;
|
|
5857
|
+
/**
|
|
5858
|
+
* @example [
|
|
5859
|
+
* "bob@example.com"
|
|
5860
|
+
* ]
|
|
5861
|
+
*/
|
|
5862
|
+
emailTo?: string[];
|
|
5863
|
+
/** @example Actor run finished */
|
|
5864
|
+
subject?: string;
|
|
5865
|
+
/** @example Actor run {{resource.id}} finished. */
|
|
5866
|
+
body?: string;
|
|
5867
|
+
/** @example csv */
|
|
5868
|
+
attachmentFormat?: string;
|
|
5869
|
+
attachmentTransformation?: components["schemas"]["WebhookDatasetTransformation"];
|
|
5870
|
+
};
|
|
5871
|
+
/**
|
|
5872
|
+
* WebhookGoogleDrive
|
|
5873
|
+
* @description Google Drive upload configuration. Present only when `actionType` is `GOOGLE_DRIVE`.
|
|
5874
|
+
*/
|
|
5875
|
+
WebhookGoogleDrive: {
|
|
5876
|
+
/** @example kLcd8Z4dzXN1z3QzS */
|
|
5877
|
+
userIntegrationId?: string;
|
|
5878
|
+
/** @example results */
|
|
5879
|
+
filename?: string;
|
|
5880
|
+
/** @example json */
|
|
5881
|
+
format?: string | null;
|
|
5882
|
+
transformation?: components["schemas"]["WebhookDatasetTransformation"];
|
|
5883
|
+
};
|
|
5884
|
+
/**
|
|
5885
|
+
* WebhookGithubIssue
|
|
5886
|
+
* @description GitHub issue configuration. Present only when `actionType` is `GITHUB_ISSUE`.
|
|
5887
|
+
*/
|
|
5888
|
+
WebhookGithubIssue: {
|
|
5889
|
+
/** @example kLcd8Z4dzXN1z3QzS */
|
|
5890
|
+
userIntegrationId?: string;
|
|
5891
|
+
/** @example apify/apify-docs */
|
|
5892
|
+
repository?: string;
|
|
5893
|
+
/** @example Actor run failed */
|
|
5894
|
+
title?: string;
|
|
5895
|
+
/** @example Actor run {{resource.id}} failed. */
|
|
5896
|
+
body?: string;
|
|
5897
|
+
};
|
|
5523
5898
|
/**
|
|
5524
5899
|
* WebhookDispatchStatus
|
|
5525
5900
|
* @description Status of the webhook dispatch indicating whether the HTTP request was successful.
|
|
@@ -5545,8 +5920,8 @@ export interface components {
|
|
|
5545
5920
|
/** @example 1 */
|
|
5546
5921
|
totalDispatches?: number;
|
|
5547
5922
|
};
|
|
5548
|
-
/**
|
|
5549
|
-
|
|
5923
|
+
/** WebhookResource */
|
|
5924
|
+
WebhookResource: {
|
|
5550
5925
|
/** @example YiKoxjkaS9gjGTqhF */
|
|
5551
5926
|
id: string;
|
|
5552
5927
|
/**
|
|
@@ -5563,13 +5938,16 @@ export interface components {
|
|
|
5563
5938
|
userId: string;
|
|
5564
5939
|
/** @example false */
|
|
5565
5940
|
isAdHoc?: boolean | null;
|
|
5566
|
-
/** @example false */
|
|
5567
|
-
isApifyIntegration?: boolean;
|
|
5568
5941
|
/** @example true */
|
|
5569
5942
|
isEnabled?: boolean;
|
|
5570
|
-
/**
|
|
5943
|
+
/**
|
|
5944
|
+
* @description Type of action the webhook performs: `HTTP_REQUEST`, `SLACK_MESSAGE`, `GOOGLE_MAIL`, `GOOGLE_DRIVE` or `GITHUB_ISSUE`.
|
|
5945
|
+
* @example HTTP_REQUEST
|
|
5946
|
+
*/
|
|
5571
5947
|
actionType?: string;
|
|
5572
5948
|
/** @example false */
|
|
5949
|
+
isApifyIntegration?: boolean | null;
|
|
5950
|
+
/** @example false */
|
|
5573
5951
|
shouldInterpolateStrings?: boolean | null;
|
|
5574
5952
|
/**
|
|
5575
5953
|
* @example [
|
|
@@ -5581,22 +5959,90 @@ export interface components {
|
|
|
5581
5959
|
/** @example false */
|
|
5582
5960
|
ignoreSslErrors: boolean;
|
|
5583
5961
|
/** @example false */
|
|
5584
|
-
doNotRetry
|
|
5962
|
+
doNotRetry?: boolean | null;
|
|
5585
5963
|
/**
|
|
5586
5964
|
* Format: uri
|
|
5965
|
+
* @description URL of the HTTP request sent by the webhook. It is omitted or `null` for hook actions other than the conventional HTTP case (e.g. Slack or email notifications).
|
|
5587
5966
|
* @example http://example.com/
|
|
5588
5967
|
*/
|
|
5589
|
-
requestUrl
|
|
5590
|
-
|
|
5591
|
-
|
|
5592
|
-
|
|
5593
|
-
|
|
5594
|
-
|
|
5595
|
-
|
|
5968
|
+
requestUrl?: string | null;
|
|
5969
|
+
/** @example {\n "userId": {{userId}}... */
|
|
5970
|
+
payloadTemplate?: string | null;
|
|
5971
|
+
/** @example {\n "Authorization": "Bearer ..."} */
|
|
5972
|
+
headersTemplate?: string | null;
|
|
5973
|
+
/** @example Notify on failure */
|
|
5974
|
+
title?: string | null;
|
|
5975
|
+
/** @example this is webhook description */
|
|
5976
|
+
description?: string | null;
|
|
5977
|
+
slackMessage?: components["schemas"]["WebhookSlackMessage"];
|
|
5978
|
+
googleMail?: components["schemas"]["WebhookGoogleMail"];
|
|
5979
|
+
googleDrive?: components["schemas"]["WebhookGoogleDrive"];
|
|
5980
|
+
githubIssue?: components["schemas"]["WebhookGithubIssue"];
|
|
5981
|
+
lastDispatch?: components["schemas"]["WebhookLastDispatch"] | null;
|
|
5982
|
+
stats?: components["schemas"]["WebhookStats"] | null;
|
|
5596
5983
|
};
|
|
5597
|
-
/**
|
|
5598
|
-
|
|
5599
|
-
|
|
5984
|
+
/**
|
|
5985
|
+
* ListOfWebhookResources
|
|
5986
|
+
* @description Paginated list of webhooks with all their fields, including `payloadTemplate`.
|
|
5987
|
+
*/
|
|
5988
|
+
ListOfWebhookResources: components["schemas"]["PaginationResponse"] & {
|
|
5989
|
+
items: components["schemas"]["WebhookResource"][];
|
|
5990
|
+
};
|
|
5991
|
+
/** ListOfWebhookResourcesResponse */
|
|
5992
|
+
ListOfWebhookResourcesResponse: {
|
|
5993
|
+
data: components["schemas"]["ListOfWebhookResources"];
|
|
5994
|
+
};
|
|
5995
|
+
/**
|
|
5996
|
+
* ActorOAuthConnection
|
|
5997
|
+
* @description An OAuth connection configured on an Actor. Secret credentials are never returned.
|
|
5998
|
+
*/
|
|
5999
|
+
ActorOAuthConnection: {
|
|
6000
|
+
/** @example kD9fm2Xp4cJq7Lw8N */
|
|
6001
|
+
_id: string;
|
|
6002
|
+
/** @example zdc3Pyhyz3m8vjDeM */
|
|
6003
|
+
actorId: string;
|
|
6004
|
+
/**
|
|
6005
|
+
* @example GOOGLE
|
|
6006
|
+
* @enum {string}
|
|
6007
|
+
*/
|
|
6008
|
+
oAuthProviderType: "CUSTOM" | "GOOGLE";
|
|
6009
|
+
/**
|
|
6010
|
+
* Format: date-time
|
|
6011
|
+
* @example 2026-01-28T10:00:00.000Z
|
|
6012
|
+
*/
|
|
6013
|
+
createdAt: Date;
|
|
6014
|
+
/**
|
|
6015
|
+
* Format: date-time
|
|
6016
|
+
* @example 2026-01-28T10:00:00.000Z
|
|
6017
|
+
*/
|
|
6018
|
+
modifiedAt: Date;
|
|
6019
|
+
/** @description The public part of the connection's OAuth client configuration. */
|
|
6020
|
+
credentials?: {
|
|
6021
|
+
/** @example 1234567890-abc.apps.googleusercontent.com */
|
|
6022
|
+
clientId?: string;
|
|
6023
|
+
/** @example https://www.googleapis.com/auth/drive.file */
|
|
6024
|
+
scope?: string;
|
|
6025
|
+
/**
|
|
6026
|
+
* @description Display name of a `CUSTOM` provider.
|
|
6027
|
+
* @example My OAuth app
|
|
6028
|
+
*/
|
|
6029
|
+
label?: string;
|
|
6030
|
+
/**
|
|
6031
|
+
* @description Logo URL of a `CUSTOM` provider.
|
|
6032
|
+
* @example https://example.com/logo.png
|
|
6033
|
+
*/
|
|
6034
|
+
imageUrl?: string;
|
|
6035
|
+
};
|
|
6036
|
+
};
|
|
6037
|
+
/** ListOfActorOAuthConnections */
|
|
6038
|
+
ListOfActorOAuthConnections: {
|
|
6039
|
+
/** @example 1 */
|
|
6040
|
+
total: number;
|
|
6041
|
+
items: components["schemas"]["ActorOAuthConnection"][];
|
|
6042
|
+
};
|
|
6043
|
+
/** ListOfActorOAuthConnectionsResponse */
|
|
6044
|
+
ListOfActorOAuthConnectionsResponse: {
|
|
6045
|
+
data: components["schemas"]["ListOfActorOAuthConnections"];
|
|
5600
6046
|
};
|
|
5601
6047
|
/**
|
|
5602
6048
|
* ActorJobStatus
|
|
@@ -5618,10 +6064,25 @@ export interface components {
|
|
|
5618
6064
|
*/
|
|
5619
6065
|
clientIp?: string;
|
|
5620
6066
|
/**
|
|
5621
|
-
* @description User agent of the client that started the build.
|
|
6067
|
+
* @description User agent of the client that started the build. Returned only to the Actor owner.
|
|
5622
6068
|
* @example Mozilla/5.0 (iPad)
|
|
5623
6069
|
*/
|
|
5624
6070
|
userAgent?: string;
|
|
6071
|
+
/**
|
|
6072
|
+
* @description URL of the GitHub Actions run that started the build. Present only for builds started from CI.
|
|
6073
|
+
* @example https://github.com/apify/my-actor/actions/runs/123456789
|
|
6074
|
+
*/
|
|
6075
|
+
githubActionsRunUrl?: string;
|
|
6076
|
+
/**
|
|
6077
|
+
* @description ID of the Actor run that started the build. Returned only to the Actor owner.
|
|
6078
|
+
* @example HG7ML7M8z78YcAPEB
|
|
6079
|
+
*/
|
|
6080
|
+
actorRunId?: string;
|
|
6081
|
+
/**
|
|
6082
|
+
* @description ID of the webhook dispatch that started the build. Returned only to the Actor owner.
|
|
6083
|
+
* @example Zib4xbZsmvZeK55ua
|
|
6084
|
+
*/
|
|
6085
|
+
webhookDispatchId?: string;
|
|
5625
6086
|
};
|
|
5626
6087
|
/** BuildListItem */
|
|
5627
6088
|
BuildListItem: {
|
|
@@ -5642,8 +6103,11 @@ export interface components {
|
|
|
5642
6103
|
* @example 2019-12-12T09:30:12.202Z
|
|
5643
6104
|
*/
|
|
5644
6105
|
finishedAt?: Date | null;
|
|
5645
|
-
/**
|
|
5646
|
-
|
|
6106
|
+
/**
|
|
6107
|
+
* @description Total cost in USD for this build. Requires authentication token to access.
|
|
6108
|
+
* @example 0.02
|
|
6109
|
+
*/
|
|
6110
|
+
usageTotalUsd?: number;
|
|
5647
6111
|
/** @example 0.1.1 */
|
|
5648
6112
|
buildNumber: string;
|
|
5649
6113
|
/** @example 10000 */
|
|
@@ -5679,12 +6143,29 @@ export interface components {
|
|
|
5679
6143
|
memoryMbytes?: number | null;
|
|
5680
6144
|
/** @example 2048 */
|
|
5681
6145
|
diskMbytes?: number | null;
|
|
6146
|
+
/**
|
|
6147
|
+
* @description The tag passed when starting the build. Present only when the `tag` parameter was used.
|
|
6148
|
+
* @example latest
|
|
6149
|
+
*/
|
|
6150
|
+
tag?: string | null;
|
|
6151
|
+
/** @description Whether this is a debug build. Present only on debug builds. */
|
|
6152
|
+
debug?: boolean | null;
|
|
5682
6153
|
};
|
|
5683
6154
|
/** BuildUsage */
|
|
5684
6155
|
BuildUsage: {
|
|
5685
6156
|
/** @example 0.08 */
|
|
5686
6157
|
ACTOR_COMPUTE_UNITS?: number | null;
|
|
5687
6158
|
};
|
|
6159
|
+
/**
|
|
6160
|
+
* ActorDefinitionMeta
|
|
6161
|
+
* @description Additional information about the Actor.
|
|
6162
|
+
*/
|
|
6163
|
+
ActorDefinitionMeta: {
|
|
6164
|
+
/** @description The ID of the template from which the Actor was created. */
|
|
6165
|
+
templateId?: string;
|
|
6166
|
+
/** @description The tool or model that generated the Actor. */
|
|
6167
|
+
generatedBy?: string;
|
|
6168
|
+
};
|
|
5688
6169
|
/**
|
|
5689
6170
|
* ActorDefinition
|
|
5690
6171
|
* @description The definition of the Actor, the full specification of this field can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/actor-json)
|
|
@@ -5697,10 +6178,15 @@ export interface components {
|
|
|
5697
6178
|
actorSpecification?: 1;
|
|
5698
6179
|
/** @description The name of the Actor. */
|
|
5699
6180
|
name?: string;
|
|
6181
|
+
/** @description The human-readable display title of the Actor, shown in Apify Console and Apify Store. */
|
|
6182
|
+
title?: string;
|
|
6183
|
+
/** @description The description of the Actor. */
|
|
6184
|
+
description?: string;
|
|
5700
6185
|
/** @description The version of the Actor, typically a dot-separated sequence of numbers (e.g., `0.1`, `1.0`, or `0.0.1`). */
|
|
5701
6186
|
version?: string;
|
|
5702
6187
|
/** @description The tag name to be applied to a successful build of the Actor. Defaults to 'latest' if not specified. */
|
|
5703
6188
|
buildTag?: string;
|
|
6189
|
+
meta?: components["schemas"]["ActorDefinitionMeta"];
|
|
5704
6190
|
/** @description A map of environment variables to be used during local development and deployment. */
|
|
5705
6191
|
environmentVariables?: {
|
|
5706
6192
|
[key: string]: string;
|
|
@@ -5713,11 +6199,19 @@ export interface components {
|
|
|
5713
6199
|
readme?: string | null;
|
|
5714
6200
|
/** @description The input schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/input-schema) */
|
|
5715
6201
|
input?: Record<string, unknown> | null;
|
|
6202
|
+
/** @description The output schema object, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/output-schema) */
|
|
6203
|
+
output?: Record<string, unknown> | null;
|
|
5716
6204
|
/** @description The path to the CHANGELOG file displayed in the Actor's information tab. */
|
|
5717
6205
|
changelog?: string | null;
|
|
5718
6206
|
storages?: {
|
|
5719
6207
|
/** @description Defines the schema of items in your dataset, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema) */
|
|
5720
6208
|
dataset?: Record<string, unknown>;
|
|
6209
|
+
/** @description Maps dataset aliases to the schemas of the Actor's datasets, the full specification can be found in [Apify docs](https://docs.apify.com/platform/storage/dataset-schema/multiple-datasets) */
|
|
6210
|
+
datasets?: {
|
|
6211
|
+
[key: string]: Record<string, unknown>;
|
|
6212
|
+
};
|
|
6213
|
+
/** @description Defines the schema of the Actor's default key-value store, the full specification can be found in [Apify docs](https://docs.apify.com/platform/storage/key-value-store-schema) */
|
|
6214
|
+
keyValueStore?: Record<string, unknown>;
|
|
5721
6215
|
};
|
|
5722
6216
|
/** @description Specifies the default amount of memory in megabytes to be used when the Actor is started. Can be an integer or a [dynamic memory expression](https://docs.apify.com/actors/development/actor-definition/dynamic-actor-memory). */
|
|
5723
6217
|
defaultMemoryMbytes?: string | number;
|
|
@@ -5727,6 +6221,10 @@ export interface components {
|
|
|
5727
6221
|
maxMemoryMbytes?: number;
|
|
5728
6222
|
/** @description Specifies whether Standby mode is enabled for the Actor. */
|
|
5729
6223
|
usesStandbyMode?: boolean;
|
|
6224
|
+
/** @description The OpenAPI v3 specification of the web server running in the Actor, the full specification can be found in [Apify docs](https://docs.apify.com/platform/actors/development/actor-definition/web-server-schema) */
|
|
6225
|
+
webServerSchema?: Record<string, unknown>;
|
|
6226
|
+
/** @description The HTTP path where the Actor's web server exposes its MCP (Model Context Protocol) server, for example `/mcp`. */
|
|
6227
|
+
webServerMcpPath?: string;
|
|
5730
6228
|
};
|
|
5731
6229
|
/**
|
|
5732
6230
|
* Build
|
|
@@ -5853,6 +6351,31 @@ export interface components {
|
|
|
5853
6351
|
* @example # Magic Actor\nThis Actor is magic.
|
|
5854
6352
|
*/
|
|
5855
6353
|
readme?: string | null;
|
|
6354
|
+
/**
|
|
6355
|
+
* @deprecated
|
|
6356
|
+
* @example # Changelog\n## 0.1.1\n- Initial release
|
|
6357
|
+
*/
|
|
6358
|
+
changelog?: string | null;
|
|
6359
|
+
/**
|
|
6360
|
+
* @description Exit code of the build process. Set when the build finishes.
|
|
6361
|
+
* @example 0
|
|
6362
|
+
*/
|
|
6363
|
+
exitCode?: number | null;
|
|
6364
|
+
/**
|
|
6365
|
+
* @description ID of the Git commit the build was created from. Present only for builds from a Git repository.
|
|
6366
|
+
* @example 5f1d2b3c4a5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a
|
|
6367
|
+
*/
|
|
6368
|
+
gitCommitId?: string;
|
|
6369
|
+
/**
|
|
6370
|
+
* @description Name of the Git branch the build was created from. Present only for builds from a Git repository.
|
|
6371
|
+
* @example main
|
|
6372
|
+
*/
|
|
6373
|
+
gitBranchName?: string;
|
|
6374
|
+
/**
|
|
6375
|
+
* @description ID of the organization member who started the build. Present only for builds started in an organization account.
|
|
6376
|
+
* @example klmdEpoiojmdEMlk3
|
|
6377
|
+
*/
|
|
6378
|
+
createdByOrganizationMemberUserId?: string;
|
|
5856
6379
|
/** @example 0.1.1 */
|
|
5857
6380
|
buildNumber: string;
|
|
5858
6381
|
/**
|
|
@@ -5880,6 +6403,16 @@ export interface components {
|
|
|
5880
6403
|
gitRepoUrl?: string;
|
|
5881
6404
|
/** @description Inline source files, present when sourceType is SOURCE_FILES. */
|
|
5882
6405
|
sourceFiles?: components["schemas"]["SourceCodeFile"][];
|
|
6406
|
+
/**
|
|
6407
|
+
* @description URL of the GitHub Gist, present when sourceType is GITHUB_GIST.
|
|
6408
|
+
* @example https://gist.github.com/jancurn/2dd8fa0dd5bf9ea2b4d5a6e0f6a0e8c5
|
|
6409
|
+
*/
|
|
6410
|
+
gitHubGistUrl?: string;
|
|
6411
|
+
/**
|
|
6412
|
+
* @description URL of the tarball or ZIP file, present when sourceType is TARBALL. Returned only to the Actor owner.
|
|
6413
|
+
* @example https://example.com/my-actor.zip
|
|
6414
|
+
*/
|
|
6415
|
+
tarballUrl?: string;
|
|
5883
6416
|
};
|
|
5884
6417
|
actorDefinition?: components["schemas"]["ActorDefinition"] | null;
|
|
5885
6418
|
};
|
|
@@ -5904,6 +6437,38 @@ export interface components {
|
|
|
5904
6437
|
* @description Time when the run was scheduled.
|
|
5905
6438
|
*/
|
|
5906
6439
|
scheduledAt?: Date | null;
|
|
6440
|
+
/**
|
|
6441
|
+
* @description ID of the Actor run that started this run. Present only when the run was started from another run.
|
|
6442
|
+
* @example HG7ML7M8z78YcAPEB
|
|
6443
|
+
*/
|
|
6444
|
+
actorRunId?: string;
|
|
6445
|
+
/**
|
|
6446
|
+
* @description ID of the webhook dispatch that started the run. Present only when the run was started by a webhook.
|
|
6447
|
+
* @example asdLZtadYvn4mBZmm
|
|
6448
|
+
*/
|
|
6449
|
+
webhookDispatchId?: string;
|
|
6450
|
+
/**
|
|
6451
|
+
* @description ID of the schedule action that started the Actor. Present only on runs of Actors started by a schedule.
|
|
6452
|
+
* @example c6KfSgoQzFhMk3etc
|
|
6453
|
+
*/
|
|
6454
|
+
scheduledAct2Id?: string;
|
|
6455
|
+
/**
|
|
6456
|
+
* @description ID of the schedule action that started the Actor task. Present only on runs of tasks started by a schedule.
|
|
6457
|
+
* @example c6KfSgoQzFhMk3etc
|
|
6458
|
+
*/
|
|
6459
|
+
scheduledActorTaskId?: string;
|
|
6460
|
+
};
|
|
6461
|
+
/**
|
|
6462
|
+
* RunStandby
|
|
6463
|
+
* @description Standby configuration of the run. Present only on Actor Standby runs.
|
|
6464
|
+
*/
|
|
6465
|
+
RunStandby: {
|
|
6466
|
+
/**
|
|
6467
|
+
* @description How the Standby run is deployed: `SINGLE_TENANT`, `MULTI_TENANT_FREE_USERS`, `MULTI_TENANT_PAYING_USERS` or `MULTI_TENANT_OWNER_PAID`. `SINGLE_TENANT` is a private instance in the user's account.
|
|
6468
|
+
* The `MULTI_TENANT_*` values are runs in the Actor owner's account that serve requests from many users.
|
|
6469
|
+
* @example SINGLE_TENANT
|
|
6470
|
+
*/
|
|
6471
|
+
deployment: string;
|
|
5907
6472
|
};
|
|
5908
6473
|
/** RunListItem */
|
|
5909
6474
|
RunListItem: {
|
|
@@ -5941,6 +6506,8 @@ export interface components {
|
|
|
5941
6506
|
defaultDatasetId: string;
|
|
5942
6507
|
/** @example so93g2shcDzK3pA85 */
|
|
5943
6508
|
defaultRequestQueueId: string;
|
|
6509
|
+
/** @description Standby configuration of the run. `null` for runs that are not Actor Standby runs. */
|
|
6510
|
+
standby?: components["schemas"]["RunStandby"] | null;
|
|
5944
6511
|
};
|
|
5945
6512
|
/** ListOfRuns */
|
|
5946
6513
|
ListOfRuns: components["schemas"]["PaginationResponse"] & {
|
|
@@ -6036,6 +6603,40 @@ export interface components {
|
|
|
6036
6603
|
/** @example 0.13804 */
|
|
6037
6604
|
computeUnits?: number;
|
|
6038
6605
|
};
|
|
6606
|
+
/**
|
|
6607
|
+
* RunEventUsage
|
|
6608
|
+
* @description Cost of a single pay-per-event event type charged during the run.
|
|
6609
|
+
*/
|
|
6610
|
+
RunEventUsage: {
|
|
6611
|
+
/**
|
|
6612
|
+
* @description Total cost of all charges of this event in USD.
|
|
6613
|
+
* @example 0.15
|
|
6614
|
+
*/
|
|
6615
|
+
eventTotalUsd: number;
|
|
6616
|
+
/**
|
|
6617
|
+
* @description Human-readable title of the event.
|
|
6618
|
+
* @example Page crawled
|
|
6619
|
+
*/
|
|
6620
|
+
eventTitle: string;
|
|
6621
|
+
};
|
|
6622
|
+
/**
|
|
6623
|
+
* IntegrationTracking
|
|
6624
|
+
* @description Information about the third-party integration that created the resource.
|
|
6625
|
+
*/
|
|
6626
|
+
IntegrationTracking: {
|
|
6627
|
+
/**
|
|
6628
|
+
* @description Name of the integration platform.
|
|
6629
|
+
* @example zapier
|
|
6630
|
+
*/
|
|
6631
|
+
platform?: string;
|
|
6632
|
+
/** @description ID of the integration app. */
|
|
6633
|
+
appId?: string;
|
|
6634
|
+
/**
|
|
6635
|
+
* @description Whether the resource was created by an AI tool.
|
|
6636
|
+
* @example false
|
|
6637
|
+
*/
|
|
6638
|
+
isAiTool?: boolean;
|
|
6639
|
+
};
|
|
6039
6640
|
/** RunOptions */
|
|
6040
6641
|
RunOptions: {
|
|
6041
6642
|
/** @example latest */
|
|
@@ -6046,10 +6647,20 @@ export interface components {
|
|
|
6046
6647
|
memoryMbytes: number;
|
|
6047
6648
|
/** @example 2048 */
|
|
6048
6649
|
diskMbytes: number;
|
|
6650
|
+
/**
|
|
6651
|
+
* @description Whether to automatically restart the run if it fails.
|
|
6652
|
+
* @example false
|
|
6653
|
+
*/
|
|
6654
|
+
restartOnError?: boolean | null;
|
|
6049
6655
|
/** @example 1000 */
|
|
6050
6656
|
maxItems?: number | null;
|
|
6051
6657
|
/** @example 5 */
|
|
6052
6658
|
maxTotalChargeUsd?: number | null;
|
|
6659
|
+
/**
|
|
6660
|
+
* @description Whether the user explicitly set `maxTotalChargeUsd` when starting the run. Not present for pay-per-result Actors.
|
|
6661
|
+
* @example true
|
|
6662
|
+
*/
|
|
6663
|
+
isMaxTotalChargeUsdSetByUser?: boolean;
|
|
6053
6664
|
};
|
|
6054
6665
|
/**
|
|
6055
6666
|
* GeneralAccess
|
|
@@ -6084,6 +6695,8 @@ export interface components {
|
|
|
6084
6695
|
PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number | null;
|
|
6085
6696
|
/** @example 3 */
|
|
6086
6697
|
PROXY_SERPS?: number | null;
|
|
6698
|
+
/** @example 0 */
|
|
6699
|
+
PROXY_UNBLOCKER_UNITS?: number | null;
|
|
6087
6700
|
};
|
|
6088
6701
|
/**
|
|
6089
6702
|
* RunUsageUsd
|
|
@@ -6114,6 +6727,8 @@ export interface components {
|
|
|
6114
6727
|
PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number | null;
|
|
6115
6728
|
/** @example 0.003 */
|
|
6116
6729
|
PROXY_SERPS?: number | null;
|
|
6730
|
+
/** @example 0 */
|
|
6731
|
+
PROXY_UNBLOCKER_UNITS?: number | null;
|
|
6117
6732
|
};
|
|
6118
6733
|
/**
|
|
6119
6734
|
* RunMetamorphEvent
|
|
@@ -6141,6 +6756,13 @@ export interface components {
|
|
|
6141
6756
|
* @example INPUT-METAMORPH-1
|
|
6142
6757
|
*/
|
|
6143
6758
|
inputKey?: string | null;
|
|
6759
|
+
/**
|
|
6760
|
+
* @description Build tags of the build used for the metamorphed Actor.
|
|
6761
|
+
* @example [
|
|
6762
|
+
* "latest"
|
|
6763
|
+
* ]
|
|
6764
|
+
*/
|
|
6765
|
+
buildTags?: string[];
|
|
6144
6766
|
};
|
|
6145
6767
|
/**
|
|
6146
6768
|
* Run
|
|
@@ -6208,6 +6830,49 @@ export interface components {
|
|
|
6208
6830
|
chargedEventCounts?: {
|
|
6209
6831
|
[key: string]: number;
|
|
6210
6832
|
};
|
|
6833
|
+
/**
|
|
6834
|
+
* @description A map of charged event types to the number of their charges that have already been accounted for billing. Present only for pay-per-event Actors.
|
|
6835
|
+
* @example {
|
|
6836
|
+
* "actor-start": 1,
|
|
6837
|
+
* "page-crawled": 150
|
|
6838
|
+
* }
|
|
6839
|
+
*/
|
|
6840
|
+
accountedChargedEventCounts?: {
|
|
6841
|
+
[key: string]: number;
|
|
6842
|
+
} | null;
|
|
6843
|
+
/** @description Cost breakdown of the pay-per-event charges in USD, keyed by event type. Present only for pay-per-event runs, and not when the run was started by the Actor's owner. */
|
|
6844
|
+
eventUsage?: {
|
|
6845
|
+
[key: string]: components["schemas"]["RunEventUsage"];
|
|
6846
|
+
};
|
|
6847
|
+
/**
|
|
6848
|
+
* @description Total price in USD of the pay-per-event charges made to other users. Present only on multi-tenant Standby runs.
|
|
6849
|
+
* @example 0.5
|
|
6850
|
+
*/
|
|
6851
|
+
externalChargedTotalUsd?: number;
|
|
6852
|
+
/** @description Standby configuration of the run. `null` for runs that are not Actor Standby runs. */
|
|
6853
|
+
standby?: components["schemas"]["RunStandby"] | null;
|
|
6854
|
+
/** @description Present only when the run was started by a third-party integration. */
|
|
6855
|
+
integrationTracking?: components["schemas"]["IntegrationTracking"];
|
|
6856
|
+
/**
|
|
6857
|
+
* @description ID of the organization member who started the run. Present only for runs started on behalf of an organization.
|
|
6858
|
+
* @example 7sT5jcggjjA9fNcxF
|
|
6859
|
+
*/
|
|
6860
|
+
createdByOrganizationMemberUserId?: string;
|
|
6861
|
+
/**
|
|
6862
|
+
* Format: uri
|
|
6863
|
+
* @description URL of the run in Apify Console. Returned only by the [Get Actor run](https://docs.apify.com/api/v2/actor-run-get) endpoint.
|
|
6864
|
+
* @example https://console.apify.com/view/runs/HG7ML7M8z78YcAPEB
|
|
6865
|
+
*/
|
|
6866
|
+
consoleUrl?: string;
|
|
6867
|
+
/**
|
|
6868
|
+
* @description Output links of the run, generated from the output schema of the Actor build. Present only if the build defines an output schema.
|
|
6869
|
+
* @example {
|
|
6870
|
+
* "results": "https://api.apify.com/v2/datasets/wmKPijuyDnPZAPRMk/items"
|
|
6871
|
+
* }
|
|
6872
|
+
*/
|
|
6873
|
+
output?: {
|
|
6874
|
+
[key: string]: string;
|
|
6875
|
+
};
|
|
6211
6876
|
/** @description Configuration options for the Actor run. */
|
|
6212
6877
|
options: components["schemas"]["RunOptions"];
|
|
6213
6878
|
/**
|
|
@@ -6319,12 +6984,12 @@ export interface components {
|
|
|
6319
6984
|
/** @example 3 */
|
|
6320
6985
|
writeCount?: number;
|
|
6321
6986
|
/**
|
|
6322
|
-
* @description Total storage size in bytes.
|
|
6987
|
+
* @description Total storage size in bytes.
|
|
6323
6988
|
* @example 783
|
|
6324
6989
|
*/
|
|
6325
6990
|
storageBytes?: number;
|
|
6326
6991
|
/**
|
|
6327
|
-
* @description Uncompressed size in bytes.
|
|
6992
|
+
* @description Uncompressed size in bytes.
|
|
6328
6993
|
* @example 0
|
|
6329
6994
|
*/
|
|
6330
6995
|
inflatedBytes?: number;
|
|
@@ -6335,6 +7000,8 @@ export interface components {
|
|
|
6335
7000
|
id: string;
|
|
6336
7001
|
/** @example d7b9MDYsbtX5L7XAj */
|
|
6337
7002
|
name?: string | null;
|
|
7003
|
+
/** @example My Dataset */
|
|
7004
|
+
title?: string | null;
|
|
6338
7005
|
/** @example wRsJZtadYvn4mBZmm */
|
|
6339
7006
|
userId: string;
|
|
6340
7007
|
/**
|
|
@@ -6561,6 +7228,8 @@ export interface components {
|
|
|
6561
7228
|
id: string;
|
|
6562
7229
|
/** @example d7b9MDYsbtX5L7XAj */
|
|
6563
7230
|
name?: string | null;
|
|
7231
|
+
/** @example My Store */
|
|
7232
|
+
title?: string | null;
|
|
6564
7233
|
/** @example BPWDBd7Z9c746JAnF */
|
|
6565
7234
|
userId?: string | null;
|
|
6566
7235
|
/** @example janedoe */
|
|
@@ -6794,6 +7463,11 @@ export interface components {
|
|
|
6794
7463
|
* @example some-name
|
|
6795
7464
|
*/
|
|
6796
7465
|
name?: string | null;
|
|
7466
|
+
/**
|
|
7467
|
+
* @description The title of the request queue.
|
|
7468
|
+
* @example My Queue
|
|
7469
|
+
*/
|
|
7470
|
+
title?: string | null;
|
|
6797
7471
|
userId: components["schemas"]["QueueUserId"];
|
|
6798
7472
|
/** @description The ID of the Actor that created this request queue. */
|
|
6799
7473
|
actId?: string | null;
|
|
@@ -6912,12 +7586,26 @@ export interface components {
|
|
|
6912
7586
|
* @example sbJ7klsdf7ujN9l
|
|
6913
7587
|
*/
|
|
6914
7588
|
RequestId: string;
|
|
7589
|
+
/**
|
|
7590
|
+
* Format: date-time
|
|
7591
|
+
* @description The timestamp when the lock on this request expires.
|
|
7592
|
+
* @example 2022-06-14T23:00:00.000Z
|
|
7593
|
+
*/
|
|
7594
|
+
LockExpiresAt: Date;
|
|
6915
7595
|
/**
|
|
6916
7596
|
* RequestResource
|
|
6917
7597
|
* @description A request stored in the request queue, including its metadata and processing state.
|
|
6918
7598
|
*/
|
|
6919
7599
|
RequestResource: components["schemas"]["RequestBase"] & {
|
|
6920
7600
|
id: components["schemas"]["RequestId"];
|
|
7601
|
+
/** @description The timestamp when the lock on this request expires. Only present while the request is locked. */
|
|
7602
|
+
lockExpiresAt?: components["schemas"]["LockExpiresAt"];
|
|
7603
|
+
/**
|
|
7604
|
+
* @description Key of the client that last locked the request. It is set when the request is locked and removed only by
|
|
7605
|
+
* an explicit unlock or by an update of the request, so it can still be present after the lock has expired.
|
|
7606
|
+
* @example my-client-key
|
|
7607
|
+
*/
|
|
7608
|
+
lockByClient?: string;
|
|
6921
7609
|
};
|
|
6922
7610
|
/**
|
|
6923
7611
|
* ListOfRequests
|
|
@@ -7175,12 +7863,6 @@ export interface components {
|
|
|
7175
7863
|
UpdateRequestResponse: {
|
|
7176
7864
|
data: components["schemas"]["RequestRegistration"];
|
|
7177
7865
|
};
|
|
7178
|
-
/**
|
|
7179
|
-
* Format: date-time
|
|
7180
|
-
* @description The timestamp when the lock on this request expires.
|
|
7181
|
-
* @example 2022-06-14T23:00:00.000Z
|
|
7182
|
-
*/
|
|
7183
|
-
LockExpiresAt: Date;
|
|
7184
7866
|
/**
|
|
7185
7867
|
* RequestLockInfo
|
|
7186
7868
|
* @description Information about a request lock.
|
|
@@ -7342,6 +8024,12 @@ export interface components {
|
|
|
7342
8024
|
TaskStats: {
|
|
7343
8025
|
/** @example 15 */
|
|
7344
8026
|
totalRuns?: number;
|
|
8027
|
+
/**
|
|
8028
|
+
* Format: date-time
|
|
8029
|
+
* @description Time when the last run of the task started. In the task list, it's `null` if the task has no runs. In a single task, it's omitted if the task has no runs.
|
|
8030
|
+
* @example 2019-11-30T07:34:24.202Z
|
|
8031
|
+
*/
|
|
8032
|
+
lastRunStartedAt?: Date | null;
|
|
7345
8033
|
};
|
|
7346
8034
|
/** TaskListItem */
|
|
7347
8035
|
TaskListItem: {
|
|
@@ -7355,6 +8043,8 @@ export interface components {
|
|
|
7355
8043
|
actName?: string | null;
|
|
7356
8044
|
/** @example my-task */
|
|
7357
8045
|
name: string;
|
|
8046
|
+
/** @example My task */
|
|
8047
|
+
title?: string | null;
|
|
7358
8048
|
/** @example janedoe */
|
|
7359
8049
|
username?: string | null;
|
|
7360
8050
|
/** @example janedoe */
|
|
@@ -7370,6 +8060,11 @@ export interface components {
|
|
|
7370
8060
|
*/
|
|
7371
8061
|
modifiedAt: Date;
|
|
7372
8062
|
stats?: components["schemas"]["TaskStats"] | null;
|
|
8063
|
+
/**
|
|
8064
|
+
* @description Whether the task is published. Based on the `publicConfig.publishedAt` field.
|
|
8065
|
+
* @example false
|
|
8066
|
+
*/
|
|
8067
|
+
isPublic?: boolean;
|
|
7373
8068
|
};
|
|
7374
8069
|
/** ListOfTasks */
|
|
7375
8070
|
ListOfTasks: components["schemas"]["PaginationResponse"] & {
|
|
@@ -7393,6 +8088,13 @@ export interface components {
|
|
|
7393
8088
|
maxTotalChargeUsd?: number | null;
|
|
7394
8089
|
/** @example false */
|
|
7395
8090
|
restartOnError?: boolean | null;
|
|
8091
|
+
/**
|
|
8092
|
+
* @description Whether the user explicitly set `maxTotalChargeUsd`. Returned only in schedule action `runOptions`, and only if it was provided.
|
|
8093
|
+
* @example true
|
|
8094
|
+
*/
|
|
8095
|
+
isMaxTotalChargeUsdSetByUser?: boolean | null;
|
|
8096
|
+
/** @description Permission level to run the Actor with, overriding the Actor's own setting. Returned only in schedule action `runOptions`, and only if it was provided. */
|
|
8097
|
+
forcePermissionLevel?: components["schemas"]["ActorPermissionLevel"] | null;
|
|
7396
8098
|
};
|
|
7397
8099
|
/**
|
|
7398
8100
|
* TaskInput
|
|
@@ -7449,6 +8151,15 @@ export interface components {
|
|
|
7449
8151
|
* one of the views declared on the resolved dataset. You can't publish a task without it.
|
|
7450
8152
|
*/
|
|
7451
8153
|
datasetView?: string | null;
|
|
8154
|
+
/** @description ID of the use-case category of the task. */
|
|
8155
|
+
categorization?: string | null;
|
|
8156
|
+
/** @description Names of the dataset fields highlighted on the public task page. */
|
|
8157
|
+
highlightedFields?: string[] | null;
|
|
8158
|
+
/** @description Frequently asked questions displayed on the public task page. */
|
|
8159
|
+
faq?: {
|
|
8160
|
+
question: string;
|
|
8161
|
+
answer: string;
|
|
8162
|
+
}[] | null;
|
|
7452
8163
|
};
|
|
7453
8164
|
/** CreateTaskRequest */
|
|
7454
8165
|
CreateTaskRequest: {
|
|
@@ -7477,6 +8188,11 @@ export interface components {
|
|
|
7477
8188
|
actId: string;
|
|
7478
8189
|
/** @example my-task */
|
|
7479
8190
|
name: string;
|
|
8191
|
+
/**
|
|
8192
|
+
* @description Task name in lowercase.
|
|
8193
|
+
* @example my-task
|
|
8194
|
+
*/
|
|
8195
|
+
nameLowerCase?: string;
|
|
7480
8196
|
/** @example janedoe */
|
|
7481
8197
|
username?: string | null;
|
|
7482
8198
|
/**
|
|
@@ -7561,52 +8277,6 @@ export interface components {
|
|
|
7561
8277
|
*/
|
|
7562
8278
|
isPublic?: boolean;
|
|
7563
8279
|
};
|
|
7564
|
-
/** WebhookResource */
|
|
7565
|
-
WebhookResource: {
|
|
7566
|
-
/** @example YiKoxjkaS9gjGTqhF */
|
|
7567
|
-
id: string;
|
|
7568
|
-
/**
|
|
7569
|
-
* Format: date-time
|
|
7570
|
-
* @example 2019-12-12T07:34:14.202Z
|
|
7571
|
-
*/
|
|
7572
|
-
createdAt: Date;
|
|
7573
|
-
/**
|
|
7574
|
-
* Format: date-time
|
|
7575
|
-
* @example 2019-12-13T08:36:13.202Z
|
|
7576
|
-
*/
|
|
7577
|
-
modifiedAt: Date;
|
|
7578
|
-
/** @example wRsJZtadYvn4mBZmm */
|
|
7579
|
-
userId: string;
|
|
7580
|
-
/** @example false */
|
|
7581
|
-
isAdHoc?: boolean | null;
|
|
7582
|
-
/** @example false */
|
|
7583
|
-
shouldInterpolateStrings?: boolean | null;
|
|
7584
|
-
/**
|
|
7585
|
-
* @example [
|
|
7586
|
-
* "ACTOR.RUN.SUCCEEDED"
|
|
7587
|
-
* ]
|
|
7588
|
-
*/
|
|
7589
|
-
eventTypes: components["schemas"]["WebhookEventType"][];
|
|
7590
|
-
condition: components["schemas"]["WebhookCondition"];
|
|
7591
|
-
/** @example false */
|
|
7592
|
-
ignoreSslErrors: boolean;
|
|
7593
|
-
/** @example false */
|
|
7594
|
-
doNotRetry?: boolean | null;
|
|
7595
|
-
/**
|
|
7596
|
-
* Format: uri
|
|
7597
|
-
* @description URL of the HTTP request sent by the webhook. It is omitted or `null` for hook actions other than the conventional HTTP case (e.g. Slack or email notifications).
|
|
7598
|
-
* @example http://example.com/
|
|
7599
|
-
*/
|
|
7600
|
-
requestUrl?: string | null;
|
|
7601
|
-
/** @example {\n "userId": {{userId}}... */
|
|
7602
|
-
payloadTemplate?: string | null;
|
|
7603
|
-
/** @example {\n "Authorization": "Bearer ..."} */
|
|
7604
|
-
headersTemplate?: string | null;
|
|
7605
|
-
/** @example this is webhook description */
|
|
7606
|
-
description?: string | null;
|
|
7607
|
-
lastDispatch?: components["schemas"]["WebhookLastDispatch"] | null;
|
|
7608
|
-
stats?: components["schemas"]["WebhookStats"] | null;
|
|
7609
|
-
};
|
|
7610
8280
|
/** UpdateRunRequest */
|
|
7611
8281
|
UpdateRunRequest: {
|
|
7612
8282
|
/** @example 3KH8gEpp4d8uQSe8T */
|
|
@@ -7629,11 +8299,116 @@ export interface components {
|
|
|
7629
8299
|
*/
|
|
7630
8300
|
requestId?: string;
|
|
7631
8301
|
};
|
|
8302
|
+
/**
|
|
8303
|
+
* ActorOAuthAccount
|
|
8304
|
+
* @description An account a user connected through an Actor OAuth connection.
|
|
8305
|
+
*/
|
|
8306
|
+
ActorOAuthAccount: {
|
|
8307
|
+
/** @example Rk3mP8xQ2vN5tY7wZ */
|
|
8308
|
+
_id: string;
|
|
8309
|
+
/** @example wRsJZtadYvn4mBZmm */
|
|
8310
|
+
userId: string;
|
|
8311
|
+
/** @example kD9fm2Xp4cJq7Lw8N */
|
|
8312
|
+
connectionId: string;
|
|
8313
|
+
/**
|
|
8314
|
+
* Format: date-time
|
|
8315
|
+
* @example 2026-01-28T10:00:00.000Z
|
|
8316
|
+
*/
|
|
8317
|
+
createdAt: Date;
|
|
8318
|
+
/**
|
|
8319
|
+
* Format: date-time
|
|
8320
|
+
* @example 2026-01-28T10:05:00.000Z
|
|
8321
|
+
*/
|
|
8322
|
+
modifiedAt: Date;
|
|
8323
|
+
/**
|
|
8324
|
+
* Format: date-time
|
|
8325
|
+
* @example 2026-01-28T10:05:00.000Z
|
|
8326
|
+
*/
|
|
8327
|
+
authorizedAt?: Date | null;
|
|
8328
|
+
/**
|
|
8329
|
+
* @description Label of the connected account, usually its email address.
|
|
8330
|
+
* @example jane.doe@example.com
|
|
8331
|
+
*/
|
|
8332
|
+
description?: string | null;
|
|
8333
|
+
/**
|
|
8334
|
+
* @description The OAuth tokens of the account, such as `access_token`, `refresh_token`, `scope` and `expiry_date`. The exact
|
|
8335
|
+
* fields depend on the OAuth provider.
|
|
8336
|
+
*/
|
|
8337
|
+
data: {
|
|
8338
|
+
[key: string]: unknown;
|
|
8339
|
+
};
|
|
8340
|
+
};
|
|
8341
|
+
/** ListOfActorOAuthAccounts */
|
|
8342
|
+
ListOfActorOAuthAccounts: {
|
|
8343
|
+
/** @example 1 */
|
|
8344
|
+
total: number;
|
|
8345
|
+
items: components["schemas"]["ActorOAuthAccount"][];
|
|
8346
|
+
};
|
|
8347
|
+
/** ListOfActorOAuthAccountsResponse */
|
|
8348
|
+
ListOfActorOAuthAccountsResponse: {
|
|
8349
|
+
data: components["schemas"]["ListOfActorOAuthAccounts"];
|
|
8350
|
+
};
|
|
8351
|
+
/** ActorOAuthAccountResponse */
|
|
8352
|
+
ActorOAuthAccountResponse: {
|
|
8353
|
+
data: components["schemas"]["ActorOAuthAccount"];
|
|
8354
|
+
};
|
|
7632
8355
|
/**
|
|
7633
8356
|
* @example ownedByMe
|
|
7634
8357
|
* @enum {string}
|
|
7635
8358
|
*/
|
|
7636
8359
|
StorageOwnership: "ownedByMe" | "sharedWithMe";
|
|
8360
|
+
/** KeyValueStoreListStats */
|
|
8361
|
+
KeyValueStoreListStats: {
|
|
8362
|
+
/** @example 9 */
|
|
8363
|
+
readCount?: number;
|
|
8364
|
+
/** @example 3 */
|
|
8365
|
+
writeCount?: number;
|
|
8366
|
+
/** @example 6 */
|
|
8367
|
+
deleteCount?: number;
|
|
8368
|
+
/** @example 2 */
|
|
8369
|
+
listCount?: number;
|
|
8370
|
+
/**
|
|
8371
|
+
* @description Storage size in bytes.
|
|
8372
|
+
* @example 18
|
|
8373
|
+
*/
|
|
8374
|
+
s3StorageBytes?: number;
|
|
8375
|
+
};
|
|
8376
|
+
/** KeyValueStoreListItem */
|
|
8377
|
+
KeyValueStoreListItem: {
|
|
8378
|
+
/** @example WkzbQMuFYuamGv3YF */
|
|
8379
|
+
id: string;
|
|
8380
|
+
/** @example d7b9MDYsbtX5L7XAj */
|
|
8381
|
+
name?: string | null;
|
|
8382
|
+
/** @example My Store */
|
|
8383
|
+
title?: string | null;
|
|
8384
|
+
/** @example BPWDBd7Z9c746JAnF */
|
|
8385
|
+
userId?: string | null;
|
|
8386
|
+
/** @example janedoe */
|
|
8387
|
+
username?: string | null;
|
|
8388
|
+
/**
|
|
8389
|
+
* Format: date-time
|
|
8390
|
+
* @example 2019-12-12T07:34:14.202Z
|
|
8391
|
+
*/
|
|
8392
|
+
createdAt: Date;
|
|
8393
|
+
/**
|
|
8394
|
+
* Format: date-time
|
|
8395
|
+
* @example 2019-12-13T08:36:13.202Z
|
|
8396
|
+
*/
|
|
8397
|
+
modifiedAt: Date;
|
|
8398
|
+
/**
|
|
8399
|
+
* Format: date-time
|
|
8400
|
+
* @example 2019-12-14T08:36:13.202Z
|
|
8401
|
+
*/
|
|
8402
|
+
accessedAt: Date;
|
|
8403
|
+
/** @example null */
|
|
8404
|
+
actId?: string | null;
|
|
8405
|
+
/** @example null */
|
|
8406
|
+
actRunId?: string | null;
|
|
8407
|
+
/** @description Optional JSON schema describing the keys stored in the key-value store. Older stores return it as a JSON string. */
|
|
8408
|
+
schema?: Record<string, unknown> | string | null;
|
|
8409
|
+
generalAccess?: components["schemas"]["GeneralAccess"] | null;
|
|
8410
|
+
stats?: components["schemas"]["KeyValueStoreListStats"];
|
|
8411
|
+
};
|
|
7637
8412
|
/** ListOfKeyValueStores */
|
|
7638
8413
|
ListOfKeyValueStores: components["schemas"]["PaginationResponse"] & {
|
|
7639
8414
|
/**
|
|
@@ -7641,7 +8416,7 @@ export interface components {
|
|
|
7641
8416
|
* @example false
|
|
7642
8417
|
*/
|
|
7643
8418
|
unnamed?: boolean;
|
|
7644
|
-
items: components["schemas"]["
|
|
8419
|
+
items: components["schemas"]["KeyValueStoreListItem"][];
|
|
7645
8420
|
};
|
|
7646
8421
|
/** ListOfKeyValueStoresResponse */
|
|
7647
8422
|
ListOfKeyValueStoresResponse: {
|
|
@@ -7652,7 +8427,7 @@ export interface components {
|
|
|
7652
8427
|
/** @example WkzbQMuFYuamGv3YF */
|
|
7653
8428
|
id: string;
|
|
7654
8429
|
/** @example d7b9MDYsbtX5L7XAj */
|
|
7655
|
-
name
|
|
8430
|
+
name?: string | null;
|
|
7656
8431
|
/** @example tbXmWu7GCxnyYtSiL */
|
|
7657
8432
|
userId: string;
|
|
7658
8433
|
/**
|
|
@@ -7698,6 +8473,42 @@ export interface components {
|
|
|
7698
8473
|
ListOfDatasetsResponse: {
|
|
7699
8474
|
data: components["schemas"]["ListOfDatasets"];
|
|
7700
8475
|
};
|
|
8476
|
+
/**
|
|
8477
|
+
* RequestQueueListStats
|
|
8478
|
+
* @description Statistics about request queue operations and storage, as returned in request queue lists.
|
|
8479
|
+
*/
|
|
8480
|
+
RequestQueueListStats: {
|
|
8481
|
+
/**
|
|
8482
|
+
* @description The number of delete operations performed on the request queue.
|
|
8483
|
+
* @example 0
|
|
8484
|
+
*/
|
|
8485
|
+
deleteCount?: number;
|
|
8486
|
+
/**
|
|
8487
|
+
* @description The number of times requests from the head were read.
|
|
8488
|
+
* @example 5
|
|
8489
|
+
*/
|
|
8490
|
+
headItemReadCount?: number;
|
|
8491
|
+
/**
|
|
8492
|
+
* @description The total number of read operations performed on the request queue.
|
|
8493
|
+
* @example 100
|
|
8494
|
+
*/
|
|
8495
|
+
readCount?: number;
|
|
8496
|
+
/**
|
|
8497
|
+
* @description The total number of write operations performed on the request queue.
|
|
8498
|
+
* @example 10
|
|
8499
|
+
*/
|
|
8500
|
+
writeCount?: number;
|
|
8501
|
+
/**
|
|
8502
|
+
* @description The storage size in bytes of requests stored in S3.
|
|
8503
|
+
* @example 0
|
|
8504
|
+
*/
|
|
8505
|
+
s3StorageBytes?: number;
|
|
8506
|
+
/**
|
|
8507
|
+
* @description The storage size in bytes of requests stored in DynamoDB.
|
|
8508
|
+
* @example 1024
|
|
8509
|
+
*/
|
|
8510
|
+
dynamodbStorageBytes?: number;
|
|
8511
|
+
};
|
|
7701
8512
|
/**
|
|
7702
8513
|
* RequestQueueListItem
|
|
7703
8514
|
* @description A shortened request queue object for list responses.
|
|
@@ -7708,13 +8519,18 @@ export interface components {
|
|
|
7708
8519
|
* @description The name of the request queue.
|
|
7709
8520
|
* @example some-name
|
|
7710
8521
|
*/
|
|
7711
|
-
name
|
|
8522
|
+
name?: string | null;
|
|
8523
|
+
/**
|
|
8524
|
+
* @description The title of the request queue.
|
|
8525
|
+
* @example My Queue
|
|
8526
|
+
*/
|
|
8527
|
+
title?: string | null;
|
|
7712
8528
|
userId: components["schemas"]["QueueUserId"];
|
|
7713
8529
|
/**
|
|
7714
8530
|
* @description The username of the user who owns the request queue.
|
|
7715
8531
|
* @example janedoe
|
|
7716
8532
|
*/
|
|
7717
|
-
username
|
|
8533
|
+
username?: string;
|
|
7718
8534
|
createdAt: components["schemas"]["QueueCreatedAt"];
|
|
7719
8535
|
modifiedAt: components["schemas"]["QueueModifiedAt"];
|
|
7720
8536
|
accessedAt: components["schemas"]["QueueAccessedAt"];
|
|
@@ -7733,7 +8549,7 @@ export interface components {
|
|
|
7733
8549
|
actRunId?: string | null;
|
|
7734
8550
|
hadMultipleClients: components["schemas"]["HadMultipleClients"];
|
|
7735
8551
|
generalAccess?: components["schemas"]["GeneralAccess"] | null;
|
|
7736
|
-
stats?: components["schemas"]["
|
|
8552
|
+
stats?: components["schemas"]["RequestQueueListStats"];
|
|
7737
8553
|
};
|
|
7738
8554
|
/**
|
|
7739
8555
|
* ListOfRequestQueues
|
|
@@ -7744,16 +8560,80 @@ export interface components {
|
|
|
7744
8560
|
* @description Whether the listing was filtered to only unnamed request queues.
|
|
7745
8561
|
* @example false
|
|
7746
8562
|
*/
|
|
7747
|
-
unnamed?: boolean;
|
|
7748
|
-
/** @description The array of request queues. */
|
|
7749
|
-
items: components["schemas"]["RequestQueueListItem"][];
|
|
8563
|
+
unnamed?: boolean;
|
|
8564
|
+
/** @description The array of request queues. */
|
|
8565
|
+
items: components["schemas"]["RequestQueueListItem"][];
|
|
8566
|
+
};
|
|
8567
|
+
/**
|
|
8568
|
+
* ListOfRequestQueuesResponse
|
|
8569
|
+
* @description Response containing a list of request queues.
|
|
8570
|
+
*/
|
|
8571
|
+
ListOfRequestQueuesResponse: {
|
|
8572
|
+
data: components["schemas"]["ListOfRequestQueues"];
|
|
8573
|
+
};
|
|
8574
|
+
/** WebhookListItem */
|
|
8575
|
+
WebhookListItem: {
|
|
8576
|
+
/** @example YiKoxjkaS9gjGTqhF */
|
|
8577
|
+
id: string;
|
|
8578
|
+
/**
|
|
8579
|
+
* Format: date-time
|
|
8580
|
+
* @example 2019-12-12T07:34:14.202Z
|
|
8581
|
+
*/
|
|
8582
|
+
createdAt: Date;
|
|
8583
|
+
/**
|
|
8584
|
+
* Format: date-time
|
|
8585
|
+
* @example 2019-12-13T08:36:13.202Z
|
|
8586
|
+
*/
|
|
8587
|
+
modifiedAt: Date;
|
|
8588
|
+
/** @example wRsJZtadYvn4mBZmm */
|
|
8589
|
+
userId: string;
|
|
8590
|
+
/** @example false */
|
|
8591
|
+
isAdHoc?: boolean | null;
|
|
8592
|
+
/** @example false */
|
|
8593
|
+
isApifyIntegration?: boolean;
|
|
8594
|
+
/** @example true */
|
|
8595
|
+
isEnabled?: boolean;
|
|
8596
|
+
/** @example HTTP_REQUEST */
|
|
8597
|
+
actionType?: string;
|
|
8598
|
+
/** @example false */
|
|
8599
|
+
shouldInterpolateStrings?: boolean | null;
|
|
8600
|
+
/**
|
|
8601
|
+
* @example [
|
|
8602
|
+
* "ACTOR.RUN.SUCCEEDED"
|
|
8603
|
+
* ]
|
|
8604
|
+
*/
|
|
8605
|
+
eventTypes: components["schemas"]["WebhookEventType"][];
|
|
8606
|
+
condition: components["schemas"]["WebhookCondition"];
|
|
8607
|
+
/** @example false */
|
|
8608
|
+
ignoreSslErrors: boolean;
|
|
8609
|
+
/** @example false */
|
|
8610
|
+
doNotRetry: boolean;
|
|
8611
|
+
/**
|
|
8612
|
+
* Format: uri
|
|
8613
|
+
* @description URL of the HTTP request sent by the webhook. It is omitted or `null` for hook actions other than the conventional HTTP case (e.g. Slack or email notifications).
|
|
8614
|
+
* @example http://example.com/
|
|
8615
|
+
*/
|
|
8616
|
+
requestUrl?: string | null;
|
|
8617
|
+
/** @example {\n "Authorization": "Bearer ..."} */
|
|
8618
|
+
headersTemplate?: string | null;
|
|
8619
|
+
/** @example Notify on failure */
|
|
8620
|
+
title?: string | null;
|
|
8621
|
+
/** @example this is webhook description */
|
|
8622
|
+
description?: string | null;
|
|
8623
|
+
slackMessage?: components["schemas"]["WebhookSlackMessage"];
|
|
8624
|
+
googleMail?: components["schemas"]["WebhookGoogleMail"];
|
|
8625
|
+
googleDrive?: components["schemas"]["WebhookGoogleDrive"];
|
|
8626
|
+
githubIssue?: components["schemas"]["WebhookGithubIssue"];
|
|
8627
|
+
lastDispatch?: components["schemas"]["WebhookLastDispatch"] | null;
|
|
8628
|
+
stats?: components["schemas"]["WebhookStats"] | null;
|
|
7750
8629
|
};
|
|
7751
|
-
/**
|
|
7752
|
-
|
|
7753
|
-
|
|
7754
|
-
|
|
7755
|
-
|
|
7756
|
-
|
|
8630
|
+
/** ListOfWebhooks */
|
|
8631
|
+
ListOfWebhooks: components["schemas"]["PaginationResponse"] & {
|
|
8632
|
+
items: components["schemas"]["WebhookListItem"][];
|
|
8633
|
+
};
|
|
8634
|
+
/** ListOfWebhooksResponse */
|
|
8635
|
+
ListOfWebhooksResponse: {
|
|
8636
|
+
data: components["schemas"]["ListOfWebhooks"];
|
|
7757
8637
|
};
|
|
7758
8638
|
/** CreateWebhookRequest */
|
|
7759
8639
|
CreateWebhookRequest: {
|
|
@@ -7824,6 +8704,11 @@ export interface components {
|
|
|
7824
8704
|
* @description A summary of the webhook that triggered this dispatch.
|
|
7825
8705
|
*/
|
|
7826
8706
|
WebhookDispatchWebhookSummary: {
|
|
8707
|
+
/**
|
|
8708
|
+
* @description ID of the webhook. The API returns it under `_id`, not `id`.
|
|
8709
|
+
* @example YiKoxjkaS9gjGTqhF
|
|
8710
|
+
*/
|
|
8711
|
+
_id?: string;
|
|
7827
8712
|
/** @example HTTP_REQUEST */
|
|
7828
8713
|
actionType?: string;
|
|
7829
8714
|
condition?: components["schemas"]["WebhookCondition"];
|
|
@@ -7835,6 +8720,12 @@ export interface components {
|
|
|
7835
8720
|
requestUrl?: string | null;
|
|
7836
8721
|
/** @example false */
|
|
7837
8722
|
isAdHoc?: boolean;
|
|
8723
|
+
/** @example false */
|
|
8724
|
+
isApifyIntegration?: boolean | null;
|
|
8725
|
+
slackMessage?: components["schemas"]["WebhookSlackMessage"];
|
|
8726
|
+
googleMail?: components["schemas"]["WebhookGoogleMail"];
|
|
8727
|
+
googleDrive?: components["schemas"]["WebhookGoogleDrive"];
|
|
8728
|
+
githubIssue?: components["schemas"]["WebhookGithubIssue"];
|
|
7838
8729
|
};
|
|
7839
8730
|
/** WebhookDispatch */
|
|
7840
8731
|
WebhookDispatch: {
|
|
@@ -7881,6 +8772,10 @@ export interface components {
|
|
|
7881
8772
|
responseStatus?: number | null;
|
|
7882
8773
|
/** @example {"foo": "bar"} */
|
|
7883
8774
|
responseBody?: string | null;
|
|
8775
|
+
/** @description Response of the Slack `chat.postMessage` call. Present only for successful calls of `SLACK_MESSAGE` webhooks. */
|
|
8776
|
+
debugPostMessage?: {
|
|
8777
|
+
[key: string]: unknown;
|
|
8778
|
+
};
|
|
7884
8779
|
}[];
|
|
7885
8780
|
};
|
|
7886
8781
|
/** WebhookDispatchResponse */
|
|
@@ -7932,6 +8827,14 @@ export interface components {
|
|
|
7932
8827
|
*/
|
|
7933
8828
|
lastRunAt?: Date | null;
|
|
7934
8829
|
};
|
|
8830
|
+
/**
|
|
8831
|
+
* ScheduleNotifications
|
|
8832
|
+
* @description Notification settings for this schedule.
|
|
8833
|
+
*/
|
|
8834
|
+
ScheduleNotifications: {
|
|
8835
|
+
/** @example true */
|
|
8836
|
+
email?: boolean;
|
|
8837
|
+
};
|
|
7935
8838
|
/** ScheduleListItemActionRunActor */
|
|
7936
8839
|
ScheduleListItemActionRunActor: {
|
|
7937
8840
|
/** @example ZReCs7hkdieq8ZUki */
|
|
@@ -7960,6 +8863,10 @@ export interface components {
|
|
|
7960
8863
|
ScheduleListItemAction: components["schemas"]["ScheduleListItemActionRunActor"] | components["schemas"]["ScheduleListItemActionRunActorTask"];
|
|
7961
8864
|
/** ScheduleListItem */
|
|
7962
8865
|
ScheduleListItem: components["schemas"]["ScheduleBase"] & {
|
|
8866
|
+
title?: string | null;
|
|
8867
|
+
notifications?: components["schemas"]["ScheduleNotifications"];
|
|
8868
|
+
/** @description Present only when the schedule was created by a third-party integration. */
|
|
8869
|
+
integrationTracking?: components["schemas"]["IntegrationTracking"];
|
|
7963
8870
|
actions: components["schemas"]["ScheduleListItemAction"][];
|
|
7964
8871
|
};
|
|
7965
8872
|
/** ListOfSchedules */
|
|
@@ -7970,14 +8877,6 @@ export interface components {
|
|
|
7970
8877
|
ListOfSchedulesResponse: {
|
|
7971
8878
|
data: components["schemas"]["ListOfSchedules"];
|
|
7972
8879
|
};
|
|
7973
|
-
/**
|
|
7974
|
-
* ScheduleNotifications
|
|
7975
|
-
* @description Notification settings for this schedule.
|
|
7976
|
-
*/
|
|
7977
|
-
ScheduleNotifications: {
|
|
7978
|
-
/** @example true */
|
|
7979
|
-
email?: boolean;
|
|
7980
|
-
};
|
|
7981
8880
|
/** ScheduleActionRunInput */
|
|
7982
8881
|
ScheduleActionRunInput: {
|
|
7983
8882
|
/** @example {\n "foo": "actor"\n} */
|
|
@@ -8028,6 +8927,26 @@ export interface components {
|
|
|
8028
8927
|
notifications?: components["schemas"]["ScheduleNotifications"];
|
|
8029
8928
|
actions?: components["schemas"]["ScheduleCreateAction"][] | null;
|
|
8030
8929
|
};
|
|
8930
|
+
/**
|
|
8931
|
+
* ScheduleUiState
|
|
8932
|
+
* @description State of the schedule editor in Apify Console. It's removed when an API update changes `cronExpression` or `timezone`.
|
|
8933
|
+
*/
|
|
8934
|
+
ScheduleUiState: {
|
|
8935
|
+
/**
|
|
8936
|
+
* @description Version of the editor state format.
|
|
8937
|
+
* @example 1
|
|
8938
|
+
*/
|
|
8939
|
+
version?: number;
|
|
8940
|
+
/** @description Editor form values, such as the frequency settings the cron expression was built from. */
|
|
8941
|
+
data?: {
|
|
8942
|
+
/** @example 0 8 * * * */
|
|
8943
|
+
cronExpression?: string;
|
|
8944
|
+
/** @example UTC */
|
|
8945
|
+
timezone?: string;
|
|
8946
|
+
} & {
|
|
8947
|
+
[key: string]: unknown;
|
|
8948
|
+
};
|
|
8949
|
+
};
|
|
8031
8950
|
/** ScheduleActionRunActor */
|
|
8032
8951
|
ScheduleActionRunActor: {
|
|
8033
8952
|
/** @example c6KfSgoQzFhMk3etc */
|
|
@@ -8063,6 +8982,9 @@ export interface components {
|
|
|
8063
8982
|
description?: string | null;
|
|
8064
8983
|
title?: string | null;
|
|
8065
8984
|
notifications?: components["schemas"]["ScheduleNotifications"];
|
|
8985
|
+
uiState?: components["schemas"]["ScheduleUiState"];
|
|
8986
|
+
/** @description Present only when the schedule was created by a third-party integration. */
|
|
8987
|
+
integrationTracking?: components["schemas"]["IntegrationTracking"];
|
|
8066
8988
|
actions: components["schemas"]["ScheduleAction"][];
|
|
8067
8989
|
};
|
|
8068
8990
|
/** ScheduleResponse */
|
|
@@ -8128,6 +9050,39 @@ export interface components {
|
|
|
8128
9050
|
pricingPerEvent?: {
|
|
8129
9051
|
[key: string]: unknown;
|
|
8130
9052
|
} | null;
|
|
9053
|
+
/**
|
|
9054
|
+
* @description Price per unit in USD. Present only for `FLAT_PRICE_PER_MONTH` and non-tiered `PRICE_PER_DATASET_ITEM` pricing.
|
|
9055
|
+
* @example 5
|
|
9056
|
+
*/
|
|
9057
|
+
pricePerUnitUsd?: number;
|
|
9058
|
+
/**
|
|
9059
|
+
* @description Length of the free trial in minutes. Present only for `FLAT_PRICE_PER_MONTH` pricing.
|
|
9060
|
+
* @example 1440
|
|
9061
|
+
*/
|
|
9062
|
+
trialMinutes?: number;
|
|
9063
|
+
/**
|
|
9064
|
+
* @description Name of the charged unit. Present only for `PRICE_PER_DATASET_ITEM` pricing.
|
|
9065
|
+
* @example result
|
|
9066
|
+
*/
|
|
9067
|
+
unitName?: string;
|
|
9068
|
+
/**
|
|
9069
|
+
* @description Price per unit for each pricing tier. Present only for tiered `PRICE_PER_DATASET_ITEM` pricing.
|
|
9070
|
+
* @example {
|
|
9071
|
+
* "FREE": {
|
|
9072
|
+
* "tieredPricePerUnitUsd": 0.005
|
|
9073
|
+
* }
|
|
9074
|
+
* }
|
|
9075
|
+
*/
|
|
9076
|
+
tieredPricing?: {
|
|
9077
|
+
[key: string]: {
|
|
9078
|
+
tieredPricePerUnitUsd?: number;
|
|
9079
|
+
};
|
|
9080
|
+
};
|
|
9081
|
+
/**
|
|
9082
|
+
* Format: date-time
|
|
9083
|
+
* @example null
|
|
9084
|
+
*/
|
|
9085
|
+
notifiedAboutRentalToPpePriceChangeAt?: Date | null;
|
|
8131
9086
|
};
|
|
8132
9087
|
/** StoreActor */
|
|
8133
9088
|
StoreActor: {
|
|
@@ -8177,6 +9132,32 @@ export interface components {
|
|
|
8177
9132
|
badge?: string | null;
|
|
8178
9133
|
/** @description A brief, LLM-generated readme summary */
|
|
8179
9134
|
readmeSummary?: string;
|
|
9135
|
+
/** @description Compact input schema of the Actor's default build, with only property types and required properties. Returned only when `includeInputSchema=true` and the default build succeeded and defines input properties. */
|
|
9136
|
+
inputSchema?: {
|
|
9137
|
+
/** @example object */
|
|
9138
|
+
type: string;
|
|
9139
|
+
/**
|
|
9140
|
+
* @example {
|
|
9141
|
+
* "startUrls": {
|
|
9142
|
+
* "type": "array"
|
|
9143
|
+
* },
|
|
9144
|
+
* "maxItems": {
|
|
9145
|
+
* "type": "integer"
|
|
9146
|
+
* }
|
|
9147
|
+
* }
|
|
9148
|
+
*/
|
|
9149
|
+
properties: {
|
|
9150
|
+
[key: string]: {
|
|
9151
|
+
type?: string | string[];
|
|
9152
|
+
};
|
|
9153
|
+
};
|
|
9154
|
+
/**
|
|
9155
|
+
* @example [
|
|
9156
|
+
* "startUrls"
|
|
9157
|
+
* ]
|
|
9158
|
+
*/
|
|
9159
|
+
required?: string[];
|
|
9160
|
+
};
|
|
8180
9161
|
};
|
|
8181
9162
|
/** ListOfStoreActors */
|
|
8182
9163
|
ListOfStoreActors: components["schemas"]["PaginationResponse"] & {
|
|
@@ -8292,17 +9273,22 @@ export interface components {
|
|
|
8292
9273
|
};
|
|
8293
9274
|
/** ProxyGroup */
|
|
8294
9275
|
ProxyGroup: {
|
|
9276
|
+
/** @example Hsu2Sk8jPqxd3dNsB */
|
|
9277
|
+
id?: string;
|
|
8295
9278
|
/** @example Group1 */
|
|
8296
9279
|
name: string;
|
|
8297
9280
|
/** @example Group1 description */
|
|
8298
9281
|
description: string | null;
|
|
8299
9282
|
/** @example 10 */
|
|
8300
|
-
availableCount
|
|
9283
|
+
availableCount?: number;
|
|
8301
9284
|
};
|
|
8302
|
-
/**
|
|
9285
|
+
/**
|
|
9286
|
+
* ProxyResource
|
|
9287
|
+
* @description Proxy access info. Omitted when the user has no access to Apify Proxy.
|
|
9288
|
+
*/
|
|
8303
9289
|
ProxyResource: {
|
|
8304
9290
|
/** @example ad78knd9Jkjd86 */
|
|
8305
|
-
password
|
|
9291
|
+
password?: string | null;
|
|
8306
9292
|
groups: components["schemas"]["ProxyGroup"][];
|
|
8307
9293
|
};
|
|
8308
9294
|
/**
|
|
@@ -8380,6 +9366,52 @@ export interface components {
|
|
|
8380
9366
|
planPricing?: {
|
|
8381
9367
|
[key: string]: unknown;
|
|
8382
9368
|
};
|
|
9369
|
+
/**
|
|
9370
|
+
* @description Version of the plan definition.
|
|
9371
|
+
* @example 2
|
|
9372
|
+
*/
|
|
9373
|
+
planVersion?: number;
|
|
9374
|
+
/**
|
|
9375
|
+
* @description ID of the legacy plan this plan was migrated from.
|
|
9376
|
+
* @example STARTER
|
|
9377
|
+
*/
|
|
9378
|
+
legacyPlanId?: string;
|
|
9379
|
+
/** @example [] */
|
|
9380
|
+
planTags?: string[];
|
|
9381
|
+
/**
|
|
9382
|
+
* @description Mid-cycle overage threshold above which the user is billed for the current-cycle overage.
|
|
9383
|
+
* @example 500
|
|
9384
|
+
*/
|
|
9385
|
+
overageThresholdUsd?: number;
|
|
9386
|
+
/** @example 1000000 */
|
|
9387
|
+
maxMonthlyUnblockerUnits?: number;
|
|
9388
|
+
/** @example 100 */
|
|
9389
|
+
maxPublicActorTaskCount?: number;
|
|
9390
|
+
/** @example 10 */
|
|
9391
|
+
maxPublicActorTaskCountPerActor?: number;
|
|
9392
|
+
/**
|
|
9393
|
+
* @description If set, the plan can be subscribed only in this billing interval.
|
|
9394
|
+
* @example ANNUAL
|
|
9395
|
+
*/
|
|
9396
|
+
forceBillingInterval?: string;
|
|
9397
|
+
/**
|
|
9398
|
+
* @description Hours of personalized support with Apify engineers included in the plan, as `Nh/P`: `N` hours per period
|
|
9399
|
+
* `P`, where `P` is `M` (monthly), `Q` (quarterly), `B` (every 6 months) or `A` (annually), for example `1h/M`.
|
|
9400
|
+
* `null` or missing means the plan includes no personalized support.
|
|
9401
|
+
* @example 4h/M
|
|
9402
|
+
*/
|
|
9403
|
+
personalizedSupport?: string | null;
|
|
9404
|
+
/**
|
|
9405
|
+
* @description Level of monitoring services included in the plan. `null` or missing means the plan includes no monitoring service.
|
|
9406
|
+
* @example STANDARD
|
|
9407
|
+
* @enum {string|null}
|
|
9408
|
+
*/
|
|
9409
|
+
monitoringLevel?: "STANDARD" | null;
|
|
9410
|
+
/**
|
|
9411
|
+
* @description Marks the user as a paying customer even without a subscription.
|
|
9412
|
+
* @example false
|
|
9413
|
+
*/
|
|
9414
|
+
isPayingCustomer?: boolean;
|
|
8383
9415
|
};
|
|
8384
9416
|
/** EffectivePlatformFeature */
|
|
8385
9417
|
EffectivePlatformFeature: {
|
|
@@ -8419,9 +9451,10 @@ export interface components {
|
|
|
8419
9451
|
profile?: components["schemas"]["UserProfile"];
|
|
8420
9452
|
/**
|
|
8421
9453
|
* Format: email
|
|
9454
|
+
* @description Primary email of the user. It is `null` when the email is not verified.
|
|
8422
9455
|
* @example bob@example.com
|
|
8423
9456
|
*/
|
|
8424
|
-
email?: string;
|
|
9457
|
+
email?: string | null;
|
|
8425
9458
|
proxy?: components["schemas"]["ProxyResource"];
|
|
8426
9459
|
plan?: components["schemas"]["UserPlan"];
|
|
8427
9460
|
effectivePlatformFeatures?: components["schemas"]["EffectivePlatformFeatures"];
|
|
@@ -8432,6 +9465,11 @@ export interface components {
|
|
|
8432
9465
|
createdAt?: Date;
|
|
8433
9466
|
/** @example true */
|
|
8434
9467
|
isPaying?: boolean;
|
|
9468
|
+
/**
|
|
9469
|
+
* @description ID of the user who owns the organization. Present only for organization accounts.
|
|
9470
|
+
* @example wRsJZtadYvn4mBZmm
|
|
9471
|
+
*/
|
|
9472
|
+
organizationOwnerUserId?: string | null;
|
|
8435
9473
|
};
|
|
8436
9474
|
/** UserPrivateInfoResponse */
|
|
8437
9475
|
UserPrivateInfoResponse: {
|
|
@@ -8549,6 +9587,8 @@ export interface components {
|
|
|
8549
9587
|
dataRetentionDays: number;
|
|
8550
9588
|
/** @example 100 */
|
|
8551
9589
|
maxScheduleCount?: number;
|
|
9590
|
+
/** @example 1000000 */
|
|
9591
|
+
maxMonthlyUnblockerUnits?: number;
|
|
8552
9592
|
};
|
|
8553
9593
|
/** CurrentUsage */
|
|
8554
9594
|
CurrentUsage: {
|
|
@@ -8574,6 +9614,8 @@ export interface components {
|
|
|
8574
9614
|
teamAccountSeatCount: number;
|
|
8575
9615
|
/** @example 77 */
|
|
8576
9616
|
scheduleCount?: number;
|
|
9617
|
+
/** @example 1520 */
|
|
9618
|
+
monthlyUnblockerUnits?: number;
|
|
8577
9619
|
};
|
|
8578
9620
|
/** AccountLimits */
|
|
8579
9621
|
AccountLimits: {
|
|
@@ -8598,6 +9640,123 @@ export interface components {
|
|
|
8598
9640
|
*/
|
|
8599
9641
|
dataRetentionDays?: number;
|
|
8600
9642
|
};
|
|
9643
|
+
/**
|
|
9644
|
+
* GitProviderWorkspace
|
|
9645
|
+
* @description A place the user can create a repository in, such as their own account or an organization, group or workspace they can access.
|
|
9646
|
+
*/
|
|
9647
|
+
GitProviderWorkspace: {
|
|
9648
|
+
/**
|
|
9649
|
+
* @description The workspace identifier to pass as `workspace` when creating a repository: the account or organization login
|
|
9650
|
+
* on GitHub, the numeric namespace ID on GitLab, or the workspace slug on Bitbucket.
|
|
9651
|
+
* @example janedoe
|
|
9652
|
+
*/
|
|
9653
|
+
id: string;
|
|
9654
|
+
/** @example janedoe */
|
|
9655
|
+
label: string;
|
|
9656
|
+
};
|
|
9657
|
+
/**
|
|
9658
|
+
* GitProviderIntegration
|
|
9659
|
+
* @description A connected git provider account the user can create repositories through.
|
|
9660
|
+
*/
|
|
9661
|
+
GitProviderIntegration: {
|
|
9662
|
+
/**
|
|
9663
|
+
* @description The provider ID to use in the `providerId` path parameter: `github-app` for the GitHub App, or the ID of a
|
|
9664
|
+
* connected GitLab or Bitbucket integration.
|
|
9665
|
+
* @example github-app
|
|
9666
|
+
*/
|
|
9667
|
+
id: string;
|
|
9668
|
+
/**
|
|
9669
|
+
* @example github
|
|
9670
|
+
* @enum {string}
|
|
9671
|
+
*/
|
|
9672
|
+
provider: "github" | "gitlab" | "bitbucket";
|
|
9673
|
+
/** @description The workspaces the account can create a repository in. Empty if listing them failed. */
|
|
9674
|
+
workspaces: components["schemas"]["GitProviderWorkspace"][];
|
|
9675
|
+
/**
|
|
9676
|
+
* @description URL where the user can install the GitHub App on another account or organization. Only for the GitHub App.
|
|
9677
|
+
* @example https://github.com/apps/apify/installations/new
|
|
9678
|
+
*/
|
|
9679
|
+
addWorkspaceUrl?: string;
|
|
9680
|
+
};
|
|
9681
|
+
/** ListOfGitProviderIntegrationsResponse */
|
|
9682
|
+
ListOfGitProviderIntegrationsResponse: {
|
|
9683
|
+
data: components["schemas"]["GitProviderIntegration"][];
|
|
9684
|
+
};
|
|
9685
|
+
/**
|
|
9686
|
+
* GitRepoFile
|
|
9687
|
+
* @description A file to commit into the new repository.
|
|
9688
|
+
*/
|
|
9689
|
+
GitRepoFile: {
|
|
9690
|
+
/** @example src/main.js */
|
|
9691
|
+
path: string;
|
|
9692
|
+
/** @example console.log('Hello'); */
|
|
9693
|
+
content: string;
|
|
9694
|
+
/**
|
|
9695
|
+
* @example utf-8
|
|
9696
|
+
* @enum {string}
|
|
9697
|
+
*/
|
|
9698
|
+
encoding: "utf-8" | "base64";
|
|
9699
|
+
};
|
|
9700
|
+
/** CreateGitRepoRequest */
|
|
9701
|
+
CreateGitRepoRequest: {
|
|
9702
|
+
/**
|
|
9703
|
+
* @description Where to create the repository, as the `id` of one of the provider's workspaces. On GitLab, this is the
|
|
9704
|
+
* numeric namespace ID.
|
|
9705
|
+
* @example janedoe
|
|
9706
|
+
*/
|
|
9707
|
+
workspace: string;
|
|
9708
|
+
/** @example my-actor */
|
|
9709
|
+
repoName: string;
|
|
9710
|
+
/** @example true */
|
|
9711
|
+
isPrivate: boolean;
|
|
9712
|
+
/** @description Files to commit as the initial commit. Can't be combined with `templateArchiveUrl`. */
|
|
9713
|
+
files?: components["schemas"]["GitRepoFile"][];
|
|
9714
|
+
/**
|
|
9715
|
+
* @description URL of an Actor template archive whose files are committed as the initial commit. Can't be combined with
|
|
9716
|
+
* `files`.
|
|
9717
|
+
* @example https://github.com/apify/actor-templates/blob/master/dist/templates/js-start.zip?raw=true
|
|
9718
|
+
*/
|
|
9719
|
+
templateArchiveUrl?: string;
|
|
9720
|
+
};
|
|
9721
|
+
/**
|
|
9722
|
+
* GitRepo
|
|
9723
|
+
* @description URLs of a newly created repository.
|
|
9724
|
+
*/
|
|
9725
|
+
GitRepo: {
|
|
9726
|
+
/** @example git@github.com:janedoe/my-actor.git */
|
|
9727
|
+
sshUrl: string;
|
|
9728
|
+
/** @example https://github.com/janedoe/my-actor.git */
|
|
9729
|
+
httpsUrl: string;
|
|
9730
|
+
/** @example https://github.com/janedoe/my-actor */
|
|
9731
|
+
htmlUrl: string;
|
|
9732
|
+
};
|
|
9733
|
+
/** GitRepoResponse */
|
|
9734
|
+
GitRepoResponse: {
|
|
9735
|
+
data: components["schemas"]["GitRepo"];
|
|
9736
|
+
};
|
|
9737
|
+
/** RegisterDeploymentKeyRequest */
|
|
9738
|
+
RegisterDeploymentKeyRequest: {
|
|
9739
|
+
/**
|
|
9740
|
+
* @description ID or `username~name` of the Actor whose deployment key to register.
|
|
9741
|
+
* @example janedoe~my-actor
|
|
9742
|
+
*/
|
|
9743
|
+
actorId: string;
|
|
9744
|
+
/**
|
|
9745
|
+
* @description URL of the repository to register the key on. Its host must match the provider.
|
|
9746
|
+
* @example https://github.com/janedoe/my-actor
|
|
9747
|
+
*/
|
|
9748
|
+
repoName: string;
|
|
9749
|
+
};
|
|
9750
|
+
/** RegisterDeploymentKeyResponse */
|
|
9751
|
+
RegisterDeploymentKeyResponse: {
|
|
9752
|
+
data: {
|
|
9753
|
+
/**
|
|
9754
|
+
* @description The normalized URL of the repository the key is registered on.
|
|
9755
|
+
* @example https://github.com/janedoe/my-actor
|
|
9756
|
+
*/
|
|
9757
|
+
repoName: string;
|
|
9758
|
+
};
|
|
9759
|
+
};
|
|
8601
9760
|
BrowserInfoResponse: {
|
|
8602
9761
|
/**
|
|
8603
9762
|
* @description HTTP method of the request.
|
|
@@ -8794,6 +9953,13 @@ export interface components {
|
|
|
8794
9953
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
8795
9954
|
};
|
|
8796
9955
|
};
|
|
9956
|
+
/** @description No content */
|
|
9957
|
+
NoContent: {
|
|
9958
|
+
headers: {
|
|
9959
|
+
[name: string]: unknown;
|
|
9960
|
+
};
|
|
9961
|
+
content?: never;
|
|
9962
|
+
};
|
|
8797
9963
|
/** @description Payment required - the user has exceeded their usage limit, does not have enough credits, or the request lacks authentication and payment credentials. */
|
|
8798
9964
|
PaymentRequired: {
|
|
8799
9965
|
headers: {
|
|
@@ -8828,13 +9994,6 @@ export interface components {
|
|
|
8828
9994
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
8829
9995
|
};
|
|
8830
9996
|
};
|
|
8831
|
-
/** @description No content */
|
|
8832
|
-
NoContent: {
|
|
8833
|
-
headers: {
|
|
8834
|
-
[name: string]: unknown;
|
|
8835
|
-
};
|
|
8836
|
-
content?: never;
|
|
8837
|
-
};
|
|
8838
9997
|
/** @description Conflict - the request could not be completed due to a conflict with the current state of the resource. */
|
|
8839
9998
|
Conflict: {
|
|
8840
9999
|
headers: {
|
|
@@ -8901,6 +10060,13 @@ export interface components {
|
|
|
8901
10060
|
* The value must be a valid ISO 8601 datetime string (UTC).
|
|
8902
10061
|
*/
|
|
8903
10062
|
startedBefore: string;
|
|
10063
|
+
/**
|
|
10064
|
+
* @description Single Actor Standby deployment or comma-separated list of deployments (`SINGLE_TENANT`, `MULTI_TENANT_FREE_USERS`,
|
|
10065
|
+
* `MULTI_TENANT_PAYING_USERS` or `MULTI_TENANT_OWNER_PAID`). Used to filter Actor Standby runs by the pool that
|
|
10066
|
+
* serves them. Requires the `status` parameter with only non-terminal statuses (`READY`, `RUNNING`, `TIMING-OUT` or
|
|
10067
|
+
* `ABORTING`).
|
|
10068
|
+
*/
|
|
10069
|
+
deployment: string[];
|
|
8904
10070
|
/** @description Optional timeout for the run, in seconds. By default, the run uses the timeout from its configuration. */
|
|
8905
10071
|
timeout: number;
|
|
8906
10072
|
/**
|
|
@@ -8945,6 +10111,13 @@ export interface components {
|
|
|
8945
10111
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
8946
10112
|
*/
|
|
8947
10113
|
webhooks: string;
|
|
10114
|
+
/**
|
|
10115
|
+
* @description Overrides the Actor's permission level for this specific run. Use to test restricted permissions
|
|
10116
|
+
* before deploying changes to your Actor or to temporarily elevate or restrict access. If you don't specify this
|
|
10117
|
+
* parameter, the Actor uses its configured default permission level. For more information on permissions, see the
|
|
10118
|
+
* [documentation](https://docs.apify.com/platform/actors/development/permissions).
|
|
10119
|
+
*/
|
|
10120
|
+
forcePermissionLevel: "LIMITED_PERMISSIONS" | "FULL_PERMISSIONS";
|
|
8948
10121
|
/**
|
|
8949
10122
|
* @description Key of the record from the run's default key-value store to return in the
|
|
8950
10123
|
* response. Defaults to `OUTPUT`. Actors aren't required to store a record
|
|
@@ -9117,8 +10290,7 @@ export interface components {
|
|
|
9117
10290
|
* determine whether the queue was accessed by multiple clients. If
|
|
9118
10291
|
* `clientKey` is not provided,
|
|
9119
10292
|
* the system considers this API call to come from a new client. For
|
|
9120
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
9121
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
10293
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
9122
10294
|
*/
|
|
9123
10295
|
clientKey: string;
|
|
9124
10296
|
/**
|
|
@@ -9955,6 +11127,35 @@ export interface operations {
|
|
|
9955
11127
|
429: components["responses"]["TooManyRequests"];
|
|
9956
11128
|
};
|
|
9957
11129
|
};
|
|
11130
|
+
actor_version_buildOnPush_put: {
|
|
11131
|
+
parameters: {
|
|
11132
|
+
query?: never;
|
|
11133
|
+
header?: never;
|
|
11134
|
+
path: {
|
|
11135
|
+
/** @description Actor ID or the username of the Actor owner and the Actor name, separated by a tilde (`~`). */
|
|
11136
|
+
actorId: components["parameters"]["actorId"];
|
|
11137
|
+
/** @description Actor version. */
|
|
11138
|
+
versionNumber: components["parameters"]["versionNumber"];
|
|
11139
|
+
};
|
|
11140
|
+
cookie?: never;
|
|
11141
|
+
};
|
|
11142
|
+
requestBody: {
|
|
11143
|
+
content: {
|
|
11144
|
+
"application/json": components["schemas"]["UpdateBuildOnPushRequest"];
|
|
11145
|
+
};
|
|
11146
|
+
};
|
|
11147
|
+
responses: {
|
|
11148
|
+
204: components["responses"]["NoContent"];
|
|
11149
|
+
400: components["responses"]["BadRequest"];
|
|
11150
|
+
401: components["responses"]["Unauthorized"];
|
|
11151
|
+
403: components["responses"]["Forbidden"];
|
|
11152
|
+
404: components["responses"]["NotFound"];
|
|
11153
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
11154
|
+
413: components["responses"]["PayloadTooLarge"];
|
|
11155
|
+
415: components["responses"]["UnsupportedMediaType"];
|
|
11156
|
+
429: components["responses"]["TooManyRequests"];
|
|
11157
|
+
};
|
|
11158
|
+
};
|
|
9958
11159
|
actor_version_envVars_get: {
|
|
9959
11160
|
parameters: {
|
|
9960
11161
|
query?: never;
|
|
@@ -10274,7 +11475,35 @@ export interface operations {
|
|
|
10274
11475
|
[name: string]: unknown;
|
|
10275
11476
|
};
|
|
10276
11477
|
content: {
|
|
10277
|
-
"application/json": components["schemas"]["
|
|
11478
|
+
"application/json": components["schemas"]["ListOfWebhookResourcesResponse"];
|
|
11479
|
+
};
|
|
11480
|
+
};
|
|
11481
|
+
400: components["responses"]["BadRequest"];
|
|
11482
|
+
401: components["responses"]["Unauthorized"];
|
|
11483
|
+
403: components["responses"]["Forbidden"];
|
|
11484
|
+
404: components["responses"]["NotFound"];
|
|
11485
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
11486
|
+
429: components["responses"]["TooManyRequests"];
|
|
11487
|
+
};
|
|
11488
|
+
};
|
|
11489
|
+
actor_oauthConnections_get: {
|
|
11490
|
+
parameters: {
|
|
11491
|
+
query?: never;
|
|
11492
|
+
header?: never;
|
|
11493
|
+
path: {
|
|
11494
|
+
/** @description Actor ID or the username of the Actor owner and the Actor name, separated by a tilde (`~`). */
|
|
11495
|
+
actorId: components["parameters"]["actorId"];
|
|
11496
|
+
};
|
|
11497
|
+
cookie?: never;
|
|
11498
|
+
};
|
|
11499
|
+
requestBody?: never;
|
|
11500
|
+
responses: {
|
|
11501
|
+
200: {
|
|
11502
|
+
headers: {
|
|
11503
|
+
[name: string]: unknown;
|
|
11504
|
+
};
|
|
11505
|
+
content: {
|
|
11506
|
+
"application/json": components["schemas"]["ListOfActorOAuthConnectionsResponse"];
|
|
10278
11507
|
};
|
|
10279
11508
|
};
|
|
10280
11509
|
400: components["responses"]["BadRequest"];
|
|
@@ -10607,6 +11836,13 @@ export interface operations {
|
|
|
10607
11836
|
* The value must be a valid ISO 8601 datetime string (UTC).
|
|
10608
11837
|
*/
|
|
10609
11838
|
startedBefore?: components["parameters"]["startedBefore"];
|
|
11839
|
+
/**
|
|
11840
|
+
* @description Single Actor Standby deployment or comma-separated list of deployments (`SINGLE_TENANT`, `MULTI_TENANT_FREE_USERS`,
|
|
11841
|
+
* `MULTI_TENANT_PAYING_USERS` or `MULTI_TENANT_OWNER_PAID`). Used to filter Actor Standby runs by the pool that
|
|
11842
|
+
* serves them. Requires the `status` parameter with only non-terminal statuses (`READY`, `RUNNING`, `TIMING-OUT` or
|
|
11843
|
+
* `ABORTING`).
|
|
11844
|
+
*/
|
|
11845
|
+
deployment?: components["parameters"]["deployment"];
|
|
10610
11846
|
};
|
|
10611
11847
|
header?: never;
|
|
10612
11848
|
path: {
|
|
@@ -10711,7 +11947,7 @@ export interface operations {
|
|
|
10711
11947
|
* parameter, the Actor uses its configured default permission level. For more information on permissions, see the
|
|
10712
11948
|
* [documentation](https://docs.apify.com/platform/actors/development/permissions).
|
|
10713
11949
|
*/
|
|
10714
|
-
forcePermissionLevel?: "
|
|
11950
|
+
forcePermissionLevel?: components["parameters"]["forcePermissionLevel"];
|
|
10715
11951
|
};
|
|
10716
11952
|
header?: never;
|
|
10717
11953
|
path: {
|
|
@@ -10802,6 +12038,13 @@ export interface operations {
|
|
|
10802
12038
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
10803
12039
|
*/
|
|
10804
12040
|
webhooks?: components["parameters"]["webhooks"];
|
|
12041
|
+
/**
|
|
12042
|
+
* @description Overrides the Actor's permission level for this specific run. Use to test restricted permissions
|
|
12043
|
+
* before deploying changes to your Actor or to temporarily elevate or restrict access. If you don't specify this
|
|
12044
|
+
* parameter, the Actor uses its configured default permission level. For more information on permissions, see the
|
|
12045
|
+
* [documentation](https://docs.apify.com/platform/actors/development/permissions).
|
|
12046
|
+
*/
|
|
12047
|
+
forcePermissionLevel?: components["parameters"]["forcePermissionLevel"];
|
|
10805
12048
|
};
|
|
10806
12049
|
header?: never;
|
|
10807
12050
|
path: {
|
|
@@ -10880,6 +12123,13 @@ export interface operations {
|
|
|
10880
12123
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
10881
12124
|
*/
|
|
10882
12125
|
webhooks?: components["parameters"]["webhooks"];
|
|
12126
|
+
/**
|
|
12127
|
+
* @description Overrides the Actor's permission level for this specific run. Use to test restricted permissions
|
|
12128
|
+
* before deploying changes to your Actor or to temporarily elevate or restrict access. If you don't specify this
|
|
12129
|
+
* parameter, the Actor uses its configured default permission level. For more information on permissions, see the
|
|
12130
|
+
* [documentation](https://docs.apify.com/platform/actors/development/permissions).
|
|
12131
|
+
*/
|
|
12132
|
+
forcePermissionLevel?: components["parameters"]["forcePermissionLevel"];
|
|
10883
12133
|
};
|
|
10884
12134
|
header?: never;
|
|
10885
12135
|
path: {
|
|
@@ -10963,6 +12213,13 @@ export interface operations {
|
|
|
10963
12213
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
10964
12214
|
*/
|
|
10965
12215
|
webhooks?: components["parameters"]["webhooks"];
|
|
12216
|
+
/**
|
|
12217
|
+
* @description Overrides the Actor's permission level for this specific run. Use to test restricted permissions
|
|
12218
|
+
* before deploying changes to your Actor or to temporarily elevate or restrict access. If you don't specify this
|
|
12219
|
+
* parameter, the Actor uses its configured default permission level. For more information on permissions, see the
|
|
12220
|
+
* [documentation](https://docs.apify.com/platform/actors/development/permissions).
|
|
12221
|
+
*/
|
|
12222
|
+
forcePermissionLevel?: components["parameters"]["forcePermissionLevel"];
|
|
10966
12223
|
/** @description Format of the results, possible values are: `json`, `jsonl`, `csv`, `html`, `xlsx`, `xml` and `rss`. The default value is `json`. */
|
|
10967
12224
|
format?: components["parameters"]["format"];
|
|
10968
12225
|
/**
|
|
@@ -11172,7 +12429,14 @@ export interface operations {
|
|
|
11172
12429
|
* the WebhookRepresentation schema. For more information, see
|
|
11173
12430
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
11174
12431
|
*/
|
|
11175
|
-
webhooks?: components["parameters"]["webhooks"];
|
|
12432
|
+
webhooks?: components["parameters"]["webhooks"];
|
|
12433
|
+
/**
|
|
12434
|
+
* @description Overrides the Actor's permission level for this specific run. Use to test restricted permissions
|
|
12435
|
+
* before deploying changes to your Actor or to temporarily elevate or restrict access. If you don't specify this
|
|
12436
|
+
* parameter, the Actor uses its configured default permission level. For more information on permissions, see the
|
|
12437
|
+
* [documentation](https://docs.apify.com/platform/actors/development/permissions).
|
|
12438
|
+
*/
|
|
12439
|
+
forcePermissionLevel?: components["parameters"]["forcePermissionLevel"];
|
|
11176
12440
|
/** @description Format of the results, possible values are: `json`, `jsonl`, `csv`, `html`, `xlsx`, `xml` and `rss`. The default value is `json`. */
|
|
11177
12441
|
format?: components["parameters"]["format"];
|
|
11178
12442
|
/**
|
|
@@ -12354,8 +13618,7 @@ export interface operations {
|
|
|
12354
13618
|
* determine whether the queue was accessed by multiple clients. If
|
|
12355
13619
|
* `clientKey` is not provided,
|
|
12356
13620
|
* the system considers this API call to come from a new client. For
|
|
12357
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12358
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
13621
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12359
13622
|
*/
|
|
12360
13623
|
clientKey?: components["parameters"]["clientKey"];
|
|
12361
13624
|
/**
|
|
@@ -12409,8 +13672,7 @@ export interface operations {
|
|
|
12409
13672
|
* determine whether the queue was accessed by multiple clients. If
|
|
12410
13673
|
* `clientKey` is not provided,
|
|
12411
13674
|
* the system considers this API call to come from a new client. For
|
|
12412
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12413
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
13675
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12414
13676
|
*/
|
|
12415
13677
|
clientKey?: components["parameters"]["clientKey"];
|
|
12416
13678
|
/**
|
|
@@ -12463,8 +13725,7 @@ export interface operations {
|
|
|
12463
13725
|
* determine whether the queue was accessed by multiple clients. If
|
|
12464
13726
|
* `clientKey` is not provided,
|
|
12465
13727
|
* the system considers this API call to come from a new client. For
|
|
12466
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12467
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
13728
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12468
13729
|
*/
|
|
12469
13730
|
clientKey?: components["parameters"]["clientKey"];
|
|
12470
13731
|
/**
|
|
@@ -12517,8 +13778,7 @@ export interface operations {
|
|
|
12517
13778
|
* determine whether the queue was accessed by multiple clients. If
|
|
12518
13779
|
* `clientKey` is not provided,
|
|
12519
13780
|
* the system considers this API call to come from a new client. For
|
|
12520
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12521
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
13781
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12522
13782
|
*/
|
|
12523
13783
|
clientKey?: components["parameters"]["clientKey"];
|
|
12524
13784
|
};
|
|
@@ -12568,8 +13828,7 @@ export interface operations {
|
|
|
12568
13828
|
* determine whether the queue was accessed by multiple clients. If
|
|
12569
13829
|
* `clientKey` is not provided,
|
|
12570
13830
|
* the system considers this API call to come from a new client. For
|
|
12571
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12572
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
13831
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12573
13832
|
*/
|
|
12574
13833
|
clientKey?: components["parameters"]["clientKey"];
|
|
12575
13834
|
};
|
|
@@ -12653,8 +13912,7 @@ export interface operations {
|
|
|
12653
13912
|
* determine whether the queue was accessed by multiple clients. If
|
|
12654
13913
|
* `clientKey` is not provided,
|
|
12655
13914
|
* the system considers this API call to come from a new client. For
|
|
12656
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12657
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
13915
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12658
13916
|
*/
|
|
12659
13917
|
clientKey?: components["parameters"]["clientKey"];
|
|
12660
13918
|
};
|
|
@@ -12704,8 +13962,7 @@ export interface operations {
|
|
|
12704
13962
|
* determine whether the queue was accessed by multiple clients. If
|
|
12705
13963
|
* `clientKey` is not provided,
|
|
12706
13964
|
* the system considers this API call to come from a new client. For
|
|
12707
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12708
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
13965
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12709
13966
|
*/
|
|
12710
13967
|
clientKey?: components["parameters"]["clientKey"];
|
|
12711
13968
|
};
|
|
@@ -12744,8 +14001,7 @@ export interface operations {
|
|
|
12744
14001
|
* determine whether the queue was accessed by multiple clients. If
|
|
12745
14002
|
* `clientKey` is not provided,
|
|
12746
14003
|
* the system considers this API call to come from a new client. For
|
|
12747
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12748
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
14004
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12749
14005
|
*/
|
|
12750
14006
|
clientKey?: components["parameters"]["clientKey"];
|
|
12751
14007
|
/**
|
|
@@ -12794,8 +14050,7 @@ export interface operations {
|
|
|
12794
14050
|
* determine whether the queue was accessed by multiple clients. If
|
|
12795
14051
|
* `clientKey` is not provided,
|
|
12796
14052
|
* the system considers this API call to come from a new client. For
|
|
12797
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12798
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
14053
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12799
14054
|
*/
|
|
12800
14055
|
clientKey?: components["parameters"]["clientKey"];
|
|
12801
14056
|
/**
|
|
@@ -12839,8 +14094,7 @@ export interface operations {
|
|
|
12839
14094
|
* determine whether the queue was accessed by multiple clients. If
|
|
12840
14095
|
* `clientKey` is not provided,
|
|
12841
14096
|
* the system considers this API call to come from a new client. For
|
|
12842
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12843
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
14097
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12844
14098
|
*/
|
|
12845
14099
|
clientKey?: components["parameters"]["clientKey"];
|
|
12846
14100
|
};
|
|
@@ -12887,8 +14141,7 @@ export interface operations {
|
|
|
12887
14141
|
* determine whether the queue was accessed by multiple clients. If
|
|
12888
14142
|
* `clientKey` is not provided,
|
|
12889
14143
|
* the system considers this API call to come from a new client. For
|
|
12890
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
12891
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
14144
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
12892
14145
|
*/
|
|
12893
14146
|
clientKey?: components["parameters"]["clientKey"];
|
|
12894
14147
|
};
|
|
@@ -14039,6 +15292,8 @@ export interface operations {
|
|
|
14039
15292
|
* by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
|
|
14040
15293
|
*/
|
|
14041
15294
|
maxTotalChargeUsd?: components["parameters"]["maxTotalChargeUsd"];
|
|
15295
|
+
/** @description Determines whether the run will be restarted if it fails. */
|
|
15296
|
+
restartOnError?: components["parameters"]["restartOnError"];
|
|
14042
15297
|
/**
|
|
14043
15298
|
* @description Specifies the Actor build to run. It can be either a build tag or build number.
|
|
14044
15299
|
* By default, the run uses the build from its configuration (typically `latest`).
|
|
@@ -15741,8 +16996,7 @@ export interface operations {
|
|
|
15741
16996
|
* determine whether the queue was accessed by multiple clients. If
|
|
15742
16997
|
* `clientKey` is not provided,
|
|
15743
16998
|
* the system considers this API call to come from a new client. For
|
|
15744
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
15745
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
16999
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
15746
17000
|
*/
|
|
15747
17001
|
clientKey?: components["parameters"]["clientKey"];
|
|
15748
17002
|
};
|
|
@@ -15789,8 +17043,7 @@ export interface operations {
|
|
|
15789
17043
|
* determine whether the queue was accessed by multiple clients. If
|
|
15790
17044
|
* `clientKey` is not provided,
|
|
15791
17045
|
* the system considers this API call to come from a new client. For
|
|
15792
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
15793
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17046
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
15794
17047
|
*/
|
|
15795
17048
|
clientKey?: components["parameters"]["clientKey"];
|
|
15796
17049
|
};
|
|
@@ -15832,8 +17085,7 @@ export interface operations {
|
|
|
15832
17085
|
* determine whether the queue was accessed by multiple clients. If
|
|
15833
17086
|
* `clientKey` is not provided,
|
|
15834
17087
|
* the system considers this API call to come from a new client. For
|
|
15835
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
15836
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17088
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
15837
17089
|
*/
|
|
15838
17090
|
clientKey?: components["parameters"]["clientKey"];
|
|
15839
17091
|
/**
|
|
@@ -15887,8 +17139,7 @@ export interface operations {
|
|
|
15887
17139
|
* determine whether the queue was accessed by multiple clients. If
|
|
15888
17140
|
* `clientKey` is not provided,
|
|
15889
17141
|
* the system considers this API call to come from a new client. For
|
|
15890
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
15891
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17142
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
15892
17143
|
*/
|
|
15893
17144
|
clientKey?: components["parameters"]["clientKey"];
|
|
15894
17145
|
/**
|
|
@@ -15941,8 +17192,7 @@ export interface operations {
|
|
|
15941
17192
|
* determine whether the queue was accessed by multiple clients. If
|
|
15942
17193
|
* `clientKey` is not provided,
|
|
15943
17194
|
* the system considers this API call to come from a new client. For
|
|
15944
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
15945
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17195
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
15946
17196
|
*/
|
|
15947
17197
|
clientKey?: components["parameters"]["clientKey"];
|
|
15948
17198
|
/**
|
|
@@ -15995,8 +17245,7 @@ export interface operations {
|
|
|
15995
17245
|
* determine whether the queue was accessed by multiple clients. If
|
|
15996
17246
|
* `clientKey` is not provided,
|
|
15997
17247
|
* the system considers this API call to come from a new client. For
|
|
15998
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
15999
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17248
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
16000
17249
|
*/
|
|
16001
17250
|
clientKey?: components["parameters"]["clientKey"];
|
|
16002
17251
|
};
|
|
@@ -16046,8 +17295,7 @@ export interface operations {
|
|
|
16046
17295
|
* determine whether the queue was accessed by multiple clients. If
|
|
16047
17296
|
* `clientKey` is not provided,
|
|
16048
17297
|
* the system considers this API call to come from a new client. For
|
|
16049
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
16050
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17298
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
16051
17299
|
*/
|
|
16052
17300
|
clientKey?: components["parameters"]["clientKey"];
|
|
16053
17301
|
};
|
|
@@ -16131,8 +17379,7 @@ export interface operations {
|
|
|
16131
17379
|
* determine whether the queue was accessed by multiple clients. If
|
|
16132
17380
|
* `clientKey` is not provided,
|
|
16133
17381
|
* the system considers this API call to come from a new client. For
|
|
16134
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
16135
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17382
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
16136
17383
|
*/
|
|
16137
17384
|
clientKey?: components["parameters"]["clientKey"];
|
|
16138
17385
|
};
|
|
@@ -16182,8 +17429,7 @@ export interface operations {
|
|
|
16182
17429
|
* determine whether the queue was accessed by multiple clients. If
|
|
16183
17430
|
* `clientKey` is not provided,
|
|
16184
17431
|
* the system considers this API call to come from a new client. For
|
|
16185
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
16186
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17432
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
16187
17433
|
*/
|
|
16188
17434
|
clientKey?: components["parameters"]["clientKey"];
|
|
16189
17435
|
};
|
|
@@ -16222,8 +17468,7 @@ export interface operations {
|
|
|
16222
17468
|
* determine whether the queue was accessed by multiple clients. If
|
|
16223
17469
|
* `clientKey` is not provided,
|
|
16224
17470
|
* the system considers this API call to come from a new client. For
|
|
16225
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
16226
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17471
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
16227
17472
|
*/
|
|
16228
17473
|
clientKey?: components["parameters"]["clientKey"];
|
|
16229
17474
|
/**
|
|
@@ -16272,8 +17517,7 @@ export interface operations {
|
|
|
16272
17517
|
* determine whether the queue was accessed by multiple clients. If
|
|
16273
17518
|
* `clientKey` is not provided,
|
|
16274
17519
|
* the system considers this API call to come from a new client. For
|
|
16275
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
16276
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
17520
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
16277
17521
|
*/
|
|
16278
17522
|
clientKey?: components["parameters"]["clientKey"];
|
|
16279
17523
|
/**
|
|
@@ -16329,6 +17573,13 @@ export interface operations {
|
|
|
16329
17573
|
* The value must be a valid ISO 8601 datetime string (UTC).
|
|
16330
17574
|
*/
|
|
16331
17575
|
startedBefore?: components["parameters"]["startedBefore"];
|
|
17576
|
+
/**
|
|
17577
|
+
* @description Single Actor Standby deployment or comma-separated list of deployments (`SINGLE_TENANT`, `MULTI_TENANT_FREE_USERS`,
|
|
17578
|
+
* `MULTI_TENANT_PAYING_USERS` or `MULTI_TENANT_OWNER_PAID`). Used to filter Actor Standby runs by the pool that
|
|
17579
|
+
* serves them. Requires the `status` parameter with only non-terminal statuses (`READY`, `RUNNING`, `TIMING-OUT` or
|
|
17580
|
+
* `ABORTING`).
|
|
17581
|
+
*/
|
|
17582
|
+
deployment?: components["parameters"]["deployment"];
|
|
16332
17583
|
};
|
|
16333
17584
|
header?: never;
|
|
16334
17585
|
path?: never;
|
|
@@ -17550,8 +18801,7 @@ export interface operations {
|
|
|
17550
18801
|
* determine whether the queue was accessed by multiple clients. If
|
|
17551
18802
|
* `clientKey` is not provided,
|
|
17552
18803
|
* the system considers this API call to come from a new client. For
|
|
17553
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17554
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
18804
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17555
18805
|
*/
|
|
17556
18806
|
clientKey?: components["parameters"]["clientKey"];
|
|
17557
18807
|
/**
|
|
@@ -17601,8 +18851,7 @@ export interface operations {
|
|
|
17601
18851
|
* determine whether the queue was accessed by multiple clients. If
|
|
17602
18852
|
* `clientKey` is not provided,
|
|
17603
18853
|
* the system considers this API call to come from a new client. For
|
|
17604
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17605
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
18854
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17606
18855
|
*/
|
|
17607
18856
|
clientKey?: components["parameters"]["clientKey"];
|
|
17608
18857
|
/**
|
|
@@ -17651,8 +18900,7 @@ export interface operations {
|
|
|
17651
18900
|
* determine whether the queue was accessed by multiple clients. If
|
|
17652
18901
|
* `clientKey` is not provided,
|
|
17653
18902
|
* the system considers this API call to come from a new client. For
|
|
17654
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17655
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
18903
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17656
18904
|
*/
|
|
17657
18905
|
clientKey?: components["parameters"]["clientKey"];
|
|
17658
18906
|
/**
|
|
@@ -17701,8 +18949,7 @@ export interface operations {
|
|
|
17701
18949
|
* determine whether the queue was accessed by multiple clients. If
|
|
17702
18950
|
* `clientKey` is not provided,
|
|
17703
18951
|
* the system considers this API call to come from a new client. For
|
|
17704
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17705
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
18952
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17706
18953
|
*/
|
|
17707
18954
|
clientKey?: components["parameters"]["clientKey"];
|
|
17708
18955
|
};
|
|
@@ -17748,8 +18995,7 @@ export interface operations {
|
|
|
17748
18995
|
* determine whether the queue was accessed by multiple clients. If
|
|
17749
18996
|
* `clientKey` is not provided,
|
|
17750
18997
|
* the system considers this API call to come from a new client. For
|
|
17751
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17752
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
18998
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17753
18999
|
*/
|
|
17754
19000
|
clientKey?: components["parameters"]["clientKey"];
|
|
17755
19001
|
};
|
|
@@ -17824,8 +19070,7 @@ export interface operations {
|
|
|
17824
19070
|
* determine whether the queue was accessed by multiple clients. If
|
|
17825
19071
|
* `clientKey` is not provided,
|
|
17826
19072
|
* the system considers this API call to come from a new client. For
|
|
17827
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17828
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
19073
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17829
19074
|
*/
|
|
17830
19075
|
clientKey?: components["parameters"]["clientKey"];
|
|
17831
19076
|
};
|
|
@@ -17871,8 +19116,7 @@ export interface operations {
|
|
|
17871
19116
|
* determine whether the queue was accessed by multiple clients. If
|
|
17872
19117
|
* `clientKey` is not provided,
|
|
17873
19118
|
* the system considers this API call to come from a new client. For
|
|
17874
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17875
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
19119
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17876
19120
|
*/
|
|
17877
19121
|
clientKey?: components["parameters"]["clientKey"];
|
|
17878
19122
|
};
|
|
@@ -17907,8 +19151,7 @@ export interface operations {
|
|
|
17907
19151
|
* determine whether the queue was accessed by multiple clients. If
|
|
17908
19152
|
* `clientKey` is not provided,
|
|
17909
19153
|
* the system considers this API call to come from a new client. For
|
|
17910
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17911
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
19154
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17912
19155
|
*/
|
|
17913
19156
|
clientKey?: components["parameters"]["clientKey"];
|
|
17914
19157
|
/**
|
|
@@ -17953,8 +19196,7 @@ export interface operations {
|
|
|
17953
19196
|
* determine whether the queue was accessed by multiple clients. If
|
|
17954
19197
|
* `clientKey` is not provided,
|
|
17955
19198
|
* the system considers this API call to come from a new client. For
|
|
17956
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17957
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
19199
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17958
19200
|
*/
|
|
17959
19201
|
clientKey?: components["parameters"]["clientKey"];
|
|
17960
19202
|
/**
|
|
@@ -17994,8 +19236,7 @@ export interface operations {
|
|
|
17994
19236
|
* determine whether the queue was accessed by multiple clients. If
|
|
17995
19237
|
* `clientKey` is not provided,
|
|
17996
19238
|
* the system considers this API call to come from a new client. For
|
|
17997
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
17998
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
19239
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
17999
19240
|
*/
|
|
18000
19241
|
clientKey?: components["parameters"]["clientKey"];
|
|
18001
19242
|
};
|
|
@@ -18038,8 +19279,7 @@ export interface operations {
|
|
|
18038
19279
|
* determine whether the queue was accessed by multiple clients. If
|
|
18039
19280
|
* `clientKey` is not provided,
|
|
18040
19281
|
* the system considers this API call to come from a new client. For
|
|
18041
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
18042
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
19282
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
18043
19283
|
*/
|
|
18044
19284
|
clientKey?: components["parameters"]["clientKey"];
|
|
18045
19285
|
};
|
|
@@ -18314,6 +19554,62 @@ export interface operations {
|
|
|
18314
19554
|
429: components["responses"]["TooManyRequests"];
|
|
18315
19555
|
};
|
|
18316
19556
|
};
|
|
19557
|
+
actorOAuthAccounts_get: {
|
|
19558
|
+
parameters: {
|
|
19559
|
+
query?: never;
|
|
19560
|
+
header?: never;
|
|
19561
|
+
path: {
|
|
19562
|
+
/** @description Actor OAuth connection ID. */
|
|
19563
|
+
connectionId: string;
|
|
19564
|
+
};
|
|
19565
|
+
cookie?: never;
|
|
19566
|
+
};
|
|
19567
|
+
requestBody?: never;
|
|
19568
|
+
responses: {
|
|
19569
|
+
200: {
|
|
19570
|
+
headers: {
|
|
19571
|
+
[name: string]: unknown;
|
|
19572
|
+
};
|
|
19573
|
+
content: {
|
|
19574
|
+
"application/json": components["schemas"]["ListOfActorOAuthAccountsResponse"];
|
|
19575
|
+
};
|
|
19576
|
+
};
|
|
19577
|
+
400: components["responses"]["BadRequest"];
|
|
19578
|
+
401: components["responses"]["Unauthorized"];
|
|
19579
|
+
403: components["responses"]["Forbidden"];
|
|
19580
|
+
404: components["responses"]["NotFound"];
|
|
19581
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
19582
|
+
429: components["responses"]["TooManyRequests"];
|
|
19583
|
+
};
|
|
19584
|
+
};
|
|
19585
|
+
actorOAuthAccount_get: {
|
|
19586
|
+
parameters: {
|
|
19587
|
+
query?: never;
|
|
19588
|
+
header?: never;
|
|
19589
|
+
path: {
|
|
19590
|
+
/** @description Actor OAuth account ID. */
|
|
19591
|
+
accountId: string;
|
|
19592
|
+
};
|
|
19593
|
+
cookie?: never;
|
|
19594
|
+
};
|
|
19595
|
+
requestBody?: never;
|
|
19596
|
+
responses: {
|
|
19597
|
+
200: {
|
|
19598
|
+
headers: {
|
|
19599
|
+
[name: string]: unknown;
|
|
19600
|
+
};
|
|
19601
|
+
content: {
|
|
19602
|
+
"application/json": components["schemas"]["ActorOAuthAccountResponse"];
|
|
19603
|
+
};
|
|
19604
|
+
};
|
|
19605
|
+
400: components["responses"]["BadRequest"];
|
|
19606
|
+
401: components["responses"]["Unauthorized"];
|
|
19607
|
+
403: components["responses"]["Forbidden"];
|
|
19608
|
+
404: components["responses"]["NotFound"];
|
|
19609
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
19610
|
+
429: components["responses"]["TooManyRequests"];
|
|
19611
|
+
};
|
|
19612
|
+
};
|
|
18317
19613
|
keyValueStores_get: {
|
|
18318
19614
|
parameters: {
|
|
18319
19615
|
query?: {
|
|
@@ -19603,8 +20899,7 @@ export interface operations {
|
|
|
19603
20899
|
* determine whether the queue was accessed by multiple clients. If
|
|
19604
20900
|
* `clientKey` is not provided,
|
|
19605
20901
|
* the system considers this API call to come from a new client. For
|
|
19606
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
19607
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
20902
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
19608
20903
|
*/
|
|
19609
20904
|
clientKey?: components["parameters"]["clientKey"];
|
|
19610
20905
|
/**
|
|
@@ -19653,8 +20948,7 @@ export interface operations {
|
|
|
19653
20948
|
* determine whether the queue was accessed by multiple clients. If
|
|
19654
20949
|
* `clientKey` is not provided,
|
|
19655
20950
|
* the system considers this API call to come from a new client. For
|
|
19656
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
19657
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
20951
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
19658
20952
|
*/
|
|
19659
20953
|
clientKey?: components["parameters"]["clientKey"];
|
|
19660
20954
|
};
|
|
@@ -19700,8 +20994,7 @@ export interface operations {
|
|
|
19700
20994
|
* determine whether the queue was accessed by multiple clients. If
|
|
19701
20995
|
* `clientKey` is not provided,
|
|
19702
20996
|
* the system considers this API call to come from a new client. For
|
|
19703
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
19704
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
20997
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
19705
20998
|
*/
|
|
19706
20999
|
clientKey?: components["parameters"]["clientKey"];
|
|
19707
21000
|
};
|
|
@@ -19740,8 +21033,7 @@ export interface operations {
|
|
|
19740
21033
|
* determine whether the queue was accessed by multiple clients. If
|
|
19741
21034
|
* `clientKey` is not provided,
|
|
19742
21035
|
* the system considers this API call to come from a new client. For
|
|
19743
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
19744
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
21036
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
19745
21037
|
*/
|
|
19746
21038
|
clientKey?: components["parameters"]["clientKey"];
|
|
19747
21039
|
/**
|
|
@@ -19791,8 +21083,7 @@ export interface operations {
|
|
|
19791
21083
|
* determine whether the queue was accessed by multiple clients. If
|
|
19792
21084
|
* `clientKey` is not provided,
|
|
19793
21085
|
* the system considers this API call to come from a new client. For
|
|
19794
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
19795
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
21086
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
19796
21087
|
*/
|
|
19797
21088
|
clientKey?: components["parameters"]["clientKey"];
|
|
19798
21089
|
/**
|
|
@@ -19877,8 +21168,7 @@ export interface operations {
|
|
|
19877
21168
|
* determine whether the queue was accessed by multiple clients. If
|
|
19878
21169
|
* `clientKey` is not provided,
|
|
19879
21170
|
* the system considers this API call to come from a new client. For
|
|
19880
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
19881
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
21171
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
19882
21172
|
*/
|
|
19883
21173
|
clientKey?: components["parameters"]["clientKey"];
|
|
19884
21174
|
};
|
|
@@ -19924,8 +21214,7 @@ export interface operations {
|
|
|
19924
21214
|
* determine whether the queue was accessed by multiple clients. If
|
|
19925
21215
|
* `clientKey` is not provided,
|
|
19926
21216
|
* the system considers this API call to come from a new client. For
|
|
19927
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
19928
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
21217
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
19929
21218
|
*/
|
|
19930
21219
|
clientKey?: components["parameters"]["clientKey"];
|
|
19931
21220
|
};
|
|
@@ -19960,8 +21249,7 @@ export interface operations {
|
|
|
19960
21249
|
* determine whether the queue was accessed by multiple clients. If
|
|
19961
21250
|
* `clientKey` is not provided,
|
|
19962
21251
|
* the system considers this API call to come from a new client. For
|
|
19963
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
19964
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
21252
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
19965
21253
|
*/
|
|
19966
21254
|
clientKey?: components["parameters"]["clientKey"];
|
|
19967
21255
|
};
|
|
@@ -20004,8 +21292,7 @@ export interface operations {
|
|
|
20004
21292
|
* determine whether the queue was accessed by multiple clients. If
|
|
20005
21293
|
* `clientKey` is not provided,
|
|
20006
21294
|
* the system considers this API call to come from a new client. For
|
|
20007
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
20008
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
21295
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
20009
21296
|
*/
|
|
20010
21297
|
clientKey?: components["parameters"]["clientKey"];
|
|
20011
21298
|
};
|
|
@@ -20045,8 +21332,7 @@ export interface operations {
|
|
|
20045
21332
|
* determine whether the queue was accessed by multiple clients. If
|
|
20046
21333
|
* `clientKey` is not provided,
|
|
20047
21334
|
* the system considers this API call to come from a new client. For
|
|
20048
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
20049
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
21335
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
20050
21336
|
*/
|
|
20051
21337
|
clientKey?: components["parameters"]["clientKey"];
|
|
20052
21338
|
/**
|
|
@@ -20091,8 +21377,7 @@ export interface operations {
|
|
|
20091
21377
|
* determine whether the queue was accessed by multiple clients. If
|
|
20092
21378
|
* `clientKey` is not provided,
|
|
20093
21379
|
* the system considers this API call to come from a new client. For
|
|
20094
|
-
* details, see the `hadMultipleClients` field returned by the [Get
|
|
20095
|
-
* head](#/reference/request-queues/queue-head) operation.
|
|
21380
|
+
* details, see the `hadMultipleClients` field returned by the [Get request queue head](https://docs.apify.com/api/v2/request-queue-head-get) endpoint.
|
|
20096
21381
|
*/
|
|
20097
21382
|
clientKey?: components["parameters"]["clientKey"];
|
|
20098
21383
|
/**
|
|
@@ -20671,6 +21956,35 @@ export interface operations {
|
|
|
20671
21956
|
429: components["responses"]["TooManyRequests"];
|
|
20672
21957
|
};
|
|
20673
21958
|
};
|
|
21959
|
+
schedule_invoke_post: {
|
|
21960
|
+
parameters: {
|
|
21961
|
+
query?: never;
|
|
21962
|
+
header?: never;
|
|
21963
|
+
path: {
|
|
21964
|
+
/** @description Schedule ID. */
|
|
21965
|
+
scheduleId: components["parameters"]["scheduleId"];
|
|
21966
|
+
};
|
|
21967
|
+
cookie?: never;
|
|
21968
|
+
};
|
|
21969
|
+
requestBody?: never;
|
|
21970
|
+
responses: {
|
|
21971
|
+
201: {
|
|
21972
|
+
headers: {
|
|
21973
|
+
[name: string]: unknown;
|
|
21974
|
+
};
|
|
21975
|
+
content: {
|
|
21976
|
+
/** @example {} */
|
|
21977
|
+
"application/json": Record<string, unknown>;
|
|
21978
|
+
};
|
|
21979
|
+
};
|
|
21980
|
+
400: components["responses"]["BadRequest"];
|
|
21981
|
+
401: components["responses"]["Unauthorized"];
|
|
21982
|
+
403: components["responses"]["Forbidden"];
|
|
21983
|
+
404: components["responses"]["NotFound"];
|
|
21984
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
21985
|
+
429: components["responses"]["TooManyRequests"];
|
|
21986
|
+
};
|
|
21987
|
+
};
|
|
20674
21988
|
schedule_log_get: {
|
|
20675
21989
|
parameters: {
|
|
20676
21990
|
query?: never;
|
|
@@ -20758,6 +22072,12 @@ export interface operations {
|
|
|
20758
22072
|
* bypass this safety filtering and include all Actors in the results.
|
|
20759
22073
|
*/
|
|
20760
22074
|
includeUnrunnableActors?: boolean;
|
|
22075
|
+
/**
|
|
22076
|
+
* @description If `true`, each Actor in the results includes an `inputSchema` field with a compact version of the input
|
|
22077
|
+
* schema of its default build (property types and required properties only). With this parameter, `limit`
|
|
22078
|
+
* defaults to and can't exceed `10`.
|
|
22079
|
+
*/
|
|
22080
|
+
includeInputSchema?: boolean;
|
|
20761
22081
|
};
|
|
20762
22082
|
header?: never;
|
|
20763
22083
|
path?: never;
|
|
@@ -20859,7 +22179,7 @@ export interface operations {
|
|
|
20859
22179
|
[name: string]: unknown;
|
|
20860
22180
|
};
|
|
20861
22181
|
content: {
|
|
20862
|
-
"application/json": components["schemas"]["UserPublicInfoResponse"];
|
|
22182
|
+
"application/json": components["schemas"]["UserPublicInfoResponse"] | components["schemas"]["UserPrivateInfoResponse"];
|
|
20863
22183
|
};
|
|
20864
22184
|
};
|
|
20865
22185
|
400: components["responses"]["BadRequest"];
|
|
@@ -20974,6 +22294,197 @@ export interface operations {
|
|
|
20974
22294
|
429: components["responses"]["TooManyRequests"];
|
|
20975
22295
|
};
|
|
20976
22296
|
};
|
|
22297
|
+
users_usage_monthly_get: {
|
|
22298
|
+
parameters: {
|
|
22299
|
+
query?: {
|
|
22300
|
+
/** @description Date in the YYYY-MM-DD format. */
|
|
22301
|
+
date?: string;
|
|
22302
|
+
};
|
|
22303
|
+
header?: never;
|
|
22304
|
+
path: {
|
|
22305
|
+
/** @description User ID or username of your account, or of the organization your API token belongs to. */
|
|
22306
|
+
userId: string;
|
|
22307
|
+
};
|
|
22308
|
+
cookie?: never;
|
|
22309
|
+
};
|
|
22310
|
+
requestBody?: never;
|
|
22311
|
+
responses: {
|
|
22312
|
+
200: {
|
|
22313
|
+
headers: {
|
|
22314
|
+
[name: string]: unknown;
|
|
22315
|
+
};
|
|
22316
|
+
content: {
|
|
22317
|
+
"application/json": components["schemas"]["MonthlyUsageResponse"];
|
|
22318
|
+
};
|
|
22319
|
+
};
|
|
22320
|
+
400: components["responses"]["BadRequest"];
|
|
22321
|
+
401: components["responses"]["Unauthorized"];
|
|
22322
|
+
403: components["responses"]["Forbidden"];
|
|
22323
|
+
404: components["responses"]["NotFound"];
|
|
22324
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
22325
|
+
429: components["responses"]["TooManyRequests"];
|
|
22326
|
+
};
|
|
22327
|
+
};
|
|
22328
|
+
users_limits_get: {
|
|
22329
|
+
parameters: {
|
|
22330
|
+
query?: never;
|
|
22331
|
+
header?: never;
|
|
22332
|
+
path: {
|
|
22333
|
+
/** @description User ID or username of your account, or of the organization your API token belongs to. */
|
|
22334
|
+
userId: string;
|
|
22335
|
+
};
|
|
22336
|
+
cookie?: never;
|
|
22337
|
+
};
|
|
22338
|
+
requestBody?: never;
|
|
22339
|
+
responses: {
|
|
22340
|
+
200: {
|
|
22341
|
+
headers: {
|
|
22342
|
+
[name: string]: unknown;
|
|
22343
|
+
};
|
|
22344
|
+
content: {
|
|
22345
|
+
"application/json": components["schemas"]["AccountLimitsResponse"];
|
|
22346
|
+
};
|
|
22347
|
+
};
|
|
22348
|
+
400: components["responses"]["BadRequest"];
|
|
22349
|
+
401: components["responses"]["Unauthorized"];
|
|
22350
|
+
403: components["responses"]["Forbidden"];
|
|
22351
|
+
404: components["responses"]["NotFound"];
|
|
22352
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
22353
|
+
429: components["responses"]["TooManyRequests"];
|
|
22354
|
+
};
|
|
22355
|
+
};
|
|
22356
|
+
users_limits_put: {
|
|
22357
|
+
parameters: {
|
|
22358
|
+
query?: never;
|
|
22359
|
+
header?: never;
|
|
22360
|
+
path: {
|
|
22361
|
+
/** @description User ID or username of your account, or of the organization your API token belongs to. */
|
|
22362
|
+
userId: string;
|
|
22363
|
+
};
|
|
22364
|
+
cookie?: never;
|
|
22365
|
+
};
|
|
22366
|
+
requestBody?: {
|
|
22367
|
+
content: {
|
|
22368
|
+
"application/json": components["schemas"]["UpdateLimitsRequest"];
|
|
22369
|
+
};
|
|
22370
|
+
};
|
|
22371
|
+
responses: {
|
|
22372
|
+
201: {
|
|
22373
|
+
headers: {
|
|
22374
|
+
[name: string]: unknown;
|
|
22375
|
+
};
|
|
22376
|
+
content: {
|
|
22377
|
+
"application/json": Record<string, unknown>;
|
|
22378
|
+
};
|
|
22379
|
+
};
|
|
22380
|
+
400: components["responses"]["BadRequest"];
|
|
22381
|
+
401: components["responses"]["Unauthorized"];
|
|
22382
|
+
403: components["responses"]["Forbidden"];
|
|
22383
|
+
404: components["responses"]["NotFound"];
|
|
22384
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
22385
|
+
413: components["responses"]["PayloadTooLarge"];
|
|
22386
|
+
415: components["responses"]["UnsupportedMediaType"];
|
|
22387
|
+
429: components["responses"]["TooManyRequests"];
|
|
22388
|
+
};
|
|
22389
|
+
};
|
|
22390
|
+
integrations_git_get: {
|
|
22391
|
+
parameters: {
|
|
22392
|
+
query?: never;
|
|
22393
|
+
header?: never;
|
|
22394
|
+
path?: never;
|
|
22395
|
+
cookie?: never;
|
|
22396
|
+
};
|
|
22397
|
+
requestBody?: never;
|
|
22398
|
+
responses: {
|
|
22399
|
+
200: {
|
|
22400
|
+
headers: {
|
|
22401
|
+
[name: string]: unknown;
|
|
22402
|
+
};
|
|
22403
|
+
content: {
|
|
22404
|
+
"application/json": components["schemas"]["ListOfGitProviderIntegrationsResponse"];
|
|
22405
|
+
};
|
|
22406
|
+
};
|
|
22407
|
+
400: components["responses"]["BadRequest"];
|
|
22408
|
+
401: components["responses"]["Unauthorized"];
|
|
22409
|
+
403: components["responses"]["Forbidden"];
|
|
22410
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
22411
|
+
429: components["responses"]["TooManyRequests"];
|
|
22412
|
+
};
|
|
22413
|
+
};
|
|
22414
|
+
integrations_git_createRepo_post: {
|
|
22415
|
+
parameters: {
|
|
22416
|
+
query?: never;
|
|
22417
|
+
header?: never;
|
|
22418
|
+
path: {
|
|
22419
|
+
/**
|
|
22420
|
+
* @description The connected git account to use: `github-app` for the GitHub App, or the ID of a connected GitLab or
|
|
22421
|
+
* Bitbucket integration, as returned by [Get git provider integrations](https://docs.apify.com/api/v2/integrations-git-get).
|
|
22422
|
+
*/
|
|
22423
|
+
providerId: string;
|
|
22424
|
+
};
|
|
22425
|
+
cookie?: never;
|
|
22426
|
+
};
|
|
22427
|
+
requestBody: {
|
|
22428
|
+
content: {
|
|
22429
|
+
"application/json": components["schemas"]["CreateGitRepoRequest"];
|
|
22430
|
+
};
|
|
22431
|
+
};
|
|
22432
|
+
responses: {
|
|
22433
|
+
201: {
|
|
22434
|
+
headers: {
|
|
22435
|
+
[name: string]: unknown;
|
|
22436
|
+
};
|
|
22437
|
+
content: {
|
|
22438
|
+
"application/json": components["schemas"]["GitRepoResponse"];
|
|
22439
|
+
};
|
|
22440
|
+
};
|
|
22441
|
+
400: components["responses"]["BadRequest"];
|
|
22442
|
+
401: components["responses"]["Unauthorized"];
|
|
22443
|
+
403: components["responses"]["Forbidden"];
|
|
22444
|
+
404: components["responses"]["NotFound"];
|
|
22445
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
22446
|
+
413: components["responses"]["PayloadTooLarge"];
|
|
22447
|
+
415: components["responses"]["UnsupportedMediaType"];
|
|
22448
|
+
429: components["responses"]["TooManyRequests"];
|
|
22449
|
+
};
|
|
22450
|
+
};
|
|
22451
|
+
integrations_git_registerDeploymentKey_post: {
|
|
22452
|
+
parameters: {
|
|
22453
|
+
query?: never;
|
|
22454
|
+
header?: never;
|
|
22455
|
+
path: {
|
|
22456
|
+
/**
|
|
22457
|
+
* @description The connected git account to use: `github-app` for the GitHub App, or the ID of a connected GitLab or
|
|
22458
|
+
* Bitbucket integration, as returned by [Get git provider integrations](https://docs.apify.com/api/v2/integrations-git-get).
|
|
22459
|
+
*/
|
|
22460
|
+
providerId: string;
|
|
22461
|
+
};
|
|
22462
|
+
cookie?: never;
|
|
22463
|
+
};
|
|
22464
|
+
requestBody: {
|
|
22465
|
+
content: {
|
|
22466
|
+
"application/json": components["schemas"]["RegisterDeploymentKeyRequest"];
|
|
22467
|
+
};
|
|
22468
|
+
};
|
|
22469
|
+
responses: {
|
|
22470
|
+
201: {
|
|
22471
|
+
headers: {
|
|
22472
|
+
[name: string]: unknown;
|
|
22473
|
+
};
|
|
22474
|
+
content: {
|
|
22475
|
+
"application/json": components["schemas"]["RegisterDeploymentKeyResponse"];
|
|
22476
|
+
};
|
|
22477
|
+
};
|
|
22478
|
+
400: components["responses"]["BadRequest"];
|
|
22479
|
+
401: components["responses"]["Unauthorized"];
|
|
22480
|
+
403: components["responses"]["Forbidden"];
|
|
22481
|
+
404: components["responses"]["NotFound"];
|
|
22482
|
+
405: components["responses"]["MethodNotAllowed"];
|
|
22483
|
+
413: components["responses"]["PayloadTooLarge"];
|
|
22484
|
+
415: components["responses"]["UnsupportedMediaType"];
|
|
22485
|
+
429: components["responses"]["TooManyRequests"];
|
|
22486
|
+
};
|
|
22487
|
+
};
|
|
20977
22488
|
tools_browser_info_get: {
|
|
20978
22489
|
parameters: {
|
|
20979
22490
|
query?: {
|