apify-client 3.0.0-beta.77 → 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 +1658 -117
- package/dist/generated/schemas.d.ts +1435 -130
- package/dist/generated/schemas.js +345 -41
- package/dist/models.d.ts +10 -47
- package/dist/schemas.d.ts +145 -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
|
*
|
|
@@ -218,7 +218,7 @@ export interface paths {
|
|
|
218
218
|
*
|
|
219
219
|
* When providing your API authentication token, we recommend using the
|
|
220
220
|
* request's `Authorization` header, rather than the URL.
|
|
221
|
-
* For details, see [Authentication](https://docs.apify.com/api/v2
|
|
221
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
222
222
|
*
|
|
223
223
|
* The response is the `Version` object as
|
|
224
224
|
* returned by the [Get Actor version](https://docs.apify.com/api/v2/actor-version-get) endpoint.
|
|
@@ -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;
|
|
@@ -309,7 +336,7 @@ export interface paths {
|
|
|
309
336
|
*
|
|
310
337
|
* When providing your API authentication token, we recommend using the
|
|
311
338
|
* request's `Authorization` header, rather than the URL.
|
|
312
|
-
* For details, see [Authentication](https://docs.apify.com/api/v2
|
|
339
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
313
340
|
*
|
|
314
341
|
* The response is the `EnvVar` object as returned by the
|
|
315
342
|
* [Get environment variable of Actor version](https://docs.apify.com/api/v2/actor-version-env-var-get)
|
|
@@ -361,6 +388,31 @@ export interface paths {
|
|
|
361
388
|
patch?: never;
|
|
362
389
|
trace?: never;
|
|
363
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
|
+
};
|
|
364
416
|
"/v2/actors/{actorId}/builds": {
|
|
365
417
|
parameters: {
|
|
366
418
|
query?: never;
|
|
@@ -1569,7 +1621,7 @@ export interface paths {
|
|
|
1569
1621
|
*
|
|
1570
1622
|
* When providing your API authentication token, we recommend using the
|
|
1571
1623
|
* request's `Authorization` header, rather than the URL.
|
|
1572
|
-
* For details, see [Authentication](https://docs.apify.com/api/v2
|
|
1624
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
1573
1625
|
*/
|
|
1574
1626
|
put: operations["actorTask_input_put"];
|
|
1575
1627
|
post?: never;
|
|
@@ -3264,6 +3316,53 @@ export interface paths {
|
|
|
3264
3316
|
patch?: never;
|
|
3265
3317
|
trace?: never;
|
|
3266
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
|
+
};
|
|
3267
3366
|
"/v2/key-value-stores": {
|
|
3268
3367
|
parameters: {
|
|
3269
3368
|
query?: never;
|
|
@@ -4134,7 +4233,7 @@ export interface paths {
|
|
|
4134
4233
|
*
|
|
4135
4234
|
* When providing your API authentication token, we recommend using the
|
|
4136
4235
|
* request's `Authorization` header, rather than the URL.
|
|
4137
|
-
* For details, see [Authentication](https://docs.apify.com/api/v2
|
|
4236
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
4138
4237
|
*/
|
|
4139
4238
|
put: operations["webhook_put"];
|
|
4140
4239
|
post?: never;
|
|
@@ -4262,7 +4361,7 @@ export interface paths {
|
|
|
4262
4361
|
*
|
|
4263
4362
|
* When providing your API authentication token, we recommend using the
|
|
4264
4363
|
* request's `Authorization` header, rather than the URL.
|
|
4265
|
-
* For details, see [Authentication](https://docs.apify.com/api/v2
|
|
4364
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
4266
4365
|
*/
|
|
4267
4366
|
post: operations["schedules_post"];
|
|
4268
4367
|
delete?: never;
|
|
@@ -4297,7 +4396,7 @@ export interface paths {
|
|
|
4297
4396
|
*
|
|
4298
4397
|
* When providing your API authentication token, we recommend using the
|
|
4299
4398
|
* request's `Authorization` header, rather than the URL.
|
|
4300
|
-
* For details, see [Authentication](https://docs.apify.com/api/v2
|
|
4399
|
+
* For details, see [Authentication](https://docs.apify.com/api/v2#authentication).
|
|
4301
4400
|
*/
|
|
4302
4401
|
put: operations["schedule_put"];
|
|
4303
4402
|
post?: never;
|
|
@@ -4311,6 +4410,29 @@ export interface paths {
|
|
|
4311
4410
|
patch?: never;
|
|
4312
4411
|
trace?: never;
|
|
4313
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
|
+
};
|
|
4314
4436
|
"/v2/schedules/{scheduleId}/log": {
|
|
4315
4437
|
parameters: {
|
|
4316
4438
|
query?: never;
|
|
@@ -4391,6 +4513,10 @@ export interface paths {
|
|
|
4391
4513
|
* can be seen on public profile pages (e.g. https://apify.com/apify).
|
|
4392
4514
|
*
|
|
4393
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.
|
|
4394
4520
|
*/
|
|
4395
4521
|
get: operations["user_get"];
|
|
4396
4522
|
put?: never;
|
|
@@ -4479,6 +4605,138 @@ export interface paths {
|
|
|
4479
4605
|
patch?: never;
|
|
4480
4606
|
trace?: never;
|
|
4481
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
|
+
};
|
|
4482
4740
|
"/v2/browser-info": {
|
|
4483
4741
|
parameters: {
|
|
4484
4742
|
query?: never;
|
|
@@ -4750,6 +5008,8 @@ export interface components {
|
|
|
4750
5008
|
type?: components["schemas"]["ErrorType"];
|
|
4751
5009
|
/** @description Human-readable error message describing what went wrong. */
|
|
4752
5010
|
message?: string;
|
|
5011
|
+
/** @description Additional machine-readable details about the error. Present only for some error types. */
|
|
5012
|
+
data?: Record<string, unknown>;
|
|
4753
5013
|
};
|
|
4754
5014
|
/** ErrorResponse */
|
|
4755
5015
|
ErrorResponse: {
|
|
@@ -4884,6 +5144,13 @@ export interface components {
|
|
|
4884
5144
|
restartOnError?: boolean | null;
|
|
4885
5145
|
/** @description Maximum number of items the run might produce. */
|
|
4886
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;
|
|
4887
5154
|
forcePermissionLevel?: components["schemas"]["ActorPermissionLevel"] | null;
|
|
4888
5155
|
};
|
|
4889
5156
|
/** ActorStandby */
|
|
@@ -4904,6 +5171,15 @@ export interface components {
|
|
|
4904
5171
|
disableStandbyFieldsOverride?: boolean | null;
|
|
4905
5172
|
/** @description Whether to pass the Actor's input to the standby run. If `false`, the standby runs start with no input. */
|
|
4906
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;
|
|
4907
5183
|
};
|
|
4908
5184
|
/** ExampleRunInput */
|
|
4909
5185
|
ExampleRunInput: {
|
|
@@ -4995,6 +5271,11 @@ export interface components {
|
|
|
4995
5271
|
* @example false
|
|
4996
5272
|
*/
|
|
4997
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;
|
|
4998
5279
|
};
|
|
4999
5280
|
/** Version */
|
|
5000
5281
|
Version: {
|
|
@@ -5025,6 +5306,12 @@ export interface components {
|
|
|
5025
5306
|
tarballUrl?: string | null;
|
|
5026
5307
|
/** @description URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`. */
|
|
5027
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;
|
|
5028
5315
|
};
|
|
5029
5316
|
/** CommonActorPricingInfo */
|
|
5030
5317
|
CommonActorPricingInfo: {
|
|
@@ -5047,6 +5334,8 @@ export interface components {
|
|
|
5047
5334
|
notifiedAboutFutureChangeAt?: Date | null;
|
|
5048
5335
|
/** Format: date-time */
|
|
5049
5336
|
notifiedAboutChangeAt?: Date | null;
|
|
5337
|
+
/** Format: date-time */
|
|
5338
|
+
notifiedAboutRentalToPpePriceChangeAt?: Date | null;
|
|
5050
5339
|
reasonForChange?: string | null;
|
|
5051
5340
|
isPriceChangeNotificationSuppressed?: boolean;
|
|
5052
5341
|
forceContainsSignificantPriceChange?: boolean;
|
|
@@ -5095,6 +5384,11 @@ export interface components {
|
|
|
5095
5384
|
};
|
|
5096
5385
|
};
|
|
5097
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;
|
|
5098
5392
|
} & {
|
|
5099
5393
|
/**
|
|
5100
5394
|
* @description discriminator enum property added by openapi-typescript
|
|
@@ -5285,7 +5579,7 @@ export interface components {
|
|
|
5285
5579
|
*/
|
|
5286
5580
|
isDeprecated?: boolean | null;
|
|
5287
5581
|
/**
|
|
5288
|
-
* @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.
|
|
5289
5583
|
* @example ssh-rsa AAAA ...
|
|
5290
5584
|
*/
|
|
5291
5585
|
deploymentKey?: string;
|
|
@@ -5479,6 +5773,20 @@ export interface components {
|
|
|
5479
5773
|
/** @description URL of the GitHub Gist to clone the source code from. Applies when the `sourceType` is `GITHUB_GIST`. */
|
|
5480
5774
|
gitHubGistUrl?: string;
|
|
5481
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
|
+
};
|
|
5482
5790
|
/** ListOfEnvVars */
|
|
5483
5791
|
ListOfEnvVars: {
|
|
5484
5792
|
/** @example 5 */
|
|
@@ -5508,6 +5816,85 @@ export interface components {
|
|
|
5508
5816
|
/** @example hgdKZtadYvn4mBpoi */
|
|
5509
5817
|
actorRunId?: string | null;
|
|
5510
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
|
+
};
|
|
5511
5898
|
/**
|
|
5512
5899
|
* WebhookDispatchStatus
|
|
5513
5900
|
* @description Status of the webhook dispatch indicating whether the HTTP request was successful.
|
|
@@ -5533,8 +5920,8 @@ export interface components {
|
|
|
5533
5920
|
/** @example 1 */
|
|
5534
5921
|
totalDispatches?: number;
|
|
5535
5922
|
};
|
|
5536
|
-
/**
|
|
5537
|
-
|
|
5923
|
+
/** WebhookResource */
|
|
5924
|
+
WebhookResource: {
|
|
5538
5925
|
/** @example YiKoxjkaS9gjGTqhF */
|
|
5539
5926
|
id: string;
|
|
5540
5927
|
/**
|
|
@@ -5551,13 +5938,16 @@ export interface components {
|
|
|
5551
5938
|
userId: string;
|
|
5552
5939
|
/** @example false */
|
|
5553
5940
|
isAdHoc?: boolean | null;
|
|
5554
|
-
/** @example false */
|
|
5555
|
-
isApifyIntegration?: boolean;
|
|
5556
5941
|
/** @example true */
|
|
5557
5942
|
isEnabled?: boolean;
|
|
5558
|
-
/**
|
|
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
|
+
*/
|
|
5559
5947
|
actionType?: string;
|
|
5560
5948
|
/** @example false */
|
|
5949
|
+
isApifyIntegration?: boolean | null;
|
|
5950
|
+
/** @example false */
|
|
5561
5951
|
shouldInterpolateStrings?: boolean | null;
|
|
5562
5952
|
/**
|
|
5563
5953
|
* @example [
|
|
@@ -5569,26 +5959,94 @@ export interface components {
|
|
|
5569
5959
|
/** @example false */
|
|
5570
5960
|
ignoreSslErrors: boolean;
|
|
5571
5961
|
/** @example false */
|
|
5572
|
-
doNotRetry
|
|
5962
|
+
doNotRetry?: boolean | null;
|
|
5573
5963
|
/**
|
|
5574
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).
|
|
5575
5966
|
* @example http://example.com/
|
|
5576
5967
|
*/
|
|
5577
|
-
requestUrl
|
|
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"];
|
|
5578
5981
|
lastDispatch?: components["schemas"]["WebhookLastDispatch"] | null;
|
|
5579
5982
|
stats?: components["schemas"]["WebhookStats"] | null;
|
|
5580
5983
|
};
|
|
5581
|
-
/**
|
|
5582
|
-
|
|
5583
|
-
|
|
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"][];
|
|
5584
5990
|
};
|
|
5585
|
-
/**
|
|
5586
|
-
|
|
5587
|
-
data: components["schemas"]["
|
|
5991
|
+
/** ListOfWebhookResourcesResponse */
|
|
5992
|
+
ListOfWebhookResourcesResponse: {
|
|
5993
|
+
data: components["schemas"]["ListOfWebhookResources"];
|
|
5588
5994
|
};
|
|
5589
5995
|
/**
|
|
5590
|
-
*
|
|
5591
|
-
* @description
|
|
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"];
|
|
6046
|
+
};
|
|
6047
|
+
/**
|
|
6048
|
+
* ActorJobStatus
|
|
6049
|
+
* @description Status of an Actor job (run or build).
|
|
5592
6050
|
* @enum {string}
|
|
5593
6051
|
*/
|
|
5594
6052
|
ActorJobStatus: "READY" | "RUNNING" | "SUCCEEDED" | "FAILED" | "TIMING-OUT" | "TIMED-OUT" | "ABORTING" | "ABORTED";
|
|
@@ -5606,10 +6064,25 @@ export interface components {
|
|
|
5606
6064
|
*/
|
|
5607
6065
|
clientIp?: string;
|
|
5608
6066
|
/**
|
|
5609
|
-
* @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.
|
|
5610
6068
|
* @example Mozilla/5.0 (iPad)
|
|
5611
6069
|
*/
|
|
5612
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;
|
|
5613
6086
|
};
|
|
5614
6087
|
/** BuildListItem */
|
|
5615
6088
|
BuildListItem: {
|
|
@@ -5630,8 +6103,11 @@ export interface components {
|
|
|
5630
6103
|
* @example 2019-12-12T09:30:12.202Z
|
|
5631
6104
|
*/
|
|
5632
6105
|
finishedAt?: Date | null;
|
|
5633
|
-
/**
|
|
5634
|
-
|
|
6106
|
+
/**
|
|
6107
|
+
* @description Total cost in USD for this build. Requires authentication token to access.
|
|
6108
|
+
* @example 0.02
|
|
6109
|
+
*/
|
|
6110
|
+
usageTotalUsd?: number;
|
|
5635
6111
|
/** @example 0.1.1 */
|
|
5636
6112
|
buildNumber: string;
|
|
5637
6113
|
/** @example 10000 */
|
|
@@ -5667,6 +6143,13 @@ export interface components {
|
|
|
5667
6143
|
memoryMbytes?: number | null;
|
|
5668
6144
|
/** @example 2048 */
|
|
5669
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;
|
|
5670
6153
|
};
|
|
5671
6154
|
/** BuildUsage */
|
|
5672
6155
|
BuildUsage: {
|
|
@@ -5868,6 +6351,31 @@ export interface components {
|
|
|
5868
6351
|
* @example # Magic Actor\nThis Actor is magic.
|
|
5869
6352
|
*/
|
|
5870
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;
|
|
5871
6379
|
/** @example 0.1.1 */
|
|
5872
6380
|
buildNumber: string;
|
|
5873
6381
|
/**
|
|
@@ -5895,6 +6403,16 @@ export interface components {
|
|
|
5895
6403
|
gitRepoUrl?: string;
|
|
5896
6404
|
/** @description Inline source files, present when sourceType is SOURCE_FILES. */
|
|
5897
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;
|
|
5898
6416
|
};
|
|
5899
6417
|
actorDefinition?: components["schemas"]["ActorDefinition"] | null;
|
|
5900
6418
|
};
|
|
@@ -5919,6 +6437,38 @@ export interface components {
|
|
|
5919
6437
|
* @description Time when the run was scheduled.
|
|
5920
6438
|
*/
|
|
5921
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;
|
|
5922
6472
|
};
|
|
5923
6473
|
/** RunListItem */
|
|
5924
6474
|
RunListItem: {
|
|
@@ -5956,6 +6506,8 @@ export interface components {
|
|
|
5956
6506
|
defaultDatasetId: string;
|
|
5957
6507
|
/** @example so93g2shcDzK3pA85 */
|
|
5958
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;
|
|
5959
6511
|
};
|
|
5960
6512
|
/** ListOfRuns */
|
|
5961
6513
|
ListOfRuns: components["schemas"]["PaginationResponse"] & {
|
|
@@ -6051,6 +6603,40 @@ export interface components {
|
|
|
6051
6603
|
/** @example 0.13804 */
|
|
6052
6604
|
computeUnits?: number;
|
|
6053
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
|
+
};
|
|
6054
6640
|
/** RunOptions */
|
|
6055
6641
|
RunOptions: {
|
|
6056
6642
|
/** @example latest */
|
|
@@ -6061,10 +6647,20 @@ export interface components {
|
|
|
6061
6647
|
memoryMbytes: number;
|
|
6062
6648
|
/** @example 2048 */
|
|
6063
6649
|
diskMbytes: number;
|
|
6650
|
+
/**
|
|
6651
|
+
* @description Whether to automatically restart the run if it fails.
|
|
6652
|
+
* @example false
|
|
6653
|
+
*/
|
|
6654
|
+
restartOnError?: boolean | null;
|
|
6064
6655
|
/** @example 1000 */
|
|
6065
6656
|
maxItems?: number | null;
|
|
6066
6657
|
/** @example 5 */
|
|
6067
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;
|
|
6068
6664
|
};
|
|
6069
6665
|
/**
|
|
6070
6666
|
* GeneralAccess
|
|
@@ -6099,6 +6695,8 @@ export interface components {
|
|
|
6099
6695
|
PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number | null;
|
|
6100
6696
|
/** @example 3 */
|
|
6101
6697
|
PROXY_SERPS?: number | null;
|
|
6698
|
+
/** @example 0 */
|
|
6699
|
+
PROXY_UNBLOCKER_UNITS?: number | null;
|
|
6102
6700
|
};
|
|
6103
6701
|
/**
|
|
6104
6702
|
* RunUsageUsd
|
|
@@ -6129,6 +6727,8 @@ export interface components {
|
|
|
6129
6727
|
PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number | null;
|
|
6130
6728
|
/** @example 0.003 */
|
|
6131
6729
|
PROXY_SERPS?: number | null;
|
|
6730
|
+
/** @example 0 */
|
|
6731
|
+
PROXY_UNBLOCKER_UNITS?: number | null;
|
|
6132
6732
|
};
|
|
6133
6733
|
/**
|
|
6134
6734
|
* RunMetamorphEvent
|
|
@@ -6156,6 +6756,13 @@ export interface components {
|
|
|
6156
6756
|
* @example INPUT-METAMORPH-1
|
|
6157
6757
|
*/
|
|
6158
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[];
|
|
6159
6766
|
};
|
|
6160
6767
|
/**
|
|
6161
6768
|
* Run
|
|
@@ -6223,6 +6830,49 @@ export interface components {
|
|
|
6223
6830
|
chargedEventCounts?: {
|
|
6224
6831
|
[key: string]: number;
|
|
6225
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
|
+
};
|
|
6226
6876
|
/** @description Configuration options for the Actor run. */
|
|
6227
6877
|
options: components["schemas"]["RunOptions"];
|
|
6228
6878
|
/**
|
|
@@ -6334,12 +6984,12 @@ export interface components {
|
|
|
6334
6984
|
/** @example 3 */
|
|
6335
6985
|
writeCount?: number;
|
|
6336
6986
|
/**
|
|
6337
|
-
* @description Total storage size in bytes.
|
|
6987
|
+
* @description Total storage size in bytes.
|
|
6338
6988
|
* @example 783
|
|
6339
6989
|
*/
|
|
6340
6990
|
storageBytes?: number;
|
|
6341
6991
|
/**
|
|
6342
|
-
* @description Uncompressed size in bytes.
|
|
6992
|
+
* @description Uncompressed size in bytes.
|
|
6343
6993
|
* @example 0
|
|
6344
6994
|
*/
|
|
6345
6995
|
inflatedBytes?: number;
|
|
@@ -6350,6 +7000,8 @@ export interface components {
|
|
|
6350
7000
|
id: string;
|
|
6351
7001
|
/** @example d7b9MDYsbtX5L7XAj */
|
|
6352
7002
|
name?: string | null;
|
|
7003
|
+
/** @example My Dataset */
|
|
7004
|
+
title?: string | null;
|
|
6353
7005
|
/** @example wRsJZtadYvn4mBZmm */
|
|
6354
7006
|
userId: string;
|
|
6355
7007
|
/**
|
|
@@ -6576,6 +7228,8 @@ export interface components {
|
|
|
6576
7228
|
id: string;
|
|
6577
7229
|
/** @example d7b9MDYsbtX5L7XAj */
|
|
6578
7230
|
name?: string | null;
|
|
7231
|
+
/** @example My Store */
|
|
7232
|
+
title?: string | null;
|
|
6579
7233
|
/** @example BPWDBd7Z9c746JAnF */
|
|
6580
7234
|
userId?: string | null;
|
|
6581
7235
|
/** @example janedoe */
|
|
@@ -6809,6 +7463,11 @@ export interface components {
|
|
|
6809
7463
|
* @example some-name
|
|
6810
7464
|
*/
|
|
6811
7465
|
name?: string | null;
|
|
7466
|
+
/**
|
|
7467
|
+
* @description The title of the request queue.
|
|
7468
|
+
* @example My Queue
|
|
7469
|
+
*/
|
|
7470
|
+
title?: string | null;
|
|
6812
7471
|
userId: components["schemas"]["QueueUserId"];
|
|
6813
7472
|
/** @description The ID of the Actor that created this request queue. */
|
|
6814
7473
|
actId?: string | null;
|
|
@@ -6927,12 +7586,26 @@ export interface components {
|
|
|
6927
7586
|
* @example sbJ7klsdf7ujN9l
|
|
6928
7587
|
*/
|
|
6929
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;
|
|
6930
7595
|
/**
|
|
6931
7596
|
* RequestResource
|
|
6932
7597
|
* @description A request stored in the request queue, including its metadata and processing state.
|
|
6933
7598
|
*/
|
|
6934
7599
|
RequestResource: components["schemas"]["RequestBase"] & {
|
|
6935
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;
|
|
6936
7609
|
};
|
|
6937
7610
|
/**
|
|
6938
7611
|
* ListOfRequests
|
|
@@ -7190,12 +7863,6 @@ export interface components {
|
|
|
7190
7863
|
UpdateRequestResponse: {
|
|
7191
7864
|
data: components["schemas"]["RequestRegistration"];
|
|
7192
7865
|
};
|
|
7193
|
-
/**
|
|
7194
|
-
* Format: date-time
|
|
7195
|
-
* @description The timestamp when the lock on this request expires.
|
|
7196
|
-
* @example 2022-06-14T23:00:00.000Z
|
|
7197
|
-
*/
|
|
7198
|
-
LockExpiresAt: Date;
|
|
7199
7866
|
/**
|
|
7200
7867
|
* RequestLockInfo
|
|
7201
7868
|
* @description Information about a request lock.
|
|
@@ -7357,6 +8024,12 @@ export interface components {
|
|
|
7357
8024
|
TaskStats: {
|
|
7358
8025
|
/** @example 15 */
|
|
7359
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;
|
|
7360
8033
|
};
|
|
7361
8034
|
/** TaskListItem */
|
|
7362
8035
|
TaskListItem: {
|
|
@@ -7370,6 +8043,8 @@ export interface components {
|
|
|
7370
8043
|
actName?: string | null;
|
|
7371
8044
|
/** @example my-task */
|
|
7372
8045
|
name: string;
|
|
8046
|
+
/** @example My task */
|
|
8047
|
+
title?: string | null;
|
|
7373
8048
|
/** @example janedoe */
|
|
7374
8049
|
username?: string | null;
|
|
7375
8050
|
/** @example janedoe */
|
|
@@ -7385,6 +8060,11 @@ export interface components {
|
|
|
7385
8060
|
*/
|
|
7386
8061
|
modifiedAt: Date;
|
|
7387
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;
|
|
7388
8068
|
};
|
|
7389
8069
|
/** ListOfTasks */
|
|
7390
8070
|
ListOfTasks: components["schemas"]["PaginationResponse"] & {
|
|
@@ -7408,6 +8088,13 @@ export interface components {
|
|
|
7408
8088
|
maxTotalChargeUsd?: number | null;
|
|
7409
8089
|
/** @example false */
|
|
7410
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;
|
|
7411
8098
|
};
|
|
7412
8099
|
/**
|
|
7413
8100
|
* TaskInput
|
|
@@ -7464,6 +8151,15 @@ export interface components {
|
|
|
7464
8151
|
* one of the views declared on the resolved dataset. You can't publish a task without it.
|
|
7465
8152
|
*/
|
|
7466
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;
|
|
7467
8163
|
};
|
|
7468
8164
|
/** CreateTaskRequest */
|
|
7469
8165
|
CreateTaskRequest: {
|
|
@@ -7492,6 +8188,11 @@ export interface components {
|
|
|
7492
8188
|
actId: string;
|
|
7493
8189
|
/** @example my-task */
|
|
7494
8190
|
name: string;
|
|
8191
|
+
/**
|
|
8192
|
+
* @description Task name in lowercase.
|
|
8193
|
+
* @example my-task
|
|
8194
|
+
*/
|
|
8195
|
+
nameLowerCase?: string;
|
|
7495
8196
|
/** @example janedoe */
|
|
7496
8197
|
username?: string | null;
|
|
7497
8198
|
/**
|
|
@@ -7576,52 +8277,6 @@ export interface components {
|
|
|
7576
8277
|
*/
|
|
7577
8278
|
isPublic?: boolean;
|
|
7578
8279
|
};
|
|
7579
|
-
/** WebhookResource */
|
|
7580
|
-
WebhookResource: {
|
|
7581
|
-
/** @example YiKoxjkaS9gjGTqhF */
|
|
7582
|
-
id: string;
|
|
7583
|
-
/**
|
|
7584
|
-
* Format: date-time
|
|
7585
|
-
* @example 2019-12-12T07:34:14.202Z
|
|
7586
|
-
*/
|
|
7587
|
-
createdAt: Date;
|
|
7588
|
-
/**
|
|
7589
|
-
* Format: date-time
|
|
7590
|
-
* @example 2019-12-13T08:36:13.202Z
|
|
7591
|
-
*/
|
|
7592
|
-
modifiedAt: Date;
|
|
7593
|
-
/** @example wRsJZtadYvn4mBZmm */
|
|
7594
|
-
userId: string;
|
|
7595
|
-
/** @example false */
|
|
7596
|
-
isAdHoc?: boolean | null;
|
|
7597
|
-
/** @example false */
|
|
7598
|
-
shouldInterpolateStrings?: boolean | null;
|
|
7599
|
-
/**
|
|
7600
|
-
* @example [
|
|
7601
|
-
* "ACTOR.RUN.SUCCEEDED"
|
|
7602
|
-
* ]
|
|
7603
|
-
*/
|
|
7604
|
-
eventTypes: components["schemas"]["WebhookEventType"][];
|
|
7605
|
-
condition: components["schemas"]["WebhookCondition"];
|
|
7606
|
-
/** @example false */
|
|
7607
|
-
ignoreSslErrors: boolean;
|
|
7608
|
-
/** @example false */
|
|
7609
|
-
doNotRetry?: boolean | null;
|
|
7610
|
-
/**
|
|
7611
|
-
* Format: uri
|
|
7612
|
-
* @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).
|
|
7613
|
-
* @example http://example.com/
|
|
7614
|
-
*/
|
|
7615
|
-
requestUrl?: string | null;
|
|
7616
|
-
/** @example {\n "userId": {{userId}}... */
|
|
7617
|
-
payloadTemplate?: string | null;
|
|
7618
|
-
/** @example {\n "Authorization": "Bearer ..."} */
|
|
7619
|
-
headersTemplate?: string | null;
|
|
7620
|
-
/** @example this is webhook description */
|
|
7621
|
-
description?: string | null;
|
|
7622
|
-
lastDispatch?: components["schemas"]["WebhookLastDispatch"] | null;
|
|
7623
|
-
stats?: components["schemas"]["WebhookStats"] | null;
|
|
7624
|
-
};
|
|
7625
8280
|
/** UpdateRunRequest */
|
|
7626
8281
|
UpdateRunRequest: {
|
|
7627
8282
|
/** @example 3KH8gEpp4d8uQSe8T */
|
|
@@ -7644,11 +8299,116 @@ export interface components {
|
|
|
7644
8299
|
*/
|
|
7645
8300
|
requestId?: string;
|
|
7646
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
|
+
};
|
|
7647
8355
|
/**
|
|
7648
8356
|
* @example ownedByMe
|
|
7649
8357
|
* @enum {string}
|
|
7650
8358
|
*/
|
|
7651
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
|
+
};
|
|
7652
8412
|
/** ListOfKeyValueStores */
|
|
7653
8413
|
ListOfKeyValueStores: components["schemas"]["PaginationResponse"] & {
|
|
7654
8414
|
/**
|
|
@@ -7656,7 +8416,7 @@ export interface components {
|
|
|
7656
8416
|
* @example false
|
|
7657
8417
|
*/
|
|
7658
8418
|
unnamed?: boolean;
|
|
7659
|
-
items: components["schemas"]["
|
|
8419
|
+
items: components["schemas"]["KeyValueStoreListItem"][];
|
|
7660
8420
|
};
|
|
7661
8421
|
/** ListOfKeyValueStoresResponse */
|
|
7662
8422
|
ListOfKeyValueStoresResponse: {
|
|
@@ -7667,7 +8427,7 @@ export interface components {
|
|
|
7667
8427
|
/** @example WkzbQMuFYuamGv3YF */
|
|
7668
8428
|
id: string;
|
|
7669
8429
|
/** @example d7b9MDYsbtX5L7XAj */
|
|
7670
|
-
name
|
|
8430
|
+
name?: string | null;
|
|
7671
8431
|
/** @example tbXmWu7GCxnyYtSiL */
|
|
7672
8432
|
userId: string;
|
|
7673
8433
|
/**
|
|
@@ -7713,6 +8473,42 @@ export interface components {
|
|
|
7713
8473
|
ListOfDatasetsResponse: {
|
|
7714
8474
|
data: components["schemas"]["ListOfDatasets"];
|
|
7715
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
|
+
};
|
|
7716
8512
|
/**
|
|
7717
8513
|
* RequestQueueListItem
|
|
7718
8514
|
* @description A shortened request queue object for list responses.
|
|
@@ -7723,13 +8519,18 @@ export interface components {
|
|
|
7723
8519
|
* @description The name of the request queue.
|
|
7724
8520
|
* @example some-name
|
|
7725
8521
|
*/
|
|
7726
|
-
name
|
|
8522
|
+
name?: string | null;
|
|
8523
|
+
/**
|
|
8524
|
+
* @description The title of the request queue.
|
|
8525
|
+
* @example My Queue
|
|
8526
|
+
*/
|
|
8527
|
+
title?: string | null;
|
|
7727
8528
|
userId: components["schemas"]["QueueUserId"];
|
|
7728
8529
|
/**
|
|
7729
8530
|
* @description The username of the user who owns the request queue.
|
|
7730
8531
|
* @example janedoe
|
|
7731
8532
|
*/
|
|
7732
|
-
username
|
|
8533
|
+
username?: string;
|
|
7733
8534
|
createdAt: components["schemas"]["QueueCreatedAt"];
|
|
7734
8535
|
modifiedAt: components["schemas"]["QueueModifiedAt"];
|
|
7735
8536
|
accessedAt: components["schemas"]["QueueAccessedAt"];
|
|
@@ -7748,7 +8549,7 @@ export interface components {
|
|
|
7748
8549
|
actRunId?: string | null;
|
|
7749
8550
|
hadMultipleClients: components["schemas"]["HadMultipleClients"];
|
|
7750
8551
|
generalAccess?: components["schemas"]["GeneralAccess"] | null;
|
|
7751
|
-
stats?: components["schemas"]["
|
|
8552
|
+
stats?: components["schemas"]["RequestQueueListStats"];
|
|
7752
8553
|
};
|
|
7753
8554
|
/**
|
|
7754
8555
|
* ListOfRequestQueues
|
|
@@ -7759,16 +8560,80 @@ export interface components {
|
|
|
7759
8560
|
* @description Whether the listing was filtered to only unnamed request queues.
|
|
7760
8561
|
* @example false
|
|
7761
8562
|
*/
|
|
7762
|
-
unnamed?: boolean;
|
|
7763
|
-
/** @description The array of request queues. */
|
|
7764
|
-
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;
|
|
7765
8629
|
};
|
|
7766
|
-
/**
|
|
7767
|
-
|
|
7768
|
-
|
|
7769
|
-
|
|
7770
|
-
|
|
7771
|
-
|
|
8630
|
+
/** ListOfWebhooks */
|
|
8631
|
+
ListOfWebhooks: components["schemas"]["PaginationResponse"] & {
|
|
8632
|
+
items: components["schemas"]["WebhookListItem"][];
|
|
8633
|
+
};
|
|
8634
|
+
/** ListOfWebhooksResponse */
|
|
8635
|
+
ListOfWebhooksResponse: {
|
|
8636
|
+
data: components["schemas"]["ListOfWebhooks"];
|
|
7772
8637
|
};
|
|
7773
8638
|
/** CreateWebhookRequest */
|
|
7774
8639
|
CreateWebhookRequest: {
|
|
@@ -7839,6 +8704,11 @@ export interface components {
|
|
|
7839
8704
|
* @description A summary of the webhook that triggered this dispatch.
|
|
7840
8705
|
*/
|
|
7841
8706
|
WebhookDispatchWebhookSummary: {
|
|
8707
|
+
/**
|
|
8708
|
+
* @description ID of the webhook. The API returns it under `_id`, not `id`.
|
|
8709
|
+
* @example YiKoxjkaS9gjGTqhF
|
|
8710
|
+
*/
|
|
8711
|
+
_id?: string;
|
|
7842
8712
|
/** @example HTTP_REQUEST */
|
|
7843
8713
|
actionType?: string;
|
|
7844
8714
|
condition?: components["schemas"]["WebhookCondition"];
|
|
@@ -7850,6 +8720,12 @@ export interface components {
|
|
|
7850
8720
|
requestUrl?: string | null;
|
|
7851
8721
|
/** @example false */
|
|
7852
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"];
|
|
7853
8729
|
};
|
|
7854
8730
|
/** WebhookDispatch */
|
|
7855
8731
|
WebhookDispatch: {
|
|
@@ -7896,6 +8772,10 @@ export interface components {
|
|
|
7896
8772
|
responseStatus?: number | null;
|
|
7897
8773
|
/** @example {"foo": "bar"} */
|
|
7898
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
|
+
};
|
|
7899
8779
|
}[];
|
|
7900
8780
|
};
|
|
7901
8781
|
/** WebhookDispatchResponse */
|
|
@@ -7947,6 +8827,14 @@ export interface components {
|
|
|
7947
8827
|
*/
|
|
7948
8828
|
lastRunAt?: Date | null;
|
|
7949
8829
|
};
|
|
8830
|
+
/**
|
|
8831
|
+
* ScheduleNotifications
|
|
8832
|
+
* @description Notification settings for this schedule.
|
|
8833
|
+
*/
|
|
8834
|
+
ScheduleNotifications: {
|
|
8835
|
+
/** @example true */
|
|
8836
|
+
email?: boolean;
|
|
8837
|
+
};
|
|
7950
8838
|
/** ScheduleListItemActionRunActor */
|
|
7951
8839
|
ScheduleListItemActionRunActor: {
|
|
7952
8840
|
/** @example ZReCs7hkdieq8ZUki */
|
|
@@ -7975,6 +8863,10 @@ export interface components {
|
|
|
7975
8863
|
ScheduleListItemAction: components["schemas"]["ScheduleListItemActionRunActor"] | components["schemas"]["ScheduleListItemActionRunActorTask"];
|
|
7976
8864
|
/** ScheduleListItem */
|
|
7977
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"];
|
|
7978
8870
|
actions: components["schemas"]["ScheduleListItemAction"][];
|
|
7979
8871
|
};
|
|
7980
8872
|
/** ListOfSchedules */
|
|
@@ -7985,14 +8877,6 @@ export interface components {
|
|
|
7985
8877
|
ListOfSchedulesResponse: {
|
|
7986
8878
|
data: components["schemas"]["ListOfSchedules"];
|
|
7987
8879
|
};
|
|
7988
|
-
/**
|
|
7989
|
-
* ScheduleNotifications
|
|
7990
|
-
* @description Notification settings for this schedule.
|
|
7991
|
-
*/
|
|
7992
|
-
ScheduleNotifications: {
|
|
7993
|
-
/** @example true */
|
|
7994
|
-
email?: boolean;
|
|
7995
|
-
};
|
|
7996
8880
|
/** ScheduleActionRunInput */
|
|
7997
8881
|
ScheduleActionRunInput: {
|
|
7998
8882
|
/** @example {\n "foo": "actor"\n} */
|
|
@@ -8043,6 +8927,26 @@ export interface components {
|
|
|
8043
8927
|
notifications?: components["schemas"]["ScheduleNotifications"];
|
|
8044
8928
|
actions?: components["schemas"]["ScheduleCreateAction"][] | null;
|
|
8045
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
|
+
};
|
|
8046
8950
|
/** ScheduleActionRunActor */
|
|
8047
8951
|
ScheduleActionRunActor: {
|
|
8048
8952
|
/** @example c6KfSgoQzFhMk3etc */
|
|
@@ -8078,6 +8982,9 @@ export interface components {
|
|
|
8078
8982
|
description?: string | null;
|
|
8079
8983
|
title?: string | null;
|
|
8080
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"];
|
|
8081
8988
|
actions: components["schemas"]["ScheduleAction"][];
|
|
8082
8989
|
};
|
|
8083
8990
|
/** ScheduleResponse */
|
|
@@ -8143,6 +9050,39 @@ export interface components {
|
|
|
8143
9050
|
pricingPerEvent?: {
|
|
8144
9051
|
[key: string]: unknown;
|
|
8145
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;
|
|
8146
9086
|
};
|
|
8147
9087
|
/** StoreActor */
|
|
8148
9088
|
StoreActor: {
|
|
@@ -8192,6 +9132,32 @@ export interface components {
|
|
|
8192
9132
|
badge?: string | null;
|
|
8193
9133
|
/** @description A brief, LLM-generated readme summary */
|
|
8194
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
|
+
};
|
|
8195
9161
|
};
|
|
8196
9162
|
/** ListOfStoreActors */
|
|
8197
9163
|
ListOfStoreActors: components["schemas"]["PaginationResponse"] & {
|
|
@@ -8307,17 +9273,22 @@ export interface components {
|
|
|
8307
9273
|
};
|
|
8308
9274
|
/** ProxyGroup */
|
|
8309
9275
|
ProxyGroup: {
|
|
9276
|
+
/** @example Hsu2Sk8jPqxd3dNsB */
|
|
9277
|
+
id?: string;
|
|
8310
9278
|
/** @example Group1 */
|
|
8311
9279
|
name: string;
|
|
8312
9280
|
/** @example Group1 description */
|
|
8313
9281
|
description: string | null;
|
|
8314
9282
|
/** @example 10 */
|
|
8315
|
-
availableCount
|
|
9283
|
+
availableCount?: number;
|
|
8316
9284
|
};
|
|
8317
|
-
/**
|
|
9285
|
+
/**
|
|
9286
|
+
* ProxyResource
|
|
9287
|
+
* @description Proxy access info. Omitted when the user has no access to Apify Proxy.
|
|
9288
|
+
*/
|
|
8318
9289
|
ProxyResource: {
|
|
8319
9290
|
/** @example ad78knd9Jkjd86 */
|
|
8320
|
-
password
|
|
9291
|
+
password?: string | null;
|
|
8321
9292
|
groups: components["schemas"]["ProxyGroup"][];
|
|
8322
9293
|
};
|
|
8323
9294
|
/**
|
|
@@ -8395,6 +9366,52 @@ export interface components {
|
|
|
8395
9366
|
planPricing?: {
|
|
8396
9367
|
[key: string]: unknown;
|
|
8397
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;
|
|
8398
9415
|
};
|
|
8399
9416
|
/** EffectivePlatformFeature */
|
|
8400
9417
|
EffectivePlatformFeature: {
|
|
@@ -8434,9 +9451,10 @@ export interface components {
|
|
|
8434
9451
|
profile?: components["schemas"]["UserProfile"];
|
|
8435
9452
|
/**
|
|
8436
9453
|
* Format: email
|
|
9454
|
+
* @description Primary email of the user. It is `null` when the email is not verified.
|
|
8437
9455
|
* @example bob@example.com
|
|
8438
9456
|
*/
|
|
8439
|
-
email?: string;
|
|
9457
|
+
email?: string | null;
|
|
8440
9458
|
proxy?: components["schemas"]["ProxyResource"];
|
|
8441
9459
|
plan?: components["schemas"]["UserPlan"];
|
|
8442
9460
|
effectivePlatformFeatures?: components["schemas"]["EffectivePlatformFeatures"];
|
|
@@ -8447,6 +9465,11 @@ export interface components {
|
|
|
8447
9465
|
createdAt?: Date;
|
|
8448
9466
|
/** @example true */
|
|
8449
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;
|
|
8450
9473
|
};
|
|
8451
9474
|
/** UserPrivateInfoResponse */
|
|
8452
9475
|
UserPrivateInfoResponse: {
|
|
@@ -8564,6 +9587,8 @@ export interface components {
|
|
|
8564
9587
|
dataRetentionDays: number;
|
|
8565
9588
|
/** @example 100 */
|
|
8566
9589
|
maxScheduleCount?: number;
|
|
9590
|
+
/** @example 1000000 */
|
|
9591
|
+
maxMonthlyUnblockerUnits?: number;
|
|
8567
9592
|
};
|
|
8568
9593
|
/** CurrentUsage */
|
|
8569
9594
|
CurrentUsage: {
|
|
@@ -8589,6 +9614,8 @@ export interface components {
|
|
|
8589
9614
|
teamAccountSeatCount: number;
|
|
8590
9615
|
/** @example 77 */
|
|
8591
9616
|
scheduleCount?: number;
|
|
9617
|
+
/** @example 1520 */
|
|
9618
|
+
monthlyUnblockerUnits?: number;
|
|
8592
9619
|
};
|
|
8593
9620
|
/** AccountLimits */
|
|
8594
9621
|
AccountLimits: {
|
|
@@ -8613,6 +9640,123 @@ export interface components {
|
|
|
8613
9640
|
*/
|
|
8614
9641
|
dataRetentionDays?: number;
|
|
8615
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
|
+
};
|
|
8616
9760
|
BrowserInfoResponse: {
|
|
8617
9761
|
/**
|
|
8618
9762
|
* @description HTTP method of the request.
|
|
@@ -8809,6 +9953,13 @@ export interface components {
|
|
|
8809
9953
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
8810
9954
|
};
|
|
8811
9955
|
};
|
|
9956
|
+
/** @description No content */
|
|
9957
|
+
NoContent: {
|
|
9958
|
+
headers: {
|
|
9959
|
+
[name: string]: unknown;
|
|
9960
|
+
};
|
|
9961
|
+
content?: never;
|
|
9962
|
+
};
|
|
8812
9963
|
/** @description Payment required - the user has exceeded their usage limit, does not have enough credits, or the request lacks authentication and payment credentials. */
|
|
8813
9964
|
PaymentRequired: {
|
|
8814
9965
|
headers: {
|
|
@@ -8843,13 +9994,6 @@ export interface components {
|
|
|
8843
9994
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
8844
9995
|
};
|
|
8845
9996
|
};
|
|
8846
|
-
/** @description No content */
|
|
8847
|
-
NoContent: {
|
|
8848
|
-
headers: {
|
|
8849
|
-
[name: string]: unknown;
|
|
8850
|
-
};
|
|
8851
|
-
content?: never;
|
|
8852
|
-
};
|
|
8853
9997
|
/** @description Conflict - the request could not be completed due to a conflict with the current state of the resource. */
|
|
8854
9998
|
Conflict: {
|
|
8855
9999
|
headers: {
|
|
@@ -8916,6 +10060,13 @@ export interface components {
|
|
|
8916
10060
|
* The value must be a valid ISO 8601 datetime string (UTC).
|
|
8917
10061
|
*/
|
|
8918
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[];
|
|
8919
10070
|
/** @description Optional timeout for the run, in seconds. By default, the run uses the timeout from its configuration. */
|
|
8920
10071
|
timeout: number;
|
|
8921
10072
|
/**
|
|
@@ -8960,6 +10111,13 @@ export interface components {
|
|
|
8960
10111
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
8961
10112
|
*/
|
|
8962
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";
|
|
8963
10121
|
/**
|
|
8964
10122
|
* @description Key of the record from the run's default key-value store to return in the
|
|
8965
10123
|
* response. Defaults to `OUTPUT`. Actors aren't required to store a record
|
|
@@ -9969,6 +11127,35 @@ export interface operations {
|
|
|
9969
11127
|
429: components["responses"]["TooManyRequests"];
|
|
9970
11128
|
};
|
|
9971
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
|
+
};
|
|
9972
11159
|
actor_version_envVars_get: {
|
|
9973
11160
|
parameters: {
|
|
9974
11161
|
query?: never;
|
|
@@ -10288,7 +11475,35 @@ export interface operations {
|
|
|
10288
11475
|
[name: string]: unknown;
|
|
10289
11476
|
};
|
|
10290
11477
|
content: {
|
|
10291
|
-
"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"];
|
|
10292
11507
|
};
|
|
10293
11508
|
};
|
|
10294
11509
|
400: components["responses"]["BadRequest"];
|
|
@@ -10621,6 +11836,13 @@ export interface operations {
|
|
|
10621
11836
|
* The value must be a valid ISO 8601 datetime string (UTC).
|
|
10622
11837
|
*/
|
|
10623
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"];
|
|
10624
11846
|
};
|
|
10625
11847
|
header?: never;
|
|
10626
11848
|
path: {
|
|
@@ -10725,7 +11947,7 @@ export interface operations {
|
|
|
10725
11947
|
* parameter, the Actor uses its configured default permission level. For more information on permissions, see the
|
|
10726
11948
|
* [documentation](https://docs.apify.com/platform/actors/development/permissions).
|
|
10727
11949
|
*/
|
|
10728
|
-
forcePermissionLevel?: "
|
|
11950
|
+
forcePermissionLevel?: components["parameters"]["forcePermissionLevel"];
|
|
10729
11951
|
};
|
|
10730
11952
|
header?: never;
|
|
10731
11953
|
path: {
|
|
@@ -10816,6 +12038,13 @@ export interface operations {
|
|
|
10816
12038
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
10817
12039
|
*/
|
|
10818
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"];
|
|
10819
12048
|
};
|
|
10820
12049
|
header?: never;
|
|
10821
12050
|
path: {
|
|
@@ -10894,6 +12123,13 @@ export interface operations {
|
|
|
10894
12123
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
10895
12124
|
*/
|
|
10896
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"];
|
|
10897
12133
|
};
|
|
10898
12134
|
header?: never;
|
|
10899
12135
|
path: {
|
|
@@ -10977,6 +12213,13 @@ export interface operations {
|
|
|
10977
12213
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
10978
12214
|
*/
|
|
10979
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"];
|
|
10980
12223
|
/** @description Format of the results, possible values are: `json`, `jsonl`, `csv`, `html`, `xlsx`, `xml` and `rss`. The default value is `json`. */
|
|
10981
12224
|
format?: components["parameters"]["format"];
|
|
10982
12225
|
/**
|
|
@@ -11186,7 +12429,14 @@ export interface operations {
|
|
|
11186
12429
|
* the WebhookRepresentation schema. For more information, see
|
|
11187
12430
|
* [Webhooks documentation](https://docs.apify.com/platform/integrations/webhooks).
|
|
11188
12431
|
*/
|
|
11189
|
-
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"];
|
|
11190
12440
|
/** @description Format of the results, possible values are: `json`, `jsonl`, `csv`, `html`, `xlsx`, `xml` and `rss`. The default value is `json`. */
|
|
11191
12441
|
format?: components["parameters"]["format"];
|
|
11192
12442
|
/**
|
|
@@ -14042,6 +15292,8 @@ export interface operations {
|
|
|
14042
15292
|
* by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
|
|
14043
15293
|
*/
|
|
14044
15294
|
maxTotalChargeUsd?: components["parameters"]["maxTotalChargeUsd"];
|
|
15295
|
+
/** @description Determines whether the run will be restarted if it fails. */
|
|
15296
|
+
restartOnError?: components["parameters"]["restartOnError"];
|
|
14045
15297
|
/**
|
|
14046
15298
|
* @description Specifies the Actor build to run. It can be either a build tag or build number.
|
|
14047
15299
|
* By default, the run uses the build from its configuration (typically `latest`).
|
|
@@ -16321,6 +17573,13 @@ export interface operations {
|
|
|
16321
17573
|
* The value must be a valid ISO 8601 datetime string (UTC).
|
|
16322
17574
|
*/
|
|
16323
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"];
|
|
16324
17583
|
};
|
|
16325
17584
|
header?: never;
|
|
16326
17585
|
path?: never;
|
|
@@ -18295,6 +19554,62 @@ export interface operations {
|
|
|
18295
19554
|
429: components["responses"]["TooManyRequests"];
|
|
18296
19555
|
};
|
|
18297
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
|
+
};
|
|
18298
19613
|
keyValueStores_get: {
|
|
18299
19614
|
parameters: {
|
|
18300
19615
|
query?: {
|
|
@@ -20641,6 +21956,35 @@ export interface operations {
|
|
|
20641
21956
|
429: components["responses"]["TooManyRequests"];
|
|
20642
21957
|
};
|
|
20643
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
|
+
};
|
|
20644
21988
|
schedule_log_get: {
|
|
20645
21989
|
parameters: {
|
|
20646
21990
|
query?: never;
|
|
@@ -20728,6 +22072,12 @@ export interface operations {
|
|
|
20728
22072
|
* bypass this safety filtering and include all Actors in the results.
|
|
20729
22073
|
*/
|
|
20730
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;
|
|
20731
22081
|
};
|
|
20732
22082
|
header?: never;
|
|
20733
22083
|
path?: never;
|
|
@@ -20829,7 +22179,7 @@ export interface operations {
|
|
|
20829
22179
|
[name: string]: unknown;
|
|
20830
22180
|
};
|
|
20831
22181
|
content: {
|
|
20832
|
-
"application/json": components["schemas"]["UserPublicInfoResponse"];
|
|
22182
|
+
"application/json": components["schemas"]["UserPublicInfoResponse"] | components["schemas"]["UserPrivateInfoResponse"];
|
|
20833
22183
|
};
|
|
20834
22184
|
};
|
|
20835
22185
|
400: components["responses"]["BadRequest"];
|
|
@@ -20944,6 +22294,197 @@ export interface operations {
|
|
|
20944
22294
|
429: components["responses"]["TooManyRequests"];
|
|
20945
22295
|
};
|
|
20946
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
|
+
};
|
|
20947
22488
|
tools_browser_info_get: {
|
|
20948
22489
|
parameters: {
|
|
20949
22490
|
query?: {
|