apify-client 3.0.0-beta.4 → 3.0.0-beta.41

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.
Files changed (117) hide show
  1. package/README.md +13 -3
  2. package/dist/apify_api_error.d.ts +62 -21
  3. package/dist/apify_api_error.js +96 -23
  4. package/dist/apify_client.d.ts +125 -10
  5. package/dist/apify_client.js +133 -48
  6. package/dist/base/api_client.d.ts +7 -7
  7. package/dist/base/api_client.js +24 -16
  8. package/dist/base/resource_client.d.ts +23 -9
  9. package/dist/base/resource_client.js +57 -29
  10. package/dist/base/resource_collection_client.d.ts +8 -4
  11. package/dist/base/resource_collection_client.js +26 -15
  12. package/dist/body_parser.d.ts +3 -4
  13. package/dist/body_parser.js +19 -26
  14. package/dist/bundle.js +29 -22
  15. package/dist/bundle.js.map +1 -1
  16. package/dist/generated/api.d.ts +887 -322
  17. package/dist/generated/schemas.d.ts +6717 -0
  18. package/dist/generated/schemas.js +1527 -0
  19. package/dist/http_clients/axios.d.ts +60 -0
  20. package/dist/http_clients/axios.js +117 -0
  21. package/dist/http_clients/base.d.ts +333 -0
  22. package/dist/http_clients/base.js +563 -0
  23. package/dist/http_clients/index.d.ts +4 -0
  24. package/dist/http_clients/index.js +2 -0
  25. package/dist/http_compressors/base.d.ts +40 -0
  26. package/dist/http_compressors/base.js +9 -0
  27. package/dist/http_compressors/brotli.d.ts +33 -0
  28. package/dist/http_compressors/brotli.js +39 -0
  29. package/dist/http_compressors/gzip.d.ts +33 -0
  30. package/dist/http_compressors/gzip.js +39 -0
  31. package/dist/http_compressors/index.d.ts +6 -0
  32. package/dist/http_compressors/index.js +2 -0
  33. package/dist/http_compressors/resolve.d.ts +23 -0
  34. package/dist/http_compressors/resolve.js +27 -0
  35. package/dist/index.d.ts +5 -1
  36. package/dist/index.js +4 -1
  37. package/dist/invalid_response_body_error.d.ts +13 -0
  38. package/dist/invalid_response_body_error.js +17 -0
  39. package/dist/lazy_schema.d.ts +8 -0
  40. package/dist/lazy_schema.js +11 -0
  41. package/dist/models.d.ts +33 -61
  42. package/dist/resource_clients/actor.d.ts +52 -31
  43. package/dist/resource_clients/actor.js +81 -58
  44. package/dist/resource_clients/actor_collection.d.ts +9 -5
  45. package/dist/resource_clients/actor_collection.js +12 -3
  46. package/dist/resource_clients/actor_env_var.d.ts +10 -3
  47. package/dist/resource_clients/actor_env_var.js +17 -6
  48. package/dist/resource_clients/actor_env_var_collection.d.ts +14 -18
  49. package/dist/resource_clients/actor_env_var_collection.js +18 -11
  50. package/dist/resource_clients/actor_version.d.ts +18 -3
  51. package/dist/resource_clients/actor_version.js +20 -9
  52. package/dist/resource_clients/actor_version_collection.d.ts +16 -17
  53. package/dist/resource_clients/actor_version_collection.js +20 -11
  54. package/dist/resource_clients/build.d.ts +18 -6
  55. package/dist/resource_clients/build.js +37 -17
  56. package/dist/resource_clients/build_collection.d.ts +3 -1
  57. package/dist/resource_clients/build_collection.js +5 -1
  58. package/dist/resource_clients/dataset.d.ts +49 -31
  59. package/dist/resource_clients/dataset.js +102 -76
  60. package/dist/resource_clients/dataset_collection.d.ts +6 -2
  61. package/dist/resource_clients/dataset_collection.js +14 -2
  62. package/dist/resource_clients/key_value_store.d.ts +58 -16
  63. package/dist/resource_clients/key_value_store.js +80 -41
  64. package/dist/resource_clients/key_value_store_collection.d.ts +6 -2
  65. package/dist/resource_clients/key_value_store_collection.js +14 -2
  66. package/dist/resource_clients/log.d.ts +11 -19
  67. package/dist/resource_clients/log.js +64 -46
  68. package/dist/resource_clients/request_queue.d.ts +56 -26
  69. package/dist/resource_clients/request_queue.js +197 -116
  70. package/dist/resource_clients/request_queue_collection.d.ts +6 -2
  71. package/dist/resource_clients/request_queue_collection.js +10 -3
  72. package/dist/resource_clients/run.d.ts +53 -18
  73. package/dist/resource_clients/run.js +94 -47
  74. package/dist/resource_clients/run_collection.d.ts +3 -1
  75. package/dist/resource_clients/run_collection.js +5 -1
  76. package/dist/resource_clients/schedule.d.ts +16 -7
  77. package/dist/resource_clients/schedule.js +32 -21
  78. package/dist/resource_clients/schedule_collection.d.ts +6 -2
  79. package/dist/resource_clients/schedule_collection.js +10 -3
  80. package/dist/resource_clients/store_collection.d.ts +3 -1
  81. package/dist/resource_clients/store_collection.js +5 -1
  82. package/dist/resource_clients/task.d.ts +28 -10
  83. package/dist/resource_clients/task.js +71 -46
  84. package/dist/resource_clients/task_collection.d.ts +6 -2
  85. package/dist/resource_clients/task_collection.js +10 -3
  86. package/dist/resource_clients/user.d.ts +17 -8
  87. package/dist/resource_clients/user.js +43 -39
  88. package/dist/resource_clients/webhook.d.ts +14 -5
  89. package/dist/resource_clients/webhook.js +31 -22
  90. package/dist/resource_clients/webhook_collection.d.ts +6 -2
  91. package/dist/resource_clients/webhook_collection.js +10 -3
  92. package/dist/resource_clients/webhook_dispatch.d.ts +4 -1
  93. package/dist/resource_clients/webhook_dispatch.js +8 -2
  94. package/dist/resource_clients/webhook_dispatch_collection.d.ts +3 -1
  95. package/dist/resource_clients/webhook_dispatch_collection.js +5 -1
  96. package/dist/response_validation_error.d.ts +26 -0
  97. package/dist/response_validation_error.js +37 -0
  98. package/dist/runtime/node.d.ts +6 -0
  99. package/dist/runtime/node.js +49 -0
  100. package/dist/runtime/types.d.ts +52 -0
  101. package/dist/runtime/types.js +1 -0
  102. package/dist/runtime/web.d.ts +5 -0
  103. package/dist/runtime/web.js +18 -0
  104. package/dist/schemas.d.ts +15 -0
  105. package/dist/schemas.js +15 -0
  106. package/dist/statistics.d.ts +1 -6
  107. package/dist/statistics.js +2 -2
  108. package/dist/timeouts.d.ts +84 -0
  109. package/dist/timeouts.js +37 -0
  110. package/dist/timezones.d.ts +1 -1
  111. package/dist/utils.d.ts +86 -46
  112. package/dist/utils.js +218 -164
  113. package/package.json +32 -29
  114. package/dist/http_client.d.ts +0 -88
  115. package/dist/http_client.js +0 -255
  116. package/dist/interceptors.d.ts +0 -19
  117. package/dist/interceptors.js +0 -105
@@ -2,6 +2,7 @@ import type { ACTOR_PERMISSION_LEVEL } from '@apify/consts';
2
2
  import type { ApiClientSubResourceOptions } from '../base/api_client.js';
3
3
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
4
4
  import type { ActorCollectionListItem } from '../models.js';
5
+ import type { TimeoutOptions } from '../timeouts.js';
5
6
  import type { PaginatedIterator, PaginatedList, PaginationOptions } from '../utils.js';
6
7
  import type { Actor, ActorDefaultRunOptions, ActorExampleRunInput, ActorStandby } from './actor.js';
7
8
  import type { ActorVersion } from './actor_version.js';
@@ -51,6 +52,7 @@ export declare class ActorCollectionClient extends ResourceCollectionClient {
51
52
  * ```
52
53
  *
53
54
  * @param options - Pagination options.
55
+ * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
54
56
  * @returns A paginated iterator of Actors.
55
57
  * @see https://docs.apify.com/api/v2/acts-get
56
58
  */
@@ -59,25 +61,29 @@ export declare class ActorCollectionClient extends ResourceCollectionClient {
59
61
  * Creates a new Actor.
60
62
  *
61
63
  * @param actor - The Actor data.
64
+ * @param options - Request options
65
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
62
66
  * @returns The created Actor object.
63
67
  * @see https://docs.apify.com/api/v2/acts-post
64
68
  */
65
- create(actor: ActorCollectionCreateOptions): Promise<Actor>;
69
+ create(actor: ActorCollectionCreateOptions, options?: TimeoutOptions): Promise<Actor>;
66
70
  }
67
71
  /**
72
+ * Field to order a list of Actors by.
73
+ *
68
74
  * @since Added in 2.12.6
69
75
  */
70
76
  export declare enum ActorListSortBy {
71
77
  CREATED_AT = "createdAt",
72
78
  LAST_RUN_STARTED_AT = "stats.lastRunStartedAt"
73
79
  }
74
- export interface ActorCollectionListOptions extends PaginationOptions {
80
+ export interface ActorCollectionListOptions extends PaginationOptions, TimeoutOptions {
75
81
  my?: boolean;
76
82
  desc?: boolean;
77
83
  /**
78
84
  * @since Added in 2.12.6
79
85
  */
80
- sortBy?: ActorListSortBy;
86
+ sortBy?: `${ActorListSortBy}`;
81
87
  }
82
88
  export type ActorCollectionListResult = PaginatedList<ActorCollectionListItem>;
83
89
  export interface ActorCollectionCreateOptions {
@@ -100,8 +106,6 @@ export interface ActorCollectionCreateOptions {
100
106
  isDeprecated?: boolean;
101
107
  isPublic?: boolean;
102
108
  name?: string;
103
- /** @deprecated Use defaultRunOptions.restartOnError instead */
104
- restartOnError?: boolean;
105
109
  /**
106
110
  * @since Added in 2.8.6
107
111
  */
@@ -1,5 +1,7 @@
1
1
  import { z } from 'zod';
2
2
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
3
+ import * as schemas from '../schemas.js';
4
+ import { timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
3
5
  import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
4
6
  const actorCreateSchema = anyObjectSchema.optional();
5
7
  /**
@@ -52,26 +54,32 @@ export class ActorCollectionClient extends ResourceCollectionClient {
52
54
  * ```
53
55
  *
54
56
  * @param options - Pagination options.
57
+ * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
55
58
  * @returns A paginated iterator of Actors.
56
59
  * @see https://docs.apify.com/api/v2/acts-get
57
60
  */
58
61
  list(options = {}) {
59
62
  const parsed = parseArgument(options, listOptionsSchema, 'ActorCollectionListOptions');
60
- return this._listPaginated(parsed);
63
+ return this.listResourcesPaginated(schemas.ListOfActors(), parsed, 'medium');
61
64
  }
62
65
  /**
63
66
  * Creates a new Actor.
64
67
  *
65
68
  * @param actor - The Actor data.
69
+ * @param options - Request options
70
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
66
71
  * @returns The created Actor object.
67
72
  * @see https://docs.apify.com/api/v2/acts-post
68
73
  */
69
- async create(actor) {
74
+ async create(actor, options = {}) {
70
75
  parseArgument(actor, actorCreateSchema);
71
- return this._create(actor);
76
+ const { timeoutSecs = 'medium', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
77
+ return this.createResource(schemas.Actor(), actor, timeoutSecs, signal);
72
78
  }
73
79
  }
74
80
  /**
81
+ * Field to order a list of Actors by.
82
+ *
75
83
  * @since Added in 2.12.6
76
84
  */
77
85
  export var ActorListSortBy;
@@ -85,4 +93,5 @@ const listOptionsSchema = z.strictObject({
85
93
  ...paginationOptionsShape,
86
94
  desc: z.boolean().optional(),
87
95
  sortBy: z.enum(ActorListSortBy).optional(),
96
+ ...timeoutOptionsShape,
88
97
  });
@@ -1,5 +1,6 @@
1
1
  import type { ApiClientSubResourceOptions } from '../base/api_client.js';
2
2
  import { ResourceClient } from '../base/resource_client.js';
3
+ import type { TimeoutOptions } from '../timeouts.js';
3
4
  import type { ActorEnvironmentVariable } from './actor_version.js';
4
5
  /**
5
6
  * Client for managing a specific Actor environment variable.
@@ -32,22 +33,28 @@ export declare class ActorEnvVarClient extends ResourceClient {
32
33
  /**
33
34
  * Retrieves the environment variable.
34
35
  *
36
+ * @param options - Request options
37
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
35
38
  * @returns The environment variable object, or `undefined` if it does not exist.
36
39
  * @see https://docs.apify.com/api/v2/act-version-env-var-get
37
40
  */
38
- get(): Promise<ActorEnvironmentVariable | undefined>;
41
+ get(options?: TimeoutOptions): Promise<ActorEnvironmentVariable | undefined>;
39
42
  /**
40
43
  * Updates the environment variable.
41
44
  *
42
45
  * @param actorEnvVar - The updated environment variable data.
46
+ * @param options - Request options
47
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
43
48
  * @returns The updated environment variable object.
44
49
  * @see https://docs.apify.com/api/v2/act-version-env-var-put
45
50
  */
46
- update(actorEnvVar: ActorEnvironmentVariable): Promise<ActorEnvironmentVariable>;
51
+ update(actorEnvVar: ActorEnvironmentVariable, options?: TimeoutOptions): Promise<ActorEnvironmentVariable>;
47
52
  /**
48
53
  * Deletes the environment variable.
49
54
  *
55
+ * @param options - Request options
56
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
50
57
  * @see https://docs.apify.com/api/v2/act-version-env-var-delete
51
58
  */
52
- delete(): Promise<void>;
59
+ delete(options?: TimeoutOptions): Promise<void>;
53
60
  }
@@ -1,4 +1,6 @@
1
1
  import { ResourceClient } from '../base/resource_client.js';
2
+ import * as schemas from '../schemas.js';
3
+ import { timeoutOptionsSchema } from '../timeouts.js';
2
4
  import { anyObjectSchema, parseArgument } from '../utils.js';
3
5
  /**
4
6
  * Client for managing a specific Actor environment variable.
@@ -36,29 +38,38 @@ export class ActorEnvVarClient extends ResourceClient {
36
38
  /**
37
39
  * Retrieves the environment variable.
38
40
  *
41
+ * @param options - Request options
42
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
39
43
  * @returns The environment variable object, or `undefined` if it does not exist.
40
44
  * @see https://docs.apify.com/api/v2/act-version-env-var-get
41
45
  */
42
- async get() {
43
- return this._get();
46
+ async get(options = {}) {
47
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
48
+ return this.getResource(schemas.EnvVar(), {}, timeoutSecs, signal);
44
49
  }
45
50
  /**
46
51
  * Updates the environment variable.
47
52
  *
48
53
  * @param actorEnvVar - The updated environment variable data.
54
+ * @param options - Request options
55
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
49
56
  * @returns The updated environment variable object.
50
57
  * @see https://docs.apify.com/api/v2/act-version-env-var-put
51
58
  */
52
- async update(actorEnvVar) {
59
+ async update(actorEnvVar, options = {}) {
53
60
  parseArgument(actorEnvVar, anyObjectSchema);
54
- return this._update(actorEnvVar);
61
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
62
+ return this.updateResource(schemas.EnvVar(), actorEnvVar, timeoutSecs, signal);
55
63
  }
56
64
  /**
57
65
  * Deletes the environment variable.
58
66
  *
67
+ * @param options - Request options
68
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
59
69
  * @see https://docs.apify.com/api/v2/act-version-env-var-delete
60
70
  */
61
- async delete() {
62
- return this._delete();
71
+ async delete(options = {}) {
72
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
73
+ return this.deleteResource(timeoutSecs, signal);
63
74
  }
64
75
  }
@@ -1,6 +1,7 @@
1
1
  import type { ApiClientSubResourceOptions } from '../base/api_client.js';
2
2
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
3
- import type { PaginatedList, PaginationOptions } from '../utils.js';
3
+ import type { TimeoutOptions } from '../timeouts.js';
4
+ import type { PaginatedList } from '../utils.js';
4
5
  import type { ActorEnvironmentVariable } from './actor_version.js';
5
6
  /**
6
7
  * Client for managing the collection of environment variables for an Actor version.
@@ -37,39 +38,34 @@ export declare class ActorEnvVarCollectionClient extends ResourceCollectionClien
37
38
  /**
38
39
  * Lists all environment variables of this Actor version.
39
40
  *
40
- * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
41
- * items in a single API call is limited.
41
+ * The endpoint returns every environment variable in one response, so awaiting the return value (as you would
42
+ * with a Promise) gets the whole list.
42
43
  * ```javascript
43
- * const paginatedList = await client.list();
44
- *```
44
+ * const { items } = await client.list();
45
+ * ```
45
46
  *
46
- * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
47
- * retrieved.
47
+ * Asynchronous iteration is also supported, and yields the environment variables one by one.
48
48
  *
49
49
  * ```javascript
50
50
  * for await (const singleItem of client.list()) {...}
51
51
  * ```
52
52
  *
53
- * @returns A paginated iterator of environment variables.
53
+ * @param options - Request options
54
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
55
+ * @returns The environment variables, awaitable as a whole list or iterable one by one.
54
56
  * @see https://docs.apify.com/api/v2/act-version-env-vars-get
55
57
  */
56
- list(_options?: ActorEnvVarCollectionListOptions): Promise<ActorEnvVarListResult> & AsyncIterable<ActorEnvironmentVariable>;
58
+ list(options?: TimeoutOptions): Promise<ActorEnvVarListResult> & AsyncIterable<ActorEnvironmentVariable>;
57
59
  /**
58
60
  * Creates a new environment variable for this Actor version.
59
61
  *
60
62
  * @param actorEnvVar - The environment variable data.
63
+ * @param options - Request options
64
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
61
65
  * @returns The created environment variable object.
62
66
  * @see https://docs.apify.com/api/v2/act-version-env-vars-post
63
67
  */
64
- create(actorEnvVar: ActorEnvironmentVariable): Promise<ActorEnvironmentVariable>;
65
- }
66
- /**
67
- * @deprecated No options are used in the current API implementation.
68
- * https://github.com/apify/apify-client-js/issues/799
69
- * @since Added in 2.1.0
70
- */
71
- export interface ActorEnvVarCollectionListOptions extends PaginationOptions {
72
- desc?: boolean;
68
+ create(actorEnvVar: ActorEnvironmentVariable, options?: TimeoutOptions): Promise<ActorEnvironmentVariable>;
73
69
  }
74
70
  /**
75
71
  * @since Added in 2.1.0
@@ -1,4 +1,6 @@
1
1
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
2
+ import * as schemas from '../schemas.js';
3
+ import { timeoutOptionsSchema } from '../timeouts.js';
2
4
  import { anyObjectSchema, parseArgument } from '../utils.js';
3
5
  const actorEnvVarSchema = anyObjectSchema.optional();
4
6
  /**
@@ -41,34 +43,39 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient {
41
43
  /**
42
44
  * Lists all environment variables of this Actor version.
43
45
  *
44
- * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
45
- * items in a single API call is limited.
46
+ * The endpoint returns every environment variable in one response, so awaiting the return value (as you would
47
+ * with a Promise) gets the whole list.
46
48
  * ```javascript
47
- * const paginatedList = await client.list();
48
- *```
49
+ * const { items } = await client.list();
50
+ * ```
49
51
  *
50
- * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
51
- * retrieved.
52
+ * Asynchronous iteration is also supported, and yields the environment variables one by one.
52
53
  *
53
54
  * ```javascript
54
55
  * for await (const singleItem of client.list()) {...}
55
56
  * ```
56
57
  *
57
- * @returns A paginated iterator of environment variables.
58
+ * @param options - Request options
59
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
60
+ * @returns The environment variables, awaitable as a whole list or iterable one by one.
58
61
  * @see https://docs.apify.com/api/v2/act-version-env-vars-get
59
62
  */
60
- list(_options = {}) {
61
- return this._listPaginated();
63
+ list(options = {}) {
64
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
65
+ return this.listResourcesPaginated(schemas.ListOfEnvVars(), { signal }, timeoutSecs);
62
66
  }
63
67
  /**
64
68
  * Creates a new environment variable for this Actor version.
65
69
  *
66
70
  * @param actorEnvVar - The environment variable data.
71
+ * @param options - Request options
72
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
67
73
  * @returns The created environment variable object.
68
74
  * @see https://docs.apify.com/api/v2/act-version-env-vars-post
69
75
  */
70
- async create(actorEnvVar) {
76
+ async create(actorEnvVar, options = {}) {
71
77
  parseArgument(actorEnvVar, actorEnvVarSchema);
72
- return this._create(actorEnvVar);
78
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
79
+ return this.createResource(schemas.EnvVar(), actorEnvVar, timeoutSecs, signal);
73
80
  }
74
81
  }
@@ -1,6 +1,7 @@
1
1
  import type { ApiClientSubResourceOptions } from '../base/api_client.js';
2
2
  import { ResourceClient } from '../base/resource_client.js';
3
3
  import type { ActorVersion, FinalActorVersion } from '../models.js';
4
+ import type { TimeoutOptions } from '../timeouts.js';
4
5
  import { ActorEnvVarClient } from './actor_env_var.js';
5
6
  import { ActorEnvVarCollectionClient } from './actor_env_var_collection.js';
6
7
  export type { ActorEnvironmentVariable, ActorVersion, ActorVersionGitHubGist, ActorVersionGitRepo, ActorVersionSourceCode, ActorVersionSourceFile, ActorVersionSourceFiles, ActorVersionSourceFolder, ActorVersionTarball, BaseActorVersion, FinalActorVersion, } from '../models.js';
@@ -34,24 +35,30 @@ export declare class ActorVersionClient extends ResourceClient {
34
35
  /**
35
36
  * Retrieves the Actor version.
36
37
  *
38
+ * @param options - Request options
39
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
37
40
  * @returns The Actor version object, or `undefined` if it does not exist.
38
41
  * @see https://docs.apify.com/api/v2/act-version-get
39
42
  */
40
- get(): Promise<FinalActorVersion | undefined>;
43
+ get(options?: TimeoutOptions): Promise<FinalActorVersion | undefined>;
41
44
  /**
42
45
  * Updates the Actor version with the specified fields.
43
46
  *
44
47
  * @param newFields - Fields to update.
48
+ * @param options - Request options
49
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
45
50
  * @returns The updated Actor version object.
46
51
  * @see https://docs.apify.com/api/v2/act-version-put
47
52
  */
48
- update(newFields: ActorVersion): Promise<FinalActorVersion>;
53
+ update(newFields: ActorVersionUpdateData, options?: TimeoutOptions): Promise<FinalActorVersion>;
49
54
  /**
50
55
  * Deletes the Actor version.
51
56
  *
57
+ * @param options - Request options
58
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
52
59
  * @see https://docs.apify.com/api/v2/act-version-delete
53
60
  */
54
- delete(): Promise<void>;
61
+ delete(options?: TimeoutOptions): Promise<void>;
55
62
  /**
56
63
  * Returns a client for the specified environment variable of this Actor version.
57
64
  *
@@ -70,3 +77,11 @@ export declare class ActorVersionClient extends ResourceClient {
70
77
  */
71
78
  envVars(): ActorEnvVarCollectionClient;
72
79
  }
80
+ /**
81
+ * Fields that can be changed on an existing Actor version.
82
+ *
83
+ * All of them are optional, because the endpoint leaves untouched whatever the payload does not
84
+ * mention. The version union enforces the pairing: a `sourceType` can only be sent next to the
85
+ * source location it implies, never next to one of the other three.
86
+ */
87
+ export type ActorVersionUpdateData = Partial<ActorVersion>;
@@ -1,9 +1,11 @@
1
1
  import { z } from 'zod';
2
2
  import { ResourceClient } from '../base/resource_client.js';
3
+ import * as schemas from '../schemas.js';
4
+ import { timeoutOptionsSchema } from '../timeouts.js';
3
5
  import { anyObjectSchema, parseArgument } from '../utils.js';
4
6
  import { ActorEnvVarClient } from './actor_env_var.js';
5
7
  import { ActorEnvVarCollectionClient } from './actor_env_var_collection.js';
6
- const envVarNameSchema = z.string();
8
+ const envVarNameSchema = z.string().min(1);
7
9
  export { ActorSourceType } from '../models.js';
8
10
  /**
9
11
  * Client for managing a specific Actor version.
@@ -39,30 +41,39 @@ export class ActorVersionClient extends ResourceClient {
39
41
  /**
40
42
  * Retrieves the Actor version.
41
43
  *
44
+ * @param options - Request options
45
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
42
46
  * @returns The Actor version object, or `undefined` if it does not exist.
43
47
  * @see https://docs.apify.com/api/v2/act-version-get
44
48
  */
45
- async get() {
46
- return this._get();
49
+ async get(options = {}) {
50
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
51
+ return this.getResource(schemas.Version(), {}, timeoutSecs, signal);
47
52
  }
48
53
  /**
49
54
  * Updates the Actor version with the specified fields.
50
55
  *
51
56
  * @param newFields - Fields to update.
57
+ * @param options - Request options
58
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
52
59
  * @returns The updated Actor version object.
53
60
  * @see https://docs.apify.com/api/v2/act-version-put
54
61
  */
55
- async update(newFields) {
62
+ async update(newFields, options = {}) {
56
63
  parseArgument(newFields, anyObjectSchema);
57
- return this._update(newFields);
64
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
65
+ return this.updateResource(schemas.Version(), newFields, timeoutSecs, signal);
58
66
  }
59
67
  /**
60
68
  * Deletes the Actor version.
61
69
  *
70
+ * @param options - Request options
71
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
62
72
  * @see https://docs.apify.com/api/v2/act-version-delete
63
73
  */
64
- async delete() {
65
- return this._delete();
74
+ async delete(options = {}) {
75
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
76
+ return this.deleteResource(timeoutSecs, signal);
66
77
  }
67
78
  /**
68
79
  * Returns a client for the specified environment variable of this Actor version.
@@ -74,7 +85,7 @@ export class ActorVersionClient extends ResourceClient {
74
85
  */
75
86
  envVar(envVarName) {
76
87
  parseArgument(envVarName, envVarNameSchema);
77
- return new ActorEnvVarClient(this._subResourceOptions({
88
+ return new ActorEnvVarClient(this.subResourceOptions({
78
89
  id: envVarName,
79
90
  }));
80
91
  }
@@ -86,6 +97,6 @@ export class ActorVersionClient extends ResourceClient {
86
97
  * @since Added in 2.1.0
87
98
  */
88
99
  envVars() {
89
- return new ActorEnvVarCollectionClient(this._subResourceOptions());
100
+ return new ActorEnvVarCollectionClient(this.subResourceOptions());
90
101
  }
91
102
  }
@@ -1,6 +1,7 @@
1
1
  import type { ApiClientSubResourceOptions } from '../base/api_client.js';
2
2
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
3
- import type { PaginatedList, PaginationOptions } from '../utils.js';
3
+ import type { TimeoutOptions } from '../timeouts.js';
4
+ import type { PaginatedList } from '../utils.js';
4
5
  import type { ActorVersion, FinalActorVersion } from './actor_version.js';
5
6
  /**
6
7
  * Client for managing the collection of Actor versions.
@@ -20,6 +21,8 @@ import type { ActorVersion, FinalActorVersion } from './actor_version.js';
20
21
  * // Create a new version
21
22
  * const newVersion = await versionsClient.create({
22
23
  * versionNumber: '0.2',
24
+ * sourceType: 'GIT_REPO',
25
+ * gitRepoUrl: 'https://github.com/my-account/my-actor',
23
26
  * buildTag: 'latest'
24
27
  * });
25
28
  * ```
@@ -34,37 +37,33 @@ export declare class ActorVersionCollectionClient extends ResourceCollectionClie
34
37
  /**
35
38
  * Lists all Actor versions.
36
39
  *
37
- * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
38
- * items in a single API call is limited.
40
+ * The endpoint returns every version in one response, so awaiting the return value (as you would with a Promise)
41
+ * gets the whole list.
39
42
  * ```javascript
40
- * const paginatedList = await client.list();
41
- *```
43
+ * const { items } = await client.list();
44
+ * ```
42
45
  *
43
- * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
44
- * retrieved.
46
+ * Asynchronous iteration is also supported, and yields the versions one by one.
45
47
  *
46
48
  * ```javascript
47
49
  * for await (const singleItem of client.list()) {...}
48
50
  * ```
49
51
  *
50
- * @returns A paginated iterator of Actor versions.
52
+ * @param options - Request options
53
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
54
+ * @returns The Actor versions, awaitable as a whole list or iterable one by one.
51
55
  * @see https://docs.apify.com/api/v2/act-versions-get
52
56
  */
53
- list(_options?: ActorVersionCollectionListOptions): Promise<ActorVersionListResult> & AsyncIterable<FinalActorVersion>;
57
+ list(options?: TimeoutOptions): Promise<ActorVersionListResult> & AsyncIterable<FinalActorVersion>;
54
58
  /**
55
59
  * Creates a new Actor version.
56
60
  *
57
61
  * @param actorVersion - The Actor version data.
62
+ * @param options - Request options
63
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
58
64
  * @returns The created Actor version object.
59
65
  * @see https://docs.apify.com/api/v2/act-versions-post
60
66
  */
61
- create(actorVersion: ActorVersion): Promise<FinalActorVersion>;
62
- }
63
- /**
64
- * @deprecated No options are used in the current API implementation.
65
- * https://github.com/apify/apify-client-js/issues/799
66
- */
67
- export interface ActorVersionCollectionListOptions extends PaginationOptions {
68
- desc?: boolean;
67
+ create(actorVersion: ActorVersion, options?: TimeoutOptions): Promise<FinalActorVersion>;
69
68
  }
70
69
  export type ActorVersionListResult = Pick<PaginatedList<FinalActorVersion>, 'total' | 'items'>;
@@ -1,4 +1,6 @@
1
1
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
2
+ import * as schemas from '../schemas.js';
3
+ import { timeoutOptionsSchema } from '../timeouts.js';
2
4
  import { anyObjectSchema, parseArgument } from '../utils.js';
3
5
  const actorVersionSchema = anyObjectSchema.optional();
4
6
  /**
@@ -19,6 +21,8 @@ const actorVersionSchema = anyObjectSchema.optional();
19
21
  * // Create a new version
20
22
  * const newVersion = await versionsClient.create({
21
23
  * versionNumber: '0.2',
24
+ * sourceType: 'GIT_REPO',
25
+ * gitRepoUrl: 'https://github.com/my-account/my-actor',
22
26
  * buildTag: 'latest'
23
27
  * });
24
28
  * ```
@@ -38,34 +42,39 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient {
38
42
  /**
39
43
  * Lists all Actor versions.
40
44
  *
41
- * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
42
- * items in a single API call is limited.
45
+ * The endpoint returns every version in one response, so awaiting the return value (as you would with a Promise)
46
+ * gets the whole list.
43
47
  * ```javascript
44
- * const paginatedList = await client.list();
45
- *```
48
+ * const { items } = await client.list();
49
+ * ```
46
50
  *
47
- * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
48
- * retrieved.
51
+ * Asynchronous iteration is also supported, and yields the versions one by one.
49
52
  *
50
53
  * ```javascript
51
54
  * for await (const singleItem of client.list()) {...}
52
55
  * ```
53
56
  *
54
- * @returns A paginated iterator of Actor versions.
57
+ * @param options - Request options
58
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
59
+ * @returns The Actor versions, awaitable as a whole list or iterable one by one.
55
60
  * @see https://docs.apify.com/api/v2/act-versions-get
56
61
  */
57
- list(_options = {}) {
58
- return this._listPaginated();
62
+ list(options = {}) {
63
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
64
+ return this.listResourcesPaginated(schemas.ListOfVersions(), { signal }, timeoutSecs);
59
65
  }
60
66
  /**
61
67
  * Creates a new Actor version.
62
68
  *
63
69
  * @param actorVersion - The Actor version data.
70
+ * @param options - Request options
71
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
64
72
  * @returns The created Actor version object.
65
73
  * @see https://docs.apify.com/api/v2/act-versions-post
66
74
  */
67
- async create(actorVersion) {
75
+ async create(actorVersion, options = {}) {
68
76
  parseArgument(actorVersion, actorVersionSchema);
69
- return this._create(actorVersion);
77
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
78
+ return this.createResource(schemas.Version(), actorVersion, timeoutSecs, signal);
70
79
  }
71
80
  }