apify-client 2.25.1-beta.0 → 2.25.1-beta.2

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 (44) hide show
  1. package/dist/apify_client.d.ts +11 -1
  2. package/dist/apify_client.js +4 -0
  3. package/dist/base/api_client.d.ts +3 -0
  4. package/dist/base/api_client.js +3 -0
  5. package/dist/bundle.js +46 -4
  6. package/dist/bundle.js.map +1 -1
  7. package/dist/resource_clients/actor.d.ts +105 -7
  8. package/dist/resource_clients/actor.js +2 -0
  9. package/dist/resource_clients/actor_collection.d.ts +30 -0
  10. package/dist/resource_clients/actor_collection.js +3 -0
  11. package/dist/resource_clients/actor_env_var.d.ts +1 -0
  12. package/dist/resource_clients/actor_env_var.js +1 -0
  13. package/dist/resource_clients/actor_env_var_collection.d.ts +5 -0
  14. package/dist/resource_clients/actor_env_var_collection.js +1 -0
  15. package/dist/resource_clients/actor_version.d.ts +5 -0
  16. package/dist/resource_clients/actor_version.js +2 -0
  17. package/dist/resource_clients/build.d.ts +17 -0
  18. package/dist/resource_clients/build.js +3 -0
  19. package/dist/resource_clients/dataset.d.ts +35 -0
  20. package/dist/resource_clients/dataset.js +2 -0
  21. package/dist/resource_clients/dataset_collection.d.ts +7 -1
  22. package/dist/resource_clients/key_value_store.d.ts +39 -0
  23. package/dist/resource_clients/key_value_store.js +3 -0
  24. package/dist/resource_clients/key_value_store_collection.d.ts +7 -1
  25. package/dist/resource_clients/log.d.ts +8 -0
  26. package/dist/resource_clients/log.js +2 -0
  27. package/dist/resource_clients/request_queue.d.ts +86 -0
  28. package/dist/resource_clients/request_queue.js +8 -0
  29. package/dist/resource_clients/request_queue_collection.d.ts +4 -1
  30. package/dist/resource_clients/run.d.ts +23 -0
  31. package/dist/resource_clients/run.js +5 -0
  32. package/dist/resource_clients/run_collection.d.ts +6 -0
  33. package/dist/resource_clients/schedule.d.ts +10 -0
  34. package/dist/resource_clients/store_collection.d.ts +18 -1
  35. package/dist/resource_clients/store_collection.js +1 -0
  36. package/dist/resource_clients/task.d.ts +18 -0
  37. package/dist/resource_clients/task.js +2 -0
  38. package/dist/resource_clients/task_collection.d.ts +3 -0
  39. package/dist/resource_clients/user.d.ts +33 -0
  40. package/dist/resource_clients/user.js +3 -0
  41. package/dist/resource_clients/webhook.d.ts +12 -0
  42. package/dist/resource_clients/webhook_dispatch.d.ts +6 -0
  43. package/dist/utils.d.ts +2 -0
  44. package/package.json +3 -3
@@ -162,6 +162,7 @@ export declare class ActorClient extends ResourceClient {
162
162
  * { build: 'beta' },
163
163
  * );
164
164
  * ```
165
+ * @since Added in 2.24.0
165
166
  */
166
167
  validateInput(input?: unknown, options?: ActorValidateInputOptions): Promise<boolean>;
167
168
  /**
@@ -217,6 +218,7 @@ export declare class ActorClient extends ResourceClient {
217
218
  * const buildClient = await client.actor('my-actor').defaultBuild({ waitForFinish: 60 });
218
219
  * const build = await buildClient.get();
219
220
  * ```
221
+ * @since Added in 2.12.2
220
222
  */
221
223
  defaultBuild(options?: BuildClientGetOptions): Promise<BuildClient>;
222
224
  /**
@@ -306,7 +308,10 @@ export interface Actor {
306
308
  stats: ActorStats;
307
309
  /** All versions of this Actor */
308
310
  versions: ActorVersion[];
309
- /** Pricing information for pay-per-result or pay-per-event Actors */
311
+ /**
312
+ * Pricing information for pay-per-result or pay-per-event Actors
313
+ * @since Added in 2.12.4
314
+ */
310
315
  pricingInfos?: ActorRunPricingInfo[];
311
316
  /** Default configuration options for Actor runs */
312
317
  defaultRunOptions: ActorDefaultRunOptions;
@@ -320,19 +325,37 @@ export interface Actor {
320
325
  title?: string;
321
326
  /** Mapping of tags to specific builds (e.g., 'latest', 'beta') */
322
327
  taggedBuilds?: ActorTaggedBuilds;
323
- /** SEO-optimized title for the Actor's public page */
328
+ /**
329
+ * SEO-optimized title for the Actor's public page
330
+ * @since Added in 2.6.1
331
+ */
324
332
  seoTitle?: string;
325
- /** SEO-optimized description for the Actor's public page */
333
+ /**
334
+ * SEO-optimized description for the Actor's public page
335
+ * @since Added in 2.6.1
336
+ */
326
337
  seoDescription?: string;
327
- /** Categories the Actor belongs to (e.g., 'ECOMMERCE', 'SCRAPING') */
338
+ /**
339
+ * Categories the Actor belongs to (e.g., 'ECOMMERCE', 'SCRAPING')
340
+ * @since Added in 2.6.1
341
+ */
328
342
  categories?: string[];
329
- /** Standby mode configuration for keeping Actor warm and responsive */
343
+ /**
344
+ * Standby mode configuration for keeping Actor warm and responsive
345
+ * @since Added in 2.9.5
346
+ */
330
347
  actorStandby?: ActorStandby & {
331
348
  isEnabled: boolean;
332
349
  };
333
- /** Permission level of the Actor on Apify platform */
350
+ /**
351
+ * Permission level of the Actor on Apify platform
352
+ * @since Added in 2.21.0
353
+ */
334
354
  actorPermissionLevel: ACTOR_PERMISSION_LEVEL;
335
- /** A brief, LLM-generated readme summary */
355
+ /**
356
+ * A brief, LLM-generated readme summary
357
+ * @since Added in 2.22.1
358
+ */
336
359
  readmeSummary?: string;
337
360
  }
338
361
  /**
@@ -363,6 +386,9 @@ export interface ActorDefaultRunOptions {
363
386
  build: string;
364
387
  timeoutSecs: number;
365
388
  memoryMbytes: number;
389
+ /**
390
+ * @since Added in 2.19.0
391
+ */
366
392
  restartOnError?: boolean;
367
393
  }
368
394
  /**
@@ -393,14 +419,21 @@ export type ActorUpdateOptions = Partial<Pick<Actor, 'name' | 'description' | 'i
393
419
  *
394
420
  * Standby mode keeps Actor containers warm and ready to process requests with minimal latency.
395
421
  * This is useful for Actors that need to respond quickly to incoming requests.
422
+ * @since Added in 2.9.5
396
423
  */
397
424
  export interface ActorStandby {
398
425
  build?: string;
399
426
  desiredRequestsPerActorRun?: number;
427
+ /**
428
+ * @since Added in 2.22.0
429
+ */
400
430
  disableStandbyFieldsOverride?: boolean;
401
431
  idleTimeoutSecs?: number;
402
432
  maxRequestsPerActorRun?: number;
403
433
  memoryMbytes?: number;
434
+ /**
435
+ * @since Added in 2.22.0
436
+ */
404
437
  shouldPassActorInput?: boolean;
405
438
  }
406
439
  export interface ActorStartOptions {
@@ -447,6 +480,7 @@ export interface ActorStartOptions {
447
480
  * It only ensures you won't be charged for more than this number of items.
448
481
  * Only works for pay-per-result Actors.
449
482
  * Value can be accessed in the Actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable.
483
+ * @since Added in 2.7.0
450
484
  */
451
485
  maxItems?: number;
452
486
  /**
@@ -454,6 +488,7 @@ export interface ActorStartOptions {
454
488
  * used only for pay-per-event Actors. It allows you to limit the amount
455
489
  * charged to your subscription. You can access the maximum cost in your
456
490
  * Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable.
491
+ * @since Added in 2.9.7
457
492
  */
458
493
  maxTotalChargeUsd?: number;
459
494
  /**
@@ -463,6 +498,7 @@ export interface ActorStartOptions {
463
498
  /**
464
499
  * Override the Actor's permissions for this run. If not set, the Actor will run with permissions configured in the
465
500
  * Actor settings.
501
+ * @since Added in 2.17.0
466
502
  */
467
503
  forcePermissionLevel?: ACTOR_PERMISSION_LEVEL;
468
504
  }
@@ -470,6 +506,7 @@ export interface ActorStartOptions {
470
506
  * Options for calling an Actor and waiting for it to finish.
471
507
  *
472
508
  * Extends {@link ActorStartOptions} with additional options for waiting and log streaming.
509
+ * @since Added in 2.6.2
473
510
  */
474
511
  export interface ActorCallOptions extends Omit<ActorStartOptions, 'waitForFinish'> {
475
512
  /**
@@ -480,6 +517,7 @@ export interface ActorCallOptions extends Omit<ActorStartOptions, 'waitForFinish
480
517
  * `Log` instance that should be used to redirect Actor run logs to.
481
518
  * If `undefined` or `'default'` the pre-defined `Log` will be created and used.
482
519
  * If `null`, no log redirection will occur.
520
+ * @since Added in 2.20.0
483
521
  */
484
522
  log?: Log | null | 'default';
485
523
  }
@@ -487,6 +525,7 @@ export interface ActorCallOptions extends Omit<ActorStartOptions, 'waitForFinish
487
525
  * Simplified Actor run information used in list results.
488
526
  *
489
527
  * Contains basic information about a run without detailed statistics.
528
+ * @since Added in 2.7.0
490
529
  */
491
530
  export interface ActorRunListItem {
492
531
  id: string;
@@ -500,9 +539,18 @@ export interface ActorRunListItem {
500
539
  buildNumber: string;
501
540
  defaultKeyValueStoreId: string;
502
541
  defaultDatasetId: string;
542
+ /**
543
+ * @since Added in 2.6.1
544
+ */
503
545
  defaultRequestQueueId: string;
546
+ /**
547
+ * @since Added in 2.7.2
548
+ */
504
549
  usageTotalUsd?: number;
505
550
  }
551
+ /**
552
+ * @since Added in 2.22.3
553
+ */
506
554
  export interface ActorRunStorageIds {
507
555
  /** Aliased dataset IDs for this run. */
508
556
  datasets: {
@@ -528,24 +576,52 @@ export interface ActorRunStorageIds {
528
576
  */
529
577
  export interface ActorRun extends ActorRunListItem {
530
578
  userId: string;
579
+ /**
580
+ * @since Added in 2.6.0
581
+ */
531
582
  statusMessage?: string;
532
583
  stats: ActorRunStats;
533
584
  options: ActorRunOptions;
534
585
  exitCode?: number;
535
586
  containerUrl: string;
587
+ /**
588
+ * @since Added in 2.7.0
589
+ */
536
590
  isContainerServerReady?: boolean;
591
+ /**
592
+ * @since Added in 2.7.0
593
+ */
537
594
  gitBranchName?: string;
595
+ /**
596
+ * @since Added in 2.7.0
597
+ */
538
598
  usage?: ActorRunUsage;
599
+ /**
600
+ * @since Added in 2.7.2
601
+ */
539
602
  usageUsd?: ActorRunUsage;
603
+ /**
604
+ * @since Added in 2.11.1
605
+ */
540
606
  pricingInfo?: ActorRunPricingInfo;
607
+ /**
608
+ * @since Added in 2.11.1
609
+ */
541
610
  chargedEventCounts?: Record<string, number>;
611
+ /**
612
+ * @since Added in 2.12.2
613
+ */
542
614
  generalAccess?: RUN_GENERAL_ACCESS | null;
615
+ /**
616
+ * @since Added in 2.22.3
617
+ */
543
618
  storageIds?: ActorRunStorageIds;
544
619
  }
545
620
  /**
546
621
  * Resource usage metrics for an Actor run.
547
622
  *
548
623
  * All values represent the total consumption during the run's lifetime.
624
+ * @since Added in 2.7.0
549
625
  */
550
626
  export interface ActorRunUsage {
551
627
  /** Compute units consumed (combines CPU and memory usage over time) */
@@ -613,12 +689,22 @@ export interface ActorRunOptions {
613
689
  timeoutSecs: number;
614
690
  memoryMbytes: number;
615
691
  diskMbytes: number;
692
+ /**
693
+ * @since Added in 2.20.0
694
+ */
616
695
  maxItems?: number;
696
+ /**
697
+ * @since Added in 2.11.1
698
+ */
617
699
  maxTotalChargeUsd?: number;
700
+ /**
701
+ * @since Added in 2.19.0
702
+ */
618
703
  restartOnError?: boolean;
619
704
  }
620
705
  /**
621
706
  * Options for validating an Actor input.
707
+ * @since Added in 2.24.0
622
708
  */
623
709
  export interface ActorValidateInputOptions {
624
710
  /**
@@ -648,6 +734,9 @@ export interface ActorBuildOptions {
648
734
  */
649
735
  export interface ActorLastRunOptions {
650
736
  status?: ValueOf<typeof ACTOR_JOB_STATUSES>;
737
+ /**
738
+ * @since Added in 2.24.0
739
+ */
651
740
  origin?: ValueOf<typeof META_ORIGINS>;
652
741
  }
653
742
  /**
@@ -655,6 +744,7 @@ export interface ActorLastRunOptions {
655
744
  *
656
745
  * Contains the Actor's configuration, input schema, and other metadata.
657
746
  * @see https://docs.apify.com/platform/actors/development/actor-definition/actor-json
747
+ * @since Added in 2.11.0
658
748
  */
659
749
  export interface ActorDefinition {
660
750
  actorSpecification: number;
@@ -673,6 +763,7 @@ export interface ActorDefinition {
673
763
  /**
674
764
  * Output schema for the Actor.
675
765
  * @see https://docs.apify.com/platform/actors/development/actor-definition/output-schema
766
+ * @since Added in 2.23.0
676
767
  */
677
768
  output?: object | null;
678
769
  changelog?: string | null;
@@ -696,12 +787,14 @@ interface CommonActorPricingInfo {
696
787
  }
697
788
  /**
698
789
  * Pricing information for free Actors.
790
+ * @since Added in 2.11.1
699
791
  */
700
792
  export interface FreeActorPricingInfo extends CommonActorPricingInfo {
701
793
  pricingModel: 'FREE';
702
794
  }
703
795
  /**
704
796
  * Pricing information for Actors with a flat monthly subscription fee.
797
+ * @since Added in 2.11.1
705
798
  */
706
799
  export interface FlatPricePerMonthActorPricingInfo extends CommonActorPricingInfo {
707
800
  pricingModel: 'FLAT_PRICE_PER_MONTH';
@@ -714,6 +807,7 @@ export interface FlatPricePerMonthActorPricingInfo extends CommonActorPricingInf
714
807
  * Pricing information for pay-per-result Actors.
715
808
  *
716
809
  * These Actors charge based on the number of items saved to the dataset.
810
+ * @since Added in 2.11.1
717
811
  */
718
812
  export interface PricePerDatasetItemActorPricingInfo extends CommonActorPricingInfo {
719
813
  pricingModel: 'PRICE_PER_DATASET_ITEM';
@@ -723,6 +817,7 @@ export interface PricePerDatasetItemActorPricingInfo extends CommonActorPricingI
723
817
  }
724
818
  /**
725
819
  * Definition of a chargeable event for pay-per-event Actors.
820
+ * @since Added in 2.11.1
726
821
  */
727
822
  export interface ActorChargeEvent {
728
823
  eventPriceUsd: number;
@@ -731,12 +826,14 @@ export interface ActorChargeEvent {
731
826
  }
732
827
  /**
733
828
  * Mapping of event names to their pricing information.
829
+ * @since Added in 2.11.1
734
830
  */
735
831
  export type ActorChargeEvents = Record<string, ActorChargeEvent>;
736
832
  /**
737
833
  * Pricing information for pay-per-event Actors.
738
834
  *
739
835
  * These Actors charge based on specific events (e.g., emails sent, API calls made).
836
+ * @since Added in 2.11.1
740
837
  */
741
838
  export interface PricePerEventActorPricingInfo extends CommonActorPricingInfo {
742
839
  pricingModel: 'PAY_PER_EVENT';
@@ -747,6 +844,7 @@ export interface PricePerEventActorPricingInfo extends CommonActorPricingInfo {
747
844
  }
748
845
  /**
749
846
  * Union type representing all possible Actor pricing models.
847
+ * @since Added in 2.11.1
750
848
  */
751
849
  export type ActorRunPricingInfo = PricePerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo;
752
850
  export {};
@@ -247,6 +247,7 @@ class ActorClient extends resource_client_1.ResourceClient {
247
247
  * { build: 'beta' },
248
248
  * );
249
249
  * ```
250
+ * @since Added in 2.24.0
250
251
  */
251
252
  async validateInput(input, options = {}) {
252
253
  // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf
@@ -342,6 +343,7 @@ class ActorClient extends resource_client_1.ResourceClient {
342
343
  * const buildClient = await client.actor('my-actor').defaultBuild({ waitForFinish: 60 });
343
344
  * const build = await buildClient.get();
344
345
  * ```
346
+ * @since Added in 2.12.2
345
347
  */
346
348
  async defaultBuild(options = {}) {
347
349
  const response = await this.httpClient.call({
@@ -62,6 +62,9 @@ export declare class ActorCollectionClient extends ResourceCollectionClient {
62
62
  */
63
63
  create(actor: ActorCollectionCreateOptions): Promise<Actor>;
64
64
  }
65
+ /**
66
+ * @since Added in 2.12.6
67
+ */
65
68
  export declare enum ActorListSortBy {
66
69
  CREATED_AT = "createdAt",
67
70
  LAST_RUN_STARTED_AT = "stats.lastRunStartedAt"
@@ -69,6 +72,9 @@ export declare enum ActorListSortBy {
69
72
  export interface ActorCollectionListOptions extends PaginationOptions {
70
73
  my?: boolean;
71
74
  desc?: boolean;
75
+ /**
76
+ * @since Added in 2.12.6
77
+ */
72
78
  sortBy?: ActorListSortBy;
73
79
  }
74
80
  export interface ActorCollectionListItem {
@@ -80,21 +86,45 @@ export interface ActorCollectionListItem {
80
86
  }
81
87
  export type ActorCollectionListResult = PaginatedList<ActorCollectionListItem>;
82
88
  export interface ActorCollectionCreateOptions {
89
+ /**
90
+ * @since Added in 2.8.6
91
+ */
83
92
  categories?: string[];
93
+ /**
94
+ * @since Added in 2.8.6
95
+ */
84
96
  defaultRunOptions?: ActorDefaultRunOptions;
85
97
  description?: string;
98
+ /**
99
+ * @since Added in 2.8.6
100
+ */
86
101
  exampleRunInput?: ActorExampleRunInput;
102
+ /**
103
+ * @since Added in 2.8.6
104
+ */
87
105
  isDeprecated?: boolean;
88
106
  isPublic?: boolean;
89
107
  name?: string;
90
108
  /** @deprecated Use defaultRunOptions.restartOnError instead */
91
109
  restartOnError?: boolean;
110
+ /**
111
+ * @since Added in 2.8.6
112
+ */
92
113
  seoTitle?: string;
114
+ /**
115
+ * @since Added in 2.8.6
116
+ */
93
117
  seoDescription?: string;
94
118
  title?: string;
95
119
  versions?: ActorVersion[];
120
+ /**
121
+ * @since Added in 2.9.5
122
+ */
96
123
  actorStandby?: ActorStandby & {
97
124
  isEnabled: boolean;
98
125
  };
126
+ /**
127
+ * @since Added in next
128
+ */
99
129
  actorPermissionLevel?: ACTOR_PERMISSION_LEVEL;
100
130
  }
@@ -80,6 +80,9 @@ class ActorCollectionClient extends resource_collection_client_1.ResourceCollect
80
80
  }
81
81
  }
82
82
  exports.ActorCollectionClient = ActorCollectionClient;
83
+ /**
84
+ * @since Added in 2.12.6
85
+ */
83
86
  var ActorListSortBy;
84
87
  (function (ActorListSortBy) {
85
88
  ActorListSortBy["CREATED_AT"] = "createdAt";
@@ -22,6 +22,7 @@ import type { ActorEnvironmentVariable } from './actor_version';
22
22
  * ```
23
23
  *
24
24
  * @see https://docs.apify.com/platform/actors/development/programming-interface/environment-variables
25
+ * @since Added in 2.1.0
25
26
  */
26
27
  export declare class ActorEnvVarClient extends ResourceClient {
27
28
  /**
@@ -25,6 +25,7 @@ const resource_client_1 = require("../base/resource_client");
25
25
  * ```
26
26
  *
27
27
  * @see https://docs.apify.com/platform/actors/development/programming-interface/environment-variables
28
+ * @since Added in 2.1.0
28
29
  */
29
30
  class ActorEnvVarClient extends resource_client_1.ResourceClient {
30
31
  /**
@@ -27,6 +27,7 @@ import type { ActorEnvironmentVariable } from './actor_version';
27
27
  * ```
28
28
  *
29
29
  * @see https://docs.apify.com/platform/actors/development/programming-interface/environment-variables
30
+ * @since Added in 2.1.0
30
31
  */
31
32
  export declare class ActorEnvVarCollectionClient extends ResourceCollectionClient {
32
33
  /**
@@ -65,8 +66,12 @@ export declare class ActorEnvVarCollectionClient extends ResourceCollectionClien
65
66
  /**
66
67
  * @deprecated No options are used in the current API implementation.
67
68
  * https://github.com/apify/apify-client-js/issues/799
69
+ * @since Added in 2.1.0
68
70
  */
69
71
  export interface ActorEnvVarCollectionListOptions extends PaginationOptions {
70
72
  desc?: boolean;
71
73
  }
74
+ /**
75
+ * @since Added in 2.1.0
76
+ */
72
77
  export type ActorEnvVarListResult = Pick<PaginatedList<ActorEnvironmentVariable>, 'total' | 'items'>;
@@ -29,6 +29,7 @@ const resource_collection_client_1 = require("../base/resource_collection_client
29
29
  * ```
30
30
  *
31
31
  * @see https://docs.apify.com/platform/actors/development/programming-interface/environment-variables
32
+ * @since Added in 2.1.0
32
33
  */
33
34
  class ActorEnvVarCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
34
35
  /**
@@ -55,6 +55,7 @@ export declare class ActorVersionClient extends ResourceClient {
55
55
  * @param envVarName - Name of the environment variable.
56
56
  * @returns A client for the environment variable.
57
57
  * @see https://docs.apify.com/api/v2/act-version-env-var-get
58
+ * @since Added in 2.1.0
58
59
  */
59
60
  envVar(envVarName: string): ActorEnvVarClient;
60
61
  /**
@@ -62,6 +63,7 @@ export declare class ActorVersionClient extends ResourceClient {
62
63
  *
63
64
  * @returns A client for the Actor version's environment variables.
64
65
  * @see https://docs.apify.com/api/v2/act-version-env-vars-get
66
+ * @since Added in 2.1.0
65
67
  */
66
68
  envVars(): ActorEnvVarCollectionClient;
67
69
  }
@@ -72,6 +74,9 @@ export interface BaseActorVersion<SourceType extends ActorSourceType> {
72
74
  applyEnvVarsToBuild?: boolean;
73
75
  buildTag?: string;
74
76
  }
77
+ /**
78
+ * @since Added in 2.6.1
79
+ */
75
80
  export interface ActorVersionSourceFiles extends BaseActorVersion<ActorSourceType.SourceFiles> {
76
81
  sourceFiles: ActorVersionSourceFile[];
77
82
  }
@@ -71,6 +71,7 @@ class ActorVersionClient extends resource_client_1.ResourceClient {
71
71
  * @param envVarName - Name of the environment variable.
72
72
  * @returns A client for the environment variable.
73
73
  * @see https://docs.apify.com/api/v2/act-version-env-var-get
74
+ * @since Added in 2.1.0
74
75
  */
75
76
  envVar(envVarName) {
76
77
  (0, ow_1.default)(envVarName, ow_1.default.string);
@@ -83,6 +84,7 @@ class ActorVersionClient extends resource_client_1.ResourceClient {
83
84
  *
84
85
  * @returns A client for the Actor version's environment variables.
85
86
  * @see https://docs.apify.com/api/v2/act-version-env-vars-get
87
+ * @since Added in 2.1.0
86
88
  */
87
89
  envVars() {
88
90
  return new actor_env_var_collection_1.ActorEnvVarCollectionClient(this._subResourceOptions());
@@ -68,6 +68,7 @@ export declare class BuildClient extends ResourceClient {
68
68
  * Deletes the Actor build.
69
69
  *
70
70
  * @see https://docs.apify.com/api/v2/actor-build-delete
71
+ * @since Added in 2.8.1
71
72
  */
72
73
  delete(): Promise<void>;
73
74
  /**
@@ -75,6 +76,7 @@ export declare class BuildClient extends ResourceClient {
75
76
  *
76
77
  * @returns The OpenAPI definition object.
77
78
  * @see https://docs.apify.com/api/v2/actor-build-openapi-json-get
79
+ * @since Added in 2.11.2
78
80
  */
79
81
  getOpenApiDefinition(): Promise<OpenApiDefinition>;
80
82
  /**
@@ -120,6 +122,7 @@ export declare class BuildClient extends ResourceClient {
120
122
  * const log = await client.build('build-id').log().get();
121
123
  * console.log(log);
122
124
  * ```
125
+ * @since Added in 2.9.0
123
126
  */
124
127
  log(): LogClient;
125
128
  }
@@ -173,13 +176,26 @@ export interface Build {
173
176
  */
174
177
  readme?: string;
175
178
  buildNumber: string;
179
+ /**
180
+ * @since Added in 2.7.2
181
+ */
176
182
  usage?: BuildUsage;
183
+ /**
184
+ * @since Added in 2.7.2
185
+ */
177
186
  usageTotalUsd?: number;
187
+ /**
188
+ * @since Added in 2.7.2
189
+ */
178
190
  usageUsd?: BuildUsage;
191
+ /**
192
+ * @since Added in 2.11.0
193
+ */
179
194
  actorDefinition?: ActorDefinition;
180
195
  }
181
196
  /**
182
197
  * Resource usage for an Actor build.
198
+ * @since Added in 2.7.2
183
199
  */
184
200
  export interface BuildUsage {
185
201
  ACTOR_COMPUTE_UNITS?: number;
@@ -206,6 +222,7 @@ export interface BuildOptions {
206
222
  *
207
223
  * Defines the Actor's API interface in OpenAPI 3.0 format, useful for integration
208
224
  * with tools like ChatGPT plugins and other API consumers.
225
+ * @since Added in 2.11.2
209
226
  */
210
227
  export interface OpenApiDefinition {
211
228
  openapi: string;
@@ -88,6 +88,7 @@ class BuildClient extends resource_client_1.ResourceClient {
88
88
  * Deletes the Actor build.
89
89
  *
90
90
  * @see https://docs.apify.com/api/v2/actor-build-delete
91
+ * @since Added in 2.8.1
91
92
  */
92
93
  async delete() {
93
94
  return this._delete();
@@ -97,6 +98,7 @@ class BuildClient extends resource_client_1.ResourceClient {
97
98
  *
98
99
  * @returns The OpenAPI definition object.
99
100
  * @see https://docs.apify.com/api/v2/actor-build-openapi-json-get
101
+ * @since Added in 2.11.2
100
102
  */
101
103
  async getOpenApiDefinition() {
102
104
  const response = await this.httpClient.call({
@@ -154,6 +156,7 @@ class BuildClient extends resource_client_1.ResourceClient {
154
156
  * const log = await client.build('build-id').log().get();
155
157
  * console.log(log);
156
158
  * ```
159
+ * @since Added in 2.9.0
157
160
  */
158
161
  log() {
159
162
  return new log_1.LogClient(this._subResourceOptions({
@@ -184,6 +184,7 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
184
184
  *
185
185
  * @returns Dataset statistics, or `undefined` if not available
186
186
  * @see https://docs.apify.com/api/v2/dataset-statistics-get
187
+ * @since Added in 2.11.2
187
188
  */
188
189
  getStatistics(): Promise<DatasetStatistics | undefined>;
189
190
  /**
@@ -216,6 +217,7 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
216
217
  * skipEmpty: true
217
218
  * });
218
219
  * ```
220
+ * @since Added in 2.13.0
219
221
  */
220
222
  createItemsPublicUrl(options?: DatasetClientCreateItemsUrlOptions): Promise<string>;
221
223
  private _createPaginationList;
@@ -229,8 +231,14 @@ export declare class DatasetClient<Data extends Record<string | number, any> = R
229
231
  export interface Dataset {
230
232
  id: string;
231
233
  name?: string;
234
+ /**
235
+ * @since Added in 2.6.1
236
+ */
232
237
  title?: string;
233
238
  userId: string;
239
+ /**
240
+ * @since Added in 2.21.0
241
+ */
234
242
  username?: string;
235
243
  createdAt: Date;
236
244
  modifiedAt: Date;
@@ -241,8 +249,17 @@ export interface Dataset {
241
249
  actRunId?: string;
242
250
  stats: DatasetStats;
243
251
  fields: string[];
252
+ /**
253
+ * @since Added in 2.12.2
254
+ */
244
255
  generalAccess?: STORAGE_GENERAL_ACCESS | null;
256
+ /**
257
+ * @since Added in 2.13.0
258
+ */
245
259
  urlSigningSecretKey?: string | null;
260
+ /**
261
+ * @since Added in 2.13.0
262
+ */
246
263
  itemsPublicUrl: string;
247
264
  }
248
265
  /**
@@ -259,7 +276,13 @@ export interface DatasetStats {
259
276
  */
260
277
  export interface DatasetClientUpdateOptions {
261
278
  name?: string | null;
279
+ /**
280
+ * @since Added in 2.6.1
281
+ */
262
282
  title?: string;
283
+ /**
284
+ * @since Added in 2.12.2
285
+ */
263
286
  generalAccess?: STORAGE_GENERAL_ACCESS | null;
264
287
  }
265
288
  /**
@@ -271,19 +294,29 @@ export interface DatasetClientUpdateOptions {
271
294
  export interface DatasetClientListItemOptions extends PaginationOptions {
272
295
  clean?: boolean;
273
296
  desc?: boolean;
297
+ /**
298
+ * @since Added in 2.6.1
299
+ */
274
300
  flatten?: string[];
275
301
  fields?: string[];
276
302
  omit?: string[];
277
303
  skipEmpty?: boolean;
278
304
  skipHidden?: boolean;
279
305
  unwind?: string | string[];
306
+ /**
307
+ * @since Added in 2.2.0
308
+ */
280
309
  view?: string;
310
+ /**
311
+ * @since Added in 2.13.0
312
+ */
281
313
  signature?: string;
282
314
  }
283
315
  /**
284
316
  * Options for creating a public URL to access dataset items.
285
317
  *
286
318
  * Extends {@link DatasetClientListItemOptions} with URL expiration control.
319
+ * @since Added in 2.16.0
287
320
  */
288
321
  export interface DatasetClientCreateItemsUrlOptions extends DatasetClientListItemOptions {
289
322
  expiresInSecs?: number;
@@ -317,12 +350,14 @@ export interface DatasetClientDownloadItemsOptions extends DatasetClientListItem
317
350
  * Statistical information about dataset fields.
318
351
  *
319
352
  * Provides insights into the data structure and content of the dataset.
353
+ * @since Added in 2.11.2
320
354
  */
321
355
  export interface DatasetStatistics {
322
356
  fieldStatistics: Record<string, FieldStatistics>;
323
357
  }
324
358
  /**
325
359
  * Statistics for a single field in a dataset.
360
+ * @since Added in 2.11.2
326
361
  */
327
362
  export interface FieldStatistics {
328
363
  min?: number;