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/models.d.ts CHANGED
@@ -62,7 +62,6 @@ export type ErrorType = Schemas['ErrorType'];
62
62
  * TODO: Remove once the spec covers them.
63
63
  */
64
64
  export interface DatasetResourceSpecGaps {
65
- title?: string;
66
65
  username?: string;
67
66
  }
68
67
  export interface DatasetResourceRePointed {
@@ -143,14 +142,6 @@ export interface WebhookDispatchEventData extends GeneratedWebhookDispatchEventD
143
142
  }
144
143
  type GeneratedKeyValueStoreStats = Schemas['KeyValueStoreStats'];
145
144
  type GeneratedKeyValueStoreKey = Schemas['KeyValueStoreKey'];
146
- /**
147
- * Fields the API returns on a key-value store that the OpenAPI spec does not describe yet.
148
- *
149
- * TODO: Remove once the spec covers them.
150
- */
151
- export interface KeyValueStoreResourceSpecGaps {
152
- title?: string;
153
- }
154
145
  export interface KeyValueStoreResourceRePointed {
155
146
  stats?: KeyValueStoreStats;
156
147
  generalAccess?: STORAGE_GENERAL_ACCESS | null;
@@ -161,7 +152,7 @@ export interface KeyValueStoreResourceRePointed {
161
152
  * Key-value stores are used to store arbitrary data records or files. Each record is identified
162
153
  * by a unique key and can contain any data - JSON objects, strings, binary files, etc.
163
154
  */
164
- export interface KeyValueStoreResource extends Omit<Schemas['KeyValueStoreResource'], keyof KeyValueStoreResourceRePointed>, KeyValueStoreResourceRePointed, KeyValueStoreResourceSpecGaps {
155
+ export interface KeyValueStoreResource extends Omit<Schemas['KeyValueStoreResource'], keyof KeyValueStoreResourceRePointed>, KeyValueStoreResourceRePointed {
165
156
  }
166
157
  /** Statistics about Key-Value Store usage and storage. */
167
158
  export interface KeyValueStoreStats extends GeneratedKeyValueStoreStats {
@@ -511,20 +502,12 @@ export interface RunMetaRePointed {
511
502
  /** Metadata about how an Actor run was initiated. */
512
503
  export interface RunMeta extends Omit<Schemas['RunMeta'], keyof RunMetaRePointed>, RunMetaRePointed {
513
504
  }
514
- /**
515
- * Fields the API returns in an Actor run's options that the OpenAPI spec does not describe yet.
516
- *
517
- * TODO: Remove once the spec covers it.
518
- */
519
- export interface RunOptionsSpecGaps {
520
- restartOnError?: boolean;
521
- }
522
505
  /**
523
506
  * Configuration options used for an Actor run.
524
507
  *
525
508
  * These are the actual options that were applied to the run (may differ from requested options).
526
509
  */
527
- export interface RunOptions extends GeneratedRunOptions, RunOptionsSpecGaps {
510
+ export interface RunOptions extends GeneratedRunOptions {
528
511
  }
529
512
  export interface RunListItemRePointed {
530
513
  meta: RunMeta;
@@ -596,19 +579,8 @@ export interface Task extends Omit<Schemas['Task'], keyof TaskRePointed>, TaskRe
596
579
  export interface TaskListItemRePointed {
597
580
  stats?: TaskStats | null;
598
581
  }
599
- /**
600
- * Fields the API returns on a listed task that the OpenAPI spec does not describe yet.
601
- *
602
- * `description` is deliberately not here, although the spec has it on the full `Task` resource: the
603
- * list endpoint publishes a smaller set of fields, and that is one of the fields it leaves out.
604
- *
605
- * TODO: Remove once the spec covers it.
606
- */
607
- export interface TaskListItemSpecGaps {
608
- title?: string | null;
609
- }
610
582
  /** A task as it appears in a listing, which carries fewer fields than the full resource. */
611
- export interface TaskListItem extends Omit<Schemas['TaskListItem'], keyof TaskListItemRePointed>, TaskListItemRePointed, TaskListItemSpecGaps {
583
+ export interface TaskListItem extends Omit<Schemas['TaskListItem'], keyof TaskListItemRePointed>, TaskListItemRePointed {
612
584
  }
613
585
  export interface StoreActorRePointed {
614
586
  stats: ActorStats;
@@ -667,17 +639,6 @@ export interface WebhookLastDispatchRePointed {
667
639
  /** The summary of a webhook's most recent dispatch that the webhook resource carries. */
668
640
  export interface WebhookLastDispatch extends Omit<Schemas['WebhookLastDispatch'], keyof WebhookLastDispatchRePointed>, WebhookLastDispatchRePointed {
669
641
  }
670
- /**
671
- * Fields the API returns on a webhook that the OpenAPI spec does not describe yet.
672
- *
673
- * The spec does carry `isApifyIntegration` on `WebhookListItem`, the listing shape, and simply omits it
674
- * from the full `WebhookResource` schema.
675
- *
676
- * TODO: Remove once the spec covers it.
677
- */
678
- export interface WebhookResourceSpecGaps {
679
- isApifyIntegration?: boolean;
680
- }
681
642
  export interface WebhookResourceRePointed {
682
643
  condition: WebhookCondition;
683
644
  stats?: WebhookStats | null;
@@ -690,7 +651,7 @@ export interface WebhookResourceRePointed {
690
651
  * Webhooks send HTTP POST requests to specified URLs when certain events occur
691
652
  * (e.g., Actor run succeeds, fails, or times out).
692
653
  */
693
- export interface WebhookResource extends Omit<Schemas['WebhookResource'], keyof WebhookResourceRePointed>, WebhookResourceRePointed, WebhookResourceSpecGaps {
654
+ export interface WebhookResource extends Omit<Schemas['WebhookResource'], keyof WebhookResourceRePointed>, WebhookResourceRePointed {
694
655
  }
695
656
  type GeneratedScheduleActionRunInput = Schemas['ScheduleActionRunInput'];
696
657
  /**
@@ -733,12 +694,15 @@ export interface ScheduleRePointed {
733
694
  export interface ScheduleClientNarrowings {
734
695
  timezone: Timezone;
735
696
  }
697
+ export interface ScheduleSpecNarrowings {
698
+ uiState?: NonNullable<Schemas['Schedule']['uiState']> | null;
699
+ }
736
700
  /**
737
701
  * Represents a schedule for automated Actor or Task runs.
738
702
  *
739
703
  * Schedules use cron expressions to define when Actors or Tasks should run automatically.
740
704
  */
741
- export interface Schedule extends Omit<Schemas['Schedule'], keyof ScheduleRePointed | keyof ScheduleClientNarrowings>, ScheduleRePointed, ScheduleClientNarrowings {
705
+ export interface Schedule extends Omit<Schemas['Schedule'], keyof ScheduleRePointed | keyof ScheduleClientNarrowings | keyof ScheduleSpecNarrowings>, ScheduleRePointed, ScheduleClientNarrowings, ScheduleSpecNarrowings {
742
706
  }
743
707
  type GeneratedUserProfile = Schemas['UserProfile'];
744
708
  type GeneratedProxyGroup = Schemas['ProxyGroup'];
@@ -899,12 +863,11 @@ export interface RequestQueueStats extends GeneratedRequestQueueStats {
899
863
  * Fields the API returns on a request queue that the OpenAPI spec does not describe yet.
900
864
  *
901
865
  * The spec does carry `username` on `RequestQueueListItem`, the listing shape, and simply omits it from the
902
- * full `RequestQueueResource` schema. `title` is absent from either.
866
+ * full `RequestQueueResource` schema.
903
867
  *
904
- * TODO: Remove once the spec covers them.
868
+ * TODO: Remove once the spec covers it.
905
869
  */
906
870
  export interface RequestQueueResourceSpecGaps {
907
- title?: string;
908
871
  username?: string;
909
872
  }
910
873
  export interface RequestQueueResourceRePointed {
package/dist/schemas.d.ts CHANGED
@@ -47,6 +47,9 @@ export declare const Build: () => z.ZodObject<{
47
47
  }>, z.ZodString]>;
48
48
  clientIp: z.ZodOptional<z.ZodString>;
49
49
  userAgent: z.ZodOptional<z.ZodString>;
50
+ githubActionsRunUrl: z.ZodOptional<z.ZodString>;
51
+ actorRunId: z.ZodOptional<z.ZodString>;
52
+ webhookDispatchId: z.ZodOptional<z.ZodString>;
50
53
  }, z.core.$loose>;
51
54
  stats: z.ZodOptional<z.ZodNullable<z.ZodObject<{
52
55
  durationMillis: z.ZodOptional<z.ZodInt>;
@@ -59,6 +62,8 @@ export declare const Build: () => z.ZodObject<{
59
62
  betaPackages: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
60
63
  memoryMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
61
64
  diskMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
65
+ tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
66
+ debug: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
62
67
  }, z.core.$loose>>>;
63
68
  usage: z.ZodOptional<z.ZodNullable<z.ZodObject<{
64
69
  ACTOR_COMPUTE_UNITS: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -69,6 +74,11 @@ export declare const Build: () => z.ZodObject<{
69
74
  }, z.core.$loose>>>;
70
75
  inputSchema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
71
76
  readme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
77
+ changelog: z.ZodOptional<z.ZodNullable<z.ZodString>>;
78
+ exitCode: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
79
+ gitCommitId: z.ZodOptional<z.ZodString>;
80
+ gitBranchName: z.ZodOptional<z.ZodString>;
81
+ createdByOrganizationMemberUserId: z.ZodOptional<z.ZodString>;
72
82
  buildNumber: z.ZodString;
73
83
  imageDigest: z.ZodOptional<z.ZodNullable<z.ZodString>>;
74
84
  actorDefinition: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -119,6 +129,8 @@ export declare const Build: () => z.ZodObject<{
119
129
  content: z.ZodOptional<z.ZodString>;
120
130
  name: z.ZodString;
121
131
  }, z.core.$loose>>>;
132
+ gitHubGistUrl: z.ZodOptional<z.ZodString>;
133
+ tarballUrl: z.ZodOptional<z.ZodString>;
122
134
  buildTag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
123
135
  }, z.core.$loose>>;
124
136
  }, z.core.$loose>;
@@ -156,6 +168,9 @@ export declare const BuildResponse: () => z.ZodObject<{
156
168
  }>, z.ZodString]>;
157
169
  clientIp: z.ZodOptional<z.ZodString>;
158
170
  userAgent: z.ZodOptional<z.ZodString>;
171
+ githubActionsRunUrl: z.ZodOptional<z.ZodString>;
172
+ actorRunId: z.ZodOptional<z.ZodString>;
173
+ webhookDispatchId: z.ZodOptional<z.ZodString>;
159
174
  }, z.core.$loose>;
160
175
  stats: z.ZodOptional<z.ZodNullable<z.ZodObject<{
161
176
  durationMillis: z.ZodOptional<z.ZodInt>;
@@ -168,6 +183,8 @@ export declare const BuildResponse: () => z.ZodObject<{
168
183
  betaPackages: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
169
184
  memoryMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
170
185
  diskMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
186
+ tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
187
+ debug: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
171
188
  }, z.core.$loose>>>;
172
189
  usage: z.ZodOptional<z.ZodNullable<z.ZodObject<{
173
190
  ACTOR_COMPUTE_UNITS: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -178,6 +195,11 @@ export declare const BuildResponse: () => z.ZodObject<{
178
195
  }, z.core.$loose>>>;
179
196
  inputSchema: z.ZodOptional<z.ZodNullable<z.ZodString>>;
180
197
  readme: z.ZodOptional<z.ZodNullable<z.ZodString>>;
198
+ changelog: z.ZodOptional<z.ZodNullable<z.ZodString>>;
199
+ exitCode: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
200
+ gitCommitId: z.ZodOptional<z.ZodString>;
201
+ gitBranchName: z.ZodOptional<z.ZodString>;
202
+ createdByOrganizationMemberUserId: z.ZodOptional<z.ZodString>;
181
203
  buildNumber: z.ZodString;
182
204
  imageDigest: z.ZodOptional<z.ZodNullable<z.ZodString>>;
183
205
  actorDefinition: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -228,7 +250,130 @@ export declare const BuildResponse: () => z.ZodObject<{
228
250
  content: z.ZodOptional<z.ZodString>;
229
251
  name: z.ZodString;
230
252
  }, z.core.$loose>>>;
253
+ gitHubGistUrl: z.ZodOptional<z.ZodString>;
254
+ tarballUrl: z.ZodOptional<z.ZodString>;
231
255
  buildTag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
232
256
  }, z.core.$loose>>;
233
257
  }, z.core.$loose>;
234
258
  }, z.core.$loose>;
259
+ /**
260
+ * The API returns `uiState` as `null` once an API update has changed the schedule's `cronExpression` or `timezone`,
261
+ * which the specification types as an object.
262
+ */
263
+ export declare const Schedule: () => z.ZodObject<{
264
+ id: z.ZodString;
265
+ userId: z.ZodString;
266
+ name: z.ZodString;
267
+ cronExpression: z.ZodString;
268
+ timezone: z.ZodString;
269
+ isEnabled: z.ZodBoolean;
270
+ isExclusive: z.ZodBoolean;
271
+ createdAt: z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>;
272
+ modifiedAt: z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>;
273
+ nextRunAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>>>;
274
+ lastRunAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>>>;
275
+ description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
276
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
277
+ notifications: z.ZodOptional<z.ZodObject<{
278
+ email: z.ZodOptional<z.ZodBoolean>;
279
+ }, z.core.$loose>>;
280
+ integrationTracking: z.ZodOptional<z.ZodObject<{
281
+ platform: z.ZodOptional<z.ZodString>;
282
+ appId: z.ZodOptional<z.ZodString>;
283
+ isAiTool: z.ZodOptional<z.ZodBoolean>;
284
+ }, z.core.$loose>>;
285
+ actions: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
286
+ id: z.ZodString;
287
+ type: z.ZodLiteral<"RUN_ACTOR">;
288
+ actorId: z.ZodString;
289
+ runInput: z.ZodOptional<z.ZodNullable<z.ZodObject<{
290
+ body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
291
+ contentType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
292
+ }, z.core.$loose>>>;
293
+ runOptions: z.ZodOptional<z.ZodNullable<z.ZodObject<{
294
+ build: z.ZodOptional<z.ZodNullable<z.ZodString>>;
295
+ timeoutSecs: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
296
+ memoryMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
297
+ maxItems: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
298
+ maxTotalChargeUsd: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
299
+ restartOnError: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
300
+ isMaxTotalChargeUsdSetByUser: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
301
+ forcePermissionLevel: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodEnum<{
302
+ FULL_PERMISSIONS: "FULL_PERMISSIONS";
303
+ LIMITED_PERMISSIONS: "LIMITED_PERMISSIONS";
304
+ }>, z.ZodString]>>>;
305
+ }, z.core.$loose>>>;
306
+ }, z.core.$loose>, z.ZodObject<{
307
+ id: z.ZodString;
308
+ type: z.ZodLiteral<"RUN_ACTOR_TASK">;
309
+ actorTaskId: z.ZodString;
310
+ input: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
311
+ }, z.core.$loose>], "type">>;
312
+ uiState: z.ZodOptional<z.ZodNullable<z.ZodObject<{
313
+ version: z.ZodOptional<z.ZodInt>;
314
+ data: z.ZodOptional<z.ZodObject<{
315
+ cronExpression: z.ZodOptional<z.ZodString>;
316
+ timezone: z.ZodOptional<z.ZodString>;
317
+ }, z.core.$loose>>;
318
+ }, z.core.$loose>>>;
319
+ }, z.core.$loose>;
320
+ /** Response containing schedule data. */
321
+ export declare const ScheduleResponse: () => z.ZodObject<{
322
+ data: z.ZodObject<{
323
+ id: z.ZodString;
324
+ userId: z.ZodString;
325
+ name: z.ZodString;
326
+ cronExpression: z.ZodString;
327
+ timezone: z.ZodString;
328
+ isEnabled: z.ZodBoolean;
329
+ isExclusive: z.ZodBoolean;
330
+ createdAt: z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>;
331
+ modifiedAt: z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>;
332
+ nextRunAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>>>;
333
+ lastRunAt: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodISODateTime, z.ZodCoercedDate<string>>>>;
334
+ description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
335
+ title: z.ZodOptional<z.ZodNullable<z.ZodString>>;
336
+ notifications: z.ZodOptional<z.ZodObject<{
337
+ email: z.ZodOptional<z.ZodBoolean>;
338
+ }, z.core.$loose>>;
339
+ integrationTracking: z.ZodOptional<z.ZodObject<{
340
+ platform: z.ZodOptional<z.ZodString>;
341
+ appId: z.ZodOptional<z.ZodString>;
342
+ isAiTool: z.ZodOptional<z.ZodBoolean>;
343
+ }, z.core.$loose>>;
344
+ actions: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
345
+ id: z.ZodString;
346
+ type: z.ZodLiteral<"RUN_ACTOR">;
347
+ actorId: z.ZodString;
348
+ runInput: z.ZodOptional<z.ZodNullable<z.ZodObject<{
349
+ body: z.ZodOptional<z.ZodNullable<z.ZodString>>;
350
+ contentType: z.ZodOptional<z.ZodNullable<z.ZodString>>;
351
+ }, z.core.$loose>>>;
352
+ runOptions: z.ZodOptional<z.ZodNullable<z.ZodObject<{
353
+ build: z.ZodOptional<z.ZodNullable<z.ZodString>>;
354
+ timeoutSecs: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
355
+ memoryMbytes: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
356
+ maxItems: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
357
+ maxTotalChargeUsd: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
358
+ restartOnError: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
359
+ isMaxTotalChargeUsdSetByUser: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
360
+ forcePermissionLevel: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodEnum<{
361
+ FULL_PERMISSIONS: "FULL_PERMISSIONS";
362
+ LIMITED_PERMISSIONS: "LIMITED_PERMISSIONS";
363
+ }>, z.ZodString]>>>;
364
+ }, z.core.$loose>>>;
365
+ }, z.core.$loose>, z.ZodObject<{
366
+ id: z.ZodString;
367
+ type: z.ZodLiteral<"RUN_ACTOR_TASK">;
368
+ actorTaskId: z.ZodString;
369
+ input: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
370
+ }, z.core.$loose>], "type">>;
371
+ uiState: z.ZodOptional<z.ZodNullable<z.ZodObject<{
372
+ version: z.ZodOptional<z.ZodInt>;
373
+ data: z.ZodOptional<z.ZodObject<{
374
+ cronExpression: z.ZodOptional<z.ZodString>;
375
+ timezone: z.ZodOptional<z.ZodString>;
376
+ }, z.core.$loose>>;
377
+ }, z.core.$loose>>>;
378
+ }, z.core.$loose>;
379
+ }, z.core.$loose>;
package/dist/schemas.js CHANGED
@@ -28,3 +28,10 @@ export const Build = lazySchema(() => {
28
28
  });
29
29
  /** Response containing Actor build data. */
30
30
  export const BuildResponse = lazySchema(() => generated.BuildResponse().extend({ data: Build() }));
31
+ /**
32
+ * The API returns `uiState` as `null` once an API update has changed the schedule's `cronExpression` or `timezone`,
33
+ * which the specification types as an object.
34
+ */
35
+ export const Schedule = lazySchema(() => generated.Schedule().extend({ uiState: generated.ScheduleUiState().nullable().optional() }));
36
+ /** Response containing schedule data. */
37
+ export const ScheduleResponse = lazySchema(() => generated.ScheduleResponse().extend({ data: Schedule() }));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "apify-client",
3
- "version": "3.0.0-beta.77",
3
+ "version": "3.0.0-beta.78",
4
4
  "description": "Apify API client for JavaScript",
5
5
  "engines": {
6
6
  "node": ">=22.13.0"
@@ -59,7 +59,7 @@
59
59
  ],
60
60
  "apify": {
61
61
  "openapiSpec": {
62
- "version": "v2-2026-10-26T112451Z"
62
+ "version": "v2-2026-10-27T134926Z"
63
63
  }
64
64
  },
65
65
  "dependencies": {