apify-client 3.0.0-beta.5 → 3.0.0-beta.51

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 (115) 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 +36 -24
  8. package/dist/base/resource_client.d.ts +21 -8
  9. package/dist/base/resource_client.js +54 -26
  10. package/dist/base/resource_collection_client.d.ts +12 -4
  11. package/dist/base/resource_collection_client.js +34 -11
  12. package/dist/body_parser.d.ts +3 -4
  13. package/dist/body_parser.js +19 -26
  14. package/dist/bundle.js +27 -22
  15. package/dist/bundle.js.map +1 -1
  16. package/dist/generated/api.d.ts +610 -112
  17. package/dist/generated/schemas.d.ts +726 -703
  18. package/dist/generated/schemas.js +92 -85
  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 +4 -1
  36. package/dist/index.js +3 -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/models.d.ts +19 -22
  40. package/dist/resource_clients/actor.d.ts +72 -32
  41. package/dist/resource_clients/actor.js +87 -56
  42. package/dist/resource_clients/actor_collection.d.ts +9 -5
  43. package/dist/resource_clients/actor_collection.js +11 -3
  44. package/dist/resource_clients/actor_env_var.d.ts +10 -3
  45. package/dist/resource_clients/actor_env_var.js +16 -6
  46. package/dist/resource_clients/actor_env_var_collection.d.ts +14 -18
  47. package/dist/resource_clients/actor_env_var_collection.js +17 -11
  48. package/dist/resource_clients/actor_version.d.ts +18 -3
  49. package/dist/resource_clients/actor_version.js +19 -9
  50. package/dist/resource_clients/actor_version_collection.d.ts +16 -17
  51. package/dist/resource_clients/actor_version_collection.js +19 -11
  52. package/dist/resource_clients/build.d.ts +18 -6
  53. package/dist/resource_clients/build.js +34 -15
  54. package/dist/resource_clients/build_collection.d.ts +3 -1
  55. package/dist/resource_clients/build_collection.js +4 -1
  56. package/dist/resource_clients/dataset.d.ts +51 -33
  57. package/dist/resource_clients/dataset.js +105 -80
  58. package/dist/resource_clients/dataset_collection.d.ts +6 -2
  59. package/dist/resource_clients/dataset_collection.js +13 -2
  60. package/dist/resource_clients/key_value_store.d.ts +58 -16
  61. package/dist/resource_clients/key_value_store.js +78 -40
  62. package/dist/resource_clients/key_value_store_collection.d.ts +6 -2
  63. package/dist/resource_clients/key_value_store_collection.js +13 -2
  64. package/dist/resource_clients/log.d.ts +12 -20
  65. package/dist/resource_clients/log.js +93 -58
  66. package/dist/resource_clients/request_queue.d.ts +56 -26
  67. package/dist/resource_clients/request_queue.js +176 -103
  68. package/dist/resource_clients/request_queue_collection.d.ts +6 -2
  69. package/dist/resource_clients/request_queue_collection.js +9 -3
  70. package/dist/resource_clients/run.d.ts +108 -18
  71. package/dist/resource_clients/run.js +183 -43
  72. package/dist/resource_clients/run_collection.d.ts +3 -1
  73. package/dist/resource_clients/run_collection.js +4 -1
  74. package/dist/resource_clients/schedule.d.ts +14 -5
  75. package/dist/resource_clients/schedule.js +29 -21
  76. package/dist/resource_clients/schedule_collection.d.ts +6 -2
  77. package/dist/resource_clients/schedule_collection.js +9 -3
  78. package/dist/resource_clients/store_collection.d.ts +3 -1
  79. package/dist/resource_clients/store_collection.js +4 -1
  80. package/dist/resource_clients/task.d.ts +33 -10
  81. package/dist/resource_clients/task.js +79 -46
  82. package/dist/resource_clients/task_collection.d.ts +6 -2
  83. package/dist/resource_clients/task_collection.js +9 -3
  84. package/dist/resource_clients/user.d.ts +17 -8
  85. package/dist/resource_clients/user.js +42 -38
  86. package/dist/resource_clients/webhook.d.ts +14 -5
  87. package/dist/resource_clients/webhook.js +30 -22
  88. package/dist/resource_clients/webhook_collection.d.ts +6 -2
  89. package/dist/resource_clients/webhook_collection.js +9 -3
  90. package/dist/resource_clients/webhook_dispatch.d.ts +4 -1
  91. package/dist/resource_clients/webhook_dispatch.js +7 -2
  92. package/dist/resource_clients/webhook_dispatch_collection.d.ts +3 -1
  93. package/dist/resource_clients/webhook_dispatch_collection.js +4 -1
  94. package/dist/runtime/node.d.ts +6 -0
  95. package/dist/runtime/node.js +49 -0
  96. package/dist/runtime/types.d.ts +52 -0
  97. package/dist/runtime/types.js +1 -0
  98. package/dist/runtime/web.d.ts +5 -0
  99. package/dist/runtime/web.js +18 -0
  100. package/dist/schemas.d.ts +1 -1
  101. package/dist/schemas.js +1 -1
  102. package/dist/statistics.d.ts +1 -6
  103. package/dist/statistics.js +2 -2
  104. package/dist/timeouts.d.ts +84 -0
  105. package/dist/timeouts.js +37 -0
  106. package/dist/timezones.d.ts +1 -1
  107. package/dist/utils.d.ts +81 -52
  108. package/dist/utils.js +201 -170
  109. package/dist/wait_for_resources.d.ts +8 -0
  110. package/dist/wait_for_resources.js +39 -0
  111. package/package.json +32 -29
  112. package/dist/http_client.d.ts +0 -88
  113. package/dist/http_client.js +0 -255
  114. package/dist/interceptors.d.ts +0 -19
  115. package/dist/interceptors.js +0 -105
@@ -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
3
  import type { TaskList } from '../models.js';
4
+ import type { TimeoutOptions } from '../timeouts.js';
4
5
  import type { PaginatedIterator, PaginationOptions } from '../utils.js';
5
6
  import type { Task, TaskUpdateData } from './task.js';
6
7
  export type { TaskList } from '../models.js';
@@ -50,6 +51,7 @@ export declare class TaskCollectionClient extends ResourceCollectionClient {
50
51
  * ```
51
52
  *
52
53
  * @param options - Pagination and sorting options.
54
+ * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
53
55
  * @returns A paginated iterator of tasks.
54
56
  * @see https://docs.apify.com/api/v2/actor-tasks-get
55
57
  */
@@ -58,12 +60,14 @@ export declare class TaskCollectionClient extends ResourceCollectionClient {
58
60
  * Creates a new task.
59
61
  *
60
62
  * @param task - The task data.
63
+ * @param options - Request options
64
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
61
65
  * @returns The created task object.
62
66
  * @see https://docs.apify.com/api/v2/actor-tasks-post
63
67
  */
64
- create(task: TaskCreateData): Promise<Task>;
68
+ create(task: TaskCreateData, options?: TimeoutOptions): Promise<Task>;
65
69
  }
66
- export interface TaskCollectionListOptions extends PaginationOptions {
70
+ export interface TaskCollectionListOptions extends PaginationOptions, TimeoutOptions {
67
71
  desc?: boolean;
68
72
  }
69
73
  /**
@@ -1,10 +1,12 @@
1
1
  import { z } from 'zod';
2
2
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
3
3
  import * as schemas from '../schemas.js';
4
+ import { timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
4
5
  import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
5
6
  const listOptionsSchema = z.strictObject({
6
7
  ...paginationOptionsShape,
7
8
  desc: z.boolean().optional(),
9
+ ...timeoutOptionsShape,
8
10
  });
9
11
  /**
10
12
  * Client for managing the collection of Actor tasks in your account.
@@ -57,22 +59,26 @@ export class TaskCollectionClient extends ResourceCollectionClient {
57
59
  * ```
58
60
  *
59
61
  * @param options - Pagination and sorting options.
62
+ * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
60
63
  * @returns A paginated iterator of tasks.
61
64
  * @see https://docs.apify.com/api/v2/actor-tasks-get
62
65
  */
63
66
  list(options = {}) {
64
67
  const parsed = parseArgument(options, listOptionsSchema, 'TaskCollectionListOptions');
65
- return this._listPaginated(schemas.ListOfTasks(), parsed);
68
+ return this.listResourcesPaginated(schemas.ListOfTasks(), parsed, 'medium');
66
69
  }
67
70
  /**
68
71
  * Creates a new task.
69
72
  *
70
73
  * @param task - The task data.
74
+ * @param options - Request options
75
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
71
76
  * @returns The created task object.
72
77
  * @see https://docs.apify.com/api/v2/actor-tasks-post
73
78
  */
74
- async create(task) {
79
+ async create(task, options = {}) {
75
80
  parseArgument(task, anyObjectSchema);
76
- return this._create(schemas.Task(), task);
81
+ const { timeoutSecs = 'medium', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
82
+ return this.createResource(schemas.Task(), task, timeoutSecs, signal);
77
83
  }
78
84
  }
@@ -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 { AccountAndUsageLimits, MonthlyUsage, User } from '../models.js';
4
+ import type { TimeoutOptions } from '../timeouts.js';
4
5
  export type { AccountAndUsageLimits, Current, DailyServiceUsage, EffectivePlatformFeature, EffectivePlatformFeatures, Limits, MonthlyUsage, MonthlyUsageCycle, PriceTier, ProxyGroup, ServiceUsage, UsageCycle, UsageItem, User, UserPlan, UserProfile, UserProxy, } from '../models.js';
5
6
  export { PlatformFeature } from '../models.js';
6
7
  /**
@@ -38,34 +39,42 @@ export declare class UserClient extends ResourceClient {
38
39
  * Depending on whether ApifyClient was created with a token,
39
40
  * the method will either return public or private user data.
40
41
  *
41
- * @returns The user object.
42
+ * @param options - Request options
43
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
44
+ * @returns The user object, or `undefined` if it does not exist.
42
45
  * @see https://docs.apify.com/api/v2/user-get
43
46
  */
44
- get(): Promise<User>;
47
+ get(options?: TimeoutOptions): Promise<User | undefined>;
45
48
  /**
46
49
  * Retrieves the user's monthly usage data.
47
50
  *
48
- * @returns The monthly usage object, or `undefined` if it does not exist.
51
+ * @param options - Request options
52
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
53
+ * @returns The monthly usage object.
49
54
  * @see https://docs.apify.com/api/v2/users-me-usage-monthly-get
50
55
  * @since Added in 2.9.2
51
56
  */
52
- monthlyUsage(): Promise<MonthlyUsage | undefined>;
57
+ monthlyUsage(options?: TimeoutOptions): Promise<MonthlyUsage>;
53
58
  /**
54
59
  * Retrieves the user's account and usage limits.
55
60
  *
56
- * @returns The account and usage limits object, or `undefined` if it does not exist.
61
+ * @param options - Request options
62
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
63
+ * @returns The account and usage limits object.
57
64
  * @see https://docs.apify.com/api/v2/users-me-limits-get
58
65
  * @since Added in 2.9.2
59
66
  */
60
- limits(): Promise<AccountAndUsageLimits | undefined>;
67
+ limits(options?: TimeoutOptions): Promise<AccountAndUsageLimits>;
61
68
  /**
62
69
  * Updates the user's account and usage limits.
63
70
  *
64
- * @param options - The new limits to set.
71
+ * @param newLimits - The new limits to set.
72
+ * @param options - Request options
73
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
65
74
  * @see https://docs.apify.com/api/v2/users-me-limits-put
66
75
  * @since Added in 2.10.0
67
76
  */
68
- updateLimits(options: LimitsUpdateOptions): Promise<void>;
77
+ updateLimits(newLimits: LimitsUpdateOptions, options?: TimeoutOptions): Promise<void>;
69
78
  }
70
79
  /**
71
80
  * @since Added in 2.10.0
@@ -1,6 +1,7 @@
1
1
  import { ResourceClient } from '../base/resource_client.js';
2
2
  import * as schemas from '../schemas.js';
3
- import { catchNotFoundOrThrow, parseResponse } from '../utils.js';
3
+ import { timeoutOptionsSchema } from '../timeouts.js';
4
+ import { parseArgument, parseResponse } from '../utils.js';
4
5
  export { PlatformFeature } from '../models.js';
5
6
  /**
6
7
  * Client for managing user account information.
@@ -42,70 +43,73 @@ export class UserClient extends ResourceClient {
42
43
  * Depending on whether ApifyClient was created with a token,
43
44
  * the method will either return public or private user data.
44
45
  *
45
- * @returns The user object.
46
+ * @param options - Request options
47
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
48
+ * @returns The user object, or `undefined` if it does not exist.
46
49
  * @see https://docs.apify.com/api/v2/user-get
47
50
  */
48
- async get() {
49
- return this._get(schemas.UserPrivateInfo());
51
+ async get(options = {}) {
52
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
53
+ return this.getResource(schemas.UserPrivateInfo(), {}, timeoutSecs, signal);
50
54
  }
51
55
  /**
52
56
  * Retrieves the user's monthly usage data.
53
57
  *
54
- * @returns The monthly usage object, or `undefined` if it does not exist.
58
+ * @param options - Request options
59
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
60
+ * @returns The monthly usage object.
55
61
  * @see https://docs.apify.com/api/v2/users-me-usage-monthly-get
56
62
  * @since Added in 2.9.2
57
63
  */
58
- async monthlyUsage() {
59
- const requestOpts = {
60
- url: this._url('usage/monthly'),
64
+ async monthlyUsage(options = {}) {
65
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
66
+ const response = await this.httpClient.call({
67
+ url: this.buildUrl('usage/monthly'),
61
68
  method: 'GET',
62
- params: this._params(),
63
- };
64
- try {
65
- const response = await this.httpClient.call(requestOpts);
66
- // `dailyServiceUsages[].date` does not end in `At`, so it has to be named for `parseDateFields`.
67
- return parseResponse(response, schemas.MonthlyUsage(), (key) => key === 'date');
68
- }
69
- catch (err) {
70
- catchNotFoundOrThrow(err);
71
- }
72
- return undefined;
69
+ params: this.buildParams(),
70
+ timeoutSecs,
71
+ signal,
72
+ });
73
+ return parseResponse(response, schemas.MonthlyUsage());
73
74
  }
74
75
  /**
75
76
  * Retrieves the user's account and usage limits.
76
77
  *
77
- * @returns The account and usage limits object, or `undefined` if it does not exist.
78
+ * @param options - Request options
79
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
80
+ * @returns The account and usage limits object.
78
81
  * @see https://docs.apify.com/api/v2/users-me-limits-get
79
82
  * @since Added in 2.9.2
80
83
  */
81
- async limits() {
82
- const requestOpts = {
83
- url: this._url('limits'),
84
+ async limits(options = {}) {
85
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
86
+ const response = await this.httpClient.call({
87
+ url: this.buildUrl('limits'),
84
88
  method: 'GET',
85
- params: this._params(),
86
- };
87
- try {
88
- const response = await this.httpClient.call(requestOpts);
89
- return parseResponse(response, schemas.AccountLimits());
90
- }
91
- catch (err) {
92
- catchNotFoundOrThrow(err);
93
- }
94
- return undefined;
89
+ params: this.buildParams(),
90
+ timeoutSecs,
91
+ signal,
92
+ });
93
+ return parseResponse(response, schemas.AccountLimits());
95
94
  }
96
95
  /**
97
96
  * Updates the user's account and usage limits.
98
97
  *
99
- * @param options - The new limits to set.
98
+ * @param newLimits - The new limits to set.
99
+ * @param options - Request options
100
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
100
101
  * @see https://docs.apify.com/api/v2/users-me-limits-put
101
102
  * @since Added in 2.10.0
102
103
  */
103
- async updateLimits(options) {
104
+ async updateLimits(newLimits, options = {}) {
105
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
104
106
  const requestOpts = {
105
- url: this._url('limits'),
107
+ url: this.buildUrl('limits'),
106
108
  method: 'PUT',
107
- params: this._params(),
108
- data: options,
109
+ params: this.buildParams(),
110
+ data: newLimits,
111
+ timeoutSecs,
112
+ signal,
109
113
  };
110
114
  await this.httpClient.call(requestOpts);
111
115
  }
@@ -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 { Webhook, WebhookEventType } from '../models.js';
4
+ import type { TimeoutOptions } from '../timeouts.js';
4
5
  import type { WebhookDispatch } from './webhook_dispatch.js';
5
6
  import { WebhookDispatchCollectionClient } from './webhook_dispatch_collection.js';
6
7
  export type { Webhook, WebhookAnyRunOfActorCondition, WebhookAnyRunOfActorTaskCondition, WebhookCertainRunCondition, WebhookCondition, WebhookEventType, WebhookLastDispatch, WebhookStats, } from '../models.js';
@@ -40,31 +41,39 @@ export declare class WebhookClient extends ResourceClient {
40
41
  /**
41
42
  * Retrieves the webhook.
42
43
  *
44
+ * @param options - Request options
45
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
43
46
  * @returns The webhook object, or `undefined` if it does not exist.
44
47
  * @see https://docs.apify.com/api/v2/webhook-get
45
48
  */
46
- get(): Promise<Webhook | undefined>;
49
+ get(options?: TimeoutOptions): Promise<Webhook | undefined>;
47
50
  /**
48
51
  * Updates the webhook with the specified fields.
49
52
  *
50
53
  * @param newFields - Fields to update.
54
+ * @param options - Request options
55
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
51
56
  * @returns The updated webhook object.
52
57
  * @see https://docs.apify.com/api/v2/webhook-put
53
58
  */
54
- update(newFields: WebhookUpdateData): Promise<Webhook>;
59
+ update(newFields: WebhookUpdateData, options?: TimeoutOptions): Promise<Webhook>;
55
60
  /**
56
61
  * Deletes the webhook.
57
62
  *
63
+ * @param options - Request options
64
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
58
65
  * @see https://docs.apify.com/api/v2/webhook-delete
59
66
  */
60
- delete(): Promise<void>;
67
+ delete(options?: TimeoutOptions): Promise<void>;
61
68
  /**
62
69
  * Tests the webhook by dispatching a test event.
63
70
  *
64
- * @returns The webhook dispatch object, or `undefined` if the test fails.
71
+ * @param options - Request options
72
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
73
+ * @returns The webhook dispatch object.
65
74
  * @see https://docs.apify.com/api/v2/webhook-test-post
66
75
  */
67
- test(): Promise<WebhookDispatch | undefined>;
76
+ test(options?: TimeoutOptions): Promise<WebhookDispatch>;
68
77
  /**
69
78
  * Returns a client for the dispatches of this webhook.
70
79
  *
@@ -1,6 +1,7 @@
1
1
  import { ResourceClient } from '../base/resource_client.js';
2
2
  import * as schemas from '../schemas.js';
3
- import { anyObjectSchema, catchNotFoundOrThrow, parseArgument, parseResponse } from '../utils.js';
3
+ import { timeoutOptionsSchema } from '../timeouts.js';
4
+ import { anyObjectSchema, parseArgument, parseResponse } from '../utils.js';
4
5
  import { WebhookDispatchCollectionClient } from './webhook_dispatch_collection.js';
5
6
  /**
6
7
  * Client for managing a specific webhook.
@@ -43,51 +44,58 @@ export class WebhookClient extends ResourceClient {
43
44
  /**
44
45
  * Retrieves the webhook.
45
46
  *
47
+ * @param options - Request options
48
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
46
49
  * @returns The webhook object, or `undefined` if it does not exist.
47
50
  * @see https://docs.apify.com/api/v2/webhook-get
48
51
  */
49
- async get() {
50
- return this._get(schemas.Webhook());
52
+ async get(options = {}) {
53
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
54
+ return this.getResource(schemas.Webhook(), {}, timeoutSecs, signal);
51
55
  }
52
56
  /**
53
57
  * Updates the webhook with the specified fields.
54
58
  *
55
59
  * @param newFields - Fields to update.
60
+ * @param options - Request options
61
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
56
62
  * @returns The updated webhook object.
57
63
  * @see https://docs.apify.com/api/v2/webhook-put
58
64
  */
59
- async update(newFields) {
65
+ async update(newFields, options = {}) {
60
66
  parseArgument(newFields, anyObjectSchema);
61
- return this._update(schemas.Webhook(), newFields);
67
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
68
+ return this.updateResource(schemas.Webhook(), newFields, timeoutSecs, signal);
62
69
  }
63
70
  /**
64
71
  * Deletes the webhook.
65
72
  *
73
+ * @param options - Request options
74
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
66
75
  * @see https://docs.apify.com/api/v2/webhook-delete
67
76
  */
68
- async delete() {
69
- return this._delete();
77
+ async delete(options = {}) {
78
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
79
+ return this.deleteResource(timeoutSecs, signal);
70
80
  }
71
81
  /**
72
82
  * Tests the webhook by dispatching a test event.
73
83
  *
74
- * @returns The webhook dispatch object, or `undefined` if the test fails.
84
+ * @param options - Request options
85
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'medium'`.
86
+ * @returns The webhook dispatch object.
75
87
  * @see https://docs.apify.com/api/v2/webhook-test-post
76
88
  */
77
- async test() {
78
- const request = {
79
- url: this._url('test'),
89
+ async test(options = {}) {
90
+ const { timeoutSecs = 'medium', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
91
+ const response = await this.httpClient.call({
92
+ url: this.buildUrl('test'),
80
93
  method: 'POST',
81
- params: this._params(),
82
- };
83
- try {
84
- const response = await this.httpClient.call(request);
85
- return parseResponse(response, schemas.WebhookDispatch());
86
- }
87
- catch (err) {
88
- catchNotFoundOrThrow(err);
89
- }
90
- return undefined;
94
+ params: this.buildParams(),
95
+ timeoutSecs,
96
+ signal,
97
+ });
98
+ return parseResponse(response, schemas.WebhookDispatch());
91
99
  }
92
100
  /**
93
101
  * Returns a client for the dispatches of this webhook.
@@ -96,7 +104,7 @@ export class WebhookClient extends ResourceClient {
96
104
  * @see https://docs.apify.com/api/v2/webhook-webhook-dispatches-get
97
105
  */
98
106
  dispatches() {
99
- return new WebhookDispatchCollectionClient(this._subResourceOptions({
107
+ return new WebhookDispatchCollectionClient(this.subResourceOptions({
100
108
  resourcePath: 'dispatches',
101
109
  }));
102
110
  }
@@ -1,5 +1,6 @@
1
1
  import type { ApiClientSubResourceOptions } from '../base/api_client.js';
2
2
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
3
+ import type { TimeoutOptions } from '../timeouts.js';
3
4
  import type { PaginatedIterator, PaginationOptions } from '../utils.js';
4
5
  import type { Webhook, WebhookUpdateData } from './webhook.js';
5
6
  /**
@@ -47,6 +48,7 @@ export declare class WebhookCollectionClient extends ResourceCollectionClient {
47
48
  * ```
48
49
  *
49
50
  * @param options - Pagination and sorting options.
51
+ * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
50
52
  * @returns A paginated iterator of webhooks.
51
53
  * @see https://docs.apify.com/api/v2/webhooks-get
52
54
  */
@@ -55,11 +57,13 @@ export declare class WebhookCollectionClient extends ResourceCollectionClient {
55
57
  * Creates a new webhook.
56
58
  *
57
59
  * @param webhook - The webhook data.
60
+ * @param options - Request options
61
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
58
62
  * @returns The created webhook object.
59
63
  * @see https://docs.apify.com/api/v2/webhooks-post
60
64
  */
61
- create(webhook?: WebhookUpdateData): Promise<Webhook>;
65
+ create(webhook?: WebhookUpdateData, options?: TimeoutOptions): Promise<Webhook>;
62
66
  }
63
- export interface WebhookCollectionListOptions extends PaginationOptions {
67
+ export interface WebhookCollectionListOptions extends PaginationOptions, TimeoutOptions {
64
68
  desc?: boolean;
65
69
  }
@@ -1,10 +1,12 @@
1
1
  import { z } from 'zod';
2
2
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
3
3
  import * as schemas from '../schemas.js';
4
+ import { timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
4
5
  import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
5
6
  const listOptionsSchema = z.strictObject({
6
7
  ...paginationOptionsShape,
7
8
  desc: z.boolean().optional(),
9
+ ...timeoutOptionsShape,
8
10
  });
9
11
  const webhookCreateSchema = anyObjectSchema.optional();
10
12
  /**
@@ -57,22 +59,26 @@ export class WebhookCollectionClient extends ResourceCollectionClient {
57
59
  * ```
58
60
  *
59
61
  * @param options - Pagination and sorting options.
62
+ * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
60
63
  * @returns A paginated iterator of webhooks.
61
64
  * @see https://docs.apify.com/api/v2/webhooks-get
62
65
  */
63
66
  list(options = {}) {
64
67
  const parsed = parseArgument(options, listOptionsSchema, 'WebhookCollectionListOptions');
65
- return this._listPaginated(schemas.ListOfWebhooks(), parsed);
68
+ return this.listResourcesPaginated(schemas.ListOfWebhooks(), parsed, 'medium');
66
69
  }
67
70
  /**
68
71
  * Creates a new webhook.
69
72
  *
70
73
  * @param webhook - The webhook data.
74
+ * @param options - Request options
75
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
71
76
  * @returns The created webhook object.
72
77
  * @see https://docs.apify.com/api/v2/webhooks-post
73
78
  */
74
- async create(webhook) {
79
+ async create(webhook, options = {}) {
75
80
  parseArgument(webhook, webhookCreateSchema);
76
- return this._create(schemas.Webhook(), webhook);
81
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
82
+ return this.createResource(schemas.Webhook(), webhook, timeoutSecs, signal);
77
83
  }
78
84
  }
@@ -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 { WebhookDispatch } from '../models.js';
4
+ import type { TimeoutOptions } from '../timeouts.js';
4
5
  export type { WebhookDispatch, WebhookDispatchCall, WebhookDispatchEventData, WebhookDispatchWebhookSummary, } from '../models.js';
5
6
  export { WebhookDispatchStatus } from '../models.js';
6
7
  /**
@@ -29,8 +30,10 @@ export declare class WebhookDispatchClient extends ResourceClient {
29
30
  /**
30
31
  * Retrieves the webhook dispatch.
31
32
  *
33
+ * @param options - Request options
34
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
32
35
  * @returns The webhook dispatch object, or `undefined` if it does not exist.
33
36
  * @see https://docs.apify.com/api/v2/webhook-dispatch-get
34
37
  */
35
- get(): Promise<WebhookDispatch | undefined>;
38
+ get(options?: TimeoutOptions): Promise<WebhookDispatch | undefined>;
36
39
  }
@@ -1,5 +1,7 @@
1
1
  import { ResourceClient } from '../base/resource_client.js';
2
2
  import * as schemas from '../schemas.js';
3
+ import { timeoutOptionsSchema } from '../timeouts.js';
4
+ import { parseArgument } from '../utils.js';
3
5
  export { WebhookDispatchStatus } from '../models.js';
4
6
  /**
5
7
  * Client for managing a specific webhook dispatch.
@@ -32,10 +34,13 @@ export class WebhookDispatchClient extends ResourceClient {
32
34
  /**
33
35
  * Retrieves the webhook dispatch.
34
36
  *
37
+ * @param options - Request options
38
+ * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
35
39
  * @returns The webhook dispatch object, or `undefined` if it does not exist.
36
40
  * @see https://docs.apify.com/api/v2/webhook-dispatch-get
37
41
  */
38
- async get() {
39
- return this._get(schemas.WebhookDispatch());
42
+ async get(options = {}) {
43
+ const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
44
+ return this.getResource(schemas.WebhookDispatch(), {}, timeoutSecs, signal);
40
45
  }
41
46
  }
@@ -1,5 +1,6 @@
1
1
  import type { ApiClientSubResourceOptions } from '../base/api_client.js';
2
2
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
3
+ import type { TimeoutOptions } from '../timeouts.js';
3
4
  import type { PaginatedIterator, PaginationOptions } from '../utils.js';
4
5
  import type { WebhookDispatch } from './webhook_dispatch.js';
5
6
  /**
@@ -42,11 +43,12 @@ export declare class WebhookDispatchCollectionClient extends ResourceCollectionC
42
43
  * ```
43
44
  *
44
45
  * @param options - Pagination and sorting options.
46
+ * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
45
47
  * @returns A paginated iterator of webhook dispatches.
46
48
  * @see https://docs.apify.com/api/v2/webhook-dispatches-get
47
49
  */
48
50
  list(options?: WebhookDispatchCollectionListOptions): PaginatedIterator<WebhookDispatch>;
49
51
  }
50
- export interface WebhookDispatchCollectionListOptions extends PaginationOptions {
52
+ export interface WebhookDispatchCollectionListOptions extends PaginationOptions, TimeoutOptions {
51
53
  desc?: boolean;
52
54
  }
@@ -1,10 +1,12 @@
1
1
  import { z } from 'zod';
2
2
  import { ResourceCollectionClient } from '../base/resource_collection_client.js';
3
3
  import * as schemas from '../schemas.js';
4
+ import { timeoutOptionsShape } from '../timeouts.js';
4
5
  import { paginationOptionsShape, parseArgument } from '../utils.js';
5
6
  const listOptionsSchema = z.strictObject({
6
7
  ...paginationOptionsShape,
7
8
  desc: z.boolean().optional(),
9
+ ...timeoutOptionsShape,
8
10
  });
9
11
  /**
10
12
  * Client for managing the collection of webhook dispatches.
@@ -51,11 +53,12 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient {
51
53
  * ```
52
54
  *
53
55
  * @param options - Pagination and sorting options.
56
+ * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
54
57
  * @returns A paginated iterator of webhook dispatches.
55
58
  * @see https://docs.apify.com/api/v2/webhook-dispatches-get
56
59
  */
57
60
  list(options = {}) {
58
61
  const parsed = parseArgument(options, listOptionsSchema, 'WebhookDispatchCollectionListOptions');
59
- return this._listPaginated(schemas.ListOfWebhookDispatches(), parsed);
62
+ return this.listResourcesPaginated(schemas.ListOfWebhookDispatches(), parsed, 'medium');
60
63
  }
61
64
  }
@@ -0,0 +1,6 @@
1
+ import type { Runtime } from './types.js';
2
+ /**
3
+ * The Node.js implementation of {@link Runtime}. Deno and Bun resolve the `node` condition too and
4
+ * provide the built-ins it uses.
5
+ */
6
+ export declare const runtime: Runtime;
@@ -0,0 +1,49 @@
1
+ import os from 'node:os';
2
+ import { brotliCompress, constants, gzip } from 'node:zlib';
3
+ /**
4
+ * The Node.js implementation of {@link Runtime}. Deno and Bun resolve the `node` condition too and
5
+ * provide the built-ins it uses.
6
+ */
7
+ export const runtime = {
8
+ isNode: true,
9
+ platform: `${os.platform()}; Node/${process.version}`,
10
+ async compress(data, { algorithm, quality }) {
11
+ return new Promise((resolve, reject) => {
12
+ const done = (error, result) => (error ? reject(error) : resolve(result));
13
+ if (algorithm === 'br') {
14
+ brotliCompress(data, { params: { [constants.BROTLI_PARAM_QUALITY]: quality } }, done);
15
+ }
16
+ else {
17
+ gzip(data, { level: quality }, done);
18
+ }
19
+ });
20
+ },
21
+ async createHttpAgents({ timeoutMillis }) {
22
+ // Loaded on the first request rather than with the client: the proxy support pulls in a sizeable
23
+ // dependency tree that a client which never sends a request should not pay for.
24
+ const { ProxyAgent } = await import('proxy-agent');
25
+ // We want to keep sockets alive for better performance.
26
+ const agentOptions = {
27
+ keepAlive: true,
28
+ // Timeout for inactive sockets
29
+ // Prevents socket leaks from idle connections
30
+ timeout: timeoutMillis,
31
+ // Keep alive timeout for free sockets (15 seconds)
32
+ // Node.js will close unused sockets after this period
33
+ keepAliveMsecs: 15_000,
34
+ // Maximum number of sockets per host
35
+ maxSockets: 256,
36
+ maxFreeSockets: 256,
37
+ // LIFO scheduling - reuse most recently used sockets for better performance
38
+ scheduling: 'lifo',
39
+ };
40
+ // ProxyAgent picks the proxy up from the environment variables and supports CONNECT tunneling.
41
+ const agent = new ProxyAgent(agentOptions);
42
+ // Disable Nagle's algorithm for lower latency
43
+ // This sends data immediately instead of buffering small packets
44
+ agent.on('socket', (socket) => {
45
+ socket.setNoDelay(true);
46
+ });
47
+ return { httpAgent: agent, httpsAgent: agent };
48
+ },
49
+ };