From b19e7d82b3825a8c11ea342c2e9e2e5547ceba1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jind=C5=99ich=20B=C3=A4r?= Date: Thu, 11 Jun 2026 14:20:08 +0200 Subject: [PATCH 1/5] docs: add `@since` TypeDoc tags, drop versioned documentation --- pnpm-lock.yaml | 2 +- src/apify_api_error.ts | 12 + src/apify_client.ts | 80 +- src/base/api_client.ts | 27 + src/interceptors.ts | 10 + src/resource_clients/actor.ts | 626 +- src/resource_clients/actor_collection.ts | 89 +- src/resource_clients/actor_env_var.ts | 4 + .../actor_env_var_collection.ts | 10 + src/resource_clients/actor_version.ts | 93 + .../actor_version_collection.ts | 10 + src/resource_clients/build.ts | 111 + src/resource_clients/build_collection.ts | 14 + src/resource_clients/dataset.ts | 177 + src/resource_clients/dataset_collection.ts | 26 +- src/resource_clients/key_value_store.ts | 157 + .../key_value_store_collection.ts | 26 +- src/resource_clients/log.ts | 36 +- src/resource_clients/request_queue.ts | 317 +- .../request_queue_collection.ts | 20 +- src/resource_clients/run.ts | 84 +- src/resource_clients/run_collection.ts | 17 + src/resource_clients/schedule.ts | 103 + src/resource_clients/schedule_collection.ts | 9 + src/resource_clients/store_collection.ts | 65 +- src/resource_clients/task.ts | 78 + src/resource_clients/task_collection.ts | 18 + src/resource_clients/user.ts | 263 + src/resource_clients/webhook.ts | 89 + src/resource_clients/webhook_collection.ts | 11 + src/resource_clients/webhook_dispatch.ts | 77 + .../webhook_dispatch_collection.ts | 8 + src/utils.ts | 43 +- website/docusaurus.config.js | 13 - website/package.json | 2 +- website/versioned_docs/version-2/.gitignore | 1 - .../version-2/01_introduction/index.md | 90 - .../version-2/01_introduction/quick-start.md | 86 - .../02_concepts/01_usage-patterns.md | 71 - .../02_concepts/02_error-handling.md | 42 - .../02_concepts/03_convenience-functions.md | 24 - .../version-2/02_concepts/04_pagination.md | 33 - .../02_concepts/05_bundled-environments.md | 22 - .../version-2/03_guides/01_examples.md | 152 - .../version-2/api-packages.json | 1 - .../versioned_docs/version-2/api-typedoc.json | 74625 ---------------- .../version-2-sidebars.json | 34 - website/versions.json | 3 - 48 files changed, 2630 insertions(+), 75281 deletions(-) delete mode 100644 website/versioned_docs/version-2/.gitignore delete mode 100644 website/versioned_docs/version-2/01_introduction/index.md delete mode 100644 website/versioned_docs/version-2/01_introduction/quick-start.md delete mode 100644 website/versioned_docs/version-2/02_concepts/01_usage-patterns.md delete mode 100644 website/versioned_docs/version-2/02_concepts/02_error-handling.md delete mode 100644 website/versioned_docs/version-2/02_concepts/03_convenience-functions.md delete mode 100644 website/versioned_docs/version-2/02_concepts/04_pagination.md delete mode 100644 website/versioned_docs/version-2/02_concepts/05_bundled-environments.md delete mode 100644 website/versioned_docs/version-2/03_guides/01_examples.md delete mode 100644 website/versioned_docs/version-2/api-packages.json delete mode 100644 website/versioned_docs/version-2/api-typedoc.json delete mode 100644 website/versioned_sidebars/version-2-sidebars.json delete mode 100644 website/versions.json diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f6f297173..8410b0321 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -139,7 +139,7 @@ importers: specifier: ^1.0.251 version: 1.0.251(959f6a77c61b01e5801039cc98a02b4a) '@apify/docusaurus-plugin-typedoc-api': - specifier: ^5.1.6 + specifier: ^5.1.11 version: 5.1.11(2fce7341730efb937c1d18fab5517614) '@docusaurus/core': specifier: ^3.8.1 diff --git a/src/apify_api_error.ts b/src/apify_api_error.ts index 13847ef59..eb240dd4b 100644 --- a/src/apify_api_error.ts +++ b/src/apify_api_error.ts @@ -20,49 +20,61 @@ const CLIENT_METHOD_REGEX = /at( async)? ([A-Za-z]+(Collection)?Client)\._?([A-Z * errors and internal errors, which are automatically retried, or validation * errors, which are thrown immediately, because a correction by the user is * needed. + * @since Added in 1.0.0 */ export class ApifyApiError extends Error { + /** + * @since Added in 2.0.1 + */ override name: string; /** * The invoked resource client and the method. Known issue: Sometimes it displays * as `unknown` because it can't be parsed from a stack trace. + * @since Added in 2.0.1 */ clientMethod: string; /** * HTTP status code of the error. + * @since Added in 2.0.1 */ statusCode: number; /** * The type of the error, as returned by the API. + * @since Added in 2.0.1 */ type?: string; /** * Number of the API call attempt. + * @since Added in 2.0.1 */ attempt: number; /** * HTTP method of the API call. + * @since Added in 2.0.1 */ httpMethod?: string; /** * Full path of the API endpoint (URL excluding origin). + * @since Added in 2.0.1 */ path?: string; /** * Original stack trace of the exception. It is replaced * by a more informative stack with API call information. + * @since Added in 2.0.1 */ originalStack: string; /** * Additional data provided by the API about the error + * @since Added in 2.0.1 */ data?: Record; diff --git a/src/apify_client.ts b/src/apify_client.ts index 50b32db02..e26ddb338 100644 --- a/src/apify_client.ts +++ b/src/apify_client.ts @@ -55,18 +55,37 @@ const DEFAULT_TIMEOUT_SECS = 360; * ``` * * @see https://docs.apify.com/api/v2 + * @since Added in 0.0.3 */ export class ApifyClient { + /** + * @since Added in 2.0.1 + */ baseUrl: string; + /** + * @since Added in 2.17.0 + */ publicBaseUrl: string; + /** + * @since Added in 2.0.1 + */ token?: string; + /** + * @since Added in 2.0.1 + */ stats: Statistics; + /** + * @since Added in 2.0.1 + */ logger: Log; + /** + * @since Added in 2.0.1 + */ httpClient: HttpClient; constructor(options: ApifyClientOptions = {}) { @@ -131,6 +150,7 @@ export class ApifyClient { * * @returns A client for the Actors collection * @see https://docs.apify.com/api/v2/acts-get + * @since Added in 2.0.1 */ actors(): ActorCollectionClient { return new ActorCollectionClient(this._options()); @@ -151,6 +171,7 @@ export class ApifyClient { * // Call an Actor and wait for it to finish * const run = await client.actor('apify/web-scraper').call({ url: 'https://example.com' }); * ``` + * @since Added in 2.0.1 */ actor(id: string): ActorClient { ow(id, ow.string.nonEmpty); @@ -168,6 +189,7 @@ export class ApifyClient { * * @returns A client for Actor builds collection * @see https://docs.apify.com/api/v2/actor-builds-get + * @since Added in 2.0.1 */ builds(): BuildCollectionClient { return new BuildCollectionClient(this._options()); @@ -181,6 +203,7 @@ export class ApifyClient { * @param id - Build ID * @returns A client for the specified build * @see https://docs.apify.com/api/v2/actor-build-get + * @since Added in 2.0.1 */ build(id: string): BuildClient { ow(id, ow.string.nonEmpty); @@ -198,6 +221,7 @@ export class ApifyClient { * * @returns A client for the Datasets collection * @see https://docs.apify.com/api/v2/datasets-get + * @since Added in 2.0.1 */ datasets(): DatasetCollectionClient { return new DatasetCollectionClient(this._options()); @@ -225,6 +249,7 @@ export class ApifyClient { * // Retrieve items * const { items } = await client.dataset('my-dataset').listItems(); * ``` + * @since Added in 2.0.1 */ dataset = Record>( id: string, @@ -244,6 +269,7 @@ export class ApifyClient { * * @returns A client for the Key-value stores collection * @see https://docs.apify.com/api/v2/key-value-stores-get + * @since Added in 2.0.1 */ keyValueStores(): KeyValueStoreCollectionClient { return new KeyValueStoreCollectionClient(this._options()); @@ -267,6 +293,7 @@ export class ApifyClient { * // Get a record * const record = await client.keyValueStore('my-store').getRecord('OUTPUT'); * ``` + * @since Added in 2.0.1 */ keyValueStore(id: string): KeyValueStoreClient { ow(id, ow.string.nonEmpty); @@ -283,6 +310,7 @@ export class ApifyClient { * @param buildOrRunId - Build ID or run ID * @returns A client for accessing logs * @see https://docs.apify.com/api/v2/log-get + * @since Added in 2.0.1 */ log(buildOrRunId: string): LogClient { ow(buildOrRunId, ow.string.nonEmpty); @@ -300,6 +328,7 @@ export class ApifyClient { * * @returns A client for the Request queues collection * @see https://docs.apify.com/api/v2/request-queues-get + * @since Added in 2.0.1 */ requestQueues(): RequestQueueCollectionClient { return new RequestQueueCollectionClient(this._options()); @@ -325,6 +354,7 @@ export class ApifyClient { * // Get and lock the next request * const { items } = await queue.listAndLockHead({ lockSecs: 60 }); * ``` + * @since Added in 2.0.1 */ requestQueue(id: string, options: RequestQueueUserOptions = {}): RequestQueueClient { ow(id, ow.string.nonEmpty); @@ -350,6 +380,7 @@ export class ApifyClient { * * @returns A client for the run collection * @see https://docs.apify.com/api/v2/actor-runs-get + * @since Added in 2.0.1 */ runs(): RunCollectionClient { return new RunCollectionClient({ @@ -376,6 +407,7 @@ export class ApifyClient { * // Access run's dataset * const { items } = await client.run('run-id').dataset().listItems(); * ``` + * @since Added in 2.0.1 */ run(id: string): RunClient { ow(id, ow.string.nonEmpty); @@ -393,6 +425,7 @@ export class ApifyClient { * * @returns A client for the task collection * @see https://docs.apify.com/api/v2/actor-tasks-get + * @since Added in 2.0.1 */ tasks(): TaskCollectionClient { return new TaskCollectionClient(this._options()); @@ -412,6 +445,7 @@ export class ApifyClient { * // Run a task and wait for it to finish * const run = await client.task('my-task').call(); * ``` + * @since Added in 2.0.1 */ task(id: string): TaskClient { ow(id, ow.string.nonEmpty); @@ -429,6 +463,7 @@ export class ApifyClient { * * @returns A client for the Schedules collection * @see https://docs.apify.com/api/v2/schedules-get + * @since Added in 2.0.1 */ schedules(): ScheduleCollectionClient { return new ScheduleCollectionClient(this._options()); @@ -442,6 +477,7 @@ export class ApifyClient { * @param id - Schedule ID * @returns A client for the specific Schedule * @see https://docs.apify.com/api/v2/schedule-get + * @since Added in 2.0.1 */ schedule(id: string): ScheduleClient { ow(id, ow.string.nonEmpty); @@ -460,6 +496,7 @@ export class ApifyClient { * @param id - User ID or username. Defaults to 'me' (current user) * @returns A client for the user * @see https://docs.apify.com/api/v2/user-get + * @since Added in 2.0.1 */ user(id = ME_USER_NAME_PLACEHOLDER): UserClient { ow(id, ow.string.nonEmpty); @@ -477,6 +514,7 @@ export class ApifyClient { * * @returns A client for the Webhooks collection * @see https://docs.apify.com/api/v2/webhooks-get + * @since Added in 2.0.1 */ webhooks(): WebhookCollectionClient { return new WebhookCollectionClient(this._options()); @@ -490,6 +528,7 @@ export class ApifyClient { * @param id - Webhook ID * @returns A client for the specific webhook * @see https://docs.apify.com/api/v2/webhook-get + * @since Added in 2.0.1 */ webhook(id: string): WebhookClient { ow(id, ow.string.nonEmpty); @@ -507,6 +546,7 @@ export class ApifyClient { * * @returns A client for the webhook dispatches collection * @see https://docs.apify.com/api/v2/webhook-dispatches-get + * @since Added in 2.0.1 */ webhookDispatches(): WebhookDispatchCollectionClient { return new WebhookDispatchCollectionClient(this._options()); @@ -518,6 +558,7 @@ export class ApifyClient { * @param id - Webhook dispatch ID * @returns A client for the specific webhook dispatch * @see https://docs.apify.com/api/v2/webhook-dispatch-get + * @since Added in 2.0.1 */ webhookDispatch(id: string): WebhookDispatchClient { ow(id, ow.string.nonEmpty); @@ -535,6 +576,7 @@ export class ApifyClient { * * @returns A client for the Apify Store * @see https://docs.apify.com/api/v2/store-get + * @since Added in 2.0.1 */ store(): StoreCollectionClient { return new StoreCollectionClient(this._options()); @@ -549,6 +591,7 @@ export class ApifyClient { * @param message - The status message to set * @param options - Additional options for the status message * @throws {Error} If `ACTOR_RUN_ID` environment variable is not set + * @since Added in 2.7.0 */ async setStatusMessage(message: string, options?: SetStatusMessageOptions): Promise { const runId = process.env[ACTOR_ENV_VARS.RUN_ID]; @@ -564,20 +607,45 @@ export class ApifyClient { /** * Configuration options for ApifyClient. + * @since Added in 2.0.1 */ export interface ApifyClientOptions { - /** @default https://api.apify.com */ + /** + * @default https://api.apify.com + * @since Added in 2.0.1 + */ baseUrl?: string; - /** @default https://api.apify.com */ + /** + * @default https://api.apify.com + * @since Added in 2.17.0 + */ publicBaseUrl?: string; - /** @default 8 */ + /** + * @default 8 + * @since Added in 2.0.1 + */ maxRetries?: number; - /** @default 500 */ + /** + * @default 500 + * @since Added in 2.0.1 + */ minDelayBetweenRetriesMillis?: number; - /** @default [] */ + /** + * @default [] + * @since Added in 2.0.1 + */ requestInterceptors?: RequestInterceptorFunction[]; - /** @default 360 */ + /** + * @default 360 + * @since Added in 2.0.1 + */ timeoutSecs?: number; + /** + * @since Added in 2.0.1 + */ token?: string; + /** + * @since Added in 2.10.0 + */ userAgentSuffix?: string | string[]; } diff --git a/src/base/api_client.ts b/src/base/api_client.ts index e201886a2..dd6079849 100644 --- a/src/base/api_client.ts +++ b/src/base/api_client.ts @@ -21,22 +21,49 @@ export type ApiClientSubResourceOptions = Omit /** @private */ export abstract class ApiClient { + /** + * @since Added in 2.0.1 + */ id?: string; + /** + * @since Added in 2.0.1 + */ safeId?: string; + /** + * @since Added in 2.0.1 + */ baseUrl: string; + /** + * @since Added in 2.17.0 + */ publicBaseUrl: string; + /** + * @since Added in 2.0.1 + */ resourcePath: string; + /** + * @since Added in 2.0.1 + */ url: string; + /** + * @since Added in 2.0.1 + */ apifyClient: ApifyClient; + /** + * @since Added in 2.0.1 + */ httpClient: HttpClient; + /** + * @since Added in 2.0.1 + */ params?: Record; constructor(options: ApiClientOptions) { diff --git a/src/interceptors.ts b/src/interceptors.ts index 4229ff3e0..6c267d722 100644 --- a/src/interceptors.ts +++ b/src/interceptors.ts @@ -13,12 +13,22 @@ import { isNode, maybeGzipValue } from './utils'; * request. We do that by identifying this error in HttpClient. * * The properties mimic AxiosError for easier integration in HttpClient error handling. + * @since Added in 1.0.0 */ export class InvalidResponseBodyError extends Error { + /** + * @since Added in 2.0.1 + */ code: string; + /** + * @since Added in 2.0.1 + */ response: AxiosResponse; + /** + * @since Added in 2.0.1 + */ declare cause: Error; constructor(response: AxiosResponse, cause: Error) { diff --git a/src/resource_clients/actor.ts b/src/resource_clients/actor.ts index 6dec88af0..77d335490 100644 --- a/src/resource_clients/actor.ts +++ b/src/resource_clients/actor.ts @@ -38,6 +38,7 @@ import { WebhookCollectionClient } from './webhook_collection'; * ``` * * @see https://docs.apify.com/platform/actors + * @since Added in 1.0.0 */ export class ActorClient extends ResourceClient { /** @@ -55,6 +56,7 @@ export class ActorClient extends ResourceClient { * * @returns The Actor object, or `undefined` if it does not exist * @see https://docs.apify.com/api/v2/act-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -66,6 +68,7 @@ export class ActorClient extends ResourceClient { * @param newFields - Fields to update in the Actor * @returns The updated Actor object * @see https://docs.apify.com/api/v2/act-put + * @since Added in 2.0.1 */ async update(newFields: ActorUpdateOptions): Promise { ow(newFields, ow.object); @@ -77,6 +80,7 @@ export class ActorClient extends ResourceClient { * Deletes the Actor. * * @see https://docs.apify.com/api/v2/act-delete + * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -115,6 +119,7 @@ export class ActorClient extends ResourceClient { * { build: '0.1.2', memory: 512, timeout: 300 } * ); * ``` + * @since Added in 2.0.1 */ async start(input?: unknown, options: ActorStartOptions = {}): Promise { // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf @@ -216,6 +221,7 @@ export class ActorClient extends ResourceClient { * const log = new Log({ prefix: 'My Actor' }); * const run = await client.actor('my-actor').call({ url: 'https://example.com' }, { log }); * ``` + * @since Added in 2.0.1 */ async call(input?: unknown, options: ActorCallOptions = {}): Promise { // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf @@ -283,6 +289,7 @@ export class ActorClient extends ResourceClient { * useCache: true * }); * ``` + * @since Added in 2.0.1 */ async build(versionNumber: string, options: ActorBuildOptions = {}): Promise { ow(versionNumber, ow.string); @@ -331,6 +338,7 @@ export class ActorClient extends ResourceClient { * const buildClient = await client.actor('my-actor').defaultBuild({ waitForFinish: 60 }); * const build = await buildClient.get(); * ``` + * @since Added in 2.12.2 */ async defaultBuild(options: BuildClientGetOptions = {}): Promise { const response = await this.httpClient.call({ @@ -366,6 +374,7 @@ export class ActorClient extends ResourceClient { * // Get the last successful run * const lastRun = await client.actor('my-actor').lastRun({ status: 'SUCCEEDED' }).get(); * ``` + * @since Added in 2.0.1 */ lastRun(options: ActorLastRunOptions = {}): RunClient { ow( @@ -390,6 +399,7 @@ export class ActorClient extends ResourceClient { * * @returns A client for the Actor's build collection * @see https://docs.apify.com/api/v2/act-builds-get + * @since Added in 2.0.1 */ builds(): BuildCollectionClient { return new BuildCollectionClient( @@ -404,6 +414,7 @@ export class ActorClient extends ResourceClient { * * @returns A client for the Actor's run collection * @see https://docs.apify.com/api/v2/act-runs-get + * @since Added in 2.0.1 */ runs(): RunCollectionClient { return new RunCollectionClient( @@ -419,6 +430,7 @@ export class ActorClient extends ResourceClient { * @param versionNumber - Version number (e.g., '0.1', '1.2.3') * @returns A client for the specified Actor version * @see https://docs.apify.com/api/v2/act-version-get + * @since Added in 2.0.1 */ version(versionNumber: string): ActorVersionClient { ow(versionNumber, ow.string); @@ -434,6 +446,7 @@ export class ActorClient extends ResourceClient { * * @returns A client for the Actor's version collection * @see https://docs.apify.com/api/v2/act-versions-get + * @since Added in 2.0.1 */ versions(): ActorVersionCollectionClient { return new ActorVersionCollectionClient(this._subResourceOptions()); @@ -444,6 +457,7 @@ export class ActorClient extends ResourceClient { * * @returns A client for the Actor's webhook collection * @see https://docs.apify.com/api/v2/act-webhooks-get + * @since Added in 2.0.1 */ webhooks(): WebhookCollectionClient { return new WebhookCollectionClient(this._subResourceOptions()); @@ -456,118 +470,251 @@ export class ActorClient extends ResourceClient { * Actors are serverless computing units that can perform arbitrary tasks such as web scraping, * data processing, automation, and more. Each Actor has versions, builds, and can be executed * with different configurations. + * @since Added in 0.5.0 */ export interface Actor { - /** Unique Actor ID */ + /** + * Unique Actor ID + * @since Added in 2.0.1 + */ id: string; - /** ID of the user who owns the Actor */ + /** + * ID of the user who owns the Actor + * @since Added in 2.0.1 + */ userId: string; - /** Unique name of the Actor (used in API paths, e.g., 'my-actor') */ + /** + * Unique name of the Actor (used in API paths, e.g., 'my-actor') + * @since Added in 2.0.1 + */ name: string; - /** Username of the Actor's owner */ + /** + * Username of the Actor's owner + * @since Added in 2.0.1 + */ username: string; - /** Detailed description of what the Actor does */ + /** + * Detailed description of what the Actor does + * @since Added in 2.0.1 + */ description?: string; - /** @deprecated Use defaultRunOptions.restartOnError instead */ + /** + * @deprecated Use defaultRunOptions.restartOnError instead + * @since Added in 2.0.1 + */ restartOnError?: boolean; - /** Whether the Actor is publicly available in Apify Store */ + /** + * Whether the Actor is publicly available in Apify Store + * @since Added in 2.0.1 + */ isPublic: boolean; - /** Whether the Actor can be run by anonymous users without authentication */ + /** + * Whether the Actor can be run by anonymous users without authentication + * @since Added in 2.0.1 + */ isAnonymouslyRunnable?: boolean; - /** Timestamp when the Actor was created */ + /** + * Timestamp when the Actor was created + * @since Added in 2.0.1 + */ createdAt: Date; - /** Timestamp when the Actor was last modified */ + /** + * Timestamp when the Actor was last modified + * @since Added in 2.0.1 + */ modifiedAt: Date; - /** Usage and run statistics for the Actor */ + /** + * Usage and run statistics for the Actor + * @since Added in 2.0.1 + */ stats: ActorStats; - /** All versions of this Actor */ + /** + * All versions of this Actor + * @since Added in 2.0.1 + */ versions: ActorVersion[]; - /** Pricing information for pay-per-result or pay-per-event Actors */ + /** + * Pricing information for pay-per-result or pay-per-event Actors + * @since Added in 2.12.4 + */ pricingInfos?: ActorRunPricingInfo[]; - /** Default configuration options for Actor runs */ + /** + * Default configuration options for Actor runs + * @since Added in 2.0.1 + */ defaultRunOptions: ActorDefaultRunOptions; - /** Example input to help users understand how to use the Actor */ + /** + * Example input to help users understand how to use the Actor + * @since Added in 2.0.1 + */ exampleRunInput?: ActorExampleRunInput; - /** Whether the Actor is deprecated and should not be used */ + /** + * Whether the Actor is deprecated and should not be used + * @since Added in 2.0.1 + */ isDeprecated?: boolean; - /** Deployment key used for automated deployments */ + /** + * Deployment key used for automated deployments + * @since Added in 2.0.1 + */ deploymentKey: string; - /** Human-readable title of the Actor (displayed in UI) */ + /** + * Human-readable title of the Actor (displayed in UI) + * @since Added in 2.0.1 + */ title?: string; - /** Mapping of tags to specific builds (e.g., 'latest', 'beta') */ + /** + * Mapping of tags to specific builds (e.g., 'latest', 'beta') + * @since Added in 2.0.1 + */ taggedBuilds?: ActorTaggedBuilds; - /** SEO-optimized title for the Actor's public page */ + /** + * SEO-optimized title for the Actor's public page + * @since Added in 2.6.1 + */ seoTitle?: string; - /** SEO-optimized description for the Actor's public page */ + /** + * SEO-optimized description for the Actor's public page + * @since Added in 2.6.1 + */ seoDescription?: string; - /** Categories the Actor belongs to (e.g., 'ECOMMERCE', 'SCRAPING') */ + /** + * Categories the Actor belongs to (e.g., 'ECOMMERCE', 'SCRAPING') + * @since Added in 2.6.1 + */ categories?: string[]; - /** Standby mode configuration for keeping Actor warm and responsive */ + /** + * Standby mode configuration for keeping Actor warm and responsive + * @since Added in 2.9.5 + */ actorStandby?: ActorStandby & { isEnabled: boolean; }; - /** Permission level of the Actor on Apify platform */ + /** + * Permission level of the Actor on Apify platform + * @since Added in 2.21.0 + */ actorPermissionLevel: ACTOR_PERMISSION_LEVEL; - /** A brief, LLM-generated readme summary */ + /** + * A brief, LLM-generated readme summary + * @since Added in 2.22.1 + */ readmeSummary?: string; } /** * Statistics about Actor usage and activity. + * @since Added in 2.0.1 */ export interface ActorStats { - /** Total number of builds created for this Actor */ + /** + * Total number of builds created for this Actor + * @since Added in 2.0.1 + */ totalBuilds: number; - /** Total number of times this Actor has been run */ + /** + * Total number of times this Actor has been run + * @since Added in 2.0.1 + */ totalRuns: number; - /** Total number of unique users who have run this Actor */ + /** + * Total number of unique users who have run this Actor + * @since Added in 2.0.1 + */ totalUsers: number; - /** Number of unique users in the last 7 days */ + /** + * Number of unique users in the last 7 days + * @since Added in 2.0.1 + */ totalUsers7Days: number; - /** Number of unique users in the last 30 days */ + /** + * Number of unique users in the last 30 days + * @since Added in 2.0.1 + */ totalUsers30Days: number; - /** Number of unique users in the last 90 days */ + /** + * Number of unique users in the last 90 days + * @since Added in 2.0.1 + */ totalUsers90Days: number; - /** Total number of times this Actor was used via metamorph */ + /** + * Total number of times this Actor was used via metamorph + * @since Added in 2.0.1 + */ totalMetamorphs: number; - /** Timestamp when the last run was started */ + /** + * Timestamp when the last run was started + * @since Added in 2.0.1 + */ lastRunStartedAt: Date; } /** * Default configuration options for Actor runs. + * @since Added in 2.0.1 */ export interface ActorDefaultRunOptions { + /** + * @since Added in 2.0.1 + */ build: string; + /** + * @since Added in 2.0.1 + */ timeoutSecs: number; + /** + * @since Added in 2.0.1 + */ memoryMbytes: number; + /** + * @since Added in 2.19.0 + */ restartOnError?: boolean; } /** * Example input data to demonstrate Actor usage. + * @since Added in 2.0.1 */ export interface ActorExampleRunInput { + /** + * @since Added in 2.0.1 + */ body: string; + /** + * @since Added in 2.0.1 + */ contentType: string; } /** * Mapping of build tags (e.g., 'latest', 'beta') to their corresponding build information. + * @since Added in 2.0.1 */ export type ActorTaggedBuilds = Record; /** * Information about a specific tagged build. + * @since Added in 2.0.1 */ export interface ActorTaggedBuild { + /** + * @since Added in 2.0.1 + */ buildId?: string; + /** + * @since Added in 2.0.1 + */ buildNumber?: string; + /** + * @since Added in 2.0.1 + */ finishedAt?: Date; } /** * Fields that can be updated when modifying an Actor. + * @since Added in 2.0.1 */ export type ActorUpdateOptions = Partial< Pick< @@ -594,21 +741,47 @@ export type ActorUpdateOptions = Partial< * * Standby mode keeps Actor containers warm and ready to process requests with minimal latency. * This is useful for Actors that need to respond quickly to incoming requests. + * @since Added in 2.9.5 */ export interface ActorStandby { + /** + * @since Added in 2.9.5 + */ build?: string; + /** + * @since Added in 2.9.5 + */ desiredRequestsPerActorRun?: number; + /** + * @since Added in 2.22.0 + */ disableStandbyFieldsOverride?: boolean; + /** + * @since Added in 2.9.5 + */ idleTimeoutSecs?: number; + /** + * @since Added in 2.9.5 + */ maxRequestsPerActorRun?: number; + /** + * @since Added in 2.9.5 + */ memoryMbytes?: number; + /** + * @since Added in 2.22.0 + */ shouldPassActorInput?: boolean; } +/** + * @since Added in 2.0.1 + */ export interface ActorStartOptions { /** * Tag or number of the Actor build to run (e.g. `beta` or `1.2.345`). * If not provided, the run uses build tag or number from the default Actor run configuration (typically `latest`). + * @since Added in 2.0.1 */ build?: string; @@ -617,17 +790,20 @@ export interface ActorStartOptions { * `input` is expected to be an object that will be stringified to JSON and content type set to * `application/json; charset=utf-8`. If `options.contentType` is specified, then `input` must be a * `String` or `Buffer`. + * @since Added in 2.0.1 */ contentType?: string; /** * Memory in megabytes which will be allocated for the new Actor run. * If not provided, the run uses memory of the default Actor run configuration. + * @since Added in 2.0.1 */ memory?: number; /** * Timeout for the Actor run in seconds. Zero value means there is no timeout. * If not provided, the run uses timeout of the default Actor run configuration. + * @since Added in 2.0.1 */ timeout?: number; @@ -638,6 +814,7 @@ export interface ActorStartOptions { * By default (or when `waitForFinish` is set to `0`), the function resolves immediately without waiting. * The wait is limited to 60s and happens on the API directly, as opposed to the `call` method and its * `waitSecs` option, which is implemented via polling on the client side instead (and has no limit like that). + * @since Added in 2.0.1 */ waitForFinish?: number; @@ -645,6 +822,7 @@ export interface ActorStartOptions { * Specifies optional webhooks associated with the Actor run, which can be used * to receive a notification e.g. when the Actor finished or failed, see * [ad hook webhooks documentation](https://docs.apify.com/webhooks/ad-hoc-webhooks) for detailed description. + * @since Added in 2.0.1 */ webhooks?: readonly WebhookUpdateData[]; @@ -654,6 +832,7 @@ export interface ActorStartOptions { * It only ensures you won't be charged for more than this number of items. * Only works for pay-per-result Actors. * Value can be accessed in the Actor run using `ACTOR_MAX_PAID_DATASET_ITEMS` environment variable. + * @since Added in 2.7.0 */ maxItems?: number; @@ -662,11 +841,13 @@ export interface ActorStartOptions { * used only for pay-per-event Actors. It allows you to limit the amount * charged to your subscription. You can access the maximum cost in your * Actor by using the `ACTOR_MAX_TOTAL_CHARGE_USD` environment variable. + * @since Added in 2.9.7 */ maxTotalChargeUsd?: number; /** * Determines whether the run will be restarted if it fails. + * @since Added in 2.0.1 */ restartOnError?: boolean; @@ -675,6 +856,7 @@ export interface ActorStartOptions { /** * Override the Actor's permissions for this run. If not set, the Actor will run with permissions configured in the * Actor settings. + * @since Added in 2.17.0 */ forcePermissionLevel?: ACTOR_PERMISSION_LEVEL; } @@ -683,16 +865,19 @@ export interface ActorStartOptions { * Options for calling an Actor and waiting for it to finish. * * Extends {@link ActorStartOptions} with additional options for waiting and log streaming. + * @since Added in 2.6.2 */ export interface ActorCallOptions extends Omit { /** * Wait time in seconds for the Actor run to finish. + * @since Added in 2.6.2 */ waitSecs?: number; /** * `Log` instance that should be used to redirect Actor run logs to. * If `undefined` or `'default'` the pre-defined `Log` will be created and used. * If `null`, no log redirection will occur. + * @since Added in 2.20.0 */ log?: Log | null | 'default'; } @@ -701,29 +886,81 @@ export interface ActorCallOptions extends Omit; + /** + * @since Added in 2.12.2 + */ generalAccess?: RUN_GENERAL_ACCESS | null; + /** + * @since Added in 2.22.3 + */ storageIds?: ActorRunStorageIds; } @@ -754,40 +1034,87 @@ export interface ActorRun extends ActorRunListItem { * Resource usage metrics for an Actor run. * * All values represent the total consumption during the run's lifetime. + * @since Added in 2.7.0 */ export interface ActorRunUsage { - /** Compute units consumed (combines CPU and memory usage over time) */ + /** + * Compute units consumed (combines CPU and memory usage over time) + * @since Added in 2.7.0 + */ ACTOR_COMPUTE_UNITS?: number; - /** Number of Dataset read operations */ + /** + * Number of Dataset read operations + * @since Added in 2.7.0 + */ DATASET_READS?: number; - /** Number of Dataset write operations */ + /** + * Number of Dataset write operations + * @since Added in 2.7.0 + */ DATASET_WRITES?: number; - /** Number of key-value store read operations */ + /** + * Number of key-value store read operations + * @since Added in 2.7.0 + */ KEY_VALUE_STORE_READS?: number; - /** Number of key-value store write operations */ + /** + * Number of key-value store write operations + * @since Added in 2.7.0 + */ KEY_VALUE_STORE_WRITES?: number; - /** Number of key-value store list operations */ + /** + * Number of key-value store list operations + * @since Added in 2.7.0 + */ KEY_VALUE_STORE_LISTS?: number; - /** Number of Request queue read operations */ + /** + * Number of Request queue read operations + * @since Added in 2.7.0 + */ REQUEST_QUEUE_READS?: number; - /** Number of Request queue write operations */ + /** + * Number of Request queue write operations + * @since Added in 2.7.0 + */ REQUEST_QUEUE_WRITES?: number; - /** Internal data transfer within Apify platform (in gigabytes) */ + /** + * Internal data transfer within Apify platform (in gigabytes) + * @since Added in 2.7.0 + */ DATA_TRANSFER_INTERNAL_GBYTES?: number; - /** External data transfer to/from internet (in gigabytes) */ + /** + * External data transfer to/from internet (in gigabytes) + * @since Added in 2.7.0 + */ DATA_TRANSFER_EXTERNAL_GBYTES?: number; - /** Residential proxy data transfer (in gigabytes) */ + /** + * Residential proxy data transfer (in gigabytes) + * @since Added in 2.7.0 + */ PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number; - /** Number of SERP (Search Engine Results Page) proxy requests */ + /** + * Number of SERP (Search Engine Results Page) proxy requests + * @since Added in 2.7.0 + */ PROXY_SERPS?: number; } /** * Metadata about how an Actor run was initiated. + * @since Added in 2.0.1 */ export interface ActorRunMeta { + /** + * @since Added in 2.0.1 + */ origin: string; + /** + * @since Added in 2.0.1 + */ clientIp?: string; + /** + * @since Added in 2.0.1 + */ userAgent: string; } @@ -795,22 +1122,68 @@ export interface ActorRunMeta { * Runtime statistics for an Actor run. * * Provides detailed metrics about resource consumption and performance during the run. + * @since Added in 2.0.1 */ export interface ActorRunStats { + /** + * @since Added in 2.0.1 + */ inputBodyLen: number; + /** + * @since Added in 2.0.1 + */ restartCount: number; + /** + * @since Added in 2.0.1 + */ resurrectCount: number; + /** + * @since Added in 2.0.1 + */ memAvgBytes: number; + /** + * @since Added in 2.0.1 + */ memMaxBytes: number; + /** + * @since Added in 2.0.1 + */ memCurrentBytes: number; + /** + * @since Added in 2.0.1 + */ cpuAvgUsage: number; + /** + * @since Added in 2.0.1 + */ cpuMaxUsage: number; + /** + * @since Added in 2.0.1 + */ cpuCurrentUsage: number; + /** + * @since Added in 2.0.1 + */ netRxBytes: number; + /** + * @since Added in 2.0.1 + */ netTxBytes: number; + /** + * @since Added in 2.0.1 + */ durationMillis: number; + /** + * @since Added in 2.0.1 + */ runTimeSecs: number; + /** + * @since Added in 2.0.1 + */ metamorph: number; + /** + * @since Added in 2.0.1 + */ computeUnits: number; } @@ -818,31 +1191,70 @@ export interface ActorRunStats { * Configuration options used for an Actor run. * * These are the actual options that were applied to the run (may differ from requested options). + * @since Added in 2.0.1 */ export interface ActorRunOptions { + /** + * @since Added in 2.0.1 + */ build: string; + /** + * @since Added in 2.0.1 + */ timeoutSecs: number; + /** + * @since Added in 2.0.1 + */ memoryMbytes: number; + /** + * @since Added in 2.0.1 + */ diskMbytes: number; + /** + * @since Added in 2.20.0 + */ maxItems?: number; + /** + * @since Added in 2.11.1 + */ maxTotalChargeUsd?: number; + /** + * @since Added in 2.19.0 + */ restartOnError?: boolean; } /** * Options for building an Actor. + * @since Added in 2.0.1 */ export interface ActorBuildOptions { + /** + * @since Added in 2.0.1 + */ betaPackages?: boolean; + /** + * @since Added in 2.0.1 + */ tag?: string; + /** + * @since Added in 2.0.1 + */ useCache?: boolean; + /** + * @since Added in 2.0.1 + */ waitForFinish?: number; } /** * Options for filtering the last run of an Actor. + * @since Added in 2.0.1 */ export interface ActorLastRunOptions { + /** + * @since Added in 2.0.1 + */ status?: keyof typeof ACT_JOB_STATUSES; } @@ -851,62 +1263,136 @@ export interface ActorLastRunOptions { * * Contains the Actor's configuration, input schema, and other metadata. * @see https://docs.apify.com/platform/actors/development/actor-definition/actor-json + * @since Added in 2.11.0 */ export interface ActorDefinition { + /** + * @since Added in 2.11.0 + */ actorSpecification: number; + /** + * @since Added in 2.11.0 + */ name: string; + /** + * @since Added in 2.11.0 + */ version: string; + /** + * @since Added in 2.11.0 + */ buildTag?: string; + /** + * @since Added in 2.11.0 + */ environmentVariables?: Record; + /** + * @since Added in 2.11.0 + */ dockerfile?: string; + /** + * @since Added in 2.11.0 + */ dockerContextDir?: string; + /** + * @since Added in 2.11.0 + */ readme?: string | null; /** * Input schema for the Actor. * @see https://docs.apify.com/platform/actors/development/actor-definition/input-schema + * @since Added in 2.11.0 */ input?: object | null; /** * Output schema for the Actor. * @see https://docs.apify.com/platform/actors/development/actor-definition/output-schema + * @since Added in 2.23.0 */ output?: object | null; + /** + * @since Added in 2.11.0 + */ changelog?: string | null; + /** + * @since Added in 2.11.0 + */ storages?: { dataset?: object; }; + /** + * @since Added in 2.11.0 + */ minMemoryMbytes?: number; + /** + * @since Added in 2.11.0 + */ maxMemoryMbytes?: number; + /** + * @since Added in 2.11.0 + */ usesStandbyMode?: boolean; } interface CommonActorPricingInfo { - /** In [0, 1], fraction of pricePerUnitUsd that goes to Apify */ + /** + * In [0, 1], fraction of pricePerUnitUsd that goes to Apify + * @since Added in 2.11.1 + */ apifyMarginPercentage: number; - /** When this pricing info record has been created */ + /** + * When this pricing info record has been created + * @since Added in 2.0.1 + */ createdAt: Date; - /** Since when is this pricing info record effective for a given Actor */ + /** + * Since when is this pricing info record effective for a given Actor + * @since Added in 2.0.1 + */ startedAt: Date; + /** + * @since Added in 2.11.1 + */ notifiedAboutFutureChangeAt?: Date; + /** + * @since Added in 2.11.1 + */ notifiedAboutChangeAt?: Date; + /** + * @since Added in 2.11.1 + */ reasonForChange?: string; } /** * Pricing information for free Actors. + * @since Added in 2.11.1 */ export interface FreeActorPricingInfo extends CommonActorPricingInfo { + /** + * @since Added in 2.11.1 + */ pricingModel: 'FREE'; } /** * Pricing information for Actors with a flat monthly subscription fee. + * @since Added in 2.11.1 */ export interface FlatPricePerMonthActorPricingInfo extends CommonActorPricingInfo { + /** + * @since Added in 2.11.1 + */ pricingModel: 'FLAT_PRICE_PER_MONTH'; - /** For how long this Actor can be used for free in trial period */ + /** + * For how long this Actor can be used for free in trial period + * @since Added in 2.11.1 + */ trialMinutes?: number; - /** Monthly flat price in USD */ + /** + * Monthly flat price in USD + * @since Added in 2.11.1 + */ pricePerUnitUsd: number; } @@ -914,25 +1400,46 @@ export interface FlatPricePerMonthActorPricingInfo extends CommonActorPricingInf * Pricing information for pay-per-result Actors. * * These Actors charge based on the number of items saved to the dataset. + * @since Added in 2.11.1 */ export interface PricePerDatasetItemActorPricingInfo extends CommonActorPricingInfo { + /** + * @since Added in 2.11.1 + */ pricingModel: 'PRICE_PER_DATASET_ITEM'; - /** Name of the unit that is being charged */ + /** + * Name of the unit that is being charged + * @since Added in 2.11.1 + */ unitName?: string; + /** + * @since Added in 2.11.1 + */ pricePerUnitUsd: number; } /** * Definition of a chargeable event for pay-per-event Actors. + * @since Added in 2.11.1 */ export interface ActorChargeEvent { + /** + * @since Added in 2.11.1 + */ eventPriceUsd: number; + /** + * @since Added in 2.11.1 + */ eventTitle: string; + /** + * @since Added in 2.11.1 + */ eventDescription?: string; } /** * Mapping of event names to their pricing information. + * @since Added in 2.11.1 */ export type ActorChargeEvents = Record; @@ -940,17 +1447,28 @@ export type ActorChargeEvents = Record; * Pricing information for pay-per-event Actors. * * These Actors charge based on specific events (e.g., emails sent, API calls made). + * @since Added in 2.11.1 */ export interface PricePerEventActorPricingInfo extends CommonActorPricingInfo { + /** + * @since Added in 2.11.1 + */ pricingModel: 'PAY_PER_EVENT'; + /** + * @since Added in 2.11.1 + */ pricingPerEvent: { actorChargeEvents: ActorChargeEvents; }; + /** + * @since Added in 2.11.1 + */ minimalMaxTotalChargeUsd?: number; } /** * Union type representing all possible Actor pricing models. + * @since Added in 2.11.1 */ export type ActorRunPricingInfo = | PricePerEventActorPricingInfo diff --git a/src/resource_clients/actor_collection.ts b/src/resource_clients/actor_collection.ts index eddcbd8f9..eb9b416a9 100644 --- a/src/resource_clients/actor_collection.ts +++ b/src/resource_clients/actor_collection.ts @@ -28,6 +28,7 @@ import type { ActorVersion } from './actor_version'; * ``` * * @see https://docs.apify.com/platform/actors + * @since Added in 1.0.0 */ export class ActorCollectionClient extends ResourceCollectionClient { /** @@ -59,6 +60,7 @@ export class ActorCollectionClient extends ResourceCollectionClient { * @param options - Pagination options. * @returns A paginated iterator of Actors. * @see https://docs.apify.com/api/v2/acts-get + * @since Added in 2.0.1 */ list(options: ActorCollectionListOptions = {}): PaginatedIterator { ow( @@ -81,6 +83,7 @@ export class ActorCollectionClient extends ResourceCollectionClient { * @param actor - The Actor data. * @returns The created Actor object. * @see https://docs.apify.com/api/v2/acts-post + * @since Added in 2.0.1 */ async create(actor: ActorCollectionCreateOptions): Promise { ow(actor, ow.optional.object); @@ -89,41 +92,125 @@ export class ActorCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.12.6 + */ export enum ActorListSortBy { + /** + * @since Added in 2.12.6 + */ CREATED_AT = 'createdAt', + /** + * @since Added in 2.12.6 + */ LAST_RUN_STARTED_AT = 'stats.lastRunStartedAt', } +/** + * @since Added in 2.0.1 + */ export interface ActorCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ my?: boolean; + /** + * @since Added in 2.0.1 + */ desc?: boolean; + /** + * @since Added in 2.12.6 + */ sortBy?: ActorListSortBy; } +/** + * @since Added in 2.0.1 + */ export interface ActorCollectionListItem { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ createdAt: Date; + /** + * @since Added in 2.0.1 + */ modifiedAt: Date; + /** + * @since Added in 2.0.1 + */ name: string; + /** + * @since Added in 2.0.1 + */ username: string; } +/** + * @since Added in 2.0.1 + */ export type ActorCollectionListResult = PaginatedList; +/** + * @since Added in 2.0.1 + */ export interface ActorCollectionCreateOptions { + /** + * @since Added in 2.8.6 + */ categories?: string[]; + /** + * @since Added in 2.8.6 + */ defaultRunOptions?: ActorDefaultRunOptions; + /** + * @since Added in 2.0.1 + */ description?: string; + /** + * @since Added in 2.8.6 + */ exampleRunInput?: ActorExampleRunInput; + /** + * @since Added in 2.8.6 + */ isDeprecated?: boolean; + /** + * @since Added in 2.0.1 + */ isPublic?: boolean; + /** + * @since Added in 2.0.1 + */ name?: string; - /** @deprecated Use defaultRunOptions.restartOnError instead */ + /** + * @deprecated Use defaultRunOptions.restartOnError instead + * @since Added in 2.0.1 + */ restartOnError?: boolean; + /** + * @since Added in 2.8.6 + */ seoTitle?: string; + /** + * @since Added in 2.8.6 + */ seoDescription?: string; + /** + * @since Added in 2.0.1 + */ title?: string; + /** + * @since Added in 2.0.1 + */ versions?: ActorVersion[]; + /** + * @since Added in 2.9.5 + */ actorStandby?: ActorStandby & { isEnabled: boolean; }; diff --git a/src/resource_clients/actor_env_var.ts b/src/resource_clients/actor_env_var.ts index 785181eb5..33109e054 100644 --- a/src/resource_clients/actor_env_var.ts +++ b/src/resource_clients/actor_env_var.ts @@ -25,6 +25,7 @@ import type { ActorEnvironmentVariable } from './actor_version'; * ``` * * @see https://docs.apify.com/platform/actors/development/programming-interface/environment-variables + * @since Added in 2.1.0 */ export class ActorEnvVarClient extends ResourceClient { /** @@ -42,6 +43,7 @@ export class ActorEnvVarClient extends ResourceClient { * * @returns The environment variable object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/act-version-env-var-get + * @since Added in 2.1.0 */ async get(): Promise { return this._get(); @@ -53,6 +55,7 @@ export class ActorEnvVarClient extends ResourceClient { * @param actorEnvVar - The updated environment variable data. * @returns The updated environment variable object. * @see https://docs.apify.com/api/v2/act-version-env-var-put + * @since Added in 2.1.0 */ async update(actorEnvVar: ActorEnvironmentVariable): Promise { ow(actorEnvVar, ow.object); @@ -63,6 +66,7 @@ export class ActorEnvVarClient extends ResourceClient { * Deletes the environment variable. * * @see https://docs.apify.com/api/v2/act-version-env-var-delete + * @since Added in 2.1.0 */ async delete(): Promise { return this._delete(); diff --git a/src/resource_clients/actor_env_var_collection.ts b/src/resource_clients/actor_env_var_collection.ts index 4167be80f..e908b71e0 100644 --- a/src/resource_clients/actor_env_var_collection.ts +++ b/src/resource_clients/actor_env_var_collection.ts @@ -30,6 +30,7 @@ import type { ActorEnvironmentVariable } from './actor_version'; * ``` * * @see https://docs.apify.com/platform/actors/development/programming-interface/environment-variables + * @since Added in 2.1.0 */ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { /** @@ -60,6 +61,7 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { * * @returns A paginated iterator of environment variables. * @see https://docs.apify.com/api/v2/act-version-env-vars-get + * @since Added in 2.1.0 */ list( _options: ActorEnvVarCollectionListOptions = {}, @@ -73,6 +75,7 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { * @param actorEnvVar - The environment variable data. * @returns The created environment variable object. * @see https://docs.apify.com/api/v2/act-version-env-vars-post + * @since Added in 2.1.0 */ async create(actorEnvVar: ActorEnvironmentVariable): Promise { ow(actorEnvVar, ow.optional.object); @@ -83,9 +86,16 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { /** * @deprecated No options are used in the current API implementation. * https://github.com/apify/apify-client-js/issues/799 + * @since Added in 2.1.0 */ export interface ActorEnvVarCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.1.0 + */ desc?: boolean; } +/** + * @since Added in 2.1.0 + */ export type ActorEnvVarListResult = Pick, 'total' | 'items'>; diff --git a/src/resource_clients/actor_version.ts b/src/resource_clients/actor_version.ts index 72f0a05da..bb2237122 100644 --- a/src/resource_clients/actor_version.ts +++ b/src/resource_clients/actor_version.ts @@ -25,6 +25,7 @@ import { ActorEnvVarCollectionClient } from './actor_env_var_collection'; * ``` * * @see https://docs.apify.com/api/v2/act-versions-get + * @since Added in 1.0.0 */ export class ActorVersionClient extends ResourceClient { /** @@ -42,6 +43,7 @@ export class ActorVersionClient extends ResourceClient { * * @returns The Actor version object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/act-version-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -53,6 +55,7 @@ export class ActorVersionClient extends ResourceClient { * @param newFields - Fields to update. * @returns The updated Actor version object. * @see https://docs.apify.com/api/v2/act-version-put + * @since Added in 2.0.1 */ async update(newFields: ActorVersion): Promise { ow(newFields, ow.object); @@ -64,6 +67,7 @@ export class ActorVersionClient extends ResourceClient { * Deletes the Actor version. * * @see https://docs.apify.com/api/v2/act-version-delete + * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -75,6 +79,7 @@ export class ActorVersionClient extends ResourceClient { * @param envVarName - Name of the environment variable. * @returns A client for the environment variable. * @see https://docs.apify.com/api/v2/act-version-env-var-get + * @since Added in 2.1.0 */ envVar(envVarName: string): ActorEnvVarClient { ow(envVarName, ow.string); @@ -90,55 +95,143 @@ export class ActorVersionClient extends ResourceClient { * * @returns A client for the Actor version's environment variables. * @see https://docs.apify.com/api/v2/act-version-env-vars-get + * @since Added in 2.1.0 */ envVars(): ActorEnvVarCollectionClient { return new ActorEnvVarCollectionClient(this._subResourceOptions()); } } +/** + * @since Added in 2.0.1 + */ export interface BaseActorVersion { + /** + * @since Added in 2.0.1 + */ versionNumber?: string; + /** + * @since Added in 2.0.1 + */ sourceType: SourceType; + /** + * @since Added in 2.0.1 + */ envVars?: ActorEnvironmentVariable[]; + /** + * @since Added in 2.0.1 + */ applyEnvVarsToBuild?: boolean; + /** + * @since Added in 2.0.1 + */ buildTag?: string; } +/** + * @since Added in 2.6.1 + */ export interface ActorVersionSourceFiles extends BaseActorVersion { + /** + * @since Added in 2.6.1 + */ sourceFiles: ActorVersionSourceFile[]; } +/** + * @since Added in 2.0.1 + */ export interface ActorVersionSourceFile { + /** + * @since Added in 2.0.1 + */ name: string; + /** + * @since Added in 2.0.1 + */ format: 'TEXT' | 'BASE64'; + /** + * @since Added in 2.0.1 + */ content: string; } +/** + * @since Added in 2.0.1 + */ export interface ActorVersionGitRepo extends BaseActorVersion { + /** + * @since Added in 2.0.1 + */ gitRepoUrl: string; } +/** + * @since Added in 2.0.1 + */ export interface ActorVersionTarball extends BaseActorVersion { + /** + * @since Added in 2.0.1 + */ tarballUrl: string; } +/** + * @since Added in 2.0.1 + */ export interface ActorVersionGitHubGist extends BaseActorVersion { + /** + * @since Added in 2.0.1 + */ gitHubGistUrl: string; } +/** + * @since Added in 2.0.1 + */ export enum ActorSourceType { + /** + * @since Added in 2.0.1 + */ SourceFiles = 'SOURCE_FILES', + /** + * @since Added in 2.0.1 + */ GitRepo = 'GIT_REPO', + /** + * @since Added in 2.0.1 + */ Tarball = 'TARBALL', + /** + * @since Added in 2.0.1 + */ GitHubGist = 'GITHUB_GIST', } +/** + * @since Added in 2.0.1 + */ export interface ActorEnvironmentVariable { + /** + * @since Added in 2.0.1 + */ name?: string; + /** + * @since Added in 2.0.1 + */ value?: string; + /** + * @since Added in 2.0.1 + */ isSecret?: boolean; } +/** + * @since Added in 0.10.0 + */ export type ActorVersion = ActorVersionSourceFiles | ActorVersionGitRepo | ActorVersionTarball | ActorVersionGitHubGist; +/** + * @since Added in 2.0.1 + */ export type FinalActorVersion = ActorVersion & Required>; diff --git a/src/resource_clients/actor_version_collection.ts b/src/resource_clients/actor_version_collection.ts index af929a2f7..24cb27f4c 100644 --- a/src/resource_clients/actor_version_collection.ts +++ b/src/resource_clients/actor_version_collection.ts @@ -28,6 +28,7 @@ import type { ActorVersion, FinalActorVersion } from './actor_version'; * ``` * * @see https://docs.apify.com/api/v2/act-versions-get + * @since Added in 1.0.0 */ export class ActorVersionCollectionClient extends ResourceCollectionClient { /** @@ -58,6 +59,7 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { * * @returns A paginated iterator of Actor versions. * @see https://docs.apify.com/api/v2/act-versions-get + * @since Added in 2.0.1 */ list( _options: ActorVersionCollectionListOptions = {}, @@ -71,6 +73,7 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { * @param actorVersion - The Actor version data. * @returns The created Actor version object. * @see https://docs.apify.com/api/v2/act-versions-post + * @since Added in 2.0.1 */ async create(actorVersion: ActorVersion): Promise { ow(actorVersion, ow.optional.object); @@ -82,9 +85,16 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { /** * @deprecated No options are used in the current API implementation. * https://github.com/apify/apify-client-js/issues/799 + * @since Added in 2.0.1 */ export interface ActorVersionCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ desc?: boolean; } +/** + * @since Added in 2.0.1 + */ export type ActorVersionListResult = Pick, 'total' | 'items'>; diff --git a/src/resource_clients/build.ts b/src/resource_clients/build.ts index ac17ab697..26eb24e1c 100644 --- a/src/resource_clients/build.ts +++ b/src/resource_clients/build.ts @@ -30,6 +30,7 @@ import { LogClient } from './log'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds#builds + * @since Added in 1.0.0 */ export class BuildClient extends ResourceClient { /** @@ -59,6 +60,7 @@ export class BuildClient extends ResourceClient { * // Wait up to 60 seconds for build to finish * const build = await client.build('build-id').get({ waitForFinish: 60 }); * ``` + * @since Added in 2.0.1 */ async get(options: BuildClientGetOptions = {}): Promise { ow( @@ -83,6 +85,7 @@ export class BuildClient extends ResourceClient { * ```javascript * await client.build('build-id').abort(); * ``` + * @since Added in 2.0.1 */ async abort(): Promise { const response = await this.httpClient.call({ @@ -98,6 +101,7 @@ export class BuildClient extends ResourceClient { * Deletes the Actor build. * * @see https://docs.apify.com/api/v2/actor-build-delete + * @since Added in 2.8.1 */ async delete(): Promise { return this._delete(); @@ -108,6 +112,7 @@ export class BuildClient extends ResourceClient { * * @returns The OpenAPI definition object. * @see https://docs.apify.com/api/v2/actor-build-openapi-json-get + * @since Added in 2.11.2 */ async getOpenApiDefinition(): Promise { const response = await this.httpClient.call({ @@ -148,6 +153,7 @@ export class BuildClient extends ResourceClient { * const run = await client.actor('my-actor').start(); * } * ``` + * @since Added in 2.0.1 */ async waitForFinish(options: BuildClientWaitForFinishOptions = {}): Promise { ow( @@ -172,6 +178,7 @@ export class BuildClient extends ResourceClient { * const log = await client.build('build-id').log().get(); * console.log(log); * ``` + * @since Added in 2.9.0 */ log(): LogClient { return new LogClient( @@ -184,29 +191,45 @@ export class BuildClient extends ResourceClient { /** * Options for getting a Build. + * @since Added in 2.0.1 */ export interface BuildClientGetOptions { + /** + * @since Added in 2.0.1 + */ waitForFinish?: number; } /** * Options for waiting for a Build to finish. + * @since Added in 2.0.1 */ export interface BuildClientWaitForFinishOptions { /** * Maximum time to wait for the build to finish, in seconds. * If the limit is reached, the returned promise is resolved to a build object that will have * status `READY` or `RUNNING`. If `waitSecs` omitted, the function waits indefinitely. + * @since Added in 2.0.1 */ waitSecs?: number; } /** * Metadata about how a Build was initiated. + * @since Added in 2.0.1 */ export interface BuildMeta { + /** + * @since Added in 2.0.1 + */ origin: string; + /** + * @since Added in 2.0.1 + */ clientIp: string; + /** + * @since Added in 2.0.1 + */ userAgent: string; } @@ -215,55 +238,127 @@ export interface BuildMeta { * * Builds compile Actor source code and prepare it for execution. Each build has a unique ID * and can be tagged (e.g., 'latest', 'beta') for easy reference. + * @since Added in 1.0.0 */ export interface Build { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ actId: string; + /** + * @since Added in 2.0.1 + */ userId: string; + /** + * @since Added in 2.0.1 + */ startedAt: Date; + /** + * @since Added in 2.0.1 + */ finishedAt?: Date; + /** + * @since Added in 2.0.1 + */ status: (typeof ACT_JOB_TERMINAL_STATUSES)[number]; + /** + * @since Added in 2.0.1 + */ meta: BuildMeta; + /** + * @since Added in 2.0.1 + */ stats?: BuildStats; + /** + * @since Added in 2.0.1 + */ options?: BuildOptions; /** * @deprecated This property is deprecated in favor of `actorDefinition.input`. + * @since Added in 2.0.1 */ inputSchema?: string; /** * @deprecated This property is deprecated in favor of `actorDefinition.readme`. + * @since Added in 2.0.1 */ readme?: string; + /** + * @since Added in 2.0.1 + */ buildNumber: string; + /** + * @since Added in 2.7.2 + */ usage?: BuildUsage; + /** + * @since Added in 2.7.2 + */ usageTotalUsd?: number; + /** + * @since Added in 2.7.2 + */ usageUsd?: BuildUsage; + /** + * @since Added in 2.11.0 + */ actorDefinition?: ActorDefinition; } /** * Resource usage for an Actor build. + * @since Added in 2.7.2 */ export interface BuildUsage { + /** + * @since Added in 2.7.2 + */ ACTOR_COMPUTE_UNITS?: number; } /** * Runtime statistics for an Actor build. + * @since Added in 2.0.1 */ export interface BuildStats { + /** + * @since Added in 2.0.1 + */ durationMillis: number; + /** + * @since Added in 2.0.1 + */ runTimeSecs: number; + /** + * @since Added in 2.0.1 + */ computeUnits: number; } /** * Configuration options used for an Actor build. + * @since Added in 2.0.1 */ export interface BuildOptions { + /** + * @since Added in 2.0.1 + */ useCache?: boolean; + /** + * @since Added in 2.0.1 + */ betaPackages?: boolean; + /** + * @since Added in 2.0.1 + */ memoryMbytes?: number; + /** + * @since Added in 2.0.1 + */ diskMbytes?: number; } @@ -272,17 +367,33 @@ export interface BuildOptions { * * Defines the Actor's API interface in OpenAPI 3.0 format, useful for integration * with tools like ChatGPT plugins and other API consumers. + * @since Added in 2.11.2 */ export interface OpenApiDefinition { + /** + * @since Added in 2.11.2 + */ openapi: string; + /** + * @since Added in 2.11.2 + */ info: { title: string; description?: string; version?: string; 'x-build-id': string; }; + /** + * @since Added in 2.11.2 + */ servers: { url: string }[]; + /** + * @since Added in 2.11.2 + */ paths: { [key: string]: { post: OpenApiOperation } }; + /** + * @since Added in 2.11.2 + */ components: { schemas: { [key: string]: object; diff --git a/src/resource_clients/build_collection.ts b/src/resource_clients/build_collection.ts index 36c4a1a2e..a664f3078 100644 --- a/src/resource_clients/build_collection.ts +++ b/src/resource_clients/build_collection.ts @@ -25,6 +25,7 @@ import type { Build } from './build'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds#builds + * @since Added in 1.0.0 */ export class BuildCollectionClient extends ResourceCollectionClient { /** @@ -56,6 +57,7 @@ export class BuildCollectionClient extends ResourceCollectionClient { * @param options - Pagination and sorting options. * @returns A paginated iterator of Actor builds. * @see https://docs.apify.com/api/v2/actor-builds-get + * @since Added in 2.0.1 */ list(options: BuildCollectionClientListOptions = {}): PaginatedIterator { ow( @@ -71,11 +73,23 @@ export class BuildCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.0.1 + */ export interface BuildCollectionClientListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ desc?: boolean; } +/** + * @since Added in 2.0.1 + */ export type BuildCollectionClientListItem = Required> & Partial>; +/** + * @since Added in 2.0.1 + */ export type BuildCollectionClientListResult = PaginatedList; diff --git a/src/resource_clients/dataset.ts b/src/resource_clients/dataset.ts index 4135bfc72..6e27ff02f 100644 --- a/src/resource_clients/dataset.ts +++ b/src/resource_clients/dataset.ts @@ -43,6 +43,7 @@ import { applyQueryParamsToUrl, cast, catchNotFoundOrThrow, pluckData } from '.. * ``` * * @see https://docs.apify.com/platform/storage/dataset + * @since Added in 1.0.0 */ export class DatasetClient< Data extends Record = Record, @@ -62,6 +63,7 @@ export class DatasetClient< * * @returns The Dataset object, or `undefined` if it does not exist * @see https://docs.apify.com/api/v2/dataset-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get({}, SMALL_TIMEOUT_MILLIS); @@ -73,6 +75,7 @@ export class DatasetClient< * @param newFields - Fields to update in the dataset * @returns The updated Dataset object * @see https://docs.apify.com/api/v2/dataset-put + * @since Added in 2.0.1 */ async update(newFields: DatasetClientUpdateOptions): Promise { ow(newFields, ow.object); @@ -84,6 +87,7 @@ export class DatasetClient< * Deletes the dataset. * * @see https://docs.apify.com/api/v2/dataset-delete + * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(SMALL_TIMEOUT_MILLIS); @@ -132,6 +136,7 @@ export class DatasetClient< * limit: 50 * }); * ``` + * @since Added in 2.0.1 */ listItems(options: DatasetClientListItemOptions = {}): PaginatedIterator { ow( @@ -208,6 +213,7 @@ export class DatasetClient< * xmlRow: 'product' * }); * ``` + * @since Added in 2.0.1 */ async downloadItems(format: DownloadItemsFormat, options: DatasetClientDownloadItemsOptions = {}): Promise { ow(format, ow.string.oneOf(validItemFormats)); @@ -280,6 +286,7 @@ export class DatasetClient< * // Store string items * await client.dataset('my-dataset').pushItems(['item1', 'item2', 'item3']); * ``` + * @since Added in 2.0.1 */ async pushItems(items: Data | Data[] | string | string[]): Promise { ow(items, ow.any(ow.object, ow.string, ow.array.ofType(ow.any(ow.object, ow.string)))); @@ -305,6 +312,7 @@ export class DatasetClient< * * @returns Dataset statistics, or `undefined` if not available * @see https://docs.apify.com/api/v2/dataset-statistics-get + * @since Added in 2.11.2 */ async getStatistics(): Promise { const requestOpts: ApifyRequestConfig = { @@ -352,6 +360,7 @@ export class DatasetClient< * skipEmpty: true * }); * ``` + * @since Added in 2.13.0 */ async createItemsPublicUrl(options: DatasetClientCreateItemsUrlOptions = {}): Promise { ow( @@ -410,43 +419,118 @@ export class DatasetClient< * * Datasets store structured data as a sequence of items (records). Each item is a JSON object. * Datasets are useful for storing results from web scraping, crawling, or data processing tasks. + * @since Added in 0.1.61 */ export interface Dataset { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ name?: string; + /** + * @since Added in 2.6.1 + */ title?: string; + /** + * @since Added in 2.0.1 + */ userId: string; + /** + * @since Added in 2.21.0 + */ username?: string; + /** + * @since Added in 2.0.1 + */ createdAt: Date; + /** + * @since Added in 2.0.1 + */ modifiedAt: Date; + /** + * @since Added in 2.0.1 + */ accessedAt: Date; + /** + * @since Added in 2.0.1 + */ itemCount: number; + /** + * @since Added in 2.0.1 + */ cleanItemCount: number; + /** + * @since Added in 2.0.1 + */ actId?: string; + /** + * @since Added in 2.0.1 + */ actRunId?: string; + /** + * @since Added in 2.0.1 + */ stats: DatasetStats; + /** + * @since Added in 2.0.1 + */ fields: string[]; + /** + * @since Added in 2.12.2 + */ generalAccess?: STORAGE_GENERAL_ACCESS | null; + /** + * @since Added in 2.13.0 + */ urlSigningSecretKey?: string | null; + /** + * @since Added in 2.13.0 + */ itemsPublicUrl: string; } /** * Statistics about dataset usage and storage. + * @since Added in 2.0.1 */ export interface DatasetStats { + /** + * @since Added in 2.0.1 + */ readCount?: number; + /** + * @since Added in 2.0.1 + */ writeCount?: number; + /** + * @since Added in 2.0.1 + */ deleteCount?: number; + /** + * @since Added in 2.0.1 + */ storageBytes?: number; } /** * Options for updating a dataset. + * @since Added in 2.0.1 */ export interface DatasetClientUpdateOptions { + /** + * @since Added in 2.0.1 + */ name?: string | null; + /** + * @since Added in 2.6.1 + */ title?: string; + /** + * @since Added in 2.12.2 + */ generalAccess?: STORAGE_GENERAL_ACCESS | null; } @@ -455,17 +539,48 @@ export interface DatasetClientUpdateOptions { * * Provides various filtering, pagination, and transformation options to customize * the output format and content of retrieved items. + * @since Added in 2.0.1 */ export interface DatasetClientListItemOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ clean?: boolean; + /** + * @since Added in 2.0.1 + */ desc?: boolean; + /** + * @since Added in 2.6.1 + */ flatten?: string[]; + /** + * @since Added in 2.0.1 + */ fields?: string[]; + /** + * @since Added in 2.0.1 + */ omit?: string[]; + /** + * @since Added in 2.0.1 + */ skipEmpty?: boolean; + /** + * @since Added in 2.0.1 + */ skipHidden?: boolean; + /** + * @since Added in 2.0.1 + */ unwind?: string | string[]; // TODO: when doing a breaking change release, change to string[] only + /** + * @since Added in 2.2.0 + */ view?: string; + /** + * @since Added in 2.13.0 + */ signature?: string; } @@ -473,21 +588,47 @@ export interface DatasetClientListItemOptions extends PaginationOptions { * Options for creating a public URL to access dataset items. * * Extends {@link DatasetClientListItemOptions} with URL expiration control. + * @since Added in 2.16.0 */ export interface DatasetClientCreateItemsUrlOptions extends DatasetClientListItemOptions { + /** + * @since Added in 2.16.0 + */ expiresInSecs?: number; } /** * Supported formats for downloading dataset items. + * @since Added in 2.0.1 */ export enum DownloadItemsFormat { + /** + * @since Added in 2.0.1 + */ JSON = 'json', + /** + * @since Added in 2.0.1 + */ JSONL = 'jsonl', + /** + * @since Added in 2.0.1 + */ XML = 'xml', + /** + * @since Added in 2.0.1 + */ HTML = 'html', + /** + * @since Added in 2.0.1 + */ CSV = 'csv', + /** + * @since Added in 2.0.1 + */ XLSX = 'xlsx', + /** + * @since Added in 2.0.1 + */ RSS = 'rss', } @@ -497,13 +638,32 @@ const validItemFormats = [...new Set(Object.values(DownloadItemsFormat).map((ite * Options for downloading dataset items in a specific format. * * Extends {@link DatasetClientListItemOptions} with format-specific options. + * @since Added in 2.0.1 */ export interface DatasetClientDownloadItemsOptions extends DatasetClientListItemOptions { + /** + * @since Added in 2.0.1 + */ attachment?: boolean; + /** + * @since Added in 2.0.1 + */ bom?: boolean; + /** + * @since Added in 2.0.1 + */ delimiter?: string; + /** + * @since Added in 2.0.1 + */ skipHeaderRow?: boolean; + /** + * @since Added in 2.0.1 + */ xmlRoot?: string; + /** + * @since Added in 2.0.1 + */ xmlRow?: string; } @@ -511,17 +671,34 @@ export interface DatasetClientDownloadItemsOptions extends DatasetClientListItem * Statistical information about dataset fields. * * Provides insights into the data structure and content of the dataset. + * @since Added in 2.11.2 */ export interface DatasetStatistics { + /** + * @since Added in 2.11.2 + */ fieldStatistics: Record; } /** * Statistics for a single field in a dataset. + * @since Added in 2.11.2 */ export interface FieldStatistics { + /** + * @since Added in 2.11.2 + */ min?: number; + /** + * @since Added in 2.11.2 + */ max?: number; + /** + * @since Added in 2.11.2 + */ nullCount?: number; + /** + * @since Added in 2.11.2 + */ emptyCount?: number; } diff --git a/src/resource_clients/dataset_collection.ts b/src/resource_clients/dataset_collection.ts index a0b242eb5..a80af6e57 100644 --- a/src/resource_clients/dataset_collection.ts +++ b/src/resource_clients/dataset_collection.ts @@ -26,6 +26,7 @@ import type { Dataset } from './dataset'; * ``` * * @see https://docs.apify.com/platform/storage/dataset + * @since Added in 1.0.0 */ export class DatasetCollectionClient extends ResourceCollectionClient { /** @@ -57,6 +58,7 @@ export class DatasetCollectionClient extends ResourceCollectionClient { * @param options - Pagination options. * @returns A paginated iterator of Datasets. * @see https://docs.apify.com/api/v2/datasets-get + * @since Added in 2.0.1 */ list( options: DatasetCollectionClientListOptions = {}, @@ -82,6 +84,7 @@ export class DatasetCollectionClient extends ResourceCollectionClient { * @param options - Additional options like schema. * @returns The dataset object. * @see https://docs.apify.com/api/v2/datasets-post + * @since Added in 2.0.1 */ async getOrCreate(name?: string, options?: DatasetCollectionClientGetOrCreateOptions): Promise { ow(name, ow.optional.string); @@ -91,15 +94,36 @@ export class DatasetCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.0.1 + */ export interface DatasetCollectionClientListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ unnamed?: boolean; + /** + * @since Added in 2.0.1 + */ desc?: boolean; - /** Filter by ownership: 'ownedByMe' returns only user's own datasets, 'sharedWithMe' returns only shared datasets. */ + /** + * Filter by ownership: 'ownedByMe' returns only user's own datasets, 'sharedWithMe' returns only shared datasets. + * @since Added in 2.22.1 + */ ownership?: STORAGE_OWNERSHIP_FILTER; } +/** + * @since Added in 2.3.0 + */ export interface DatasetCollectionClientGetOrCreateOptions { + /** + * @since Added in 2.3.0 + */ schema?: Record; } +/** + * @since Added in 2.0.1 + */ export type DatasetCollectionClientListResult = PaginatedList & { unnamed: boolean }; diff --git a/src/resource_clients/key_value_store.ts b/src/resource_clients/key_value_store.ts index d6c41f425..210663b9e 100644 --- a/src/resource_clients/key_value_store.ts +++ b/src/resource_clients/key_value_store.ts @@ -54,6 +54,7 @@ import { * ``` * * @see https://docs.apify.com/platform/storage/key-value-store + * @since Added in 1.0.0 */ export class KeyValueStoreClient extends ResourceClient { /** @@ -71,6 +72,7 @@ export class KeyValueStoreClient extends ResourceClient { * * @returns The KeyValueStore object, or `undefined` if it does not exist * @see https://docs.apify.com/api/v2/key-value-store-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get({}, SMALL_TIMEOUT_MILLIS); @@ -85,6 +87,7 @@ export class KeyValueStoreClient extends ResourceClient { * @param newFields.generalAccess - General resource access level ('FOLLOW_USER_SETTING', 'ANYONE_WITH_ID_CAN_READ' or 'RESTRICTED') * @returns The updated KeyValueStore object * @see https://docs.apify.com/api/v2/key-value-store-put + * @since Added in 2.0.1 */ async update(newFields: KeyValueClientUpdateOptions): Promise { ow(newFields, ow.object); @@ -96,6 +99,7 @@ export class KeyValueStoreClient extends ResourceClient { * Deletes the key-value store. * * @see https://docs.apify.com/api/v2/key-value-store-delete + * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(SMALL_TIMEOUT_MILLIS); @@ -135,6 +139,7 @@ export class KeyValueStoreClient extends ResourceClient { * exclusiveStartKey = result.nextExclusiveStartKey; * } while (result.isTruncated); * ``` + * @since Added in 2.0.1 */ listKeys( options: KeyValueClientListKeysOptions = {}, @@ -209,6 +214,7 @@ export class KeyValueStoreClient extends ResourceClient { * console.log(`Public URL: ${url}`); * // You can now share this URL or use it in a browser * ``` + * @since Added in 2.14.0 */ async getRecordPublicUrl(key: string): Promise { ow(key, ow.string.nonEmpty); @@ -246,6 +252,7 @@ export class KeyValueStoreClient extends ResourceClient { * }); * console.log(`Share this URL: ${url}`); * ``` + * @since Added in 2.13.0 */ async createKeysPublicUrl(options: KeyValueClientCreateKeysUrlOptions = {}) { ow( @@ -295,6 +302,7 @@ export class KeyValueStoreClient extends ResourceClient { * console.log('OUTPUT record exists'); * } * ``` + * @since Added in 2.9.0 */ async recordExists(key: string): Promise { const requestOpts: Record = { @@ -322,6 +330,7 @@ export class KeyValueStoreClient extends ResourceClient { * NOT resolve to a `KeyValueStore` record with an `undefined` value. * * @see https://docs.apify.com/api/v2/key-value-store-record-get + * @since Added in 2.0.1 */ async getRecord(key: string): Promise | undefined>; @@ -429,6 +438,7 @@ export class KeyValueStoreClient extends ResourceClient { * contentType: 'image/png' * }); * ``` + * @since Added in 2.0.1 */ async setRecord(record: KeyValueStoreRecord, options: KeyValueStoreRecordOptions = {}): Promise { ow( @@ -493,6 +503,7 @@ export class KeyValueStoreClient extends ResourceClient { * ```javascript * await client.keyValueStore('my-store').deleteRecord('temp-data'); * ``` + * @since Added in 2.0.1 */ async deleteRecord(key: string): Promise { ow(key, ow.string); @@ -511,52 +522,137 @@ export class KeyValueStoreClient extends ResourceClient { * * Key-value stores are used to store arbitrary data records or files. Each record is identified * by a unique key and can contain any data - JSON objects, strings, binary files, etc. + * @since Added in 0.1.39 */ export interface KeyValueStore { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ name?: string; + /** + * @since Added in 2.6.1 + */ title?: string; + /** + * @since Added in 2.0.1 + */ userId: string; + /** + * @since Added in 2.21.0 + */ username?: string; + /** + * @since Added in 2.0.1 + */ createdAt: Date; + /** + * @since Added in 2.0.1 + */ modifiedAt: Date; + /** + * @since Added in 2.0.1 + */ accessedAt: Date; + /** + * @since Added in 2.0.1 + */ actId?: string; + /** + * @since Added in 2.0.1 + */ actRunId?: string; + /** + * @since Added in 2.0.1 + */ stats?: KeyValueStoreStats; + /** + * @since Added in 2.12.2 + */ generalAccess?: STORAGE_GENERAL_ACCESS | null; + /** + * @since Added in 2.13.0 + */ urlSigningSecretKey?: string | null; + /** + * @since Added in 2.13.0 + */ keysPublicUrl: string; } /** * Statistics about Key-Value Store usage and storage. + * @since Added in 2.0.1 */ export interface KeyValueStoreStats { + /** + * @since Added in 2.0.1 + */ readCount?: number; + /** + * @since Added in 2.0.1 + */ writeCount?: number; + /** + * @since Added in 2.0.1 + */ deleteCount?: number; + /** + * @since Added in 2.0.1 + */ listCount?: number; + /** + * @since Added in 2.0.1 + */ storageBytes?: number; } /** * Options for updating a Key-Value Store. + * @since Added in 2.0.1 */ export interface KeyValueClientUpdateOptions { + /** + * @since Added in 2.0.1 + */ name?: string | null; + /** + * @since Added in 2.6.1 + */ title?: string; + /** + * @since Added in 2.12.2 + */ generalAccess?: STORAGE_GENERAL_ACCESS | null; } /** * Options for listing keys in a Key-Value Store. + * @since Added in 2.0.1 */ export interface KeyValueClientListKeysOptions { + /** + * @since Added in 2.0.1 + */ limit?: number; + /** + * @since Added in 2.0.1 + */ exclusiveStartKey?: string; + /** + * @since Added in 2.0.1 + */ collection?: string; + /** + * @since Added in 2.12.5 + */ prefix?: string; + /** + * @since Added in 2.13.0 + */ signature?: string; } @@ -564,8 +660,12 @@ export interface KeyValueClientListKeysOptions { * Options for creating a public URL to list keys in a Key-Value Store. * * Extends {@link KeyValueClientListKeysOptions} with URL expiration control. + * @since Added in 2.16.0 */ export interface KeyValueClientCreateKeysUrlOptions extends KeyValueClientListKeysOptions { + /** + * @since Added in 2.16.0 + */ expiresInSecs?: number; } @@ -573,31 +673,70 @@ export interface KeyValueClientCreateKeysUrlOptions extends KeyValueClientListKe * Result of listing keys in a Key-Value Store. * * Contains paginated list of keys with metadata and pagination information. + * @since Added in 2.0.1 */ export interface KeyValueClientListKeysResult { + /** + * @since Added in 2.0.1 + */ count: number; + /** + * @since Added in 2.0.1 + */ limit: number; + /** + * @since Added in 2.0.1 + */ exclusiveStartKey: string; + /** + * @since Added in 2.0.1 + */ isTruncated: boolean; + /** + * @since Added in 2.0.1 + */ nextExclusiveStartKey: string; + /** + * @since Added in 2.0.1 + */ items: KeyValueListItem[]; } /** * Metadata about a single key in a Key-Value Store. + * @since Added in 2.0.1 */ export interface KeyValueListItem { + /** + * @since Added in 2.0.1 + */ key: string; + /** + * @since Added in 2.0.1 + */ size: number; + /** + * @since Added in 2.15.1 + */ recordPublicUrl: string; } /** * Options for retrieving a record from a Key-Value Store. + * @since Added in 2.0.1 */ export interface KeyValueClientGetRecordOptions { + /** + * @since Added in 2.0.1 + */ buffer?: boolean; + /** + * @since Added in 2.0.1 + */ stream?: boolean; + /** + * @since Added in 2.18.0 + */ signature?: string; } @@ -605,18 +744,35 @@ export interface KeyValueClientGetRecordOptions { * Represents a record (key-value pair) in a Key-Value Store. * * @template T - The type of the record's value + * @since Added in 0.1.39 */ export interface KeyValueStoreRecord { + /** + * @since Added in 2.0.1 + */ key: string; + /** + * @since Added in 2.0.1 + */ value: T; + /** + * @since Added in 2.0.1 + */ contentType?: string; } /** * Options for storing a record in a Key-Value Store. + * @since Added in 2.12.4 */ export interface KeyValueStoreRecordOptions { + /** + * @since Added in 2.12.4 + */ timeoutSecs?: number; + /** + * @since Added in 2.12.4 + */ doNotRetryTimeouts?: boolean; } @@ -625,6 +781,7 @@ export interface KeyValueStoreRecordOptions { * * Returns Readable if stream option is true, Buffer if buffer option is true, * otherwise returns JsonValue. + * @since Added in 2.0.6 */ export type ReturnTypeFromOptions = Options['stream'] extends true ? Readable diff --git a/src/resource_clients/key_value_store_collection.ts b/src/resource_clients/key_value_store_collection.ts index 5e96dc7fc..6c6342b87 100644 --- a/src/resource_clients/key_value_store_collection.ts +++ b/src/resource_clients/key_value_store_collection.ts @@ -26,6 +26,7 @@ import type { KeyValueStore } from './key_value_store'; * ``` * * @see https://docs.apify.com/platform/storage/key-value-store + * @since Added in 1.0.0 */ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { /** @@ -57,6 +58,7 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { * @param options - Pagination options. * @returns A paginated iterator of Key-value stores. * @see https://docs.apify.com/api/v2/key-value-stores-get + * @since Added in 2.0.1 */ list( options: KeyValueStoreCollectionClientListOptions = {}, @@ -82,6 +84,7 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { * @param options - Additional options like schema. * @returns The key-value store object. * @see https://docs.apify.com/api/v2/key-value-stores-post + * @since Added in 2.0.1 */ async getOrCreate( name?: string, @@ -94,15 +97,36 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.0.1 + */ export interface KeyValueStoreCollectionClientListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ unnamed?: boolean; + /** + * @since Added in 2.0.1 + */ desc?: boolean; - /** Filter by ownership: 'ownedByMe' returns only user's own key-value stores, 'sharedWithMe' returns only shared key-value stores. */ + /** + * Filter by ownership: 'ownedByMe' returns only user's own key-value stores, 'sharedWithMe' returns only shared key-value stores. + * @since Added in 2.22.1 + */ ownership?: STORAGE_OWNERSHIP_FILTER; } +/** + * @since Added in 2.3.0 + */ export interface KeyValueStoreCollectionClientGetOrCreateOptions { + /** + * @since Added in 2.3.0 + */ schema?: Record; } +/** + * @since Added in 2.0.1 + */ export type KeyValueStoreCollectionListResult = PaginatedList & { unnamed: boolean }; diff --git a/src/resource_clients/log.ts b/src/resource_clients/log.ts index 497373ba2..32f59e72c 100644 --- a/src/resource_clients/log.ts +++ b/src/resource_clients/log.ts @@ -33,6 +33,7 @@ import { cast, catchNotFoundOrThrow } from '../utils'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds#logging + * @since Added in 1.0.0 */ export class LogClient extends ResourceClient { /** @@ -52,6 +53,7 @@ export class LogClient extends ResourceClient { * @param options.raw - If `true`, returns raw log content without any processing. Default is `false`. * @returns The log content as a string, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/log-get + * @since Added in 2.0.1 */ async get(options: LogOptions = {}): Promise { const requestOpts: ApifyRequestConfig = { @@ -77,6 +79,7 @@ export class LogClient extends ResourceClient { * @param options.raw - If `true`, returns raw log content without any processing. Default is `false`. * @returns The log content as a Readable stream, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/log-get + * @since Added in 2.0.1 */ async stream(options: LogOptions = {}): Promise { const params = { @@ -102,19 +105,29 @@ export class LogClient extends ResourceClient { } } +/** + * @since Added in 2.20.0 + */ export interface LogOptions { - /** @default false */ + /** + * @default false + * @since Added in 2.20.0 + */ raw?: boolean; } /** * Logger for redirected actor logs. + * @since Added in 2.20.0 */ export class LoggerActorRedirect extends Logger { constructor(options = {}) { super({ skipTime: true, level: LogLevel.DEBUG, ...options }); } + /** + * @since Added in 2.20.0 + */ override _log(level: LogLevel, message: string, data?: any, exception?: unknown, opts: Record = {}) { if (level > this.options.level) { return; @@ -141,6 +154,7 @@ export class LoggerActorRedirect extends Logger { /** * Helper class for redirecting streamed Actor logs to another log. + * @since Added in 2.20.0 */ export class StreamedLog { private destinationLog: Log; @@ -161,6 +175,7 @@ export class StreamedLog { /** * Start log redirection. + * @since Added in 2.20.0 */ public start(): void { if (this.streamingTask) { @@ -172,6 +187,7 @@ export class StreamedLog { /** * Stop log redirection. + * @since Added in 2.20.0 */ public async stop(): Promise { if (!this.streamingTask) { @@ -264,11 +280,23 @@ export class StreamedLog { } } +/** + * @since Added in 2.20.0 + */ export interface StreamedLogOptions { - /** Log client used to communicate with the Apify API. */ + /** + * Log client used to communicate with the Apify API. + * @since Added in 2.20.0 + */ logClient: LogClient; - /** Log to which the Actor run logs will be redirected. */ + /** + * Log to which the Actor run logs will be redirected. + * @since Added in 2.20.0 + */ toLog: Log; - /** Whether to redirect all logs from Actor run start (even logs from the past). */ + /** + * Whether to redirect all logs from Actor run start (even logs from the past). + * @since Added in 2.20.0 + */ fromStart?: boolean; } diff --git a/src/resource_clients/request_queue.ts b/src/resource_clients/request_queue.ts index 9d7ee190d..53a6caacd 100644 --- a/src/resource_clients/request_queue.ts +++ b/src/resource_clients/request_queue.ts @@ -54,6 +54,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01% * ``` * * @see https://docs.apify.com/platform/storage/request-queue + * @since Added in 1.0.0 */ export class RequestQueueClient extends ResourceClient { private clientKey?: string; @@ -78,6 +79,7 @@ export class RequestQueueClient extends ResourceClient { * * @returns The RequestQueue object, or `undefined` if it does not exist * @see https://docs.apify.com/api/v2/request-queue-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get({}, SMALL_TIMEOUT_MILLIS); @@ -89,6 +91,7 @@ export class RequestQueueClient extends ResourceClient { * @param newFields - Fields to update in the Request queue * @returns The updated RequestQueue object * @see https://docs.apify.com/api/v2/request-queue-put + * @since Added in 2.0.1 */ async update(newFields: RequestQueueClientUpdateOptions): Promise { ow(newFields, ow.object); @@ -100,6 +103,7 @@ export class RequestQueueClient extends ResourceClient { * Deletes the Request queue. * * @see https://docs.apify.com/api/v2/request-queue-delete + * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(SMALL_TIMEOUT_MILLIS); @@ -114,6 +118,7 @@ export class RequestQueueClient extends ResourceClient { * @param options - Options for listing (e.g., limit) * @returns List of requests from the queue head * @see https://docs.apify.com/api/v2/request-queue-head-get + * @since Added in 2.0.1 */ async listHead(options: RequestQueueClientListHeadOptions = {}): Promise { ow( @@ -167,6 +172,7 @@ export class RequestQueueClient extends ResourceClient { * await client.requestQueue('my-queue').deleteRequestLock(request.id); * } * ``` + * @since Added in 2.4.1 */ async listAndLockHead( options: RequestQueueClientListAndLockHeadOptions, @@ -230,6 +236,7 @@ export class RequestQueueClient extends ResourceClient { * { forefront: true } * ); * ``` + * @since Added in 2.0.1 */ async addRequest( request: Omit, @@ -407,6 +414,7 @@ export class RequestQueueClient extends ResourceClient { * { maxUnprocessedRequestsRetries: 5, maxParallel: 10 } * ); * ``` + * @since Added in 2.1.0 */ async batchAddRequests( requests: Omit[], @@ -477,6 +485,7 @@ export class RequestQueueClient extends ResourceClient { * @param requests - Array of requests to delete (by id or uniqueKey) * @returns Result containing processed and unprocessed requests * @see https://docs.apify.com/api/v2/request-queue-requests-batch-delete + * @since Added in 2.3.0 */ async batchDeleteRequests( requests: RequestQueueClientRequestToDelete[], @@ -510,6 +519,7 @@ export class RequestQueueClient extends ResourceClient { * @param id - Request ID * @returns The request object, or `undefined` if not found * @see https://docs.apify.com/api/v2/request-queue-request-get + * @since Added in 2.0.1 */ async getRequest(id: string): Promise { ow(id, ow.string); @@ -536,6 +546,7 @@ export class RequestQueueClient extends ResourceClient { * @param options - Update options such as whether to move to front * @returns Information about the updated request * @see https://docs.apify.com/api/v2/request-queue-request-put + * @since Added in 2.0.1 */ async updateRequest( request: RequestQueueClientRequestSchema, @@ -573,6 +584,7 @@ export class RequestQueueClient extends ResourceClient { * Deletes a specific request from the queue. * * @param id - Request ID + * @since Added in 2.0.1 */ async deleteRequest(id: string): Promise { ow(id, ow.string); @@ -610,6 +622,7 @@ export class RequestQueueClient extends ResourceClient { * // Processing takes longer than expected, extend the lock * await client.requestQueue('my-queue').prolongRequestLock(request.id, { lockSecs: 120 }); * ``` + * @since Added in 2.4.1 */ async prolongRequestLock( id: string, @@ -647,6 +660,7 @@ export class RequestQueueClient extends ResourceClient { * @param id - Request ID * @param options - Options such as whether to move to front * @see https://docs.apify.com/api/v2/request-queue-request-lock-delete + * @since Added in 2.4.1 */ async deleteRequestLock(id: string, options: RequestQueueClientDeleteRequestLockOptions = {}): Promise { ow(id, ow.string); @@ -677,6 +691,7 @@ export class RequestQueueClient extends ResourceClient { * @param options - Pagination options * @returns List of requests with pagination information * @see https://docs.apify.com/api/v2/request-queue-requests-get + * @since Added in 2.5.1 */ listRequests( options: RequestQueueClientListRequestsOptions = {}, @@ -752,6 +767,7 @@ export class RequestQueueClient extends ResourceClient { * * @returns Number of requests that were unlocked * @see https://docs.apify.com/api/v2/request-queue-requests-unlock-post + * @since Added in 2.12.5 */ async unlockRequests(): Promise { const response = await this.httpClient.call({ @@ -782,6 +798,7 @@ export class RequestQueueClient extends ResourceClient { * items.forEach((request) => console.log(request.url)); * } * ``` + * @since Added in 2.5.1 */ paginateRequests( options: RequestQueueClientPaginateRequestsOptions = {}, @@ -818,9 +835,16 @@ export class RequestQueueClient extends ResourceClient { /** * User-specific options for RequestQueueClient. + * @since Added in 2.0.1 */ export interface RequestQueueUserOptions { + /** + * @since Added in 2.0.1 + */ clientKey?: string; + /** + * @since Added in 2.2.0 + */ timeoutSecs?: number; } @@ -829,109 +853,257 @@ export interface RequestQueueUserOptions { * * Request queues store URLs (requests) to be processed by web crawlers. They provide * automatic deduplication, request locking for parallel processing, and persistence. + * @since Added in 0.2.4 */ export interface RequestQueue { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ name?: string; + /** + * @since Added in 2.6.1 + */ title?: string; + /** + * @since Added in 2.0.1 + */ userId: string; + /** + * @since Added in 2.21.0 + */ username?: string; + /** + * @since Added in 2.0.1 + */ createdAt: Date; + /** + * @since Added in 2.0.1 + */ modifiedAt: Date; + /** + * @since Added in 2.0.1 + */ accessedAt: Date; + /** + * @since Added in 2.0.1 + */ expireAt?: string; + /** + * @since Added in 2.0.1 + */ totalRequestCount: number; + /** + * @since Added in 2.0.1 + */ handledRequestCount: number; + /** + * @since Added in 2.0.1 + */ pendingRequestCount: number; + /** + * @since Added in 2.0.1 + */ actId?: string; + /** + * @since Added in 2.0.1 + */ actRunId?: string; + /** + * @since Added in 2.0.1 + */ hadMultipleClients: boolean; + /** + * @since Added in 2.0.1 + */ stats: RequestQueueStats; + /** + * @since Added in 2.12.2 + */ generalAccess?: STORAGE_GENERAL_ACCESS | null; } /** * Statistics about Request Queue usage and storage. + * @since Added in 2.0.1 */ export interface RequestQueueStats { + /** + * @since Added in 2.0.1 + */ readCount?: number; + /** + * @since Added in 2.0.1 + */ writeCount?: number; + /** + * @since Added in 2.0.1 + */ deleteCount?: number; + /** + * @since Added in 2.0.1 + */ headItemReadCount?: number; + /** + * @since Added in 2.0.1 + */ storageBytes?: number; } /** * Options for updating a Request Queue. + * @since Added in 2.0.1 */ export interface RequestQueueClientUpdateOptions { + /** + * @since Added in 2.0.1 + */ name?: string | null; + /** + * @since Added in 2.6.1 + */ title?: string; + /** + * @since Added in 2.12.2 + */ generalAccess?: STORAGE_GENERAL_ACCESS | null; } /** * Options for listing requests from the queue head. + * @since Added in 2.0.1 */ export interface RequestQueueClientListHeadOptions { + /** + * @since Added in 2.0.1 + */ limit?: number; } /** * Result of listing requests from the queue head. + * @since Added in 2.0.1 */ export interface RequestQueueClientListHeadResult { + /** + * @since Added in 2.0.1 + */ limit: number; + /** + * @since Added in 2.0.1 + */ queueModifiedAt: Date; + /** + * @since Added in 2.0.1 + */ hadMultipleClients: boolean; + /** + * @since Added in 2.0.1 + */ items: RequestQueueClientListItem[]; } +/** + * @since Added in 2.23.2 + */ export type RequestQueueListRequestsFilter = 'locked' | 'pending'; /** * Options for listing all requests in the queue. + * @since Added in 2.5.1 */ export interface RequestQueueClientListRequestsOptions { + /** + * @since Added in 2.5.1 + */ limit?: number; /** * Using id of request that does not exist in request queue leads to unpredictable results. * @deprecated Use `cursor` for pagination instead. + * @since Added in 2.5.1 */ exclusiveStartId?: string; + /** + * @since Added in 2.23.2 + */ cursor?: string; + /** + * @since Added in 2.23.2 + */ filter?: readonly RequestQueueListRequestsFilter[]; } /** * Options for paginating through requests in the queue. + * @since Added in 2.5.1 */ export interface RequestQueueClientPaginateRequestsOptions { + /** + * @since Added in 2.5.1 + */ limit?: number; + /** + * @since Added in 2.5.1 + */ maxPageLimit?: number; - /** @deprecated Use `cursor` for pagination instead. */ + /** + * @deprecated Use `cursor` for pagination instead. + * @since Added in 2.5.1 + */ exclusiveStartId?: string; + /** + * @since Added in 2.23.2 + */ cursor?: string; + /** + * @since Added in 2.23.2 + */ filter?: readonly RequestQueueListRequestsFilter[]; } /** * Result of listing all requests in the queue. + * @since Added in 2.5.1 */ export interface RequestQueueClientListRequestsResult { + /** + * @since Added in 2.5.1 + */ limit: number; - /** @deprecated Use `cursor` for pagination instead. */ + /** + * @deprecated Use `cursor` for pagination instead. + * @since Added in 2.5.1 + */ exclusiveStartId?: string; + /** + * @since Added in 2.23.2 + */ cursor?: string; + /** + * @since Added in 2.23.2 + */ nextCursor?: string; + /** + * @since Added in 2.5.1 + */ items: RequestQueueClientRequestSchema[]; } /** * Options for listing and locking requests from the queue head. + * @since Added in 2.4.1 */ export interface RequestQueueClientListAndLockHeadOptions { + /** + * @since Added in 2.4.1 + */ lockSecs: number; + /** + * @since Added in 2.4.1 + */ limit?: number; } @@ -939,46 +1111,117 @@ export interface RequestQueueClientListAndLockHeadOptions { * Result of listing and locking requests from the queue head. * * Extends {@link RequestQueueClientListHeadResult} with lock information. + * @since Added in 2.4.1 */ export interface RequestQueueClientListAndLockHeadResult extends RequestQueueClientListHeadResult { + /** + * @since Added in 2.4.1 + */ lockSecs: number; + /** + * @since Added in 2.11.0 + */ queueHasLockedRequests: boolean; + /** + * @since Added in 2.11.0 + */ clientKey: string; } /** * Simplified request information used in list results. + * @since Added in 2.0.1 */ export interface RequestQueueClientListItem { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ retryCount: number; + /** + * @since Added in 2.0.1 + */ uniqueKey: string; + /** + * @since Added in 2.0.1 + */ url: string; + /** + * @since Added in 2.0.1 + */ method: AllowedHttpMethods; + /** + * @since Added in 2.4.1 + */ lockExpiresAt?: Date; } +/** + * @since Added in 2.0.1 + */ export interface RequestQueueClientAddRequestOptions { + /** + * @since Added in 2.0.1 + */ forefront?: boolean; } +/** + * @since Added in 2.4.1 + */ export interface RequestQueueClientProlongRequestLockOptions { + /** + * @since Added in 2.4.1 + */ forefront?: boolean; + /** + * @since Added in 2.4.1 + */ lockSecs: number; } +/** + * @since Added in 2.4.1 + */ export interface RequestQueueClientDeleteRequestLockOptions { + /** + * @since Added in 2.4.1 + */ forefront?: boolean; } +/** + * @since Added in 2.4.1 + */ export interface RequestQueueClientProlongRequestLockResult { + /** + * @since Added in 2.4.1 + */ lockExpiresAt: Date; } +/** + * @since Added in 2.3.0 + */ export interface RequestQueueClientBatchAddRequestWithRetriesOptions { + /** + * @since Added in 2.3.0 + */ forefront?: boolean; + /** + * @since Added in 2.3.0 + */ maxUnprocessedRequestsRetries?: number; + /** + * @since Added in 2.3.0 + */ maxParallel?: number; + /** + * @since Added in 2.4.0 + */ minDelayBetweenUnprocessedRequestsRetriesMillis?: number; } @@ -986,28 +1229,75 @@ export interface RequestQueueClientBatchAddRequestWithRetriesOptions { * Complete schema for a request in the queue. * * Represents a URL to be crawled along with its metadata, retry information, and custom data. + * @since Added in 2.0.1 */ export interface RequestQueueClientRequestSchema { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ uniqueKey: string; + /** + * @since Added in 2.0.1 + */ url: string; + /** + * @since Added in 2.0.1 + */ method?: AllowedHttpMethods; + /** + * @since Added in 2.0.1 + */ payload?: string; + /** + * @since Added in 2.0.1 + */ retryCount?: number; + /** + * @since Added in 2.0.1 + */ errorMessages?: string[]; + /** + * @since Added in 2.0.1 + */ headers?: Record; + /** + * @since Added in 2.0.1 + */ userData?: Record; + /** + * @since Added in 2.0.1 + */ handledAt?: string; + /** + * @since Added in 2.0.1 + */ noRetry?: boolean; + /** + * @since Added in 2.0.1 + */ loadedUrl?: string; } /** * Result of adding a request to the queue. + * @since Added in 2.0.1 */ export interface RequestQueueClientAddRequestResult { + /** + * @since Added in 2.0.1 + */ requestId: string; + /** + * @since Added in 2.0.1 + */ wasAlreadyPresent: boolean; + /** + * @since Added in 2.0.1 + */ wasAlreadyHandled: boolean; } @@ -1024,7 +1314,13 @@ interface UnprocessedRequest { method?: AllowedHttpMethods; } +/** + * @since Added in 2.12.5 + */ export interface RequestQueueClientUnlockRequestsResult { + /** + * @since Added in 2.12.5 + */ unlockedCount: number; } @@ -1032,21 +1328,38 @@ export interface RequestQueueClientUnlockRequestsResult { * Result of a batch operation on requests. * * Contains lists of successfully processed and unprocessed requests. + * @since Added in 2.3.0 */ export interface RequestQueueClientBatchRequestsOperationResult { + /** + * @since Added in 2.3.0 + */ processedRequests: ProcessedRequest[]; + /** + * @since Added in 2.3.0 + */ unprocessedRequests: UnprocessedRequest[]; } +/** + * @since Added in 2.3.0 + */ export type RequestQueueClientRequestToDelete = | Pick | Pick; +/** + * @since Added in 2.0.1 + */ export type RequestQueueClientGetRequestResult = Omit; /** * HTTP methods supported by Request Queue requests. + * @since Added in 2.0.1 */ export type AllowedHttpMethods = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'OPTIONS' | 'CONNECT' | 'PATCH'; +/** + * @since Added in 2.5.1 + */ export type RequestQueueRequestsAsyncIterable = AsyncIterable; diff --git a/src/resource_clients/request_queue_collection.ts b/src/resource_clients/request_queue_collection.ts index b81aa9c91..b738cef3a 100644 --- a/src/resource_clients/request_queue_collection.ts +++ b/src/resource_clients/request_queue_collection.ts @@ -26,6 +26,7 @@ import type { RequestQueue } from './request_queue'; * ``` * * @see https://docs.apify.com/platform/storage/request-queue + * @since Added in 1.0.0 */ export class RequestQueueCollectionClient extends ResourceCollectionClient { /** @@ -57,6 +58,7 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient { * @param options - Pagination options. * @returns A paginated iterator of Request queues. * @see https://docs.apify.com/api/v2/request-queues-get + * @since Added in 2.0.1 */ list( options: RequestQueueCollectionListOptions = {}, @@ -81,6 +83,7 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient { * @param name - Name of the Request queue. If not provided, a default queue is used. * @returns The Request queue object. * @see https://docs.apify.com/api/v2/request-queues-post + * @since Added in 2.0.1 */ async getOrCreate(name?: string): Promise { ow(name, ow.optional.string); @@ -89,11 +92,26 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.0.1 + */ export interface RequestQueueCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ unnamed?: boolean; + /** + * @since Added in 2.0.1 + */ desc?: boolean; - /** Filter by ownership: 'ownedByMe' returns only user's own request queues, 'sharedWithMe' returns only shared request queues. */ + /** + * Filter by ownership: 'ownedByMe' returns only user's own request queues, 'sharedWithMe' returns only shared request queues. + * @since Added in 2.22.1 + */ ownership?: STORAGE_OWNERSHIP_FILTER; } +/** + * @since Added in 2.0.1 + */ export type RequestQueueCollectionListResult = PaginatedList & { unnamed: boolean }; diff --git a/src/resource_clients/run.ts b/src/resource_clients/run.ts index cf9066db2..f197feb45 100644 --- a/src/resource_clients/run.ts +++ b/src/resource_clients/run.ts @@ -38,6 +38,7 @@ const RUN_CHARGE_IDEMPOTENCY_HEADER = 'idempotency-key'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds + * @since Added in 1.0.0 */ export class RunClient extends ResourceClient { /** @@ -67,6 +68,7 @@ export class RunClient extends ResourceClient { * // Wait up to 60 seconds for run to finish * const run = await client.run('run-id').get({ waitForFinish: 60 }); * ``` + * @since Added in 2.0.1 */ async get(options: RunGetOptions = {}): Promise { ow( @@ -95,6 +97,7 @@ export class RunClient extends ResourceClient { * // Abort gracefully (allows cleanup) * await client.run('run-id').abort({ gracefully: true }); * ``` + * @since Added in 2.0.1 */ async abort(options: RunAbortOptions = {}): Promise { ow( @@ -117,6 +120,7 @@ export class RunClient extends ResourceClient { * Deletes the Actor run. * * @see https://docs.apify.com/api/v2/actor-run-delete + * @since Added in 2.8.1 */ async delete(): Promise { return this._delete(); @@ -146,6 +150,7 @@ export class RunClient extends ResourceClient { * ); * console.log(`Run ${metamorphedRun.id} is now running ${metamorphedRun.actId}`); * ``` + * @since Added in 2.0.1 */ async metamorph(targetActorId: string, input: unknown, options: RunMetamorphOptions = {}): Promise { ow(targetActorId, ow.string); @@ -201,6 +206,7 @@ export class RunClient extends ResourceClient { * ```javascript * const run = await client.run('run-id').reboot(); * ``` + * @since Added in 2.8.0 */ async reboot(): Promise { const request: AxiosRequestConfig = { @@ -228,6 +234,7 @@ export class RunClient extends ResourceClient { * statusMessage: 'Processing items: 50/100' * }); * ``` + * @since Added in 2.6.0 */ async update(newFields: RunUpdateOptions): Promise { ow(newFields, ow.object); @@ -257,6 +264,7 @@ export class RunClient extends ResourceClient { * const newRun = await client.run('failed-run-id').resurrect({ memory: 2048 }); * console.log(`New run started: ${newRun.id}`); * ``` + * @since Added in 2.0.1 */ async resurrect(options: RunResurrectOptions = {}): Promise { ow( @@ -289,6 +297,7 @@ export class RunClient extends ResourceClient { * @param options.idempotencyKey - Optional key to ensure the charge is not duplicated. If not provided, one is auto-generated. * @returns Empty response object. * @see https://docs.apify.com/api/v2/post-charge-run + * @since Added in 2.11.0 */ async charge(options: RunChargeOptions): Promise>> { ow( @@ -348,6 +357,7 @@ export class RunClient extends ResourceClient { * console.log('Run succeeded!'); * } * ``` + * @since Added in 2.0.1 */ async waitForFinish(options: RunWaitForFinishOptions = {}): Promise { ow( @@ -371,6 +381,7 @@ export class RunClient extends ResourceClient { * // Access run's dataset * const { items } = await client.run('run-id').dataset().listItems(); * ``` + * @since Added in 2.0.1 */ dataset(): DatasetClient { return new DatasetClient( @@ -391,6 +402,7 @@ export class RunClient extends ResourceClient { * // Access run's key-value store * const output = await client.run('run-id').keyValueStore().getRecord('OUTPUT'); * ``` + * @since Added in 2.0.1 */ keyValueStore(): KeyValueStoreClient { return new KeyValueStoreClient( @@ -411,6 +423,7 @@ export class RunClient extends ResourceClient { * // Access run's Request queue * const { items } = await client.run('run-id').requestQueue().listHead(); * ``` + * @since Added in 2.0.1 */ requestQueue(): RequestQueueClient { return new RequestQueueClient( @@ -432,6 +445,7 @@ export class RunClient extends ResourceClient { * const log = await client.run('run-id').log().get(); * console.log(log); * ``` + * @since Added in 2.0.1 */ log(): LogClient { return new LogClient( @@ -443,6 +457,7 @@ export class RunClient extends ResourceClient { /** * Get StreamedLog for convenient streaming of the run log and their redirection. + * @since Added in 2.20.0 */ async getStreamedLog(options: GetStreamedLogOptions = {}): Promise { const { fromStart = true } = options; @@ -472,75 +487,138 @@ export class RunClient extends ResourceClient { /** * Options for getting a streamed log. + * @since Added in 2.20.0 */ export interface GetStreamedLogOptions { + /** + * @since Added in 2.20.0 + */ toLog?: Log | null | 'default'; + /** + * @since Added in 2.20.0 + */ fromStart?: boolean; } /** * Options for getting a Run. + * @since Added in 2.0.1 */ export interface RunGetOptions { + /** + * @since Added in 2.0.1 + */ waitForFinish?: number; } /** * Options for aborting a Run. + * @since Added in 2.0.1 */ export interface RunAbortOptions { + /** + * @since Added in 2.0.1 + */ gracefully?: boolean; } /** * Options for metamorphing a Run into another Actor. + * @since Added in 2.0.1 */ export interface RunMetamorphOptions { + /** + * @since Added in 2.0.1 + */ contentType?: string; + /** + * @since Added in 2.0.1 + */ build?: string; } /** * Options for updating a Run. + * @since Added in 2.6.0 */ export interface RunUpdateOptions { + /** + * @since Added in 2.6.0 + */ statusMessage?: string; + /** + * @since Added in 2.6.3 + */ isStatusMessageTerminal?: boolean; + /** + * @since Added in 2.12.2 + */ generalAccess?: RUN_GENERAL_ACCESS | null; } /** * Options for resurrecting a finished Run. + * @since Added in 2.0.1 */ export interface RunResurrectOptions { + /** + * @since Added in 2.0.1 + */ build?: string; + /** + * @since Added in 2.0.1 + */ memory?: number; + /** + * @since Added in 2.0.1 + */ timeout?: number; + /** + * @since Added in 2.12.1 + */ maxItems?: number; + /** + * @since Added in 2.12.1 + */ maxTotalChargeUsd?: number; + /** + * @since Added in 2.19.0 + */ restartOnError?: boolean; } /** * Options for charging events in a pay-per-event Actor run. + * @since Added in 2.11.0 */ export interface RunChargeOptions { - /** Name of the event to charge. Must be defined in the Actor's pricing info else the API will throw. */ + /** + * Name of the event to charge. Must be defined in the Actor's pricing info else the API will throw. + * @since Added in 2.11.0 + */ eventName: string; - /** Defaults to 1 */ + /** + * Defaults to 1 + * @since Added in 2.11.0 + */ count?: number; - /** Defaults to runId-eventName-timestamp */ + /** + * Defaults to runId-eventName-timestamp + * @since Added in 2.11.0 + */ idempotencyKey?: string; } /** * Options for waiting for a Run to finish. + * @since Added in 2.0.1 */ export interface RunWaitForFinishOptions { /** * Maximum time to wait for the run to finish, in seconds. * If the limit is reached, the returned promise is resolved to a run object that will have * status `READY` or `RUNNING`. If `waitSecs` omitted, the function waits indefinitely. + * @since Added in 2.0.1 */ waitSecs?: number; } diff --git a/src/resource_clients/run_collection.ts b/src/resource_clients/run_collection.ts index 9630efef7..26d4d1be7 100644 --- a/src/resource_clients/run_collection.ts +++ b/src/resource_clients/run_collection.ts @@ -27,6 +27,7 @@ import type { ActorRunListItem } from './actor'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds + * @since Added in 1.0.0 */ export class RunCollectionClient extends ResourceCollectionClient { /** @@ -58,6 +59,7 @@ export class RunCollectionClient extends ResourceCollectionClient { * @param options - Pagination and filtering options. * @returns A paginated iterator of Actor runs. * @see https://docs.apify.com/api/v2/actor-runs-get + * @since Added in 2.0.1 */ list(options: RunCollectionListOptions = {}): PaginatedIterator { ow( @@ -79,11 +81,26 @@ export class RunCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.0.1 + */ export interface RunCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ desc?: boolean; + /** + * @since Added in 2.0.1 + */ status?: | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES] | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES][]; + /** + * @since Added in 2.18.0 + */ startedBefore?: Date | string; + /** + * @since Added in 2.18.0 + */ startedAfter?: Date | string; } diff --git a/src/resource_clients/schedule.ts b/src/resource_clients/schedule.ts index e7c4bee1a..dad33078d 100644 --- a/src/resource_clients/schedule.ts +++ b/src/resource_clients/schedule.ts @@ -30,6 +30,7 @@ import { cast, catchNotFoundOrThrow, parseDateFields, pluckData } from '../utils * ``` * * @see https://docs.apify.com/platform/schedules + * @since Added in 1.0.0 */ export class ScheduleClient extends ResourceClient { /** @@ -47,6 +48,7 @@ export class ScheduleClient extends ResourceClient { * * @returns The schedule object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/schedule-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -58,6 +60,7 @@ export class ScheduleClient extends ResourceClient { * @param newFields - Fields to update. * @returns The updated schedule object. * @see https://docs.apify.com/api/v2/schedule-put + * @since Added in 2.0.1 */ async update(newFields: ScheduleCreateOrUpdateData): Promise { ow(newFields, ow.object); @@ -68,6 +71,7 @@ export class ScheduleClient extends ResourceClient { * Deletes the schedule. * * @see https://docs.apify.com/api/v2/schedule-delete + * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -78,6 +82,7 @@ export class ScheduleClient extends ResourceClient { * * @returns The schedule log as a string, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/schedule-log-get + * @since Added in 2.0.1 */ async getLog(): Promise { const requestOpts: ApifyRequestConfig = { @@ -100,22 +105,68 @@ export class ScheduleClient extends ResourceClient { * Represents a schedule for automated Actor or Task runs. * * Schedules use cron expressions to define when Actors or Tasks should run automatically. + * @since Added in 1.0.0 */ export interface Schedule { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ userId: string; + /** + * @since Added in 2.0.1 + */ name: string; + /** + * @since Added in 2.6.1 + */ title?: string; + /** + * @since Added in 2.0.1 + */ cronExpression: string; + /** + * @since Added in 2.0.1 + */ timezone: Timezone; + /** + * @since Added in 2.0.1 + */ isEnabled: boolean; + /** + * @since Added in 2.0.1 + */ isExclusive: boolean; + /** + * @since Added in 2.0.1 + */ description?: string; + /** + * @since Added in 2.0.1 + */ createdAt: Date; + /** + * @since Added in 2.0.1 + */ modifiedAt: Date; + /** + * @since Added in 2.0.1 + */ nextRunAt: string; + /** + * @since Added in 2.0.1 + */ lastRunAt: string; + /** + * @since Added in 2.0.1 + */ actions: ScheduleAction[]; + /** + * @since Added in 2.9.4 + */ notifications: { email: boolean; }; @@ -123,6 +174,7 @@ export interface Schedule { /** * Data for creating or updating a Schedule. + * @since Added in 2.6.2 */ export type ScheduleCreateOrUpdateData = Partial< Pick< @@ -135,53 +187,104 @@ export type ScheduleCreateOrUpdateData = Partial< /** * Types of actions that can be scheduled. + * @since Added in 2.0.1 */ export enum ScheduleActions { + /** + * @since Added in 2.0.1 + */ RunActor = 'RUN_ACTOR', + /** + * @since Added in 2.0.1 + */ RunActorTask = 'RUN_ACTOR_TASK', } interface BaseScheduleAction { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ type: Type; } /** * Union type representing all possible scheduled actions. + * @since Added in 2.0.1 */ export type ScheduleAction = ScheduleActionRunActor | ScheduleActionRunActorTask; /** * Scheduled action to run an Actor. + * @since Added in 2.0.1 */ export interface ScheduleActionRunActor extends BaseScheduleAction { + /** + * @since Added in 2.0.1 + */ actorId: string; + /** + * @since Added in 2.0.1 + */ runInput?: ScheduledActorRunInput; + /** + * @since Added in 2.0.1 + */ runOptions?: ScheduledActorRunOptions; } /** * Input configuration for a scheduled Actor run. + * @since Added in 2.0.1 */ export interface ScheduledActorRunInput { + /** + * @since Added in 2.0.1 + */ body: string; + /** + * @since Added in 2.0.1 + */ contentType: string; } /** * Run options for a scheduled Actor run. + * @since Added in 2.0.1 */ export interface ScheduledActorRunOptions { + /** + * @since Added in 2.0.1 + */ build: string; + /** + * @since Added in 2.0.1 + */ timeoutSecs: number; + /** + * @since Added in 2.0.1 + */ memoryMbytes: number; + /** + * @since Added in 2.19.0 + */ restartOnError?: boolean; } /** * Scheduled action to run an Actor task. + * @since Added in 2.0.1 */ export interface ScheduleActionRunActorTask extends BaseScheduleAction { + /** + * @since Added in 2.0.1 + */ actorTaskId: string; + /** + * @since Added in 2.0.1 + */ input?: string; } diff --git a/src/resource_clients/schedule_collection.ts b/src/resource_clients/schedule_collection.ts index 6a0462634..0d87dcbf8 100644 --- a/src/resource_clients/schedule_collection.ts +++ b/src/resource_clients/schedule_collection.ts @@ -28,6 +28,7 @@ import type { Schedule, ScheduleCreateOrUpdateData } from './schedule'; * ``` * * @see https://docs.apify.com/platform/schedules + * @since Added in 1.0.0 */ export class ScheduleCollectionClient extends ResourceCollectionClient { /** @@ -59,6 +60,7 @@ export class ScheduleCollectionClient extends ResourceCollectionClient { * @param options - Pagination and sorting options. * @returns A paginated iterator of schedules. * @see https://docs.apify.com/api/v2/schedules-get + * @since Added in 2.0.1 */ list(options: ScheduleCollectionListOptions = {}): PaginatedIterator { ow( @@ -79,6 +81,7 @@ export class ScheduleCollectionClient extends ResourceCollectionClient { * @param schedule - The schedule data. * @returns The created schedule object. * @see https://docs.apify.com/api/v2/schedules-post + * @since Added in 2.0.1 */ async create(schedule?: ScheduleCreateOrUpdateData): Promise { ow(schedule, ow.optional.object); @@ -87,6 +90,12 @@ export class ScheduleCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.0.1 + */ export interface ScheduleCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ desc?: boolean; } diff --git a/src/resource_clients/store_collection.ts b/src/resource_clients/store_collection.ts index 1c89437b2..5e37b33dd 100644 --- a/src/resource_clients/store_collection.ts +++ b/src/resource_clients/store_collection.ts @@ -24,6 +24,7 @@ import type { ActorStats } from './actor'; * ``` * * @see https://docs.apify.com/platform/actors/publishing + * @since Added in 2.7.2 */ export class StoreCollectionClient extends ResourceCollectionClient { /** @@ -55,6 +56,7 @@ export class StoreCollectionClient extends ResourceCollectionClient { * @param options - Search and pagination options. * @returns A paginated iterator of store Actors. * @see https://docs.apify.com/api/v2/store-get + * @since Added in 2.7.2 */ list(options: StoreCollectionListOptions = {}): PaginatedIterator { ow( @@ -75,34 +77,95 @@ export class StoreCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.7.2 + */ export interface PricingInfo { + /** + * @since Added in 2.7.2 + */ pricingModel: string; } +/** + * @since Added in 2.7.2 + */ export interface ActorStoreList { + /** + * @since Added in 2.7.2 + */ id: string; + /** + * @since Added in 2.7.2 + */ name: string; + /** + * @since Added in 2.7.2 + */ username: string; + /** + * @since Added in 2.7.2 + */ title?: string; + /** + * @since Added in 2.7.2 + */ description?: string; + /** + * @since Added in 2.7.2 + */ stats: ActorStats; + /** + * @since Added in 2.7.2 + */ currentPricingInfo: PricingInfo; + /** + * @since Added in 2.7.2 + */ pictureUrl?: string; + /** + * @since Added in 2.7.2 + */ userPictureUrl?: string; + /** + * @since Added in 2.8.6 + */ url: string; - /** A brief, LLM-generated readme summary */ + /** + * A brief, LLM-generated readme summary + * @since Added in 2.22.1 + */ readmeSummary?: string; } +/** + * @since Added in 2.7.2 + */ export interface StoreCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.7.2 + */ search?: string; + /** + * @since Added in 2.7.2 + */ sortBy?: string; + /** + * @since Added in 2.7.2 + */ category?: string; + /** + * @since Added in 2.7.2 + */ username?: string; + /** + * @since Added in 2.7.2 + */ pricingModel?: string; /** * If true, the response will include Actors that cannot be run (e.g., Actors * that require a linked integration account that the current user does not have). + * @since Added in 2.23.0 */ includeUnrunnableActors?: boolean; } diff --git a/src/resource_clients/task.ts b/src/resource_clients/task.ts index 04d832b41..33d967a5f 100644 --- a/src/resource_clients/task.ts +++ b/src/resource_clients/task.ts @@ -32,6 +32,7 @@ import { WebhookCollectionClient } from './webhook_collection'; * ``` * * @see https://docs.apify.com/platform/actors/running/tasks + * @since Added in 1.0.0 */ export class TaskClient extends ResourceClient { /** @@ -49,6 +50,7 @@ export class TaskClient extends ResourceClient { * * @returns The task object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/actor-task-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -60,6 +62,7 @@ export class TaskClient extends ResourceClient { * @param newFields - Fields to update. * @returns The updated task object. * @see https://docs.apify.com/api/v2/actor-task-put + * @since Added in 2.0.1 */ async update(newFields: TaskUpdateData): Promise { ow(newFields, ow.object); @@ -71,6 +74,7 @@ export class TaskClient extends ResourceClient { * Deletes the Task. * * @see https://docs.apify.com/api/v2/actor-task-delete + * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -91,6 +95,7 @@ export class TaskClient extends ResourceClient { * @param options.restartOnError - Whether to restart the run on error. * @returns The Actor Run object. * @see https://docs.apify.com/api/v2/actor-task-runs-post + * @since Added in 2.0.1 */ async start(input?: Dictionary, options: TaskStartOptions = {}): Promise { ow(input, ow.optional.object); @@ -154,6 +159,7 @@ export class TaskClient extends ResourceClient { * @param options.restartOnError - Whether to restart the run on error. * @returns The Actor run object. * @see https://docs.apify.com/api/v2/actor-task-runs-post + * @since Added in 2.0.1 */ async call(input?: Dictionary, options: TaskCallOptions = {}): Promise { ow(input, ow.optional.object); @@ -186,6 +192,7 @@ export class TaskClient extends ResourceClient { * * @returns The Task's input, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/actor-task-input-get + * @since Added in 2.0.1 */ async getInput(): Promise { const requestOpts: ApifyRequestConfig = { @@ -209,6 +216,7 @@ export class TaskClient extends ResourceClient { * @param newFields - New input data for the task. * @returns The updated task input. * @see https://docs.apify.com/api/v2/actor-task-input-put + * @since Added in 2.0.1 */ async updateInput(newFields: Dictionary | Dictionary[]): Promise { const response = await this.httpClient.call({ @@ -229,6 +237,7 @@ export class TaskClient extends ResourceClient { * @param options.origin - Filter by run origin (e.g., `'WEB'`, `'API'`, `'SCHEDULE'`). * @returns A client for the last run. * @see https://docs.apify.com/api/v2/actor-task-runs-last-get + * @since Added in 2.0.1 */ lastRun(options: TaskLastRunOptions = {}): RunClient { ow( @@ -253,6 +262,7 @@ export class TaskClient extends ResourceClient { * * @returns A client for the task's runs. * @see https://docs.apify.com/api/v2/actor-task-runs-get + * @since Added in 2.0.1 */ runs(): RunCollectionClient { return new RunCollectionClient( @@ -267,6 +277,7 @@ export class TaskClient extends ResourceClient { * * @returns A client for the task's webhooks. * @see https://docs.apify.com/api/v2/actor-task-webhooks-get + * @since Added in 2.0.1 */ webhooks(): WebhookCollectionClient { return new WebhookCollectionClient(this._subResourceOptions()); @@ -278,42 +289,100 @@ export class TaskClient extends ResourceClient { * * Tasks are saved Actor configurations with input and settings that can be executed * repeatedly without having to specify the full input each time. + * @since Added in 0.3.2 */ export interface Task { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ userId: string; + /** + * @since Added in 2.0.1 + */ actId: string; + /** + * @since Added in 2.0.1 + */ name: string; + /** + * @since Added in 2.6.1 + */ title?: string; + /** + * @since Added in 2.0.1 + */ description?: string; + /** + * @since Added in 2.0.1 + */ username?: string; + /** + * @since Added in 2.0.1 + */ createdAt: Date; + /** + * @since Added in 2.0.1 + */ modifiedAt: Date; + /** + * @since Added in 2.0.1 + */ stats: TaskStats; + /** + * @since Added in 2.0.1 + */ options?: TaskOptions; + /** + * @since Added in 2.0.1 + */ input?: Dictionary | Dictionary[]; + /** + * @since Added in 2.9.5 + */ actorStandby?: Partial; } /** * Statistics about Actor task usage. + * @since Added in 2.0.1 */ export interface TaskStats { + /** + * @since Added in 2.0.1 + */ totalRuns: number; } /** * Configuration options for an Actor task. + * @since Added in 2.0.1 */ export interface TaskOptions { + /** + * @since Added in 2.0.1 + */ build?: string; + /** + * @since Added in 2.0.1 + */ timeoutSecs?: number; + /** + * @since Added in 2.0.1 + */ memoryMbytes?: number; + /** + * @since Added in 2.19.0 + */ restartOnError?: boolean; } /** * Fields that can be updated when modifying a Task. + * @since Added in 2.0.1 */ export type TaskUpdateData = Partial< Pick @@ -321,8 +390,12 @@ export type TaskUpdateData = Partial< /** * Options for filtering the last run of a Task. + * @since Added in 2.0.1 */ export interface TaskLastRunOptions { + /** + * @since Added in 2.0.1 + */ status?: keyof typeof ACT_JOB_STATUSES; } @@ -331,12 +404,17 @@ export interface TaskLastRunOptions { * * Similar to {@link ActorStartOptions} but without contentType (Task input is predefined) * and forcePermissionLevel. + * @since Added in 2.0.4 */ export type TaskStartOptions = Omit; /** * Options for calling a Task and waiting for it to finish. + * @since Added in 2.6.2 */ export interface TaskCallOptions extends Omit { + /** + * @since Added in 2.6.2 + */ waitSecs?: number; } diff --git a/src/resource_clients/task_collection.ts b/src/resource_clients/task_collection.ts index bfd13b558..0e4e6c977 100644 --- a/src/resource_clients/task_collection.ts +++ b/src/resource_clients/task_collection.ts @@ -28,6 +28,7 @@ import type { Task, TaskUpdateData } from './task'; * ``` * * @see https://docs.apify.com/platform/actors/running/tasks + * @since Added in 1.0.0 */ export class TaskCollectionClient extends ResourceCollectionClient { /** @@ -59,6 +60,7 @@ export class TaskCollectionClient extends ResourceCollectionClient { * @param options - Pagination and sorting options. * @returns A paginated iterator of tasks. * @see https://docs.apify.com/api/v2/actor-tasks-get + * @since Added in 2.0.1 */ list(options: TaskCollectionListOptions = {}): PaginatedIterator { ow( @@ -79,6 +81,7 @@ export class TaskCollectionClient extends ResourceCollectionClient { * @param task - The task data. * @returns The created task object. * @see https://docs.apify.com/api/v2/actor-tasks-post + * @since Added in 2.0.1 */ async create(task: TaskCreateData): Promise { ow(task, ow.object); @@ -87,12 +90,27 @@ export class TaskCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.0.1 + */ export interface TaskCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ desc?: boolean; } +/** + * @since Added in 2.0.1 + */ export type TaskList = Omit; +/** + * @since Added in 2.3.0 + */ export interface TaskCreateData extends TaskUpdateData { + /** + * @since Added in 2.3.0 + */ actId: string; } diff --git a/src/resource_clients/user.ts b/src/resource_clients/user.ts index 0e9de50a4..4de91f004 100644 --- a/src/resource_clients/user.ts +++ b/src/resource_clients/user.ts @@ -27,6 +27,7 @@ import { cast, catchNotFoundOrThrow, parseDateFields, pluckData } from '../utils * ``` * * @see https://docs.apify.com/platform/actors/running + * @since Added in 1.0.0 */ export class UserClient extends ResourceClient { /** @@ -47,6 +48,7 @@ export class UserClient extends ResourceClient { * * @returns The user object. * @see https://docs.apify.com/api/v2/user-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get() as Promise; @@ -57,6 +59,7 @@ export class UserClient extends ResourceClient { * * @returns The monthly usage object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/users-me-usage-monthly-get + * @since Added in 2.9.2 */ async monthlyUsage(): Promise { const requestOpts: ApifyRequestConfig = { @@ -85,6 +88,7 @@ export class UserClient extends ResourceClient { * * @returns The account and usage limits object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/users-me-limits-get + * @since Added in 2.9.2 */ async limits(): Promise { const requestOpts: ApifyRequestConfig = { @@ -107,6 +111,7 @@ export class UserClient extends ResourceClient { * * @param options - The new limits to set. * @see https://docs.apify.com/api/v2/users-me-limits-put + * @since Added in 2.10.0 */ async updateLimits(options: LimitsUpdateOptions): Promise { const requestOpts: ApifyRequestConfig = { @@ -124,9 +129,18 @@ export class UserClient extends ResourceClient { // Using token will return private user data // +/** + * @since Added in 0.2.2 + */ export interface User { // Public properties + /** + * @since Added in 2.0.1 + */ username: string; + /** + * @since Added in 2.0.1 + */ profile: { bio?: string; name?: string; @@ -136,56 +150,185 @@ export interface User { twitterUsername?: string; }; // Private properties + /** + * @since Added in 2.0.1 + */ id?: string; + /** + * @since Added in 2.0.1 + */ email?: string; + /** + * @since Added in 2.0.1 + */ proxy?: UserProxy; + /** + * @since Added in 2.0.1 + */ plan?: UserPlan; + /** + * @since Added in 2.12.5 + */ effectivePlatformFeatures?: EffectivePlatformFeatures; + /** + * @since Added in 2.12.5 + */ createdAt?: Date; + /** + * @since Added in 2.12.5 + */ isPaying?: boolean; } +/** + * @since Added in 2.0.1 + */ export interface UserProxy { + /** + * @since Added in 2.0.1 + */ password: string; + /** + * @since Added in 2.0.1 + */ groups: ProxyGroup[]; } +/** + * @since Added in 2.0.1 + */ export interface ProxyGroup { + /** + * @since Added in 2.0.1 + */ name: string; + /** + * @since Added in 2.0.1 + */ description: string; + /** + * @since Added in 2.0.1 + */ availableCount: number; } +/** + * @since Added in 2.0.1 + */ export interface UserPlan { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ description: string; + /** + * @since Added in 2.0.1 + */ isEnabled: boolean; + /** + * @since Added in 2.0.1 + */ monthlyBasePriceUsd: number; + /** + * @since Added in 2.0.1 + */ monthlyUsageCreditsUsd: number; + /** + * @since Added in 2.0.1 + */ usageDiscountPercent: number; + /** + * @since Added in 2.0.1 + */ enabledPlatformFeatures: PlatformFeature[]; + /** + * @since Added in 2.0.1 + */ maxMonthlyUsageUsd: number; + /** + * @since Added in 2.0.1 + */ maxActorMemoryGbytes: number; + /** + * @since Added in 2.0.1 + */ maxMonthlyActorComputeUnits: number; + /** + * @since Added in 2.0.1 + */ maxMonthlyResidentialProxyGbytes: number; + /** + * @since Added in 2.0.1 + */ maxMonthlyProxySerps: number; + /** + * @since Added in 2.0.1 + */ maxMonthlyExternalDataTransferGbytes: number; + /** + * @since Added in 2.0.1 + */ maxActorCount: number; + /** + * @since Added in 2.0.1 + */ maxActorTaskCount: number; + /** + * @since Added in 2.0.1 + */ dataRetentionDays: number; + /** + * @since Added in 2.0.1 + */ availableProxyGroups: Record; + /** + * @since Added in 2.0.1 + */ teamAccountSeatCount: number; + /** + * @since Added in 2.0.1 + */ supportLevel: string; + /** + * @since Added in 2.0.1 + */ availableAddOns: unknown[]; } +/** + * @since Added in 2.0.1 + */ export enum PlatformFeature { + /** + * @since Added in 2.0.1 + */ Actors = 'ACTORS', + /** + * @since Added in 2.0.1 + */ Storage = 'STORAGE', + /** + * @since Added in 2.0.1 + */ ProxySERPS = 'PROXY_SERPS', + /** + * @since Added in 2.0.1 + */ Scheduler = 'SCHEDULER', + /** + * @since Added in 2.0.1 + */ Webhooks = 'WEBHOOKS', + /** + * @since Added in 2.0.1 + */ Proxy = 'PROXY', + /** + * @since Added in 2.0.1 + */ ProxyExternalAccess = 'PROXY_EXTERNAL_ACCESS', } @@ -214,16 +357,43 @@ interface EffectivePlatformFeatures { // Response interface for /users/:userId/usage/monthly // +/** + * @since Added in 2.9.2 + */ export interface MonthlyUsage { + /** + * @since Added in 2.9.2 + */ usageCycle: UsageCycle; + /** + * @since Added in 2.9.2 + */ monthlyServiceUsage: { [key: string]: MonthlyServiceUsageData }; + /** + * @since Added in 2.9.2 + */ dailyServiceUsages: DailyServiceUsage[]; + /** + * @since Added in 2.9.2 + */ totalUsageCreditsUsdBeforeVolumeDiscount: number; + /** + * @since Added in 2.9.2 + */ totalUsageCreditsUsdAfterVolumeDiscount: number; } +/** + * @since Added in 2.9.2 + */ export interface UsageCycle { + /** + * @since Added in 2.9.2 + */ startAt: Date; + /** + * @since Added in 2.9.2 + */ endAt: Date; } @@ -260,42 +430,135 @@ interface DailyServiceUsageData { // Response interface for /users/:userId/limits // +/** + * @since Added in 2.9.2 + */ export interface AccountAndUsageLimits { + /** + * @since Added in 2.9.2 + */ monthlyUsageCycle: MonthlyUsageCycle; + /** + * @since Added in 2.9.2 + */ limits: Limits; + /** + * @since Added in 2.9.2 + */ current: Current; } +/** + * @since Added in 2.9.2 + */ export interface MonthlyUsageCycle { + /** + * @since Added in 2.9.2 + */ startAt: Date; + /** + * @since Added in 2.9.2 + */ endAt: Date; } +/** + * @since Added in 2.9.2 + */ export interface Limits { + /** + * @since Added in 2.9.2 + */ maxMonthlyUsageUsd: number; + /** + * @since Added in 2.9.2 + */ maxMonthlyActorComputeUnits: number; + /** + * @since Added in 2.9.2 + */ maxMonthlyExternalDataTransferGbytes: number; + /** + * @since Added in 2.9.2 + */ maxMonthlyProxySerps: number; + /** + * @since Added in 2.9.2 + */ maxMonthlyResidentialProxyGbytes: number; + /** + * @since Added in 2.9.2 + */ maxActorMemoryGbytes: number; + /** + * @since Added in 2.9.2 + */ maxActorCount: number; + /** + * @since Added in 2.9.2 + */ maxActorTaskCount: number; + /** + * @since Added in 2.9.2 + */ maxConcurrentActorJobs: number; + /** + * @since Added in 2.9.2 + */ maxTeamAccountSeatCount: number; + /** + * @since Added in 2.9.2 + */ dataRetentionDays: number; } +/** + * @since Added in 2.10.0 + */ export type LimitsUpdateOptions = { maxMonthlyUsageUsd: number } | { dataRetentionDays: number }; +/** + * @since Added in 2.9.2 + */ export interface Current { + /** + * @since Added in 2.9.2 + */ monthlyUsageUsd: number; + /** + * @since Added in 2.9.2 + */ monthlyActorComputeUnits: number; + /** + * @since Added in 2.9.2 + */ monthlyExternalDataTransferGbytes: number; + /** + * @since Added in 2.9.2 + */ monthlyProxySerps: number; + /** + * @since Added in 2.9.2 + */ monthlyResidentialProxyGbytes: number; + /** + * @since Added in 2.9.2 + */ actorMemoryGbytes: number; + /** + * @since Added in 2.9.2 + */ actorCount: number; + /** + * @since Added in 2.9.2 + */ actorTaskCount: number; + /** + * @since Added in 2.9.2 + */ activeActorJobCount: number; + /** + * @since Added in 2.9.2 + */ teamAccountSeatCount: number; } diff --git a/src/resource_clients/webhook.ts b/src/resource_clients/webhook.ts index 445ef3d30..799c11670 100644 --- a/src/resource_clients/webhook.ts +++ b/src/resource_clients/webhook.ts @@ -37,6 +37,7 @@ import { WebhookDispatchCollectionClient } from './webhook_dispatch_collection'; * ``` * * @see https://docs.apify.com/platform/integrations/webhooks + * @since Added in 1.0.0 */ export class WebhookClient extends ResourceClient { /** @@ -54,6 +55,7 @@ export class WebhookClient extends ResourceClient { * * @returns The webhook object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/webhook-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -65,6 +67,7 @@ export class WebhookClient extends ResourceClient { * @param newFields - Fields to update. * @returns The updated webhook object. * @see https://docs.apify.com/api/v2/webhook-put + * @since Added in 2.0.1 */ async update(newFields: WebhookUpdateData): Promise { ow(newFields, ow.object); @@ -76,6 +79,7 @@ export class WebhookClient extends ResourceClient { * Deletes the webhook. * * @see https://docs.apify.com/api/v2/webhook-delete + * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -86,6 +90,7 @@ export class WebhookClient extends ResourceClient { * * @returns The webhook dispatch object, or `undefined` if the test fails. * @see https://docs.apify.com/api/v2/webhook-test-post + * @since Added in 2.0.1 */ async test(): Promise { const request: ApifyRequestConfig = { @@ -109,6 +114,7 @@ export class WebhookClient extends ResourceClient { * * @returns A client for the webhook's dispatches. * @see https://docs.apify.com/api/v2/webhook-webhook-dispatches-get + * @since Added in 2.0.1 */ dispatches(): WebhookDispatchCollectionClient { return new WebhookDispatchCollectionClient( @@ -124,33 +130,92 @@ export class WebhookClient extends ResourceClient { * * Webhooks send HTTP POST requests to specified URLs when certain events occur * (e.g., Actor run succeeds, fails, or times out). + * @since Added in 0.5.8 */ export interface Webhook { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ userId: string; + /** + * @since Added in 2.0.1 + */ createdAt: Date; + /** + * @since Added in 2.0.1 + */ modifiedAt: Date; + /** + * @since Added in 2.0.1 + */ isAdHoc: boolean; + /** + * @since Added in 2.0.1 + */ eventTypes: WebhookEventType[]; + /** + * @since Added in 2.0.1 + */ condition: WebhookCondition; + /** + * @since Added in 2.0.1 + */ ignoreSslErrors: boolean; + /** + * @since Added in 2.0.1 + */ doNotRetry: boolean; + /** + * @since Added in 2.0.1 + */ requestUrl: string; + /** + * @since Added in 2.0.1 + */ payloadTemplate: string; + /** + * @since Added in 2.0.1 + */ lastDispatch: string; + /** + * @since Added in 2.0.1 + */ stats: WebhookStats; + /** + * @since Added in 2.7.2 + */ shouldInterpolateStrings: boolean; + /** + * @since Added in 2.9.4 + */ isApifyIntegration?: boolean; + /** + * @since Added in 2.8.1 + */ headersTemplate?: string; + /** + * @since Added in 2.8.1 + */ description?: string; } +/** + * @since Added in 2.0.1 + */ export interface WebhookIdempotencyKey { + /** + * @since Added in 2.0.1 + */ idempotencyKey?: string; } /** * Data for updating a webhook. + * @since Added in 2.0.1 */ export type WebhookUpdateData = Partial< Pick< @@ -175,32 +240,56 @@ export type WebhookUpdateData = Partial< /** * Statistics about webhook usage. + * @since Added in 2.0.1 */ export interface WebhookStats { + /** + * @since Added in 2.0.1 + */ totalDispatches: number; } /** * Event types that can trigger webhooks. + * @since Added in 2.0.1 */ export type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[keyof typeof WEBHOOK_EVENT_TYPES]; /** * Condition that determines when a webhook should be triggered. + * @since Added in 2.0.1 */ export type WebhookCondition = | WebhookAnyRunOfActorCondition | WebhookAnyRunOfActorTaskCondition | WebhookCertainRunCondition; +/** + * @since Added in 2.0.1 + */ export interface WebhookAnyRunOfActorCondition { + /** + * @since Added in 2.0.1 + */ actorId: string; } +/** + * @since Added in 2.0.1 + */ export interface WebhookAnyRunOfActorTaskCondition { + /** + * @since Added in 2.0.1 + */ actorTaskId: string; } +/** + * @since Added in 2.0.1 + */ export interface WebhookCertainRunCondition { + /** + * @since Added in 2.0.1 + */ actorRunId: string; } diff --git a/src/resource_clients/webhook_collection.ts b/src/resource_clients/webhook_collection.ts index fc706087c..f750ab3d6 100644 --- a/src/resource_clients/webhook_collection.ts +++ b/src/resource_clients/webhook_collection.ts @@ -27,6 +27,7 @@ import type { Webhook, WebhookUpdateData } from './webhook'; * ``` * * @see https://docs.apify.com/platform/integrations/webhooks + * @since Added in 1.0.0 */ export class WebhookCollectionClient extends ResourceCollectionClient { /** @@ -60,6 +61,9 @@ export class WebhookCollectionClient extends ResourceCollectionClient { * @see https://docs.apify.com/api/v2/webhooks-get */ + /** + * @since Added in 2.0.1 + */ list( options: WebhookCollectionListOptions = {}, ): PaginatedIterator> { @@ -81,6 +85,7 @@ export class WebhookCollectionClient extends ResourceCollectionClient { * @param webhook - The webhook data. * @returns The created webhook object. * @see https://docs.apify.com/api/v2/webhooks-post + * @since Added in 2.0.1 */ async create(webhook?: WebhookUpdateData): Promise { ow(webhook, ow.optional.object); @@ -89,6 +94,12 @@ export class WebhookCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.0.1 + */ export interface WebhookCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ desc?: boolean; } diff --git a/src/resource_clients/webhook_dispatch.ts b/src/resource_clients/webhook_dispatch.ts index 3246befbc..24002a518 100644 --- a/src/resource_clients/webhook_dispatch.ts +++ b/src/resource_clients/webhook_dispatch.ts @@ -19,6 +19,7 @@ import type { Webhook, WebhookEventType } from './webhook'; * ``` * * @see https://docs.apify.com/platform/integrations/webhooks + * @since Added in 1.0.0 */ export class WebhookDispatchClient extends ResourceClient { /** @@ -36,41 +37,117 @@ export class WebhookDispatchClient extends ResourceClient { * * @returns The webhook dispatch object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/webhook-dispatch-get + * @since Added in 2.0.1 */ async get(): Promise { return this._get(); } } +/** + * @since Added in 0.5.8 + */ export interface WebhookDispatch { + /** + * @since Added in 2.0.1 + */ id: string; + /** + * @since Added in 2.0.1 + */ userId: string; + /** + * @since Added in 2.0.1 + */ webhookId: string; + /** + * @since Added in 2.0.1 + */ createdAt: Date; + /** + * @since Added in 2.0.1 + */ status: WebhookDispatchStatus; + /** + * @since Added in 2.0.1 + */ eventType: WebhookEventType; + /** + * @since Added in 2.0.1 + */ calls: WebhookDispatchCall[]; + /** + * @since Added in 2.0.1 + */ webhook: Pick; + /** + * @since Added in 2.13.0 + */ eventData: WebhookDispatchEventData | null; } +/** + * @since Added in 2.0.1 + */ export enum WebhookDispatchStatus { + /** + * @since Added in 2.0.1 + */ Active = 'ACTIVE', + /** + * @since Added in 2.0.1 + */ Succeeded = 'SUCCEEDED', + /** + * @since Added in 2.0.1 + */ Failed = 'FAILED', } +/** + * @since Added in 2.0.1 + */ export interface WebhookDispatchCall { + /** + * @since Added in 2.0.1 + */ startedAt: Date; + /** + * @since Added in 2.0.1 + */ finishedAt: Date; + /** + * @since Added in 2.0.1 + */ errorMessage: string | null; + /** + * @since Added in 2.0.1 + */ responseStatus: number | null; + /** + * @since Added in 2.0.1 + */ responseBody: string | null; } +/** + * @since Added in 2.13.0 + */ export interface WebhookDispatchEventData { + /** + * @since Added in 2.13.0 + */ actorRunId?: string; + /** + * @since Added in 2.13.0 + */ actorId?: string; + /** + * @since Added in 2.13.0 + */ actorTaskId?: string; + /** + * @since Added in 2.13.0 + */ actorBuildId?: string; } diff --git a/src/resource_clients/webhook_dispatch_collection.ts b/src/resource_clients/webhook_dispatch_collection.ts index d239d2bf5..cb87b29a3 100644 --- a/src/resource_clients/webhook_dispatch_collection.ts +++ b/src/resource_clients/webhook_dispatch_collection.ts @@ -22,6 +22,7 @@ import type { WebhookDispatch } from './webhook_dispatch'; * ``` * * @see https://docs.apify.com/platform/integrations/webhooks + * @since Added in 1.0.0 */ export class WebhookDispatchCollectionClient extends ResourceCollectionClient { /** @@ -53,6 +54,7 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient { * @param options - Pagination and sorting options. * @returns A paginated iterator of webhook dispatches. * @see https://docs.apify.com/api/v2/webhook-dispatches-get + * @since Added in 2.0.1 */ list(options: WebhookDispatchCollectionListOptions = {}): PaginatedIterator { ow( @@ -68,6 +70,12 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient { } } +/** + * @since Added in 2.0.1 + */ export interface WebhookDispatchCollectionListOptions extends PaginationOptions { + /** + * @since Added in 2.0.1 + */ desc?: boolean; } diff --git a/src/utils.ts b/src/utils.ts index 4f28b8075..f7d2f980f 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -255,15 +255,22 @@ export interface RequestQueuePaginationIteratorOptions { * Standard pagination options for API requests. */ export interface PaginationOptions { - /** Position of the first returned entry. */ + /** + * Position of the first returned entry. + * @since Added in 2.0.1 + */ offset?: number; - /** Maximum number of entries requested. */ + /** + * Maximum number of entries requested. + * @since Added in 2.0.1 + */ limit?: number; /** Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator * will fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the * limit is reached or once all items from API have been fetched. * * Chunk size is usually limited by API. Minimum of those two limits will be used. + * @since Added in 2.21.0 * */ chunkSize?: number; } @@ -274,9 +281,15 @@ export interface PaginationOptions { * @template Data - The type of items in the response */ export interface PaginatedResponse { - /** Total count of entries. */ + /** + * Total count of entries. + * @since Added in 2.0.1 + */ total: number; - /** Entries. */ + /** + * Entries. + * @since Added in 2.0.1 + */ items: Data[]; } @@ -287,15 +300,28 @@ export interface PaginatedResponse { * offset-based pagination and field transformations. * * @template Data - The type of items in the list + * @since Added in 2.0.1 */ export interface PaginatedList extends PaginatedResponse { - /** Count of dataset entries returned in this set. */ + /** + * Count of dataset entries returned in this set. + * @since Added in 2.0.1 + */ count: number; - /** Position of the first returned entry in the dataset. */ + /** + * Position of the first returned entry in the dataset. + * @since Added in 2.0.1 + */ offset: number; - /** Maximum number of dataset entries requested. */ + /** + * Maximum number of dataset entries requested. + * @since Added in 2.0.1 + */ limit: number; - /** Should the results be in descending order. */ + /** + * Should the results be in descending order. + * @since Added in 2.0.1 + */ desc: boolean; } @@ -324,6 +350,7 @@ export function asArray(value: T | T[]): T[] { * Generic dictionary type (key-value map). * * @template T - The type of values in the dictionary + * @since Added in 2.0.4 */ export type Dictionary = Record; diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index fecc3cab0..d7b61327f 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -4,7 +4,6 @@ const { resolve } = require('node:path'); const { config } = require('@apify/docs-theme'); const { externalLinkProcessor } = require('./tools/utils/externalLink'); -const versions = require('./versions.json'); const { absoluteUrl } = config; /** @type {Partial} */ @@ -63,17 +62,6 @@ module.exports = { href: 'https://github.com/apify/apify-client-js', label: 'GitHub', }, - { - type: 'docsVersionDropdown', - position: 'left', - className: 'navbar__item', // fixes margin around dropdown - hackish, should be fixed in theme - 'data-api-links': JSON.stringify([ - 'reference/next', - ...versions.map((version, i) => (i === 0 ? 'reference' : `reference/${version}`)), - ]), - dropdownItemsBefore: [], - dropdownItemsAfter: [], - }, ], }, }, @@ -138,7 +126,6 @@ module.exports = { ], themeConfig: { ...config.themeConfig, - versions, footer: { ...config.themeConfig.footer, logo: { diff --git a/website/package.json b/website/package.json index b49e23c8d..73fb3ffd8 100644 --- a/website/package.json +++ b/website/package.json @@ -27,7 +27,7 @@ }, "dependencies": { "@apify/docs-theme": "^1.0.251", - "@apify/docusaurus-plugin-typedoc-api": "^5.1.6", + "@apify/docusaurus-plugin-typedoc-api": "^5.1.11", "@docusaurus/core": "^3.8.1", "@docusaurus/faster": "^3.8.1", "@docusaurus/preset-classic": "^3.8.1", diff --git a/website/versioned_docs/version-2/.gitignore b/website/versioned_docs/version-2/.gitignore deleted file mode 100644 index 1a13c3638..000000000 --- a/website/versioned_docs/version-2/.gitignore +++ /dev/null @@ -1 +0,0 @@ -changelog.md diff --git a/website/versioned_docs/version-2/01_introduction/index.md b/website/versioned_docs/version-2/01_introduction/index.md deleted file mode 100644 index 5aba02679..000000000 --- a/website/versioned_docs/version-2/01_introduction/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -id: introduction -title: Overview -sidebar_label: Overview -slug: / -description: 'The official JavaScript library to access the Apify API, with automatic retries, TypeScript support, and cross-platform compatibility.' ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -The Apify API client is the official library to access the [Apify REST API](https://docs.apify.com/api/v2) from your JavaScript/TypeScript applications. It runs both in Node.js and browser and provides useful features like automatic retries and convenience functions that improve the experience of using the Apify API. - -The client simplifies interaction with the Apify platform by providing: - -- Intuitive methods for working with [Actors](https://docs.apify.com/platform/actors), [datasets](https://docs.apify.com/platform/storage/dataset), [key-value stores](https://docs.apify.com/platform/storage/key-value-store), and other Apify resources -- Intelligent parsing of API responses and rich error messages for debugging -- Built-in [exponential backoff](../02_concepts/02_error-handling.md#retries-with-exponential-backoff) for failed requests -- Full TypeScript support with comprehensive type definitions -- Cross-platform compatibility in [Node.js](https://nodejs.org/) v16+ and modern browsers - -All requests and responses (including errors) are encoded in JSON format with UTF-8 encoding. - -## Pre-requisites - -`apify-client` requires Node.js version 16 or higher. Node.js is available for download on the [official website](https://nodejs.org/). Check for your current Node.js version by running: - -```bash -node -v -``` - -## Installation - -You can install the client via [NPM](https://www.npmjs.com/) or any other package manager of your choice. - - - - -```bash -npm i apify-client -``` - - - - -```bash -yarn add apify-client -``` - - - - -```bash -pnpm add apify-client -``` - - - - -```bash -bun add apify-client -``` - - - - -## Quick example - -Here's an example showing how to run an Actor and retrieve its results: - -```javascript -import { ApifyClient } from 'apify-client'; - -// Initialize the client with your API token -const client = new ApifyClient({ - token: 'MY-APIFY-TOKEN', -}); - -// Start an Actor and wait for it to finish -const run = await client.actor('apify/web-scraper').call({ - startUrls: [{ url: 'https://example.com' }], - maxCrawlPages: 10, -}); - -// Get results from the Actor's dataset -const { items } = await client.dataset(run.defaultDatasetId).listItems(); -console.log(items); -``` - -> You can find your API token in the [Integrations section](https://console.apify.com/account/integrations) of Apify Console. See the [Quick start guide](./quick-start.md) for more details on authentication. diff --git a/website/versioned_docs/version-2/01_introduction/quick-start.md b/website/versioned_docs/version-2/01_introduction/quick-start.md deleted file mode 100644 index 72def8654..000000000 --- a/website/versioned_docs/version-2/01_introduction/quick-start.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -id: quick-start -title: Quick start -sidebar_label: Quick start -description: 'Get started with the Apify API client for JavaScript by running an Actor and retrieving results from its dataset.' ---- - -import ApiLink from '@theme/ApiLink'; - -Learn how to authenticate, run Actors, and retrieve results using the Apify API client for JavaScript. - ---- - -## Step 1: Authenticate the client - -To use the client, you need an [API token](https://docs.apify.com/platform/integrations/api#api-token). You can find your token under [Integrations](https://console.apify.com/account/integrations) tab in Apify Console. Copy the token and initialize the client by providing the token (`MY-APIFY-TOKEN`) as a parameter to the `ApifyClient` constructor. - -```js -import { ApifyClient } from 'apify-client'; - -// Client initialization with the API token -const client = new ApifyClient({ - token: 'MY-APIFY-TOKEN', -}); -``` - -:::warning Secure access - -The API token is used to authorize your requests to the Apify API. You can be charged for the usage of the underlying services, so do not share your API token with untrusted parties or expose it on the client side of your applications. - -::: - -## Step 2: Run an Actor - -To start an Actor, call the `client.actor()` method with the Actor's ID (e.g. `john-doe/my-cool-actor`). The Actor's ID is a combination of the Actor owner's username and the Actor name. You can run both your own Actors and Actors from Apify Store. - -To define the Actor's input, pass a JSON object to the `call()` method that matches the Actor's [input schema](https://docs.apify.com/platform/actors/development/actor-definition/input-schema). The input can include URLs to scrape, search terms, or other configuration data. - -```js -import { ApifyClient } from 'apify-client'; - -const client = new ApifyClient({ token: 'MY-APIFY-TOKEN' }); - -// Runs an Actor with an input and waits for it to finish. -const { defaultDatasetId } = await client.actor('username/actor-name').call({ - some: 'input', -}); -``` - -## Step 3: Get results from the dataset - -To get the results from the dataset, call the `client.dataset()` method with the dataset ID, then call `listItems()` to retrieve the data. You can get the dataset ID from the Actor's run object (represented by `defaultDatasetId`). - -```js -import { ApifyClient } from 'apify-client'; - -const client = new ApifyClient({ token: 'MY-APIFY-TOKEN' }); - -// Runs an Actor and waits for it to finish -const { defaultDatasetId } = await client.actor('username/actor-name').call(); - -// Lists items from the Actor's dataset -const { items } = await client.dataset(defaultDatasetId).listItems(); -console.log(items); -``` - -:::note Dataset access - -Running an Actor might take time, depending on the Actor's complexity and the amount of data it processes. If you want only to get data and have an immediate response you should access the existing dataset of the finished [Actor run](https://docs.apify.com/platform/actors/running/runs-and-builds#runs). - -::: - -## Next steps - -### Concepts - -To learn more about how the client works, check out the Concepts section in the sidebar: - -- [Usage patterns](../02_concepts/01_usage-patterns.md) - resource clients, collection clients, and nested clients -- [Error handling and retries](../02_concepts/02_error-handling.md) - automatic retries with exponential backoff -- [Convenience functions](../02_concepts/03_convenience-functions.md) - `call()`, `waitForFinish()`, and more -- [Pagination](../02_concepts/04_pagination.md) - iterating through large result sets - -### Guides - -For practical examples of common tasks, see [Code examples](../03_guides/01_examples.md). diff --git a/website/versioned_docs/version-2/02_concepts/01_usage-patterns.md b/website/versioned_docs/version-2/02_concepts/01_usage-patterns.md deleted file mode 100644 index c6f21bbde..000000000 --- a/website/versioned_docs/version-2/02_concepts/01_usage-patterns.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: usage-patterns -title: Usage patterns -sidebar_label: Usage patterns -description: 'Learn the resource client and collection client patterns used by the Apify API client for JavaScript.' ---- - -import ApiLink from '@theme/ApiLink'; - -The `ApifyClient` interface follows a generic pattern that applies to all of its components. By calling individual methods of `ApifyClient`, specific clients that target individual API resources are created. There are two types of those clients: - -- `ActorClient`: a client for the management of a single resource -- `ActorCollectionClient`: a client for the collection of resources - -```js -import { ApifyClient } from 'apify-client'; - -const client = new ApifyClient({ token: 'MY-APIFY-TOKEN' }); - -// Collection clients do not require a parameter. -const actorCollectionClient = client.actors(); -// Creates an actor with the name: my-actor. -const myActor = await actorCollectionClient.create({ name: 'my-actor-name' }); -// List all your used Actors (both own and from Apify Store) -const { items } = await actorCollectionClient.list(); -``` - -:::note Resource identification - -The resource ID can be either the `id` of the said resource, or a combination of your `username/resource-name`. - -::: - -```js -import { ApifyClient } from 'apify-client'; - -const client = new ApifyClient({ token: 'MY-APIFY-TOKEN' }); - -// Resource clients accept an ID of the resource. -const actorClient = client.actor('username/actor-name'); -// Fetches the john-doe/my-actor object from the API. -const myActor = await actorClient.get(); -// Starts the run of john-doe/my-actor and returns the Run object. -const myActorRun = await actorClient.start(); -``` - -## Nested clients - -Sometimes clients return other clients. That's to simplify working with nested collections, such as runs of a given Actor. - -```js -import { ApifyClient } from 'apify-client'; - -const client = new ApifyClient({ token: 'MY-APIFY-TOKEN' }); - -const actorClient = client.actor('username/actor-name'); -const runsClient = actorClient.runs(); -// Lists the last 10 runs of your Actor. -const { items } = await runsClient.list({ - limit: 10, - desc: true, -}); - -// Select the last run of your Actor that finished -// with a SUCCEEDED status. -const lastSucceededRunClient = actorClient.lastRun({ status: 'SUCCEEDED' }); -// Fetches items from the run's dataset. -const { items } = await lastSucceededRunClient.dataset().listItems(); -``` - -The quick access to `dataset` and other storage directly from the run client can be used with the `lastRun()` method. diff --git a/website/versioned_docs/version-2/02_concepts/02_error-handling.md b/website/versioned_docs/version-2/02_concepts/02_error-handling.md deleted file mode 100644 index 79d26af7a..000000000 --- a/website/versioned_docs/version-2/02_concepts/02_error-handling.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: error-handling -title: Error handling and retries -sidebar_label: Error handling and retries -description: 'Handle API errors and configure automatic retries with exponential backoff in the Apify API client for JavaScript.' ---- - -import ApiLink from '@theme/ApiLink'; - -Based on the endpoint, the client automatically extracts the relevant data and returns it in the expected format. Date strings are automatically converted to `Date` objects. For exceptions, the client throws an `ApifyApiError`, which wraps the plain JSON errors returned by API and enriches them with other contexts for easier debugging. - -```js -import { ApifyClient } from 'apify-client'; - -const client = new ApifyClient({ token: 'MY-APIFY-TOKEN' }); - -try { - const { items } = await client.dataset('non-existing-dataset-id').listItems(); -} catch (error) { - // The error is an instance of ApifyApiError - const { message, type, statusCode, clientMethod, path } = error; - // Log error for easier debugging - console.log({ message, statusCode, clientMethod, type }); -} -``` - -## Retries with exponential backoff - -The client automatically retries requests that fail due to network errors, Apify API internal errors (HTTP 500+), or rate limit errors (HTTP 429). By default, the client retries up to 8 times with exponential backoff starting at 500ms. - -To configure retry behavior, set the `maxRetries` and `minDelayBetweenRetriesMillis` options in the `ApifyClient` constructor: - -```js -import { ApifyClient } from 'apify-client'; - -const client = new ApifyClient({ - token: 'MY-APIFY-TOKEN', - maxRetries: 8, - minDelayBetweenRetriesMillis: 500, // 0.5s - timeoutSecs: 360, // 6 mins -}); -``` diff --git a/website/versioned_docs/version-2/02_concepts/03_convenience-functions.md b/website/versioned_docs/version-2/02_concepts/03_convenience-functions.md deleted file mode 100644 index 2aa978bd7..000000000 --- a/website/versioned_docs/version-2/02_concepts/03_convenience-functions.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: convenience-functions -title: Convenience functions -sidebar_label: Convenience functions -description: 'Use call(), waitForFinish(), and other convenience functions in the Apify API client for JavaScript.' ---- - -Some actions can't be performed by the API itself, such as indefinite waiting for an Actor run to finish (because of network timeouts). The client provides convenient `call()` and `waitForFinish()` functions that do that. If the limit is reached, the returned promise is resolved to a run object that will have status `READY` or `RUNNING` and it will not contain the Actor run output. - -[Key-value store](https://docs.apify.com/platform/storage/key-value-store) records can be retrieved as objects, buffers, or streams via the respective options, dataset items can be fetched as individual objects or serialized data. - -```js -import { ApifyClient } from 'apify-client'; - -const client = new ApifyClient({ token: 'MY-APIFY-TOKEN' }); - -// Starts an Actor and waits for it to finish. -const finishedActorRun = await client.actor('username/actor-name').call(); - -// Starts an Actor and waits maximum 60s for the finish -const { status } = await client.actor('username/actor-name').start({ - waitForFinish: 60, // 1 minute -}); -``` diff --git a/website/versioned_docs/version-2/02_concepts/04_pagination.md b/website/versioned_docs/version-2/02_concepts/04_pagination.md deleted file mode 100644 index b6feada3a..000000000 --- a/website/versioned_docs/version-2/02_concepts/04_pagination.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: pagination -title: Pagination -sidebar_label: Pagination -description: 'Paginate through large result sets and use async iteration with the Apify API client for JavaScript.' ---- - -import ApiLink from '@theme/ApiLink'; - -Methods that return lists (such as `list()` or `listSomething()`) return a `PaginatedList` object. Exceptions include `listKeys()` and `listHead()`, which use different pagination mechanisms. - -The list results are stored in the `items` property. Use the `limit` parameter to retrieve a specific number of results. Additional properties vary by method—see the method reference for details. - -```js -import { ApifyClient } from 'apify-client'; - -const client = new ApifyClient({ token: 'MY-APIFY-TOKEN' }); - -// Resource clients accept an ID of the resource. -const datasetClient = client.dataset('dataset-id'); - -// Maximum amount of items to fetch in total -const limit = 1000; -// Maximum amount of items to fetch in one API call -const chunkSize = 100; -// Initial offset -const offset = 0; - -for await (const item of datasetClient.listItems({ limit, offset, chunkSize })) { - // Processs individual item - console.log(item); -} -``` diff --git a/website/versioned_docs/version-2/02_concepts/05_bundled-environments.md b/website/versioned_docs/version-2/02_concepts/05_bundled-environments.md deleted file mode 100644 index 94d6663b8..000000000 --- a/website/versioned_docs/version-2/02_concepts/05_bundled-environments.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -id: bundled-environments -title: Use in bundled environments -sidebar_label: Bundled environments -description: 'Use the Apify API client for JavaScript in browsers, Cloudflare Workers, and other edge runtimes.' ---- - -:::warning Non-Node.js environments - -This applies only to non-Node.js environments (browsers, Cloudflare Workers, edge runtimes). If you're running on Node.js, you can skip this section. - -::: - -The package ships a pre-built browser bundle that is automatically resolved when your bundler targets a browser environment. If it isn't picked up automatically, you can import it directly: - -```js -import { ApifyClient } from 'apify-client/browser'; -``` - -For Cloudflare Workers or other edge runtimes that don't provide Node built-ins, you may need to enable Node compatibility in your runtime config (e.g. `node_compat = true`. - -Note that some Node-specific features (streaming APIs, proxy) are not available in the browser bundle. diff --git a/website/versioned_docs/version-2/03_guides/01_examples.md b/website/versioned_docs/version-2/03_guides/01_examples.md deleted file mode 100644 index 869f3d277..000000000 --- a/website/versioned_docs/version-2/03_guides/01_examples.md +++ /dev/null @@ -1,152 +0,0 @@ ---- -id: examples -title: Code examples -sidebar_label: Examples -description: 'Practical code examples for common tasks with the Apify API client for JavaScript, including webhooks and datasets.' ---- - -## Passing an input to the Actor - -The fastest way to get results from an Actor is to pass input directly to the `call` function. -Input can be passed to `call` function and the reference of running Actor (or wait for finish) is available in `runData` variable. - -This example starts an Actor that scrapes 20 posts from the Instagram website based on the hashtag. - -```javascript -import { ApifyClient } from 'apify-client'; - -// Client initialization with the API token -const client = new ApifyClient({ token: 'MY_APIFY_TOKEN' }); - -const actorClient = client.actor('apify/instagram-hashtag-scraper'); - -const input = { hashtags: ['rainbow'], resultsLimit: 20 }; - -// Run the Actor and wait for it to finish up to 60 seconds. -// Input is not persisted for next runs. -const runData = await actorClient.call(input, { waitSecs: 60 }); - -console.log('Run data:'); -console.log(runData); -``` - -To run multiple inputs with the same Actor, most convenient way is to create multiple [tasks](https://docs.apify.com/platform/actors/running/tasks) with different inputs. Task input is persisted on Apify platform when task is created. - -```javascript -import { ApifyClient } from 'apify-client'; - -// Client initialization with the API token -const client = new ApifyClient({ token: 'MY_APIFY_TOKEN' }); - -const animalsHashtags = ['zebra', 'lion', 'hippo']; - -// Multiple input schemas for one Actor can be persisted in tasks. -// Tasks are saved in the Apify platform and can be run multiple times. -const socialsTasksPromises = animalsHashtags.map((hashtag) => - client.tasks().create({ - actId: 'apify/instagram-hashtag-scraper', - name: `hashtags-${hashtag}`, - input: { hashtags: [hashtag], resultsLimit: 20 }, - options: { memoryMbytes: 1024 }, - }), -); - -// Create all tasks in parallel -const createdTasks = await Promise.all(socialsTasksPromises); - -console.log('Created tasks:'); -console.log(createdTasks); - -// Run all tasks in parallel -await Promise.all(createdTasks.map((task) => client.task(task.id).call())); -``` - -## Getting latest data from an Actor, joining datasets - -Actor data are stored to [datasets](https://docs.apify.com/platform/storage/dataset). Datasets can be retrieved from Actor runs. Dataset items can be listed with pagination. Also, datasets can be merged together to make analysis further on with single file as dataset can be exported to various data format (CSV, JSON, XSLX, XML). [Integrations](https://docs.apify.com/platform/integrations) can do the trick as well. - -```javascript -import { ApifyClient } from 'apify-client'; - -// Client initialization with the API token -const client = new ApifyClient({ token: 'MY_APIFY_TOKEN' }); - -const actorClient = client.actor('apify/instagram-hashtag-scraper'); - -const actorRuns = actorClient.runs(); - -// See pagination to understand how to get more datasets -const actorDatasets = await actorRuns.list({ limit: 20 }); - -console.log('Actor datasets:'); -console.log(actorDatasets); - -const mergingDataset = await client.datasets().getOrCreate('merge-dataset'); - -for (const datasetItem of actorDatasets.items) { - // Dataset items can be handled here. Dataset items can be paginated - const datasetItems = await client.dataset(datasetItem.defaultDatasetId).listItems({ limit: 1000 }); - - // Items can be pushed to single dataset - await client.dataset(mergingDataset.id).pushItems(datasetItems.items); - - // ... -} -``` - -## Handling webhooks - -[Webhooks](https://docs.apify.com/platform/integrations/webhooks) can be used to get notifications about Actor runs. -For example, a webhook can be triggered when an Actor run finishes successfully. -Webhook can receive dataset ID for further processing. - -Initialization of webhook: - -```javascript -import { ApifyClient } from 'apify-client'; - -// Client initialization with the API token -const client = new ApifyClient({ token: 'MY_APIFY_TOKEN' }); - -const webhooksClient = client.webhooks(); - -await webhooksClient.create({ - description: 'Instagram hashtag actor succeeded', - condition: { actorId: 'reGe1ST3OBgYZSsZJ' }, // Actor ID of apify/instagram-hashtag-scraper - // Request URL can be generated using https://webhook.site. Any REST server can be used - requestUrl: 'https://webhook.site/CUSTOM_WEBHOOK_ID', - eventTypes: ['ACTOR.RUN.SUCCEEDED'], -}); -``` - -Simple webhook listener can be built on [`express`](https://expressjs.com/) library, which can helps to create a REST server for handling webhooks: - -```javascript -import express from 'express'; -import bodyParser from 'body-parser'; -import { ApifyClient, DownloadItemsFormat } from 'apify-client'; - -// Initialize Apify client, express and define server port -const client = new ApifyClient({ token: 'MY_APIFY_TOKEN' }); -const app = express(); -const PORT = 3000; - -// Tell express to use body-parser's JSON parsing -app.use(bodyParser.json()); - -app.post('apify-webhook', async (req, res) => { - // Log the payload from the webhook - console.log(req.body); - - const runDataset = await client.dataset(req.body.resource.defaultDatasetId); - - // e.g. Save dataset locally as JSON - await runDataset.downloadItems(DownloadItemsFormat.JSON); - - // Respond to the webhook - res.send('Webhook received'); -}); - -// Start express on the defined port -app.listen(PORT, () => console.log(`🚀 Server running on port ${PORT}`)); -``` diff --git a/website/versioned_docs/version-2/api-packages.json b/website/versioned_docs/version-2/api-packages.json deleted file mode 100644 index 34c348d15..000000000 --- a/website/versioned_docs/version-2/api-packages.json +++ /dev/null @@ -1 +0,0 @@ -[{"entryPoints":{"index":{"label":"Index","path":"src/index.ts"}},"packageRoot":"..","packagePath":".","packageSlug":".","packageName":"apify-client","packageVersion":"2.23.4"}] \ No newline at end of file diff --git a/website/versioned_docs/version-2/api-typedoc.json b/website/versioned_docs/version-2/api-typedoc.json deleted file mode 100644 index 7cdcdc533..000000000 --- a/website/versioned_docs/version-2/api-typedoc.json +++ /dev/null @@ -1,74625 +0,0 @@ -{ - "id": 0, - "name": "apify-client", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 543, - "name": "ActorListSortBy", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 544, - "name": "CREATED_AT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 93, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L93", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "createdAt" - } - }, - { - "id": 545, - "name": "LAST_RUN_STARTED_AT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 94, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L94", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "stats.lastRunStartedAt" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 544, - 545 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 92, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L92", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 830, - "name": "ActorSourceType", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 834, - "name": "GitHubGist", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 133, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L133", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "GITHUB_GIST" - } - }, - { - "id": 832, - "name": "GitRepo", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 131, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L131", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "GIT_REPO" - } - }, - { - "id": 831, - "name": "SourceFiles", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 130, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L130", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "SOURCE_FILES" - } - }, - { - "id": 833, - "name": "Tarball", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 132, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L132", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "TARBALL" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 834, - 832, - 831, - 833 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 129, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L129", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1266, - "name": "DownloadItemsFormat", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Supported formats for downloading dataset items." - } - ] - }, - "children": [ - { - "id": 1271, - "name": "CSV", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 489, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L489", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "csv" - } - }, - { - "id": 1270, - "name": "HTML", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 488, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L488", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "html" - } - }, - { - "id": 1267, - "name": "JSON", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 485, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L485", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "json" - } - }, - { - "id": 1268, - "name": "JSONL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 486, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L486", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "jsonl" - } - }, - { - "id": 1273, - "name": "RSS", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 491, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L491", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "rss" - } - }, - { - "id": 1272, - "name": "XLSX", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 490, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L490", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "xlsx" - } - }, - { - "id": 1269, - "name": "XML", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 487, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L487", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "xml" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 1271, - 1270, - 1267, - 1268, - 1273, - 1272, - 1269 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 484, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L484", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2989, - "name": "PlatformFeature", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 2990, - "name": "Actors", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 183, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L183", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "ACTORS" - } - }, - { - "id": 2995, - "name": "Proxy", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 188, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L188", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "PROXY" - } - }, - { - "id": 2996, - "name": "ProxyExternalAccess", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 189, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L189", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "PROXY_EXTERNAL_ACCESS" - } - }, - { - "id": 2992, - "name": "ProxySERPS", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 185, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L185", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "PROXY_SERPS" - } - }, - { - "id": 2993, - "name": "Scheduler", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 186, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L186", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "SCHEDULER" - } - }, - { - "id": 2991, - "name": "Storage", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 184, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L184", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "STORAGE" - } - }, - { - "id": 2994, - "name": "Webhooks", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 187, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L187", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "WEBHOOKS" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 2990, - 2995, - 2996, - 2992, - 2993, - 2991, - 2994 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 182, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L182", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2483, - "name": "ScheduleActions", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Types of actions that can be scheduled." - } - ] - }, - "children": [ - { - "id": 2484, - "name": "RunActor", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 140, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L140", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "RUN_ACTOR" - } - }, - { - "id": 2485, - "name": "RunActorTask", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 141, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L141", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "RUN_ACTOR_TASK" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 2484, - 2485 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 139, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L139", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3295, - "name": "WebhookDispatchStatus", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 3296, - "name": "Active", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 58, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L58", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "ACTIVE" - } - }, - { - "id": 3298, - "name": "Failed", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 60, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L60", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "FAILED" - } - }, - { - "id": 3297, - "name": "Succeeded", - "variant": "declaration", - "kind": 16, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 59, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L59", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "SUCCEEDED" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 3296, - 3298, - 3297 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 57, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L57", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 126, - "name": "ActorClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific Actor.\n\nProvides methods to start, call, build, update, and delete an Actor, as well as manage its\nversions, builds, runs, and webhooks." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst actorClient = client.actor('my-actor-id');\n\n// Start an Actor\nconst run = await actorClient.start(input, { memory: 256 });\n\n// Call an Actor and wait for it to finish\nconst finishedRun = await actorClient.call({ url: 'https://example.com' });\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors" - } - ] - } - ] - }, - "children": [ - { - "id": 193, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 189, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 194, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 187, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 195, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 190, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 191, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 188, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 192, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 145, - "name": "build", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 287, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L287", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 146, - "name": "build", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Builds the Actor.\n\nCreates a new build of the specified Actor version. The build compiles the Actor's\nsource code, installs dependencies, and prepares it for execution." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Build object with status and build details" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-builds-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Start a build and return immediately\nconst build = await client.actor('my-actor').build('0.1');\nconsole.log(`Build ${build.id} started with status: ${build.status}`);\n\n// Build and wait up to 120 seconds for it to finish\nconst build = await client.actor('my-actor').build('0.1', {\n waitForFinish: 120,\n tag: 'latest',\n useCache: true\n});\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 287, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L287", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 147, - "name": "versionNumber", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Version number or tag to build (e.g., " - }, - { - "kind": "code", - "text": "`'0.1'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'0.2'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'latest'`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 148, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Build configuration options" - } - ] - }, - "type": { - "type": "reference", - "target": 404, - "name": "ActorBuildOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 998, - "name": "Build", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 155, - "name": "builds", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 394, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L394", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 156, - "name": "builds", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing builds of this Actor." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Actor's build collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-builds-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 394, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L394", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1049, - "name": "BuildCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 141, - "name": "call", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 220, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L220", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 142, - "name": "call", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the Actor and waits for it to finish before returning the Run object.\n\nThis is a convenience method that starts the Actor run and waits for its completion\nby polling the run status. It optionally streams logs to the console or a custom Log instance.\nBy default, it waits indefinitely unless the " - }, - { - "kind": "code", - "text": "`waitSecs`" - }, - { - "kind": "text", - "text": " option is provided." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The finished Actor run object with final status (" - }, - { - "kind": "code", - "text": "`SUCCEEDED`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`FAILED`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`ABORTED`" - }, - { - "kind": "text", - "text": ", or " - }, - { - "kind": "code", - "text": "`TIMED-OUT`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-runs-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Run an Actor and wait for it to finish\nconst run = await client.actor('my-actor').call({ url: 'https://example.com' });\nconsole.log(`Run finished with status: ${run.status}`);\nconsole.log(`Dataset ID: ${run.defaultDatasetId}`);\n\n// Run with a timeout and log streaming to console\nconst run = await client.actor('my-actor').call(\n { url: 'https://example.com' },\n { waitSecs: 300, log: 'default' }\n);\n\n// Run with custom log instance\nimport { Log } from '@apify/log';\nconst log = new Log({ prefix: 'My Actor' });\nconst run = await client.actor('my-actor').call({ url: 'https://example.com' }, { log });\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 220, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L220", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 143, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input for the Actor. Can be any JSON-serializable value (object, array, string, number).\n If " - }, - { - "kind": "code", - "text": "`contentType`" - }, - { - "kind": "text", - "text": " is specified in options, input should be a string or Buffer." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 144, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Run configuration options (extends all options from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "start", - "target": 137 - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "type": { - "type": "reference", - "target": 293, - "name": "ActorCallOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 149, - "name": "defaultBuild", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 335, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L335", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 150, - "name": "defaultBuild", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the default build of this Actor.\n\nMakes an API call to resolve the Actor's default build, then returns a " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "BuildClient", - "target": 915 - }, - { - "kind": "text", - "text": "\nfor that build. Use the returned client to get build details, wait for the build to finish,\nor access its logs." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the default build" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-build-default-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Get the default build client, then fetch build details\nconst buildClient = await client.actor('my-actor').defaultBuild();\nconst build = await buildClient.get();\nconsole.log(`Default build status: ${build.status}`);\n\n// Wait up to 60 seconds for the default build to finish\nconst buildClient = await client.actor('my-actor').defaultBuild({ waitForFinish: 60 });\nconst build = await buildClient.get();\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 335, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L335", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 151, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for getting the default build" - } - ] - }, - "type": { - "type": "reference", - "target": 990, - "name": "BuildClientGetOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 915, - "name": "BuildClient", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 135, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 81, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L81", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 136, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the Actor." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 81, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L81", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 130, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 59, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L59", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 131, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the Actor object from the Apify API." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Actor object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 59, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L59", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 223, - "name": "Actor", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 152, - "name": "lastRun", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 370, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L370", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 153, - "name": "lastRun", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the last run of this Actor.\n\nProvides access to the most recent Actor run, optionally filtered by status or origin." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the last run" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-runs-last-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Get the last successful run\nconst lastRun = await client.actor('my-actor').lastRun({ status: 'SUCCEEDED' }).get();\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 370, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L370", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 154, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options to filter the last run" - } - ] - }, - "type": { - "type": "reference", - "target": 409, - "name": "ActorLastRunOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 2191, - "name": "RunClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 157, - "name": "runs", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 408, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L408", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 158, - "name": "runs", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing runs of this Actor." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Actor's run collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-runs-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 408, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L408", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2317, - "name": "RunCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 137, - "name": "start", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 119, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L119", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 138, - "name": "start", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts the Actor and immediately returns the Run object.\n\nThe Actor run can be configured with optional input and various options. The run starts\nasynchronously and this method returns immediately without waiting for completion.\nUse the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "call", - "target": 141 - }, - { - "kind": "text", - "text": " method if you want to wait for the Actor to finish." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Actor run object with status, usage, and storage IDs" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-runs-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Start Actor with simple input\nconst run = await client.actor('my-actor').start({ url: 'https://example.com' });\nconsole.log(`Run started with ID: ${run.id}, status: ${run.status}`);\n\n// Start Actor with specific build and memory\nconst run = await client.actor('my-actor').start(\n { url: 'https://example.com' },\n { build: '0.1.2', memory: 512, timeout: 300 }\n);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 119, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L119", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 139, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input for the Actor. Can be any JSON-serializable value (object, array, string, number).\n If " - }, - { - "kind": "code", - "text": "`contentType`" - }, - { - "kind": "text", - "text": " is specified in options, input should be a string or Buffer." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 140, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Run configuration options" - } - ] - }, - "type": { - "type": "reference", - "target": 282, - "name": "ActorStartOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 132, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 70, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L70", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 133, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the Actor with specified fields." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated Actor object" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 70, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L70", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 134, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to update in the Actor" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 223, - "name": "Actor", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "description" - }, - { - "type": "literal", - "value": "isPublic" - }, - { - "type": "literal", - "value": "isDeprecated" - }, - { - "type": "literal", - "value": "seoTitle" - }, - { - "type": "literal", - "value": "seoDescription" - }, - { - "type": "literal", - "value": "title" - }, - { - "type": "literal", - "value": "restartOnError" - }, - { - "type": "literal", - "value": "versions" - }, - { - "type": "literal", - "value": "categories" - }, - { - "type": "literal", - "value": "defaultRunOptions" - }, - { - "type": "literal", - "value": "actorStandby" - }, - { - "type": "literal", - "value": "actorPermissionLevel" - }, - { - "type": "literal", - "value": "taggedBuilds" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 223, - "name": "Actor", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 159, - "name": "version", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 423, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L423", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 160, - "name": "version", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific version of this Actor." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specified Actor version" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 423, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L423", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 161, - "name": "versionNumber", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Version number (e.g., '0.1', '1.2.3')" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 718, - "name": "ActorVersionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 162, - "name": "versions", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 438, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L438", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 163, - "name": "versions", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing versions of this Actor." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Actor's version collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-versions-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 438, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L438", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 841, - "name": "ActorVersionCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 164, - "name": "webhooks", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 448, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L448", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 165, - "name": "webhooks", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing webhooks associated with this Actor." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Actor's webhook collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-webhooks-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 448, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L448", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3149, - "name": "WebhookCollectionClient", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 193, - 189, - 194, - 187, - 195, - 190, - 191, - 188, - 192 - ] - }, - { - "title": "Methods", - "children": [ - 145, - 155, - 141, - 149, - 135, - 130, - 152, - 157, - 137, - 132, - 159, - 162, - 164 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 42, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L42", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 475, - "name": "ActorCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of Actors in your account.\n\nProvides methods to list and create Actors. To access an individual Actor,\nuse the " - }, - { - "kind": "code", - "text": "`actor()`" - }, - { - "kind": "text", - "text": " method on the main ApifyClient." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst actorsClient = client.actors();\n\n// List all Actors\nconst { items } = await actorsClient.list();\n\n// Create a new Actor\nconst newActor = await actorsClient.create({\n name: 'my-actor',\n title: 'My Actor'\n});\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors" - } - ] - } - ] - }, - "children": [ - { - "id": 513, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 509, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 514, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 507, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 515, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 510, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 511, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 508, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 512, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 482, - "name": "create", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 85, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L85", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 483, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Actor." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The created Actor object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/acts-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 85, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L85", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 484, - "name": "actor", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor data." - } - ] - }, - "type": { - "type": "reference", - "target": 560, - "name": "ActorCollectionCreateOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 223, - "name": "Actor", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 479, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 63, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 480, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all Actors.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of Actors." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/acts-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 63, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 481, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination options." - } - ] - }, - "type": { - "type": "reference", - "target": 546, - "name": "ActorCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedIterator" - }, - "typeArguments": [ - { - "type": "reference", - "target": 553, - "name": "ActorCollectionListItem", - "package": "apify-client" - } - ], - "name": "PaginatedIterator", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 513, - 509, - 514, - 507, - 515, - 510, - 511, - 508, - 512 - ] - }, - { - "title": "Methods", - "children": [ - 482, - 479 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 32, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 576, - "name": "ActorEnvVarClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific Actor environment variable.\n\nEnvironment variables are key-value pairs that are available to the Actor during execution.\nThis client provides methods to get, update, and delete environment variables." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst actorClient = client.actor('my-actor-id');\nconst versionClient = actorClient.version('0.1');\n\n// Get an environment variable\nconst envVarClient = versionClient.envVar('MY_VAR');\nconst envVar = await envVarClient.get();\n\n// Update environment variable\nawait envVarClient.update({ value: 'new-value' });\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/development/programming-interface/environment-variables" - } - ] - } - ] - }, - "children": [ - { - "id": 614, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 610, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 615, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 608, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 616, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 611, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 612, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 609, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 613, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 585, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var.ts", - "line": 67, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var.ts#L67", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 586, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the environment variable." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-env-var-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var.ts", - "line": 67, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var.ts#L67", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 580, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var.ts", - "line": 46, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var.ts#L46", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 581, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the environment variable." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The environment variable object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-env-var-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var.ts", - "line": 46, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var.ts#L46", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 582, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var.ts", - "line": 57, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var.ts#L57", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 583, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the environment variable." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated environment variable object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-env-var-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var.ts", - "line": 57, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var.ts#L57", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 584, - "name": "actorEnvVar", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The updated environment variable data." - } - ] - }, - "type": { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 614, - 610, - 615, - 608, - 616, - 611, - 612, - 609, - 613 - ] - }, - { - "title": "Methods", - "children": [ - 585, - 580, - 582 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var.ts", - "line": 29, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var.ts#L29", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 644, - "name": "ActorEnvVarCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of environment variables for an Actor version.\n\nEnvironment variables are key-value pairs that are available to the Actor during execution.\nThis client provides methods to list and create environment variables." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst actorClient = client.actor('my-actor-id');\nconst versionClient = actorClient.version('0.1');\n\n// List all environment variables\nconst envVarsClient = versionClient.envVars();\nconst { items } = await envVarsClient.list();\n\n// Create a new environment variable\nconst newEnvVar = await envVarsClient.create({\n name: 'MY_VAR',\n value: 'my-value',\n isSecret: false\n});\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/development/programming-interface/environment-variables" - } - ] - } - ] - }, - "children": [ - { - "id": 682, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 678, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 683, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 676, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 684, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 679, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 680, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 677, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 681, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 651, - "name": "create", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var_collection.ts", - "line": 77, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var_collection.ts#L77", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 652, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new environment variable for this Actor version." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The created environment variable object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-env-vars-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var_collection.ts", - "line": 77, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var_collection.ts#L77", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 653, - "name": "actorEnvVar", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The environment variable data." - } - ] - }, - "type": { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 648, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var_collection.ts", - "line": 64, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var_collection.ts#L64", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 649, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all environment variables of this Actor version.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list();\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list()) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of environment variables." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-env-vars-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var_collection.ts", - "line": 64, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var_collection.ts#L64", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 650, - "name": "_options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 712, - "name": "ActorEnvVarCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 717, - "name": "ActorEnvVarListResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es2018.asynciterable.d.ts", - "qualifiedName": "AsyncIterable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "AsyncIterable", - "package": "typescript" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 682, - 678, - 683, - 676, - 684, - 679, - 680, - 677, - 681 - ] - }, - { - "title": "Methods", - "children": [ - 651, - 648 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var_collection.ts", - "line": 34, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var_collection.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 718, - "name": "ActorVersionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific Actor version.\n\nActor versions represent specific builds or snapshots of an Actor's code. This client provides\nmethods to get, update, and delete versions, as well as manage their environment variables." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst actorClient = client.actor('my-actor-id');\n\n// Get a specific version\nconst versionClient = actorClient.version('0.1');\nconst version = await versionClient.get();\n\n// Update version\nawait versionClient.update({ buildTag: 'latest' });\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-versions-get" - } - ] - } - ] - }, - "children": [ - { - "id": 761, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 757, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 762, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 755, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 763, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 758, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 759, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 756, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 760, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 727, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 68, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L68", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 728, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the Actor version." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 68, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L68", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 729, - "name": "envVar", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 79, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L79", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 730, - "name": "envVar", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the specified environment variable of this Actor version." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the environment variable." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-env-var-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 79, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L79", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 731, - "name": "envVarName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the environment variable." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 576, - "name": "ActorEnvVarClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 732, - "name": "envVars", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 94, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L94", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 733, - "name": "envVars", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the environment variables of this Actor version." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Actor version's environment variables." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-env-vars-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 94, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L94", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 644, - "name": "ActorEnvVarCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 722, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 46, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L46", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 723, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the Actor version." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Actor version object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 46, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L46", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 840, - "name": "FinalActorVersion", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 724, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 57, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L57", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 725, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the Actor version with the specified fields." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated Actor version object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-version-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 57, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L57", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 726, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to update." - } - ] - }, - "type": { - "type": "reference", - "target": 839, - "name": "ActorVersion", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 840, - "name": "FinalActorVersion", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 761, - 757, - 762, - 755, - 763, - 758, - 759, - 756, - 760 - ] - }, - { - "title": "Methods", - "children": [ - 727, - 729, - 732, - 722, - 724 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 29, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L29", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 841, - "name": "ActorVersionCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of Actor versions.\n\nActor versions represent specific builds or snapshots of an Actor's code. This client provides\nmethods to list and create versions for a specific Actor." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst actorClient = client.actor('my-actor-id');\n\n// List all versions\nconst versionsClient = actorClient.versions();\nconst { items } = await versionsClient.list();\n\n// Create a new version\nconst newVersion = await versionsClient.create({\n versionNumber: '0.2',\n buildTag: 'latest'\n});\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-versions-get" - } - ] - } - ] - }, - "children": [ - { - "id": 879, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 875, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 880, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 873, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 881, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 876, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 877, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 874, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 878, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 848, - "name": "create", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version_collection.ts", - "line": 75, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version_collection.ts#L75", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 849, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new Actor version." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The created Actor version object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-versions-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version_collection.ts", - "line": 75, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version_collection.ts#L75", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 850, - "name": "actorVersion", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Actor version data." - } - ] - }, - "type": { - "type": "reference", - "target": 839, - "name": "ActorVersion", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 840, - "name": "FinalActorVersion", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 845, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version_collection.ts", - "line": 62, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version_collection.ts#L62", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 846, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all Actor versions.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list();\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list()) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of Actor versions." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-versions-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version_collection.ts", - "line": 62, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version_collection.ts#L62", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 847, - "name": "_options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 909, - "name": "ActorVersionCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 914, - "name": "ActorVersionListResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es2018.asynciterable.d.ts", - "qualifiedName": "AsyncIterable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 840, - "name": "FinalActorVersion", - "package": "apify-client" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "AsyncIterable", - "package": "typescript" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 879, - 875, - 880, - 873, - 881, - 876, - 877, - 874, - 878 - ] - }, - { - "title": "Methods", - "children": [ - 848, - 845 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version_collection.ts", - "line": 32, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version_collection.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 3380, - "name": "ApifyApiError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An " - }, - { - "kind": "code", - "text": "`ApifyApiError`" - }, - { - "kind": "text", - "text": " is thrown for successful HTTP requests that reach the API,\nbut the API responds with an error response. Typically, those are rate limit\nerrors and internal errors, which are automatically retried, or validation\nerrors, which are thrown immediately, because a correction by the user is\nneeded." - } - ] - }, - "children": [ - { - "id": 3402, - "name": "attempt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of the API call attempt." - } - ] - }, - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 46, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L46", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3417, - "name": "cause", - "variant": "declaration", - "kind": 1024, - "flags": { - "isExternal": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.es2022.error.d.ts", - "line": 24, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.cause" - } - }, - { - "id": 3399, - "name": "clientMethod", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The invoked resource client and the method. Known issue: Sometimes it displays\nas " - }, - { - "kind": "code", - "text": "`unknown`" - }, - { - "kind": "text", - "text": " because it can't be parsed from a stack trace." - } - ] - }, - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 31, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L31", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3406, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional data provided by the API about the error" - } - ] - }, - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 67, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L67", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3403, - "name": "httpMethod", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP method of the API call." - } - ] - }, - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 51, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L51", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3415, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.es5.d.ts", - "line": 1075, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.message" - } - }, - { - "id": 3398, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 25, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L25", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.name" - } - }, - { - "id": 3405, - "name": "originalStack", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Original stack trace of the exception. It is replaced\nby a more informative stack with API call information." - } - ] - }, - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 62, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L62", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3404, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Full path of the API endpoint (URL excluding origin)." - } - ] - }, - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 56, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L56", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3416, - "name": "stack", - "variant": "declaration", - "kind": 1024, - "flags": { - "isExternal": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.es5.d.ts", - "line": 1076, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.stack" - } - }, - { - "id": 3400, - "name": "statusCode", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP status code of the error." - } - ] - }, - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3401, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the error, as returned by the API." - } - ] - }, - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 41, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L41", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3392, - "name": "stackTraceLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`Error.stackTraceLimit`" - }, - { - "kind": "text", - "text": " property specifies the number of stack frames\ncollected by a stack trace (whether generated by " - }, - { - "kind": "code", - "text": "`new Error().stack`" - }, - { - "kind": "text", - "text": " or\n" - }, - { - "kind": "code", - "text": "`Error.captureStackTrace(obj)`" - }, - { - "kind": "text", - "text": ").\n\nThe default value is " - }, - { - "kind": "code", - "text": "`10`" - }, - { - "kind": "text", - "text": " but may be set to any valid JavaScript number. Changes\nwill affect any stack trace captured _after_ the value has been changed.\n\nIf set to a non-number value, or set to a negative number, stack traces will\nnot capture any frames." - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 68, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.stackTraceLimit" - } - }, - { - "id": 3384, - "name": "captureStackTrace", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 52, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3385, - "name": "captureStackTrace", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a " - }, - { - "kind": "code", - "text": "`.stack`" - }, - { - "kind": "text", - "text": " property on " - }, - { - "kind": "code", - "text": "`targetObject`" - }, - { - "kind": "text", - "text": ", which when accessed returns\na string representing the location in the code at which\n" - }, - { - "kind": "code", - "text": "`Error.captureStackTrace()`" - }, - { - "kind": "text", - "text": " was called.\n\n" - }, - { - "kind": "code", - "text": "```js\nconst myObject = {};\nError.captureStackTrace(myObject);\nmyObject.stack; // Similar to `new Error().stack`\n```" - }, - { - "kind": "text", - "text": "\n\nThe first line of the trace will be prefixed with\n" - }, - { - "kind": "code", - "text": "`${myObject.name}: ${myObject.message}`" - }, - { - "kind": "text", - "text": ".\n\nThe optional " - }, - { - "kind": "code", - "text": "`constructorOpt`" - }, - { - "kind": "text", - "text": " argument accepts a function. If given, all frames\nabove " - }, - { - "kind": "code", - "text": "`constructorOpt`" - }, - { - "kind": "text", - "text": ", including " - }, - { - "kind": "code", - "text": "`constructorOpt`" - }, - { - "kind": "text", - "text": ", will be omitted from the\ngenerated stack trace.\n\nThe " - }, - { - "kind": "code", - "text": "`constructorOpt`" - }, - { - "kind": "text", - "text": " argument is useful for hiding implementation\ndetails of error generation from the user. For instance:\n\n" - }, - { - "kind": "code", - "text": "```js\nfunction a() {\n b();\n}\n\nfunction b() {\n c();\n}\n\nfunction c() {\n // Create an error without stack trace to avoid calculating the stack trace twice.\n const { stackTraceLimit } = Error;\n Error.stackTraceLimit = 0;\n const error = new Error();\n Error.stackTraceLimit = stackTraceLimit;\n\n // Capture the stack trace above function b\n Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace\n throw error;\n}\n\na();\n```" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 52, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 3386, - "name": "targetObject", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 3387, - "name": "constructorOpt", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.captureStackTrace" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.captureStackTrace" - } - }, - { - "id": 3381, - "name": "isError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.esnext.error.d.ts", - "line": 21, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3382, - "name": "isError", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Indicates whether the argument provided is a built-in Error instance or not." - } - ] - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.esnext.error.d.ts", - "line": 21, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 3383, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.isError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.isError" - } - }, - { - "id": 3388, - "name": "prepareStackTrace", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 56, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3389, - "name": "prepareStackTrace", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://v8.dev/docs/stack-trace-api#customizing-stack-traces" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 56, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 3390, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - }, - { - "id": 3391, - "name": "stackTraces", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "NodeJS.CallSite" - }, - "name": "CallSite", - "package": "@types/node", - "qualifiedName": "NodeJS.CallSite" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.prepareStackTrace" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.prepareStackTrace" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3402, - 3417, - 3399, - 3406, - 3403, - 3415, - 3398, - 3405, - 3404, - 3416, - 3400, - 3401, - 3392 - ] - }, - { - "title": "Methods", - "children": [ - 3384, - 3381, - 3388 - ] - } - ], - "sources": [ - { - "fileName": "src/apify_api_error.ts", - "line": 24, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_api_error.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ] - }, - { - "id": 36, - "name": "ApifyClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The official JavaScript client for the Apify API.\n\nProvides programmatic access to all Apify platform resources including Actors, runs, datasets,\nkey-value stores, request queues, and more. Works in both Node.js and browser environments." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nimport { ApifyClient } from 'apify-client';\n\nconst client = new ApifyClient({ token: 'my-token' });\n\n// Start an Actor and wait for it to finish\nconst run = await client.actor('my-actor-id').call();\n\n// Fetch dataset items\nconst { items } = await client.dataset(run.defaultDatasetId).listItems();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2" - } - ] - } - ] - }, - "children": [ - { - "id": 37, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 72, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L72", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 38, - "name": "new ApifyClient", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 72, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L72", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 39, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 117, - "name": "ApifyClientOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 40, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 60, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L60", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 45, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 70, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L70", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - } - }, - { - "id": 44, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 68, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L68", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Log" - }, - "name": "Log", - "package": "@apify/log" - } - }, - { - "id": 41, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 62, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L62", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 43, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 66, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L66", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/statistics.ts", - "qualifiedName": "Statistics" - }, - "name": "Statistics", - "package": "apify-client" - } - }, - { - "id": 42, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 64, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L64", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 55, - "name": "actor", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 155, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L155", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 56, - "name": "actor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific Actor.\n\nUse this to get, update, delete, start, or call an Actor, as well as manage its builds,\nruns, versions, and webhooks." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specific Actor" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/act-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Call an Actor and wait for it to finish\nconst run = await client.actor('apify/web-scraper').call({ url: 'https://example.com' });\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 155, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L155", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 57, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actor ID or username/name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 126, - "name": "ActorClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 53, - "name": "actors", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 135, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L135", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 54, - "name": "actors", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing Actors in your account.\n\nProvides access to the Actor collection, allowing you to list, create, and search for Actors." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Actors collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/acts-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 135, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L135", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 475, - "name": "ActorCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 60, - "name": "build", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 185, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L185", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 61, - "name": "build", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific Actor build.\n\nUse this to get details about a build, wait for it to finish, or access its logs." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specified build" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-build-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 185, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L185", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 62, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Build ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 915, - "name": "BuildClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 58, - "name": "builds", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 172, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L172", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 59, - "name": "builds", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing Actor builds in your account.\n\nLists all builds across all of your Actors." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for Actor builds collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-builds-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 172, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L172", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1049, - "name": "BuildCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 65, - "name": "dataset", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 229, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L229", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 66, - "name": "dataset", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific dataset.\n\nUse this to read, write, and manage items in the dataset. Datasets contain structured\ndata stored as individual items (records)." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specific Dataset" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/dataset-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Push items to a dataset\nawait client.dataset('my-dataset').pushItems([\n { url: 'https://example.com', title: 'Example' },\n { url: 'https://test.com', title: 'Test' }\n]);\n\n// Retrieve items\nconst { items } = await client.dataset('my-dataset').listItems();\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 229, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L229", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 67, - "name": "Data", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of items stored in the dataset" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 68, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Dataset ID or name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1121, - "typeArguments": [ - { - "type": "reference", - "target": 67, - "name": "Data", - "package": "apify-client", - "refersToTypeParameter": true - } - ], - "name": "DatasetClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 63, - "name": "datasets", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 202, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L202", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 64, - "name": "datasets", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing datasets in your account.\n\nDatasets store structured data results from Actor runs. Use this to list or create datasets." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Datasets collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/datasets-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 202, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L202", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1301, - "name": "DatasetCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 71, - "name": "keyValueStore", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 271, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L271", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 72, - "name": "keyValueStore", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific key-value store.\n\nUse this to read, write, and delete records in the store. Key-value stores can hold\nany type of data including text, JSON, images, and other files." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specific key-value store" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-store-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Save a record\nawait client.keyValueStore('my-store').setRecord({ key: 'OUTPUT', value: { foo: 'bar' } });\n\n// Get a record\nconst record = await client.keyValueStore('my-store').getRecord('OUTPUT');\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 271, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L271", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 73, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Key-value store ID or name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1382, - "name": "KeyValueStoreClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 69, - "name": "keyValueStores", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 248, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L248", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 70, - "name": "keyValueStores", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing key-value stores in your account.\n\nKey-value stores are used to store arbitrary data records or files." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Key-value stores collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-stores-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 248, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L248", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1539, - "name": "KeyValueStoreCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 74, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 287, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L287", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 75, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for accessing logs of an Actor build or run." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for accessing logs" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/log-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 287, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L287", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 76, - "name": "buildOrRunId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Build ID or run ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1620, - "name": "LogClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 79, - "name": "requestQueue", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 329, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L329", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 80, - "name": "requestQueue", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific request queue.\n\nUse this to add, retrieve, and manage requests in the queue. Request queues are used\nby web crawlers to manage URLs that need to be visited." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specific Request queue" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Add requests to a queue\nconst queue = client.requestQueue('my-queue');\nawait queue.addRequest({ url: 'https://example.com', uniqueKey: 'example' });\n\n// Get and lock the next request\nconst { items } = await queue.listAndLockHead({ lockSecs: 60 });\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 329, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L329", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 81, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request queue ID or name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 82, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for the request queue client" - } - ] - }, - "type": { - "type": "reference", - "target": 1998, - "name": "RequestQueueUserOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 1876, - "name": "RequestQueueClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 77, - "name": "requestQueues", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 304, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L304", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 78, - "name": "requestQueues", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing request queues in your account.\n\nRequest queues store URLs to be crawled, along with their metadata." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Request queues collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queues-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 304, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L304", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2113, - "name": "RequestQueueCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 85, - "name": "run", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 380, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L380", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 86, - "name": "run", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific Actor run.\n\nUse this to get details about a run, wait for it to finish, abort it, or access its\ndataset, key-value store, and request queue." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specified run" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Wait for a run to finish\nconst run = await client.run('run-id').waitForFinish();\n\n// Access run's dataset\nconst { items } = await client.run('run-id').dataset().listItems();\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 380, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L380", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 87, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Run ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2191, - "name": "RunClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 83, - "name": "runs", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 354, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L354", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 84, - "name": "runs", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing Actor runs in your account.\n\nLists all runs across all of your Actors." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the run collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-runs-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 354, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L354", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2317, - "name": "RunCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 95, - "name": "schedule", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 446, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L446", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 96, - "name": "schedule", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific schedule.\n\nUse this to get, update, or delete a schedule." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specific Schedule" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/schedule-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 446, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L446", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 97, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Schedule ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2390, - "name": "ScheduleClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 93, - "name": "schedules", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 433, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L433", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 94, - "name": "schedules", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing schedules in your account.\n\nSchedules automatically start Actor or task runs at specified times." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Schedules collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/schedules-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 433, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L433", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2506, - "name": "ScheduleCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 113, - "name": "setStatusMessage", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 553, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L553", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 114, - "name": "setStatusMessage", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sets a status message for the current Actor run.\n\nThis is a convenience method that updates the status message of the run specified by\nthe " - }, - { - "kind": "code", - "text": "`ACTOR_RUN_ID`" - }, - { - "kind": "text", - "text": " environment variable. Only works when called from within an Actor run." - } - ], - "blockTags": [ - { - "tag": "@throws", - "content": [ - { - "kind": "text", - "text": "If " - }, - { - "kind": "code", - "text": "`ACTOR_RUN_ID`" - }, - { - "kind": "text", - "text": " environment variable is not set" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 553, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L553", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 115, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status message to set" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 116, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options for the status message" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@crawlee/src/storages.ts", - "qualifiedName": "SetStatusMessageOptions" - }, - "name": "SetStatusMessageOptions", - "package": "@crawlee/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 111, - "name": "store", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 539, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L539", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 112, - "name": "store", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for browsing Actors in Apify Store.\n\nUse this to search and retrieve information about public Actors." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Apify Store" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/store-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 539, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L539", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2581, - "name": "StoreCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 90, - "name": "task", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 416, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L416", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 91, - "name": "task", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific Actor task.\n\nUse this to get, update, delete, or run a task with pre-configured input." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specified task" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Run a task and wait for it to finish\nconst run = await client.task('my-task').call();\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 416, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L416", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 92, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Task ID or username/task-name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 2670, - "name": "TaskClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 88, - "name": "tasks", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 397, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L397", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 89, - "name": "tasks", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing Actor tasks in your account.\n\nTasks are pre-configured Actor runs with stored input that can be executed repeatedly." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the task collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-tasks-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 397, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L397", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2792, - "name": "TaskCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 98, - "name": "user", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 464, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L464", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 99, - "name": "user", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for accessing user data.\n\nBy default, returns information about the current user (determined by the API token)." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the user" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/user-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 464, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L464", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 100, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User ID or username. Defaults to 'me' (current user)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "ME_USER_NAME_PLACEHOLDER" - } - ], - "type": { - "type": "reference", - "target": 2874, - "name": "UserClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 103, - "name": "webhook", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 494, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L494", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 104, - "name": "webhook", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific webhook.\n\nUse this to get, update, delete, or test a webhook." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specific webhook" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 494, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L494", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 105, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Webhook ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 3044, - "name": "WebhookClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 108, - "name": "webhookDispatch", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 522, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L522", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 109, - "name": "webhookDispatch", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for a specific webhook dispatch." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the specific webhook dispatch" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-dispatch-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 522, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L522", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 110, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Webhook dispatch ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 3222, - "name": "WebhookDispatchClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 106, - "name": "webhookDispatches", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 511, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L511", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 107, - "name": "webhookDispatches", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for viewing webhook dispatches in your account.\n\nWebhook dispatches represent individual invocations of webhooks." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the webhook dispatches collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-dispatches-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 511, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L511", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3310, - "name": "WebhookDispatchCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 101, - "name": "webhooks", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 481, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L481", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 102, - "name": "webhooks", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for managing webhooks in your account.\n\nWebhooks notify external services when specific events occur (e.g., Actor run finishes)." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the Webhooks collection" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhooks-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 481, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L481", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3149, - "name": "WebhookCollectionClient", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 37 - ] - }, - { - "title": "Properties", - "children": [ - 40, - 45, - 44, - 41, - 43, - 42 - ] - }, - { - "title": "Methods", - "children": [ - 55, - 53, - 60, - 58, - 65, - 63, - 71, - 69, - 74, - 79, - 77, - 85, - 83, - 95, - 93, - 113, - 111, - 90, - 88, - 98, - 103, - 108, - 106, - 101 - ] - } - ], - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 59, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L59", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 915, - "name": "BuildClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific Actor build.\n\nBuilds are created when an Actor is built from source code. This client provides methods\nto get build details, wait for the build to finish, abort it, and access its logs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst buildClient = client.build('my-build-id');\n\n// Get build details\nconst build = await buildClient.get();\n\n// Wait for the build to finish\nconst finishedBuild = await buildClient.waitForFinish();\n\n// Access build logs\nconst log = await buildClient.log().get();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/running/runs-and-builds#builds" - } - ] - } - ] - }, - "children": [ - { - "id": 960, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 956, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 961, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 954, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 962, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 957, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 958, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 955, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 959, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 922, - "name": "abort", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 87, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L87", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 923, - "name": "abort", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aborts the Actor build.\n\nStops the build process immediately. The build will have an " - }, - { - "kind": "code", - "text": "`ABORTED`" - }, - { - "kind": "text", - "text": " status." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated Build object with " - }, - { - "kind": "code", - "text": "`ABORTED`" - }, - { - "kind": "text", - "text": " status" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-build-abort-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nawait client.build('build-id').abort();\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 87, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L87", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 998, - "name": "Build", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 924, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 102, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L102", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 925, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the Actor build." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-build-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 102, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L102", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 919, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 63, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 920, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the Actor build object from the Apify API." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Build object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-build-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Get build status immediately\nconst build = await client.build('build-id').get();\nconsole.log(`Status: ${build.status}`);\n\n// Wait up to 60 seconds for build to finish\nconst build = await client.build('build-id').get({ waitForFinish: 60 });\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 63, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 921, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get options" - } - ] - }, - "type": { - "type": "reference", - "target": 990, - "name": "BuildClientGetOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 998, - "name": "Build", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 926, - "name": "getOpenApiDefinition", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 112, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L112", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 927, - "name": "getOpenApiDefinition", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the OpenAPI definition for the Actor build." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The OpenAPI definition object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-build-openapi-json-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 112, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L112", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1026, - "name": "OpenApiDefinition", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 931, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 176, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L176", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 932, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for accessing the log of this Actor build." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for accessing the build's log" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-build-log-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Get build log\nconst log = await client.build('build-id').log().get();\nconsole.log(log);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 176, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L176", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1620, - "name": "LogClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 928, - "name": "waitForFinish", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 152, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L152", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 929, - "name": "waitForFinish", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Waits for the Actor build to finish and returns the finished Build object.\n\nThe promise resolves when the build reaches a terminal state (" - }, - { - "kind": "code", - "text": "`SUCCEEDED`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`FAILED`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`ABORTED`" - }, - { - "kind": "text", - "text": ", or " - }, - { - "kind": "code", - "text": "`TIMED-OUT`" - }, - { - "kind": "text", - "text": ").\nIf " - }, - { - "kind": "code", - "text": "`waitSecs`" - }, - { - "kind": "text", - "text": " is provided and the timeout is reached, the promise resolves with the unfinished\nBuild object (status will be " - }, - { - "kind": "code", - "text": "`RUNNING`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`READY`" - }, - { - "kind": "text", - "text": "). The promise is NOT rejected based on build status.\n\nUnlike the " - }, - { - "kind": "code", - "text": "`waitForFinish`" - }, - { - "kind": "text", - "text": " parameter in " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "get", - "target": 919 - }, - { - "kind": "text", - "text": ", this method can wait indefinitely\nby polling the build status. It uses the " - }, - { - "kind": "code", - "text": "`waitForFinish`" - }, - { - "kind": "text", - "text": " parameter internally (max 60s per call)\nand continuously polls until the build finishes or the timeout is reached.\n\nThis is useful when you need to immediately start a run after a build finishes." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Build object (finished or still building if timeout was reached)" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Wait indefinitely for build to finish\nconst build = await client.build('build-id').waitForFinish();\nconsole.log(`Build finished with status: ${build.status}`);\n\n// Start a run immediately after build succeeds\nconst build = await client.build('build-id').waitForFinish();\nif (build.status === 'SUCCEEDED') {\n const run = await client.actor('my-actor').start();\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 152, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L152", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 930, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wait options" - } - ] - }, - "type": { - "type": "reference", - "target": 992, - "name": "BuildClientWaitForFinishOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 998, - "name": "Build", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 960, - 956, - 961, - 954, - 962, - 957, - 958, - 955, - 959 - ] - }, - { - "title": "Methods", - "children": [ - 922, - 924, - 919, - 926, - 931, - 928 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 34, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 1049, - "name": "BuildCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of Actor builds.\n\nProvides methods to list Actor builds across all Actors or for a specific Actor.\nTo access an individual build, use the " - }, - { - "kind": "code", - "text": "`build()`" - }, - { - "kind": "text", - "text": " method on the main ApifyClient." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\n\n// List all builds\nconst buildsClient = client.builds();\nconst { items } = await buildsClient.list();\n\n// List builds for a specific Actor\nconst actorBuildsClient = client.actor('my-actor-id').builds();\nconst { items: actorBuilds } = await actorBuildsClient.list();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/running/runs-and-builds#builds" - } - ] - } - ] - }, - "children": [ - { - "id": 1084, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 1080, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 1085, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 1078, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 1086, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 1081, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 1082, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 1079, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 1083, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 1053, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build_collection.ts", - "line": 60, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build_collection.ts#L60", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1054, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all Actor builds.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of Actor builds." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-builds-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build_collection.ts", - "line": 60, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build_collection.ts#L60", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1055, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination and sorting options." - } - ] - }, - "type": { - "type": "reference", - "target": 1114, - "name": "BuildCollectionClientListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedIterator" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1119, - "name": "BuildCollectionClientListItem", - "package": "apify-client" - } - ], - "name": "PaginatedIterator", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1084, - 1080, - 1085, - 1078, - 1086, - 1081, - 1082, - 1079, - 1083 - ] - }, - { - "title": "Methods", - "children": [ - 1053 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build_collection.ts", - "line": 29, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build_collection.ts#L29", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 1121, - "name": "DatasetClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific Dataset.\n\nDatasets store structured data results from Actor runs. This client provides methods to push items,\nlist and retrieve items, download items in various formats (JSON, CSV, Excel, etc.), and manage\nthe dataset." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst datasetClient = client.dataset('my-dataset-id');\n\n// Push items to the dataset\nawait datasetClient.pushItems([\n { url: 'https://example.com', title: 'Example' },\n { url: 'https://test.com', title: 'Test' }\n]);\n\n// List all items\nconst { items } = await datasetClient.listItems();\n\n// Download items as CSV\nconst buffer = await datasetClient.downloadItems('csv');\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/storage/dataset" - } - ] - } - ] - }, - "children": [ - { - "id": 1179, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 1175, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 1180, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 1173, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 1181, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 1176, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 1177, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 1174, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 1178, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 1145, - "name": "createItemsPublicUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 356, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L356", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1146, - "name": "createItemsPublicUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generates a public URL for accessing dataset items.\n\nIf the client has permission to access the dataset's URL signing key,\nthe URL will include a cryptographic signature allowing access without authentication.\nThis is useful for sharing dataset results with external services or users." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A public URL string for accessing the dataset items" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Create a URL that expires in 1 hour with specific fields\nconst url = await client.dataset('my-dataset').createItemsPublicUrl({\n expiresInSecs: 3600,\n fields: ['url', 'title'],\n limit: 100\n});\nconsole.log(`Share this URL: ${url}`);\n\n// Create a permanent public URL for clean items only\nconst url = await client.dataset('my-dataset').createItemsPublicUrl({\n clean: true,\n skipEmpty: true\n});\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 356, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L356", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1147, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL generation options (extends all options from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "listItems", - "target": 1133 - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "type": { - "type": "reference", - "target": 1251, - "name": "DatasetClientCreateItemsUrlOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1131, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 88, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L88", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1132, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the dataset." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/dataset-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 88, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L88", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1136, - "name": "downloadItems", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 212, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L212", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1137, - "name": "downloadItems", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Downloads dataset items in a specific format.\n\nUnlike " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "listItems", - "target": 1133 - }, - { - "kind": "text", - "text": " which returns a " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "PaginatedList", - "target": 26 - }, - { - "kind": "text", - "text": " with an array of individual\ndataset items, this method returns the items serialized to the provided format\n(JSON, CSV, Excel, etc.) as a Buffer. Useful for exporting data for further processing." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Buffer containing the serialized data in the specified format" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/dataset-items-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Download as CSV with BOM for Excel compatibility\nconst csvBuffer = await client.dataset('my-dataset').downloadItems('csv', { bom: true });\nrequire('fs').writeFileSync('output.csv', csvBuffer);\n\n// Download as Excel with custom options\nconst xlsxBuffer = await client.dataset('my-dataset').downloadItems('xlsx', {\n fields: ['url', 'title', 'price'],\n skipEmpty: true,\n limit: 1000\n});\n\n// Download as XML with custom element names\nconst xmlBuffer = await client.dataset('my-dataset').downloadItems('xml', {\n xmlRoot: 'products',\n xmlRow: 'product'\n});\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 212, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L212", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1138, - "name": "format", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Output format: " - }, - { - "kind": "code", - "text": "`'json'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'jsonl'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'csv'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'xlsx'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'xml'`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`'rss'`" - }, - { - "kind": "text", - "text": ", or " - }, - { - "kind": "code", - "text": "`'html'`" - } - ] - }, - "type": { - "type": "reference", - "target": 1266, - "name": "DownloadItemsFormat", - "package": "apify-client" - } - }, - { - "id": 1139, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Download and formatting options (extends all options from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "listItems", - "target": 1133 - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "type": { - "type": "reference", - "target": 1274, - "name": "DatasetClientDownloadItemsOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/buffer.buffer.d.ts", - "qualifiedName": "__global.Buffer" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "ArrayBufferLike" - }, - "name": "ArrayBufferLike", - "package": "typescript" - } - ], - "name": "Buffer", - "package": "@types/node", - "qualifiedName": "__global.Buffer" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1126, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 66, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L66", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1127, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the dataset object from the Apify API." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Dataset object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/dataset-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 66, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L66", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 1210, - "name": "Dataset", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1143, - "name": "getStatistics", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 309, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L309", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1144, - "name": "getStatistics", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets statistical information about the dataset.\n\nReturns statistics for each field in the dataset, including information about\ndata types, null counts, and value ranges." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Dataset statistics, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if not available" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/dataset-statistics-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 309, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L309", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 1294, - "name": "DatasetStatistics", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1133, - "name": "listItems", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 136, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L136", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1134, - "name": "listItems", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists items in the dataset.\n\nReturns a paginated list of dataset items. You can use pagination parameters to retrieve\nspecific subsets of items, and various filtering and formatting options to customize\nthe output." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated list with " - }, - { - "kind": "code", - "text": "`items`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`total`" - }, - { - "kind": "text", - "text": " count, " - }, - { - "kind": "code", - "text": "`offset`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`limit`" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/dataset-items-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Get first 100 items\nconst { items, total } = await client.dataset('my-dataset').listItems({ limit: 100 });\nconsole.log(`Retrieved ${items.length} of ${total} total items`);\n\n// Get items with specific fields only\nconst { items } = await client.dataset('my-dataset').listItems({\n fields: ['url', 'title'],\n skipEmpty: true,\n limit: 50\n});\n\n// Get items in descending order with pagination\nconst { items } = await client.dataset('my-dataset').listItems({\n desc: true,\n offset: 100,\n limit: 50\n});\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 136, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L136", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1135, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing items" - } - ] - }, - "type": { - "type": "reference", - "target": 1237, - "name": "DatasetClientListItemOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedIterator" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1209, - "name": "Data", - "package": "apify-client", - "qualifiedName": "DatasetClient.Data", - "refersToTypeParameter": true - } - ], - "name": "PaginatedIterator", - "package": "apify-client" - } - } - ] - }, - { - "id": 1140, - "name": "pushItems", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 284, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L284", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1141, - "name": "pushItems", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stores one or more items into the dataset.\n\nItems can be objects, strings, or arrays thereof. Each item will be stored as a separate\nrecord in the dataset. Objects are automatically serialized to JSON. If you provide an array,\nall items will be stored in order. This method is idempotent - calling it multiple times\nwith the same data will not create duplicates, but will append items each time." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/dataset-items-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Store a single object\nawait client.dataset('my-dataset').pushItems({\n url: 'https://example.com',\n title: 'Example Page',\n extractedAt: new Date()\n});\n\n// Store multiple items at once\nawait client.dataset('my-dataset').pushItems([\n { url: 'https://example.com', title: 'Example' },\n { url: 'https://test.com', title: 'Test' },\n { url: 'https://demo.com', title: 'Demo' }\n]);\n\n// Store string items\nawait client.dataset('my-dataset').pushItems(['item1', 'item2', 'item3']);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 284, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L284", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1142, - "name": "items", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A single item (object or string) or an array of items to store.\n Objects are automatically stringified to JSON. Strings are stored as-is." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1209, - "name": "Data", - "package": "apify-client", - "qualifiedName": "DatasetClient.Data", - "refersToTypeParameter": true - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1209, - "name": "Data", - "package": "apify-client", - "qualifiedName": "DatasetClient.Data", - "refersToTypeParameter": true - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1128, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 77, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L77", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1129, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the dataset with specified fields." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated Dataset object" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/dataset-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 77, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L77", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1130, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to update in the dataset" - } - ] - }, - "type": { - "type": "reference", - "target": 1233, - "name": "DatasetClientUpdateOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1210, - "name": "Dataset", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1179, - 1175, - 1180, - 1173, - 1181, - 1176, - 1177, - 1174, - 1178 - ] - }, - { - "title": "Methods", - "children": [ - 1145, - 1131, - 1136, - 1126, - 1143, - 1133, - 1140, - 1128 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 47, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L47", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1209, - "name": "Data", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type of items stored in the dataset" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 1301, - "name": "DatasetCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of datasets in your account.\n\nDatasets store structured data results from Actor runs. This client provides methods\nto list, create, or get datasets by name." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst datasetsClient = client.datasets();\n\n// List all datasets\nconst { items } = await datasetsClient.list();\n\n// Get or create a dataset by name\nconst dataset = await datasetsClient.getOrCreate('my-dataset');\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/storage/dataset" - } - ] - } - ] - }, - "children": [ - { - "id": 1340, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 1336, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 1341, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 1334, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 1342, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 1337, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 1338, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 1335, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 1339, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 1308, - "name": "getOrCreate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 86, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L86", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1309, - "name": "getOrCreate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets or creates a dataset with the specified name." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The dataset object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/datasets-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 86, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L86", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1310, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the dataset. If not provided, a default dataset is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1311, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options like schema." - } - ] - }, - "type": { - "type": "reference", - "target": 1377, - "name": "DatasetCollectionClientGetOrCreateOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1210, - "name": "Dataset", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1305, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 61, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L61", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1306, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all Datasets.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of Datasets." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/datasets-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 61, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L61", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1307, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination options." - } - ] - }, - "type": { - "type": "reference", - "target": 1370, - "name": "DatasetCollectionClientListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1379, - "name": "DatasetCollectionClientListResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es2018.asynciterable.d.ts", - "qualifiedName": "AsyncIterable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1210, - "name": "Dataset", - "package": "apify-client" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "AsyncIterable", - "package": "typescript" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1340, - 1336, - 1341, - 1334, - 1342, - 1337, - 1338, - 1335, - 1339 - ] - }, - { - "title": "Methods", - "children": [ - 1308, - 1305 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 30, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 1, - "name": "InvalidResponseBodyError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This error exists for the quite common situation, where only a partial JSON response is received and\nan attempt to parse the JSON throws an error. In most cases this can be resolved by retrying the\nrequest. We do that by identifying this error in HttpClient.\n\nThe properties mimic AxiosError for easier integration in HttpClient error handling." - } - ] - }, - "children": [ - { - "id": 14, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "src/interceptors.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/interceptors.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 15, - "name": "new InvalidResponseBodyError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "src/interceptors.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/interceptors.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 16, - "name": "response", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/axios/index.d.cts", - "qualifiedName": "axios.AxiosResponse" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "reflection", - "declaration": { - "id": 17, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ], - "name": "AxiosResponse", - "package": "axios", - "qualifiedName": "axios.AxiosResponse" - } - }, - { - "id": 18, - "name": "cause", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 1, - "name": "InvalidResponseBodyError", - "package": "apify-client" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 22, - "name": "cause", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/interceptors.ts", - "line": 22, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/interceptors.ts#L22", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.cause" - } - }, - { - "id": 19, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/interceptors.ts", - "line": 18, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/interceptors.ts#L18", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 24, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.es5.d.ts", - "line": 1075, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.message" - } - }, - { - "id": 23, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.es5.d.ts", - "line": 1074, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.name" - } - }, - { - "id": 20, - "name": "response", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/interceptors.ts", - "line": 20, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/interceptors.ts#L20", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/axios/index.d.cts", - "qualifiedName": "axios.AxiosResponse" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "reflection", - "declaration": { - "id": 21, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {} - } - } - ], - "name": "AxiosResponse", - "package": "axios", - "qualifiedName": "axios.AxiosResponse" - } - }, - { - "id": 25, - "name": "stack", - "variant": "declaration", - "kind": 1024, - "flags": { - "isExternal": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.es5.d.ts", - "line": 1076, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.stack" - } - }, - { - "id": 13, - "name": "stackTraceLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`Error.stackTraceLimit`" - }, - { - "kind": "text", - "text": " property specifies the number of stack frames\ncollected by a stack trace (whether generated by " - }, - { - "kind": "code", - "text": "`new Error().stack`" - }, - { - "kind": "text", - "text": " or\n" - }, - { - "kind": "code", - "text": "`Error.captureStackTrace(obj)`" - }, - { - "kind": "text", - "text": ").\n\nThe default value is " - }, - { - "kind": "code", - "text": "`10`" - }, - { - "kind": "text", - "text": " but may be set to any valid JavaScript number. Changes\nwill affect any stack trace captured _after_ the value has been changed.\n\nIf set to a non-number value, or set to a negative number, stack traces will\nnot capture any frames." - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 68, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.stackTraceLimit" - } - }, - { - "id": 5, - "name": "captureStackTrace", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 52, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 6, - "name": "captureStackTrace", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a " - }, - { - "kind": "code", - "text": "`.stack`" - }, - { - "kind": "text", - "text": " property on " - }, - { - "kind": "code", - "text": "`targetObject`" - }, - { - "kind": "text", - "text": ", which when accessed returns\na string representing the location in the code at which\n" - }, - { - "kind": "code", - "text": "`Error.captureStackTrace()`" - }, - { - "kind": "text", - "text": " was called.\n\n" - }, - { - "kind": "code", - "text": "```js\nconst myObject = {};\nError.captureStackTrace(myObject);\nmyObject.stack; // Similar to `new Error().stack`\n```" - }, - { - "kind": "text", - "text": "\n\nThe first line of the trace will be prefixed with\n" - }, - { - "kind": "code", - "text": "`${myObject.name}: ${myObject.message}`" - }, - { - "kind": "text", - "text": ".\n\nThe optional " - }, - { - "kind": "code", - "text": "`constructorOpt`" - }, - { - "kind": "text", - "text": " argument accepts a function. If given, all frames\nabove " - }, - { - "kind": "code", - "text": "`constructorOpt`" - }, - { - "kind": "text", - "text": ", including " - }, - { - "kind": "code", - "text": "`constructorOpt`" - }, - { - "kind": "text", - "text": ", will be omitted from the\ngenerated stack trace.\n\nThe " - }, - { - "kind": "code", - "text": "`constructorOpt`" - }, - { - "kind": "text", - "text": " argument is useful for hiding implementation\ndetails of error generation from the user. For instance:\n\n" - }, - { - "kind": "code", - "text": "```js\nfunction a() {\n b();\n}\n\nfunction b() {\n c();\n}\n\nfunction c() {\n // Create an error without stack trace to avoid calculating the stack trace twice.\n const { stackTraceLimit } = Error;\n Error.stackTraceLimit = 0;\n const error = new Error();\n Error.stackTraceLimit = stackTraceLimit;\n\n // Capture the stack trace above function b\n Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace\n throw error;\n}\n\na();\n```" - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 52, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 7, - "name": "targetObject", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 8, - "name": "constructorOpt", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.captureStackTrace" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.captureStackTrace" - } - }, - { - "id": 2, - "name": "isError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.esnext.error.d.ts", - "line": 21, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3, - "name": "isError", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Indicates whether the argument provided is a built-in Error instance or not." - } - ] - }, - "sources": [ - { - "fileName": "node_modules/typescript/lib/lib.esnext.error.d.ts", - "line": 21, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 4, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "predicate", - "name": "error", - "asserts": false, - "targetType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.isError" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.isError" - } - }, - { - "id": 9, - "name": "prepareStackTrace", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 56, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 10, - "name": "prepareStackTrace", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://v8.dev/docs/stack-trace-api#customizing-stack-traces" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/globals.d.ts", - "line": 56, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 11, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - }, - { - "id": 12, - "name": "stackTraces", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "NodeJS.CallSite" - }, - "name": "CallSite", - "package": "@types/node", - "qualifiedName": "NodeJS.CallSite" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.prepareStackTrace" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Error.prepareStackTrace" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 14 - ] - }, - { - "title": "Properties", - "children": [ - 22, - 19, - 24, - 23, - 20, - 25, - 13 - ] - }, - { - "title": "Methods", - "children": [ - 5, - 2, - 9 - ] - } - ], - "sources": [ - { - "fileName": "src/interceptors.ts", - "line": 17, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/interceptors.ts#L17", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ] - }, - { - "id": 1382, - "name": "KeyValueStoreClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific key-value store.\n\nKey-value stores are used to store arbitrary data records or files. Each record is identified by\na unique key and can contain any type of data. This client provides methods to get, set, and delete\nrecords, list keys, and manage the store." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst storeClient = client.keyValueStore('my-store-id');\n\n// Set a record\nawait storeClient.setRecord({\n key: 'OUTPUT',\n value: { foo: 'bar' },\n contentType: 'application/json'\n});\n\n// Get a record\nconst record = await storeClient.getRecord('OUTPUT');\n\n// List all keys\nconst { items } = await storeClient.listKeys();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/storage/key-value-store" - } - ] - } - ] - }, - "children": [ - { - "id": 1446, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 1442, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 1447, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 1440, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 1448, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 1443, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 1444, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 1441, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 1445, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 1399, - "name": "createKeysPublicUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 250, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L250", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1400, - "name": "createKeysPublicUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generates a public URL for accessing the list of keys in the key-value store.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a cryptographic signature which allows access without authentication." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A public URL string for accessing the keys list" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Create a URL that expires in 1 hour\nconst url = await client.keyValueStore('my-store').createKeysPublicUrl({\n expiresInSecs: 3600,\n prefix: 'image-'\n});\nconsole.log(`Share this URL: ${url}`);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 250, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L250", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1401, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "URL generation options (extends all options from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "listKeys", - "target": 1393 - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "type": { - "type": "reference", - "target": 1507, - "name": "KeyValueClientCreateKeysUrlOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1391, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 100, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L100", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1392, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the key-value store." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-store-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 100, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L100", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1416, - "name": "deleteRecord", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 497, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L497", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1417, - "name": "deleteRecord", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a record from the key-value store." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-store-record-delete" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nawait client.keyValueStore('my-store').deleteRecord('temp-data');\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 497, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L497", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1418, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The record key to delete" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1386, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 75, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L75", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1387, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the key-value store object from the Apify API." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The KeyValueStore object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-store-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 75, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L75", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 1476, - "name": "KeyValueStore", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1405, - "name": "getRecord", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 326, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L326", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - }, - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 328, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L328", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - }, - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 333, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L333", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1406, - "name": "getRecord", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "You can use the " - }, - { - "kind": "code", - "text": "`buffer`" - }, - { - "kind": "text", - "text": " option to get the value in a Buffer (Node.js)\nor ArrayBuffer (browser) format. In Node.js (not in browser) you can also\nuse the " - }, - { - "kind": "code", - "text": "`stream`" - }, - { - "kind": "text", - "text": " option to get a Readable stream.\n\nWhen the record does not exist, the function resolves to " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": ". It does\nNOT resolve to a " - }, - { - "kind": "code", - "text": "`KeyValueStore`" - }, - { - "kind": "text", - "text": " record with an " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " value." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-store-record-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 326, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L326", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1407, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 1529, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/type-fest/source/basic.d.ts", - "qualifiedName": "JsonValue" - }, - "name": "JsonValue", - "package": "type-fest" - } - ], - "name": "KeyValueStoreRecord", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1408, - "name": "getRecord", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 328, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L328", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1409, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 1525, - "name": "KeyValueClientGetRecordOptions", - "package": "apify-client" - }, - "default": { - "type": "reference", - "target": 1525, - "name": "KeyValueClientGetRecordOptions", - "package": "apify-client" - } - } - ], - "parameters": [ - { - "id": 1410, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1411, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1409, - "name": "Options", - "package": "apify-client", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 1529, - "typeArguments": [ - { - "type": "reference", - "target": 1537, - "typeArguments": [ - { - "type": "reference", - "target": 1409, - "name": "Options", - "package": "apify-client", - "refersToTypeParameter": true - } - ], - "name": "ReturnTypeFromOptions", - "package": "apify-client" - } - ], - "name": "KeyValueStoreRecord", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1396, - "name": "getRecordPublicUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 213, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L213", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1397, - "name": "getRecordPublicUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generates a public URL for accessing a specific record in the key-value store.\n\nIf the client has permission to access the key-value store's URL signing key,\nthe URL will include a cryptographic signature for authenticated access without\nrequiring an API token." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A public URL string for accessing the record" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst url = await client.keyValueStore('my-store').getRecordPublicUrl('OUTPUT');\nconsole.log(`Public URL: ${url}`);\n// You can now share this URL or use it in a browser\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 213, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L213", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1398, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The record key" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1393, - "name": "listKeys", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 139, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L139", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1394, - "name": "listKeys", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all keys in the key-value store.\n\nReturns a paginated list of all record keys in the store. Use pagination parameters\nto retrieve large lists efficiently." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Object containing " - }, - { - "kind": "code", - "text": "`items`" - }, - { - "kind": "text", - "text": " array of key metadata, pagination info (" - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`limit`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`isTruncated`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`nextExclusiveStartKey`" - }, - { - "kind": "text", - "text": ")" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-store-keys-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// List all keys\nconst { items, isTruncated } = await client.keyValueStore('my-store').listKeys();\nitems.forEach(item => console.log(`${item.key}: ${item.size} bytes`));\n\n// List keys with prefix\nconst { items } = await client.keyValueStore('my-store').listKeys({ prefix: 'user-' });\n\n// Paginate through all keys\nlet exclusiveStartKey;\ndo {\n const result = await client.keyValueStore('my-store').listKeys({\n limit: 100,\n exclusiveStartKey\n });\n // Process result.items...\n exclusiveStartKey = result.nextExclusiveStartKey;\n} while (result.isTruncated);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 139, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L139", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1395, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listing options" - } - ] - }, - "type": { - "type": "reference", - "target": 1501, - "name": "KeyValueClientListKeysOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1514, - "name": "KeyValueClientListKeysResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es2018.asynciterable.d.ts", - "qualifiedName": "AsyncIterable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1521, - "name": "KeyValueListItem", - "package": "apify-client" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "AsyncIterable", - "package": "typescript" - } - ] - } - } - ] - }, - { - "id": 1402, - "name": "recordExists", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 299, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L299", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1403, - "name": "recordExists", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tests whether a record with the given key exists in the key-value store without retrieving its value.\n\nThis is more efficient than " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "getRecord", - "target": 1405 - }, - { - "kind": "text", - "text": " when you only need to check for existence." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the record exists, " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " if it does not" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-store-record-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst exists = await client.keyValueStore('my-store').recordExists('OUTPUT');\nif (exists) {\n console.log('OUTPUT record exists');\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 299, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L299", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1404, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The record key to check" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "boolean" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1412, - "name": "setRecord", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 433, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L433", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1413, - "name": "setRecord", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stores a record in the key-value store.\n\nThe record value can be any JSON-serializable object, a string, or a Buffer/Stream.\nThe content type is automatically determined based on the value type, but can be\noverridden using the " - }, - { - "kind": "code", - "text": "`contentType`" - }, - { - "kind": "text", - "text": " property.\n\n**Note about streams:** If the value is a stream object (has " - }, - { - "kind": "code", - "text": "`.pipe`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`.on`" - }, - { - "kind": "text", - "text": " methods),\nthe upload cannot be retried on failure or follow redirects. For reliable uploads,\nbuffer the entire stream into memory first." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-store-record-put" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Store JSON object\nawait client.keyValueStore('my-store').setRecord({\n key: 'OUTPUT',\n value: { crawledUrls: 100, items: [...] }\n});\n\n// Store text\nawait client.keyValueStore('my-store').setRecord({\n key: 'README',\n value: 'This is my readme text',\n contentType: 'text/plain'\n});\n\n// Store binary data\nconst imageBuffer = await fetchImageBuffer();\nawait client.keyValueStore('my-store').setRecord({\n key: 'screenshot.png',\n value: imageBuffer,\n contentType: 'image/png'\n});\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 433, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L433", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1414, - "name": "record", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The record to store" - } - ] - }, - "type": { - "type": "reference", - "target": 1529, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/type-fest/source/basic.d.ts", - "qualifiedName": "JsonValue" - }, - "name": "JsonValue", - "package": "type-fest" - } - ], - "name": "KeyValueStoreRecord", - "package": "apify-client" - } - }, - { - "id": 1415, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Storage options" - } - ] - }, - "type": { - "type": "reference", - "target": 1534, - "name": "KeyValueStoreRecordOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1388, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 89, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L89", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1389, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the key-value store with specified fields." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated KeyValueStore object" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-store-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 89, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L89", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1390, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to update in the key-value store" - } - ] - }, - "type": { - "type": "reference", - "target": 1497, - "name": "KeyValueClientUpdateOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1476, - "name": "KeyValueStore", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1446, - 1442, - 1447, - 1440, - 1448, - 1443, - 1444, - 1441, - 1445 - ] - }, - { - "title": "Methods", - "children": [ - 1399, - 1391, - 1416, - 1386, - 1405, - 1396, - 1393, - 1402, - 1412, - 1388 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 58, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L58", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 1539, - "name": "KeyValueStoreCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of Key-value stores in your account.\n\nKey-value stores are used to store arbitrary data records or files. This client provides\nmethods to list, create, or get key-value stores by name." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst storesClient = client.keyValueStores();\n\n// List all key-value stores\nconst { items } = await storesClient.list();\n\n// Get or create a key-value store by name\nconst store = await storesClient.getOrCreate('my-store');\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/storage/key-value-store" - } - ] - } - ] - }, - "children": [ - { - "id": 1578, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 1574, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 1579, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 1572, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 1580, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 1575, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 1576, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 1573, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 1577, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 1546, - "name": "getOrCreate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 86, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L86", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1547, - "name": "getOrCreate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets or creates a key-value store with the specified name." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The key-value store object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-stores-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 86, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L86", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1548, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the key-value store. If not provided, a default store is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1549, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options like schema." - } - ] - }, - "type": { - "type": "reference", - "target": 1615, - "name": "KeyValueStoreCollectionClientGetOrCreateOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1476, - "name": "KeyValueStore", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1543, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 61, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L61", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1544, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all Key-value stores.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of Key-value stores." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/key-value-stores-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 61, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L61", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1545, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination options." - } - ] - }, - "type": { - "type": "reference", - "target": 1608, - "name": "KeyValueStoreCollectionClientListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1617, - "name": "KeyValueStoreCollectionListResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es2018.asynciterable.d.ts", - "qualifiedName": "AsyncIterable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1476, - "name": "KeyValueStore", - "package": "apify-client" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "AsyncIterable", - "package": "typescript" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1578, - 1574, - 1579, - 1572, - 1580, - 1575, - 1576, - 1573, - 1577 - ] - }, - { - "title": "Methods", - "children": [ - 1546, - 1543 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 30, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 1620, - "name": "LogClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for accessing Actor run or build logs.\n\nProvides methods to retrieve logs as text or stream them in real-time. Logs can be accessed\nfor both running and finished Actor runs and builds." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst runClient = client.run('my-run-id');\n\n// Get the log content\nconst log = await runClient.log().get();\nconsole.log(log);\n\n// Stream the log in real-time\nconst stream = await runClient.log().stream();\nstream.on('line', (line) => console.log(line));\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/running/runs-and-builds#logging" - } - ] - } - ] - }, - "children": [ - { - "id": 1657, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 1653, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 1658, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 1651, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 1659, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 1654, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 1655, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 1652, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 1656, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 1624, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 56, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L56", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1625, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the log as a string." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The log content as a string, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/log-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 56, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L56", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1626, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log retrieval options." - } - ] - }, - "type": { - "type": "reference", - "target": 1687, - "name": "LogOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1627, - "name": "stream", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 81, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L81", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1628, - "name": "stream", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the log as a Readable stream. Only works in Node.js." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The log content as a Readable stream, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/log-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 81, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L81", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1629, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log retrieval options." - } - ] - }, - "type": { - "type": "reference", - "target": 1687, - "name": "LogOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/stream.d.ts", - "qualifiedName": "Stream.Readable" - }, - "name": "Readable", - "package": "@types/node", - "qualifiedName": "Stream.Readable" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1657, - 1653, - 1658, - 1651, - 1659, - 1654, - 1655, - 1652, - 1656 - ] - }, - { - "title": "Methods", - "children": [ - 1624, - 1627 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 37, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L37", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 1689, - "name": "LoggerActorRedirect", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Logger for redirected actor logs." - } - ] - }, - "children": [ - { - "id": 1734, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 114, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L114", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1735, - "name": "new LoggerActorRedirect", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 114, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L114", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1736, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1737, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 114, - "character": 26, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L114", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 1689, - "name": "LoggerActorRedirect", - "package": "apify-client" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Logger.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Logger.constructor" - } - }, - { - "id": 1732, - "name": "captureRejections", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Value: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type)\n\nChange the default " - }, - { - "kind": "code", - "text": "`captureRejections`" - }, - { - "kind": "text", - "text": " option on all new " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " objects." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v13.4.0, v12.16.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 425, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.captureRejections" - } - }, - { - "id": 1731, - "name": "captureRejectionSymbol", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isExternal": true, - "isReadonly": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Value: " - }, - { - "kind": "code", - "text": "`Symbol.for('nodejs.rejection')`" - }, - { - "kind": "text", - "text": "\n\nSee how to write a custom " - }, - { - "kind": "code", - "text": "`rejection handler`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v13.4.0, v12.16.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 418, - "character": 24, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1731, - "name": "captureRejectionSymbol", - "package": "@types/node", - "qualifiedName": "EventEmitter.captureRejectionSymbol" - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.captureRejectionSymbol" - } - }, - { - "id": 1733, - "name": "defaultMaxListeners", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default, a maximum of " - }, - { - "kind": "code", - "text": "`10`" - }, - { - "kind": "text", - "text": " listeners can be registered for any single\nevent. This limit can be changed for individual " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " instances\nusing the " - }, - { - "kind": "code", - "text": "`emitter.setMaxListeners(n)`" - }, - { - "kind": "text", - "text": " method. To change the default\nfor _all_" - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " instances, the " - }, - { - "kind": "code", - "text": "`events.defaultMaxListeners`" - }, - { - "kind": "text", - "text": " property\ncan be used. If this value is not a positive number, a " - }, - { - "kind": "code", - "text": "`RangeError`" - }, - { - "kind": "text", - "text": " is thrown.\n\nTake caution when setting the " - }, - { - "kind": "code", - "text": "`events.defaultMaxListeners`" - }, - { - "kind": "text", - "text": " because the\nchange affects _all_ " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " instances, including those created before\nthe change is made. However, calling " - }, - { - "kind": "code", - "text": "`emitter.setMaxListeners(n)`" - }, - { - "kind": "text", - "text": " still has\nprecedence over " - }, - { - "kind": "code", - "text": "`events.defaultMaxListeners`" - }, - { - "kind": "text", - "text": ".\n\nThis is not a hard limit. The " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " instance will allow\nmore listeners to be added but will output a trace warning to stderr indicating\nthat a \"possible EventEmitter memory leak\" has been detected. For any single\n" - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": ", the " - }, - { - "kind": "code", - "text": "`emitter.getMaxListeners()`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`emitter.setMaxListeners()`" - }, - { - "kind": "text", - "text": " methods can be used to\ntemporarily avoid this warning:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter } from 'node:events';\nconst emitter = new EventEmitter();\nemitter.setMaxListeners(emitter.getMaxListeners() + 1);\nemitter.once('event', () => {\n // do stuff\n emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));\n});\n```" - }, - { - "kind": "text", - "text": "\n\nThe " - }, - { - "kind": "code", - "text": "`--trace-warnings`" - }, - { - "kind": "text", - "text": " command-line flag can be used to display the\nstack trace for such warnings.\n\nThe emitted warning can be inspected with " - }, - { - "kind": "code", - "text": "`process.on('warning')`" - }, - { - "kind": "text", - "text": " and will\nhave the additional " - }, - { - "kind": "code", - "text": "`emitter`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`type`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`count`" - }, - { - "kind": "text", - "text": " properties, referring to\nthe event emitter instance, the event's name and the number of attached\nlisteners, respectively.\nIts " - }, - { - "kind": "code", - "text": "`name`" - }, - { - "kind": "text", - "text": " property is set to " - }, - { - "kind": "code", - "text": "`'MaxListenersExceededWarning'`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.11.2" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 464, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.defaultMaxListeners" - } - }, - { - "id": 1730, - "name": "errorMonitor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true, - "isExternal": true, - "isReadonly": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This symbol shall be used to install a listener for only monitoring " - }, - { - "kind": "code", - "text": "`'error'`" - }, - { - "kind": "text", - "text": " events. Listeners installed using this symbol are called before the regular " - }, - { - "kind": "code", - "text": "`'error'`" - }, - { - "kind": "text", - "text": " listeners are called.\n\nInstalling a listener using this symbol does not change the behavior once an " - }, - { - "kind": "code", - "text": "`'error'`" - }, - { - "kind": "text", - "text": " event is emitted. Therefore, the process will still crash if no\nregular " - }, - { - "kind": "code", - "text": "`'error'`" - }, - { - "kind": "text", - "text": " listener is installed." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v13.6.0, v12.17.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 411, - "character": 24, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "query", - "queryType": { - "type": "reference", - "target": 1730, - "name": "errorMonitor", - "package": "@types/node", - "qualifiedName": "EventEmitter.errorMonitor" - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.errorMonitor" - } - }, - { - "id": 1738, - "name": "_log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 118, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L118", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1739, - "name": "_log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 118, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L118", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1740, - "name": "level", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@apify/log" - } - }, - { - "id": 1741, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1742, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 1743, - "name": "exception", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1744, - "name": "opts", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Logger._log" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Logger._log" - } - }, - { - "id": 1751, - "name": "_outputWithConsole", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@apify/log/cjs/index.d.ts", - "line": 49, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1752, - "name": "_outputWithConsole", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@apify/log/cjs/index.d.ts", - "line": 49, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1753, - "name": "level", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@apify/log" - } - }, - { - "id": 1754, - "name": "line", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger._outputWithConsole" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger._outputWithConsole" - } - }, - { - "id": 1760, - "name": "[captureRejectionSymbol]", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 103, - "character": 8, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1761, - "name": "[captureRejectionSymbol]", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 103, - "character": 8, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1762, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1763, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - }, - { - "id": 1764, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1765, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "AnyRest" - }, - "name": "AnyRest", - "package": "@types/node" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.[captureRejectionSymbol]" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.[captureRejectionSymbol]" - } - }, - { - "id": 1766, - "name": "addListener", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 642, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1767, - "name": "addListener", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Alias for " - }, - { - "kind": "code", - "text": "`emitter.on(eventName, listener)`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.1.26" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 642, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1768, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1769, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1770, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1771, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1772, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1773, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.addListener" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.addListener" - } - }, - { - "id": 1822, - "name": "emit", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 904, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1823, - "name": "emit", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Synchronously calls each of the listeners registered for the event named " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ", in the order they were registered, passing the supplied arguments\nto each.\n\nReturns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": " if the event had listeners, " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": " otherwise.\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter } from 'node:events';\nconst myEmitter = new EventEmitter();\n\n// First listener\nmyEmitter.on('event', function firstListener() {\n console.log('Helloooo! first listener');\n});\n// Second listener\nmyEmitter.on('event', function secondListener(arg1, arg2) {\n console.log(`event with parameters ${arg1}, ${arg2} in second listener`);\n});\n// Third listener\nmyEmitter.on('event', function thirdListener(...args) {\n const parameters = args.join(', ');\n console.log(`event with parameters ${parameters} in third listener`);\n});\n\nconsole.log(myEmitter.listeners('event'));\n\nmyEmitter.emit('event', 1, 2, 3, 4, 5);\n\n// Prints:\n// [\n// [Function: firstListener],\n// [Function: secondListener],\n// [Function: thirdListener]\n// ]\n// Helloooo! first listener\n// event with parameters 1, 2 in second listener\n// event with parameters 1, 2, 3, 4, 5 in third listener\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.1.26" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 904, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1824, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1825, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1826, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "AnyRest" - }, - "name": "AnyRest", - "package": "@types/node" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.emit" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.emit" - } - }, - { - "id": 1848, - "name": "eventNames", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 967, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1849, - "name": "eventNames", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns an array listing the events for which the emitter has registered\nlisteners. The values in the array are strings or " - }, - { - "kind": "code", - "text": "`Symbol`" - }, - { - "kind": "text", - "text": "s.\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter } from 'node:events';\n\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => {});\nmyEE.on('bar', () => {});\n\nconst sym = Symbol('symbol');\nmyEE.on(sym, () => {});\n\nconsole.log(myEE.eventNames());\n// Prints: [ 'foo', 'bar', Symbol(symbol) ]\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v6.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 967, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.eventNames" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.eventNames" - } - }, - { - "id": 1812, - "name": "getMaxListeners", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 819, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1813, - "name": "getMaxListeners", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the current max listener value for the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " which is either\nset by " - }, - { - "kind": "code", - "text": "`emitter.setMaxListeners(n)`" - }, - { - "kind": "text", - "text": " or defaults to " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "EventEmitter.defaultMaxListeners", - "target": 1733 - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v1.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 819, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.getMaxListeners" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.getMaxListeners" - } - }, - { - "id": 1749, - "name": "getOptions", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@apify/log/cjs/index.d.ts", - "line": 48, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1750, - "name": "getOptions", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@apify/log/cjs/index.d.ts", - "line": 48, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.getOptions" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.getOptions" - } - }, - { - "id": 1827, - "name": "listenerCount", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 913, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1828, - "name": "listenerCount", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the number of listeners listening for the event named " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ".\nIf " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " is provided, it will return how many times the listener is found\nin the list of the listeners of the event." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v3.2.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 913, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1829, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1830, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event being listened for" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1831, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The event handler function" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.listenerCount" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.listenerCount" - } - }, - { - "id": 1814, - "name": "listeners", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 832, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1815, - "name": "listeners", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a copy of the array of listeners for the event named " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```js\nserver.on('connection', (stream) => {\n console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n// Prints: [ [Function] ]\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.1.26" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 832, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1816, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1817, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.listeners" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.listeners" - } - }, - { - "id": 1755, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@apify/log/cjs/index.d.ts", - "line": 51, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1756, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@apify/log/cjs/index.d.ts", - "line": 51, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1757, - "name": "level", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "LogLevel" - }, - "name": "LogLevel", - "package": "@apify/log" - } - }, - { - "id": 1758, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1759, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.log" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.log" - } - }, - { - "id": 1798, - "name": "off", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 792, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1799, - "name": "off", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Alias for " - }, - { - "kind": "code", - "text": "`emitter.removeListener()`" - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v10.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 792, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1800, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1801, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1802, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1803, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1804, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1805, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.off" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.off" - } - }, - { - "id": 1774, - "name": "on", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 674, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1775, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Adds the " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " function to the end of the listeners array for the event\nnamed " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ". No checks are made to see if the " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " has already\nbeen added. Multiple calls passing the same combination of " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": " and\n" - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " will result in the " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " being added, and called, multiple times.\n\n" - }, - { - "kind": "code", - "text": "```js\nserver.on('connection', (stream) => {\n console.log('someone connected!');\n});\n```" - }, - { - "kind": "text", - "text": "\n\nReturns a reference to the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": ", so that calls can be chained.\n\nBy default, event listeners are invoked in the order they are added. The " - }, - { - "kind": "code", - "text": "`emitter.prependListener()`" - }, - { - "kind": "text", - "text": " method can be used as an alternative to add the\nevent listener to the beginning of the listeners array.\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter } from 'node:events';\nconst myEE = new EventEmitter();\nmyEE.on('foo', () => console.log('a'));\nmyEE.prependListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.1.101" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 674, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1776, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1777, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1778, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback function" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1779, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1780, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1781, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.on" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.on" - } - }, - { - "id": 1782, - "name": "once", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 704, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1783, - "name": "once", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Adds a **one-time** " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " function for the event named " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ". The\nnext time " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": " is triggered, this listener is removed and then invoked.\n\n" - }, - { - "kind": "code", - "text": "```js\nserver.once('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n```" - }, - { - "kind": "text", - "text": "\n\nReturns a reference to the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": ", so that calls can be chained.\n\nBy default, event listeners are invoked in the order they are added. The " - }, - { - "kind": "code", - "text": "`emitter.prependOnceListener()`" - }, - { - "kind": "text", - "text": " method can be used as an alternative to add the\nevent listener to the beginning of the listeners array.\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter } from 'node:events';\nconst myEE = new EventEmitter();\nmyEE.once('foo', () => console.log('a'));\nmyEE.prependOnceListener('foo', () => console.log('b'));\nmyEE.emit('foo');\n// Prints:\n// b\n// a\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.3.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 704, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1784, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1785, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1786, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback function" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1787, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1788, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1789, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.once" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.once" - } - }, - { - "id": 1832, - "name": "prependListener", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 931, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1833, - "name": "prependListener", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Adds the " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " function to the _beginning_ of the listeners array for the\nevent named " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ". No checks are made to see if the " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " has\nalready been added. Multiple calls passing the same combination of " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": "\nand " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " will result in the " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " being added, and called, multiple times.\n\n" - }, - { - "kind": "code", - "text": "```js\nserver.prependListener('connection', (stream) => {\n console.log('someone connected!');\n});\n```" - }, - { - "kind": "text", - "text": "\n\nReturns a reference to the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": ", so that calls can be chained." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v6.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 931, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1834, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1835, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1836, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback function" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1837, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1838, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1839, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.prependListener" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.prependListener" - } - }, - { - "id": 1840, - "name": "prependOnceListener", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 947, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1841, - "name": "prependOnceListener", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Adds a **one-time**" - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " function for the event named " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": " to the _beginning_ of the listeners array. The next time " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": " is triggered, this\nlistener is removed, and then invoked.\n\n" - }, - { - "kind": "code", - "text": "```js\nserver.prependOnceListener('connection', (stream) => {\n console.log('Ah, we have our first user!');\n});\n```" - }, - { - "kind": "text", - "text": "\n\nReturns a reference to the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": ", so that calls can be chained." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v6.0.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 947, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1842, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1843, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the event." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1844, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The callback function" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1845, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1846, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1847, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.prependOnceListener" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.prependOnceListener" - } - }, - { - "id": 1818, - "name": "rawListeners", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 863, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1819, - "name": "rawListeners", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a copy of the array of listeners for the event named " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ",\nincluding any wrappers (such as those created by " - }, - { - "kind": "code", - "text": "`.once()`" - }, - { - "kind": "text", - "text": ").\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter } from 'node:events';\nconst emitter = new EventEmitter();\nemitter.once('log', () => console.log('log once'));\n\n// Returns a new Array with a function `onceWrapper` which has a property\n// `listener` which contains the original listener bound above\nconst listeners = emitter.rawListeners('log');\nconst logFnWrapper = listeners[0];\n\n// Logs \"log once\" to the console and does not unbind the `once` event\nlogFnWrapper.listener();\n\n// Logs \"log once\" to the console and removes the listener\nlogFnWrapper();\n\nemitter.on('log', () => console.log('log persistently'));\n// Will return a new Array with a single function bound by `.on()` above\nconst newListeners = emitter.rawListeners('log');\n\n// Logs \"log persistently\" twice\nnewListeners[0]();\nemitter.emit('log');\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v9.4.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 863, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1820, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1821, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.rawListeners" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.rawListeners" - } - }, - { - "id": 1806, - "name": "removeAllListeners", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 803, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1807, - "name": "removeAllListeners", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes all listeners, or those of the specified " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ".\n\nIt is bad practice to remove listeners added elsewhere in the code,\nparticularly when the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " instance was created by some other\ncomponent or module (e.g. sockets or file streams).\n\nReturns a reference to the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": ", so that calls can be chained." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.1.26" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 803, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1808, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.removeAllListeners" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.removeAllListeners" - } - }, - { - "id": 1790, - "name": "removeListener", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 787, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1791, - "name": "removeListener", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Removes the specified " - }, - { - "kind": "code", - "text": "`listener`" - }, - { - "kind": "text", - "text": " from the listener array for the event named " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```js\nconst callback = (stream) => {\n console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n```" - }, - { - "kind": "text", - "text": "\n\n" - }, - { - "kind": "code", - "text": "`removeListener()`" - }, - { - "kind": "text", - "text": " will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ", then " - }, - { - "kind": "code", - "text": "`removeListener()`" - }, - { - "kind": "text", - "text": " must be\ncalled multiple times to remove each instance.\n\nOnce an event is emitted, all listeners attached to it at the\ntime of emitting are called in order. This implies that any " - }, - { - "kind": "code", - "text": "`removeListener()`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`removeAllListeners()`" - }, - { - "kind": "text", - "text": " calls _after_ emitting and _before_ the last listener finishes execution\nwill not remove them from" - }, - { - "kind": "code", - "text": "`emit()`" - }, - { - "kind": "text", - "text": " in progress. Subsequent events behave as expected.\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter } from 'node:events';\nclass MyEmitter extends EventEmitter {}\nconst myEmitter = new MyEmitter();\n\nconst callbackA = () => {\n console.log('A');\n myEmitter.removeListener('event', callbackB);\n};\n\nconst callbackB = () => {\n console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n// Prints:\n// A\n// B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n// Prints:\n// A\n```" - }, - { - "kind": "text", - "text": "\n\nBecause listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered _after_ the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it means that any copies of the listener array as returned by\nthe " - }, - { - "kind": "code", - "text": "`emitter.listeners()`" - }, - { - "kind": "text", - "text": " method will need to be recreated.\n\nWhen a single function has been added as a handler multiple times for a single\nevent (as in the example below), " - }, - { - "kind": "code", - "text": "`removeListener()`" - }, - { - "kind": "text", - "text": " will remove the most\nrecently added instance. In the example the " - }, - { - "kind": "code", - "text": "`once('ping')`" - }, - { - "kind": "text", - "text": " listener is removed:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter } from 'node:events';\nconst ee = new EventEmitter();\n\nfunction pong() {\n console.log('pong');\n}\n\nee.on('ping', pong);\nee.once('ping', pong);\nee.removeListener('ping', pong);\n\nee.emit('ping');\nee.emit('ping');\n```" - }, - { - "kind": "text", - "text": "\n\nReturns a reference to the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": ", so that calls can be chained." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.1.26" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 787, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1792, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": { - "isExternal": true - } - } - ], - "parameters": [ - { - "id": 1793, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1794, - "name": "listener", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1795, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1796, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 84, - "character": 42, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1797, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.removeListener" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.removeListener" - } - }, - { - "id": 1809, - "name": "setMaxListeners", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 813, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1810, - "name": "setMaxListeners", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "By default " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": "s will print a warning if more than " - }, - { - "kind": "code", - "text": "`10`" - }, - { - "kind": "text", - "text": " listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. The " - }, - { - "kind": "code", - "text": "`emitter.setMaxListeners()`" - }, - { - "kind": "text", - "text": " method allows the limit to be\nmodified for this specific " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " instance. The value can be set to " - }, - { - "kind": "code", - "text": "`Infinity`" - }, - { - "kind": "text", - "text": " (or " - }, - { - "kind": "code", - "text": "`0`" - }, - { - "kind": "text", - "text": ") to indicate an unlimited number of listeners.\n\nReturns a reference to the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": ", so that calls can be chained." - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.3.5" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 813, - "character": 16, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1811, - "name": "n", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.setMaxListeners" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.setMaxListeners" - } - }, - { - "id": 1746, - "name": "setOptions", - "variant": "declaration", - "kind": 2048, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@apify/log/cjs/index.d.ts", - "line": 47, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1747, - "name": "setOptions", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@apify/log/cjs/index.d.ts", - "line": 47, - "character": 4, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1748, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.setOptions" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.setOptions" - } - }, - { - "id": 1723, - "name": "addAbortListener", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 403, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1724, - "name": "addAbortListener", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Listens once to the " - }, - { - "kind": "code", - "text": "`abort`" - }, - { - "kind": "text", - "text": " event on the provided " - }, - { - "kind": "code", - "text": "`signal`" - }, - { - "kind": "text", - "text": ".\n\nListening to the " - }, - { - "kind": "code", - "text": "`abort`" - }, - { - "kind": "text", - "text": " event on abort signals is unsafe and may\nlead to resource leaks since another third party with the signal can\ncall " - }, - { - "kind": "code", - "text": "`e.stopImmediatePropagation()`" - }, - { - "kind": "text", - "text": ". Unfortunately Node.js cannot change\nthis since it would violate the web standard. Additionally, the original\nAPI makes it easy to forget to remove listeners.\n\nThis API allows safely using " - }, - { - "kind": "code", - "text": "`AbortSignal`" - }, - { - "kind": "text", - "text": "s in Node.js APIs by solving these\ntwo issues by listening to the event such that " - }, - { - "kind": "code", - "text": "`stopImmediatePropagation`" - }, - { - "kind": "text", - "text": " does\nnot prevent the listener from running.\n\nReturns a disposable so that it may be unsubscribed from more easily.\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { addAbortListener } from 'node:events';\n\nfunction example(signal) {\n let disposable;\n try {\n signal.addEventListener('abort', (e) => e.stopImmediatePropagation());\n disposable = addAbortListener(signal, (e) => {\n // Do something when signal is aborted.\n });\n } finally {\n disposable?.[Symbol.dispose]();\n }\n}\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v20.5.0" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Disposable that removes the " - }, - { - "kind": "code", - "text": "`abort`" - }, - { - "kind": "text", - "text": " listener." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 403, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1725, - "name": "signal", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "AbortSignal" - }, - "name": "AbortSignal", - "package": "typescript" - } - }, - { - "id": 1726, - "name": "resource", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1727, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 403, - "character": 63, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1728, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 403, - "character": 63, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1729, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "Event" - }, - "name": "Event", - "package": "typescript" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.esnext.disposable.d.ts", - "qualifiedName": "Disposable" - }, - "name": "Disposable", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.addAbortListener" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.addAbortListener" - } - }, - { - "id": 1712, - "name": "getEventListeners", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 325, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1713, - "name": "getEventListeners", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a copy of the array of listeners for the event named " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": ".\n\nFor " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": "s this behaves exactly the same as calling " - }, - { - "kind": "code", - "text": "`.listeners`" - }, - { - "kind": "text", - "text": " on\nthe emitter.\n\nFor " - }, - { - "kind": "code", - "text": "`EventTarget`" - }, - { - "kind": "text", - "text": "s this is the only way to get the event listeners for the\nevent target. This is useful for debugging and diagnostic purposes.\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { getEventListeners, EventEmitter } from 'node:events';\n\n{\n const ee = new EventEmitter();\n const listener = () => console.log('Events are fun');\n ee.on('foo', listener);\n console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]\n}\n{\n const et = new EventTarget();\n const listener = () => console.log('Events are fun');\n et.addEventListener('foo', listener);\n console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]\n}\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v15.2.0, v14.17.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 325, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1714, - "name": "emitter", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "DefaultEventMap" - }, - "name": "DefaultEventMap", - "package": "@types/node" - } - ], - "name": "EventEmitter", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.EventEmitter" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventTarget" - }, - "name": "EventTarget", - "package": "typescript" - } - ] - } - }, - { - "id": 1715, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Function" - }, - "name": "Function", - "package": "typescript" - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.getEventListeners" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.getEventListeners" - } - }, - { - "id": 1716, - "name": "getMaxListeners", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 354, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1717, - "name": "getMaxListeners", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns the currently set max amount of listeners.\n\nFor " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": "s this behaves exactly the same as calling " - }, - { - "kind": "code", - "text": "`.getMaxListeners`" - }, - { - "kind": "text", - "text": " on\nthe emitter.\n\nFor " - }, - { - "kind": "code", - "text": "`EventTarget`" - }, - { - "kind": "text", - "text": "s this is the only way to get the max event listeners for the\nevent target. If the number of event handlers on a single EventTarget exceeds\nthe max set, the EventTarget will print a warning.\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';\n\n{\n const ee = new EventEmitter();\n console.log(getMaxListeners(ee)); // 10\n setMaxListeners(11, ee);\n console.log(getMaxListeners(ee)); // 11\n}\n{\n const et = new EventTarget();\n console.log(getMaxListeners(et)); // 10\n setMaxListeners(11, et);\n console.log(getMaxListeners(et)); // 11\n}\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v19.9.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 354, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1718, - "name": "emitter", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "DefaultEventMap" - }, - "name": "DefaultEventMap", - "package": "@types/node" - } - ], - "name": "EventEmitter", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.EventEmitter" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventTarget" - }, - "name": "EventTarget", - "package": "typescript" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.getMaxListeners" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.getMaxListeners" - } - }, - { - "id": 1708, - "name": "listenerCount", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 297, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1709, - "name": "listenerCount", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A class method that returns the number of listeners for the given " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": " registered on the given " - }, - { - "kind": "code", - "text": "`emitter`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter, listenerCount } from 'node:events';\n\nconst myEmitter = new EventEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(listenerCount(myEmitter, 'event'));\n// Prints: 2\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v0.9.12" - } - ] - }, - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Since v3.2.0 - Use " - }, - { - "kind": "code", - "text": "`listenerCount`" - }, - { - "kind": "text", - "text": " instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 297, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1710, - "name": "emitter", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The emitter to query" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "DefaultEventMap" - }, - "name": "DefaultEventMap", - "package": "@types/node" - } - ], - "name": "EventEmitter", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.EventEmitter" - } - }, - { - "id": 1711, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The event name" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.listenerCount" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.listenerCount" - } - }, - { - "id": 1699, - "name": "on", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 270, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - }, - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 275, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1700, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "code", - "text": "```js\nimport { on, EventEmitter } from 'node:events';\nimport process from 'node:process';\n\nconst ee = new EventEmitter();\n\n// Emit later on\nprocess.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n});\n\nfor await (const event of on(ee, 'foo')) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n}\n// Unreachable here\n```" - }, - { - "kind": "text", - "text": "\n\nReturns an " - }, - { - "kind": "code", - "text": "`AsyncIterator`" - }, - { - "kind": "text", - "text": " that iterates " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": " events. It will throw\nif the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " emits " - }, - { - "kind": "code", - "text": "`'error'`" - }, - { - "kind": "text", - "text": ". It removes all listeners when\nexiting the loop. The " - }, - { - "kind": "code", - "text": "`value`" - }, - { - "kind": "text", - "text": " returned by each iteration is an array\ncomposed of the emitted event arguments.\n\nAn " - }, - { - "kind": "code", - "text": "`AbortSignal`" - }, - { - "kind": "text", - "text": " can be used to cancel waiting on events:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { on, EventEmitter } from 'node:events';\nimport process from 'node:process';\n\nconst ac = new AbortController();\n\n(async () => {\n const ee = new EventEmitter();\n\n // Emit later on\n process.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n });\n\n for await (const event of on(ee, 'foo', { signal: ac.signal })) {\n // The execution of this inner block is synchronous and it\n // processes one event at a time (even with await). Do not use\n // if concurrent execution is required.\n console.log(event); // prints ['bar'] [42]\n }\n // Unreachable here\n})();\n\nprocess.nextTick(() => ac.abort());\n```" - }, - { - "kind": "text", - "text": "\n\nUse the " - }, - { - "kind": "code", - "text": "`close`" - }, - { - "kind": "text", - "text": " option to specify an array of event names that will end the iteration:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { on, EventEmitter } from 'node:events';\nimport process from 'node:process';\n\nconst ee = new EventEmitter();\n\n// Emit later on\nprocess.nextTick(() => {\n ee.emit('foo', 'bar');\n ee.emit('foo', 42);\n ee.emit('close');\n});\n\nfor await (const event of on(ee, 'foo', { close: ['close'] })) {\n console.log(event); // prints ['bar'] [42]\n}\n// the loop will exit after 'close' is emitted\nconsole.log('done'); // prints 'done'\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v13.6.0, v12.16.0" - } - ] - }, - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "An " - }, - { - "kind": "code", - "text": "`AsyncIterator`" - }, - { - "kind": "text", - "text": " that iterates " - }, - { - "kind": "code", - "text": "`eventName`" - }, - { - "kind": "text", - "text": " events emitted by the " - }, - { - "kind": "code", - "text": "`emitter`" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 270, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1701, - "name": "emitter", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "DefaultEventMap" - }, - "name": "DefaultEventMap", - "package": "@types/node" - } - ], - "name": "EventEmitter", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.EventEmitter" - } - }, - { - "id": 1702, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1703, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "StaticEventEmitterIteratorOptions" - }, - "name": "StaticEventEmitterIteratorOptions", - "package": "@types/node" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/compatibility/iterators.d.ts", - "qualifiedName": "NodeJS.AsyncIterator" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "AsyncIterator", - "package": "@types/node", - "qualifiedName": "NodeJS.AsyncIterator" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.on" - } - }, - { - "id": 1704, - "name": "on", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 275, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1705, - "name": "emitter", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventTarget" - }, - "name": "EventTarget", - "package": "typescript" - } - }, - { - "id": 1706, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1707, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "StaticEventEmitterIteratorOptions" - }, - "name": "StaticEventEmitterIteratorOptions", - "package": "@types/node" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/compatibility/iterators.d.ts", - "qualifiedName": "NodeJS.AsyncIterator" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "AsyncIterator", - "package": "@types/node", - "qualifiedName": "NodeJS.AsyncIterator" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.on" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.on" - } - }, - { - "id": 1690, - "name": "once", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 184, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - }, - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 189, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1691, - "name": "once", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a " - }, - { - "kind": "code", - "text": "`Promise`" - }, - { - "kind": "text", - "text": " that is fulfilled when the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " emits the given\nevent or that is rejected if the " - }, - { - "kind": "code", - "text": "`EventEmitter`" - }, - { - "kind": "text", - "text": " emits " - }, - { - "kind": "code", - "text": "`'error'`" - }, - { - "kind": "text", - "text": " while waiting.\nThe " - }, - { - "kind": "code", - "text": "`Promise`" - }, - { - "kind": "text", - "text": " will resolve with an array of all the arguments emitted to the\ngiven event.\n\nThis method is intentionally generic and works with the web platform [EventTarget](https://dom.spec.whatwg.org/#interface-eventtarget) interface, which has no special" - }, - { - "kind": "code", - "text": "`'error'`" - }, - { - "kind": "text", - "text": " event\nsemantics and does not listen to the " - }, - { - "kind": "code", - "text": "`'error'`" - }, - { - "kind": "text", - "text": " event.\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { once, EventEmitter } from 'node:events';\nimport process from 'node:process';\n\nconst ee = new EventEmitter();\n\nprocess.nextTick(() => {\n ee.emit('myevent', 42);\n});\n\nconst [value] = await once(ee, 'myevent');\nconsole.log(value);\n\nconst err = new Error('kaboom');\nprocess.nextTick(() => {\n ee.emit('error', err);\n});\n\ntry {\n await once(ee, 'myevent');\n} catch (err) {\n console.error('error happened', err);\n}\n```" - }, - { - "kind": "text", - "text": "\n\nThe special handling of the " - }, - { - "kind": "code", - "text": "`'error'`" - }, - { - "kind": "text", - "text": " event is only used when " - }, - { - "kind": "code", - "text": "`events.once()`" - }, - { - "kind": "text", - "text": " is used to wait for another event. If " - }, - { - "kind": "code", - "text": "`events.once()`" - }, - { - "kind": "text", - "text": " is used to wait for the\n'" - }, - { - "kind": "code", - "text": "`error'`" - }, - { - "kind": "text", - "text": " event itself, then it is treated as any other kind of event without\nspecial handling:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter, once } from 'node:events';\n\nconst ee = new EventEmitter();\n\nonce(ee, 'error')\n .then(([err]) => console.log('ok', err.message))\n .catch((err) => console.error('error', err.message));\n\nee.emit('error', new Error('boom'));\n\n// Prints: ok boom\n```" - }, - { - "kind": "text", - "text": "\n\nAn " - }, - { - "kind": "code", - "text": "`AbortSignal`" - }, - { - "kind": "text", - "text": " can be used to cancel waiting for the event:\n\n" - }, - { - "kind": "code", - "text": "```js\nimport { EventEmitter, once } from 'node:events';\n\nconst ee = new EventEmitter();\nconst ac = new AbortController();\n\nasync function foo(emitter, event, signal) {\n try {\n await once(emitter, event, { signal });\n console.log('event emitted!');\n } catch (error) {\n if (error.name === 'AbortError') {\n console.error('Waiting for the event was canceled!');\n } else {\n console.error('There was an error', error.message);\n }\n }\n}\n\nfoo(ee, 'foo', ac.signal);\nac.abort(); // Abort waiting for the event\nee.emit('foo'); // Prints: Waiting for the event was canceled!\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v11.13.0, v10.16.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 184, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1692, - "name": "emitter", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "DefaultEventMap" - }, - "name": "DefaultEventMap", - "package": "@types/node" - } - ], - "name": "EventEmitter", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.EventEmitter" - } - }, - { - "id": 1693, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 1694, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "StaticEventEmitterOptions" - }, - "name": "StaticEventEmitterOptions", - "package": "@types/node" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.once" - } - }, - { - "id": 1695, - "name": "once", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 189, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1696, - "name": "emitter", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventTarget" - }, - "name": "EventTarget", - "package": "typescript" - } - }, - { - "id": 1697, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1698, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "StaticEventEmitterOptions" - }, - "name": "StaticEventEmitterOptions", - "package": "@types/node" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.once" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.once" - } - }, - { - "id": 1719, - "name": "setMaxListeners", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true, - "isExternal": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 369, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1720, - "name": "setMaxListeners", - "variant": "signature", - "kind": 4096, - "flags": { - "isExternal": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "code", - "text": "```js\nimport { setMaxListeners, EventEmitter } from 'node:events';\n\nconst target = new EventTarget();\nconst emitter = new EventEmitter();\n\nsetMaxListeners(5, target, emitter);\n```" - } - ], - "blockTags": [ - { - "tag": "@since", - "content": [ - { - "kind": "text", - "text": "v15.4.0" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "node_modules/@types/node/events.d.ts", - "line": 369, - "character": 15, - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1721, - "name": "n", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A non-negative number. The maximum number of listeners per " - }, - { - "kind": "code", - "text": "`EventTarget`" - }, - { - "kind": "text", - "text": " event." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1722, - "name": "eventTargets", - "variant": "param", - "kind": 32768, - "flags": { - "isExternal": true, - "isRest": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, " - }, - { - "kind": "code", - "text": "`n`" - }, - { - "kind": "text", - "text": " is set as the default max for all newly created {EventTarget} and {EventEmitter}\nobjects." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "DefaultEventMap" - }, - "name": "DefaultEventMap", - "package": "@types/node" - } - ], - "name": "EventEmitter", - "package": "@types/node", - "qualifiedName": "__global.NodeJS.EventEmitter" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.dom.d.ts", - "qualifiedName": "EventTarget" - }, - "name": "EventTarget", - "package": "typescript" - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.setMaxListeners" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Logger.setMaxListeners" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1734 - ] - }, - { - "title": "Properties", - "children": [ - 1732, - 1731, - 1733, - 1730 - ] - }, - { - "title": "Methods", - "children": [ - 1738, - 1751, - 1760, - 1766, - 1822, - 1848, - 1812, - 1749, - 1827, - 1814, - 1755, - 1798, - 1774, - 1782, - 1832, - 1840, - 1818, - 1806, - 1790, - 1809, - 1746, - 1723, - 1712, - 1716, - 1708, - 1699, - 1690, - 1719 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 113, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L113", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Logger" - }, - "name": "Logger", - "package": "@apify/log" - } - ] - }, - { - "id": 1876, - "name": "RequestQueueClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific Request queue.\n\nRequest queues store URLs to be crawled and their metadata. Each request in the queue has a unique ID\nand can be in various states (pending, handled). This client provides methods to add, get, update,\nand delete requests, as well as manage the queue itself." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst queueClient = client.requestQueue('my-queue-id');\n\n// Add a request to the queue\nawait queueClient.addRequest({\n url: 'https://example.com',\n uniqueKey: 'example-com'\n});\n\n// Get the next request from the queue\nconst request = await queueClient.listHead();\n\n// Mark request as handled\nawait queueClient.updateRequest({\n id: request.id,\n handledAt: new Date().toISOString()\n});\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/storage/request-queue" - } - ] - } - ] - }, - "children": [ - { - "id": 1968, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 1964, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 1969, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 1962, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 1970, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 1965, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 1966, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 1963, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 1967, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 1896, - "name": "addRequest", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 234, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L234", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1897, - "name": "addRequest", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Adds a single request to the queue.\n\nIf a request with the same " - }, - { - "kind": "code", - "text": "`uniqueKey`" - }, - { - "kind": "text", - "text": " already exists, the method will return information\nabout the existing request without adding a duplicate. The " - }, - { - "kind": "code", - "text": "`uniqueKey`" - }, - { - "kind": "text", - "text": " is used for\ndeduplication - typically it's the URL, but you can use any string to identify the request." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Object with " - }, - { - "kind": "code", - "text": "`requestId`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`wasAlreadyPresent`" - }, - { - "kind": "text", - "text": ", and " - }, - { - "kind": "code", - "text": "`wasAlreadyHandled`" - }, - { - "kind": "text", - "text": " flags" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-requests-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst result = await client.requestQueue('my-queue').addRequest({\n url: 'https://example.com',\n uniqueKey: 'example-page',\n method: 'GET',\n userData: { label: 'START', depth: 0 }\n});\nconsole.log(`Request ID: ${result.requestId}`);\nconsole.log(`Already present: ${result.wasAlreadyPresent}`);\nconsole.log(`Already handled: ${result.wasAlreadyHandled}`);\n\n// Add urgent request to the front of the queue\nawait client.requestQueue('my-queue').addRequest(\n { url: 'https://priority.com', uniqueKey: 'priority-page' },\n { forefront: true }\n);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 234, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L234", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1898, - "name": "request", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The request object to add (excluding " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": ", which is assigned by the API)" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2086, - "name": "RequestQueueClientRequestSchema", - "package": "apify-client" - }, - { - "type": "literal", - "value": "id" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 1899, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional options" - } - ] - }, - "type": { - "type": "reference", - "target": 2072, - "name": "RequestQueueClientAddRequestOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2099, - "name": "RequestQueueClientAddRequestResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1908, - "name": "batchAddRequests", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 411, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L411", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1909, - "name": "batchAddRequests", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Adds multiple requests to the queue in a single operation.\n\nThis is significantly more efficient than calling " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "addRequest", - "target": 1896 - }, - { - "kind": "text", - "text": " multiple times, especially\nfor large batches. The method automatically handles batching (max 25 requests per API call),\nretries on rate limiting, and parallel processing. Requests are sent in chunks respecting the\nAPI payload size limit, and any unprocessed requests due to rate limits are automatically\nretried with exponential backoff." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Object with " - }, - { - "kind": "code", - "text": "`processedRequests`" - }, - { - "kind": "text", - "text": " (successfully added) and " - }, - { - "kind": "code", - "text": "`unprocessedRequests`" - }, - { - "kind": "text", - "text": " (failed after all retries)" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-requests-batch-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Add a batch of URLs to crawl\nconst requests = [\n { url: 'https://example.com', uniqueKey: 'page1', userData: { depth: 1 } },\n { url: 'https://example.com/2', uniqueKey: 'page2', userData: { depth: 1 } },\n { url: 'https://example.com/3', uniqueKey: 'page3', userData: { depth: 1 } }\n];\nconst result = await client.requestQueue('my-queue').batchAddRequests(requests);\nconsole.log(`Successfully added: ${result.processedRequests.length}`);\nconsole.log(`Failed: ${result.unprocessedRequests.length}`);\n\n// Batch add with custom retry settings\nconst result = await client.requestQueue('my-queue').batchAddRequests(\n requests,\n { maxUnprocessedRequestsRetries: 5, maxParallel: 10 }\n);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 411, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L411", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1910, - "name": "requests", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of request objects to add (excluding " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " fields)" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2086, - "name": "RequestQueueClientRequestSchema", - "package": "apify-client" - }, - { - "type": "literal", - "value": "id" - } - ], - "name": "Omit", - "package": "typescript" - } - } - }, - { - "id": 1911, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Batch operation configuration" - } - ] - }, - "type": { - "type": "reference", - "target": 2081, - "name": "RequestQueueClientBatchAddRequestWithRetriesOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2105, - "name": "RequestQueueClientBatchRequestsOperationResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1912, - "name": "batchDeleteRequests", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 481, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L481", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1913, - "name": "batchDeleteRequests", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes multiple requests from the queue in a single operation.\n\nRequests can be identified by either their ID or unique key." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Result containing processed and unprocessed requests" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-requests-batch-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 481, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L481", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1914, - "name": "requests", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of requests to delete (by id or uniqueKey)" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2108, - "name": "RequestQueueClientRequestToDelete", - "package": "apify-client" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2105, - "name": "RequestQueueClientBatchRequestsOperationResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1888, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 104, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1889, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the Request queue." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 104, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1922, - "name": "deleteRequest", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 577, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L577", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1923, - "name": "deleteRequest", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes a specific request from the queue." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 577, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L577", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1924, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1929, - "name": "deleteRequestLock", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 651, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L651", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1930, - "name": "deleteRequestLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Releases the lock on a request, allowing other clients to process it.\n\nThis should be called after successfully processing a request or when you decide\nnot to process it." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-request-lock-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 651, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L651", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1931, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1932, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options such as whether to move to front" - } - ] - }, - "type": { - "type": "reference", - "target": 2077, - "name": "RequestQueueClientDeleteRequestLockOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1883, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 82, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L82", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1884, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the Request queue object from the Apify API." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The RequestQueue object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 82, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L82", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 2001, - "name": "RequestQueue", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1915, - "name": "getRequest", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 514, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L514", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1916, - "name": "getRequest", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets a specific request from the queue by its ID." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The request object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if not found" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-request-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 514, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L514", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1917, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 2109, - "name": "RequestQueueClientGetRequestResult", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1893, - "name": "listAndLockHead", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 171, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L171", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1894, - "name": "listAndLockHead", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets and locks the next requests from the queue head for processing.\n\nThis method retrieves requests from the beginning of the queue and locks them for\nthe specified duration to prevent other clients from processing them simultaneously.\nThis is the primary method used by distributed web crawlers to coordinate work across\nmultiple workers. Locked requests won't be returned to other clients until the lock expires\nor is explicitly released using " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "deleteRequestLock", - "target": 1929 - }, - { - "kind": "text", - "text": "." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Object containing " - }, - { - "kind": "code", - "text": "`items`" - }, - { - "kind": "text", - "text": " (locked requests), " - }, - { - "kind": "code", - "text": "`queueModifiedAt`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`hadMultipleClients`" - }, - { - "kind": "text", - "text": ", and lock information" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-head-lock-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Get and lock up to 10 requests for 60 seconds\nconst { items, lockSecs } = await client.requestQueue('my-queue').listAndLockHead({\n lockSecs: 60,\n limit: 10\n});\n\n// Process each locked request\nfor (const request of items) {\n console.log(`Processing: ${request.url}`);\n // ... process request ...\n // Delete lock after successful processing\n await client.requestQueue('my-queue').deleteRequestLock(request.id);\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 171, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L171", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1895, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lock configuration" - } - ] - }, - "type": { - "type": "reference", - "target": 2054, - "name": "RequestQueueClientListAndLockHeadOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2057, - "name": "RequestQueueClientListAndLockHeadResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1890, - "name": "listHead", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 118, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L118", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1891, - "name": "listHead", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists requests from the beginning of the queue (head).\n\nReturns the first N requests from the queue without locking them. This is useful for\ninspecting what requests are waiting to be processed." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "List of requests from the queue head" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-head-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 118, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L118", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1892, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing (e.g., limit)" - } - ] - }, - "type": { - "type": "reference", - "target": 2029, - "name": "RequestQueueClientListHeadOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2031, - "name": "RequestQueueClientListHeadResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1933, - "name": "listRequests", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 681, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L681", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1934, - "name": "listRequests", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all requests in the queue.\n\nReturns a paginated list of all requests, allowing you to iterate through the entire\nqueue contents." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "List of requests with pagination information" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-requests-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 681, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L681", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1935, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination options" - } - ] - }, - "type": { - "type": "reference", - "target": 2037, - "name": "RequestQueueClientListRequestsOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2048, - "name": "RequestQueueClientListRequestsResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es2018.asynciterable.d.ts", - "qualifiedName": "AsyncIterable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2086, - "name": "RequestQueueClientRequestSchema", - "package": "apify-client" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "AsyncIterable", - "package": "typescript" - } - ] - } - } - ] - }, - { - "id": 1938, - "name": "paginateRequests", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 786, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L786", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1939, - "name": "paginateRequests", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns an async iterable for paginating through all requests in the queue.\n\nThis allows you to efficiently process all requests using a for-await-of loop,\nautomatically handling pagination behind the scenes." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "An async iterable of request pages" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-requests-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nfor await (const { items } of client.requestQueue('my-queue').paginateRequests({ limit: 100 })) {\n items.forEach((request) => console.log(request.url));\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 786, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L786", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1940, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination options" - } - ] - }, - "type": { - "type": "reference", - "target": 2042, - "name": "RequestQueueClientPaginateRequestsOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 2111, - "typeArguments": [ - { - "type": "reference", - "target": 2048, - "name": "RequestQueueClientListRequestsResult", - "package": "apify-client" - } - ], - "name": "RequestQueueRequestsAsyncIterable", - "package": "apify-client" - } - } - ] - }, - { - "id": 1925, - "name": "prolongRequestLock", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 614, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L614", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1926, - "name": "prolongRequestLock", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prolongs the lock on a request to prevent it from being returned to other clients.\n\nThis is useful when processing a request takes longer than expected and you need\nto extend the lock duration to prevent other workers from picking it up. The lock\nexpiration time is reset to the current time plus the specified duration." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Object with new " - }, - { - "kind": "code", - "text": "`lockExpiresAt`" - }, - { - "kind": "text", - "text": " timestamp" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-request-lock-put" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Lock request for initial processing\nconst { items } = await client.requestQueue('my-queue').listAndLockHead({ lockSecs: 60, limit: 1 });\nconst request = items[0];\n\n// Processing takes longer than expected, extend the lock\nawait client.requestQueue('my-queue').prolongRequestLock(request.id, { lockSecs: 120 });\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 614, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L614", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1927, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request ID (obtained from " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "listAndLockHead", - "target": 1893 - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "getRequest", - "target": 1915 - }, - { - "kind": "text", - "text": ")" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1928, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lock extension options" - } - ] - }, - "type": { - "type": "reference", - "target": 2074, - "name": "RequestQueueClientProlongRequestLockOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2079, - "name": "RequestQueueClientProlongRequestLockResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1936, - "name": "unlockRequests", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 756, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L756", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1937, - "name": "unlockRequests", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unlocks all requests locked by this client.\n\nThis is useful for releasing all locks at once, for example when shutting down\na crawler gracefully." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Number of requests that were unlocked" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-requests-unlock-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 756, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L756", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2103, - "name": "RequestQueueClientUnlockRequestsResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1885, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 93, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L93", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1886, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the Request queue with specified fields." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated RequestQueue object" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 93, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L93", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1887, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to update in the Request queue" - } - ] - }, - "type": { - "type": "reference", - "target": 2025, - "name": "RequestQueueClientUpdateOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2001, - "name": "RequestQueue", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1918, - "name": "updateRequest", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 540, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L540", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1919, - "name": "updateRequest", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates a request in the queue." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Information about the updated request" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queue-request-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 540, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L540", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1920, - "name": "request", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The updated request object (must include id)" - } - ] - }, - "type": { - "type": "reference", - "target": 2086, - "name": "RequestQueueClientRequestSchema", - "package": "apify-client" - } - }, - { - "id": 1921, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Update options such as whether to move to front" - } - ] - }, - "type": { - "type": "reference", - "target": 2072, - "name": "RequestQueueClientAddRequestOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2099, - "name": "RequestQueueClientAddRequestResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1968, - 1964, - 1969, - 1962, - 1970, - 1965, - 1966, - 1963, - 1967 - ] - }, - { - "title": "Methods", - "children": [ - 1896, - 1908, - 1912, - 1888, - 1922, - 1929, - 1883, - 1915, - 1893, - 1890, - 1933, - 1938, - 1925, - 1936, - 1885, - 1918 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 58, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L58", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 2113, - "name": "RequestQueueCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of Request queues in your account.\n\nRequest queues store URLs to be crawled and their metadata. This client provides methods\nto list, create, or get request queues by name." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst queuesClient = client.requestQueues();\n\n// List all request queues\nconst { items } = await queuesClient.list();\n\n// Get or create a request queue by name\nconst queue = await queuesClient.getOrCreate('my-queue');\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/storage/request-queue" - } - ] - } - ] - }, - "children": [ - { - "id": 2151, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 2147, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 2152, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 2145, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 2153, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 2148, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 2149, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 2146, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 2150, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 2120, - "name": "getOrCreate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 85, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L85", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2121, - "name": "getOrCreate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets or creates a Request queue with the specified name." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Request queue object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queues-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 85, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L85", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2122, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the Request queue. If not provided, a default queue is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2001, - "name": "RequestQueue", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2117, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 61, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L61", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2118, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all Request queues.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of Request queues." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/request-queues-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 61, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L61", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2119, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination options." - } - ] - }, - "type": { - "type": "reference", - "target": 2181, - "name": "RequestQueueCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2188, - "name": "RequestQueueCollectionListResult", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es2018.asynciterable.d.ts", - "qualifiedName": "AsyncIterable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2001, - "name": "RequestQueue", - "package": "apify-client" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "AsyncIterable", - "package": "typescript" - } - ] - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2151, - 2147, - 2152, - 2145, - 2153, - 2148, - 2149, - 2146, - 2150 - ] - }, - { - "title": "Methods", - "children": [ - 2120, - 2117 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 30, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 2191, - "name": "RunClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific Actor run.\n\nProvides methods to get run details, abort, metamorph, resurrect, wait for completion,\nand access the run's dataset, key-value store, request queue, and logs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst runClient = client.run('my-run-id');\n\n// Get run details\nconst run = await runClient.get();\n\n// Wait for the run to finish\nconst finishedRun = await runClient.waitForFinish();\n\n// Access the run's dataset\nconst { items } = await runClient.dataset().listItems();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/running/runs-and-builds" - } - ] - } - ] - }, - "children": [ - { - "id": 2260, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 2256, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 2261, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 2254, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 2262, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 2257, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 2258, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 2255, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 2259, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 2198, - "name": "abort", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 99, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L99", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2199, - "name": "abort", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aborts the Actor run." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated ActorRun object with " - }, - { - "kind": "code", - "text": "`ABORTING`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`ABORTED`" - }, - { - "kind": "text", - "text": " status" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-abort-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Abort immediately\nawait client.run('run-id').abort();\n\n// Abort gracefully (allows cleanup)\nawait client.run('run-id').abort({ gracefully: true });\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 99, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L99", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2200, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Abort options" - } - ] - }, - "type": { - "type": "reference", - "target": 2295, - "name": "RunAbortOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2216, - "name": "charge", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 293, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L293", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2217, - "name": "charge", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Charges the Actor run for a specific event." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Empty response object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/post-charge-run" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 293, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L293", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2218, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Charge options including event name and count." - } - ] - }, - "type": { - "type": "reference", - "target": 2311, - "name": "RunChargeOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "ApifyResponse" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "never" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "ApifyResponse", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2222, - "name": "dataset", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 375, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L375", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2223, - "name": "dataset", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the default dataset of this Actor run." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for accessing the run's default dataset" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Access run's dataset\nconst { items } = await client.run('run-id').dataset().listItems();\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 375, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L375", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1121, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "DatasetClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 2201, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 121, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L121", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2202, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the Actor run." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 121, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L121", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2195, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 71, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L71", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2196, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gets the Actor run object from the Apify API." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The ActorRun object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Get run status immediately\nconst run = await client.run('run-id').get();\nconsole.log(`Status: ${run.status}`);\n\n// Wait up to 60 seconds for run to finish\nconst run = await client.run('run-id').get({ waitForFinish: 60 });\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 71, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L71", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2197, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get options" - } - ] - }, - "type": { - "type": "reference", - "target": 2293, - "name": "RunGetOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2230, - "name": "getStreamedLog", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 447, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L447", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2231, - "name": "getStreamedLog", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Get StreamedLog for convenient streaming of the run log and their redirection." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 447, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L447", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2232, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2290, - "name": "GetStreamedLogOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 1850, - "name": "StreamedLog", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2224, - "name": "keyValueStore", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 395, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L395", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2225, - "name": "keyValueStore", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the default key-value store of this Actor run." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for accessing the run's default key-value store" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Access run's key-value store\nconst output = await client.run('run-id').keyValueStore().getRecord('OUTPUT');\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 395, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L395", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1382, - "name": "KeyValueStoreClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 2228, - "name": "log", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 436, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L436", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2229, - "name": "log", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for accessing the log of this Actor run." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for accessing the run's log" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Get run log\nconst log = await client.run('run-id').log().get();\nconsole.log(log);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 436, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L436", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1620, - "name": "LogClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 2203, - "name": "metamorph", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 150, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L150", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2204, - "name": "metamorph", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Transforms the Actor run into a run of another Actor (metamorph).\n\nThis operation preserves the run ID, storages (dataset, key-value store, request queue),\nand resource allocation. The run effectively becomes a run of the target Actor with new input.\nThis is useful for chaining Actor executions or implementing complex workflows." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The metamorphed ActorRun object (same ID, but now running the target Actor)" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-metamorph-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Transform current run into another Actor\nconst metamorphedRun = await client.run('original-run-id').metamorph(\n 'target-actor-id',\n { url: 'https://example.com' }\n);\nconsole.log(`Run ${metamorphedRun.id} is now running ${metamorphedRun.actId}`);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 150, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L150", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2205, - "name": "targetActorId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID or username/name of the target Actor" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2206, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input for the target Actor. Can be any JSON-serializable value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 2207, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metamorph options" - } - ] - }, - "type": { - "type": "reference", - "target": 2297, - "name": "RunMetamorphOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2208, - "name": "reboot", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 205, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L205", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2209, - "name": "reboot", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reboots the Actor run.\n\nRebooting restarts the Actor's Docker container while preserving the run ID and storages.\nThis can be useful to recover from certain errors or to force the Actor to restart\nwith a fresh environment." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated ActorRun object" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-reboot-post" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst run = await client.run('run-id').reboot();\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 205, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L205", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2226, - "name": "requestQueue", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 415, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L415", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2227, - "name": "requestQueue", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the default Request queue of this Actor run." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for accessing the run's default Request queue" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-run-get" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Access run's Request queue\nconst { items } = await client.run('run-id').requestQueue().listHead();\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 415, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L415", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1876, - "name": "RequestQueueClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 2213, - "name": "resurrect", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 261, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2214, - "name": "resurrect", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resurrects a finished Actor run, starting it again with the same settings.\n\nThis creates a new run with the same configuration as the original run. The original\nrun's storages (dataset, key-value store, request queue) are preserved and reused." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The new (resurrected) ActorRun object" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/post-resurrect-run" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Resurrect a failed run with more memory\nconst newRun = await client.run('failed-run-id').resurrect({ memory: 2048 });\nconsole.log(`New run started: ${newRun.id}`);\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 261, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2215, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resurrection options (override original run settings)" - } - ] - }, - "type": { - "type": "reference", - "target": 2304, - "name": "RunResurrectOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2210, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 232, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L232", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2211, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the Actor run with specified fields." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated ActorRun object" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Set a status message\nawait client.run('run-id').update({\n statusMessage: 'Processing items: 50/100'\n});\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 232, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L232", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2212, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to update" - } - ] - }, - "type": { - "type": "reference", - "target": 2300, - "name": "RunUpdateOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2219, - "name": "waitForFinish", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 352, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L352", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2220, - "name": "waitForFinish", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Waits for the Actor run to finish and returns the finished Run object.\n\nThe promise resolves when the run reaches a terminal state (" - }, - { - "kind": "code", - "text": "`SUCCEEDED`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`FAILED`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`ABORTED`" - }, - { - "kind": "text", - "text": ", or " - }, - { - "kind": "code", - "text": "`TIMED-OUT`" - }, - { - "kind": "text", - "text": ").\nIf " - }, - { - "kind": "code", - "text": "`waitSecs`" - }, - { - "kind": "text", - "text": " is provided and the timeout is reached, the promise resolves with the unfinished\nRun object (status will be " - }, - { - "kind": "code", - "text": "`RUNNING`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`READY`" - }, - { - "kind": "text", - "text": "). The promise is NOT rejected based on run status.\n\nUnlike the " - }, - { - "kind": "code", - "text": "`waitForFinish`" - }, - { - "kind": "text", - "text": " parameter in " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "get", - "target": 2195 - }, - { - "kind": "text", - "text": ", this method can wait indefinitely\nby polling the run status. It uses the " - }, - { - "kind": "code", - "text": "`waitForFinish`" - }, - { - "kind": "text", - "text": " parameter internally (max 60s per call)\nand continuously polls until the run finishes or the timeout is reached." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The ActorRun object (finished or still running if timeout was reached)" - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\n// Wait indefinitely for run to finish\nconst run = await client.run('run-id').waitForFinish();\nconsole.log(`Run finished with status: ${run.status}`);\n\n// Wait up to 5 minutes\nconst run = await client.run('run-id').waitForFinish({ waitSecs: 300 });\nif (run.status === 'SUCCEEDED') {\n console.log('Run succeeded!');\n}\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 352, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L352", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2221, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wait options" - } - ] - }, - "type": { - "type": "reference", - "target": 2315, - "name": "RunWaitForFinishOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2260, - 2256, - 2261, - 2254, - 2262, - 2257, - 2258, - 2255, - 2259 - ] - }, - { - "title": "Methods", - "children": [ - 2198, - 2216, - 2222, - 2201, - 2195, - 2230, - 2224, - 2228, - 2203, - 2208, - 2226, - 2213, - 2210, - 2219 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 42, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L42", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 2317, - "name": "RunCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of Actor runs.\n\nProvides methods to list Actor runs across all Actors or for a specific Actor.\nTo access an individual run, use the " - }, - { - "kind": "code", - "text": "`run()`" - }, - { - "kind": "text", - "text": " method on the main ApifyClient." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\n\n// List all runs\nconst runsClient = client.runs();\nconst { items } = await runsClient.list();\n\n// List runs for a specific Actor\nconst actorRunsClient = client.actor('my-actor-id').runs();\nconst { items: actorRuns } = await actorRunsClient.list();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/running/runs-and-builds" - } - ] - } - ] - }, - "children": [ - { - "id": 2352, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 2348, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 2353, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 2346, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 2354, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 2349, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 2350, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 2347, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 2351, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 2321, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/run_collection.ts", - "line": 62, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run_collection.ts#L62", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2322, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all Actor runs.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of Actor runs." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-runs-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run_collection.ts", - "line": 62, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run_collection.ts#L62", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2323, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination and filtering options." - } - ] - }, - "type": { - "type": "reference", - "target": 2382, - "name": "RunCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedIterator" - }, - "typeArguments": [ - { - "type": "reference", - "target": 305, - "name": "ActorRunListItem", - "package": "apify-client" - } - ], - "name": "PaginatedIterator", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2352, - 2348, - 2353, - 2346, - 2354, - 2349, - 2350, - 2347, - 2351 - ] - }, - { - "title": "Methods", - "children": [ - 2321 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run_collection.ts", - "line": 31, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run_collection.ts#L31", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 2390, - "name": "ScheduleClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific Schedule.\n\nSchedules are used to automatically start Actors or tasks at specified times. This client provides\nmethods to get, update, and delete schedules, as well as retrieve schedule logs." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst scheduleClient = client.schedule('my-schedule-id');\n\n// Get schedule details\nconst schedule = await scheduleClient.get();\n\n// Update schedule\nawait scheduleClient.update({\n cronExpression: '0 12 * * *',\n isEnabled: true\n});\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/schedules" - } - ] - } - ] - }, - "children": [ - { - "id": 2432, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 2428, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 2433, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 2426, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 2434, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 2429, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 2430, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 2427, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 2431, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 2401, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 72, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L72", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2402, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the schedule." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/schedule-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 72, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L72", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2394, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 51, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L51", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2395, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the schedule." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The schedule object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/schedule-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 51, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L51", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 2462, - "name": "Schedule", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2403, - "name": "getLog", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 82, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L82", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2404, - "name": "getLog", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the schedule's log." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The schedule log as a string, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/schedule-log-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 82, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L82", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2396, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 62, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L62", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2397, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the schedule with the specified fields." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated schedule object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/schedule-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 62, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L62", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2398, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to update." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2462, - "name": "Schedule", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "description" - }, - { - "type": "literal", - "value": "title" - }, - { - "type": "literal", - "value": "cronExpression" - }, - { - "type": "literal", - "value": "timezone" - }, - { - "type": "literal", - "value": "isEnabled" - }, - { - "type": "literal", - "value": "isExclusive" - }, - { - "type": "literal", - "value": "notifications" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 2399, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2400, - "name": "actions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 132, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L132", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "DistributiveOptional" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2486, - "name": "ScheduleAction", - "package": "apify-client" - }, - { - "type": "literal", - "value": "id" - } - ], - "name": "DistributiveOptional", - "package": "apify-client" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2400 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 131, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L131", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2462, - "name": "Schedule", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2432, - 2428, - 2433, - 2426, - 2434, - 2429, - 2430, - 2427, - 2431 - ] - }, - { - "title": "Methods", - "children": [ - 2401, - 2394, - 2403, - 2396 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 34, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 2506, - "name": "ScheduleCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of Schedules in your account.\n\nSchedules are used to automatically start Actors or tasks at specified times.\nThis client provides methods to list and create schedules." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst schedulesClient = client.schedules();\n\n// List all schedules\nconst { items } = await schedulesClient.list();\n\n// Create a new schedule\nconst newSchedule = await schedulesClient.create({\n actorId: 'my-actor-id',\n cronExpression: '0 9 * * *',\n isEnabled: true\n});\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/schedules" - } - ] - } - ] - }, - "children": [ - { - "id": 2546, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 2542, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 2547, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 2540, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 2548, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 2543, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 2544, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 2541, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 2545, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 2513, - "name": "create", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule_collection.ts", - "line": 83, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule_collection.ts#L83", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2514, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new schedule." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The created schedule object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/schedules-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule_collection.ts", - "line": 83, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule_collection.ts#L83", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2515, - "name": "schedule", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The schedule data." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2462, - "name": "Schedule", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "description" - }, - { - "type": "literal", - "value": "title" - }, - { - "type": "literal", - "value": "cronExpression" - }, - { - "type": "literal", - "value": "timezone" - }, - { - "type": "literal", - "value": "isEnabled" - }, - { - "type": "literal", - "value": "isExclusive" - }, - { - "type": "literal", - "value": "notifications" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 2516, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2517, - "name": "actions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 132, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L132", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "DistributiveOptional" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2486, - "name": "ScheduleAction", - "package": "apify-client" - }, - { - "type": "literal", - "value": "id" - } - ], - "name": "DistributiveOptional", - "package": "apify-client" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2517 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 131, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L131", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2462, - "name": "Schedule", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2510, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule_collection.ts", - "line": 63, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule_collection.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2511, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all schedules.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of schedules." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/schedules-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule_collection.ts", - "line": 63, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule_collection.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2512, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination and sorting options." - } - ] - }, - "type": { - "type": "reference", - "target": 2576, - "name": "ScheduleCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedIterator" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2462, - "name": "Schedule", - "package": "apify-client" - } - ], - "name": "PaginatedIterator", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2546, - 2542, - 2547, - 2540, - 2548, - 2543, - 2544, - 2541, - 2545 - ] - }, - { - "title": "Methods", - "children": [ - 2513, - 2510 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule_collection.ts", - "line": 32, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule_collection.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 2581, - "name": "StoreCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for browsing Actors in the Apify Store.\n\nThe Apify Store contains publicly available Actors that can be used by anyone.\nThis client provides methods to search and list Actors from the Store." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient();\nconst storeClient = client.store();\n\n// Search for Actors in the Store\nconst { items } = await storeClient.list({ search: 'web scraper' });\n\n// Get details about a specific Store Actor\nconst actor = await storeClient.list({ username: 'apify', actorName: 'web-scraper' });\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/publishing" - } - ] - } - ] - }, - "children": [ - { - "id": 2616, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 2612, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 2617, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 2610, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 2618, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 2613, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 2614, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 2611, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 2615, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 2585, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 59, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L59", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2586, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists Actors from the Apify Store.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of store Actors." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/store-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 59, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L59", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2587, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search and pagination options." - } - ] - }, - "type": { - "type": "reference", - "target": 2660, - "name": "StoreCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedIterator" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2648, - "name": "ActorStoreList", - "package": "apify-client" - } - ], - "name": "PaginatedIterator", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2616, - 2612, - 2617, - 2610, - 2618, - 2613, - 2614, - 2611, - 2615 - ] - }, - { - "title": "Methods", - "children": [ - 2585 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 28, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 1850, - "name": "StreamedLog", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper class for redirecting streamed Actor logs to another log." - } - ] - }, - "children": [ - { - "id": 1851, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 155, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L155", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1852, - "name": "new StreamedLog", - "variant": "signature", - "kind": 16384, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 155, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L155", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1853, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1872, - "name": "StreamedLogOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": 1850, - "name": "StreamedLog", - "package": "apify-client" - } - } - ] - }, - { - "id": 1861, - "name": "start", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 165, - "character": 11, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L165", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1862, - "name": "start", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Start log redirection." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 165, - "character": 11, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L165", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 1863, - "name": "stop", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 176, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L176", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 1864, - "name": "stop", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stop log redirection." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 176, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L176", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1851 - ] - }, - { - "title": "Methods", - "children": [ - 1861, - 1863 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 145, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L145", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2670, - "name": "TaskClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific Actor task.\n\nTasks are pre-configured Actor runs with saved input and options. This client provides methods\nto start, call, update, and delete tasks, as well as manage their runs and webhooks." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst taskClient = client.task('my-task-id');\n\n// Start a task\nconst run = await taskClient.start();\n\n// Call a task and wait for it to finish\nconst finishedRun = await taskClient.call();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/running/tasks" - } - ] - } - ] - }, - "children": [ - { - "id": 2728, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 2724, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 2729, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 2722, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 2730, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 2725, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 2726, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 2723, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 2727, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 2685, - "name": "call", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 158, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L158", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2686, - "name": "call", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts a task and waits for it to finish before returning the Run object.\nIt waits indefinitely, unless the " - }, - { - "kind": "code", - "text": "`waitSecs`" - }, - { - "kind": "text", - "text": " option is provided." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Actor run object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-runs-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 158, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L158", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2687, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input overrides for the task. If not provided, the task's saved input is used." - } - ] - }, - "type": { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - } - }, - { - "id": 2688, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Run and wait options." - } - ] - }, - "type": { - "type": "reference", - "target": 2783, - "name": "TaskCallOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2679, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 75, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L75", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2680, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the Task." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 75, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L75", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2674, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 53, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L53", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2675, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the Actor task." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The task object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 53, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L53", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 2758, - "name": "Task", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2689, - "name": "getInput", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 190, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L190", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2690, - "name": "getInput", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the Actor task's input object." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Task's input, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-input-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 190, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L190", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2694, - "name": "lastRun", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 233, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L233", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2695, - "name": "lastRun", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the last run of this task." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the last run." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-runs-last-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 233, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L233", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2696, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter options for the last run." - } - ] - }, - "type": { - "type": "reference", - "target": 2780, - "name": "TaskLastRunOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 2191, - "name": "RunClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 2697, - "name": "runs", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 257, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L257", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2698, - "name": "runs", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the Runs of this Task." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the task's runs." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-runs-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 257, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L257", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2317, - "name": "RunCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 2681, - "name": "start", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 95, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L95", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2682, - "name": "start", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Starts an Actor task and immediately returns the Run object." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The Actor Run object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-runs-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 95, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L95", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2683, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input overrides for the task. If not provided, the task's saved input is used." - } - ] - }, - "type": { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - } - }, - { - "id": 2684, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Run options." - } - ] - }, - "type": { - "type": "reference", - "target": 2782, - "name": "TaskStartOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2676, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 64, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L64", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2677, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the task with the specified fields." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated task object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 64, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L64", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2678, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to update." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2758, - "name": "Task", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "description" - }, - { - "type": "literal", - "value": "title" - }, - { - "type": "literal", - "value": "actorStandby" - }, - { - "type": "literal", - "value": "input" - }, - { - "type": "literal", - "value": "options" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2758, - "name": "Task", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2691, - "name": "updateInput", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 213, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L213", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2692, - "name": "updateInput", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the Actor task's input object." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated task input." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-input-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 213, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L213", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2693, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "New input data for the task." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - } - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2699, - "name": "webhooks", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 271, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L271", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2700, - "name": "webhooks", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the Webhooks of this Task." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the task's webhooks." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-task-webhooks-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 271, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L271", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3149, - "name": "WebhookCollectionClient", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2728, - 2724, - 2729, - 2722, - 2730, - 2725, - 2726, - 2723, - 2727 - ] - }, - { - "title": "Methods", - "children": [ - 2685, - 2679, - 2674, - 2689, - 2694, - 2697, - 2681, - 2676, - 2691, - 2699 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 36, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 2792, - "name": "TaskCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of Actor tasks in your account.\n\nTasks are pre-configured Actor runs with saved input and options. This client provides\nmethods to list and create tasks." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst tasksClient = client.tasks();\n\n// List all tasks\nconst { items } = await tasksClient.list();\n\n// Create a new task\nconst newTask = await tasksClient.create({\n actId: 'my-actor-id',\n name: 'my-task',\n input: { url: 'https://example.com' }\n});\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/running/tasks" - } - ] - } - ] - }, - "children": [ - { - "id": 2830, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 2826, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 2831, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 2824, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 2832, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 2827, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 2828, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 2825, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 2829, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 2799, - "name": "create", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 83, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L83", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2800, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new task." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The created task object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-tasks-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 83, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L83", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2801, - "name": "task", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The task data." - } - ] - }, - "type": { - "type": "reference", - "target": 2866, - "name": "TaskCreateData", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2758, - "name": "Task", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2796, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 63, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2797, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all Tasks.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of tasks." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/actor-tasks-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 63, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2798, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination and sorting options." - } - ] - }, - "type": { - "type": "reference", - "target": 2860, - "name": "TaskCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedIterator" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2865, - "name": "TaskList", - "package": "apify-client" - } - ], - "name": "PaginatedIterator", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2830, - 2826, - 2831, - 2824, - 2832, - 2827, - 2828, - 2825, - 2829 - ] - }, - { - "title": "Methods", - "children": [ - 2799, - 2796 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 32, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 2874, - "name": "UserClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing user account information.\n\nProvides methods to retrieve user details, monthly usage statistics, and account limits.\nWhen using an API token, you can access your own user information or public information\nabout other users." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst userClient = client.user('my-user-id');\n\n// Get user information\nconst user = await userClient.get();\n\n// Get monthly usage\nconst usage = await userClient.monthlyUsage();\n\n// Get account limits\nconst limits = await userClient.limits();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/running" - } - ] - } - ] - }, - "children": [ - { - "id": 2914, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 2910, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 2915, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 2908, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 2916, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 2911, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 2912, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 2909, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 2913, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 2878, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 51, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L51", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2879, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the user data.\n\nDepending on whether ApifyClient was created with a token,\nthe method will either return public or private user data." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The user object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/user-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 51, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L51", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2944, - "name": "User", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2882, - "name": "limits", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 89, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L89", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2883, - "name": "limits", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the user's account and usage limits." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The account and usage limits object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/users-me-limits-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 89, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L89", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 3009, - "name": "AccountAndUsageLimits", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2880, - "name": "monthlyUsage", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 61, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L61", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2881, - "name": "monthlyUsage", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the user's monthly usage data." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The monthly usage object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/users-me-usage-monthly-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 61, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L61", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 2997, - "name": "MonthlyUsage", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2884, - "name": "updateLimits", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 111, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L111", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 2885, - "name": "updateLimits", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the user's account and usage limits." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/users-me-limits-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 111, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L111", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 2886, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new limits to set." - } - ] - }, - "type": { - "type": "reference", - "target": 3028, - "name": "LimitsUpdateOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2914, - 2910, - 2915, - 2908, - 2916, - 2911, - 2912, - 2909, - 2913 - ] - }, - { - "title": "Methods", - "children": [ - 2878, - 2882, - 2880, - 2884 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 31, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L31", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 3044, - "name": "WebhookClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific webhook.\n\nWebhooks allow you to receive notifications when specific events occur in your Actors or tasks.\nThis client provides methods to get, update, delete, and test webhooks, as well as retrieve\nwebhook dispatches." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst webhookClient = client.webhook('my-webhook-id');\n\n// Get webhook details\nconst webhook = await webhookClient.get();\n\n// Update webhook\nawait webhookClient.update({\n isEnabled: true,\n eventTypes: ['ACTOR.RUN.SUCCEEDED'],\n requestUrl: 'https://example.com/webhook'\n});\n\n// Test webhook\nawait webhookClient.test();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/integrations/webhooks" - } - ] - } - ] - }, - "children": [ - { - "id": 3086, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 3082, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 3087, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 3080, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 3088, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 3083, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 3084, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 3081, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 3085, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 3053, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 80, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L80", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3054, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletes the webhook." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-delete" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 80, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L80", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3057, - "name": "dispatches", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 113, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L113", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3058, - "name": "dispatches", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Returns a client for the dispatches of this webhook." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A client for the webhook's dispatches." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-webhook-dispatches-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 113, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L113", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3310, - "name": "WebhookDispatchCollectionClient", - "package": "apify-client" - } - } - ] - }, - { - "id": 3048, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 58, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L58", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3049, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the webhook." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The webhook object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 58, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L58", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 3116, - "name": "Webhook", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3055, - "name": "test", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 90, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L90", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3056, - "name": "test", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tests the webhook by dispatching a test event." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The webhook dispatch object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if the test fails." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-test-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 90, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L90", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 3285, - "name": "WebhookDispatch", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3050, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 69, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L69", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3051, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Updates the webhook with the specified fields." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The updated webhook object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-put" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 69, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L69", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 3052, - "name": "newFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to update." - } - ] - }, - "type": { - "type": "reference", - "target": 3136, - "name": "WebhookUpdateData", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3116, - "name": "Webhook", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3086, - 3082, - 3087, - 3080, - 3088, - 3083, - 3084, - 3081, - 3085 - ] - }, - { - "title": "Methods", - "children": [ - 3053, - 3057, - 3048, - 3055, - 3050 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 41, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L41", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 3149, - "name": "WebhookCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of Webhooks.\n\nWebhooks allow you to receive notifications when specific events occur in your Actors or tasks.\nThis client provides methods to list and create webhooks for specific Actors or tasks." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\n\n// List webhooks for an Actor\nconst actorWebhooksClient = client.actor('my-actor-id').webhooks();\nconst { items } = await actorWebhooksClient.list();\n\n// Create a webhook\nconst newWebhook = await actorWebhooksClient.create({\n eventTypes: ['ACTOR.RUN.SUCCEEDED'],\n requestUrl: 'https://example.com/webhook'\n});\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/integrations/webhooks" - } - ] - } - ] - }, - "children": [ - { - "id": 3187, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 3183, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 3188, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 3181, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 3189, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 3184, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 3185, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 3182, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 3186, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 3156, - "name": "create", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_collection.ts", - "line": 85, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_collection.ts#L85", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3157, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a new webhook." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The created webhook object." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhooks-post" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_collection.ts", - "line": 85, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_collection.ts#L85", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 3158, - "name": "webhook", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The webhook data." - } - ] - }, - "type": { - "type": "reference", - "target": 3136, - "name": "WebhookUpdateData", - "package": "apify-client" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3116, - "name": "Webhook", - "package": "apify-client" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3153, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_collection.ts", - "line": 63, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_collection.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3154, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all Webhooks.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of webhooks." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhooks-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_collection.ts", - "line": 63, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_collection.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 3155, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination and sorting options." - } - ] - }, - "type": { - "type": "reference", - "target": 3217, - "name": "WebhookCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedIterator" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3116, - "name": "Webhook", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "payloadTemplate" - }, - { - "type": "literal", - "value": "headersTemplate" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - ], - "name": "PaginatedIterator", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3187, - 3183, - 3188, - 3181, - 3189, - 3184, - 3185, - 3182, - 3186 - ] - }, - { - "title": "Methods", - "children": [ - 3156, - 3153 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook_collection.ts", - "line": 31, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_collection.ts#L31", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 3222, - "name": "WebhookDispatchClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing a specific webhook dispatch.\n\nWebhook dispatches represent individual notifications sent by webhooks. This client provides\nmethods to retrieve details about a specific dispatch." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst webhookClient = client.webhook('my-webhook-id');\n\n// Get a specific dispatch\nconst dispatchClient = webhookClient.dispatches().get('dispatch-id');\nconst dispatch = await dispatchClient.get();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/integrations/webhooks" - } - ] - } - ] - }, - "children": [ - { - "id": 3255, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.apifyClient" - } - }, - { - "id": 3251, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.baseUrl" - } - }, - { - "id": 3256, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.httpClient" - } - }, - { - "id": 3249, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.id" - } - }, - { - "id": 3257, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.params" - } - }, - { - "id": 3252, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.publicBaseUrl" - } - }, - { - "id": 3253, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.resourcePath" - } - }, - { - "id": 3250, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.safeId" - } - }, - { - "id": 3254, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceClient.url" - } - }, - { - "id": 3226, - "name": "get", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 40, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3227, - "name": "get", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the webhook dispatch." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The webhook dispatch object, or " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " if it does not exist." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-dispatch-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 40, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": 3285, - "name": "WebhookDispatch", - "package": "apify-client" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3255, - 3251, - 3256, - 3249, - 3257, - 3252, - 3253, - 3250, - 3254 - ] - }, - { - "title": "Methods", - "children": [ - 3226 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 23, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L23", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_client.ts", - "qualifiedName": "ResourceClient" - }, - "name": "ResourceClient", - "package": "apify-client" - } - ] - }, - { - "id": 3310, - "name": "WebhookDispatchCollectionClient", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Client for managing the collection of webhook dispatches.\n\nWebhook dispatches represent individual notifications sent by a webhook. This client provides\nmethods to list all dispatches for a specific webhook." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```javascript\nconst client = new ApifyClient({ token: 'my-token' });\nconst webhookClient = client.webhook('my-webhook-id');\n\n// List all dispatches for this webhook\nconst dispatchesClient = webhookClient.dispatches();\nconst { items } = await dispatchesClient.list();\n```" - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/integrations/webhooks" - } - ] - } - ] - }, - "children": [ - { - "id": 3345, - "name": "apifyClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 36, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L36", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 36, - "name": "ApifyClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.apifyClient" - } - }, - { - "id": 3341, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 28, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L28", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.baseUrl" - } - }, - { - "id": 3346, - "name": "httpClient", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 38, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L38", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "HttpClient" - }, - "name": "HttpClient", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.httpClient" - } - }, - { - "id": 3339, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 24, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L24", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.id" - } - }, - { - "id": 3347, - "name": "params", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 40, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L40", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.params" - } - }, - { - "id": 3342, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 30, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L30", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.publicBaseUrl" - } - }, - { - "id": 3343, - "name": "resourcePath", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 32, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L32", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.resourcePath" - } - }, - { - "id": 3340, - "name": "safeId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 26, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.safeId" - } - }, - { - "id": 3344, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/base/api_client.ts", - "line": 34, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/base/api_client.ts#L34", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "ResourceCollectionClient.url" - } - }, - { - "id": 3314, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch_collection.ts", - "line": 57, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch_collection.ts#L57", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "signatures": [ - { - "id": 3315, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Lists all webhook dispatches.\n\nAwaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched\nitems in a single API call is limited.\n" - }, - { - "kind": "code", - "text": "```javascript\nconst paginatedList = await client.list(options);\n```" - }, - { - "kind": "text", - "text": "\n\nAsynchronous iteration is also supported. This will fetch additional pages if needed until all items are\nretrieved.\n\n" - }, - { - "kind": "code", - "text": "```javascript\nfor await (const singleItem of client.list(options)) {...}\n```" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "A paginated iterator of webhook dispatches." - } - ] - }, - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/api/v2/webhook-dispatches-get" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch_collection.ts", - "line": 57, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch_collection.ts#L57", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 3316, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination and sorting options." - } - ] - }, - "type": { - "type": "reference", - "target": 3375, - "name": "WebhookDispatchCollectionListOptions", - "package": "apify-client" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedIterator" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3285, - "name": "WebhookDispatch", - "package": "apify-client" - } - ], - "name": "PaginatedIterator", - "package": "apify-client" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3345, - 3341, - 3346, - 3339, - 3347, - 3342, - 3343, - 3340, - 3344 - ] - }, - { - "title": "Methods", - "children": [ - 3314 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch_collection.ts", - "line": 26, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch_collection.ts#L26", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/base/resource_collection_client.ts", - "qualifiedName": "ResourceCollectionClient" - }, - "name": "ResourceCollectionClient", - "package": "apify-client" - } - ] - }, - { - "id": 3009, - "name": "AccountAndUsageLimits", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3012, - "name": "current", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 266, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L266", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3033, - "name": "Current", - "package": "apify-client" - } - }, - { - "id": 3011, - "name": "limits", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 265, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L265", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3016, - "name": "Limits", - "package": "apify-client" - } - }, - { - "id": 3010, - "name": "monthlyUsageCycle", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 264, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L264", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3013, - "name": "MonthlyUsageCycle", - "package": "apify-client" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3012, - 3011, - 3010 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 263, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L263", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 223, - "name": "Actor", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents an Actor in the Apify platform.\n\nActors are serverless computing units that can perform arbitrary tasks such as web scraping,\ndata processing, automation, and more. Each Actor has versions, builds, and can be executed\nwith different configurations." - } - ] - }, - "children": [ - { - "id": 249, - "name": "actorPermissionLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Permission level of the Actor on Apify platform" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 510, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L510", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "ACTOR_PERMISSION_LEVEL" - }, - "name": "ACTOR_PERMISSION_LEVEL", - "package": "@apify/consts" - } - }, - { - "id": 246, - "name": "actorStandby", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Standby mode configuration for keeping Actor warm and responsive" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 506, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L506", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 274, - "name": "ActorStandby", - "package": "apify-client" - }, - { - "type": "reflection", - "declaration": { - "id": 247, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 248, - "name": "isEnabled", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 507, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L507", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 248 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 506, - "character": 34, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L506", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - }, - { - "id": 245, - "name": "categories", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Categories the Actor belongs to (e.g., 'ECOMMERCE', 'SCRAPING')" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 504, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L504", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 232, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the Actor was created" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 478, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L478", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 237, - "name": "defaultRunOptions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default configuration options for Actor runs" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 488, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L488", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 260, - "name": "ActorDefaultRunOptions", - "package": "apify-client" - } - }, - { - "id": 240, - "name": "deploymentKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deployment key used for automated deployments" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 494, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L494", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 228, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Detailed description of what the Actor does" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 470, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L470", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 238, - "name": "exampleRunInput", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Example input to help users understand how to use the Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 490, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L490", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 265, - "name": "ActorExampleRunInput", - "package": "apify-client" - } - }, - { - "id": 224, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique Actor ID" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 462, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L462", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 231, - "name": "isAnonymouslyRunnable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor can be run by anonymous users without authentication" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 476, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L476", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 239, - "name": "isDeprecated", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is deprecated and should not be used" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 492, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L492", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 230, - "name": "isPublic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Actor is publicly available in Apify Store" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 474, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L474", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 233, - "name": "modifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the Actor was last modified" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 480, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L480", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 226, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Unique name of the Actor (used in API paths, e.g., 'my-actor')" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 466, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L466", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 236, - "name": "pricingInfos", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pricing information for pay-per-result or pay-per-event Actors" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 486, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L486", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 474, - "name": "ActorRunPricingInfo", - "package": "apify-client" - } - } - }, - { - "id": 250, - "name": "readmeSummary", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A brief, LLM-generated readme summary" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 512, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L512", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 229, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use defaultRunOptions.restartOnError instead" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 472, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L472", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 244, - "name": "seoDescription", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "SEO-optimized description for the Actor's public page" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 502, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L502", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 243, - "name": "seoTitle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "SEO-optimized title for the Actor's public page" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 500, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L500", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 234, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Usage and run statistics for the Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 482, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L482", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 251, - "name": "ActorStats", - "package": "apify-client" - } - }, - { - "id": 242, - "name": "taggedBuilds", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of tags to specific builds (e.g., 'latest', 'beta')" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 498, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L498", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 268, - "name": "ActorTaggedBuilds", - "package": "apify-client" - } - }, - { - "id": 241, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Human-readable title of the Actor (displayed in UI)" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 496, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L496", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 225, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the user who owns the Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 464, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L464", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 227, - "name": "username", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Username of the Actor's owner" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 468, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L468", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 235, - "name": "versions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "All versions of this Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 484, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L484", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 839, - "name": "ActorVersion", - "package": "apify-client" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 249, - 246, - 245, - 232, - 237, - 240, - 228, - 238, - 224, - 231, - 239, - 230, - 233, - 226, - 236, - 250, - 229, - 244, - 243, - 234, - 242, - 241, - 225, - 227, - 235 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 460, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L460", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 404, - "name": "ActorBuildOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for building an Actor." - } - ] - }, - "children": [ - { - "id": 405, - "name": "betaPackages", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 836, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L836", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 406, - "name": "tag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 837, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L837", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "useCache", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 838, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L838", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 408, - "name": "waitForFinish", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 839, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L839", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 405, - 406, - 407, - 408 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 835, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L835", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 293, - "name": "ActorCallOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for calling an Actor and waiting for it to finish.\n\nExtends " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "ActorStartOptions", - "target": 282 - }, - { - "kind": "text", - "text": " with additional options for waiting and log streaming." - } - ] - }, - "children": [ - { - "id": 297, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag or number of the Actor build to run (e.g. " - }, - { - "kind": "code", - "text": "`beta`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`1.2.345`" - }, - { - "kind": "text", - "text": ").\nIf not provided, the run uses build tag or number from the default Actor run configuration (typically " - }, - { - "kind": "code", - "text": "`latest`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 613, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L613", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.build" - } - }, - { - "id": 298, - "name": "contentType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Content type for the " - }, - { - "kind": "code", - "text": "`input`" - }, - { - "kind": "text", - "text": ". If not specified,\n" - }, - { - "kind": "code", - "text": "`input`" - }, - { - "kind": "text", - "text": " is expected to be an object that will be stringified to JSON and content type set to\n" - }, - { - "kind": "code", - "text": "`application/json; charset=utf-8`" - }, - { - "kind": "text", - "text": ". If " - }, - { - "kind": "code", - "text": "`options.contentType`" - }, - { - "kind": "text", - "text": " is specified, then " - }, - { - "kind": "code", - "text": "`input`" - }, - { - "kind": "text", - "text": " must be a\n" - }, - { - "kind": "code", - "text": "`String`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`Buffer`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 621, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L621", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.contentType" - } - }, - { - "id": 304, - "name": "forcePermissionLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the Actor's permissions for this run. If not set, the Actor will run with permissions configured in the\nActor settings." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 679, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L679", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "ACTOR_PERMISSION_LEVEL" - }, - "name": "ACTOR_PERMISSION_LEVEL", - "package": "@apify/consts" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.forcePermissionLevel" - } - }, - { - "id": 295, - "name": "log", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "code", - "text": "`Log`" - }, - { - "kind": "text", - "text": " instance that should be used to redirect Actor run logs to.\nIf " - }, - { - "kind": "code", - "text": "`undefined`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`'default'`" - }, - { - "kind": "text", - "text": " the pre-defined " - }, - { - "kind": "code", - "text": "`Log`" - }, - { - "kind": "text", - "text": " will be created and used.\nIf " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": ", no log redirection will occur." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 697, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L697", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Log" - }, - "name": "Log", - "package": "@apify/log" - }, - { - "type": "literal", - "value": "default" - } - ] - } - }, - { - "id": 302, - "name": "maxItems", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the maximum number of dataset items that will be charged for pay-per-result Actors.\nThis does NOT guarantee that the Actor will return only this many items.\nIt only ensures you won't be charged for more than this number of items.\nOnly works for pay-per-result Actors.\nValue can be accessed in the Actor run using " - }, - { - "kind": "code", - "text": "`ACTOR_MAX_PAID_DATASET_ITEMS`" - }, - { - "kind": "text", - "text": " environment variable." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 658, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L658", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.maxItems" - } - }, - { - "id": 303, - "name": "maxTotalChargeUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the maximum cost of the Actor run. This parameter is\nused only for pay-per-event Actors. It allows you to limit the amount\ncharged to your subscription. You can access the maximum cost in your\nActor by using the " - }, - { - "kind": "code", - "text": "`ACTOR_MAX_TOTAL_CHARGE_USD`" - }, - { - "kind": "text", - "text": " environment variable." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 666, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L666", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.maxTotalChargeUsd" - } - }, - { - "id": 299, - "name": "memory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory in megabytes which will be allocated for the new Actor run.\nIf not provided, the run uses memory of the default Actor run configuration." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 627, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L627", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.memory" - } - }, - { - "id": 296, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines whether the run will be restarted if it fails." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 671, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L671", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.restartOnError" - } - }, - { - "id": 300, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the Actor run in seconds. Zero value means there is no timeout.\nIf not provided, the run uses timeout of the default Actor run configuration." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 632, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L632", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.timeout" - } - }, - { - "id": 294, - "name": "waitSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wait time in seconds for the Actor run to finish." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 691, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L691", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 301, - "name": "webhooks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies optional webhooks associated with the Actor run, which can be used\nto receive a notification e.g. when the Actor finished or failed, see\n[ad hook webhooks documentation](https://docs.apify.com/webhooks/ad-hoc-webhooks) for detailed description." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 649, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L649", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3136, - "name": "WebhookUpdateData", - "package": "apify-client" - } - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.webhooks" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 297, - 298, - 304, - 295, - 302, - 303, - 299, - 296, - 300, - 294, - 301 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 687, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L687", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 282, - "name": "ActorStartOptions", - "package": "apify-client" - }, - { - "type": "literal", - "value": "waitForFinish" - } - ], - "name": "Omit", - "package": "typescript" - } - ] - }, - { - "id": 457, - "name": "ActorChargeEvent", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Definition of a chargeable event for pay-per-event Actors." - } - ] - }, - "children": [ - { - "id": 460, - "name": "eventDescription", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 931, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L931", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 458, - "name": "eventPriceUsd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 929, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L929", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 459, - "name": "eventTitle", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 930, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L930", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 460, - 458, - 459 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 928, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L928", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 560, - "name": "ActorCollectionCreateOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 573, - "name": "actorStandby", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 127, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L127", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 274, - "name": "ActorStandby", - "package": "apify-client" - }, - { - "type": "reflection", - "declaration": { - "id": 574, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 575, - "name": "isEnabled", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 128, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L128", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 575 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 127, - "character": 34, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L127", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - }, - { - "id": 561, - "name": "categories", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 114, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L114", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 562, - "name": "defaultRunOptions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 115, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L115", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 260, - "name": "ActorDefaultRunOptions", - "package": "apify-client" - } - }, - { - "id": 563, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 116, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L116", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 564, - "name": "exampleRunInput", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 117, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L117", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 265, - "name": "ActorExampleRunInput", - "package": "apify-client" - } - }, - { - "id": 565, - "name": "isDeprecated", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 118, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L118", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 566, - "name": "isPublic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 119, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L119", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 567, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 120, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L120", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 568, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use defaultRunOptions.restartOnError instead" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 122, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L122", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 570, - "name": "seoDescription", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 124, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L124", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 569, - "name": "seoTitle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 123, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L123", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 571, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 125, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L125", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 572, - "name": "versions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 126, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L126", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 839, - "name": "ActorVersion", - "package": "apify-client" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 573, - 561, - 562, - 563, - 564, - 565, - 566, - 567, - 568, - 570, - 569, - 571, - 572 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 113, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L113", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 553, - "name": "ActorCollectionListItem", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 555, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 105, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L105", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 554, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 104, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 556, - "name": "modifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 106, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L106", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 557, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 107, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L107", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 558, - "name": "username", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 108, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L108", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 555, - 554, - 556, - 557, - 558 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 103, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L103", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 546, - "name": "ActorCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 552, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 548, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 99, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L99", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 551, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 547, - "name": "my", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 98, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L98", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 550, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - }, - { - "id": 549, - "name": "sortBy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 100, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L100", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 543, - "name": "ActorListSortBy", - "package": "apify-client" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 552, - 548, - 551, - 547, - 550, - 549 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 97, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L97", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 260, - "name": "ActorDefaultRunOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Default configuration options for Actor runs." - } - ] - }, - "children": [ - { - "id": 261, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 541, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L541", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 263, - "name": "memoryMbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 543, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L543", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 264, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 544, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L544", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 262, - "name": "timeoutSecs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 542, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L542", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 261, - 263, - 264, - 262 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 540, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L540", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 411, - "name": "ActorDefinition", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Actor definition from the " - }, - { - "kind": "code", - "text": "`.actor/actor.json`" - }, - { - "kind": "text", - "text": " file.\n\nContains the Actor's configuration, input schema, and other metadata." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/development/actor-definition/actor-json" - } - ] - } - ] - }, - "children": [ - { - "id": 412, - "name": "actorSpecification", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 856, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L856", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 415, - "name": "buildTag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 859, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L859", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 422, - "name": "changelog", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 874, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L874", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 418, - "name": "dockerContextDir", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 862, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L862", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 417, - "name": "dockerfile", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 861, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L861", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 416, - "name": "environmentVariables", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 860, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L860", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 420, - "name": "input", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input schema for the Actor." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/development/actor-definition/input-schema" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 868, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L868", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "object" - } - ] - } - }, - { - "id": 427, - "name": "maxMemoryMbytes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 879, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L879", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 426, - "name": "minMemoryMbytes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 878, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L878", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 413, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 857, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L857", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 421, - "name": "output", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Output schema for the Actor." - } - ], - "blockTags": [ - { - "tag": "@see", - "content": [ - { - "kind": "text", - "text": "https://docs.apify.com/platform/actors/development/actor-definition/output-schema" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 873, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L873", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "object" - } - ] - } - }, - { - "id": 419, - "name": "readme", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 863, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L863", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 423, - "name": "storages", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 875, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L875", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 424, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 425, - "name": "dataset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 876, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L876", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 425 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 875, - "character": 15, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L875", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - }, - { - "id": 428, - "name": "usesStandbyMode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 880, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L880", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 414, - "name": "version", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 858, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L858", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 412, - 415, - 422, - 418, - 417, - 416, - 420, - 427, - 426, - 413, - 421, - 419, - 423, - 428, - 414 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 855, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L855", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 835, - "name": "ActorEnvironmentVariable", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 838, - "name": "isSecret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 139, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L139", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 836, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 137, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L137", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 837, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 138, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L138", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 838, - 836, - 837 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 136, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L136", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 712, - "name": "ActorEnvVarCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "No options are used in the current API implementation.\nhttps://github.com/apify/apify-client-js/issues/799" - } - ] - } - ] - }, - "children": [ - { - "id": 716, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 713, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var_collection.ts", - "line": 88, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var_collection.ts#L88", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 715, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 714, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 716, - 713, - 715, - 714 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var_collection.ts", - "line": 87, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var_collection.ts#L87", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 265, - "name": "ActorExampleRunInput", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Example input data to demonstrate Actor usage." - } - ] - }, - "children": [ - { - "id": 266, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 551, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L551", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 267, - "name": "contentType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 552, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L552", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 266, - 267 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 550, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L550", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 409, - "name": "ActorLastRunOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for filtering the last run of an Actor." - } - ] - }, - "children": [ - { - "id": 410, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 846, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L846", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "READY" - }, - { - "type": "literal", - "value": "RUNNING" - }, - { - "type": "literal", - "value": "SUCCEEDED" - }, - { - "type": "literal", - "value": "FAILED" - }, - { - "type": "literal", - "value": "TIMING_OUT" - }, - { - "type": "literal", - "value": "TIMED_OUT" - }, - { - "type": "literal", - "value": "ABORTING" - }, - { - "type": "literal", - "value": "ABORTED" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 410 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 845, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L845", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 335, - "name": "ActorRun", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Complete Actor run information including statistics and usage details.\n\nRepresents a single execution of an Actor with all its configuration, status,\nand resource usage information." - } - ] - }, - "children": [ - { - "id": 351, - "name": "actId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 707, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L707", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 307, - "name": "ActorRunListItem.actId" - } - }, - { - "id": 352, - "name": "actorTaskId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 708, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L708", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 308, - "name": "ActorRunListItem.actorTaskId" - } - }, - { - "id": 357, - "name": "buildId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 713, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L713", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 313, - "name": "ActorRunListItem.buildId" - } - }, - { - "id": 358, - "name": "buildNumber", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 714, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L714", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 314, - "name": "ActorRunListItem.buildNumber" - } - }, - { - "id": 347, - "name": "chargedEventCounts", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 748, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L748", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 341, - "name": "containerUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 742, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L742", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 360, - "name": "defaultDatasetId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 716, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L716", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 316, - "name": "ActorRunListItem.defaultDatasetId" - } - }, - { - "id": 359, - "name": "defaultKeyValueStoreId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 715, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L715", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 315, - "name": "ActorRunListItem.defaultKeyValueStoreId" - } - }, - { - "id": 361, - "name": "defaultRequestQueueId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 717, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L717", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 317, - "name": "ActorRunListItem.defaultRequestQueueId" - } - }, - { - "id": 340, - "name": "exitCode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 741, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L741", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 354, - "name": "finishedAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 710, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L710", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 310, - "name": "ActorRunListItem.finishedAt" - } - }, - { - "id": 348, - "name": "generalAccess", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 749, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L749", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "RUN_GENERAL_ACCESS" - }, - "name": "RUN_GENERAL_ACCESS", - "package": "@apify/consts" - } - ] - } - }, - { - "id": 343, - "name": "gitBranchName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 744, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L744", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 350, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 706, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L706", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 306, - "name": "ActorRunListItem.id" - } - }, - { - "id": 342, - "name": "isContainerServerReady", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 743, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L743", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 356, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 712, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L712", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 376, - "name": "ActorRunMeta", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": 312, - "name": "ActorRunListItem.meta" - } - }, - { - "id": 339, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 740, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L740", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 396, - "name": "ActorRunOptions", - "package": "apify-client" - } - }, - { - "id": 346, - "name": "pricingInfo", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 747, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L747", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 474, - "name": "ActorRunPricingInfo", - "package": "apify-client" - } - }, - { - "id": 353, - "name": "startedAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 709, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L709", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 309, - "name": "ActorRunListItem.startedAt" - } - }, - { - "id": 338, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 739, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L739", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 380, - "name": "ActorRunStats", - "package": "apify-client" - } - }, - { - "id": 355, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 711, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L711", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "READY" - }, - { - "type": "literal", - "value": "RUNNING" - }, - { - "type": "literal", - "value": "SUCCEEDED" - }, - { - "type": "literal", - "value": "FAILED" - }, - { - "type": "literal", - "value": "ABORTING" - }, - { - "type": "literal", - "value": "ABORTED" - }, - { - "type": "literal", - "value": "TIMING-OUT" - }, - { - "type": "literal", - "value": "TIMED-OUT" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 311, - "name": "ActorRunListItem.status" - } - }, - { - "id": 337, - "name": "statusMessage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 738, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L738", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 349, - "name": "storageIds", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 750, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L750", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 319, - "name": "ActorRunStorageIds", - "package": "apify-client" - } - }, - { - "id": 344, - "name": "usage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 745, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L745", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 363, - "name": "ActorRunUsage", - "package": "apify-client" - } - }, - { - "id": 362, - "name": "usageTotalUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 718, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L718", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 318, - "name": "ActorRunListItem.usageTotalUsd" - } - }, - { - "id": 345, - "name": "usageUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 746, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L746", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 363, - "name": "ActorRunUsage", - "package": "apify-client" - } - }, - { - "id": 336, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 737, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L737", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 351, - 352, - 357, - 358, - 347, - 341, - 360, - 359, - 361, - 340, - 354, - 348, - 343, - 350, - 342, - 356, - 339, - 346, - 353, - 338, - 355, - 337, - 349, - 344, - 362, - 345, - 336 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 736, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L736", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 305, - "name": "ActorRunListItem", - "package": "apify-client" - } - ] - }, - { - "id": 305, - "name": "ActorRunListItem", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Simplified Actor run information used in list results.\n\nContains basic information about a run without detailed statistics." - } - ] - }, - "children": [ - { - "id": 307, - "name": "actId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 707, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L707", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 308, - "name": "actorTaskId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 708, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L708", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 313, - "name": "buildId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 713, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L713", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 314, - "name": "buildNumber", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 714, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L714", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 316, - "name": "defaultDatasetId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 716, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L716", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 315, - "name": "defaultKeyValueStoreId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 715, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L715", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 317, - "name": "defaultRequestQueueId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 717, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L717", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 310, - "name": "finishedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 710, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L710", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 306, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 706, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L706", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 312, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 712, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L712", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 376, - "name": "ActorRunMeta", - "package": "apify-client" - } - }, - { - "id": 309, - "name": "startedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 709, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L709", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 311, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 711, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L711", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "READY" - }, - { - "type": "literal", - "value": "RUNNING" - }, - { - "type": "literal", - "value": "SUCCEEDED" - }, - { - "type": "literal", - "value": "FAILED" - }, - { - "type": "literal", - "value": "ABORTING" - }, - { - "type": "literal", - "value": "ABORTED" - }, - { - "type": "literal", - "value": "TIMING-OUT" - }, - { - "type": "literal", - "value": "TIMED-OUT" - } - ] - } - }, - { - "id": 318, - "name": "usageTotalUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 718, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L718", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 307, - 308, - 313, - 314, - 316, - 315, - 317, - 310, - 306, - 312, - 309, - 311, - 318 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 705, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L705", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 335, - "name": "ActorRun" - } - ] - }, - { - "id": 376, - "name": "ActorRunMeta", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata about how an Actor run was initiated." - } - ] - }, - "children": [ - { - "id": 378, - "name": "clientIp", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 790, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L790", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 377, - "name": "origin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 789, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L789", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 379, - "name": "userAgent", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 791, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L791", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 378, - 377, - 379 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 788, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L788", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 396, - "name": "ActorRunOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options used for an Actor run.\n\nThese are the actual options that were applied to the run (may differ from requested options)." - } - ] - }, - "children": [ - { - "id": 397, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 823, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L823", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 400, - "name": "diskMbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 826, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L826", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 401, - "name": "maxItems", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 827, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L827", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 402, - "name": "maxTotalChargeUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 828, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L828", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 399, - "name": "memoryMbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 825, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L825", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 403, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 829, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L829", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 398, - "name": "timeoutSecs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 824, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L824", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 397, - 400, - 401, - 402, - 399, - 403, - 398 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 822, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L822", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 380, - "name": "ActorRunStats", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Runtime statistics for an Actor run.\n\nProvides detailed metrics about resource consumption and performance during the run." - } - ] - }, - "children": [ - { - "id": 395, - "name": "computeUnits", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 814, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L814", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 387, - "name": "cpuAvgUsage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 806, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L806", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 389, - "name": "cpuCurrentUsage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 808, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L808", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 388, - "name": "cpuMaxUsage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 807, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L807", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 392, - "name": "durationMillis", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 811, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L811", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 381, - "name": "inputBodyLen", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 800, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L800", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 384, - "name": "memAvgBytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 803, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L803", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 386, - "name": "memCurrentBytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 805, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L805", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 385, - "name": "memMaxBytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 804, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L804", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 394, - "name": "metamorph", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 813, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L813", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 390, - "name": "netRxBytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 809, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L809", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 391, - "name": "netTxBytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 810, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L810", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 382, - "name": "restartCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 801, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L801", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 383, - "name": "resurrectCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 802, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L802", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 393, - "name": "runTimeSecs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 812, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L812", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 395, - 387, - 389, - 388, - 392, - 381, - 384, - 386, - 385, - 394, - 390, - 391, - 382, - 383, - 393 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 799, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L799", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 319, - "name": "ActorRunStorageIds", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 320, - "name": "datasets", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aliased dataset IDs for this run." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 723, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L723", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 322, - "name": "default", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 723, - "character": 16, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L723", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 322 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 723, - "character": 14, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L723", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "indexSignatures": [ - { - "id": 323, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 723, - "character": 33, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L723", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 324, - "name": "alias", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 325, - "name": "keyValueStores", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aliased key-value store IDs for this run." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 725, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L725", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 326, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 327, - "name": "default", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 725, - "character": 22, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L725", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 327 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 725, - "character": 20, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L725", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "indexSignatures": [ - { - "id": 328, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 725, - "character": 39, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L725", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 329, - "name": "alias", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - }, - { - "id": 330, - "name": "requestQueues", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Aliased request queue IDs for this run." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 727, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L727", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 331, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 332, - "name": "default", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 727, - "character": 21, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L727", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 332 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 727, - "character": 19, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L727", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "indexSignatures": [ - { - "id": 333, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 727, - "character": 38, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L727", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 334, - "name": "alias", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 320, - 325, - 330 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 721, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L721", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 363, - "name": "ActorRunUsage", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource usage metrics for an Actor run.\n\nAll values represent the total consumption during the run's lifetime." - } - ] - }, - "children": [ - { - "id": 364, - "name": "ACTOR_COMPUTE_UNITS", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Compute units consumed (combines CPU and memory usage over time)" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 760, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L760", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 373, - "name": "DATA_TRANSFER_EXTERNAL_GBYTES", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "External data transfer to/from internet (in gigabytes)" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 778, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L778", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 372, - "name": "DATA_TRANSFER_INTERNAL_GBYTES", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Internal data transfer within Apify platform (in gigabytes)" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 776, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L776", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 365, - "name": "DATASET_READS", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of Dataset read operations" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 762, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L762", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 366, - "name": "DATASET_WRITES", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of Dataset write operations" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 764, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L764", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 369, - "name": "KEY_VALUE_STORE_LISTS", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of key-value store list operations" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 770, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L770", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 367, - "name": "KEY_VALUE_STORE_READS", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of key-value store read operations" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 766, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L766", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 368, - "name": "KEY_VALUE_STORE_WRITES", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of key-value store write operations" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 768, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L768", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 374, - "name": "PROXY_RESIDENTIAL_TRANSFER_GBYTES", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Residential proxy data transfer (in gigabytes)" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 780, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L780", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 375, - "name": "PROXY_SERPS", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of SERP (Search Engine Results Page) proxy requests" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 782, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L782", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 370, - "name": "REQUEST_QUEUE_READS", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of Request queue read operations" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 772, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L772", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 371, - "name": "REQUEST_QUEUE_WRITES", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of Request queue write operations" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 774, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L774", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 364, - 373, - 372, - 365, - 366, - 369, - 367, - 368, - 374, - 375, - 370, - 371 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 758, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L758", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 274, - "name": "ActorStandby", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration for Actor standby mode.\n\nStandby mode keeps Actor containers warm and ready to process requests with minimal latency.\nThis is useful for Actors that need to respond quickly to incoming requests." - } - ] - }, - "children": [ - { - "id": 275, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 599, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L599", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 276, - "name": "desiredRequestsPerActorRun", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 600, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L600", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 277, - "name": "disableStandbyFieldsOverride", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 601, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L601", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 278, - "name": "idleTimeoutSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 602, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L602", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 279, - "name": "maxRequestsPerActorRun", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 603, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L603", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 280, - "name": "memoryMbytes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 604, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L604", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 281, - "name": "shouldPassActorInput", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 605, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L605", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 275, - 276, - 277, - 278, - 279, - 280, - 281 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 598, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L598", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 282, - "name": "ActorStartOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 283, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag or number of the Actor build to run (e.g. " - }, - { - "kind": "code", - "text": "`beta`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`1.2.345`" - }, - { - "kind": "text", - "text": ").\nIf not provided, the run uses build tag or number from the default Actor run configuration (typically " - }, - { - "kind": "code", - "text": "`latest`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 613, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L613", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 284, - "name": "contentType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Content type for the " - }, - { - "kind": "code", - "text": "`input`" - }, - { - "kind": "text", - "text": ". If not specified,\n" - }, - { - "kind": "code", - "text": "`input`" - }, - { - "kind": "text", - "text": " is expected to be an object that will be stringified to JSON and content type set to\n" - }, - { - "kind": "code", - "text": "`application/json; charset=utf-8`" - }, - { - "kind": "text", - "text": ". If " - }, - { - "kind": "code", - "text": "`options.contentType`" - }, - { - "kind": "text", - "text": " is specified, then " - }, - { - "kind": "code", - "text": "`input`" - }, - { - "kind": "text", - "text": " must be a\n" - }, - { - "kind": "code", - "text": "`String`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`Buffer`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 621, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L621", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 292, - "name": "forcePermissionLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Override the Actor's permissions for this run. If not set, the Actor will run with permissions configured in the\nActor settings." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 679, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L679", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "ACTOR_PERMISSION_LEVEL" - }, - "name": "ACTOR_PERMISSION_LEVEL", - "package": "@apify/consts" - } - }, - { - "id": 289, - "name": "maxItems", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the maximum number of dataset items that will be charged for pay-per-result Actors.\nThis does NOT guarantee that the Actor will return only this many items.\nIt only ensures you won't be charged for more than this number of items.\nOnly works for pay-per-result Actors.\nValue can be accessed in the Actor run using " - }, - { - "kind": "code", - "text": "`ACTOR_MAX_PAID_DATASET_ITEMS`" - }, - { - "kind": "text", - "text": " environment variable." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 658, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L658", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 290, - "name": "maxTotalChargeUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the maximum cost of the Actor run. This parameter is\nused only for pay-per-event Actors. It allows you to limit the amount\ncharged to your subscription. You can access the maximum cost in your\nActor by using the " - }, - { - "kind": "code", - "text": "`ACTOR_MAX_TOTAL_CHARGE_USD`" - }, - { - "kind": "text", - "text": " environment variable." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 666, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L666", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 285, - "name": "memory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory in megabytes which will be allocated for the new Actor run.\nIf not provided, the run uses memory of the default Actor run configuration." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 627, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L627", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 291, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines whether the run will be restarted if it fails." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 671, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L671", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 286, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the Actor run in seconds. Zero value means there is no timeout.\nIf not provided, the run uses timeout of the default Actor run configuration." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 632, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L632", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 287, - "name": "waitForFinish", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time to wait for the Actor run to finish, in seconds.\nIf the limit is reached, the returned promise is resolved to a run object that will have\nstatus " - }, - { - "kind": "code", - "text": "`READY`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`RUNNING`" - }, - { - "kind": "text", - "text": " and it will not contain the Actor run output.\nBy default (or when " - }, - { - "kind": "code", - "text": "`waitForFinish`" - }, - { - "kind": "text", - "text": " is set to " - }, - { - "kind": "code", - "text": "`0`" - }, - { - "kind": "text", - "text": "), the function resolves immediately without waiting.\nThe wait is limited to 60s and happens on the API directly, as opposed to the " - }, - { - "kind": "code", - "text": "`call`" - }, - { - "kind": "text", - "text": " method and its\n" - }, - { - "kind": "code", - "text": "`waitSecs`" - }, - { - "kind": "text", - "text": " option, which is implemented via polling on the client side instead (and has no limit like that)." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 642, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L642", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 288, - "name": "webhooks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies optional webhooks associated with the Actor run, which can be used\nto receive a notification e.g. when the Actor finished or failed, see\n[ad hook webhooks documentation](https://docs.apify.com/webhooks/ad-hoc-webhooks) for detailed description." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 649, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L649", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3136, - "name": "WebhookUpdateData", - "package": "apify-client" - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 283, - 284, - 292, - 289, - 290, - 285, - 291, - 286, - 287, - 288 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 608, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L608", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 251, - "name": "ActorStats", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics about Actor usage and activity." - } - ] - }, - "children": [ - { - "id": 259, - "name": "lastRunStartedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timestamp when the last run was started" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 534, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L534", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 252, - "name": "totalBuilds", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of builds created for this Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 520, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L520", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 258, - "name": "totalMetamorphs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of times this Actor was used via metamorph" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 532, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L532", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 253, - "name": "totalRuns", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of times this Actor has been run" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 522, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L522", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 254, - "name": "totalUsers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total number of unique users who have run this Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 524, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L524", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 256, - "name": "totalUsers30Days", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of unique users in the last 30 days" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 528, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L528", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 255, - "name": "totalUsers7Days", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of unique users in the last 7 days" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 526, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L526", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 257, - "name": "totalUsers90Days", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number of unique users in the last 90 days" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 530, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L530", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 259, - 252, - 258, - 253, - 254, - 256, - 255, - 257 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 518, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L518", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2648, - "name": "ActorStoreList", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2655, - "name": "currentPricingInfo", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 89, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L89", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2646, - "name": "PricingInfo", - "package": "apify-client" - } - }, - { - "id": 2653, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 87, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L87", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2649, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 83, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L83", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2650, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 84, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L84", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2656, - "name": "pictureUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 90, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L90", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2659, - "name": "readmeSummary", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A brief, LLM-generated readme summary" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 94, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L94", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2654, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 88, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L88", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 251, - "name": "ActorStats", - "package": "apify-client" - } - }, - { - "id": 2652, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 86, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L86", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2658, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 92, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L92", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2651, - "name": "username", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 85, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L85", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2657, - "name": "userPictureUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 91, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L91", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2655, - 2653, - 2649, - 2650, - 2656, - 2659, - 2654, - 2652, - 2658, - 2651, - 2657 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 82, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L82", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 269, - "name": "ActorTaggedBuild", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Information about a specific tagged build." - } - ] - }, - "children": [ - { - "id": 270, - "name": "buildId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 564, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L564", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 271, - "name": "buildNumber", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 565, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L565", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 272, - "name": "finishedAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 566, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L566", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 270, - 271, - 272 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 563, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L563", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 909, - "name": "ActorVersionCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "No options are used in the current API implementation.\nhttps://github.com/apify/apify-client-js/issues/799" - } - ] - } - ] - }, - "children": [ - { - "id": 913, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 910, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version_collection.ts", - "line": 87, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version_collection.ts#L87", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 912, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 911, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 913, - 910, - 912, - 911 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version_collection.ts", - "line": 86, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version_collection.ts#L86", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 823, - "name": "ActorVersionGitHubGist", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 828, - "name": "applyEnvVarsToBuild", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 103, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L103", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 795, - "name": "BaseActorVersion.applyEnvVarsToBuild" - } - }, - { - "id": 829, - "name": "buildTag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 104, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 796, - "name": "BaseActorVersion.buildTag" - } - }, - { - "id": 827, - "name": "envVars", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 102, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L102", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 794, - "name": "BaseActorVersion.envVars" - } - }, - { - "id": 824, - "name": "gitHubGistUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 126, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L126", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 826, - "name": "sourceType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 101, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L101", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 834, - "name": "GitHubGist", - "package": "apify-client", - "qualifiedName": "ActorSourceType.GitHubGist" - }, - "inheritedFrom": { - "type": "reference", - "target": 793, - "name": "BaseActorVersion.sourceType" - } - }, - { - "id": 825, - "name": "versionNumber", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 100, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L100", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 792, - "name": "BaseActorVersion.versionNumber" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 828, - 829, - 827, - 824, - 826, - 825 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 125, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L125", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 791, - "typeArguments": [ - { - "type": "reference", - "target": 834, - "name": "ActorSourceType.GitHubGist", - "package": "apify-client" - } - ], - "name": "BaseActorVersion", - "package": "apify-client" - } - ] - }, - { - "id": 809, - "name": "ActorVersionGitRepo", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 814, - "name": "applyEnvVarsToBuild", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 103, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L103", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 795, - "name": "BaseActorVersion.applyEnvVarsToBuild" - } - }, - { - "id": 815, - "name": "buildTag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 104, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 796, - "name": "BaseActorVersion.buildTag" - } - }, - { - "id": 813, - "name": "envVars", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 102, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L102", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 794, - "name": "BaseActorVersion.envVars" - } - }, - { - "id": 810, - "name": "gitRepoUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 118, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L118", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 812, - "name": "sourceType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 101, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L101", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 832, - "name": "GitRepo", - "package": "apify-client", - "qualifiedName": "ActorSourceType.GitRepo" - }, - "inheritedFrom": { - "type": "reference", - "target": 793, - "name": "BaseActorVersion.sourceType" - } - }, - { - "id": 811, - "name": "versionNumber", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 100, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L100", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 792, - "name": "BaseActorVersion.versionNumber" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 814, - 815, - 813, - 810, - 812, - 811 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 117, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L117", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 791, - "typeArguments": [ - { - "type": "reference", - "target": 832, - "name": "ActorSourceType.GitRepo", - "package": "apify-client" - } - ], - "name": "BaseActorVersion", - "package": "apify-client" - } - ] - }, - { - "id": 805, - "name": "ActorVersionSourceFile", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 808, - "name": "content", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 114, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L114", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 807, - "name": "format", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 113, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L113", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "TEXT" - }, - { - "type": "literal", - "value": "BASE64" - } - ] - } - }, - { - "id": 806, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 112, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L112", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 808, - 807, - 806 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 111, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L111", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 798, - "name": "ActorVersionSourceFiles", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 803, - "name": "applyEnvVarsToBuild", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 103, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L103", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 795, - "name": "BaseActorVersion.applyEnvVarsToBuild" - } - }, - { - "id": 804, - "name": "buildTag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 104, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 796, - "name": "BaseActorVersion.buildTag" - } - }, - { - "id": 802, - "name": "envVars", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 102, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L102", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 794, - "name": "BaseActorVersion.envVars" - } - }, - { - "id": 799, - "name": "sourceFiles", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 108, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L108", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 805, - "name": "ActorVersionSourceFile", - "package": "apify-client" - } - } - }, - { - "id": 801, - "name": "sourceType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 101, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L101", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 831, - "name": "SourceFiles", - "package": "apify-client", - "qualifiedName": "ActorSourceType.SourceFiles" - }, - "inheritedFrom": { - "type": "reference", - "target": 793, - "name": "BaseActorVersion.sourceType" - } - }, - { - "id": 800, - "name": "versionNumber", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 100, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L100", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 792, - "name": "BaseActorVersion.versionNumber" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 803, - 804, - 802, - 799, - 801, - 800 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 107, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L107", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 791, - "typeArguments": [ - { - "type": "reference", - "target": 831, - "name": "ActorSourceType.SourceFiles", - "package": "apify-client" - } - ], - "name": "BaseActorVersion", - "package": "apify-client" - } - ] - }, - { - "id": 816, - "name": "ActorVersionTarball", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 821, - "name": "applyEnvVarsToBuild", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 103, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L103", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 795, - "name": "BaseActorVersion.applyEnvVarsToBuild" - } - }, - { - "id": 822, - "name": "buildTag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 104, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 796, - "name": "BaseActorVersion.buildTag" - } - }, - { - "id": 820, - "name": "envVars", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 102, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L102", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 794, - "name": "BaseActorVersion.envVars" - } - }, - { - "id": 819, - "name": "sourceType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 101, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L101", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 833, - "name": "Tarball", - "package": "apify-client", - "qualifiedName": "ActorSourceType.Tarball" - }, - "inheritedFrom": { - "type": "reference", - "target": 793, - "name": "BaseActorVersion.sourceType" - } - }, - { - "id": 817, - "name": "tarballUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 122, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L122", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 818, - "name": "versionNumber", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 100, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L100", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 792, - "name": "BaseActorVersion.versionNumber" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 821, - 822, - 820, - 819, - 817, - 818 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 121, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L121", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 791, - "typeArguments": [ - { - "type": "reference", - "target": 833, - "name": "ActorSourceType.Tarball", - "package": "apify-client" - } - ], - "name": "BaseActorVersion", - "package": "apify-client" - } - ] - }, - { - "id": 117, - "name": "ApifyClientOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for ApifyClient." - } - ] - }, - "children": [ - { - "id": 118, - "name": "baseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nhttps://api.apify.com\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 570, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L570", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 120, - "name": "maxRetries", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n8\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 574, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L574", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 121, - "name": "minDelayBetweenRetriesMillis", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n500\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 576, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L576", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 119, - "name": "publicBaseUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nhttps://api.apify.com\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 572, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L572", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 122, - "name": "requestInterceptors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n[]\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 578, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L578", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/axios/index.d.cts", - "qualifiedName": "axios.AxiosInterceptorFulfilled" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/http_client.ts", - "qualifiedName": "ApifyRequestConfig" - }, - "name": "ApifyRequestConfig", - "package": "apify-client" - } - ], - "name": "AxiosInterceptorFulfilled", - "package": "axios", - "qualifiedName": "axios.AxiosInterceptorFulfilled" - } - ] - } - } - }, - { - "id": 123, - "name": "timeoutSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\n360\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 580, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L580", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 124, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 581, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L581", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 125, - "name": "userAgentSuffix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 582, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L582", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 118, - 120, - 121, - 119, - 122, - 123, - 124, - 125 - ] - } - ], - "sources": [ - { - "fileName": "src/apify_client.ts", - "line": 568, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/apify_client.ts#L568", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 791, - "name": "BaseActorVersion", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 795, - "name": "applyEnvVarsToBuild", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 103, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L103", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 796, - "name": "buildTag", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 104, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 794, - "name": "envVars", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 102, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L102", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - } - }, - { - "id": 793, - "name": "sourceType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 101, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L101", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 797, - "name": "SourceType", - "package": "apify-client", - "qualifiedName": "BaseActorVersion.SourceType", - "refersToTypeParameter": true - } - }, - { - "id": 792, - "name": "versionNumber", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 100, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L100", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 795, - 796, - 794, - 793, - 792 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 99, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L99", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 797, - "name": "SourceType", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 830, - "name": "ActorSourceType", - "package": "apify-client" - } - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 798, - "name": "ActorVersionSourceFiles" - }, - { - "type": "reference", - "target": 809, - "name": "ActorVersionGitRepo" - }, - { - "type": "reference", - "target": 816, - "name": "ActorVersionTarball" - }, - { - "type": "reference", - "target": 823, - "name": "ActorVersionGitHubGist" - } - ] - }, - { - "id": 998, - "name": "Build", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents an Actor build.\n\nBuilds compile Actor source code and prepare it for execution. Each build has a unique ID\nand can be tagged (e.g., 'latest', 'beta') for easy reference." - } - ] - }, - "children": [ - { - "id": 1000, - "name": "actId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 221, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L221", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1014, - "name": "actorDefinition", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 241, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L241", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 411, - "name": "ActorDefinition", - "package": "apify-client" - } - }, - { - "id": 1010, - "name": "buildNumber", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 237, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L237", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1003, - "name": "finishedAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 224, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L224", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 999, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 220, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L220", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1008, - "name": "inputSchema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "This property is deprecated in favor of " - }, - { - "kind": "code", - "text": "`actorDefinition.input`" - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 232, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L232", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1005, - "name": "meta", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 226, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L226", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 994, - "name": "BuildMeta", - "package": "apify-client" - } - }, - { - "id": 1007, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 228, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L228", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1021, - "name": "BuildOptions", - "package": "apify-client" - } - }, - { - "id": 1009, - "name": "readme", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "This property is deprecated in favor of " - }, - { - "kind": "code", - "text": "`actorDefinition.readme`" - }, - { - "kind": "text", - "text": "." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 236, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L236", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1002, - "name": "startedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 223, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L223", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1006, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 227, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L227", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1017, - "name": "BuildStats", - "package": "apify-client" - } - }, - { - "id": 1004, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 225, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L225", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "SUCCEEDED" - }, - { - "type": "literal", - "value": "FAILED" - }, - { - "type": "literal", - "value": "ABORTED" - }, - { - "type": "literal", - "value": "TIMED-OUT" - } - ] - } - }, - { - "id": 1011, - "name": "usage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 238, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L238", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1015, - "name": "BuildUsage", - "package": "apify-client" - } - }, - { - "id": 1012, - "name": "usageTotalUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 239, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L239", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1013, - "name": "usageUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 240, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L240", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1015, - "name": "BuildUsage", - "package": "apify-client" - } - }, - { - "id": 1001, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 222, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L222", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1000, - 1014, - 1010, - 1003, - 999, - 1008, - 1005, - 1007, - 1009, - 1002, - 1006, - 1004, - 1011, - 1012, - 1013, - 1001 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 219, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L219", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 990, - "name": "BuildClientGetOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for getting a Build." - } - ] - }, - "children": [ - { - "id": 991, - "name": "waitForFinish", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 189, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L189", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 991 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 188, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L188", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 992, - "name": "BuildClientWaitForFinishOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for waiting for a Build to finish." - } - ] - }, - "children": [ - { - "id": 993, - "name": "waitSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time to wait for the build to finish, in seconds.\nIf the limit is reached, the returned promise is resolved to a build object that will have\nstatus " - }, - { - "kind": "code", - "text": "`READY`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`RUNNING`" - }, - { - "kind": "text", - "text": ". If " - }, - { - "kind": "code", - "text": "`waitSecs`" - }, - { - "kind": "text", - "text": " omitted, the function waits indefinitely." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 201, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L201", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 993 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 195, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L195", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1114, - "name": "BuildCollectionClientListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1118, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 1115, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build_collection.ts", - "line": 75, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build_collection.ts#L75", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1117, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 1116, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1118, - 1115, - 1117, - 1116 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build_collection.ts", - "line": 74, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build_collection.ts#L74", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 994, - "name": "BuildMeta", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata about how a Build was initiated." - } - ] - }, - "children": [ - { - "id": 996, - "name": "clientIp", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 209, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L209", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 995, - "name": "origin", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 208, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L208", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 997, - "name": "userAgent", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 210, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L210", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 996, - 995, - 997 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 207, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L207", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1021, - "name": "BuildOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options used for an Actor build." - } - ] - }, - "children": [ - { - "id": 1023, - "name": "betaPackages", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 265, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L265", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1025, - "name": "diskMbytes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 267, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L267", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1024, - "name": "memoryMbytes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 266, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L266", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1022, - "name": "useCache", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 264, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L264", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1023, - 1025, - 1024, - 1022 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 263, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L263", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1017, - "name": "BuildStats", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Runtime statistics for an Actor build." - } - ] - }, - "children": [ - { - "id": 1020, - "name": "computeUnits", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 257, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L257", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1018, - "name": "durationMillis", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 255, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L255", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1019, - "name": "runTimeSecs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 256, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L256", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1020, - 1018, - 1019 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 254, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L254", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1015, - "name": "BuildUsage", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource usage for an Actor build." - } - ] - }, - "children": [ - { - "id": 1016, - "name": "ACTOR_COMPUTE_UNITS", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 248, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L248", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1016 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 247, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L247", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3033, - "name": "Current", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3042, - "name": "activeActorJobCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 299, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L299", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3040, - "name": "actorCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 297, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L297", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3039, - "name": "actorMemoryGbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 296, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L296", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3041, - "name": "actorTaskCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 298, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L298", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3035, - "name": "monthlyActorComputeUnits", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 292, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L292", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3036, - "name": "monthlyExternalDataTransferGbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 293, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L293", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3037, - "name": "monthlyProxySerps", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 294, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L294", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3038, - "name": "monthlyResidentialProxyGbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 295, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L295", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3034, - "name": "monthlyUsageUsd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 291, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L291", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3043, - "name": "teamAccountSeatCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 300, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L300", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3042, - 3040, - 3039, - 3041, - 3035, - 3036, - 3037, - 3038, - 3034, - 3043 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 290, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L290", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1210, - "name": "Dataset", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a dataset storage on the Apify platform.\n\nDatasets store structured data as a sequence of items (records). Each item is a JSON object.\nDatasets are useful for storing results from web scraping, crawling, or data processing tasks." - } - ] - }, - "children": [ - { - "id": 1218, - "name": "accessedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 422, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L422", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1221, - "name": "actId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 425, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L425", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1222, - "name": "actRunId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 426, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L426", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1220, - "name": "cleanItemCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 424, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L424", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1216, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 420, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L420", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1224, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 428, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L428", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1225, - "name": "generalAccess", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 429, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L429", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "STORAGE_GENERAL_ACCESS" - }, - "name": "STORAGE_GENERAL_ACCESS", - "package": "@apify/consts" - } - ] - } - }, - { - "id": 1211, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 415, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L415", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1219, - "name": "itemCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 423, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L423", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1227, - "name": "itemsPublicUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 431, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L431", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1217, - "name": "modifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 421, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L421", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1212, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 416, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L416", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1223, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 427, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L427", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1228, - "name": "DatasetStats", - "package": "apify-client" - } - }, - { - "id": 1213, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 417, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L417", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1226, - "name": "urlSigningSecretKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 430, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L430", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1214, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 418, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L418", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1215, - "name": "username", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 419, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L419", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1218, - 1221, - 1222, - 1220, - 1216, - 1224, - 1225, - 1211, - 1219, - 1227, - 1217, - 1212, - 1223, - 1213, - 1226, - 1214, - 1215 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 414, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L414", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1251, - "name": "DatasetClientCreateItemsUrlOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for creating a public URL to access dataset items.\n\nExtends " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "DatasetClientListItemOptions", - "target": 1237 - }, - { - "kind": "text", - "text": " with URL expiration control." - } - ] - }, - "children": [ - { - "id": 1265, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1250, - "name": "DatasetClientListItemOptions.chunkSize" - } - }, - { - "id": 1253, - "name": "clean", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 460, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L460", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 1238, - "name": "DatasetClientListItemOptions.clean" - } - }, - { - "id": 1254, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 461, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L461", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 1239, - "name": "DatasetClientListItemOptions.desc" - } - }, - { - "id": 1252, - "name": "expiresInSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 478, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L478", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1256, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 463, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L463", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1241, - "name": "DatasetClientListItemOptions.fields" - } - }, - { - "id": 1255, - "name": "flatten", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 462, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L462", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1240, - "name": "DatasetClientListItemOptions.flatten" - } - }, - { - "id": 1264, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1249, - "name": "DatasetClientListItemOptions.limit" - } - }, - { - "id": 1263, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1248, - "name": "DatasetClientListItemOptions.offset" - } - }, - { - "id": 1257, - "name": "omit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 464, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L464", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1242, - "name": "DatasetClientListItemOptions.omit" - } - }, - { - "id": 1262, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 469, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L469", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1247, - "name": "DatasetClientListItemOptions.signature" - } - }, - { - "id": 1258, - "name": "skipEmpty", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 465, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L465", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 1243, - "name": "DatasetClientListItemOptions.skipEmpty" - } - }, - { - "id": 1259, - "name": "skipHidden", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 466, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L466", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 1244, - "name": "DatasetClientListItemOptions.skipHidden" - } - }, - { - "id": 1260, - "name": "unwind", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 467, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L467", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1245, - "name": "DatasetClientListItemOptions.unwind" - } - }, - { - "id": 1261, - "name": "view", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 468, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L468", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1246, - "name": "DatasetClientListItemOptions.view" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1265, - 1253, - 1254, - 1252, - 1256, - 1255, - 1264, - 1263, - 1257, - 1262, - 1258, - 1259, - 1260, - 1261 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 477, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L477", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1237, - "name": "DatasetClientListItemOptions", - "package": "apify-client" - } - ] - }, - { - "id": 1274, - "name": "DatasetClientDownloadItemsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for downloading dataset items in a specific format.\n\nExtends " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "DatasetClientListItemOptions", - "target": 1237 - }, - { - "kind": "text", - "text": " with format-specific options." - } - ] - }, - "children": [ - { - "id": 1275, - "name": "attachment", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 502, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L502", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1276, - "name": "bom", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 503, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L503", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1293, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1250, - "name": "DatasetClientListItemOptions.chunkSize" - } - }, - { - "id": 1281, - "name": "clean", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 460, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L460", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 1238, - "name": "DatasetClientListItemOptions.clean" - } - }, - { - "id": 1277, - "name": "delimiter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 504, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L504", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1282, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 461, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L461", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 1239, - "name": "DatasetClientListItemOptions.desc" - } - }, - { - "id": 1284, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 463, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L463", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1241, - "name": "DatasetClientListItemOptions.fields" - } - }, - { - "id": 1283, - "name": "flatten", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 462, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L462", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1240, - "name": "DatasetClientListItemOptions.flatten" - } - }, - { - "id": 1292, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1249, - "name": "DatasetClientListItemOptions.limit" - } - }, - { - "id": 1291, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1248, - "name": "DatasetClientListItemOptions.offset" - } - }, - { - "id": 1285, - "name": "omit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 464, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L464", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 1242, - "name": "DatasetClientListItemOptions.omit" - } - }, - { - "id": 1290, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 469, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L469", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1247, - "name": "DatasetClientListItemOptions.signature" - } - }, - { - "id": 1286, - "name": "skipEmpty", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 465, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L465", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 1243, - "name": "DatasetClientListItemOptions.skipEmpty" - } - }, - { - "id": 1278, - "name": "skipHeaderRow", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 505, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L505", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1287, - "name": "skipHidden", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 466, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L466", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 1244, - "name": "DatasetClientListItemOptions.skipHidden" - } - }, - { - "id": 1288, - "name": "unwind", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 467, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L467", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1245, - "name": "DatasetClientListItemOptions.unwind" - } - }, - { - "id": 1289, - "name": "view", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 468, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L468", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1246, - "name": "DatasetClientListItemOptions.view" - } - }, - { - "id": 1279, - "name": "xmlRoot", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 506, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L506", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1280, - "name": "xmlRow", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 507, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L507", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1275, - 1276, - 1293, - 1281, - 1277, - 1282, - 1284, - 1283, - 1292, - 1291, - 1285, - 1290, - 1286, - 1278, - 1287, - 1288, - 1289, - 1279, - 1280 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 501, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L501", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1237, - "name": "DatasetClientListItemOptions", - "package": "apify-client" - } - ] - }, - { - "id": 1237, - "name": "DatasetClientListItemOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing items from a dataset.\n\nProvides various filtering, pagination, and transformation options to customize\nthe output format and content of retrieved items." - } - ] - }, - "children": [ - { - "id": 1250, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 1238, - "name": "clean", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 460, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L460", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1239, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 461, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L461", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1241, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 463, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L463", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1240, - "name": "flatten", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 462, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L462", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1249, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 1248, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - }, - { - "id": 1242, - "name": "omit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 464, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L464", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1247, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 469, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L469", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1243, - "name": "skipEmpty", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 465, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L465", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1244, - "name": "skipHidden", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 466, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L466", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1245, - "name": "unwind", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 467, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L467", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1246, - "name": "view", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 468, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L468", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1250, - 1238, - 1239, - 1241, - 1240, - 1249, - 1248, - 1242, - 1247, - 1243, - 1244, - 1245, - 1246 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 459, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L459", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1251, - "name": "DatasetClientCreateItemsUrlOptions" - }, - { - "type": "reference", - "target": 1274, - "name": "DatasetClientDownloadItemsOptions" - } - ] - }, - { - "id": 1233, - "name": "DatasetClientUpdateOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for updating a dataset." - } - ] - }, - "children": [ - { - "id": 1236, - "name": "generalAccess", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 450, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L450", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "STORAGE_GENERAL_ACCESS" - }, - "name": "STORAGE_GENERAL_ACCESS", - "package": "@apify/consts" - } - ] - } - }, - { - "id": 1234, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 448, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L448", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1235, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 449, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L449", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1236, - 1234, - 1235 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 447, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L447", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1377, - "name": "DatasetCollectionClientGetOrCreateOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1378, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 102, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L102", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1378 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 101, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L101", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1370, - "name": "DatasetCollectionClientListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1376, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 1372, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 96, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L96", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1375, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 1374, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - }, - { - "id": 1373, - "name": "ownership", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership: 'ownedByMe' returns only user's own datasets, 'sharedWithMe' returns only shared datasets." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 98, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L98", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "STORAGE_OWNERSHIP_FILTER" - }, - "name": "STORAGE_OWNERSHIP_FILTER", - "package": "@apify/consts" - } - }, - { - "id": 1371, - "name": "unnamed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 95, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L95", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1376, - 1372, - 1375, - 1374, - 1373, - 1371 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 94, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L94", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 1294, - "name": "DatasetStatistics", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistical information about dataset fields.\n\nProvides insights into the data structure and content of the dataset." - } - ] - }, - "children": [ - { - "id": 1295, - "name": "fieldStatistics", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 516, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L516", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1296, - "name": "FieldStatistics", - "package": "apify-client" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1295 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 515, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L515", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1228, - "name": "DatasetStats", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics about dataset usage and storage." - } - ] - }, - "children": [ - { - "id": 1231, - "name": "deleteCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 440, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L440", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1229, - "name": "readCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 438, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L438", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1232, - "name": "storageBytes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 441, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L441", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1230, - "name": "writeCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 439, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L439", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1231, - 1229, - 1232, - 1230 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 437, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L437", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1296, - "name": "FieldStatistics", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics for a single field in a dataset." - } - ] - }, - "children": [ - { - "id": 1300, - "name": "emptyCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 526, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L526", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1298, - "name": "max", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 524, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L524", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1297, - "name": "min", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 523, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L523", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1299, - "name": "nullCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 525, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L525", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1300, - 1298, - 1297, - 1299 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset.ts", - "line": 522, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset.ts#L522", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 437, - "name": "FlatPricePerMonthActorPricingInfo", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pricing information for Actors with a flat monthly subscription fee." - } - ] - }, - "children": [ - { - "id": 441, - "name": "apifyMarginPercentage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 885, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L885", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.apifyMarginPercentage" - } - }, - { - "id": 442, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When this pricing info record has been created" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 887, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L887", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.createdAt" - } - }, - { - "id": 445, - "name": "notifiedAboutChangeAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 891, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L891", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.notifiedAboutChangeAt" - } - }, - { - "id": 444, - "name": "notifiedAboutFutureChangeAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 890, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L890", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.notifiedAboutFutureChangeAt" - } - }, - { - "id": 440, - "name": "pricePerUnitUsd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Monthly flat price in USD" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 910, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L910", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 438, - "name": "pricingModel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 906, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L906", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "FLAT_PRICE_PER_MONTH" - } - }, - { - "id": 446, - "name": "reasonForChange", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 892, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L892", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.reasonForChange" - } - }, - { - "id": 443, - "name": "startedAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Since when is this pricing info record effective for a given Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 889, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L889", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.startedAt" - } - }, - { - "id": 439, - "name": "trialMinutes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "For how long this Actor can be used for free in trial period" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 908, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L908", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 441, - 442, - 445, - 444, - 440, - 438, - 446, - 443, - 439 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 905, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L905", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo" - }, - "name": "CommonActorPricingInfo", - "package": "apify-client" - } - ] - }, - { - "id": 429, - "name": "FreeActorPricingInfo", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pricing information for free Actors." - } - ] - }, - "children": [ - { - "id": 431, - "name": "apifyMarginPercentage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 885, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L885", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.apifyMarginPercentage" - } - }, - { - "id": 432, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When this pricing info record has been created" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 887, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L887", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.createdAt" - } - }, - { - "id": 435, - "name": "notifiedAboutChangeAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 891, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L891", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.notifiedAboutChangeAt" - } - }, - { - "id": 434, - "name": "notifiedAboutFutureChangeAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 890, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L890", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.notifiedAboutFutureChangeAt" - } - }, - { - "id": 430, - "name": "pricingModel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 899, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L899", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "FREE" - } - }, - { - "id": 436, - "name": "reasonForChange", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 892, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L892", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.reasonForChange" - } - }, - { - "id": 433, - "name": "startedAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Since when is this pricing info record effective for a given Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 889, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L889", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.startedAt" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 431, - 432, - 435, - 434, - 430, - 436, - 433 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 898, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L898", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo" - }, - "name": "CommonActorPricingInfo", - "package": "apify-client" - } - ] - }, - { - "id": 2290, - "name": "GetStreamedLogOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for getting a streamed log." - } - ] - }, - "children": [ - { - "id": 2292, - "name": "fromStart", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 478, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L478", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2291, - "name": "toLog", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 477, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L477", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Log" - }, - "name": "Log", - "package": "@apify/log" - }, - { - "type": "literal", - "value": "default" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2292, - 2291 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 476, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L476", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1507, - "name": "KeyValueClientCreateKeysUrlOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for creating a public URL to list keys in a Key-Value Store.\n\nExtends " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "KeyValueClientListKeysOptions", - "target": 1501 - }, - { - "kind": "text", - "text": " with URL expiration control." - } - ] - }, - "children": [ - { - "id": 1511, - "name": "collection", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 558, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L558", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1504, - "name": "KeyValueClientListKeysOptions.collection" - } - }, - { - "id": 1510, - "name": "exclusiveStartKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 557, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L557", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1503, - "name": "KeyValueClientListKeysOptions.exclusiveStartKey" - } - }, - { - "id": 1508, - "name": "expiresInSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 569, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L569", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1509, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 556, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L556", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1502, - "name": "KeyValueClientListKeysOptions.limit" - } - }, - { - "id": 1512, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 559, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L559", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1505, - "name": "KeyValueClientListKeysOptions.prefix" - } - }, - { - "id": 1513, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 560, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L560", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1506, - "name": "KeyValueClientListKeysOptions.signature" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1511, - 1510, - 1508, - 1509, - 1512, - 1513 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 568, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L568", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1501, - "name": "KeyValueClientListKeysOptions", - "package": "apify-client" - } - ] - }, - { - "id": 1525, - "name": "KeyValueClientGetRecordOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for retrieving a record from a Key-Value Store." - } - ] - }, - "children": [ - { - "id": 1526, - "name": "buffer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 599, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L599", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1528, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 601, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L601", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1527, - "name": "stream", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 600, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L600", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1526, - 1528, - 1527 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 598, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L598", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1501, - "name": "KeyValueClientListKeysOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing keys in a Key-Value Store." - } - ] - }, - "children": [ - { - "id": 1504, - "name": "collection", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 558, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L558", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1503, - "name": "exclusiveStartKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 557, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L557", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1502, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 556, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L556", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1505, - "name": "prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 559, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L559", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1506, - "name": "signature", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 560, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L560", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1504, - 1503, - 1502, - 1505, - 1506 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 555, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L555", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1507, - "name": "KeyValueClientCreateKeysUrlOptions" - } - ] - }, - { - "id": 1514, - "name": "KeyValueClientListKeysResult", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of listing keys in a Key-Value Store.\n\nContains paginated list of keys with metadata and pagination information." - } - ] - }, - "children": [ - { - "id": 1515, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 578, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L578", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1517, - "name": "exclusiveStartKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 580, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L580", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1518, - "name": "isTruncated", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 581, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L581", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1520, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 583, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L583", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1521, - "name": "KeyValueListItem", - "package": "apify-client" - } - } - }, - { - "id": 1516, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 579, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L579", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1519, - "name": "nextExclusiveStartKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 582, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L582", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1515, - 1517, - 1518, - 1520, - 1516, - 1519 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 577, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L577", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1497, - "name": "KeyValueClientUpdateOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for updating a Key-Value Store." - } - ] - }, - "children": [ - { - "id": 1500, - "name": "generalAccess", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 549, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L549", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "STORAGE_GENERAL_ACCESS" - }, - "name": "STORAGE_GENERAL_ACCESS", - "package": "@apify/consts" - } - ] - } - }, - { - "id": 1498, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 547, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L547", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1499, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 548, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L548", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1500, - 1498, - 1499 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 546, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L546", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1521, - "name": "KeyValueListItem", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata about a single key in a Key-Value Store." - } - ] - }, - "children": [ - { - "id": 1522, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 590, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L590", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1524, - "name": "recordPublicUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 592, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L592", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1523, - "name": "size", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 591, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L591", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1522, - 1524, - 1523 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 589, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L589", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1476, - "name": "KeyValueStore", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a Key-Value Store storage on the Apify platform.\n\nKey-value stores are used to store arbitrary data records or files. Each record is identified\nby a unique key and can contain any data - JSON objects, strings, binary files, etc." - } - ] - }, - "children": [ - { - "id": 1484, - "name": "accessedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 523, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L523", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1485, - "name": "actId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 524, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L524", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1486, - "name": "actRunId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 525, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L525", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1482, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 521, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L521", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1488, - "name": "generalAccess", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 527, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L527", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "STORAGE_GENERAL_ACCESS" - }, - "name": "STORAGE_GENERAL_ACCESS", - "package": "@apify/consts" - } - ] - } - }, - { - "id": 1477, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 516, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L516", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1490, - "name": "keysPublicUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 529, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L529", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1483, - "name": "modifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 522, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L522", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1478, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 517, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L517", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1487, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 526, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L526", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1491, - "name": "KeyValueStoreStats", - "package": "apify-client" - } - }, - { - "id": 1479, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 518, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L518", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1489, - "name": "urlSigningSecretKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 528, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L528", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1480, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 519, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L519", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1481, - "name": "username", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 520, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L520", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1484, - 1485, - 1486, - 1482, - 1488, - 1477, - 1490, - 1483, - 1478, - 1487, - 1479, - 1489, - 1480, - 1481 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 515, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L515", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1615, - "name": "KeyValueStoreCollectionClientGetOrCreateOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1616, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 105, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L105", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1616 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 104, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1608, - "name": "KeyValueStoreCollectionClientListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1614, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 1610, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 99, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L99", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1613, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 1612, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - }, - { - "id": 1611, - "name": "ownership", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership: 'ownedByMe' returns only user's own key-value stores, 'sharedWithMe' returns only shared key-value stores." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 101, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L101", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "STORAGE_OWNERSHIP_FILTER" - }, - "name": "STORAGE_OWNERSHIP_FILTER", - "package": "@apify/consts" - } - }, - { - "id": 1609, - "name": "unnamed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 98, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L98", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1614, - 1610, - 1613, - 1612, - 1611, - 1609 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 97, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L97", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 1529, - "name": "KeyValueStoreRecord", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a record (key-value pair) in a Key-Value Store." - } - ] - }, - "children": [ - { - "id": 1532, - "name": "contentType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 612, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L612", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1530, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 610, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L610", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1531, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 611, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L611", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1533, - "name": "T", - "package": "apify-client", - "qualifiedName": "KeyValueStoreRecord.T", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1532, - 1530, - 1531 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 609, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L609", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1533, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the record's value" - } - ] - } - } - ] - }, - { - "id": 1534, - "name": "KeyValueStoreRecordOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for storing a record in a Key-Value Store." - } - ] - }, - "children": [ - { - "id": 1536, - "name": "doNotRetryTimeouts", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 620, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L620", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1535, - "name": "timeoutSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 619, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L619", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1536, - 1535 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 618, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L618", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1491, - "name": "KeyValueStoreStats", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics about Key-Value Store usage and storage." - } - ] - }, - "children": [ - { - "id": 1494, - "name": "deleteCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 538, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L538", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1495, - "name": "listCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 539, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L539", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1492, - "name": "readCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 536, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L536", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1496, - "name": "storageBytes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 540, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L540", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1493, - "name": "writeCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 537, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L537", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1494, - 1495, - 1492, - 1496, - 1493 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 535, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L535", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3016, - "name": "Limits", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3027, - "name": "dataRetentionDays", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 285, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L285", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3023, - "name": "maxActorCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 281, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L281", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3022, - "name": "maxActorMemoryGbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 280, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L280", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3024, - "name": "maxActorTaskCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 282, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L282", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3025, - "name": "maxConcurrentActorJobs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 283, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L283", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3018, - "name": "maxMonthlyActorComputeUnits", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 276, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L276", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3019, - "name": "maxMonthlyExternalDataTransferGbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 277, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L277", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3020, - "name": "maxMonthlyProxySerps", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 278, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L278", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3021, - "name": "maxMonthlyResidentialProxyGbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 279, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L279", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3017, - "name": "maxMonthlyUsageUsd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 275, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L275", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3026, - "name": "maxTeamAccountSeatCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 284, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L284", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3027, - 3023, - 3022, - 3024, - 3025, - 3018, - 3019, - 3020, - 3021, - 3017, - 3026 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 274, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L274", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1687, - "name": "LogOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1688, - "name": "raw", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@default", - "content": [ - { - "kind": "code", - "text": "```ts\nfalse\n```" - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 107, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L107", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1688 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 105, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L105", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2997, - "name": "MonthlyUsage", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3003, - "name": "dailyServiceUsages", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 220, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L220", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "DailyServiceUsage" - }, - "name": "DailyServiceUsage", - "package": "apify-client" - } - } - }, - { - "id": 2999, - "name": "monthlyServiceUsage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 219, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L219", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3000, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 219, - "character": 25, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L219", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "indexSignatures": [ - { - "id": 3001, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 219, - "character": 27, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L219", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 3002, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyServiceUsageData" - }, - "name": "MonthlyServiceUsageData", - "package": "apify-client" - } - } - ] - } - } - }, - { - "id": 3005, - "name": "totalUsageCreditsUsdAfterVolumeDiscount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 222, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L222", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3004, - "name": "totalUsageCreditsUsdBeforeVolumeDiscount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 221, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L221", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2998, - "name": "usageCycle", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 218, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L218", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3006, - "name": "UsageCycle", - "package": "apify-client" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3003, - 2999, - 3005, - 3004, - 2998 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 217, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L217", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3013, - "name": "MonthlyUsageCycle", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3015, - "name": "endAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 271, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L271", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 3014, - "name": "startAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 270, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L270", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3015, - 3014 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 269, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L269", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1026, - "name": "OpenApiDefinition", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "OpenAPI specification for an Actor.\n\nDefines the Actor's API interface in OpenAPI 3.0 format, useful for integration\nwith tools like ChatGPT plugins and other API consumers." - } - ] - }, - "children": [ - { - "id": 1043, - "name": "components", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 286, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L286", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1044, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1045, - "name": "schemas", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 287, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L287", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1046, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 287, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L287", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "indexSignatures": [ - { - "id": 1047, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 288, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L288", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1048, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "object" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1045 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 286, - "character": 16, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L286", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - }, - { - "id": 1028, - "name": "info", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 278, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L278", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1029, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1031, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 280, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L280", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1030, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 279, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L279", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1032, - "name": "version", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 281, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L281", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1033, - "name": "x-build-id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 282, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L282", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1031, - 1030, - 1032, - 1033 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 278, - "character": 10, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L278", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - }, - { - "id": 1027, - "name": "openapi", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 277, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L277", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1037, - "name": "paths", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 285, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L285", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 285, - "character": 11, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L285", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "indexSignatures": [ - { - "id": 1039, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 285, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L285", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "parameters": [ - { - "id": 1040, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1041, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1042, - "name": "post", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 285, - "character": 30, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L285", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "OpenApiOperation" - }, - "name": "OpenApiOperation", - "package": "apify-client" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1042 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 285, - "character": 28, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L285", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - } - ] - } - } - }, - { - "id": 1034, - "name": "servers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 284, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L284", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1035, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1036, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 284, - "character": 15, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L284", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1036 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 284, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L284", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1043, - 1028, - 1027, - 1037, - 1034 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/build.ts", - "line": 276, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build.ts#L276", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 26, - "name": "PaginatedList", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Paginated list with detailed pagination information.\n\nUsed primarily for Dataset items and other list operations that support\noffset-based pagination and field transformations." - } - ] - }, - "children": [ - { - "id": 27, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Count of dataset entries returned in this set." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 293, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L293", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 30, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Should the results be in descending order." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 299, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L299", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 32, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Entries." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 280, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L280", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 33, - "name": "Data", - "package": "apify-client", - "qualifiedName": "PaginatedList.Data", - "refersToTypeParameter": true - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginatedResponse.items" - } - }, - { - "id": 29, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of dataset entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 297, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L297", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 28, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry in the dataset." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 295, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L295", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 31, - "name": "total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Total count of entries." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 278, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L278", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginatedResponse.total" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 27, - 30, - 32, - 29, - 28, - 31 - ] - } - ], - "sources": [ - { - "fileName": "src/utils.ts", - "line": 291, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L291", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 33, - "name": "Data", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of items in the list" - } - ] - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedResponse" - }, - "typeArguments": [ - { - "type": "reference", - "target": 33, - "name": "Data", - "package": "apify-client", - "qualifiedName": "PaginatedList.Data", - "refersToTypeParameter": true - } - ], - "name": "PaginatedResponse", - "package": "apify-client" - } - ] - }, - { - "id": 447, - "name": "PricePerDatasetItemActorPricingInfo", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pricing information for pay-per-result Actors.\n\nThese Actors charge based on the number of items saved to the dataset." - } - ] - }, - "children": [ - { - "id": 451, - "name": "apifyMarginPercentage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 885, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L885", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.apifyMarginPercentage" - } - }, - { - "id": 452, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When this pricing info record has been created" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 887, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L887", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.createdAt" - } - }, - { - "id": 455, - "name": "notifiedAboutChangeAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 891, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L891", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.notifiedAboutChangeAt" - } - }, - { - "id": 454, - "name": "notifiedAboutFutureChangeAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 890, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L890", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.notifiedAboutFutureChangeAt" - } - }, - { - "id": 450, - "name": "pricePerUnitUsd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 922, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L922", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 448, - "name": "pricingModel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 919, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L919", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "PRICE_PER_DATASET_ITEM" - } - }, - { - "id": 456, - "name": "reasonForChange", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 892, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L892", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.reasonForChange" - } - }, - { - "id": 453, - "name": "startedAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Since when is this pricing info record effective for a given Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 889, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L889", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.startedAt" - } - }, - { - "id": 449, - "name": "unitName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the unit that is being charged" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 921, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L921", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 451, - 452, - 455, - 454, - 450, - 448, - 456, - 453, - 449 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 918, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L918", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo" - }, - "name": "CommonActorPricingInfo", - "package": "apify-client" - } - ] - }, - { - "id": 462, - "name": "PricePerEventActorPricingInfo", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pricing information for pay-per-event Actors.\n\nThese Actors charge based on specific events (e.g., emails sent, API calls made)." - } - ] - }, - "children": [ - { - "id": 468, - "name": "apifyMarginPercentage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "In [0, 1], fraction of pricePerUnitUsd that goes to Apify" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 885, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L885", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.apifyMarginPercentage" - } - }, - { - "id": 469, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When this pricing info record has been created" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 887, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L887", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.createdAt" - } - }, - { - "id": 467, - "name": "minimalMaxTotalChargeUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 949, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L949", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 472, - "name": "notifiedAboutChangeAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 891, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L891", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.notifiedAboutChangeAt" - } - }, - { - "id": 471, - "name": "notifiedAboutFutureChangeAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 890, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L890", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.notifiedAboutFutureChangeAt" - } - }, - { - "id": 463, - "name": "pricingModel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 945, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L945", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "literal", - "value": "PAY_PER_EVENT" - } - }, - { - "id": 464, - "name": "pricingPerEvent", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 946, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L946", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 465, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 466, - "name": "actorChargeEvents", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 947, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L947", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 461, - "name": "ActorChargeEvents", - "package": "apify-client" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 466 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 946, - "character": 21, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L946", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - }, - { - "id": 473, - "name": "reasonForChange", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 892, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L892", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.reasonForChange" - } - }, - { - "id": 470, - "name": "startedAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Since when is this pricing info record effective for a given Actor" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 889, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L889", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "CommonActorPricingInfo.startedAt" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 468, - 469, - 467, - 472, - 471, - 463, - 464, - 473, - 470 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 944, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L944", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo" - }, - "name": "CommonActorPricingInfo", - "package": "apify-client" - } - ] - }, - { - "id": 2646, - "name": "PricingInfo", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2647, - "name": "pricingModel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 79, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L79", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2647 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 78, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L78", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2964, - "name": "ProxyGroup", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2967, - "name": "availableCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 156, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L156", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2966, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 155, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L155", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2965, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 154, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L154", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2967, - 2966, - 2965 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 153, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L153", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2001, - "name": "RequestQueue", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a Request Queue storage on the Apify platform.\n\nRequest queues store URLs (requests) to be processed by web crawlers. They provide\nautomatic deduplication, request locking for parallel processing, and persistence." - } - ] - }, - "children": [ - { - "id": 2009, - "name": "accessedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 841, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L841", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 2014, - "name": "actId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 846, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L846", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2015, - "name": "actRunId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 847, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L847", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2007, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 839, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L839", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 2010, - "name": "expireAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 842, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L842", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2018, - "name": "generalAccess", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 850, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L850", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "STORAGE_GENERAL_ACCESS" - }, - "name": "STORAGE_GENERAL_ACCESS", - "package": "@apify/consts" - } - ] - } - }, - { - "id": 2016, - "name": "hadMultipleClients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 848, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L848", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2012, - "name": "handledRequestCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 844, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L844", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2002, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 834, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L834", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2008, - "name": "modifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 840, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L840", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 2003, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 835, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L835", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2013, - "name": "pendingRequestCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 845, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L845", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2017, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 849, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L849", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2019, - "name": "RequestQueueStats", - "package": "apify-client" - } - }, - { - "id": 2004, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 836, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L836", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2011, - "name": "totalRequestCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 843, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L843", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2005, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 837, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L837", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2006, - "name": "username", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 838, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L838", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2009, - 2014, - 2015, - 2007, - 2010, - 2018, - 2016, - 2012, - 2002, - 2008, - 2003, - 2013, - 2017, - 2004, - 2011, - 2005, - 2006 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 833, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L833", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2072, - "name": "RequestQueueClientAddRequestOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2073, - "name": "forefront", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 962, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L962", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2073 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 961, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L961", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2099, - "name": "RequestQueueClientAddRequestResult", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of adding a request to the queue." - } - ] - }, - "children": [ - { - "id": 2100, - "name": "requestId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1009, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1009", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2102, - "name": "wasAlreadyHandled", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1011, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1011", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2101, - "name": "wasAlreadyPresent", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1010, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1010", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2100, - 2102, - 2101 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1008, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1008", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2081, - "name": "RequestQueueClientBatchAddRequestWithRetriesOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2082, - "name": "forefront", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 979, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L979", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2084, - "name": "maxParallel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 981, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L981", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2083, - "name": "maxUnprocessedRequestsRetries", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 980, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L980", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2085, - "name": "minDelayBetweenUnprocessedRequestsRetriesMillis", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 982, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L982", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2082, - 2084, - 2083, - 2085 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 978, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L978", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2105, - "name": "RequestQueueClientBatchRequestsOperationResult", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of a batch operation on requests.\n\nContains lists of successfully processed and unprocessed requests." - } - ] - }, - "children": [ - { - "id": 2106, - "name": "processedRequests", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1037, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1037", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "ProcessedRequest" - }, - "name": "ProcessedRequest", - "package": "apify-client" - } - } - }, - { - "id": 2107, - "name": "unprocessedRequests", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1038, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1038", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "UnprocessedRequest" - }, - "name": "UnprocessedRequest", - "package": "apify-client" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2106, - 2107 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1036, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1036", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2077, - "name": "RequestQueueClientDeleteRequestLockOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2078, - "name": "forefront", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 971, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L971", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2078 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 970, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L970", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2054, - "name": "RequestQueueClientListAndLockHeadOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing and locking requests from the queue head." - } - ] - }, - "children": [ - { - "id": 2056, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 935, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L935", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2055, - "name": "lockSecs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 934, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L934", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2056, - 2055 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 933, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L933", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2057, - "name": "RequestQueueClientListAndLockHeadResult", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of listing and locking requests from the queue head.\n\nExtends " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "RequestQueueClientListHeadResult", - "target": 2031 - }, - { - "kind": "text", - "text": " with lock information." - } - ] - }, - "children": [ - { - "id": 2060, - "name": "clientKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 946, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L946", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2063, - "name": "hadMultipleClients", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 886, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L886", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 2034, - "name": "RequestQueueClientListHeadResult.hadMultipleClients" - } - }, - { - "id": 2064, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 887, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L887", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2065, - "name": "RequestQueueClientListItem", - "package": "apify-client" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 2035, - "name": "RequestQueueClientListHeadResult.items" - } - }, - { - "id": 2061, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 884, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L884", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 2032, - "name": "RequestQueueClientListHeadResult.limit" - } - }, - { - "id": 2058, - "name": "lockSecs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 944, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L944", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2059, - "name": "queueHasLockedRequests", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 945, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L945", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2062, - "name": "queueModifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 885, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L885", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 2033, - "name": "RequestQueueClientListHeadResult.queueModifiedAt" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2060, - 2063, - 2064, - 2061, - 2058, - 2059, - 2062 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 943, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L943", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2031, - "name": "RequestQueueClientListHeadResult", - "package": "apify-client" - } - ] - }, - { - "id": 2029, - "name": "RequestQueueClientListHeadOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing requests from the queue head." - } - ] - }, - "children": [ - { - "id": 2030, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 877, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L877", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2030 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 876, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L876", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2031, - "name": "RequestQueueClientListHeadResult", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of listing requests from the queue head." - } - ] - }, - "children": [ - { - "id": 2034, - "name": "hadMultipleClients", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 886, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L886", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2035, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 887, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L887", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2065, - "name": "RequestQueueClientListItem", - "package": "apify-client" - } - } - }, - { - "id": 2032, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 884, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L884", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2033, - "name": "queueModifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 885, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L885", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2034, - 2035, - 2032, - 2033 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 883, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L883", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2057, - "name": "RequestQueueClientListAndLockHeadResult" - } - ] - }, - { - "id": 2065, - "name": "RequestQueueClientListItem", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Simplified request information used in list results." - } - ] - }, - "children": [ - { - "id": 2066, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 953, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L953", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2071, - "name": "lockExpiresAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 958, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L958", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 2070, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 957, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L957", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2110, - "name": "AllowedHttpMethods", - "package": "apify-client" - } - }, - { - "id": 2067, - "name": "retryCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 954, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L954", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2068, - "name": "uniqueKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 955, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L955", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2069, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 956, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L956", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2066, - 2071, - 2070, - 2067, - 2068, - 2069 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 952, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L952", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2037, - "name": "RequestQueueClientListRequestsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for listing all requests in the queue." - } - ] - }, - "children": [ - { - "id": 2040, - "name": "cursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 902, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L902", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2039, - "name": "exclusiveStartId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Using id of request that does not exist in request queue leads to unpredictable results." - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`cursor`" - }, - { - "kind": "text", - "text": " for pagination instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 901, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L901", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2041, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 903, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L903", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2036, - "name": "RequestQueueListRequestsFilter", - "package": "apify-client" - } - } - } - }, - { - "id": 2038, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 896, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L896", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2040, - 2039, - 2041, - 2038 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 895, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L895", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2048, - "name": "RequestQueueClientListRequestsResult", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Result of listing all requests in the queue." - } - ] - }, - "children": [ - { - "id": 2051, - "name": "cursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 925, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L925", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2050, - "name": "exclusiveStartId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`cursor`" - }, - { - "kind": "text", - "text": " for pagination instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 924, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L924", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2053, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 927, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L927", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2086, - "name": "RequestQueueClientRequestSchema", - "package": "apify-client" - } - } - }, - { - "id": 2049, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 922, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L922", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2052, - "name": "nextCursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 926, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L926", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2051, - 2050, - 2053, - 2049, - 2052 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 921, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L921", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2042, - "name": "RequestQueueClientPaginateRequestsOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for paginating through requests in the queue." - } - ] - }, - "children": [ - { - "id": 2046, - "name": "cursor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 914, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L914", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2045, - "name": "exclusiveStartId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "Use " - }, - { - "kind": "code", - "text": "`cursor`" - }, - { - "kind": "text", - "text": " for pagination instead." - } - ] - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 913, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L913", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2047, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 915, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L915", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2036, - "name": "RequestQueueListRequestsFilter", - "package": "apify-client" - } - } - } - }, - { - "id": 2043, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 910, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L910", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2044, - "name": "maxPageLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 911, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L911", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2046, - 2045, - 2047, - 2043, - 2044 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 909, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L909", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2074, - "name": "RequestQueueClientProlongRequestLockOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2075, - "name": "forefront", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 966, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L966", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2076, - "name": "lockSecs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 967, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L967", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2075, - 2076 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 965, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L965", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2079, - "name": "RequestQueueClientProlongRequestLockResult", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2080, - "name": "lockExpiresAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 975, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L975", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2080 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 974, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L974", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2086, - "name": "RequestQueueClientRequestSchema", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Complete schema for a request in the queue.\n\nRepresents a URL to be crawled along with its metadata, retry information, and custom data." - } - ] - }, - "children": [ - { - "id": 2093, - "name": "errorMessages", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 997, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L997", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2096, - "name": "handledAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1000, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1000", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2094, - "name": "headers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 998, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L998", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2087, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 991, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L991", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2098, - "name": "loadedUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1002, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1002", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2090, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 994, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L994", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2110, - "name": "AllowedHttpMethods", - "package": "apify-client" - } - }, - { - "id": 2097, - "name": "noRetry", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1001, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1001", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2091, - "name": "payload", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 995, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L995", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2092, - "name": "retryCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 996, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L996", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2088, - "name": "uniqueKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 992, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L992", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2089, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 993, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L993", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2095, - "name": "userData", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 999, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L999", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2093, - 2096, - 2094, - 2087, - 2098, - 2090, - 2097, - 2091, - 2092, - 2088, - 2089, - 2095 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 990, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L990", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2103, - "name": "RequestQueueClientUnlockRequestsResult", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2104, - "name": "unlockedCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1028, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1028", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2104 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1027, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1027", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2025, - "name": "RequestQueueClientUpdateOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for updating a Request Queue." - } - ] - }, - "children": [ - { - "id": 2028, - "name": "generalAccess", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 870, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L870", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "STORAGE_GENERAL_ACCESS" - }, - "name": "STORAGE_GENERAL_ACCESS", - "package": "@apify/consts" - } - ] - } - }, - { - "id": 2026, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 868, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L868", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 2027, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 869, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L869", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2028, - 2026, - 2027 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 867, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L867", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2181, - "name": "RequestQueueCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2187, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 2183, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 94, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L94", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2186, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 2185, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - }, - { - "id": 2184, - "name": "ownership", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter by ownership: 'ownedByMe' returns only user's own request queues, 'sharedWithMe' returns only shared request queues." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 96, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L96", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "STORAGE_OWNERSHIP_FILTER" - }, - "name": "STORAGE_OWNERSHIP_FILTER", - "package": "@apify/consts" - } - }, - { - "id": 2182, - "name": "unnamed", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 93, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L93", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2187, - 2183, - 2186, - 2185, - 2184, - 2182 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 92, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L92", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 2019, - "name": "RequestQueueStats", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics about Request Queue usage and storage." - } - ] - }, - "children": [ - { - "id": 2022, - "name": "deleteCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 859, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L859", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2023, - "name": "headItemReadCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 860, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L860", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2020, - "name": "readCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 857, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L857", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2024, - "name": "storageBytes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 861, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L861", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2021, - "name": "writeCount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 858, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L858", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2022, - 2023, - 2020, - 2024, - 2021 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 856, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L856", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 1998, - "name": "RequestQueueUserOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User-specific options for RequestQueueClient." - } - ] - }, - "children": [ - { - "id": 1999, - "name": "clientKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 823, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L823", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2000, - "name": "timeoutSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 824, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L824", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1999, - 2000 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 822, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L822", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2295, - "name": "RunAbortOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for aborting a Run." - } - ] - }, - "children": [ - { - "id": 2296, - "name": "gracefully", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 492, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L492", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2296 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 491, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L491", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2311, - "name": "RunChargeOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for charging events in a pay-per-event Actor run." - } - ] - }, - "children": [ - { - "id": 2313, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Defaults to 1" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 531, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L531", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2312, - "name": "eventName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the event to charge. Must be defined in the Actor's pricing info else the API will throw." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 529, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L529", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2314, - "name": "idempotencyKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Defaults to runId-eventName-timestamp" - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 533, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L533", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2313, - 2312, - 2314 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 527, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L527", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2382, - "name": "RunCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2389, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 2383, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run_collection.ts", - "line": 83, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run_collection.ts#L83", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2388, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 2387, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - }, - { - "id": 2386, - "name": "startedAfter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run_collection.ts", - "line": 88, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run_collection.ts#L88", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 2385, - "name": "startedBefore", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run_collection.ts", - "line": 87, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run_collection.ts#L87", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 2384, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run_collection.ts", - "line": 84, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run_collection.ts#L84", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "READY" - }, - { - "type": "literal", - "value": "RUNNING" - }, - { - "type": "literal", - "value": "SUCCEEDED" - }, - { - "type": "literal", - "value": "FAILED" - }, - { - "type": "literal", - "value": "ABORTING" - }, - { - "type": "literal", - "value": "ABORTED" - }, - { - "type": "literal", - "value": "TIMING-OUT" - }, - { - "type": "literal", - "value": "TIMED-OUT" - }, - { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "READY" - }, - { - "type": "literal", - "value": "RUNNING" - }, - { - "type": "literal", - "value": "SUCCEEDED" - }, - { - "type": "literal", - "value": "FAILED" - }, - { - "type": "literal", - "value": "ABORTING" - }, - { - "type": "literal", - "value": "ABORTED" - }, - { - "type": "literal", - "value": "TIMING-OUT" - }, - { - "type": "literal", - "value": "TIMED-OUT" - } - ] - } - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2389, - 2383, - 2388, - 2387, - 2386, - 2385, - 2384 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run_collection.ts", - "line": 82, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run_collection.ts#L82", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 2293, - "name": "RunGetOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for getting a Run." - } - ] - }, - "children": [ - { - "id": 2294, - "name": "waitForFinish", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 485, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L485", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2294 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 484, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L484", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2297, - "name": "RunMetamorphOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for metamorphing a Run into another Actor." - } - ] - }, - "children": [ - { - "id": 2299, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 500, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L500", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2298, - "name": "contentType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 499, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L499", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2299, - 2298 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 498, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L498", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2304, - "name": "RunResurrectOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for resurrecting a finished Run." - } - ] - }, - "children": [ - { - "id": 2305, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 516, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L516", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2308, - "name": "maxItems", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 519, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L519", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2309, - "name": "maxTotalChargeUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 520, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L520", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2306, - "name": "memory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 517, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L517", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2310, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 521, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L521", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2307, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 518, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L518", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2305, - 2308, - 2309, - 2306, - 2310, - 2307 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 515, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L515", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2300, - "name": "RunUpdateOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for updating a Run." - } - ] - }, - "children": [ - { - "id": 2303, - "name": "generalAccess", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 509, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L509", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "RUN_GENERAL_ACCESS" - }, - "name": "RUN_GENERAL_ACCESS", - "package": "@apify/consts" - } - ] - } - }, - { - "id": 2302, - "name": "isStatusMessageTerminal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 508, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L508", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2301, - "name": "statusMessage", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 507, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L507", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2303, - 2302, - 2301 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 506, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L506", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2315, - "name": "RunWaitForFinishOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for waiting for a Run to finish." - } - ] - }, - "children": [ - { - "id": 2316, - "name": "waitSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum time to wait for the run to finish, in seconds.\nIf the limit is reached, the returned promise is resolved to a run object that will have\nstatus " - }, - { - "kind": "code", - "text": "`READY`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`RUNNING`" - }, - { - "kind": "text", - "text": ". If " - }, - { - "kind": "code", - "text": "`waitSecs`" - }, - { - "kind": "text", - "text": " omitted, the function waits indefinitely." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 545, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L545", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2316 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/run.ts", - "line": 539, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/run.ts#L539", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2462, - "name": "Schedule", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a schedule for automated Actor or Task runs.\n\nSchedules use cron expressions to define when Actors or Tasks should run automatically." - } - ] - }, - "children": [ - { - "id": 2476, - "name": "actions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 118, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L118", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2486, - "name": "ScheduleAction", - "package": "apify-client" - } - } - }, - { - "id": 2472, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 114, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L114", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 2467, - "name": "cronExpression", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 109, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L109", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2471, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 113, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L113", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2463, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 105, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L105", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2469, - "name": "isEnabled", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 111, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L111", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2470, - "name": "isExclusive", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 112, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L112", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2475, - "name": "lastRunAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 117, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L117", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2473, - "name": "modifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 115, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L115", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 2465, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 107, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L107", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2474, - "name": "nextRunAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 116, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L116", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2477, - "name": "notifications", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 119, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L119", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2478, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2479, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 120, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L120", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2479 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 119, - "character": 19, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L119", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - }, - { - "id": 2468, - "name": "timezone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 110, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L110", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "Africa/Abidjan" - }, - { - "type": "literal", - "value": "Africa/Accra" - }, - { - "type": "literal", - "value": "Africa/Addis_Ababa" - }, - { - "type": "literal", - "value": "Africa/Algiers" - }, - { - "type": "literal", - "value": "Africa/Asmara" - }, - { - "type": "literal", - "value": "Africa/Asmera" - }, - { - "type": "literal", - "value": "Africa/Bamako" - }, - { - "type": "literal", - "value": "Africa/Bangui" - }, - { - "type": "literal", - "value": "Africa/Banjul" - }, - { - "type": "literal", - "value": "Africa/Bissau" - }, - { - "type": "literal", - "value": "Africa/Blantyre" - }, - { - "type": "literal", - "value": "Africa/Brazzaville" - }, - { - "type": "literal", - "value": "Africa/Bujumbura" - }, - { - "type": "literal", - "value": "Africa/Cairo" - }, - { - "type": "literal", - "value": "Africa/Casablanca" - }, - { - "type": "literal", - "value": "Africa/Ceuta" - }, - { - "type": "literal", - "value": "Africa/Conakry" - }, - { - "type": "literal", - "value": "Africa/Dakar" - }, - { - "type": "literal", - "value": "Africa/Dar_es_Salaam" - }, - { - "type": "literal", - "value": "Africa/Djibouti" - }, - { - "type": "literal", - "value": "Africa/Douala" - }, - { - "type": "literal", - "value": "Africa/El_Aaiun" - }, - { - "type": "literal", - "value": "Africa/Freetown" - }, - { - "type": "literal", - "value": "Africa/Gaborone" - }, - { - "type": "literal", - "value": "Africa/Harare" - }, - { - "type": "literal", - "value": "Africa/Johannesburg" - }, - { - "type": "literal", - "value": "Africa/Juba" - }, - { - "type": "literal", - "value": "Africa/Kampala" - }, - { - "type": "literal", - "value": "Africa/Khartoum" - }, - { - "type": "literal", - "value": "Africa/Kigali" - }, - { - "type": "literal", - "value": "Africa/Kinshasa" - }, - { - "type": "literal", - "value": "Africa/Lagos" - }, - { - "type": "literal", - "value": "Africa/Libreville" - }, - { - "type": "literal", - "value": "Africa/Lome" - }, - { - "type": "literal", - "value": "Africa/Luanda" - }, - { - "type": "literal", - "value": "Africa/Lubumbashi" - }, - { - "type": "literal", - "value": "Africa/Lusaka" - }, - { - "type": "literal", - "value": "Africa/Malabo" - }, - { - "type": "literal", - "value": "Africa/Maputo" - }, - { - "type": "literal", - "value": "Africa/Maseru" - }, - { - "type": "literal", - "value": "Africa/Mbabane" - }, - { - "type": "literal", - "value": "Africa/Mogadishu" - }, - { - "type": "literal", - "value": "Africa/Monrovia" - }, - { - "type": "literal", - "value": "Africa/Nairobi" - }, - { - "type": "literal", - "value": "Africa/Ndjamena" - }, - { - "type": "literal", - "value": "Africa/Niamey" - }, - { - "type": "literal", - "value": "Africa/Nouakchott" - }, - { - "type": "literal", - "value": "Africa/Ouagadougou" - }, - { - "type": "literal", - "value": "Africa/Porto-Novo" - }, - { - "type": "literal", - "value": "Africa/Sao_Tome" - }, - { - "type": "literal", - "value": "Africa/Timbuktu" - }, - { - "type": "literal", - "value": "Africa/Tripoli" - }, - { - "type": "literal", - "value": "Africa/Tunis" - }, - { - "type": "literal", - "value": "Africa/Windhoek" - }, - { - "type": "literal", - "value": "America/Adak" - }, - { - "type": "literal", - "value": "America/Anchorage" - }, - { - "type": "literal", - "value": "America/Anguilla" - }, - { - "type": "literal", - "value": "America/Antigua" - }, - { - "type": "literal", - "value": "America/Araguaina" - }, - { - "type": "literal", - "value": "America/Argentina/Buenos_Aires" - }, - { - "type": "literal", - "value": "America/Argentina/Catamarca" - }, - { - "type": "literal", - "value": "America/Argentina/ComodRivadavia" - }, - { - "type": "literal", - "value": "America/Argentina/Cordoba" - }, - { - "type": "literal", - "value": "America/Argentina/Jujuy" - }, - { - "type": "literal", - "value": "America/Argentina/La_Rioja" - }, - { - "type": "literal", - "value": "America/Argentina/Mendoza" - }, - { - "type": "literal", - "value": "America/Argentina/Rio_Gallegos" - }, - { - "type": "literal", - "value": "America/Argentina/Salta" - }, - { - "type": "literal", - "value": "America/Argentina/San_Juan" - }, - { - "type": "literal", - "value": "America/Argentina/San_Luis" - }, - { - "type": "literal", - "value": "America/Argentina/Tucuman" - }, - { - "type": "literal", - "value": "America/Argentina/Ushuaia" - }, - { - "type": "literal", - "value": "America/Aruba" - }, - { - "type": "literal", - "value": "America/Asuncion" - }, - { - "type": "literal", - "value": "America/Atikokan" - }, - { - "type": "literal", - "value": "America/Atka" - }, - { - "type": "literal", - "value": "America/Bahia" - }, - { - "type": "literal", - "value": "America/Bahia_Banderas" - }, - { - "type": "literal", - "value": "America/Barbados" - }, - { - "type": "literal", - "value": "America/Belem" - }, - { - "type": "literal", - "value": "America/Belize" - }, - { - "type": "literal", - "value": "America/Blanc-Sablon" - }, - { - "type": "literal", - "value": "America/Boa_Vista" - }, - { - "type": "literal", - "value": "America/Bogota" - }, - { - "type": "literal", - "value": "America/Boise" - }, - { - "type": "literal", - "value": "America/Buenos_Aires" - }, - { - "type": "literal", - "value": "America/Cambridge_Bay" - }, - { - "type": "literal", - "value": "America/Campo_Grande" - }, - { - "type": "literal", - "value": "America/Cancun" - }, - { - "type": "literal", - "value": "America/Caracas" - }, - { - "type": "literal", - "value": "America/Catamarca" - }, - { - "type": "literal", - "value": "America/Cayenne" - }, - { - "type": "literal", - "value": "America/Cayman" - }, - { - "type": "literal", - "value": "America/Chicago" - }, - { - "type": "literal", - "value": "America/Chihuahua" - }, - { - "type": "literal", - "value": "America/Coral_Harbour" - }, - { - "type": "literal", - "value": "America/Cordoba" - }, - { - "type": "literal", - "value": "America/Costa_Rica" - }, - { - "type": "literal", - "value": "America/Creston" - }, - { - "type": "literal", - "value": "America/Cuiaba" - }, - { - "type": "literal", - "value": "America/Curacao" - }, - { - "type": "literal", - "value": "America/Danmarkshavn" - }, - { - "type": "literal", - "value": "America/Dawson" - }, - { - "type": "literal", - "value": "America/Dawson_Creek" - }, - { - "type": "literal", - "value": "America/Denver" - }, - { - "type": "literal", - "value": "America/Detroit" - }, - { - "type": "literal", - "value": "America/Dominica" - }, - { - "type": "literal", - "value": "America/Edmonton" - }, - { - "type": "literal", - "value": "America/Eirunepe" - }, - { - "type": "literal", - "value": "America/El_Salvador" - }, - { - "type": "literal", - "value": "America/Ensenada" - }, - { - "type": "literal", - "value": "America/Fort_Nelson" - }, - { - "type": "literal", - "value": "America/Fort_Wayne" - }, - { - "type": "literal", - "value": "America/Fortaleza" - }, - { - "type": "literal", - "value": "America/Glace_Bay" - }, - { - "type": "literal", - "value": "America/Godthab" - }, - { - "type": "literal", - "value": "America/Goose_Bay" - }, - { - "type": "literal", - "value": "America/Grand_Turk" - }, - { - "type": "literal", - "value": "America/Grenada" - }, - { - "type": "literal", - "value": "America/Guadeloupe" - }, - { - "type": "literal", - "value": "America/Guatemala" - }, - { - "type": "literal", - "value": "America/Guayaquil" - }, - { - "type": "literal", - "value": "America/Guyana" - }, - { - "type": "literal", - "value": "America/Halifax" - }, - { - "type": "literal", - "value": "America/Havana" - }, - { - "type": "literal", - "value": "America/Hermosillo" - }, - { - "type": "literal", - "value": "America/Indiana/Indianapolis" - }, - { - "type": "literal", - "value": "America/Indiana/Knox" - }, - { - "type": "literal", - "value": "America/Indiana/Marengo" - }, - { - "type": "literal", - "value": "America/Indiana/Petersburg" - }, - { - "type": "literal", - "value": "America/Indiana/Tell_City" - }, - { - "type": "literal", - "value": "America/Indiana/Vevay" - }, - { - "type": "literal", - "value": "America/Indiana/Vincennes" - }, - { - "type": "literal", - "value": "America/Indiana/Winamac" - }, - { - "type": "literal", - "value": "America/Indianapolis" - }, - { - "type": "literal", - "value": "America/Inuvik" - }, - { - "type": "literal", - "value": "America/Iqaluit" - }, - { - "type": "literal", - "value": "America/Jamaica" - }, - { - "type": "literal", - "value": "America/Jujuy" - }, - { - "type": "literal", - "value": "America/Juneau" - }, - { - "type": "literal", - "value": "America/Kentucky/Louisville" - }, - { - "type": "literal", - "value": "America/Kentucky/Monticello" - }, - { - "type": "literal", - "value": "America/Knox_IN" - }, - { - "type": "literal", - "value": "America/Kralendijk" - }, - { - "type": "literal", - "value": "America/La_Paz" - }, - { - "type": "literal", - "value": "America/Lima" - }, - { - "type": "literal", - "value": "America/Los_Angeles" - }, - { - "type": "literal", - "value": "America/Louisville" - }, - { - "type": "literal", - "value": "America/Lower_Princes" - }, - { - "type": "literal", - "value": "America/Maceio" - }, - { - "type": "literal", - "value": "America/Managua" - }, - { - "type": "literal", - "value": "America/Manaus" - }, - { - "type": "literal", - "value": "America/Marigot" - }, - { - "type": "literal", - "value": "America/Martinique" - }, - { - "type": "literal", - "value": "America/Matamoros" - }, - { - "type": "literal", - "value": "America/Mazatlan" - }, - { - "type": "literal", - "value": "America/Mendoza" - }, - { - "type": "literal", - "value": "America/Menominee" - }, - { - "type": "literal", - "value": "America/Merida" - }, - { - "type": "literal", - "value": "America/Metlakatla" - }, - { - "type": "literal", - "value": "America/Mexico_City" - }, - { - "type": "literal", - "value": "America/Miquelon" - }, - { - "type": "literal", - "value": "America/Moncton" - }, - { - "type": "literal", - "value": "America/Monterrey" - }, - { - "type": "literal", - "value": "America/Montevideo" - }, - { - "type": "literal", - "value": "America/Montreal" - }, - { - "type": "literal", - "value": "America/Montserrat" - }, - { - "type": "literal", - "value": "America/Nassau" - }, - { - "type": "literal", - "value": "America/New_York" - }, - { - "type": "literal", - "value": "America/Nipigon" - }, - { - "type": "literal", - "value": "America/Nome" - }, - { - "type": "literal", - "value": "America/Noronha" - }, - { - "type": "literal", - "value": "America/North_Dakota/Beulah" - }, - { - "type": "literal", - "value": "America/North_Dakota/Center" - }, - { - "type": "literal", - "value": "America/North_Dakota/New_Salem" - }, - { - "type": "literal", - "value": "America/Nuuk" - }, - { - "type": "literal", - "value": "America/Ojinaga" - }, - { - "type": "literal", - "value": "America/Panama" - }, - { - "type": "literal", - "value": "America/Pangnirtung" - }, - { - "type": "literal", - "value": "America/Paramaribo" - }, - { - "type": "literal", - "value": "America/Phoenix" - }, - { - "type": "literal", - "value": "America/Port-au-Prince" - }, - { - "type": "literal", - "value": "America/Port_of_Spain" - }, - { - "type": "literal", - "value": "America/Porto_Acre" - }, - { - "type": "literal", - "value": "America/Porto_Velho" - }, - { - "type": "literal", - "value": "America/Puerto_Rico" - }, - { - "type": "literal", - "value": "America/Punta_Arenas" - }, - { - "type": "literal", - "value": "America/Rainy_River" - }, - { - "type": "literal", - "value": "America/Rankin_Inlet" - }, - { - "type": "literal", - "value": "America/Recife" - }, - { - "type": "literal", - "value": "America/Regina" - }, - { - "type": "literal", - "value": "America/Resolute" - }, - { - "type": "literal", - "value": "America/Rio_Branco" - }, - { - "type": "literal", - "value": "America/Rosario" - }, - { - "type": "literal", - "value": "America/Santa_Isabel" - }, - { - "type": "literal", - "value": "America/Santarem" - }, - { - "type": "literal", - "value": "America/Santiago" - }, - { - "type": "literal", - "value": "America/Santo_Domingo" - }, - { - "type": "literal", - "value": "America/Sao_Paulo" - }, - { - "type": "literal", - "value": "America/Scoresbysund" - }, - { - "type": "literal", - "value": "America/Shiprock" - }, - { - "type": "literal", - "value": "America/Sitka" - }, - { - "type": "literal", - "value": "America/St_Barthelemy" - }, - { - "type": "literal", - "value": "America/St_Johns" - }, - { - "type": "literal", - "value": "America/St_Kitts" - }, - { - "type": "literal", - "value": "America/St_Lucia" - }, - { - "type": "literal", - "value": "America/St_Thomas" - }, - { - "type": "literal", - "value": "America/St_Vincent" - }, - { - "type": "literal", - "value": "America/Swift_Current" - }, - { - "type": "literal", - "value": "America/Tegucigalpa" - }, - { - "type": "literal", - "value": "America/Thule" - }, - { - "type": "literal", - "value": "America/Thunder_Bay" - }, - { - "type": "literal", - "value": "America/Tijuana" - }, - { - "type": "literal", - "value": "America/Toronto" - }, - { - "type": "literal", - "value": "America/Tortola" - }, - { - "type": "literal", - "value": "America/Vancouver" - }, - { - "type": "literal", - "value": "America/Virgin" - }, - { - "type": "literal", - "value": "America/Whitehorse" - }, - { - "type": "literal", - "value": "America/Winnipeg" - }, - { - "type": "literal", - "value": "America/Yakutat" - }, - { - "type": "literal", - "value": "America/Yellowknife" - }, - { - "type": "literal", - "value": "Antarctica/Casey" - }, - { - "type": "literal", - "value": "Antarctica/Davis" - }, - { - "type": "literal", - "value": "Antarctica/DumontDUrville" - }, - { - "type": "literal", - "value": "Antarctica/Macquarie" - }, - { - "type": "literal", - "value": "Antarctica/Mawson" - }, - { - "type": "literal", - "value": "Antarctica/McMurdo" - }, - { - "type": "literal", - "value": "Antarctica/Palmer" - }, - { - "type": "literal", - "value": "Antarctica/Rothera" - }, - { - "type": "literal", - "value": "Antarctica/South_Pole" - }, - { - "type": "literal", - "value": "Antarctica/Syowa" - }, - { - "type": "literal", - "value": "Antarctica/Troll" - }, - { - "type": "literal", - "value": "Antarctica/Vostok" - }, - { - "type": "literal", - "value": "Arctic/Longyearbyen" - }, - { - "type": "literal", - "value": "Asia/Aden" - }, - { - "type": "literal", - "value": "Asia/Almaty" - }, - { - "type": "literal", - "value": "Asia/Amman" - }, - { - "type": "literal", - "value": "Asia/Anadyr" - }, - { - "type": "literal", - "value": "Asia/Aqtau" - }, - { - "type": "literal", - "value": "Asia/Aqtobe" - }, - { - "type": "literal", - "value": "Asia/Ashgabat" - }, - { - "type": "literal", - "value": "Asia/Ashkhabad" - }, - { - "type": "literal", - "value": "Asia/Atyrau" - }, - { - "type": "literal", - "value": "Asia/Baghdad" - }, - { - "type": "literal", - "value": "Asia/Bahrain" - }, - { - "type": "literal", - "value": "Asia/Baku" - }, - { - "type": "literal", - "value": "Asia/Bangkok" - }, - { - "type": "literal", - "value": "Asia/Barnaul" - }, - { - "type": "literal", - "value": "Asia/Beirut" - }, - { - "type": "literal", - "value": "Asia/Bishkek" - }, - { - "type": "literal", - "value": "Asia/Brunei" - }, - { - "type": "literal", - "value": "Asia/Calcutta" - }, - { - "type": "literal", - "value": "Asia/Chita" - }, - { - "type": "literal", - "value": "Asia/Choibalsan" - }, - { - "type": "literal", - "value": "Asia/Chongqing" - }, - { - "type": "literal", - "value": "Asia/Chungking" - }, - { - "type": "literal", - "value": "Asia/Colombo" - }, - { - "type": "literal", - "value": "Asia/Dacca" - }, - { - "type": "literal", - "value": "Asia/Damascus" - }, - { - "type": "literal", - "value": "Asia/Dhaka" - }, - { - "type": "literal", - "value": "Asia/Dili" - }, - { - "type": "literal", - "value": "Asia/Dubai" - }, - { - "type": "literal", - "value": "Asia/Dushanbe" - }, - { - "type": "literal", - "value": "Asia/Famagusta" - }, - { - "type": "literal", - "value": "Asia/Gaza" - }, - { - "type": "literal", - "value": "Asia/Harbin" - }, - { - "type": "literal", - "value": "Asia/Hebron" - }, - { - "type": "literal", - "value": "Asia/Ho_Chi_Minh" - }, - { - "type": "literal", - "value": "Asia/Hong_Kong" - }, - { - "type": "literal", - "value": "Asia/Hovd" - }, - { - "type": "literal", - "value": "Asia/Irkutsk" - }, - { - "type": "literal", - "value": "Asia/Istanbul" - }, - { - "type": "literal", - "value": "Asia/Jakarta" - }, - { - "type": "literal", - "value": "Asia/Jayapura" - }, - { - "type": "literal", - "value": "Asia/Jerusalem" - }, - { - "type": "literal", - "value": "Asia/Kabul" - }, - { - "type": "literal", - "value": "Asia/Kamchatka" - }, - { - "type": "literal", - "value": "Asia/Karachi" - }, - { - "type": "literal", - "value": "Asia/Kashgar" - }, - { - "type": "literal", - "value": "Asia/Kathmandu" - }, - { - "type": "literal", - "value": "Asia/Katmandu" - }, - { - "type": "literal", - "value": "Asia/Khandyga" - }, - { - "type": "literal", - "value": "Asia/Kolkata" - }, - { - "type": "literal", - "value": "Asia/Krasnoyarsk" - }, - { - "type": "literal", - "value": "Asia/Kuala_Lumpur" - }, - { - "type": "literal", - "value": "Asia/Kuching" - }, - { - "type": "literal", - "value": "Asia/Kuwait" - }, - { - "type": "literal", - "value": "Asia/Macao" - }, - { - "type": "literal", - "value": "Asia/Macau" - }, - { - "type": "literal", - "value": "Asia/Magadan" - }, - { - "type": "literal", - "value": "Asia/Makassar" - }, - { - "type": "literal", - "value": "Asia/Manila" - }, - { - "type": "literal", - "value": "Asia/Muscat" - }, - { - "type": "literal", - "value": "Asia/Nicosia" - }, - { - "type": "literal", - "value": "Asia/Novokuznetsk" - }, - { - "type": "literal", - "value": "Asia/Novosibirsk" - }, - { - "type": "literal", - "value": "Asia/Omsk" - }, - { - "type": "literal", - "value": "Asia/Oral" - }, - { - "type": "literal", - "value": "Asia/Phnom_Penh" - }, - { - "type": "literal", - "value": "Asia/Pontianak" - }, - { - "type": "literal", - "value": "Asia/Pyongyang" - }, - { - "type": "literal", - "value": "Asia/Qatar" - }, - { - "type": "literal", - "value": "Asia/Qostanay" - }, - { - "type": "literal", - "value": "Asia/Qyzylorda" - }, - { - "type": "literal", - "value": "Asia/Rangoon" - }, - { - "type": "literal", - "value": "Asia/Riyadh" - }, - { - "type": "literal", - "value": "Asia/Saigon" - }, - { - "type": "literal", - "value": "Asia/Sakhalin" - }, - { - "type": "literal", - "value": "Asia/Samarkand" - }, - { - "type": "literal", - "value": "Asia/Seoul" - }, - { - "type": "literal", - "value": "Asia/Shanghai" - }, - { - "type": "literal", - "value": "Asia/Singapore" - }, - { - "type": "literal", - "value": "Asia/Srednekolymsk" - }, - { - "type": "literal", - "value": "Asia/Taipei" - }, - { - "type": "literal", - "value": "Asia/Tashkent" - }, - { - "type": "literal", - "value": "Asia/Tbilisi" - }, - { - "type": "literal", - "value": "Asia/Tehran" - }, - { - "type": "literal", - "value": "Asia/Tel_Aviv" - }, - { - "type": "literal", - "value": "Asia/Thimbu" - }, - { - "type": "literal", - "value": "Asia/Thimphu" - }, - { - "type": "literal", - "value": "Asia/Tokyo" - }, - { - "type": "literal", - "value": "Asia/Tomsk" - }, - { - "type": "literal", - "value": "Asia/Ujung_Pandang" - }, - { - "type": "literal", - "value": "Asia/Ulaanbaatar" - }, - { - "type": "literal", - "value": "Asia/Ulan_Bator" - }, - { - "type": "literal", - "value": "Asia/Urumqi" - }, - { - "type": "literal", - "value": "Asia/Ust-Nera" - }, - { - "type": "literal", - "value": "Asia/Vientiane" - }, - { - "type": "literal", - "value": "Asia/Vladivostok" - }, - { - "type": "literal", - "value": "Asia/Yakutsk" - }, - { - "type": "literal", - "value": "Asia/Yangon" - }, - { - "type": "literal", - "value": "Asia/Yekaterinburg" - }, - { - "type": "literal", - "value": "Asia/Yerevan" - }, - { - "type": "literal", - "value": "Atlantic/Azores" - }, - { - "type": "literal", - "value": "Atlantic/Bermuda" - }, - { - "type": "literal", - "value": "Atlantic/Canary" - }, - { - "type": "literal", - "value": "Atlantic/Cape_Verde" - }, - { - "type": "literal", - "value": "Atlantic/Faeroe" - }, - { - "type": "literal", - "value": "Atlantic/Faroe" - }, - { - "type": "literal", - "value": "Atlantic/Jan_Mayen" - }, - { - "type": "literal", - "value": "Atlantic/Madeira" - }, - { - "type": "literal", - "value": "Atlantic/Reykjavik" - }, - { - "type": "literal", - "value": "Atlantic/South_Georgia" - }, - { - "type": "literal", - "value": "Atlantic/St_Helena" - }, - { - "type": "literal", - "value": "Atlantic/Stanley" - }, - { - "type": "literal", - "value": "Australia/ACT" - }, - { - "type": "literal", - "value": "Australia/Adelaide" - }, - { - "type": "literal", - "value": "Australia/Brisbane" - }, - { - "type": "literal", - "value": "Australia/Broken_Hill" - }, - { - "type": "literal", - "value": "Australia/Canberra" - }, - { - "type": "literal", - "value": "Australia/Currie" - }, - { - "type": "literal", - "value": "Australia/Darwin" - }, - { - "type": "literal", - "value": "Australia/Eucla" - }, - { - "type": "literal", - "value": "Australia/Hobart" - }, - { - "type": "literal", - "value": "Australia/LHI" - }, - { - "type": "literal", - "value": "Australia/Lindeman" - }, - { - "type": "literal", - "value": "Australia/Lord_Howe" - }, - { - "type": "literal", - "value": "Australia/Melbourne" - }, - { - "type": "literal", - "value": "Australia/NSW" - }, - { - "type": "literal", - "value": "Australia/North" - }, - { - "type": "literal", - "value": "Australia/Perth" - }, - { - "type": "literal", - "value": "Australia/Queensland" - }, - { - "type": "literal", - "value": "Australia/South" - }, - { - "type": "literal", - "value": "Australia/Sydney" - }, - { - "type": "literal", - "value": "Australia/Tasmania" - }, - { - "type": "literal", - "value": "Australia/Victoria" - }, - { - "type": "literal", - "value": "Australia/West" - }, - { - "type": "literal", - "value": "Australia/Yancowinna" - }, - { - "type": "literal", - "value": "Brazil/Acre" - }, - { - "type": "literal", - "value": "Brazil/DeNoronha" - }, - { - "type": "literal", - "value": "Brazil/East" - }, - { - "type": "literal", - "value": "Brazil/West" - }, - { - "type": "literal", - "value": "CET" - }, - { - "type": "literal", - "value": "CST6CDT" - }, - { - "type": "literal", - "value": "Canada/Atlantic" - }, - { - "type": "literal", - "value": "Canada/Central" - }, - { - "type": "literal", - "value": "Canada/Eastern" - }, - { - "type": "literal", - "value": "Canada/Mountain" - }, - { - "type": "literal", - "value": "Canada/Newfoundland" - }, - { - "type": "literal", - "value": "Canada/Pacific" - }, - { - "type": "literal", - "value": "Canada/Saskatchewan" - }, - { - "type": "literal", - "value": "Canada/Yukon" - }, - { - "type": "literal", - "value": "Chile/Continental" - }, - { - "type": "literal", - "value": "Chile/EasterIsland" - }, - { - "type": "literal", - "value": "Cuba" - }, - { - "type": "literal", - "value": "EET" - }, - { - "type": "literal", - "value": "EST" - }, - { - "type": "literal", - "value": "EST5EDT" - }, - { - "type": "literal", - "value": "Egypt" - }, - { - "type": "literal", - "value": "Eire" - }, - { - "type": "literal", - "value": "Etc/GMT" - }, - { - "type": "literal", - "value": "Etc/GMT+0" - }, - { - "type": "literal", - "value": "Etc/GMT+1" - }, - { - "type": "literal", - "value": "Etc/GMT+10" - }, - { - "type": "literal", - "value": "Etc/GMT+11" - }, - { - "type": "literal", - "value": "Etc/GMT+12" - }, - { - "type": "literal", - "value": "Etc/GMT+2" - }, - { - "type": "literal", - "value": "Etc/GMT+3" - }, - { - "type": "literal", - "value": "Etc/GMT+4" - }, - { - "type": "literal", - "value": "Etc/GMT+5" - }, - { - "type": "literal", - "value": "Etc/GMT+6" - }, - { - "type": "literal", - "value": "Etc/GMT+7" - }, - { - "type": "literal", - "value": "Etc/GMT+8" - }, - { - "type": "literal", - "value": "Etc/GMT+9" - }, - { - "type": "literal", - "value": "Etc/GMT-0" - }, - { - "type": "literal", - "value": "Etc/GMT-1" - }, - { - "type": "literal", - "value": "Etc/GMT-10" - }, - { - "type": "literal", - "value": "Etc/GMT-11" - }, - { - "type": "literal", - "value": "Etc/GMT-12" - }, - { - "type": "literal", - "value": "Etc/GMT-13" - }, - { - "type": "literal", - "value": "Etc/GMT-14" - }, - { - "type": "literal", - "value": "Etc/GMT-2" - }, - { - "type": "literal", - "value": "Etc/GMT-3" - }, - { - "type": "literal", - "value": "Etc/GMT-4" - }, - { - "type": "literal", - "value": "Etc/GMT-5" - }, - { - "type": "literal", - "value": "Etc/GMT-6" - }, - { - "type": "literal", - "value": "Etc/GMT-7" - }, - { - "type": "literal", - "value": "Etc/GMT-8" - }, - { - "type": "literal", - "value": "Etc/GMT-9" - }, - { - "type": "literal", - "value": "Etc/GMT0" - }, - { - "type": "literal", - "value": "Etc/Greenwich" - }, - { - "type": "literal", - "value": "Etc/UCT" - }, - { - "type": "literal", - "value": "Etc/UTC" - }, - { - "type": "literal", - "value": "Etc/Universal" - }, - { - "type": "literal", - "value": "Etc/Zulu" - }, - { - "type": "literal", - "value": "Europe/Amsterdam" - }, - { - "type": "literal", - "value": "Europe/Andorra" - }, - { - "type": "literal", - "value": "Europe/Astrakhan" - }, - { - "type": "literal", - "value": "Europe/Athens" - }, - { - "type": "literal", - "value": "Europe/Belfast" - }, - { - "type": "literal", - "value": "Europe/Belgrade" - }, - { - "type": "literal", - "value": "Europe/Berlin" - }, - { - "type": "literal", - "value": "Europe/Bratislava" - }, - { - "type": "literal", - "value": "Europe/Brussels" - }, - { - "type": "literal", - "value": "Europe/Bucharest" - }, - { - "type": "literal", - "value": "Europe/Budapest" - }, - { - "type": "literal", - "value": "Europe/Busingen" - }, - { - "type": "literal", - "value": "Europe/Chisinau" - }, - { - "type": "literal", - "value": "Europe/Copenhagen" - }, - { - "type": "literal", - "value": "Europe/Dublin" - }, - { - "type": "literal", - "value": "Europe/Gibraltar" - }, - { - "type": "literal", - "value": "Europe/Guernsey" - }, - { - "type": "literal", - "value": "Europe/Helsinki" - }, - { - "type": "literal", - "value": "Europe/Isle_of_Man" - }, - { - "type": "literal", - "value": "Europe/Istanbul" - }, - { - "type": "literal", - "value": "Europe/Jersey" - }, - { - "type": "literal", - "value": "Europe/Kaliningrad" - }, - { - "type": "literal", - "value": "Europe/Kiev" - }, - { - "type": "literal", - "value": "Europe/Kirov" - }, - { - "type": "literal", - "value": "Europe/Lisbon" - }, - { - "type": "literal", - "value": "Europe/Ljubljana" - }, - { - "type": "literal", - "value": "Europe/London" - }, - { - "type": "literal", - "value": "Europe/Luxembourg" - }, - { - "type": "literal", - "value": "Europe/Madrid" - }, - { - "type": "literal", - "value": "Europe/Malta" - }, - { - "type": "literal", - "value": "Europe/Mariehamn" - }, - { - "type": "literal", - "value": "Europe/Minsk" - }, - { - "type": "literal", - "value": "Europe/Monaco" - }, - { - "type": "literal", - "value": "Europe/Moscow" - }, - { - "type": "literal", - "value": "Europe/Nicosia" - }, - { - "type": "literal", - "value": "Europe/Oslo" - }, - { - "type": "literal", - "value": "Europe/Paris" - }, - { - "type": "literal", - "value": "Europe/Podgorica" - }, - { - "type": "literal", - "value": "Europe/Prague" - }, - { - "type": "literal", - "value": "Europe/Riga" - }, - { - "type": "literal", - "value": "Europe/Rome" - }, - { - "type": "literal", - "value": "Europe/Samara" - }, - { - "type": "literal", - "value": "Europe/San_Marino" - }, - { - "type": "literal", - "value": "Europe/Sarajevo" - }, - { - "type": "literal", - "value": "Europe/Saratov" - }, - { - "type": "literal", - "value": "Europe/Simferopol" - }, - { - "type": "literal", - "value": "Europe/Skopje" - }, - { - "type": "literal", - "value": "Europe/Sofia" - }, - { - "type": "literal", - "value": "Europe/Stockholm" - }, - { - "type": "literal", - "value": "Europe/Tallinn" - }, - { - "type": "literal", - "value": "Europe/Tirane" - }, - { - "type": "literal", - "value": "Europe/Tiraspol" - }, - { - "type": "literal", - "value": "Europe/Ulyanovsk" - }, - { - "type": "literal", - "value": "Europe/Uzhgorod" - }, - { - "type": "literal", - "value": "Europe/Vaduz" - }, - { - "type": "literal", - "value": "Europe/Vatican" - }, - { - "type": "literal", - "value": "Europe/Vienna" - }, - { - "type": "literal", - "value": "Europe/Vilnius" - }, - { - "type": "literal", - "value": "Europe/Volgograd" - }, - { - "type": "literal", - "value": "Europe/Warsaw" - }, - { - "type": "literal", - "value": "Europe/Zagreb" - }, - { - "type": "literal", - "value": "Europe/Zaporozhye" - }, - { - "type": "literal", - "value": "Europe/Zurich" - }, - { - "type": "literal", - "value": "GB" - }, - { - "type": "literal", - "value": "GB-Eire" - }, - { - "type": "literal", - "value": "GMT" - }, - { - "type": "literal", - "value": "GMT+0" - }, - { - "type": "literal", - "value": "GMT-0" - }, - { - "type": "literal", - "value": "GMT0" - }, - { - "type": "literal", - "value": "Greenwich" - }, - { - "type": "literal", - "value": "HST" - }, - { - "type": "literal", - "value": "Hongkong" - }, - { - "type": "literal", - "value": "Iceland" - }, - { - "type": "literal", - "value": "Indian/Antananarivo" - }, - { - "type": "literal", - "value": "Indian/Chagos" - }, - { - "type": "literal", - "value": "Indian/Christmas" - }, - { - "type": "literal", - "value": "Indian/Cocos" - }, - { - "type": "literal", - "value": "Indian/Comoro" - }, - { - "type": "literal", - "value": "Indian/Kerguelen" - }, - { - "type": "literal", - "value": "Indian/Mahe" - }, - { - "type": "literal", - "value": "Indian/Maldives" - }, - { - "type": "literal", - "value": "Indian/Mauritius" - }, - { - "type": "literal", - "value": "Indian/Mayotte" - }, - { - "type": "literal", - "value": "Indian/Reunion" - }, - { - "type": "literal", - "value": "Iran" - }, - { - "type": "literal", - "value": "Israel" - }, - { - "type": "literal", - "value": "Jamaica" - }, - { - "type": "literal", - "value": "Japan" - }, - { - "type": "literal", - "value": "Kwajalein" - }, - { - "type": "literal", - "value": "Libya" - }, - { - "type": "literal", - "value": "MET" - }, - { - "type": "literal", - "value": "MST" - }, - { - "type": "literal", - "value": "MST7MDT" - }, - { - "type": "literal", - "value": "Mexico/BajaNorte" - }, - { - "type": "literal", - "value": "Mexico/BajaSur" - }, - { - "type": "literal", - "value": "Mexico/General" - }, - { - "type": "literal", - "value": "NZ" - }, - { - "type": "literal", - "value": "NZ-CHAT" - }, - { - "type": "literal", - "value": "Navajo" - }, - { - "type": "literal", - "value": "PRC" - }, - { - "type": "literal", - "value": "PST8PDT" - }, - { - "type": "literal", - "value": "Pacific/Apia" - }, - { - "type": "literal", - "value": "Pacific/Auckland" - }, - { - "type": "literal", - "value": "Pacific/Bougainville" - }, - { - "type": "literal", - "value": "Pacific/Chatham" - }, - { - "type": "literal", - "value": "Pacific/Chuuk" - }, - { - "type": "literal", - "value": "Pacific/Easter" - }, - { - "type": "literal", - "value": "Pacific/Efate" - }, - { - "type": "literal", - "value": "Pacific/Enderbury" - }, - { - "type": "literal", - "value": "Pacific/Fakaofo" - }, - { - "type": "literal", - "value": "Pacific/Fiji" - }, - { - "type": "literal", - "value": "Pacific/Funafuti" - }, - { - "type": "literal", - "value": "Pacific/Galapagos" - }, - { - "type": "literal", - "value": "Pacific/Gambier" - }, - { - "type": "literal", - "value": "Pacific/Guadalcanal" - }, - { - "type": "literal", - "value": "Pacific/Guam" - }, - { - "type": "literal", - "value": "Pacific/Honolulu" - }, - { - "type": "literal", - "value": "Pacific/Johnston" - }, - { - "type": "literal", - "value": "Pacific/Kiritimati" - }, - { - "type": "literal", - "value": "Pacific/Kosrae" - }, - { - "type": "literal", - "value": "Pacific/Kwajalein" - }, - { - "type": "literal", - "value": "Pacific/Majuro" - }, - { - "type": "literal", - "value": "Pacific/Marquesas" - }, - { - "type": "literal", - "value": "Pacific/Midway" - }, - { - "type": "literal", - "value": "Pacific/Nauru" - }, - { - "type": "literal", - "value": "Pacific/Niue" - }, - { - "type": "literal", - "value": "Pacific/Norfolk" - }, - { - "type": "literal", - "value": "Pacific/Noumea" - }, - { - "type": "literal", - "value": "Pacific/Pago_Pago" - }, - { - "type": "literal", - "value": "Pacific/Palau" - }, - { - "type": "literal", - "value": "Pacific/Pitcairn" - }, - { - "type": "literal", - "value": "Pacific/Pohnpei" - }, - { - "type": "literal", - "value": "Pacific/Ponape" - }, - { - "type": "literal", - "value": "Pacific/Port_Moresby" - }, - { - "type": "literal", - "value": "Pacific/Rarotonga" - }, - { - "type": "literal", - "value": "Pacific/Saipan" - }, - { - "type": "literal", - "value": "Pacific/Samoa" - }, - { - "type": "literal", - "value": "Pacific/Tahiti" - }, - { - "type": "literal", - "value": "Pacific/Tarawa" - }, - { - "type": "literal", - "value": "Pacific/Tongatapu" - }, - { - "type": "literal", - "value": "Pacific/Truk" - }, - { - "type": "literal", - "value": "Pacific/Wake" - }, - { - "type": "literal", - "value": "Pacific/Wallis" - }, - { - "type": "literal", - "value": "Pacific/Yap" - }, - { - "type": "literal", - "value": "Poland" - }, - { - "type": "literal", - "value": "Portugal" - }, - { - "type": "literal", - "value": "ROC" - }, - { - "type": "literal", - "value": "ROK" - }, - { - "type": "literal", - "value": "Singapore" - }, - { - "type": "literal", - "value": "Turkey" - }, - { - "type": "literal", - "value": "UCT" - }, - { - "type": "literal", - "value": "US/Alaska" - }, - { - "type": "literal", - "value": "US/Aleutian" - }, - { - "type": "literal", - "value": "US/Arizona" - }, - { - "type": "literal", - "value": "US/Central" - }, - { - "type": "literal", - "value": "US/East-Indiana" - }, - { - "type": "literal", - "value": "US/Eastern" - }, - { - "type": "literal", - "value": "US/Hawaii" - }, - { - "type": "literal", - "value": "US/Indiana-Starke" - }, - { - "type": "literal", - "value": "US/Michigan" - }, - { - "type": "literal", - "value": "US/Mountain" - }, - { - "type": "literal", - "value": "US/Pacific" - }, - { - "type": "literal", - "value": "US/Samoa" - }, - { - "type": "literal", - "value": "UTC" - }, - { - "type": "literal", - "value": "Universal" - }, - { - "type": "literal", - "value": "W-SU" - }, - { - "type": "literal", - "value": "WET" - }, - { - "type": "literal", - "value": "Zulu" - } - ] - } - }, - { - "id": 2466, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 108, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L108", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2464, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 106, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L106", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2476, - 2472, - 2467, - 2471, - 2463, - 2469, - 2470, - 2475, - 2473, - 2465, - 2474, - 2477, - 2468, - 2466, - 2464 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 104, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L104", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2487, - "name": "ScheduleActionRunActor", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scheduled action to run an Actor." - } - ] - }, - "children": [ - { - "id": 2488, - "name": "actorId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 158, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L158", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2491, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 145, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L145", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseScheduleAction.id" - } - }, - { - "id": 2489, - "name": "runInput", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 159, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L159", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2493, - "name": "ScheduledActorRunInput", - "package": "apify-client" - } - }, - { - "id": 2490, - "name": "runOptions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 160, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L160", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2496, - "name": "ScheduledActorRunOptions", - "package": "apify-client" - } - }, - { - "id": 2492, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 146, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L146", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2484, - "name": "RunActor", - "package": "apify-client", - "qualifiedName": "ScheduleActions.RunActor" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseScheduleAction.type" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2488, - 2491, - 2489, - 2490, - 2492 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 157, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L157", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "BaseScheduleAction" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2484, - "name": "ScheduleActions.RunActor", - "package": "apify-client" - } - ], - "name": "BaseScheduleAction", - "package": "apify-client" - } - ] - }, - { - "id": 2501, - "name": "ScheduleActionRunActorTask", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Scheduled action to run an Actor task." - } - ] - }, - "children": [ - { - "id": 2502, - "name": "actorTaskId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 185, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L185", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2504, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 145, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L145", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseScheduleAction.id" - } - }, - { - "id": 2503, - "name": "input", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 186, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L186", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2505, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 146, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L146", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2485, - "name": "RunActorTask", - "package": "apify-client", - "qualifiedName": "ScheduleActions.RunActorTask" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "BaseScheduleAction.type" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2502, - 2504, - 2503, - 2505 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 184, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L184", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "BaseScheduleAction" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2485, - "name": "ScheduleActions.RunActorTask", - "package": "apify-client" - } - ], - "name": "BaseScheduleAction", - "package": "apify-client" - } - ] - }, - { - "id": 2576, - "name": "ScheduleCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2580, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 2577, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule_collection.ts", - "line": 91, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule_collection.ts#L91", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2579, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 2578, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2580, - 2577, - 2579, - 2578 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule_collection.ts", - "line": 90, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule_collection.ts#L90", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 2493, - "name": "ScheduledActorRunInput", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Input configuration for a scheduled Actor run." - } - ] - }, - "children": [ - { - "id": 2494, - "name": "body", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 167, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L167", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2495, - "name": "contentType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 168, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L168", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2494, - 2495 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 166, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L166", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2496, - "name": "ScheduledActorRunOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Run options for a scheduled Actor run." - } - ] - }, - "children": [ - { - "id": 2497, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 175, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L175", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2499, - "name": "memoryMbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 177, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L177", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2500, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 178, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L178", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2498, - "name": "timeoutSecs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 176, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L176", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2497, - 2499, - 2500, - 2498 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 174, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L174", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2660, - "name": "StoreCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2663, - "name": "category", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 100, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L100", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2669, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 2666, - "name": "includeUnrunnableActors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the response will include Actors that cannot be run (e.g., Actors\nthat require a linked integration account that the current user does not have)." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 107, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L107", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2668, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 2667, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - }, - { - "id": 2665, - "name": "pricingModel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 102, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L102", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2661, - "name": "search", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 98, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L98", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2662, - "name": "sortBy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 99, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L99", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2664, - "name": "username", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 101, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L101", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2663, - 2669, - 2666, - 2668, - 2667, - 2665, - 2661, - 2662, - 2664 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/store_collection.ts", - "line": 97, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/store_collection.ts#L97", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 1872, - "name": "StreamedLogOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1875, - "name": "fromStart", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to redirect all logs from Actor run start (even logs from the past)." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 273, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L273", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1873, - "name": "logClient", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log client used to communicate with the Apify API." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 269, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L269", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 1620, - "name": "LogClient", - "package": "apify-client" - } - }, - { - "id": 1874, - "name": "toLog", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Log to which the Actor run logs will be redirected." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 271, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L271", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Log" - }, - "name": "Log", - "package": "@apify/log" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1875, - 1873, - 1874 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/log.ts", - "line": 267, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/log.ts#L267", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2758, - "name": "Task", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents an Actor task.\n\nTasks are saved Actor configurations with input and settings that can be executed\nrepeatedly without having to specify the full input each time." - } - ] - }, - "children": [ - { - "id": 2761, - "name": "actId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 285, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L285", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2771, - "name": "actorStandby", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 295, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L295", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 274, - "name": "ActorStandby", - "package": "apify-client" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 2766, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 290, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L290", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 2764, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 288, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L288", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2759, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 283, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L283", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2770, - "name": "input", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 294, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L294", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - } - } - ] - } - }, - { - "id": 2767, - "name": "modifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 291, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L291", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 2762, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 286, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L286", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2769, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 293, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L293", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2774, - "name": "TaskOptions", - "package": "apify-client" - } - }, - { - "id": 2768, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 292, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L292", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2772, - "name": "TaskStats", - "package": "apify-client" - } - }, - { - "id": 2763, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 287, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L287", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2760, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 284, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L284", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2765, - "name": "username", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 289, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L289", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2761, - 2771, - 2766, - 2764, - 2759, - 2770, - 2767, - 2762, - 2769, - 2768, - 2763, - 2760, - 2765 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 282, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L282", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2783, - "name": "TaskCallOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for calling a Task and waiting for it to finish." - } - ] - }, - "children": [ - { - "id": 2786, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag or number of the Actor build to run (e.g. " - }, - { - "kind": "code", - "text": "`beta`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`1.2.345`" - }, - { - "kind": "text", - "text": ").\nIf not provided, the run uses build tag or number from the default Actor run configuration (typically " - }, - { - "kind": "code", - "text": "`latest`" - }, - { - "kind": "text", - "text": ")." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 613, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L613", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.build" - } - }, - { - "id": 2790, - "name": "maxItems", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the maximum number of dataset items that will be charged for pay-per-result Actors.\nThis does NOT guarantee that the Actor will return only this many items.\nIt only ensures you won't be charged for more than this number of items.\nOnly works for pay-per-result Actors.\nValue can be accessed in the Actor run using " - }, - { - "kind": "code", - "text": "`ACTOR_MAX_PAID_DATASET_ITEMS`" - }, - { - "kind": "text", - "text": " environment variable." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 658, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L658", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.maxItems" - } - }, - { - "id": 2791, - "name": "maxTotalChargeUsd", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies the maximum cost of the Actor run. This parameter is\nused only for pay-per-event Actors. It allows you to limit the amount\ncharged to your subscription. You can access the maximum cost in your\nActor by using the " - }, - { - "kind": "code", - "text": "`ACTOR_MAX_TOTAL_CHARGE_USD`" - }, - { - "kind": "text", - "text": " environment variable." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 666, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L666", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.maxTotalChargeUsd" - } - }, - { - "id": 2787, - "name": "memory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Memory in megabytes which will be allocated for the new Actor run.\nIf not provided, the run uses memory of the default Actor run configuration." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 627, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L627", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.memory" - } - }, - { - "id": 2785, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Determines whether the run will be restarted if it fails." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 671, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L671", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.restartOnError" - } - }, - { - "id": 2788, - "name": "timeout", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Timeout for the Actor run in seconds. Zero value means there is no timeout.\nIf not provided, the run uses timeout of the default Actor run configuration." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 632, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L632", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.timeout" - } - }, - { - "id": 2784, - "name": "waitSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 341, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L341", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2789, - "name": "webhooks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies optional webhooks associated with the Actor run, which can be used\nto receive a notification e.g. when the Actor finished or failed, see\n[ad hook webhooks documentation](https://docs.apify.com/webhooks/ad-hoc-webhooks) for detailed description." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 649, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L649", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3136, - "name": "WebhookUpdateData", - "package": "apify-client" - } - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Omit.webhooks" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2786, - 2790, - 2791, - 2787, - 2785, - 2788, - 2784, - 2789 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 340, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L340", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2782, - "name": "TaskStartOptions", - "package": "apify-client" - }, - { - "type": "literal", - "value": "waitForFinish" - } - ], - "name": "Omit", - "package": "typescript" - } - ] - }, - { - "id": 2860, - "name": "TaskCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2864, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 2861, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 91, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L91", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2863, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 2862, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2864, - 2861, - 2863, - 2862 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 90, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L90", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 2866, - "name": "TaskCreateData", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields that can be updated when modifying a Task." - } - ] - }, - "children": [ - { - "id": 2867, - "name": "actId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 97, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L97", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2871, - "name": "actorStandby", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 295, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L295", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 274, - "name": "ActorStandby", - "package": "apify-client" - } - ], - "name": "Partial", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TaskUpdateData.actorStandby" - } - }, - { - "id": 2869, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 288, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L288", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TaskUpdateData.description" - } - }, - { - "id": 2872, - "name": "input", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 294, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L294", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 34, - "name": "Dictionary", - "package": "apify-client" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TaskUpdateData.input" - } - }, - { - "id": 2868, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 286, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L286", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TaskUpdateData.name" - } - }, - { - "id": 2873, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 293, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L293", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2774, - "name": "TaskOptions", - "package": "apify-client" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TaskUpdateData.options" - } - }, - { - "id": 2870, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 287, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L287", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TaskUpdateData.title" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2867, - 2871, - 2869, - 2872, - 2868, - 2873, - 2870 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 96, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L96", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2779, - "name": "TaskUpdateData", - "package": "apify-client" - } - ] - }, - { - "id": 2780, - "name": "TaskLastRunOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for filtering the last run of a Task." - } - ] - }, - "children": [ - { - "id": 2781, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 326, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L326", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "READY" - }, - { - "type": "literal", - "value": "RUNNING" - }, - { - "type": "literal", - "value": "SUCCEEDED" - }, - { - "type": "literal", - "value": "FAILED" - }, - { - "type": "literal", - "value": "TIMING_OUT" - }, - { - "type": "literal", - "value": "TIMED_OUT" - }, - { - "type": "literal", - "value": "ABORTING" - }, - { - "type": "literal", - "value": "ABORTED" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2781 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 325, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L325", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2774, - "name": "TaskOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Configuration options for an Actor task." - } - ] - }, - "children": [ - { - "id": 2775, - "name": "build", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 309, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L309", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2777, - "name": "memoryMbytes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 311, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L311", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2778, - "name": "restartOnError", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 312, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L312", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2776, - "name": "timeoutSecs", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 310, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L310", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2775, - 2777, - 2778, - 2776 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 308, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L308", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2772, - "name": "TaskStats", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics about Actor task usage." - } - ] - }, - "children": [ - { - "id": 2773, - "name": "totalRuns", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 302, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L302", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2773 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 301, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L301", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3006, - "name": "UsageCycle", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3008, - "name": "endAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 227, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L227", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 3007, - "name": "startAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 226, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L226", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3008, - 3007 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 225, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L225", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2944, - "name": "User", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2959, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 144, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L144", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 2958, - "name": "effectivePlatformFeatures", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 143, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L143", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "EffectivePlatformFeatures" - }, - "name": "EffectivePlatformFeatures", - "package": "apify-client" - } - }, - { - "id": 2955, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 140, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L140", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2954, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 139, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L139", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2960, - "name": "isPaying", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 145, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L145", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2957, - "name": "plan", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 142, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L142", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2968, - "name": "UserPlan", - "package": "apify-client" - } - }, - { - "id": 2946, - "name": "profile", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 130, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L130", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2947, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2948, - "name": "bio", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 131, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L131", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2951, - "name": "githubUsername", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 134, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L134", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2949, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 132, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L132", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2950, - "name": "pictureUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 133, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L133", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2953, - "name": "twitterUsername", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 136, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L136", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2952, - "name": "websiteUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 135, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L135", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2948, - 2951, - 2949, - 2950, - 2953, - 2952 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 130, - "character": 13, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L130", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - }, - { - "id": 2956, - "name": "proxy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 141, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L141", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 2961, - "name": "UserProxy", - "package": "apify-client" - } - }, - { - "id": 2945, - "name": "username", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 129, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L129", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2959, - 2958, - 2955, - 2954, - 2960, - 2957, - 2946, - 2956, - 2945 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 127, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L127", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2968, - "name": "UserPlan", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2988, - "name": "availableAddOns", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 179, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L179", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "id": 2985, - "name": "availableProxyGroups", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 176, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L176", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2984, - "name": "dataRetentionDays", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 175, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L175", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2970, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 161, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L161", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2975, - "name": "enabledPlatformFeatures", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 166, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L166", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2989, - "name": "PlatformFeature", - "package": "apify-client" - } - } - }, - { - "id": 2969, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 160, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L160", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2971, - "name": "isEnabled", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 162, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L162", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2982, - "name": "maxActorCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 173, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L173", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2977, - "name": "maxActorMemoryGbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 168, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L168", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2983, - "name": "maxActorTaskCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 174, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L174", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2978, - "name": "maxMonthlyActorComputeUnits", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 169, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L169", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2981, - "name": "maxMonthlyExternalDataTransferGbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 172, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L172", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2980, - "name": "maxMonthlyProxySerps", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 171, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L171", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2979, - "name": "maxMonthlyResidentialProxyGbytes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 170, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L170", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2976, - "name": "maxMonthlyUsageUsd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 167, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L167", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2972, - "name": "monthlyBasePriceUsd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 163, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L163", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2973, - "name": "monthlyUsageCreditsUsd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 164, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L164", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2987, - "name": "supportLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 178, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L178", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2986, - "name": "teamAccountSeatCount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 177, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L177", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2974, - "name": "usageDiscountPercent", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 165, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L165", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2988, - 2985, - 2984, - 2970, - 2975, - 2969, - 2971, - 2982, - 2977, - 2983, - 2978, - 2981, - 2980, - 2979, - 2976, - 2972, - 2973, - 2987, - 2986, - 2974 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 159, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L159", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 2961, - "name": "UserProxy", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2963, - "name": "groups", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 150, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L150", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2964, - "name": "ProxyGroup", - "package": "apify-client" - } - } - }, - { - "id": 2962, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 149, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L149", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2963, - 2962 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 148, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L148", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3116, - "name": "Webhook", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a webhook for receiving notifications about Actor events.\n\nWebhooks send HTTP POST requests to specified URLs when certain events occur\n(e.g., Actor run succeeds, fails, or times out)." - } - ] - }, - "children": [ - { - "id": 3123, - "name": "condition", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 135, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L135", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3142, - "name": "WebhookCondition", - "package": "apify-client" - } - }, - { - "id": 3119, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 131, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L131", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 3133, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 145, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L145", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3125, - "name": "doNotRetry", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 137, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L137", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3122, - "name": "eventTypes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 134, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L134", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3141, - "name": "WebhookEventType", - "package": "apify-client" - } - } - }, - { - "id": 3132, - "name": "headersTemplate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 144, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L144", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3117, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 129, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L129", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3124, - "name": "ignoreSslErrors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 136, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L136", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3121, - "name": "isAdHoc", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 133, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L133", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3131, - "name": "isApifyIntegration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 143, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L143", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3128, - "name": "lastDispatch", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 140, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L140", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3120, - "name": "modifiedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 132, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L132", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 3127, - "name": "payloadTemplate", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 139, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L139", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3126, - "name": "requestUrl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 138, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L138", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3130, - "name": "shouldInterpolateStrings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 142, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L142", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3129, - "name": "stats", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 141, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L141", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3139, - "name": "WebhookStats", - "package": "apify-client" - } - }, - { - "id": 3118, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 130, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L130", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3123, - 3119, - 3133, - 3125, - 3122, - 3132, - 3117, - 3124, - 3121, - 3131, - 3128, - 3120, - 3127, - 3126, - 3130, - 3129, - 3118 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 128, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L128", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3143, - "name": "WebhookAnyRunOfActorCondition", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3144, - "name": "actorId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 197, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L197", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3144 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 196, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L196", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3145, - "name": "WebhookAnyRunOfActorTaskCondition", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3146, - "name": "actorTaskId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 201, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L201", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3146 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 200, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L200", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3147, - "name": "WebhookCertainRunCondition", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3148, - "name": "actorRunId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 205, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L205", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3148 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 204, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L204", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3217, - "name": "WebhookCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3221, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 3218, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_collection.ts", - "line": 93, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_collection.ts#L93", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3220, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 3219, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3221, - 3218, - 3220, - 3219 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook_collection.ts", - "line": 92, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_collection.ts#L92", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 3285, - "name": "WebhookDispatch", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3292, - "name": "calls", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 52, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L52", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3299, - "name": "WebhookDispatchCall", - "package": "apify-client" - } - } - }, - { - "id": 3289, - "name": "createdAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 49, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L49", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 3294, - "name": "eventData", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 54, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L54", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 3305, - "name": "WebhookDispatchEventData", - "package": "apify-client" - } - ] - } - }, - { - "id": 3291, - "name": "eventType", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 51, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L51", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3141, - "name": "WebhookEventType", - "package": "apify-client" - } - }, - { - "id": 3286, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 46, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L46", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3290, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 50, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L50", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 3295, - "name": "WebhookDispatchStatus", - "package": "apify-client" - } - }, - { - "id": 3287, - "name": "userId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 47, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L47", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3293, - "name": "webhook", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 53, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L53", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3116, - "name": "Webhook", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "isAdHoc" - }, - { - "type": "literal", - "value": "requestUrl" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 3288, - "name": "webhookId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 48, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L48", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3292, - 3289, - 3294, - 3291, - 3286, - 3290, - 3287, - 3293, - 3288 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 45, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L45", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3299, - "name": "WebhookDispatchCall", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3302, - "name": "errorMessage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 66, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L66", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 3301, - "name": "finishedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 65, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L65", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 3304, - "name": "responseBody", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 68, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L68", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 3303, - "name": "responseStatus", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 67, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L67", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 3300, - "name": "startedAt", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 64, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L64", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3302, - 3301, - 3304, - 3303, - 3300 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 63, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L63", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3375, - "name": "WebhookDispatchCollectionListOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3379, - "name": "chunkSize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator\nwill fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the\nlimit is reached or once all items from API have been fetched.\n\nChunk size is usually limited by API. Minimum of those two limits will be used." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 268, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L268", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.chunkSize" - } - }, - { - "id": 3376, - "name": "desc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch_collection.ts", - "line": 72, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch_collection.ts#L72", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3378, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of entries requested." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 261, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L261", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.limit" - } - }, - { - "id": 3377, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true, - "isInherited": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Position of the first returned entry." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 259, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L259", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "PaginationOptions.offset" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3379, - 3376, - 3378, - 3377 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch_collection.ts", - "line": 71, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch_collection.ts#L71", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions" - }, - "name": "PaginationOptions", - "package": "apify-client" - } - ] - }, - { - "id": 3305, - "name": "WebhookDispatchEventData", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3309, - "name": "actorBuildId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 75, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L75", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3307, - "name": "actorId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 73, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L73", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3306, - "name": "actorRunId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 72, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L72", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3308, - "name": "actorTaskId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 74, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L74", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3309, - 3307, - 3306, - 3308 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook_dispatch.ts", - "line": 71, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook_dispatch.ts#L71", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3134, - "name": "WebhookIdempotencyKey", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3135, - "name": "idempotencyKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 149, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L149", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3135 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 148, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L148", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 3139, - "name": "WebhookStats", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statistics about webhook usage." - } - ] - }, - "children": [ - { - "id": 3140, - "name": "totalDispatches", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 180, - "character": 4, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L180", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3140 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 179, - "character": 17, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L179", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - }, - { - "id": 461, - "name": "ActorChargeEvents", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of event names to their pricing information." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 937, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L937", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 457, - "name": "ActorChargeEvent", - "package": "apify-client" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 559, - "name": "ActorCollectionListResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_collection.ts", - "line": 111, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_collection.ts#L111", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 26, - "typeArguments": [ - { - "type": "reference", - "target": 553, - "name": "ActorCollectionListItem", - "package": "apify-client" - } - ], - "name": "PaginatedList", - "package": "apify-client" - } - }, - { - "id": 717, - "name": "ActorEnvVarListResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_env_var_collection.ts", - "line": 91, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_env_var_collection.ts#L91", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 26, - "typeArguments": [ - { - "type": "reference", - "target": 835, - "name": "ActorEnvironmentVariable", - "package": "apify-client" - } - ], - "name": "PaginatedList", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "total" - }, - { - "type": "literal", - "value": "items" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 474, - "name": "ActorRunPricingInfo", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Union type representing all possible Actor pricing models." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 955, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L955", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 462, - "name": "PricePerEventActorPricingInfo", - "package": "apify-client" - }, - { - "type": "reference", - "target": 447, - "name": "PricePerDatasetItemActorPricingInfo", - "package": "apify-client" - }, - { - "type": "reference", - "target": 437, - "name": "FlatPricePerMonthActorPricingInfo", - "package": "apify-client" - }, - { - "type": "reference", - "target": 429, - "name": "FreeActorPricingInfo", - "package": "apify-client" - } - ] - } - }, - { - "id": 268, - "name": "ActorTaggedBuilds", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mapping of build tags (e.g., 'latest', 'beta') to their corresponding build information." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 558, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L558", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 269, - "name": "ActorTaggedBuild", - "package": "apify-client" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 273, - "name": "ActorUpdateOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields that can be updated when modifying an Actor." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/actor.ts", - "line": 572, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor.ts#L572", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 223, - "name": "Actor", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "description" - }, - { - "type": "literal", - "value": "isPublic" - }, - { - "type": "literal", - "value": "isDeprecated" - }, - { - "type": "literal", - "value": "seoTitle" - }, - { - "type": "literal", - "value": "seoDescription" - }, - { - "type": "literal", - "value": "title" - }, - { - "type": "literal", - "value": "restartOnError" - }, - { - "type": "literal", - "value": "versions" - }, - { - "type": "literal", - "value": "categories" - }, - { - "type": "literal", - "value": "defaultRunOptions" - }, - { - "type": "literal", - "value": "actorStandby" - }, - { - "type": "literal", - "value": "actorPermissionLevel" - }, - { - "type": "literal", - "value": "taggedBuilds" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 839, - "name": "ActorVersion", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 142, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L142", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 798, - "name": "ActorVersionSourceFiles", - "package": "apify-client" - }, - { - "type": "reference", - "target": 809, - "name": "ActorVersionGitRepo", - "package": "apify-client" - }, - { - "type": "reference", - "target": 816, - "name": "ActorVersionTarball", - "package": "apify-client" - }, - { - "type": "reference", - "target": 823, - "name": "ActorVersionGitHubGist", - "package": "apify-client" - } - ] - } - }, - { - "id": 914, - "name": "ActorVersionListResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version_collection.ts", - "line": 90, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version_collection.ts#L90", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 26, - "typeArguments": [ - { - "type": "reference", - "target": 840, - "name": "FinalActorVersion", - "package": "apify-client" - } - ], - "name": "PaginatedList", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "total" - }, - { - "type": "literal", - "value": "items" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 2110, - "name": "AllowedHttpMethods", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "HTTP methods supported by Request Queue requests." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1050, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1050", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "HEAD" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "TRACE" - }, - { - "type": "literal", - "value": "OPTIONS" - }, - { - "type": "literal", - "value": "CONNECT" - }, - { - "type": "literal", - "value": "PATCH" - } - ] - } - }, - { - "id": 1119, - "name": "BuildCollectionClientListItem", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build_collection.ts", - "line": 78, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build_collection.ts#L78", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Required" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 998, - "name": "Build", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "id" - }, - { - "type": "literal", - "value": "status" - }, - { - "type": "literal", - "value": "startedAt" - }, - { - "type": "literal", - "value": "finishedAt" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "Required", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 998, - "name": "Build", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "meta" - }, - { - "type": "literal", - "value": "usageTotalUsd" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - ] - } - }, - { - "id": 1120, - "name": "BuildCollectionClientListResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/build_collection.ts", - "line": 81, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/build_collection.ts#L81", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": 26, - "typeArguments": [ - { - "type": "reference", - "target": 1119, - "name": "BuildCollectionClientListItem", - "package": "apify-client" - } - ], - "name": "PaginatedList", - "package": "apify-client" - } - }, - { - "id": 1379, - "name": "DatasetCollectionClientListResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 105, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L105", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 26, - "typeArguments": [ - { - "type": "reference", - "target": 1210, - "name": "Dataset", - "package": "apify-client" - } - ], - "name": "PaginatedList", - "package": "apify-client" - }, - { - "type": "reflection", - "declaration": { - "id": 1380, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1381, - "name": "unnamed", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 105, - "character": 75, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L105", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1381 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/dataset_collection.ts", - "line": 105, - "character": 73, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/dataset_collection.ts#L105", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - }, - { - "id": 34, - "name": "Dictionary", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generic dictionary type (key-value map)." - } - ] - }, - "sources": [ - { - "fileName": "src/utils.ts", - "line": 328, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/utils.ts#L328", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 35, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of values in the dictionary" - } - ] - }, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "PropertyKey" - }, - "name": "PropertyKey", - "package": "typescript" - }, - { - "type": "reference", - "target": 35, - "name": "T", - "package": "apify-client", - "refersToTypeParameter": true - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 840, - "name": "FinalActorVersion", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/actor_version.ts", - "line": 144, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/actor_version.ts#L144", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 839, - "name": "ActorVersion", - "package": "apify-client" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Required" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 839, - "name": "ActorVersion", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "versionNumber" - }, - { - "type": "literal", - "value": "buildTag" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "Required", - "package": "typescript" - } - ] - } - }, - { - "id": 1617, - "name": "KeyValueStoreCollectionListResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 108, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L108", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 26, - "typeArguments": [ - { - "type": "reference", - "target": 1476, - "name": "KeyValueStore", - "package": "apify-client" - } - ], - "name": "PaginatedList", - "package": "apify-client" - }, - { - "type": "reflection", - "declaration": { - "id": 1618, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1619, - "name": "unnamed", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 108, - "character": 81, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L108", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1619 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/key_value_store_collection.ts", - "line": 108, - "character": 79, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store_collection.ts#L108", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - }, - { - "id": 3028, - "name": "LimitsUpdateOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 288, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L288", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 3029, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3030, - "name": "maxMonthlyUsageUsd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 288, - "character": 36, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L288", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3030 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 288, - "character": 34, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L288", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 3031, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3032, - "name": "dataRetentionDays", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 288, - "character": 69, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L288", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3032 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/user.ts", - "line": 288, - "character": 67, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/user.ts#L288", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - }, - { - "id": 2109, - "name": "RequestQueueClientGetRequestResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1045, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1045", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2065, - "name": "RequestQueueClientListItem", - "package": "apify-client" - }, - { - "type": "literal", - "value": "retryCount" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 2108, - "name": "RequestQueueClientRequestToDelete", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1041, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1041", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2086, - "name": "RequestQueueClientRequestSchema", - "package": "apify-client" - }, - { - "type": "literal", - "value": "id" - } - ], - "name": "Pick", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2086, - "name": "RequestQueueClientRequestSchema", - "package": "apify-client" - }, - { - "type": "literal", - "value": "uniqueKey" - } - ], - "name": "Pick", - "package": "typescript" - } - ] - } - }, - { - "id": 2188, - "name": "RequestQueueCollectionListResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 99, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L99", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 26, - "typeArguments": [ - { - "type": "reference", - "target": 2001, - "name": "RequestQueue", - "package": "apify-client" - } - ], - "name": "PaginatedList", - "package": "apify-client" - }, - { - "type": "reflection", - "declaration": { - "id": 2189, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2190, - "name": "unnamed", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 99, - "character": 79, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L99", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2190 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/request_queue_collection.ts", - "line": 99, - "character": 77, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue_collection.ts#L99", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - }, - { - "id": 2036, - "name": "RequestQueueListRequestsFilter", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 890, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L890", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "locked" - }, - { - "type": "literal", - "value": "pending" - } - ] - } - }, - { - "id": 2111, - "name": "RequestQueueRequestsAsyncIterable", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/request_queue.ts", - "line": 1052, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/request_queue.ts#L1052", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 2112, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es2018.asynciterable.d.ts", - "qualifiedName": "AsyncIterable" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2112, - "name": "T", - "package": "apify-client", - "refersToTypeParameter": true - } - ], - "name": "AsyncIterable", - "package": "typescript" - } - }, - { - "id": 1537, - "name": "ReturnTypeFromOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Helper type to determine the return type based on getRecord options.\n\nReturns Readable if stream option is true, Buffer if buffer option is true,\notherwise returns JsonValue." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/key_value_store.ts", - "line": 629, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/key_value_store.ts#L629", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "typeParameters": [ - { - "id": 1538, - "name": "Options", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 1525, - "name": "KeyValueClientGetRecordOptions", - "package": "apify-client" - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "stream" - }, - "objectType": { - "type": "reference", - "target": 1538, - "name": "Options", - "package": "apify-client", - "refersToTypeParameter": true - } - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/stream.d.ts", - "qualifiedName": "Stream.Readable" - }, - "name": "Readable", - "package": "@types/node", - "qualifiedName": "Stream.Readable" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "buffer" - }, - "objectType": { - "type": "reference", - "target": 1538, - "name": "Options", - "package": "apify-client", - "refersToTypeParameter": true - } - }, - "extendsType": { - "type": "literal", - "value": true - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@types/node/buffer.buffer.d.ts", - "qualifiedName": "__global.Buffer" - }, - "name": "Buffer", - "package": "@types/node", - "qualifiedName": "__global.Buffer" - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/type-fest/source/basic.d.ts", - "qualifiedName": "JsonValue" - }, - "name": "JsonValue", - "package": "type-fest" - } - } - } - }, - { - "id": 2486, - "name": "ScheduleAction", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Union type representing all possible scheduled actions." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 152, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L152", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 2487, - "name": "ScheduleActionRunActor", - "package": "apify-client" - }, - { - "type": "reference", - "target": 2501, - "name": "ScheduleActionRunActorTask", - "package": "apify-client" - } - ] - } - }, - { - "id": 2480, - "name": "ScheduleCreateOrUpdateData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data for creating or updating a Schedule." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 127, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L127", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2462, - "name": "Schedule", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "title" - }, - { - "type": "literal", - "value": "cronExpression" - }, - { - "type": "literal", - "value": "timezone" - }, - { - "type": "literal", - "value": "isEnabled" - }, - { - "type": "literal", - "value": "isExclusive" - }, - { - "type": "literal", - "value": "description" - }, - { - "type": "literal", - "value": "notifications" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 2481, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2482, - "name": "actions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 132, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L132", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "DistributiveOptional" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2486, - "name": "ScheduleAction", - "package": "apify-client" - }, - { - "type": "literal", - "value": "id" - } - ], - "name": "DistributiveOptional", - "package": "apify-client" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2482 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/schedule.ts", - "line": 131, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/schedule.ts#L131", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 2865, - "name": "TaskList", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/task_collection.ts", - "line": 94, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task_collection.ts#L94", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2758, - "name": "Task", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "options" - }, - { - "type": "literal", - "value": "input" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 2782, - "name": "TaskStartOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Options for starting a Task.\n\nSimilar to " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "ActorStartOptions", - "target": 282 - }, - { - "kind": "text", - "text": " but without contentType (Task input is predefined)\nand forcePermissionLevel." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 335, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L335", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 282, - "name": "ActorStartOptions", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "contentType" - }, - { - "type": "literal", - "value": "forcePermissionLevel" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 2779, - "name": "TaskUpdateData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields that can be updated when modifying a Task." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/task.ts", - "line": 318, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/task.ts#L318", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2758, - "name": "Task", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "title" - }, - { - "type": "literal", - "value": "description" - }, - { - "type": "literal", - "value": "options" - }, - { - "type": "literal", - "value": "input" - }, - { - "type": "literal", - "value": "actorStandby" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - }, - "extendedBy": [ - { - "type": "reference", - "target": 2866, - "name": "TaskCreateData" - } - ] - }, - { - "id": 3142, - "name": "WebhookCondition", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Condition that determines when a webhook should be triggered." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 191, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L191", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3143, - "name": "WebhookAnyRunOfActorCondition", - "package": "apify-client" - }, - { - "type": "reference", - "target": 3145, - "name": "WebhookAnyRunOfActorTaskCondition", - "package": "apify-client" - }, - { - "type": "reference", - "target": 3147, - "name": "WebhookCertainRunCondition", - "package": "apify-client" - } - ] - } - }, - { - "id": 3141, - "name": "WebhookEventType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event types that can trigger webhooks." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 186, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L186", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "indexedAccess", - "indexType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "WEBHOOK_EVENT_TYPES" - }, - "name": "WEBHOOK_EVENT_TYPES", - "package": "@apify/consts", - "preferValues": true - } - } - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/@apify/consts/cjs/index.d.ts", - "qualifiedName": "WEBHOOK_EVENT_TYPES" - }, - "name": "WEBHOOK_EVENT_TYPES", - "package": "@apify/consts", - "preferValues": true - } - } - } - }, - { - "id": 3136, - "name": "WebhookUpdateData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data for updating a webhook." - } - ] - }, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 155, - "character": 12, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L155", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3116, - "name": "Webhook", - "package": "apify-client" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "isAdHoc" - }, - { - "type": "literal", - "value": "condition" - }, - { - "type": "literal", - "value": "ignoreSslErrors" - }, - { - "type": "literal", - "value": "doNotRetry" - }, - { - "type": "literal", - "value": "requestUrl" - }, - { - "type": "literal", - "value": "payloadTemplate" - }, - { - "type": "literal", - "value": "shouldInterpolateStrings" - }, - { - "type": "literal", - "value": "isApifyIntegration" - }, - { - "type": "literal", - "value": "headersTemplate" - }, - { - "type": "literal", - "value": "description" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3137, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3138, - "name": "eventTypes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 171, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L171", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ], - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3141, - "name": "WebhookEventType", - "package": "apify-client" - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3138 - ] - } - ], - "sources": [ - { - "fileName": "src/resource_clients/webhook.ts", - "line": 168, - "character": 8, - "url": "https://github.com/apify/apify-client-js/blob/6168f70372dc328d9cabac0a866ba88b1045ba44/src/resource_clients/webhook.ts#L168", - "gitRevision": "6168f70372dc328d9cabac0a866ba88b1045ba44" - } - ] - } - } - ] - } - ], - "name": "Partial", - "package": "typescript" - }, - { - "type": "reference", - "target": 3134, - "name": "WebhookIdempotencyKey", - "package": "apify-client" - } - ] - } - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [ - 543, - 830, - 1266, - 2989, - 2483, - 3295 - ] - }, - { - "title": "Classes", - "children": [ - 126, - 475, - 576, - 644, - 718, - 841, - 3380, - 36, - 915, - 1049, - 1121, - 1301, - 1, - 1382, - 1539, - 1620, - 1689, - 1876, - 2113, - 2191, - 2317, - 2390, - 2506, - 2581, - 1850, - 2670, - 2792, - 2874, - 3044, - 3149, - 3222, - 3310 - ] - }, - { - "title": "Interfaces", - "children": [ - 3009, - 223, - 404, - 293, - 457, - 560, - 553, - 546, - 260, - 411, - 835, - 712, - 265, - 409, - 335, - 305, - 376, - 396, - 380, - 319, - 363, - 274, - 282, - 251, - 2648, - 269, - 909, - 823, - 809, - 805, - 798, - 816, - 117, - 791, - 998, - 990, - 992, - 1114, - 994, - 1021, - 1017, - 1015, - 3033, - 1210, - 1251, - 1274, - 1237, - 1233, - 1377, - 1370, - 1294, - 1228, - 1296, - 437, - 429, - 2290, - 1507, - 1525, - 1501, - 1514, - 1497, - 1521, - 1476, - 1615, - 1608, - 1529, - 1534, - 1491, - 3016, - 1687, - 2997, - 3013, - 1026, - 26, - 447, - 462, - 2646, - 2964, - 2001, - 2072, - 2099, - 2081, - 2105, - 2077, - 2054, - 2057, - 2029, - 2031, - 2065, - 2037, - 2048, - 2042, - 2074, - 2079, - 2086, - 2103, - 2025, - 2181, - 2019, - 1998, - 2295, - 2311, - 2382, - 2293, - 2297, - 2304, - 2300, - 2315, - 2462, - 2487, - 2501, - 2576, - 2493, - 2496, - 2660, - 1872, - 2758, - 2783, - 2860, - 2866, - 2780, - 2774, - 2772, - 3006, - 2944, - 2968, - 2961, - 3116, - 3143, - 3145, - 3147, - 3217, - 3285, - 3299, - 3375, - 3305, - 3134, - 3139 - ] - }, - { - "title": "Type Aliases", - "children": [ - 461, - 559, - 717, - 474, - 268, - 273, - 839, - 914, - 2110, - 1119, - 1120, - 1379, - 34, - 840, - 1617, - 3028, - 2109, - 2108, - 2188, - 2036, - 2111, - 1537, - 2486, - 2480, - 2865, - 2782, - 2779, - 3142, - 3141, - 3136 - ] - } - ], - "packageName": "apify-client", - "packageVersion": "2.23.4", - "readme": [ - { - "kind": "text", - "text": "# Apify API client for JavaScript\n\n[![npm version](https://badge.fury.io/js/apify-client.svg)](https://www.npmjs.com/package/apify-client)\n[![Downloads](https://img.shields.io/npm/dm/apify-client.svg)](https://www.npmjs.com/package/apify-client)\n[![Chat on discord](https://img.shields.io/discord/801163717915574323?label=discord)](https://discord.gg/jyEM2PRvMU)\n[![Build Status](https://github.com/apify/apify-client-js/actions/workflows/check.yaml/badge.svg?branch=master)](https://github.com/apify/apify-client-js/actions/workflows/check.yaml)\n\n" - }, - { - "kind": "code", - "text": "`apify-client`" - }, - { - "kind": "text", - "text": " is the official library to access [Apify API](https://docs.apify.com/api/v2) from your\nJavaScript applications. It runs both in Node.js and browser and provides useful features like\nautomatic retries and convenience functions that improve the experience of using the Apify API.\n\n\n\n- [Quick Start](#quick-start)\n- [Features](#features)\n - [Automatic parsing and error handling](#automatic-parsing-and-error-handling)\n - [Retries with exponential backoff](#retries-with-exponential-backoff)\n - [Convenience functions and options](#convenience-functions-and-options)\n- [Usage concepts](#usage-concepts)\n - [Nested clients](#nested-clients)\n - [Pagination](#pagination)\n- [API Reference](#api-reference)\n\n\n\n## Quick Start\n\n" - }, - { - "kind": "code", - "text": "```js\nconst { ApifyClient } = require('apify-client');\n\nconst client = new ApifyClient({\n token: 'MY-APIFY-TOKEN',\n});\n\n// Starts an actor and waits for it to finish.\nconst { defaultDatasetId } = await client.actor('john-doe/my-cool-actor').call();\n// Fetches results from the actor's dataset.\nconst { items } = await client.dataset(defaultDatasetId).listItems();\n```" - }, - { - "kind": "text", - "text": "\n\n## Features\n\nBesides greatly simplifying the process of querying the Apify API, the client provides other useful features.\n\n### Automatic parsing and error handling\n\nBased on the endpoint, the client automatically extracts the relevant data and returns it in the\nexpected format. Date strings are automatically converted to " - }, - { - "kind": "code", - "text": "`Date`" - }, - { - "kind": "text", - "text": " objects. For exceptions,\nwe throw an " - }, - { - "kind": "code", - "text": "`ApifyApiError`" - }, - { - "kind": "text", - "text": ", which wraps the plain JSON errors returned by API and enriches\nthem with other context for easier debugging.\n\n### Retries with exponential backoff\n\nNetwork communication sometimes fails, that's a given. The client will automatically retry requests that\nfailed due to a network error, an internal error of the Apify API (HTTP 500+) or rate limit error (HTTP 429).\nBy default, it will retry up to 8 times. First retry will be attempted after ~500ms, second after ~1000ms\nand so on. You can configure those parameters using the " - }, - { - "kind": "code", - "text": "`maxRetries`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`minDelayBetweenRetriesMillis`" - }, - { - "kind": "text", - "text": "\noptions of the " - }, - { - "kind": "code", - "text": "`ApifyClient`" - }, - { - "kind": "text", - "text": " constructor.\n\n### Convenience functions and options\n\nSome actions can't be performed by the API itself, such as indefinite waiting for an actor run to finish\n(because of network timeouts). The client provides convenient " - }, - { - "kind": "code", - "text": "`call()`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`waitForFinish()`" - }, - { - "kind": "text", - "text": " functions that do that.\nKey-value store records can be retrieved as objects, buffers or streams via the respective options, dataset items\ncan be fetched as individual objects or serialized data and we plan to add better stream support and async iterators.\n\n## Usage concepts\n\nThe " - }, - { - "kind": "code", - "text": "`ApifyClient`" - }, - { - "kind": "text", - "text": " interface follows a generic pattern that is applicable to all of its components.\nBy calling individual methods of " - }, - { - "kind": "code", - "text": "`ApifyClient`" - }, - { - "kind": "text", - "text": ", specific clients which target individual API\nresources are created. There are two types of those clients. A client for management of a single\nresource and a client for a collection of resources.\n\n" - }, - { - "kind": "code", - "text": "```js\nconst { ApifyClient } = require('apify-client');\nconst apifyClient = new ApifyClient({ token: 'my-token' });\n\n// Collection clients do not require a parameter.\nconst actorCollectionClient = apifyClient.actors();\n// Creates an actor with the name: my-actor.\nconst myActor = await actorCollectionClient.create({ name: 'my-actor' });\n// Lists all of your actors.\nconst { items } = await actorCollectionClient.list();\n```" - }, - { - "kind": "text", - "text": "\n\n" - }, - { - "kind": "code", - "text": "```js\n// Collection clients do not require a parameter.\nconst datasetCollectionClient = apifyClient.datasets();\n// Gets (or creates, if it doesn't exist) a dataset with the name of my-dataset.\nconst myDataset = await datasetCollectionClient.getOrCreate('my-dataset');\n```" - }, - { - "kind": "text", - "text": "\n\n" - }, - { - "kind": "code", - "text": "```js\n// Resource clients accept an ID of the resource.\nconst actorClient = apifyClient.actor('john-doe/my-actor');\n// Fetches the john-doe/my-actor object from the API.\nconst myActor = await actorClient.get();\n// Starts the run of john-doe/my-actor and returns the Run object.\nconst myActorRun = await actorClient.start();\n```" - }, - { - "kind": "text", - "text": "\n\n" - }, - { - "kind": "code", - "text": "```js\n// Resource clients accept an ID of the resource.\nconst datasetClient = apifyClient.dataset('john-doe/my-dataset');\n// Appends items to the end of john-doe/my-dataset.\nawait datasetClient.pushItems([{ foo: 1 }, { bar: 2 }]);\n```" - }, - { - "kind": "text", - "text": "\n\n> The ID of the resource can be either the " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " of the said resource,\n> or a combination of your " - }, - { - "kind": "code", - "text": "`username/resource-name`" - }, - { - "kind": "text", - "text": ".\n\nThis is really all you need to remember, because all resource clients\nfollow the pattern you see above.\n\n### Nested clients\n\nSometimes clients return other clients. That's to simplify working with\nnested collections, such as runs of a given actor.\n\n" - }, - { - "kind": "code", - "text": "```js\nconst actorClient = apifyClient.actor('john-doe/hello-world');\nconst runsClient = actorClient.runs();\n// Lists the last 10 runs of the john-doe/hello-world actor.\nconst { items } = await runsClient.list({ limit: 10, desc: true });\n\n// Selects the last run of the john-doe/hello-world actor that finished\n// with a SUCCEEDED status.\nconst lastSucceededRunClient = actorClient.lastRun({ status: 'SUCCEEDED' });\n// Fetches items from the run's dataset.\nconst { items } = await lastSucceededRunClient.dataset().listItems();\n```" - }, - { - "kind": "text", - "text": "\n\n> The quick access to " - }, - { - "kind": "code", - "text": "`dataset`" - }, - { - "kind": "text", - "text": " and other storages directly from the run\n> client can now only be used with the " - }, - { - "kind": "code", - "text": "`lastRun()`" - }, - { - "kind": "text", - "text": " method, but the feature\n> will be available to all runs in the future.\n\n### Pagination\n\nMost methods named " - }, - { - "kind": "code", - "text": "`list`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`listSomething`" - }, - { - "kind": "text", - "text": " return a [Promise.<PaginationList>](/api/interface/PaginatedList).\nThere are some exceptions though, like " - }, - { - "kind": "code", - "text": "`listKeys`" - }, - { - "kind": "text", - "text": " or " - }, - { - "kind": "code", - "text": "`listHead`" - }, - { - "kind": "text", - "text": " which paginate differently.\nThe results you're looking for are always stored under " - }, - { - "kind": "code", - "text": "`items`" - }, - { - "kind": "text", - "text": " and you can use the " - }, - { - "kind": "code", - "text": "`limit`" - }, - { - "kind": "text", - "text": "\nproperty to get only a subset of results. Other props are also available, depending on the method.\n\n## Bundled environments\n\nThe package includes a pre-built browser bundle that is automatically resolved by bundlers targeting browser environments. You can also import it explicitly via\n\n" - }, - { - "kind": "code", - "text": "```typescript\nimport { ApifyClient } from 'apify-client/browser';\n```" - }, - { - "kind": "text", - "text": "\n\nFor edge runtimes like Cloudflare Workers, you may need to enable Node compatibility (e.g. " - }, - { - "kind": "code", - "text": "`node_compat = true`" - }, - { - "kind": "text", - "text": " in " - }, - { - "kind": "code", - "text": "`wrangler.toml`" - }, - { - "kind": "text", - "text": "). Note that some Node-specific features (streaming, proxy support) are not available in the bundle.\n\n## API Reference\n\nAll public classes, methods and their parameters can be inspected in the [API reference](https://docs.apify.com/api/client/js/reference)." - } - ], - "symbolIdMap": { - "0": { - "sourceFileName": "../src/index.ts", - "qualifiedName": "" - }, - "1": { - "sourceFileName": "../src/interceptors.ts", - "qualifiedName": "InvalidResponseBodyError" - }, - "2": { - "sourceFileName": "../node_modules/typescript/lib/lib.esnext.error.d.ts", - "qualifiedName": "ErrorConstructor.isError" - }, - "3": { - "sourceFileName": "../node_modules/typescript/lib/lib.esnext.error.d.ts", - "qualifiedName": "ErrorConstructor.isError" - }, - "4": { - "sourceFileName": "../node_modules/typescript/lib/lib.esnext.error.d.ts", - "qualifiedName": "error" - }, - "5": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.captureStackTrace" - }, - "6": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.captureStackTrace" - }, - "7": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "targetObject" - }, - "8": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "constructorOpt" - }, - "9": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.prepareStackTrace" - }, - "10": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.prepareStackTrace" - }, - "11": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "err" - }, - "12": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "stackTraces" - }, - "13": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.stackTraceLimit" - }, - "14": { - "sourceFileName": "../src/interceptors.ts", - "qualifiedName": "InvalidResponseBodyError.__constructor" - }, - "15": { - "sourceFileName": "../src/interceptors.ts", - "qualifiedName": "InvalidResponseBodyError" - }, - "16": { - "sourceFileName": "../src/interceptors.ts", - "qualifiedName": "response" - }, - "17": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "18": { - "sourceFileName": "../src/interceptors.ts", - "qualifiedName": "cause" - }, - "19": { - "sourceFileName": "../src/interceptors.ts", - "qualifiedName": "InvalidResponseBodyError.code" - }, - "20": { - "sourceFileName": "../src/interceptors.ts", - "qualifiedName": "InvalidResponseBodyError.response" - }, - "21": { - "sourceFileName": "", - "qualifiedName": "__type" - }, - "22": { - "sourceFileName": "../src/interceptors.ts", - "qualifiedName": "InvalidResponseBodyError.cause" - }, - "23": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error.name" - }, - "24": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error.message" - }, - "25": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error.stack" - }, - "26": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedList" - }, - "27": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedList.count" - }, - "28": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedList.offset" - }, - "29": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedList.limit" - }, - "30": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedList.desc" - }, - "31": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedResponse.total" - }, - "32": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedResponse.items" - }, - "33": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginatedList.Data" - }, - "34": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "Dictionary" - }, - "35": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "T" - }, - "36": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient" - }, - "37": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.__constructor" - }, - "38": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient" - }, - "39": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "options" - }, - "40": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.baseUrl" - }, - "41": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.publicBaseUrl" - }, - "42": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.token" - }, - "43": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.stats" - }, - "44": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.logger" - }, - "45": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.httpClient" - }, - "53": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.actors" - }, - "54": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.actors" - }, - "55": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.actor" - }, - "56": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.actor" - }, - "57": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "58": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.builds" - }, - "59": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.builds" - }, - "60": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.build" - }, - "61": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.build" - }, - "62": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "63": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.datasets" - }, - "64": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.datasets" - }, - "65": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.dataset" - }, - "66": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.dataset" - }, - "67": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "Data" - }, - "68": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "69": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.keyValueStores" - }, - "70": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.keyValueStores" - }, - "71": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.keyValueStore" - }, - "72": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.keyValueStore" - }, - "73": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "74": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.log" - }, - "75": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.log" - }, - "76": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "buildOrRunId" - }, - "77": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.requestQueues" - }, - "78": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.requestQueues" - }, - "79": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.requestQueue" - }, - "80": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.requestQueue" - }, - "81": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "82": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "options" - }, - "83": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.runs" - }, - "84": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.runs" - }, - "85": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.run" - }, - "86": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.run" - }, - "87": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "88": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.tasks" - }, - "89": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.tasks" - }, - "90": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.task" - }, - "91": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.task" - }, - "92": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "93": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.schedules" - }, - "94": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.schedules" - }, - "95": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.schedule" - }, - "96": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.schedule" - }, - "97": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "98": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.user" - }, - "99": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.user" - }, - "100": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "101": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.webhooks" - }, - "102": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.webhooks" - }, - "103": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.webhook" - }, - "104": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.webhook" - }, - "105": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "106": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.webhookDispatches" - }, - "107": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.webhookDispatches" - }, - "108": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.webhookDispatch" - }, - "109": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.webhookDispatch" - }, - "110": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "id" - }, - "111": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.store" - }, - "112": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.store" - }, - "113": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.setStatusMessage" - }, - "114": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClient.setStatusMessage" - }, - "115": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "message" - }, - "116": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "options" - }, - "117": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClientOptions" - }, - "118": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClientOptions.baseUrl" - }, - "119": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClientOptions.publicBaseUrl" - }, - "120": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClientOptions.maxRetries" - }, - "121": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClientOptions.minDelayBetweenRetriesMillis" - }, - "122": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClientOptions.requestInterceptors" - }, - "123": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClientOptions.timeoutSecs" - }, - "124": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClientOptions.token" - }, - "125": { - "sourceFileName": "../src/apify_client.ts", - "qualifiedName": "ApifyClientOptions.userAgentSuffix" - }, - "126": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient" - }, - "130": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.get" - }, - "131": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.get" - }, - "132": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.update" - }, - "133": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.update" - }, - "134": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "newFields" - }, - "135": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.delete" - }, - "136": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.delete" - }, - "137": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.start" - }, - "138": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.start" - }, - "139": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "input" - }, - "140": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "options" - }, - "141": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.call" - }, - "142": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.call" - }, - "143": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "input" - }, - "144": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "options" - }, - "145": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.build" - }, - "146": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.build" - }, - "147": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "versionNumber" - }, - "148": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "options" - }, - "149": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.defaultBuild" - }, - "150": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.defaultBuild" - }, - "151": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "options" - }, - "152": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.lastRun" - }, - "153": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.lastRun" - }, - "154": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "options" - }, - "155": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.builds" - }, - "156": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.builds" - }, - "157": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.runs" - }, - "158": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.runs" - }, - "159": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.version" - }, - "160": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.version" - }, - "161": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "versionNumber" - }, - "162": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.versions" - }, - "163": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.versions" - }, - "164": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.webhooks" - }, - "165": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorClient.webhooks" - }, - "187": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "188": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "189": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "190": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "191": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "192": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "193": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "194": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "195": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "223": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor" - }, - "224": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.id" - }, - "225": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.userId" - }, - "226": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.name" - }, - "227": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.username" - }, - "228": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.description" - }, - "229": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.restartOnError" - }, - "230": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.isPublic" - }, - "231": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.isAnonymouslyRunnable" - }, - "232": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.createdAt" - }, - "233": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.modifiedAt" - }, - "234": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.stats" - }, - "235": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.versions" - }, - "236": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.pricingInfos" - }, - "237": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.defaultRunOptions" - }, - "238": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.exampleRunInput" - }, - "239": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.isDeprecated" - }, - "240": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.deploymentKey" - }, - "241": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.title" - }, - "242": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.taggedBuilds" - }, - "243": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.seoTitle" - }, - "244": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.seoDescription" - }, - "245": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.categories" - }, - "246": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.actorStandby" - }, - "247": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type" - }, - "248": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type.isEnabled" - }, - "249": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.actorPermissionLevel" - }, - "250": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "Actor.readmeSummary" - }, - "251": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStats" - }, - "252": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStats.totalBuilds" - }, - "253": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStats.totalRuns" - }, - "254": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStats.totalUsers" - }, - "255": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStats.totalUsers7Days" - }, - "256": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStats.totalUsers30Days" - }, - "257": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStats.totalUsers90Days" - }, - "258": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStats.totalMetamorphs" - }, - "259": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStats.lastRunStartedAt" - }, - "260": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefaultRunOptions" - }, - "261": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefaultRunOptions.build" - }, - "262": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefaultRunOptions.timeoutSecs" - }, - "263": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefaultRunOptions.memoryMbytes" - }, - "264": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefaultRunOptions.restartOnError" - }, - "265": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorExampleRunInput" - }, - "266": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorExampleRunInput.body" - }, - "267": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorExampleRunInput.contentType" - }, - "268": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorTaggedBuilds" - }, - "269": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorTaggedBuild" - }, - "270": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorTaggedBuild.buildId" - }, - "271": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorTaggedBuild.buildNumber" - }, - "272": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorTaggedBuild.finishedAt" - }, - "273": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorUpdateOptions" - }, - "274": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStandby" - }, - "275": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStandby.build" - }, - "276": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStandby.desiredRequestsPerActorRun" - }, - "277": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStandby.disableStandbyFieldsOverride" - }, - "278": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStandby.idleTimeoutSecs" - }, - "279": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStandby.maxRequestsPerActorRun" - }, - "280": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStandby.memoryMbytes" - }, - "281": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStandby.shouldPassActorInput" - }, - "282": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions" - }, - "283": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.build" - }, - "284": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.contentType" - }, - "285": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.memory" - }, - "286": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.timeout" - }, - "287": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.waitForFinish" - }, - "288": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.webhooks" - }, - "289": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.maxItems" - }, - "290": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.maxTotalChargeUsd" - }, - "291": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.restartOnError" - }, - "292": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorStartOptions.forcePermissionLevel" - }, - "293": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorCallOptions" - }, - "294": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorCallOptions.waitSecs" - }, - "295": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorCallOptions.log" - }, - "296": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "restartOnError" - }, - "297": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "build" - }, - "298": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "contentType" - }, - "299": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "memory" - }, - "300": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "timeout" - }, - "301": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "webhooks" - }, - "302": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "maxItems" - }, - "303": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "maxTotalChargeUsd" - }, - "304": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "forcePermissionLevel" - }, - "305": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem" - }, - "306": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.id" - }, - "307": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.actId" - }, - "308": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.actorTaskId" - }, - "309": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.startedAt" - }, - "310": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.finishedAt" - }, - "311": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.status" - }, - "312": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.meta" - }, - "313": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.buildId" - }, - "314": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.buildNumber" - }, - "315": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.defaultKeyValueStoreId" - }, - "316": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.defaultDatasetId" - }, - "317": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.defaultRequestQueueId" - }, - "318": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.usageTotalUsd" - }, - "319": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStorageIds" - }, - "320": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStorageIds.datasets" - }, - "321": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type" - }, - "322": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type.default" - }, - "323": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type.__index" - }, - "325": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStorageIds.keyValueStores" - }, - "326": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type" - }, - "327": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type.default" - }, - "328": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type.__index" - }, - "330": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStorageIds.requestQueues" - }, - "331": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type" - }, - "332": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type.default" - }, - "333": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type.__index" - }, - "335": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun" - }, - "336": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.userId" - }, - "337": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.statusMessage" - }, - "338": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.stats" - }, - "339": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.options" - }, - "340": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.exitCode" - }, - "341": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.containerUrl" - }, - "342": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.isContainerServerReady" - }, - "343": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.gitBranchName" - }, - "344": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.usage" - }, - "345": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.usageUsd" - }, - "346": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.pricingInfo" - }, - "347": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.chargedEventCounts" - }, - "348": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.generalAccess" - }, - "349": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRun.storageIds" - }, - "350": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.id" - }, - "351": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.actId" - }, - "352": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.actorTaskId" - }, - "353": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.startedAt" - }, - "354": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.finishedAt" - }, - "355": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.status" - }, - "356": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.meta" - }, - "357": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.buildId" - }, - "358": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.buildNumber" - }, - "359": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.defaultKeyValueStoreId" - }, - "360": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.defaultDatasetId" - }, - "361": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.defaultRequestQueueId" - }, - "362": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunListItem.usageTotalUsd" - }, - "363": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage" - }, - "364": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.ACTOR_COMPUTE_UNITS" - }, - "365": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.DATASET_READS" - }, - "366": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.DATASET_WRITES" - }, - "367": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.KEY_VALUE_STORE_READS" - }, - "368": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.KEY_VALUE_STORE_WRITES" - }, - "369": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.KEY_VALUE_STORE_LISTS" - }, - "370": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.REQUEST_QUEUE_READS" - }, - "371": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.REQUEST_QUEUE_WRITES" - }, - "372": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.DATA_TRANSFER_INTERNAL_GBYTES" - }, - "373": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.DATA_TRANSFER_EXTERNAL_GBYTES" - }, - "374": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.PROXY_RESIDENTIAL_TRANSFER_GBYTES" - }, - "375": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunUsage.PROXY_SERPS" - }, - "376": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunMeta" - }, - "377": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunMeta.origin" - }, - "378": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunMeta.clientIp" - }, - "379": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunMeta.userAgent" - }, - "380": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats" - }, - "381": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.inputBodyLen" - }, - "382": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.restartCount" - }, - "383": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.resurrectCount" - }, - "384": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.memAvgBytes" - }, - "385": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.memMaxBytes" - }, - "386": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.memCurrentBytes" - }, - "387": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.cpuAvgUsage" - }, - "388": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.cpuMaxUsage" - }, - "389": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.cpuCurrentUsage" - }, - "390": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.netRxBytes" - }, - "391": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.netTxBytes" - }, - "392": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.durationMillis" - }, - "393": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.runTimeSecs" - }, - "394": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.metamorph" - }, - "395": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunStats.computeUnits" - }, - "396": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunOptions" - }, - "397": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunOptions.build" - }, - "398": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunOptions.timeoutSecs" - }, - "399": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunOptions.memoryMbytes" - }, - "400": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunOptions.diskMbytes" - }, - "401": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunOptions.maxItems" - }, - "402": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunOptions.maxTotalChargeUsd" - }, - "403": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunOptions.restartOnError" - }, - "404": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorBuildOptions" - }, - "405": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorBuildOptions.betaPackages" - }, - "406": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorBuildOptions.tag" - }, - "407": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorBuildOptions.useCache" - }, - "408": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorBuildOptions.waitForFinish" - }, - "409": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorLastRunOptions" - }, - "410": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorLastRunOptions.status" - }, - "411": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition" - }, - "412": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.actorSpecification" - }, - "413": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.name" - }, - "414": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.version" - }, - "415": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.buildTag" - }, - "416": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.environmentVariables" - }, - "417": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.dockerfile" - }, - "418": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.dockerContextDir" - }, - "419": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.readme" - }, - "420": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.input" - }, - "421": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.output" - }, - "422": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.changelog" - }, - "423": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.storages" - }, - "424": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type" - }, - "425": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type.dataset" - }, - "426": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.minMemoryMbytes" - }, - "427": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.maxMemoryMbytes" - }, - "428": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorDefinition.usesStandbyMode" - }, - "429": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "FreeActorPricingInfo" - }, - "430": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "FreeActorPricingInfo.pricingModel" - }, - "431": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.apifyMarginPercentage" - }, - "432": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.createdAt" - }, - "433": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.startedAt" - }, - "434": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.notifiedAboutFutureChangeAt" - }, - "435": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.notifiedAboutChangeAt" - }, - "436": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.reasonForChange" - }, - "437": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "FlatPricePerMonthActorPricingInfo" - }, - "438": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "FlatPricePerMonthActorPricingInfo.pricingModel" - }, - "439": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "FlatPricePerMonthActorPricingInfo.trialMinutes" - }, - "440": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "FlatPricePerMonthActorPricingInfo.pricePerUnitUsd" - }, - "441": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.apifyMarginPercentage" - }, - "442": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.createdAt" - }, - "443": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.startedAt" - }, - "444": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.notifiedAboutFutureChangeAt" - }, - "445": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.notifiedAboutChangeAt" - }, - "446": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.reasonForChange" - }, - "447": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "PricePerDatasetItemActorPricingInfo" - }, - "448": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "PricePerDatasetItemActorPricingInfo.pricingModel" - }, - "449": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "PricePerDatasetItemActorPricingInfo.unitName" - }, - "450": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "PricePerDatasetItemActorPricingInfo.pricePerUnitUsd" - }, - "451": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.apifyMarginPercentage" - }, - "452": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.createdAt" - }, - "453": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.startedAt" - }, - "454": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.notifiedAboutFutureChangeAt" - }, - "455": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.notifiedAboutChangeAt" - }, - "456": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.reasonForChange" - }, - "457": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorChargeEvent" - }, - "458": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorChargeEvent.eventPriceUsd" - }, - "459": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorChargeEvent.eventTitle" - }, - "460": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorChargeEvent.eventDescription" - }, - "461": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorChargeEvents" - }, - "462": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "PricePerEventActorPricingInfo" - }, - "463": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "PricePerEventActorPricingInfo.pricingModel" - }, - "464": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "PricePerEventActorPricingInfo.pricingPerEvent" - }, - "465": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type" - }, - "466": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "__type.actorChargeEvents" - }, - "467": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "PricePerEventActorPricingInfo.minimalMaxTotalChargeUsd" - }, - "468": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.apifyMarginPercentage" - }, - "469": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.createdAt" - }, - "470": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.startedAt" - }, - "471": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.notifiedAboutFutureChangeAt" - }, - "472": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.notifiedAboutChangeAt" - }, - "473": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "CommonActorPricingInfo.reasonForChange" - }, - "474": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "ActorRunPricingInfo" - }, - "475": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionClient" - }, - "479": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionClient.list" - }, - "480": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionClient.list" - }, - "481": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "options" - }, - "482": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionClient.create" - }, - "483": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionClient.create" - }, - "484": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "actor" - }, - "507": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "508": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "509": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "510": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "511": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "512": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "513": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "514": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "515": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "543": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorListSortBy" - }, - "544": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorListSortBy.CREATED_AT" - }, - "545": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorListSortBy.LAST_RUN_STARTED_AT" - }, - "546": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListOptions" - }, - "547": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListOptions.my" - }, - "548": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListOptions.desc" - }, - "549": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListOptions.sortBy" - }, - "550": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "551": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "552": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "553": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListItem" - }, - "554": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListItem.id" - }, - "555": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListItem.createdAt" - }, - "556": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListItem.modifiedAt" - }, - "557": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListItem.name" - }, - "558": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListItem.username" - }, - "559": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionListResult" - }, - "560": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions" - }, - "561": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.categories" - }, - "562": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.defaultRunOptions" - }, - "563": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.description" - }, - "564": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.exampleRunInput" - }, - "565": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.isDeprecated" - }, - "566": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.isPublic" - }, - "567": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.name" - }, - "568": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.restartOnError" - }, - "569": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.seoTitle" - }, - "570": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.seoDescription" - }, - "571": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.title" - }, - "572": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.versions" - }, - "573": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "ActorCollectionCreateOptions.actorStandby" - }, - "574": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "__type" - }, - "575": { - "sourceFileName": "../src/resource_clients/actor_collection.ts", - "qualifiedName": "__type.isEnabled" - }, - "576": { - "sourceFileName": "../src/resource_clients/actor_env_var.ts", - "qualifiedName": "ActorEnvVarClient" - }, - "580": { - "sourceFileName": "../src/resource_clients/actor_env_var.ts", - "qualifiedName": "ActorEnvVarClient.get" - }, - "581": { - "sourceFileName": "../src/resource_clients/actor_env_var.ts", - "qualifiedName": "ActorEnvVarClient.get" - }, - "582": { - "sourceFileName": "../src/resource_clients/actor_env_var.ts", - "qualifiedName": "ActorEnvVarClient.update" - }, - "583": { - "sourceFileName": "../src/resource_clients/actor_env_var.ts", - "qualifiedName": "ActorEnvVarClient.update" - }, - "584": { - "sourceFileName": "../src/resource_clients/actor_env_var.ts", - "qualifiedName": "actorEnvVar" - }, - "585": { - "sourceFileName": "../src/resource_clients/actor_env_var.ts", - "qualifiedName": "ActorEnvVarClient.delete" - }, - "586": { - "sourceFileName": "../src/resource_clients/actor_env_var.ts", - "qualifiedName": "ActorEnvVarClient.delete" - }, - "608": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "609": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "610": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "611": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "612": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "613": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "614": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "615": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "616": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "644": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "ActorEnvVarCollectionClient" - }, - "648": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "ActorEnvVarCollectionClient.list" - }, - "649": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "ActorEnvVarCollectionClient.list" - }, - "650": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "_options" - }, - "651": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "ActorEnvVarCollectionClient.create" - }, - "652": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "ActorEnvVarCollectionClient.create" - }, - "653": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "actorEnvVar" - }, - "676": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "677": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "678": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "679": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "680": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "681": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "682": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "683": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "684": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "712": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "ActorEnvVarCollectionListOptions" - }, - "713": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "ActorEnvVarCollectionListOptions.desc" - }, - "714": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "715": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "716": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "717": { - "sourceFileName": "../src/resource_clients/actor_env_var_collection.ts", - "qualifiedName": "ActorEnvVarListResult" - }, - "718": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient" - }, - "722": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.get" - }, - "723": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.get" - }, - "724": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.update" - }, - "725": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.update" - }, - "726": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "newFields" - }, - "727": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.delete" - }, - "728": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.delete" - }, - "729": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.envVar" - }, - "730": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.envVar" - }, - "731": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "envVarName" - }, - "732": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.envVars" - }, - "733": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionClient.envVars" - }, - "755": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "756": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "757": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "758": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "759": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "760": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "761": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "762": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "763": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "791": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion" - }, - "792": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.versionNumber" - }, - "793": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.sourceType" - }, - "794": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.envVars" - }, - "795": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.applyEnvVarsToBuild" - }, - "796": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.buildTag" - }, - "797": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.SourceType" - }, - "798": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionSourceFiles" - }, - "799": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionSourceFiles.sourceFiles" - }, - "800": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.versionNumber" - }, - "801": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.sourceType" - }, - "802": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.envVars" - }, - "803": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.applyEnvVarsToBuild" - }, - "804": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.buildTag" - }, - "805": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionSourceFile" - }, - "806": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionSourceFile.name" - }, - "807": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionSourceFile.format" - }, - "808": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionSourceFile.content" - }, - "809": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionGitRepo" - }, - "810": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionGitRepo.gitRepoUrl" - }, - "811": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.versionNumber" - }, - "812": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.sourceType" - }, - "813": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.envVars" - }, - "814": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.applyEnvVarsToBuild" - }, - "815": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.buildTag" - }, - "816": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionTarball" - }, - "817": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionTarball.tarballUrl" - }, - "818": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.versionNumber" - }, - "819": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.sourceType" - }, - "820": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.envVars" - }, - "821": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.applyEnvVarsToBuild" - }, - "822": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.buildTag" - }, - "823": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionGitHubGist" - }, - "824": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersionGitHubGist.gitHubGistUrl" - }, - "825": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.versionNumber" - }, - "826": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.sourceType" - }, - "827": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.envVars" - }, - "828": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.applyEnvVarsToBuild" - }, - "829": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "BaseActorVersion.buildTag" - }, - "830": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorSourceType" - }, - "831": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorSourceType.SourceFiles" - }, - "832": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorSourceType.GitRepo" - }, - "833": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorSourceType.Tarball" - }, - "834": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorSourceType.GitHubGist" - }, - "835": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorEnvironmentVariable" - }, - "836": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorEnvironmentVariable.name" - }, - "837": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorEnvironmentVariable.value" - }, - "838": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorEnvironmentVariable.isSecret" - }, - "839": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "ActorVersion" - }, - "840": { - "sourceFileName": "../src/resource_clients/actor_version.ts", - "qualifiedName": "FinalActorVersion" - }, - "841": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "ActorVersionCollectionClient" - }, - "845": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "ActorVersionCollectionClient.list" - }, - "846": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "ActorVersionCollectionClient.list" - }, - "847": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "_options" - }, - "848": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "ActorVersionCollectionClient.create" - }, - "849": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "ActorVersionCollectionClient.create" - }, - "850": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "actorVersion" - }, - "873": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "874": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "875": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "876": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "877": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "878": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "879": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "880": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "881": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "909": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "ActorVersionCollectionListOptions" - }, - "910": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "ActorVersionCollectionListOptions.desc" - }, - "911": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "912": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "913": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "914": { - "sourceFileName": "../src/resource_clients/actor_version_collection.ts", - "qualifiedName": "ActorVersionListResult" - }, - "915": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient" - }, - "919": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.get" - }, - "920": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.get" - }, - "921": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "options" - }, - "922": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.abort" - }, - "923": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.abort" - }, - "924": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.delete" - }, - "925": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.delete" - }, - "926": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.getOpenApiDefinition" - }, - "927": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.getOpenApiDefinition" - }, - "928": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.waitForFinish" - }, - "929": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.waitForFinish" - }, - "930": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "options" - }, - "931": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.log" - }, - "932": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClient.log" - }, - "954": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "955": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "956": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "957": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "958": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "959": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "960": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "961": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "962": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "990": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClientGetOptions" - }, - "991": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClientGetOptions.waitForFinish" - }, - "992": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClientWaitForFinishOptions" - }, - "993": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildClientWaitForFinishOptions.waitSecs" - }, - "994": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildMeta" - }, - "995": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildMeta.origin" - }, - "996": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildMeta.clientIp" - }, - "997": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildMeta.userAgent" - }, - "998": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build" - }, - "999": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.id" - }, - "1000": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.actId" - }, - "1001": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.userId" - }, - "1002": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.startedAt" - }, - "1003": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.finishedAt" - }, - "1004": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.status" - }, - "1005": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.meta" - }, - "1006": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.stats" - }, - "1007": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.options" - }, - "1008": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.inputSchema" - }, - "1009": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.readme" - }, - "1010": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.buildNumber" - }, - "1011": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.usage" - }, - "1012": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.usageTotalUsd" - }, - "1013": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.usageUsd" - }, - "1014": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "Build.actorDefinition" - }, - "1015": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildUsage" - }, - "1016": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildUsage.ACTOR_COMPUTE_UNITS" - }, - "1017": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildStats" - }, - "1018": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildStats.durationMillis" - }, - "1019": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildStats.runTimeSecs" - }, - "1020": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildStats.computeUnits" - }, - "1021": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildOptions" - }, - "1022": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildOptions.useCache" - }, - "1023": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildOptions.betaPackages" - }, - "1024": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildOptions.memoryMbytes" - }, - "1025": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "BuildOptions.diskMbytes" - }, - "1026": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "OpenApiDefinition" - }, - "1027": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "OpenApiDefinition.openapi" - }, - "1028": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "OpenApiDefinition.info" - }, - "1029": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type" - }, - "1030": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type.title" - }, - "1031": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type.description" - }, - "1032": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type.version" - }, - "1033": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type.x-build-id" - }, - "1034": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "OpenApiDefinition.servers" - }, - "1035": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type" - }, - "1036": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type.url" - }, - "1037": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "OpenApiDefinition.paths" - }, - "1038": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type" - }, - "1039": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type.__index" - }, - "1041": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type" - }, - "1042": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type.post" - }, - "1043": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "OpenApiDefinition.components" - }, - "1044": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type" - }, - "1045": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type.schemas" - }, - "1046": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type" - }, - "1047": { - "sourceFileName": "../src/resource_clients/build.ts", - "qualifiedName": "__type.__index" - }, - "1049": { - "sourceFileName": "../src/resource_clients/build_collection.ts", - "qualifiedName": "BuildCollectionClient" - }, - "1053": { - "sourceFileName": "../src/resource_clients/build_collection.ts", - "qualifiedName": "BuildCollectionClient.list" - }, - "1054": { - "sourceFileName": "../src/resource_clients/build_collection.ts", - "qualifiedName": "BuildCollectionClient.list" - }, - "1055": { - "sourceFileName": "../src/resource_clients/build_collection.ts", - "qualifiedName": "options" - }, - "1078": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "1079": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "1080": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "1081": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "1082": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "1083": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "1084": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "1085": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "1086": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "1114": { - "sourceFileName": "../src/resource_clients/build_collection.ts", - "qualifiedName": "BuildCollectionClientListOptions" - }, - "1115": { - "sourceFileName": "../src/resource_clients/build_collection.ts", - "qualifiedName": "BuildCollectionClientListOptions.desc" - }, - "1116": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "1117": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "1118": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "1119": { - "sourceFileName": "../src/resource_clients/build_collection.ts", - "qualifiedName": "BuildCollectionClientListItem" - }, - "1120": { - "sourceFileName": "../src/resource_clients/build_collection.ts", - "qualifiedName": "BuildCollectionClientListResult" - }, - "1121": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient" - }, - "1126": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.get" - }, - "1127": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.get" - }, - "1128": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.update" - }, - "1129": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.update" - }, - "1130": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "newFields" - }, - "1131": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.delete" - }, - "1132": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.delete" - }, - "1133": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.listItems" - }, - "1134": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.listItems" - }, - "1135": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "options" - }, - "1136": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.downloadItems" - }, - "1137": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.downloadItems" - }, - "1138": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "format" - }, - "1139": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "options" - }, - "1140": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.pushItems" - }, - "1141": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.pushItems" - }, - "1142": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "items" - }, - "1143": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.getStatistics" - }, - "1144": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.getStatistics" - }, - "1145": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.createItemsPublicUrl" - }, - "1146": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.createItemsPublicUrl" - }, - "1147": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "options" - }, - "1173": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "1174": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "1175": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "1176": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "1177": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "1178": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "1179": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "1180": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "1181": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "1209": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClient.Data" - }, - "1210": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset" - }, - "1211": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.id" - }, - "1212": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.name" - }, - "1213": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.title" - }, - "1214": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.userId" - }, - "1215": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.username" - }, - "1216": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.createdAt" - }, - "1217": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.modifiedAt" - }, - "1218": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.accessedAt" - }, - "1219": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.itemCount" - }, - "1220": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.cleanItemCount" - }, - "1221": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.actId" - }, - "1222": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.actRunId" - }, - "1223": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.stats" - }, - "1224": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.fields" - }, - "1225": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.generalAccess" - }, - "1226": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.urlSigningSecretKey" - }, - "1227": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "Dataset.itemsPublicUrl" - }, - "1228": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetStats" - }, - "1229": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetStats.readCount" - }, - "1230": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetStats.writeCount" - }, - "1231": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetStats.deleteCount" - }, - "1232": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetStats.storageBytes" - }, - "1233": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientUpdateOptions" - }, - "1234": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientUpdateOptions.name" - }, - "1235": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientUpdateOptions.title" - }, - "1236": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientUpdateOptions.generalAccess" - }, - "1237": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions" - }, - "1238": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.clean" - }, - "1239": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.desc" - }, - "1240": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.flatten" - }, - "1241": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.fields" - }, - "1242": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.omit" - }, - "1243": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.skipEmpty" - }, - "1244": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.skipHidden" - }, - "1245": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.unwind" - }, - "1246": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.view" - }, - "1247": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.signature" - }, - "1248": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "1249": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "1250": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "1251": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientCreateItemsUrlOptions" - }, - "1252": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientCreateItemsUrlOptions.expiresInSecs" - }, - "1253": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.clean" - }, - "1254": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.desc" - }, - "1255": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.flatten" - }, - "1256": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.fields" - }, - "1257": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.omit" - }, - "1258": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.skipEmpty" - }, - "1259": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.skipHidden" - }, - "1260": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.unwind" - }, - "1261": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.view" - }, - "1262": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.signature" - }, - "1263": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "1264": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "1265": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "1266": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DownloadItemsFormat" - }, - "1267": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DownloadItemsFormat.JSON" - }, - "1268": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DownloadItemsFormat.JSONL" - }, - "1269": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DownloadItemsFormat.XML" - }, - "1270": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DownloadItemsFormat.HTML" - }, - "1271": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DownloadItemsFormat.CSV" - }, - "1272": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DownloadItemsFormat.XLSX" - }, - "1273": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DownloadItemsFormat.RSS" - }, - "1274": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientDownloadItemsOptions" - }, - "1275": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientDownloadItemsOptions.attachment" - }, - "1276": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientDownloadItemsOptions.bom" - }, - "1277": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientDownloadItemsOptions.delimiter" - }, - "1278": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientDownloadItemsOptions.skipHeaderRow" - }, - "1279": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientDownloadItemsOptions.xmlRoot" - }, - "1280": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientDownloadItemsOptions.xmlRow" - }, - "1281": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.clean" - }, - "1282": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.desc" - }, - "1283": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.flatten" - }, - "1284": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.fields" - }, - "1285": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.omit" - }, - "1286": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.skipEmpty" - }, - "1287": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.skipHidden" - }, - "1288": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.unwind" - }, - "1289": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.view" - }, - "1290": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetClientListItemOptions.signature" - }, - "1291": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "1292": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "1293": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "1294": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetStatistics" - }, - "1295": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "DatasetStatistics.fieldStatistics" - }, - "1296": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "FieldStatistics" - }, - "1297": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "FieldStatistics.min" - }, - "1298": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "FieldStatistics.max" - }, - "1299": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "FieldStatistics.nullCount" - }, - "1300": { - "sourceFileName": "../src/resource_clients/dataset.ts", - "qualifiedName": "FieldStatistics.emptyCount" - }, - "1301": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClient" - }, - "1305": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClient.list" - }, - "1306": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClient.list" - }, - "1307": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "options" - }, - "1308": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClient.getOrCreate" - }, - "1309": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClient.getOrCreate" - }, - "1310": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "name" - }, - "1311": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "options" - }, - "1334": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "1335": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "1336": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "1337": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "1338": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "1339": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "1340": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "1341": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "1342": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "1370": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClientListOptions" - }, - "1371": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClientListOptions.unnamed" - }, - "1372": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClientListOptions.desc" - }, - "1373": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClientListOptions.ownership" - }, - "1374": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "1375": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "1376": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "1377": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClientGetOrCreateOptions" - }, - "1378": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClientGetOrCreateOptions.schema" - }, - "1379": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "DatasetCollectionClientListResult" - }, - "1380": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "__type" - }, - "1381": { - "sourceFileName": "../src/resource_clients/dataset_collection.ts", - "qualifiedName": "__type.unnamed" - }, - "1382": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient" - }, - "1386": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.get" - }, - "1387": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.get" - }, - "1388": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.update" - }, - "1389": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.update" - }, - "1390": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "newFields" - }, - "1391": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.delete" - }, - "1392": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.delete" - }, - "1393": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.listKeys" - }, - "1394": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.listKeys" - }, - "1395": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "options" - }, - "1396": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.getRecordPublicUrl" - }, - "1397": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.getRecordPublicUrl" - }, - "1398": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "key" - }, - "1399": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.createKeysPublicUrl" - }, - "1400": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.createKeysPublicUrl" - }, - "1401": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "options" - }, - "1402": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.recordExists" - }, - "1403": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.recordExists" - }, - "1404": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "key" - }, - "1405": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.getRecord" - }, - "1406": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.getRecord" - }, - "1407": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "key" - }, - "1408": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.getRecord" - }, - "1409": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "Options" - }, - "1410": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "key" - }, - "1411": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "options" - }, - "1412": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.setRecord" - }, - "1413": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.setRecord" - }, - "1414": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "record" - }, - "1415": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "options" - }, - "1416": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.deleteRecord" - }, - "1417": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreClient.deleteRecord" - }, - "1418": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "key" - }, - "1440": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "1441": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "1442": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "1443": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "1444": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "1445": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "1446": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "1447": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "1448": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "1476": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore" - }, - "1477": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.id" - }, - "1478": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.name" - }, - "1479": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.title" - }, - "1480": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.userId" - }, - "1481": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.username" - }, - "1482": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.createdAt" - }, - "1483": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.modifiedAt" - }, - "1484": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.accessedAt" - }, - "1485": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.actId" - }, - "1486": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.actRunId" - }, - "1487": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.stats" - }, - "1488": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.generalAccess" - }, - "1489": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.urlSigningSecretKey" - }, - "1490": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStore.keysPublicUrl" - }, - "1491": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreStats" - }, - "1492": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreStats.readCount" - }, - "1493": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreStats.writeCount" - }, - "1494": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreStats.deleteCount" - }, - "1495": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreStats.listCount" - }, - "1496": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreStats.storageBytes" - }, - "1497": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientUpdateOptions" - }, - "1498": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientUpdateOptions.name" - }, - "1499": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientUpdateOptions.title" - }, - "1500": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientUpdateOptions.generalAccess" - }, - "1501": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions" - }, - "1502": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.limit" - }, - "1503": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.exclusiveStartKey" - }, - "1504": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.collection" - }, - "1505": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.prefix" - }, - "1506": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.signature" - }, - "1507": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientCreateKeysUrlOptions" - }, - "1508": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientCreateKeysUrlOptions.expiresInSecs" - }, - "1509": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.limit" - }, - "1510": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.exclusiveStartKey" - }, - "1511": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.collection" - }, - "1512": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.prefix" - }, - "1513": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysOptions.signature" - }, - "1514": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysResult" - }, - "1515": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysResult.count" - }, - "1516": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysResult.limit" - }, - "1517": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysResult.exclusiveStartKey" - }, - "1518": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysResult.isTruncated" - }, - "1519": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysResult.nextExclusiveStartKey" - }, - "1520": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientListKeysResult.items" - }, - "1521": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueListItem" - }, - "1522": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueListItem.key" - }, - "1523": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueListItem.size" - }, - "1524": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueListItem.recordPublicUrl" - }, - "1525": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientGetRecordOptions" - }, - "1526": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientGetRecordOptions.buffer" - }, - "1527": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientGetRecordOptions.stream" - }, - "1528": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueClientGetRecordOptions.signature" - }, - "1529": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreRecord" - }, - "1530": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreRecord.key" - }, - "1531": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreRecord.value" - }, - "1532": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreRecord.contentType" - }, - "1533": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreRecord.T" - }, - "1534": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreRecordOptions" - }, - "1535": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreRecordOptions.timeoutSecs" - }, - "1536": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "KeyValueStoreRecordOptions.doNotRetryTimeouts" - }, - "1537": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "ReturnTypeFromOptions" - }, - "1538": { - "sourceFileName": "../src/resource_clients/key_value_store.ts", - "qualifiedName": "Options" - }, - "1539": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClient" - }, - "1543": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClient.list" - }, - "1544": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClient.list" - }, - "1545": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "options" - }, - "1546": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClient.getOrCreate" - }, - "1547": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClient.getOrCreate" - }, - "1548": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "name" - }, - "1549": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "options" - }, - "1572": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "1573": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "1574": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "1575": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "1576": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "1577": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "1578": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "1579": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "1580": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "1608": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClientListOptions" - }, - "1609": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClientListOptions.unnamed" - }, - "1610": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClientListOptions.desc" - }, - "1611": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClientListOptions.ownership" - }, - "1612": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "1613": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "1614": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "1615": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClientGetOrCreateOptions" - }, - "1616": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionClientGetOrCreateOptions.schema" - }, - "1617": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "KeyValueStoreCollectionListResult" - }, - "1618": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "__type" - }, - "1619": { - "sourceFileName": "../src/resource_clients/key_value_store_collection.ts", - "qualifiedName": "__type.unnamed" - }, - "1620": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LogClient" - }, - "1624": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LogClient.get" - }, - "1625": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LogClient.get" - }, - "1626": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "options" - }, - "1627": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LogClient.stream" - }, - "1628": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LogClient.stream" - }, - "1629": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "options" - }, - "1651": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "1652": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "1653": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "1654": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "1655": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "1656": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "1657": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "1658": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "1659": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "1687": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LogOptions" - }, - "1688": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LogOptions.raw" - }, - "1689": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LoggerActorRedirect" - }, - "1690": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.once" - }, - "1691": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.once" - }, - "1692": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "emitter" - }, - "1693": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1694": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "options" - }, - "1695": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.once" - }, - "1696": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "emitter" - }, - "1697": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1698": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "options" - }, - "1699": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.on" - }, - "1700": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.on" - }, - "1701": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "emitter" - }, - "1702": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1703": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "options" - }, - "1704": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.on" - }, - "1705": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "emitter" - }, - "1706": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1707": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "options" - }, - "1708": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.listenerCount" - }, - "1709": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.listenerCount" - }, - "1710": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "emitter" - }, - "1711": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1712": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.getEventListeners" - }, - "1713": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.getEventListeners" - }, - "1714": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "emitter" - }, - "1715": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "name" - }, - "1716": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.getMaxListeners" - }, - "1717": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.getMaxListeners" - }, - "1718": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "emitter" - }, - "1719": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.setMaxListeners" - }, - "1720": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.setMaxListeners" - }, - "1721": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "n" - }, - "1722": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventTargets" - }, - "1723": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.addAbortListener" - }, - "1724": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.addAbortListener" - }, - "1725": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "signal" - }, - "1726": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "resource" - }, - "1727": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1728": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1729": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "event" - }, - "1730": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.errorMonitor" - }, - "1731": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.captureRejectionSymbol" - }, - "1732": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.captureRejections" - }, - "1733": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.defaultMaxListeners" - }, - "1734": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LoggerActorRedirect.__constructor" - }, - "1735": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LoggerActorRedirect" - }, - "1736": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "options" - }, - "1737": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "__object" - }, - "1738": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LoggerActorRedirect._log" - }, - "1739": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "LoggerActorRedirect._log" - }, - "1740": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "level" - }, - "1741": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "message" - }, - "1742": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "data" - }, - "1743": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "exception" - }, - "1744": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "opts" - }, - "1746": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Logger.setOptions" - }, - "1747": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Logger.setOptions" - }, - "1748": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "options" - }, - "1749": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Logger.getOptions" - }, - "1750": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Logger.getOptions" - }, - "1751": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Logger._outputWithConsole" - }, - "1752": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Logger._outputWithConsole" - }, - "1753": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "level" - }, - "1754": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "line" - }, - "1755": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Logger.log" - }, - "1756": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "Logger.log" - }, - "1757": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "level" - }, - "1758": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "message" - }, - "1759": { - "sourceFileName": "../node_modules/@apify/log/cjs/index.d.ts", - "qualifiedName": "args" - }, - "1760": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.[captureRejectionSymbol]" - }, - "1761": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "EventEmitter.[captureRejectionSymbol]" - }, - "1762": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1763": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "error" - }, - "1764": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "event" - }, - "1765": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "args" - }, - "1766": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.addListener" - }, - "1767": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.addListener" - }, - "1768": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1769": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1770": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "listener" - }, - "1771": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1772": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1773": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "args" - }, - "1774": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.on" - }, - "1775": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.on" - }, - "1776": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1777": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1778": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "listener" - }, - "1779": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1780": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1781": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "args" - }, - "1782": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.once" - }, - "1783": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.once" - }, - "1784": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1785": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1786": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "listener" - }, - "1787": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1788": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1789": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "args" - }, - "1790": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.removeListener" - }, - "1791": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.removeListener" - }, - "1792": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1793": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1794": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "listener" - }, - "1795": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1796": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1797": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "args" - }, - "1798": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.off" - }, - "1799": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.off" - }, - "1800": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1801": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1802": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "listener" - }, - "1803": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1804": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1805": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "args" - }, - "1806": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.removeAllListeners" - }, - "1807": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.removeAllListeners" - }, - "1808": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1809": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.setMaxListeners" - }, - "1810": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.setMaxListeners" - }, - "1811": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "n" - }, - "1812": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.getMaxListeners" - }, - "1813": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.getMaxListeners" - }, - "1814": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.listeners" - }, - "1815": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.listeners" - }, - "1816": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1817": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1818": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.rawListeners" - }, - "1819": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.rawListeners" - }, - "1820": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1821": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1822": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.emit" - }, - "1823": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.emit" - }, - "1824": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1825": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1826": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "args" - }, - "1827": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.listenerCount" - }, - "1828": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.listenerCount" - }, - "1829": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1830": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1831": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "listener" - }, - "1832": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.prependListener" - }, - "1833": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.prependListener" - }, - "1834": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1835": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1836": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "listener" - }, - "1837": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1838": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1839": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "args" - }, - "1840": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.prependOnceListener" - }, - "1841": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.prependOnceListener" - }, - "1842": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "K" - }, - "1843": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "eventName" - }, - "1844": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "listener" - }, - "1845": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1846": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__type" - }, - "1847": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "args" - }, - "1848": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.eventNames" - }, - "1849": { - "sourceFileName": "../node_modules/@types/node/events.d.ts", - "qualifiedName": "__global.NodeJS.EventEmitter.eventNames" - }, - "1850": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLog" - }, - "1851": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLog.__constructor" - }, - "1852": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLog" - }, - "1853": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "options" - }, - "1861": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLog.start" - }, - "1862": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLog.start" - }, - "1863": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLog.stop" - }, - "1864": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLog.stop" - }, - "1872": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLogOptions" - }, - "1873": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLogOptions.logClient" - }, - "1874": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLogOptions.toLog" - }, - "1875": { - "sourceFileName": "../src/resource_clients/log.ts", - "qualifiedName": "StreamedLogOptions.fromStart" - }, - "1876": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient" - }, - "1883": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.get" - }, - "1884": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.get" - }, - "1885": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.update" - }, - "1886": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.update" - }, - "1887": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "newFields" - }, - "1888": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.delete" - }, - "1889": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.delete" - }, - "1890": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.listHead" - }, - "1891": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.listHead" - }, - "1892": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "options" - }, - "1893": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.listAndLockHead" - }, - "1894": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.listAndLockHead" - }, - "1895": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "options" - }, - "1896": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.addRequest" - }, - "1897": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.addRequest" - }, - "1898": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "request" - }, - "1899": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "options" - }, - "1908": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.batchAddRequests" - }, - "1909": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.batchAddRequests" - }, - "1910": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "requests" - }, - "1911": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "options" - }, - "1912": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.batchDeleteRequests" - }, - "1913": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.batchDeleteRequests" - }, - "1914": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "requests" - }, - "1915": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.getRequest" - }, - "1916": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.getRequest" - }, - "1917": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "id" - }, - "1918": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.updateRequest" - }, - "1919": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.updateRequest" - }, - "1920": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "request" - }, - "1921": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "options" - }, - "1922": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.deleteRequest" - }, - "1923": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.deleteRequest" - }, - "1924": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "id" - }, - "1925": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.prolongRequestLock" - }, - "1926": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.prolongRequestLock" - }, - "1927": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "id" - }, - "1928": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "options" - }, - "1929": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.deleteRequestLock" - }, - "1930": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.deleteRequestLock" - }, - "1931": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "id" - }, - "1932": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "options" - }, - "1933": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.listRequests" - }, - "1934": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.listRequests" - }, - "1935": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "options" - }, - "1936": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.unlockRequests" - }, - "1937": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.unlockRequests" - }, - "1938": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.paginateRequests" - }, - "1939": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClient.paginateRequests" - }, - "1940": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "options" - }, - "1962": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "1963": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "1964": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "1965": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "1966": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "1967": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "1968": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "1969": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "1970": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "1998": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueUserOptions" - }, - "1999": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueUserOptions.clientKey" - }, - "2000": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueUserOptions.timeoutSecs" - }, - "2001": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue" - }, - "2002": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.id" - }, - "2003": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.name" - }, - "2004": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.title" - }, - "2005": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.userId" - }, - "2006": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.username" - }, - "2007": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.createdAt" - }, - "2008": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.modifiedAt" - }, - "2009": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.accessedAt" - }, - "2010": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.expireAt" - }, - "2011": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.totalRequestCount" - }, - "2012": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.handledRequestCount" - }, - "2013": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.pendingRequestCount" - }, - "2014": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.actId" - }, - "2015": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.actRunId" - }, - "2016": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.hadMultipleClients" - }, - "2017": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.stats" - }, - "2018": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueue.generalAccess" - }, - "2019": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueStats" - }, - "2020": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueStats.readCount" - }, - "2021": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueStats.writeCount" - }, - "2022": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueStats.deleteCount" - }, - "2023": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueStats.headItemReadCount" - }, - "2024": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueStats.storageBytes" - }, - "2025": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientUpdateOptions" - }, - "2026": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientUpdateOptions.name" - }, - "2027": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientUpdateOptions.title" - }, - "2028": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientUpdateOptions.generalAccess" - }, - "2029": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadOptions" - }, - "2030": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadOptions.limit" - }, - "2031": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadResult" - }, - "2032": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadResult.limit" - }, - "2033": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadResult.queueModifiedAt" - }, - "2034": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadResult.hadMultipleClients" - }, - "2035": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadResult.items" - }, - "2036": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueListRequestsFilter" - }, - "2037": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsOptions" - }, - "2038": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsOptions.limit" - }, - "2039": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsOptions.exclusiveStartId" - }, - "2040": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsOptions.cursor" - }, - "2041": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsOptions.filter" - }, - "2042": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientPaginateRequestsOptions" - }, - "2043": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientPaginateRequestsOptions.limit" - }, - "2044": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientPaginateRequestsOptions.maxPageLimit" - }, - "2045": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientPaginateRequestsOptions.exclusiveStartId" - }, - "2046": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientPaginateRequestsOptions.cursor" - }, - "2047": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientPaginateRequestsOptions.filter" - }, - "2048": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsResult" - }, - "2049": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsResult.limit" - }, - "2050": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsResult.exclusiveStartId" - }, - "2051": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsResult.cursor" - }, - "2052": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsResult.nextCursor" - }, - "2053": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListRequestsResult.items" - }, - "2054": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListAndLockHeadOptions" - }, - "2055": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListAndLockHeadOptions.lockSecs" - }, - "2056": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListAndLockHeadOptions.limit" - }, - "2057": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListAndLockHeadResult" - }, - "2058": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListAndLockHeadResult.lockSecs" - }, - "2059": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListAndLockHeadResult.queueHasLockedRequests" - }, - "2060": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListAndLockHeadResult.clientKey" - }, - "2061": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadResult.limit" - }, - "2062": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadResult.queueModifiedAt" - }, - "2063": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadResult.hadMultipleClients" - }, - "2064": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListHeadResult.items" - }, - "2065": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListItem" - }, - "2066": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListItem.id" - }, - "2067": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListItem.retryCount" - }, - "2068": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListItem.uniqueKey" - }, - "2069": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListItem.url" - }, - "2070": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListItem.method" - }, - "2071": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientListItem.lockExpiresAt" - }, - "2072": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientAddRequestOptions" - }, - "2073": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientAddRequestOptions.forefront" - }, - "2074": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientProlongRequestLockOptions" - }, - "2075": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientProlongRequestLockOptions.forefront" - }, - "2076": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientProlongRequestLockOptions.lockSecs" - }, - "2077": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientDeleteRequestLockOptions" - }, - "2078": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientDeleteRequestLockOptions.forefront" - }, - "2079": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientProlongRequestLockResult" - }, - "2080": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientProlongRequestLockResult.lockExpiresAt" - }, - "2081": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientBatchAddRequestWithRetriesOptions" - }, - "2082": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientBatchAddRequestWithRetriesOptions.forefront" - }, - "2083": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientBatchAddRequestWithRetriesOptions.maxUnprocessedRequestsRetries" - }, - "2084": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientBatchAddRequestWithRetriesOptions.maxParallel" - }, - "2085": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientBatchAddRequestWithRetriesOptions.minDelayBetweenUnprocessedRequestsRetriesMillis" - }, - "2086": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema" - }, - "2087": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.id" - }, - "2088": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.uniqueKey" - }, - "2089": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.url" - }, - "2090": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.method" - }, - "2091": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.payload" - }, - "2092": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.retryCount" - }, - "2093": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.errorMessages" - }, - "2094": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.headers" - }, - "2095": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.userData" - }, - "2096": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.handledAt" - }, - "2097": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.noRetry" - }, - "2098": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestSchema.loadedUrl" - }, - "2099": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientAddRequestResult" - }, - "2100": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientAddRequestResult.requestId" - }, - "2101": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientAddRequestResult.wasAlreadyPresent" - }, - "2102": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientAddRequestResult.wasAlreadyHandled" - }, - "2103": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientUnlockRequestsResult" - }, - "2104": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientUnlockRequestsResult.unlockedCount" - }, - "2105": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientBatchRequestsOperationResult" - }, - "2106": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientBatchRequestsOperationResult.processedRequests" - }, - "2107": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientBatchRequestsOperationResult.unprocessedRequests" - }, - "2108": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientRequestToDelete" - }, - "2109": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueClientGetRequestResult" - }, - "2110": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "AllowedHttpMethods" - }, - "2111": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "RequestQueueRequestsAsyncIterable" - }, - "2112": { - "sourceFileName": "../src/resource_clients/request_queue.ts", - "qualifiedName": "T" - }, - "2113": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionClient" - }, - "2117": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionClient.list" - }, - "2118": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionClient.list" - }, - "2119": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "options" - }, - "2120": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionClient.getOrCreate" - }, - "2121": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionClient.getOrCreate" - }, - "2122": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "name" - }, - "2145": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "2146": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "2147": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "2148": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "2149": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "2150": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "2151": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "2152": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "2153": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "2181": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionListOptions" - }, - "2182": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionListOptions.unnamed" - }, - "2183": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionListOptions.desc" - }, - "2184": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionListOptions.ownership" - }, - "2185": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "2186": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "2187": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "2188": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "RequestQueueCollectionListResult" - }, - "2189": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "__type" - }, - "2190": { - "sourceFileName": "../src/resource_clients/request_queue_collection.ts", - "qualifiedName": "__type.unnamed" - }, - "2191": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient" - }, - "2195": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.get" - }, - "2196": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.get" - }, - "2197": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "options" - }, - "2198": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.abort" - }, - "2199": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.abort" - }, - "2200": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "options" - }, - "2201": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.delete" - }, - "2202": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.delete" - }, - "2203": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.metamorph" - }, - "2204": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.metamorph" - }, - "2205": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "targetActorId" - }, - "2206": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "input" - }, - "2207": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "options" - }, - "2208": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.reboot" - }, - "2209": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.reboot" - }, - "2210": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.update" - }, - "2211": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.update" - }, - "2212": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "newFields" - }, - "2213": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.resurrect" - }, - "2214": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.resurrect" - }, - "2215": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "options" - }, - "2216": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.charge" - }, - "2217": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.charge" - }, - "2218": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "options" - }, - "2219": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.waitForFinish" - }, - "2220": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.waitForFinish" - }, - "2221": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "options" - }, - "2222": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.dataset" - }, - "2223": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.dataset" - }, - "2224": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.keyValueStore" - }, - "2225": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.keyValueStore" - }, - "2226": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.requestQueue" - }, - "2227": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.requestQueue" - }, - "2228": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.log" - }, - "2229": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.log" - }, - "2230": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.getStreamedLog" - }, - "2231": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunClient.getStreamedLog" - }, - "2232": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "options" - }, - "2254": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "2255": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "2256": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "2257": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "2258": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "2259": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "2260": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "2261": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "2262": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "2290": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "GetStreamedLogOptions" - }, - "2291": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "GetStreamedLogOptions.toLog" - }, - "2292": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "GetStreamedLogOptions.fromStart" - }, - "2293": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunGetOptions" - }, - "2294": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunGetOptions.waitForFinish" - }, - "2295": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunAbortOptions" - }, - "2296": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunAbortOptions.gracefully" - }, - "2297": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunMetamorphOptions" - }, - "2298": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunMetamorphOptions.contentType" - }, - "2299": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunMetamorphOptions.build" - }, - "2300": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunUpdateOptions" - }, - "2301": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunUpdateOptions.statusMessage" - }, - "2302": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunUpdateOptions.isStatusMessageTerminal" - }, - "2303": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunUpdateOptions.generalAccess" - }, - "2304": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunResurrectOptions" - }, - "2305": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunResurrectOptions.build" - }, - "2306": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunResurrectOptions.memory" - }, - "2307": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunResurrectOptions.timeout" - }, - "2308": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunResurrectOptions.maxItems" - }, - "2309": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunResurrectOptions.maxTotalChargeUsd" - }, - "2310": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunResurrectOptions.restartOnError" - }, - "2311": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunChargeOptions" - }, - "2312": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunChargeOptions.eventName" - }, - "2313": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunChargeOptions.count" - }, - "2314": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunChargeOptions.idempotencyKey" - }, - "2315": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunWaitForFinishOptions" - }, - "2316": { - "sourceFileName": "../src/resource_clients/run.ts", - "qualifiedName": "RunWaitForFinishOptions.waitSecs" - }, - "2317": { - "sourceFileName": "../src/resource_clients/run_collection.ts", - "qualifiedName": "RunCollectionClient" - }, - "2321": { - "sourceFileName": "../src/resource_clients/run_collection.ts", - "qualifiedName": "RunCollectionClient.list" - }, - "2322": { - "sourceFileName": "../src/resource_clients/run_collection.ts", - "qualifiedName": "RunCollectionClient.list" - }, - "2323": { - "sourceFileName": "../src/resource_clients/run_collection.ts", - "qualifiedName": "options" - }, - "2346": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "2347": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "2348": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "2349": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "2350": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "2351": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "2352": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "2353": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "2354": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "2382": { - "sourceFileName": "../src/resource_clients/run_collection.ts", - "qualifiedName": "RunCollectionListOptions" - }, - "2383": { - "sourceFileName": "../src/resource_clients/run_collection.ts", - "qualifiedName": "RunCollectionListOptions.desc" - }, - "2384": { - "sourceFileName": "../src/resource_clients/run_collection.ts", - "qualifiedName": "RunCollectionListOptions.status" - }, - "2385": { - "sourceFileName": "../src/resource_clients/run_collection.ts", - "qualifiedName": "RunCollectionListOptions.startedBefore" - }, - "2386": { - "sourceFileName": "../src/resource_clients/run_collection.ts", - "qualifiedName": "RunCollectionListOptions.startedAfter" - }, - "2387": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "2388": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "2389": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "2390": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleClient" - }, - "2394": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleClient.get" - }, - "2395": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleClient.get" - }, - "2396": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleClient.update" - }, - "2397": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleClient.update" - }, - "2398": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "newFields" - }, - "2399": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "__type" - }, - "2400": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "__type.actions" - }, - "2401": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleClient.delete" - }, - "2402": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleClient.delete" - }, - "2403": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleClient.getLog" - }, - "2404": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleClient.getLog" - }, - "2426": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "2427": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "2428": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "2429": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "2430": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "2431": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "2432": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "2433": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "2434": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "2462": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule" - }, - "2463": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.id" - }, - "2464": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.userId" - }, - "2465": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.name" - }, - "2466": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.title" - }, - "2467": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.cronExpression" - }, - "2468": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.timezone" - }, - "2469": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.isEnabled" - }, - "2470": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.isExclusive" - }, - "2471": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.description" - }, - "2472": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.createdAt" - }, - "2473": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.modifiedAt" - }, - "2474": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.nextRunAt" - }, - "2475": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.lastRunAt" - }, - "2476": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.actions" - }, - "2477": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "Schedule.notifications" - }, - "2478": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "__type" - }, - "2479": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "__type.email" - }, - "2480": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleCreateOrUpdateData" - }, - "2481": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "__type" - }, - "2482": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "__type.actions" - }, - "2483": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActions" - }, - "2484": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActions.RunActor" - }, - "2485": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActions.RunActorTask" - }, - "2486": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleAction" - }, - "2487": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActionRunActor" - }, - "2488": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActionRunActor.actorId" - }, - "2489": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActionRunActor.runInput" - }, - "2490": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActionRunActor.runOptions" - }, - "2491": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "BaseScheduleAction.id" - }, - "2492": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "BaseScheduleAction.type" - }, - "2493": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduledActorRunInput" - }, - "2494": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduledActorRunInput.body" - }, - "2495": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduledActorRunInput.contentType" - }, - "2496": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduledActorRunOptions" - }, - "2497": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduledActorRunOptions.build" - }, - "2498": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduledActorRunOptions.timeoutSecs" - }, - "2499": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduledActorRunOptions.memoryMbytes" - }, - "2500": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduledActorRunOptions.restartOnError" - }, - "2501": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActionRunActorTask" - }, - "2502": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActionRunActorTask.actorTaskId" - }, - "2503": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "ScheduleActionRunActorTask.input" - }, - "2504": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "BaseScheduleAction.id" - }, - "2505": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "BaseScheduleAction.type" - }, - "2506": { - "sourceFileName": "../src/resource_clients/schedule_collection.ts", - "qualifiedName": "ScheduleCollectionClient" - }, - "2510": { - "sourceFileName": "../src/resource_clients/schedule_collection.ts", - "qualifiedName": "ScheduleCollectionClient.list" - }, - "2511": { - "sourceFileName": "../src/resource_clients/schedule_collection.ts", - "qualifiedName": "ScheduleCollectionClient.list" - }, - "2512": { - "sourceFileName": "../src/resource_clients/schedule_collection.ts", - "qualifiedName": "options" - }, - "2513": { - "sourceFileName": "../src/resource_clients/schedule_collection.ts", - "qualifiedName": "ScheduleCollectionClient.create" - }, - "2514": { - "sourceFileName": "../src/resource_clients/schedule_collection.ts", - "qualifiedName": "ScheduleCollectionClient.create" - }, - "2515": { - "sourceFileName": "../src/resource_clients/schedule_collection.ts", - "qualifiedName": "schedule" - }, - "2516": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "__type" - }, - "2517": { - "sourceFileName": "../src/resource_clients/schedule.ts", - "qualifiedName": "__type.actions" - }, - "2540": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "2541": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "2542": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "2543": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "2544": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "2545": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "2546": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "2547": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "2548": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "2576": { - "sourceFileName": "../src/resource_clients/schedule_collection.ts", - "qualifiedName": "ScheduleCollectionListOptions" - }, - "2577": { - "sourceFileName": "../src/resource_clients/schedule_collection.ts", - "qualifiedName": "ScheduleCollectionListOptions.desc" - }, - "2578": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "2579": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "2580": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "2581": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionClient" - }, - "2585": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionClient.list" - }, - "2586": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionClient.list" - }, - "2587": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "options" - }, - "2610": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "2611": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "2612": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "2613": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "2614": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "2615": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "2616": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "2617": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "2618": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "2646": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "PricingInfo" - }, - "2647": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "PricingInfo.pricingModel" - }, - "2648": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList" - }, - "2649": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.id" - }, - "2650": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.name" - }, - "2651": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.username" - }, - "2652": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.title" - }, - "2653": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.description" - }, - "2654": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.stats" - }, - "2655": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.currentPricingInfo" - }, - "2656": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.pictureUrl" - }, - "2657": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.userPictureUrl" - }, - "2658": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.url" - }, - "2659": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "ActorStoreList.readmeSummary" - }, - "2660": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionListOptions" - }, - "2661": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionListOptions.search" - }, - "2662": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionListOptions.sortBy" - }, - "2663": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionListOptions.category" - }, - "2664": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionListOptions.username" - }, - "2665": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionListOptions.pricingModel" - }, - "2666": { - "sourceFileName": "../src/resource_clients/store_collection.ts", - "qualifiedName": "StoreCollectionListOptions.includeUnrunnableActors" - }, - "2667": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "2668": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "2669": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "2670": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient" - }, - "2674": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.get" - }, - "2675": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.get" - }, - "2676": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.update" - }, - "2677": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.update" - }, - "2678": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "newFields" - }, - "2679": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.delete" - }, - "2680": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.delete" - }, - "2681": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.start" - }, - "2682": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.start" - }, - "2683": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "input" - }, - "2684": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "options" - }, - "2685": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.call" - }, - "2686": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.call" - }, - "2687": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "input" - }, - "2688": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "options" - }, - "2689": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.getInput" - }, - "2690": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.getInput" - }, - "2691": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.updateInput" - }, - "2692": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.updateInput" - }, - "2693": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "newFields" - }, - "2694": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.lastRun" - }, - "2695": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.lastRun" - }, - "2696": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "options" - }, - "2697": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.runs" - }, - "2698": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.runs" - }, - "2699": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.webhooks" - }, - "2700": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskClient.webhooks" - }, - "2722": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "2723": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "2724": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "2725": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "2726": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "2727": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "2728": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "2729": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "2730": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "2758": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task" - }, - "2759": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.id" - }, - "2760": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.userId" - }, - "2761": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.actId" - }, - "2762": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.name" - }, - "2763": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.title" - }, - "2764": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.description" - }, - "2765": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.username" - }, - "2766": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.createdAt" - }, - "2767": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.modifiedAt" - }, - "2768": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.stats" - }, - "2769": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.options" - }, - "2770": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.input" - }, - "2771": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "Task.actorStandby" - }, - "2772": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskStats" - }, - "2773": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskStats.totalRuns" - }, - "2774": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskOptions" - }, - "2775": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskOptions.build" - }, - "2776": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskOptions.timeoutSecs" - }, - "2777": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskOptions.memoryMbytes" - }, - "2778": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskOptions.restartOnError" - }, - "2779": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskUpdateData" - }, - "2780": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskLastRunOptions" - }, - "2781": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskLastRunOptions.status" - }, - "2782": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskStartOptions" - }, - "2783": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskCallOptions" - }, - "2784": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "TaskCallOptions.waitSecs" - }, - "2785": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "restartOnError" - }, - "2786": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "build" - }, - "2787": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "memory" - }, - "2788": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "timeout" - }, - "2789": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "webhooks" - }, - "2790": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "maxItems" - }, - "2791": { - "sourceFileName": "../src/resource_clients/actor.ts", - "qualifiedName": "maxTotalChargeUsd" - }, - "2792": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskCollectionClient" - }, - "2796": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskCollectionClient.list" - }, - "2797": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskCollectionClient.list" - }, - "2798": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "options" - }, - "2799": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskCollectionClient.create" - }, - "2800": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskCollectionClient.create" - }, - "2801": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "task" - }, - "2824": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "2825": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "2826": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "2827": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "2828": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "2829": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "2830": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "2831": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "2832": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "2860": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskCollectionListOptions" - }, - "2861": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskCollectionListOptions.desc" - }, - "2862": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "2863": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "2864": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "2865": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskList" - }, - "2866": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskCreateData" - }, - "2867": { - "sourceFileName": "../src/resource_clients/task_collection.ts", - "qualifiedName": "TaskCreateData.actId" - }, - "2868": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "name" - }, - "2869": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "description" - }, - "2870": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "title" - }, - "2871": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "actorStandby" - }, - "2872": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "input" - }, - "2873": { - "sourceFileName": "../src/resource_clients/task.ts", - "qualifiedName": "options" - }, - "2874": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserClient" - }, - "2878": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserClient.get" - }, - "2879": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserClient.get" - }, - "2880": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserClient.monthlyUsage" - }, - "2881": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserClient.monthlyUsage" - }, - "2882": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserClient.limits" - }, - "2883": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserClient.limits" - }, - "2884": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserClient.updateLimits" - }, - "2885": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserClient.updateLimits" - }, - "2886": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "options" - }, - "2908": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "2909": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "2910": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "2911": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "2912": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "2913": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "2914": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "2915": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "2916": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "2944": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User" - }, - "2945": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User.username" - }, - "2946": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User.profile" - }, - "2947": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type" - }, - "2948": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type.bio" - }, - "2949": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type.name" - }, - "2950": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type.pictureUrl" - }, - "2951": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type.githubUsername" - }, - "2952": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type.websiteUrl" - }, - "2953": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type.twitterUsername" - }, - "2954": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User.id" - }, - "2955": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User.email" - }, - "2956": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User.proxy" - }, - "2957": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User.plan" - }, - "2958": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User.effectivePlatformFeatures" - }, - "2959": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User.createdAt" - }, - "2960": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "User.isPaying" - }, - "2961": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserProxy" - }, - "2962": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserProxy.password" - }, - "2963": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserProxy.groups" - }, - "2964": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "ProxyGroup" - }, - "2965": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "ProxyGroup.name" - }, - "2966": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "ProxyGroup.description" - }, - "2967": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "ProxyGroup.availableCount" - }, - "2968": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan" - }, - "2969": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.id" - }, - "2970": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.description" - }, - "2971": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.isEnabled" - }, - "2972": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.monthlyBasePriceUsd" - }, - "2973": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.monthlyUsageCreditsUsd" - }, - "2974": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.usageDiscountPercent" - }, - "2975": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.enabledPlatformFeatures" - }, - "2976": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.maxMonthlyUsageUsd" - }, - "2977": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.maxActorMemoryGbytes" - }, - "2978": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.maxMonthlyActorComputeUnits" - }, - "2979": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.maxMonthlyResidentialProxyGbytes" - }, - "2980": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.maxMonthlyProxySerps" - }, - "2981": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.maxMonthlyExternalDataTransferGbytes" - }, - "2982": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.maxActorCount" - }, - "2983": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.maxActorTaskCount" - }, - "2984": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.dataRetentionDays" - }, - "2985": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.availableProxyGroups" - }, - "2986": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.teamAccountSeatCount" - }, - "2987": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.supportLevel" - }, - "2988": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UserPlan.availableAddOns" - }, - "2989": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "PlatformFeature" - }, - "2990": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "PlatformFeature.Actors" - }, - "2991": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "PlatformFeature.Storage" - }, - "2992": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "PlatformFeature.ProxySERPS" - }, - "2993": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "PlatformFeature.Scheduler" - }, - "2994": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "PlatformFeature.Webhooks" - }, - "2995": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "PlatformFeature.Proxy" - }, - "2996": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "PlatformFeature.ProxyExternalAccess" - }, - "2997": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyUsage" - }, - "2998": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyUsage.usageCycle" - }, - "2999": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyUsage.monthlyServiceUsage" - }, - "3000": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type" - }, - "3001": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type.__index" - }, - "3003": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyUsage.dailyServiceUsages" - }, - "3004": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyUsage.totalUsageCreditsUsdBeforeVolumeDiscount" - }, - "3005": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyUsage.totalUsageCreditsUsdAfterVolumeDiscount" - }, - "3006": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UsageCycle" - }, - "3007": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UsageCycle.startAt" - }, - "3008": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "UsageCycle.endAt" - }, - "3009": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "AccountAndUsageLimits" - }, - "3010": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "AccountAndUsageLimits.monthlyUsageCycle" - }, - "3011": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "AccountAndUsageLimits.limits" - }, - "3012": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "AccountAndUsageLimits.current" - }, - "3013": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyUsageCycle" - }, - "3014": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyUsageCycle.startAt" - }, - "3015": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "MonthlyUsageCycle.endAt" - }, - "3016": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits" - }, - "3017": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxMonthlyUsageUsd" - }, - "3018": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxMonthlyActorComputeUnits" - }, - "3019": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxMonthlyExternalDataTransferGbytes" - }, - "3020": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxMonthlyProxySerps" - }, - "3021": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxMonthlyResidentialProxyGbytes" - }, - "3022": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxActorMemoryGbytes" - }, - "3023": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxActorCount" - }, - "3024": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxActorTaskCount" - }, - "3025": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxConcurrentActorJobs" - }, - "3026": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.maxTeamAccountSeatCount" - }, - "3027": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Limits.dataRetentionDays" - }, - "3028": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "LimitsUpdateOptions" - }, - "3029": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type" - }, - "3030": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type.maxMonthlyUsageUsd" - }, - "3031": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type" - }, - "3032": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "__type.dataRetentionDays" - }, - "3033": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current" - }, - "3034": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.monthlyUsageUsd" - }, - "3035": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.monthlyActorComputeUnits" - }, - "3036": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.monthlyExternalDataTransferGbytes" - }, - "3037": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.monthlyProxySerps" - }, - "3038": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.monthlyResidentialProxyGbytes" - }, - "3039": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.actorMemoryGbytes" - }, - "3040": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.actorCount" - }, - "3041": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.actorTaskCount" - }, - "3042": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.activeActorJobCount" - }, - "3043": { - "sourceFileName": "../src/resource_clients/user.ts", - "qualifiedName": "Current.teamAccountSeatCount" - }, - "3044": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient" - }, - "3048": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.get" - }, - "3049": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.get" - }, - "3050": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.update" - }, - "3051": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.update" - }, - "3052": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "newFields" - }, - "3053": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.delete" - }, - "3054": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.delete" - }, - "3055": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.test" - }, - "3056": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.test" - }, - "3057": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.dispatches" - }, - "3058": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookClient.dispatches" - }, - "3080": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "3081": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "3082": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "3083": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "3084": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "3085": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "3086": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "3087": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "3088": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "3116": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook" - }, - "3117": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.id" - }, - "3118": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.userId" - }, - "3119": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.createdAt" - }, - "3120": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.modifiedAt" - }, - "3121": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.isAdHoc" - }, - "3122": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.eventTypes" - }, - "3123": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.condition" - }, - "3124": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.ignoreSslErrors" - }, - "3125": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.doNotRetry" - }, - "3126": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.requestUrl" - }, - "3127": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.payloadTemplate" - }, - "3128": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.lastDispatch" - }, - "3129": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.stats" - }, - "3130": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.shouldInterpolateStrings" - }, - "3131": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.isApifyIntegration" - }, - "3132": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.headersTemplate" - }, - "3133": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "Webhook.description" - }, - "3134": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookIdempotencyKey" - }, - "3135": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookIdempotencyKey.idempotencyKey" - }, - "3136": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookUpdateData" - }, - "3137": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "__type" - }, - "3138": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "__type.eventTypes" - }, - "3139": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookStats" - }, - "3140": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookStats.totalDispatches" - }, - "3141": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookEventType" - }, - "3142": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookCondition" - }, - "3143": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookAnyRunOfActorCondition" - }, - "3144": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookAnyRunOfActorCondition.actorId" - }, - "3145": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookAnyRunOfActorTaskCondition" - }, - "3146": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookAnyRunOfActorTaskCondition.actorTaskId" - }, - "3147": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookCertainRunCondition" - }, - "3148": { - "sourceFileName": "../src/resource_clients/webhook.ts", - "qualifiedName": "WebhookCertainRunCondition.actorRunId" - }, - "3149": { - "sourceFileName": "../src/resource_clients/webhook_collection.ts", - "qualifiedName": "WebhookCollectionClient" - }, - "3153": { - "sourceFileName": "../src/resource_clients/webhook_collection.ts", - "qualifiedName": "WebhookCollectionClient.list" - }, - "3154": { - "sourceFileName": "../src/resource_clients/webhook_collection.ts", - "qualifiedName": "WebhookCollectionClient.list" - }, - "3155": { - "sourceFileName": "../src/resource_clients/webhook_collection.ts", - "qualifiedName": "options" - }, - "3156": { - "sourceFileName": "../src/resource_clients/webhook_collection.ts", - "qualifiedName": "WebhookCollectionClient.create" - }, - "3157": { - "sourceFileName": "../src/resource_clients/webhook_collection.ts", - "qualifiedName": "WebhookCollectionClient.create" - }, - "3158": { - "sourceFileName": "../src/resource_clients/webhook_collection.ts", - "qualifiedName": "webhook" - }, - "3181": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "3182": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "3183": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "3184": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "3185": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "3186": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "3187": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "3188": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "3189": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "3217": { - "sourceFileName": "../src/resource_clients/webhook_collection.ts", - "qualifiedName": "WebhookCollectionListOptions" - }, - "3218": { - "sourceFileName": "../src/resource_clients/webhook_collection.ts", - "qualifiedName": "WebhookCollectionListOptions.desc" - }, - "3219": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "3220": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "3221": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "3222": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchClient" - }, - "3226": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchClient.get" - }, - "3227": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchClient.get" - }, - "3249": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "3250": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "3251": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "3252": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "3253": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "3254": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "3255": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "3256": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "3257": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "3285": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch" - }, - "3286": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch.id" - }, - "3287": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch.userId" - }, - "3288": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch.webhookId" - }, - "3289": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch.createdAt" - }, - "3290": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch.status" - }, - "3291": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch.eventType" - }, - "3292": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch.calls" - }, - "3293": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch.webhook" - }, - "3294": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatch.eventData" - }, - "3295": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchStatus" - }, - "3296": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchStatus.Active" - }, - "3297": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchStatus.Succeeded" - }, - "3298": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchStatus.Failed" - }, - "3299": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchCall" - }, - "3300": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchCall.startedAt" - }, - "3301": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchCall.finishedAt" - }, - "3302": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchCall.errorMessage" - }, - "3303": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchCall.responseStatus" - }, - "3304": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchCall.responseBody" - }, - "3305": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchEventData" - }, - "3306": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchEventData.actorRunId" - }, - "3307": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchEventData.actorId" - }, - "3308": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchEventData.actorTaskId" - }, - "3309": { - "sourceFileName": "../src/resource_clients/webhook_dispatch.ts", - "qualifiedName": "WebhookDispatchEventData.actorBuildId" - }, - "3310": { - "sourceFileName": "../src/resource_clients/webhook_dispatch_collection.ts", - "qualifiedName": "WebhookDispatchCollectionClient" - }, - "3314": { - "sourceFileName": "../src/resource_clients/webhook_dispatch_collection.ts", - "qualifiedName": "WebhookDispatchCollectionClient.list" - }, - "3315": { - "sourceFileName": "../src/resource_clients/webhook_dispatch_collection.ts", - "qualifiedName": "WebhookDispatchCollectionClient.list" - }, - "3316": { - "sourceFileName": "../src/resource_clients/webhook_dispatch_collection.ts", - "qualifiedName": "options" - }, - "3339": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.id" - }, - "3340": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.safeId" - }, - "3341": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.baseUrl" - }, - "3342": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.publicBaseUrl" - }, - "3343": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.resourcePath" - }, - "3344": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.url" - }, - "3345": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.apifyClient" - }, - "3346": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.httpClient" - }, - "3347": { - "sourceFileName": "../src/base/api_client.ts", - "qualifiedName": "ApiClient.params" - }, - "3375": { - "sourceFileName": "../src/resource_clients/webhook_dispatch_collection.ts", - "qualifiedName": "WebhookDispatchCollectionListOptions" - }, - "3376": { - "sourceFileName": "../src/resource_clients/webhook_dispatch_collection.ts", - "qualifiedName": "WebhookDispatchCollectionListOptions.desc" - }, - "3377": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.offset" - }, - "3378": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.limit" - }, - "3379": { - "sourceFileName": "../src/utils.ts", - "qualifiedName": "PaginationOptions.chunkSize" - }, - "3380": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError" - }, - "3381": { - "sourceFileName": "../node_modules/typescript/lib/lib.esnext.error.d.ts", - "qualifiedName": "ErrorConstructor.isError" - }, - "3382": { - "sourceFileName": "../node_modules/typescript/lib/lib.esnext.error.d.ts", - "qualifiedName": "ErrorConstructor.isError" - }, - "3383": { - "sourceFileName": "../node_modules/typescript/lib/lib.esnext.error.d.ts", - "qualifiedName": "error" - }, - "3384": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.captureStackTrace" - }, - "3385": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.captureStackTrace" - }, - "3386": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "targetObject" - }, - "3387": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "constructorOpt" - }, - "3388": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.prepareStackTrace" - }, - "3389": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.prepareStackTrace" - }, - "3390": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "err" - }, - "3391": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "stackTraces" - }, - "3392": { - "sourceFileName": "../node_modules/@types/node/globals.d.ts", - "qualifiedName": "ErrorConstructor.stackTraceLimit" - }, - "3398": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError.name" - }, - "3399": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError.clientMethod" - }, - "3400": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError.statusCode" - }, - "3401": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError.type" - }, - "3402": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError.attempt" - }, - "3403": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError.httpMethod" - }, - "3404": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError.path" - }, - "3405": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError.originalStack" - }, - "3406": { - "sourceFileName": "../src/apify_api_error.ts", - "qualifiedName": "ApifyApiError.data" - }, - "3415": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error.message" - }, - "3416": { - "sourceFileName": "../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error.stack" - }, - "3417": { - "sourceFileName": "../node_modules/typescript/lib/lib.es2022.error.d.ts", - "qualifiedName": "Error.cause" - } - }, - "files": { - "entries": { - "1": "../src/index.ts" - }, - "reflections": { - "1": 0 - } - } -} \ No newline at end of file diff --git a/website/versioned_sidebars/version-2-sidebars.json b/website/versioned_sidebars/version-2-sidebars.json deleted file mode 100644 index 23d57077d..000000000 --- a/website/versioned_sidebars/version-2-sidebars.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "sidebar": [ - { - "type": "doc", - "id": "introduction/introduction" - }, - { - "type": "doc", - "id": "introduction/quick-start" - }, - { - "type": "category", - "label": "Concepts", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "02_concepts" - } - ] - }, - { - "type": "category", - "label": "Guides", - "collapsed": true, - "items": [ - { - "type": "autogenerated", - "dirName": "03_guides" - } - ] - } - ] -} diff --git a/website/versions.json b/website/versions.json deleted file mode 100644 index 92034d3a3..000000000 --- a/website/versions.json +++ /dev/null @@ -1,3 +0,0 @@ -[ - "2" -] From 6db681d384063764cad954f152ee1c3a50e0f435 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jind=C5=99ich=20B=C3=A4r?= Date: Wed, 17 Jun 2026 16:45:50 +0200 Subject: [PATCH 2/5] docs: keep `@since` annotations minimal Annotate every top-level symbol, but annotate a member only when it was added in a later release than its parent. A member introduced alongside its parent is already covered by the parent's `@since`, so repeating it on every field was noise. Removes 417 redundant tags (1056 -> 639). Co-Authored-By: Claude Opus 4.8 (1M context) --- src/apify_client.ts | 28 +- src/resource_clients/actor.ts | 336 ++---------------- src/resource_clients/actor_collection.ts | 47 +-- src/resource_clients/actor_env_var.ts | 3 - .../actor_env_var_collection.ts | 5 - src/resource_clients/actor_version.ts | 57 --- .../actor_version_collection.ts | 3 - src/resource_clients/build.ts | 52 --- src/resource_clients/build_collection.ts | 3 - src/resource_clients/dataset.ts | 72 ---- src/resource_clients/dataset_collection.ts | 9 - src/resource_clients/key_value_store.ts | 57 --- .../key_value_store_collection.ts | 9 - src/resource_clients/log.ts | 25 +- src/resource_clients/request_queue.ts | 152 +------- .../request_queue_collection.ts | 6 - src/resource_clients/run.ts | 46 +-- src/resource_clients/run_collection.ts | 6 - src/resource_clients/schedule.ts | 42 --- src/resource_clients/schedule_collection.ts | 3 - src/resource_clients/store_collection.ts | 46 --- src/resource_clients/task.ts | 18 - src/resource_clients/task_collection.ts | 6 - src/resource_clients/user.ts | 195 ---------- src/resource_clients/webhook.ts | 15 - src/resource_clients/webhook_collection.ts | 3 - src/resource_clients/webhook_dispatch.ts | 36 -- .../webhook_dispatch_collection.ts | 3 - src/utils.ts | 40 +-- 29 files changed, 50 insertions(+), 1273 deletions(-) diff --git a/src/apify_client.ts b/src/apify_client.ts index e26ddb338..a8e8ccda9 100644 --- a/src/apify_client.ts +++ b/src/apify_client.ts @@ -610,39 +610,21 @@ export class ApifyClient { * @since Added in 2.0.1 */ export interface ApifyClientOptions { - /** - * @default https://api.apify.com - * @since Added in 2.0.1 - */ + /** @default https://api.apify.com */ baseUrl?: string; /** * @default https://api.apify.com * @since Added in 2.17.0 */ publicBaseUrl?: string; - /** - * @default 8 - * @since Added in 2.0.1 - */ + /** @default 8 */ maxRetries?: number; - /** - * @default 500 - * @since Added in 2.0.1 - */ + /** @default 500 */ minDelayBetweenRetriesMillis?: number; - /** - * @default [] - * @since Added in 2.0.1 - */ + /** @default [] */ requestInterceptors?: RequestInterceptorFunction[]; - /** - * @default 360 - * @since Added in 2.0.1 - */ + /** @default 360 */ timeoutSecs?: number; - /** - * @since Added in 2.0.1 - */ token?: string; /** * @since Added in 2.10.0 diff --git a/src/resource_clients/actor.ts b/src/resource_clients/actor.ts index 77d335490..266e22c1b 100644 --- a/src/resource_clients/actor.ts +++ b/src/resource_clients/actor.ts @@ -607,45 +607,21 @@ export interface Actor { * @since Added in 2.0.1 */ export interface ActorStats { - /** - * Total number of builds created for this Actor - * @since Added in 2.0.1 - */ + /** Total number of builds created for this Actor */ totalBuilds: number; - /** - * Total number of times this Actor has been run - * @since Added in 2.0.1 - */ + /** Total number of times this Actor has been run */ totalRuns: number; - /** - * Total number of unique users who have run this Actor - * @since Added in 2.0.1 - */ + /** Total number of unique users who have run this Actor */ totalUsers: number; - /** - * Number of unique users in the last 7 days - * @since Added in 2.0.1 - */ + /** Number of unique users in the last 7 days */ totalUsers7Days: number; - /** - * Number of unique users in the last 30 days - * @since Added in 2.0.1 - */ + /** Number of unique users in the last 30 days */ totalUsers30Days: number; - /** - * Number of unique users in the last 90 days - * @since Added in 2.0.1 - */ + /** Number of unique users in the last 90 days */ totalUsers90Days: number; - /** - * Total number of times this Actor was used via metamorph - * @since Added in 2.0.1 - */ + /** Total number of times this Actor was used via metamorph */ totalMetamorphs: number; - /** - * Timestamp when the last run was started - * @since Added in 2.0.1 - */ + /** Timestamp when the last run was started */ lastRunStartedAt: Date; } @@ -654,17 +630,8 @@ export interface ActorStats { * @since Added in 2.0.1 */ export interface ActorDefaultRunOptions { - /** - * @since Added in 2.0.1 - */ build: string; - /** - * @since Added in 2.0.1 - */ timeoutSecs: number; - /** - * @since Added in 2.0.1 - */ memoryMbytes: number; /** * @since Added in 2.19.0 @@ -677,13 +644,7 @@ export interface ActorDefaultRunOptions { * @since Added in 2.0.1 */ export interface ActorExampleRunInput { - /** - * @since Added in 2.0.1 - */ body: string; - /** - * @since Added in 2.0.1 - */ contentType: string; } @@ -698,17 +659,8 @@ export type ActorTaggedBuilds = Record; * @since Added in 2.0.1 */ export interface ActorTaggedBuild { - /** - * @since Added in 2.0.1 - */ buildId?: string; - /** - * @since Added in 2.0.1 - */ buildNumber?: string; - /** - * @since Added in 2.0.1 - */ finishedAt?: Date; } @@ -744,29 +696,14 @@ export type ActorUpdateOptions = Partial< * @since Added in 2.9.5 */ export interface ActorStandby { - /** - * @since Added in 2.9.5 - */ build?: string; - /** - * @since Added in 2.9.5 - */ desiredRequestsPerActorRun?: number; /** * @since Added in 2.22.0 */ disableStandbyFieldsOverride?: boolean; - /** - * @since Added in 2.9.5 - */ idleTimeoutSecs?: number; - /** - * @since Added in 2.9.5 - */ maxRequestsPerActorRun?: number; - /** - * @since Added in 2.9.5 - */ memoryMbytes?: number; /** * @since Added in 2.22.0 @@ -814,7 +751,6 @@ export interface ActorStartOptions { * By default (or when `waitForFinish` is set to `0`), the function resolves immediately without waiting. * The wait is limited to 60s and happens on the API directly, as opposed to the `call` method and its * `waitSecs` option, which is implemented via polling on the client side instead (and has no limit like that). - * @since Added in 2.0.1 */ waitForFinish?: number; @@ -870,7 +806,6 @@ export interface ActorStartOptions { export interface ActorCallOptions extends Omit { /** * Wait time in seconds for the Actor run to finish. - * @since Added in 2.6.2 */ waitSecs?: number; /** @@ -947,20 +882,11 @@ export interface ActorRunListItem { * @since Added in 2.22.3 */ export interface ActorRunStorageIds { - /** - * Aliased dataset IDs for this run. - * @since Added in 2.22.3 - */ + /** Aliased dataset IDs for this run. */ datasets: { default: string; [alias: string]: string }; - /** - * Aliased key-value store IDs for this run. - * @since Added in 2.22.3 - */ + /** Aliased key-value store IDs for this run. */ keyValueStores: { default: string; [alias: string]: string }; - /** - * Aliased request queue IDs for this run. - * @since Added in 2.22.3 - */ + /** Aliased request queue IDs for this run. */ requestQueues: { default: string; [alias: string]: string }; } @@ -1037,65 +963,29 @@ export interface ActorRun extends ActorRunListItem { * @since Added in 2.7.0 */ export interface ActorRunUsage { - /** - * Compute units consumed (combines CPU and memory usage over time) - * @since Added in 2.7.0 - */ + /** Compute units consumed (combines CPU and memory usage over time) */ ACTOR_COMPUTE_UNITS?: number; - /** - * Number of Dataset read operations - * @since Added in 2.7.0 - */ + /** Number of Dataset read operations */ DATASET_READS?: number; - /** - * Number of Dataset write operations - * @since Added in 2.7.0 - */ + /** Number of Dataset write operations */ DATASET_WRITES?: number; - /** - * Number of key-value store read operations - * @since Added in 2.7.0 - */ + /** Number of key-value store read operations */ KEY_VALUE_STORE_READS?: number; - /** - * Number of key-value store write operations - * @since Added in 2.7.0 - */ + /** Number of key-value store write operations */ KEY_VALUE_STORE_WRITES?: number; - /** - * Number of key-value store list operations - * @since Added in 2.7.0 - */ + /** Number of key-value store list operations */ KEY_VALUE_STORE_LISTS?: number; - /** - * Number of Request queue read operations - * @since Added in 2.7.0 - */ + /** Number of Request queue read operations */ REQUEST_QUEUE_READS?: number; - /** - * Number of Request queue write operations - * @since Added in 2.7.0 - */ + /** Number of Request queue write operations */ REQUEST_QUEUE_WRITES?: number; - /** - * Internal data transfer within Apify platform (in gigabytes) - * @since Added in 2.7.0 - */ + /** Internal data transfer within Apify platform (in gigabytes) */ DATA_TRANSFER_INTERNAL_GBYTES?: number; - /** - * External data transfer to/from internet (in gigabytes) - * @since Added in 2.7.0 - */ + /** External data transfer to/from internet (in gigabytes) */ DATA_TRANSFER_EXTERNAL_GBYTES?: number; - /** - * Residential proxy data transfer (in gigabytes) - * @since Added in 2.7.0 - */ + /** Residential proxy data transfer (in gigabytes) */ PROXY_RESIDENTIAL_TRANSFER_GBYTES?: number; - /** - * Number of SERP (Search Engine Results Page) proxy requests - * @since Added in 2.7.0 - */ + /** Number of SERP (Search Engine Results Page) proxy requests */ PROXY_SERPS?: number; } @@ -1104,17 +994,8 @@ export interface ActorRunUsage { * @since Added in 2.0.1 */ export interface ActorRunMeta { - /** - * @since Added in 2.0.1 - */ origin: string; - /** - * @since Added in 2.0.1 - */ clientIp?: string; - /** - * @since Added in 2.0.1 - */ userAgent: string; } @@ -1125,65 +1006,20 @@ export interface ActorRunMeta { * @since Added in 2.0.1 */ export interface ActorRunStats { - /** - * @since Added in 2.0.1 - */ inputBodyLen: number; - /** - * @since Added in 2.0.1 - */ restartCount: number; - /** - * @since Added in 2.0.1 - */ resurrectCount: number; - /** - * @since Added in 2.0.1 - */ memAvgBytes: number; - /** - * @since Added in 2.0.1 - */ memMaxBytes: number; - /** - * @since Added in 2.0.1 - */ memCurrentBytes: number; - /** - * @since Added in 2.0.1 - */ cpuAvgUsage: number; - /** - * @since Added in 2.0.1 - */ cpuMaxUsage: number; - /** - * @since Added in 2.0.1 - */ cpuCurrentUsage: number; - /** - * @since Added in 2.0.1 - */ netRxBytes: number; - /** - * @since Added in 2.0.1 - */ netTxBytes: number; - /** - * @since Added in 2.0.1 - */ durationMillis: number; - /** - * @since Added in 2.0.1 - */ runTimeSecs: number; - /** - * @since Added in 2.0.1 - */ metamorph: number; - /** - * @since Added in 2.0.1 - */ computeUnits: number; } @@ -1194,21 +1030,9 @@ export interface ActorRunStats { * @since Added in 2.0.1 */ export interface ActorRunOptions { - /** - * @since Added in 2.0.1 - */ build: string; - /** - * @since Added in 2.0.1 - */ timeoutSecs: number; - /** - * @since Added in 2.0.1 - */ memoryMbytes: number; - /** - * @since Added in 2.0.1 - */ diskMbytes: number; /** * @since Added in 2.20.0 @@ -1229,21 +1053,9 @@ export interface ActorRunOptions { * @since Added in 2.0.1 */ export interface ActorBuildOptions { - /** - * @since Added in 2.0.1 - */ betaPackages?: boolean; - /** - * @since Added in 2.0.1 - */ tag?: string; - /** - * @since Added in 2.0.1 - */ useCache?: boolean; - /** - * @since Added in 2.0.1 - */ waitForFinish?: number; } @@ -1252,9 +1064,6 @@ export interface ActorBuildOptions { * @since Added in 2.0.1 */ export interface ActorLastRunOptions { - /** - * @since Added in 2.0.1 - */ status?: keyof typeof ACT_JOB_STATUSES; } @@ -1266,42 +1075,17 @@ export interface ActorLastRunOptions { * @since Added in 2.11.0 */ export interface ActorDefinition { - /** - * @since Added in 2.11.0 - */ actorSpecification: number; - /** - * @since Added in 2.11.0 - */ name: string; - /** - * @since Added in 2.11.0 - */ version: string; - /** - * @since Added in 2.11.0 - */ buildTag?: string; - /** - * @since Added in 2.11.0 - */ environmentVariables?: Record; - /** - * @since Added in 2.11.0 - */ dockerfile?: string; - /** - * @since Added in 2.11.0 - */ dockerContextDir?: string; - /** - * @since Added in 2.11.0 - */ readme?: string | null; /** * Input schema for the Actor. * @see https://docs.apify.com/platform/actors/development/actor-definition/input-schema - * @since Added in 2.11.0 */ input?: object | null; /** @@ -1310,35 +1094,17 @@ export interface ActorDefinition { * @since Added in 2.23.0 */ output?: object | null; - /** - * @since Added in 2.11.0 - */ changelog?: string | null; - /** - * @since Added in 2.11.0 - */ storages?: { dataset?: object; }; - /** - * @since Added in 2.11.0 - */ minMemoryMbytes?: number; - /** - * @since Added in 2.11.0 - */ maxMemoryMbytes?: number; - /** - * @since Added in 2.11.0 - */ usesStandbyMode?: boolean; } interface CommonActorPricingInfo { - /** - * In [0, 1], fraction of pricePerUnitUsd that goes to Apify - * @since Added in 2.11.1 - */ + /** In [0, 1], fraction of pricePerUnitUsd that goes to Apify */ apifyMarginPercentage: number; /** * When this pricing info record has been created @@ -1350,17 +1116,8 @@ interface CommonActorPricingInfo { * @since Added in 2.0.1 */ startedAt: Date; - /** - * @since Added in 2.11.1 - */ notifiedAboutFutureChangeAt?: Date; - /** - * @since Added in 2.11.1 - */ notifiedAboutChangeAt?: Date; - /** - * @since Added in 2.11.1 - */ reasonForChange?: string; } @@ -1369,9 +1126,6 @@ interface CommonActorPricingInfo { * @since Added in 2.11.1 */ export interface FreeActorPricingInfo extends CommonActorPricingInfo { - /** - * @since Added in 2.11.1 - */ pricingModel: 'FREE'; } @@ -1380,19 +1134,10 @@ export interface FreeActorPricingInfo extends CommonActorPricingInfo { * @since Added in 2.11.1 */ export interface FlatPricePerMonthActorPricingInfo extends CommonActorPricingInfo { - /** - * @since Added in 2.11.1 - */ pricingModel: 'FLAT_PRICE_PER_MONTH'; - /** - * For how long this Actor can be used for free in trial period - * @since Added in 2.11.1 - */ + /** For how long this Actor can be used for free in trial period */ trialMinutes?: number; - /** - * Monthly flat price in USD - * @since Added in 2.11.1 - */ + /** Monthly flat price in USD */ pricePerUnitUsd: number; } @@ -1403,18 +1148,9 @@ export interface FlatPricePerMonthActorPricingInfo extends CommonActorPricingInf * @since Added in 2.11.1 */ export interface PricePerDatasetItemActorPricingInfo extends CommonActorPricingInfo { - /** - * @since Added in 2.11.1 - */ pricingModel: 'PRICE_PER_DATASET_ITEM'; - /** - * Name of the unit that is being charged - * @since Added in 2.11.1 - */ + /** Name of the unit that is being charged */ unitName?: string; - /** - * @since Added in 2.11.1 - */ pricePerUnitUsd: number; } @@ -1423,17 +1159,8 @@ export interface PricePerDatasetItemActorPricingInfo extends CommonActorPricingI * @since Added in 2.11.1 */ export interface ActorChargeEvent { - /** - * @since Added in 2.11.1 - */ eventPriceUsd: number; - /** - * @since Added in 2.11.1 - */ eventTitle: string; - /** - * @since Added in 2.11.1 - */ eventDescription?: string; } @@ -1450,19 +1177,10 @@ export type ActorChargeEvents = Record; * @since Added in 2.11.1 */ export interface PricePerEventActorPricingInfo extends CommonActorPricingInfo { - /** - * @since Added in 2.11.1 - */ pricingModel: 'PAY_PER_EVENT'; - /** - * @since Added in 2.11.1 - */ pricingPerEvent: { actorChargeEvents: ActorChargeEvents; }; - /** - * @since Added in 2.11.1 - */ minimalMaxTotalChargeUsd?: number; } diff --git a/src/resource_clients/actor_collection.ts b/src/resource_clients/actor_collection.ts index eb9b416a9..b9b2b15d9 100644 --- a/src/resource_clients/actor_collection.ts +++ b/src/resource_clients/actor_collection.ts @@ -96,13 +96,7 @@ export class ActorCollectionClient extends ResourceCollectionClient { * @since Added in 2.12.6 */ export enum ActorListSortBy { - /** - * @since Added in 2.12.6 - */ CREATED_AT = 'createdAt', - /** - * @since Added in 2.12.6 - */ LAST_RUN_STARTED_AT = 'stats.lastRunStartedAt', } @@ -110,13 +104,7 @@ export enum ActorListSortBy { * @since Added in 2.0.1 */ export interface ActorCollectionListOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ my?: boolean; - /** - * @since Added in 2.0.1 - */ desc?: boolean; /** * @since Added in 2.12.6 @@ -128,25 +116,10 @@ export interface ActorCollectionListOptions extends PaginationOptions { * @since Added in 2.0.1 */ export interface ActorCollectionListItem { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ createdAt: Date; - /** - * @since Added in 2.0.1 - */ modifiedAt: Date; - /** - * @since Added in 2.0.1 - */ name: string; - /** - * @since Added in 2.0.1 - */ username: string; } @@ -167,9 +140,6 @@ export interface ActorCollectionCreateOptions { * @since Added in 2.8.6 */ defaultRunOptions?: ActorDefaultRunOptions; - /** - * @since Added in 2.0.1 - */ description?: string; /** * @since Added in 2.8.6 @@ -179,18 +149,9 @@ export interface ActorCollectionCreateOptions { * @since Added in 2.8.6 */ isDeprecated?: boolean; - /** - * @since Added in 2.0.1 - */ isPublic?: boolean; - /** - * @since Added in 2.0.1 - */ name?: string; - /** - * @deprecated Use defaultRunOptions.restartOnError instead - * @since Added in 2.0.1 - */ + /** @deprecated Use defaultRunOptions.restartOnError instead */ restartOnError?: boolean; /** * @since Added in 2.8.6 @@ -200,13 +161,7 @@ export interface ActorCollectionCreateOptions { * @since Added in 2.8.6 */ seoDescription?: string; - /** - * @since Added in 2.0.1 - */ title?: string; - /** - * @since Added in 2.0.1 - */ versions?: ActorVersion[]; /** * @since Added in 2.9.5 diff --git a/src/resource_clients/actor_env_var.ts b/src/resource_clients/actor_env_var.ts index 33109e054..2dbdd88b8 100644 --- a/src/resource_clients/actor_env_var.ts +++ b/src/resource_clients/actor_env_var.ts @@ -43,7 +43,6 @@ export class ActorEnvVarClient extends ResourceClient { * * @returns The environment variable object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/act-version-env-var-get - * @since Added in 2.1.0 */ async get(): Promise { return this._get(); @@ -55,7 +54,6 @@ export class ActorEnvVarClient extends ResourceClient { * @param actorEnvVar - The updated environment variable data. * @returns The updated environment variable object. * @see https://docs.apify.com/api/v2/act-version-env-var-put - * @since Added in 2.1.0 */ async update(actorEnvVar: ActorEnvironmentVariable): Promise { ow(actorEnvVar, ow.object); @@ -66,7 +64,6 @@ export class ActorEnvVarClient extends ResourceClient { * Deletes the environment variable. * * @see https://docs.apify.com/api/v2/act-version-env-var-delete - * @since Added in 2.1.0 */ async delete(): Promise { return this._delete(); diff --git a/src/resource_clients/actor_env_var_collection.ts b/src/resource_clients/actor_env_var_collection.ts index e908b71e0..3277e8d91 100644 --- a/src/resource_clients/actor_env_var_collection.ts +++ b/src/resource_clients/actor_env_var_collection.ts @@ -61,7 +61,6 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { * * @returns A paginated iterator of environment variables. * @see https://docs.apify.com/api/v2/act-version-env-vars-get - * @since Added in 2.1.0 */ list( _options: ActorEnvVarCollectionListOptions = {}, @@ -75,7 +74,6 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { * @param actorEnvVar - The environment variable data. * @returns The created environment variable object. * @see https://docs.apify.com/api/v2/act-version-env-vars-post - * @since Added in 2.1.0 */ async create(actorEnvVar: ActorEnvironmentVariable): Promise { ow(actorEnvVar, ow.optional.object); @@ -89,9 +87,6 @@ export class ActorEnvVarCollectionClient extends ResourceCollectionClient { * @since Added in 2.1.0 */ export interface ActorEnvVarCollectionListOptions extends PaginationOptions { - /** - * @since Added in 2.1.0 - */ desc?: boolean; } diff --git a/src/resource_clients/actor_version.ts b/src/resource_clients/actor_version.ts index bb2237122..d091c17b0 100644 --- a/src/resource_clients/actor_version.ts +++ b/src/resource_clients/actor_version.ts @@ -106,25 +106,10 @@ export class ActorVersionClient extends ResourceClient { * @since Added in 2.0.1 */ export interface BaseActorVersion { - /** - * @since Added in 2.0.1 - */ versionNumber?: string; - /** - * @since Added in 2.0.1 - */ sourceType: SourceType; - /** - * @since Added in 2.0.1 - */ envVars?: ActorEnvironmentVariable[]; - /** - * @since Added in 2.0.1 - */ applyEnvVarsToBuild?: boolean; - /** - * @since Added in 2.0.1 - */ buildTag?: string; } @@ -132,9 +117,6 @@ export interface BaseActorVersion { * @since Added in 2.6.1 */ export interface ActorVersionSourceFiles extends BaseActorVersion { - /** - * @since Added in 2.6.1 - */ sourceFiles: ActorVersionSourceFile[]; } @@ -142,17 +124,8 @@ export interface ActorVersionSourceFiles extends BaseActorVersion { - /** - * @since Added in 2.0.1 - */ gitRepoUrl: string; } @@ -170,9 +140,6 @@ export interface ActorVersionGitRepo extends BaseActorVersion { - /** - * @since Added in 2.0.1 - */ tarballUrl: string; } @@ -180,9 +147,6 @@ export interface ActorVersionTarball extends BaseActorVersion { - /** - * @since Added in 2.0.1 - */ gitHubGistUrl: string; } @@ -190,21 +154,9 @@ export interface ActorVersionGitHubGist extends BaseActorVersion; } @@ -685,20 +625,8 @@ export interface DatasetStatistics { * @since Added in 2.11.2 */ export interface FieldStatistics { - /** - * @since Added in 2.11.2 - */ min?: number; - /** - * @since Added in 2.11.2 - */ max?: number; - /** - * @since Added in 2.11.2 - */ nullCount?: number; - /** - * @since Added in 2.11.2 - */ emptyCount?: number; } diff --git a/src/resource_clients/dataset_collection.ts b/src/resource_clients/dataset_collection.ts index a80af6e57..0cc1d7c52 100644 --- a/src/resource_clients/dataset_collection.ts +++ b/src/resource_clients/dataset_collection.ts @@ -98,13 +98,7 @@ export class DatasetCollectionClient extends ResourceCollectionClient { * @since Added in 2.0.1 */ export interface DatasetCollectionClientListOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ unnamed?: boolean; - /** - * @since Added in 2.0.1 - */ desc?: boolean; /** * Filter by ownership: 'ownedByMe' returns only user's own datasets, 'sharedWithMe' returns only shared datasets. @@ -117,9 +111,6 @@ export interface DatasetCollectionClientListOptions extends PaginationOptions { * @since Added in 2.3.0 */ export interface DatasetCollectionClientGetOrCreateOptions { - /** - * @since Added in 2.3.0 - */ schema?: Record; } diff --git a/src/resource_clients/key_value_store.ts b/src/resource_clients/key_value_store.ts index 210663b9e..e896d964e 100644 --- a/src/resource_clients/key_value_store.ts +++ b/src/resource_clients/key_value_store.ts @@ -588,25 +588,10 @@ export interface KeyValueStore { * @since Added in 2.0.1 */ export interface KeyValueStoreStats { - /** - * @since Added in 2.0.1 - */ readCount?: number; - /** - * @since Added in 2.0.1 - */ writeCount?: number; - /** - * @since Added in 2.0.1 - */ deleteCount?: number; - /** - * @since Added in 2.0.1 - */ listCount?: number; - /** - * @since Added in 2.0.1 - */ storageBytes?: number; } @@ -615,9 +600,6 @@ export interface KeyValueStoreStats { * @since Added in 2.0.1 */ export interface KeyValueClientUpdateOptions { - /** - * @since Added in 2.0.1 - */ name?: string | null; /** * @since Added in 2.6.1 @@ -663,9 +645,6 @@ export interface KeyValueClientListKeysOptions { * @since Added in 2.16.0 */ export interface KeyValueClientCreateKeysUrlOptions extends KeyValueClientListKeysOptions { - /** - * @since Added in 2.16.0 - */ expiresInSecs?: number; } @@ -676,29 +655,11 @@ export interface KeyValueClientCreateKeysUrlOptions extends KeyValueClientListKe * @since Added in 2.0.1 */ export interface KeyValueClientListKeysResult { - /** - * @since Added in 2.0.1 - */ count: number; - /** - * @since Added in 2.0.1 - */ limit: number; - /** - * @since Added in 2.0.1 - */ exclusiveStartKey: string; - /** - * @since Added in 2.0.1 - */ isTruncated: boolean; - /** - * @since Added in 2.0.1 - */ nextExclusiveStartKey: string; - /** - * @since Added in 2.0.1 - */ items: KeyValueListItem[]; } @@ -707,13 +668,7 @@ export interface KeyValueClientListKeysResult { * @since Added in 2.0.1 */ export interface KeyValueListItem { - /** - * @since Added in 2.0.1 - */ key: string; - /** - * @since Added in 2.0.1 - */ size: number; /** * @since Added in 2.15.1 @@ -726,13 +681,7 @@ export interface KeyValueListItem { * @since Added in 2.0.1 */ export interface KeyValueClientGetRecordOptions { - /** - * @since Added in 2.0.1 - */ buffer?: boolean; - /** - * @since Added in 2.0.1 - */ stream?: boolean; /** * @since Added in 2.18.0 @@ -766,13 +715,7 @@ export interface KeyValueStoreRecord { * @since Added in 2.12.4 */ export interface KeyValueStoreRecordOptions { - /** - * @since Added in 2.12.4 - */ timeoutSecs?: number; - /** - * @since Added in 2.12.4 - */ doNotRetryTimeouts?: boolean; } diff --git a/src/resource_clients/key_value_store_collection.ts b/src/resource_clients/key_value_store_collection.ts index 6c6342b87..98cfd353f 100644 --- a/src/resource_clients/key_value_store_collection.ts +++ b/src/resource_clients/key_value_store_collection.ts @@ -101,13 +101,7 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { * @since Added in 2.0.1 */ export interface KeyValueStoreCollectionClientListOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ unnamed?: boolean; - /** - * @since Added in 2.0.1 - */ desc?: boolean; /** * Filter by ownership: 'ownedByMe' returns only user's own key-value stores, 'sharedWithMe' returns only shared key-value stores. @@ -120,9 +114,6 @@ export interface KeyValueStoreCollectionClientListOptions extends PaginationOpti * @since Added in 2.3.0 */ export interface KeyValueStoreCollectionClientGetOrCreateOptions { - /** - * @since Added in 2.3.0 - */ schema?: Record; } diff --git a/src/resource_clients/log.ts b/src/resource_clients/log.ts index 32f59e72c..48727dc93 100644 --- a/src/resource_clients/log.ts +++ b/src/resource_clients/log.ts @@ -109,10 +109,7 @@ export class LogClient extends ResourceClient { * @since Added in 2.20.0 */ export interface LogOptions { - /** - * @default false - * @since Added in 2.20.0 - */ + /** @default false */ raw?: boolean; } @@ -125,9 +122,6 @@ export class LoggerActorRedirect extends Logger { super({ skipTime: true, level: LogLevel.DEBUG, ...options }); } - /** - * @since Added in 2.20.0 - */ override _log(level: LogLevel, message: string, data?: any, exception?: unknown, opts: Record = {}) { if (level > this.options.level) { return; @@ -175,7 +169,6 @@ export class StreamedLog { /** * Start log redirection. - * @since Added in 2.20.0 */ public start(): void { if (this.streamingTask) { @@ -187,7 +180,6 @@ export class StreamedLog { /** * Stop log redirection. - * @since Added in 2.20.0 */ public async stop(): Promise { if (!this.streamingTask) { @@ -284,19 +276,10 @@ export class StreamedLog { * @since Added in 2.20.0 */ export interface StreamedLogOptions { - /** - * Log client used to communicate with the Apify API. - * @since Added in 2.20.0 - */ + /** Log client used to communicate with the Apify API. */ logClient: LogClient; - /** - * Log to which the Actor run logs will be redirected. - * @since Added in 2.20.0 - */ + /** Log to which the Actor run logs will be redirected. */ toLog: Log; - /** - * Whether to redirect all logs from Actor run start (even logs from the past). - * @since Added in 2.20.0 - */ + /** Whether to redirect all logs from Actor run start (even logs from the past). */ fromStart?: boolean; } diff --git a/src/resource_clients/request_queue.ts b/src/resource_clients/request_queue.ts index 53a6caacd..40b864635 100644 --- a/src/resource_clients/request_queue.ts +++ b/src/resource_clients/request_queue.ts @@ -838,9 +838,6 @@ export class RequestQueueClient extends ResourceClient { * @since Added in 2.0.1 */ export interface RequestQueueUserOptions { - /** - * @since Added in 2.0.1 - */ clientKey?: string; /** * @since Added in 2.2.0 @@ -931,25 +928,10 @@ export interface RequestQueue { * @since Added in 2.0.1 */ export interface RequestQueueStats { - /** - * @since Added in 2.0.1 - */ readCount?: number; - /** - * @since Added in 2.0.1 - */ writeCount?: number; - /** - * @since Added in 2.0.1 - */ deleteCount?: number; - /** - * @since Added in 2.0.1 - */ headItemReadCount?: number; - /** - * @since Added in 2.0.1 - */ storageBytes?: number; } @@ -958,9 +940,6 @@ export interface RequestQueueStats { * @since Added in 2.0.1 */ export interface RequestQueueClientUpdateOptions { - /** - * @since Added in 2.0.1 - */ name?: string | null; /** * @since Added in 2.6.1 @@ -977,9 +956,6 @@ export interface RequestQueueClientUpdateOptions { * @since Added in 2.0.1 */ export interface RequestQueueClientListHeadOptions { - /** - * @since Added in 2.0.1 - */ limit?: number; } @@ -1016,14 +992,10 @@ export type RequestQueueListRequestsFilter = 'locked' | 'pending'; * @since Added in 2.5.1 */ export interface RequestQueueClientListRequestsOptions { - /** - * @since Added in 2.5.1 - */ limit?: number; /** * Using id of request that does not exist in request queue leads to unpredictable results. * @deprecated Use `cursor` for pagination instead. - * @since Added in 2.5.1 */ exclusiveStartId?: string; /** @@ -1041,18 +1013,9 @@ export interface RequestQueueClientListRequestsOptions { * @since Added in 2.5.1 */ export interface RequestQueueClientPaginateRequestsOptions { - /** - * @since Added in 2.5.1 - */ limit?: number; - /** - * @since Added in 2.5.1 - */ maxPageLimit?: number; - /** - * @deprecated Use `cursor` for pagination instead. - * @since Added in 2.5.1 - */ + /** @deprecated Use `cursor` for pagination instead. */ exclusiveStartId?: string; /** * @since Added in 2.23.2 @@ -1069,14 +1032,8 @@ export interface RequestQueueClientPaginateRequestsOptions { * @since Added in 2.5.1 */ export interface RequestQueueClientListRequestsResult { - /** - * @since Added in 2.5.1 - */ limit: number; - /** - * @deprecated Use `cursor` for pagination instead. - * @since Added in 2.5.1 - */ + /** @deprecated Use `cursor` for pagination instead. */ exclusiveStartId?: string; /** * @since Added in 2.23.2 @@ -1086,9 +1043,6 @@ export interface RequestQueueClientListRequestsResult { * @since Added in 2.23.2 */ nextCursor?: string; - /** - * @since Added in 2.5.1 - */ items: RequestQueueClientRequestSchema[]; } @@ -1097,13 +1051,7 @@ export interface RequestQueueClientListRequestsResult { * @since Added in 2.4.1 */ export interface RequestQueueClientListAndLockHeadOptions { - /** - * @since Added in 2.4.1 - */ lockSecs: number; - /** - * @since Added in 2.4.1 - */ limit?: number; } @@ -1114,9 +1062,6 @@ export interface RequestQueueClientListAndLockHeadOptions { * @since Added in 2.4.1 */ export interface RequestQueueClientListAndLockHeadResult extends RequestQueueClientListHeadResult { - /** - * @since Added in 2.4.1 - */ lockSecs: number; /** * @since Added in 2.11.0 @@ -1133,25 +1078,10 @@ export interface RequestQueueClientListAndLockHeadResult extends RequestQueueCli * @since Added in 2.0.1 */ export interface RequestQueueClientListItem { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ retryCount: number; - /** - * @since Added in 2.0.1 - */ uniqueKey: string; - /** - * @since Added in 2.0.1 - */ url: string; - /** - * @since Added in 2.0.1 - */ method: AllowedHttpMethods; /** * @since Added in 2.4.1 @@ -1163,9 +1093,6 @@ export interface RequestQueueClientListItem { * @since Added in 2.0.1 */ export interface RequestQueueClientAddRequestOptions { - /** - * @since Added in 2.0.1 - */ forefront?: boolean; } @@ -1173,13 +1100,7 @@ export interface RequestQueueClientAddRequestOptions { * @since Added in 2.4.1 */ export interface RequestQueueClientProlongRequestLockOptions { - /** - * @since Added in 2.4.1 - */ forefront?: boolean; - /** - * @since Added in 2.4.1 - */ lockSecs: number; } @@ -1187,9 +1108,6 @@ export interface RequestQueueClientProlongRequestLockOptions { * @since Added in 2.4.1 */ export interface RequestQueueClientDeleteRequestLockOptions { - /** - * @since Added in 2.4.1 - */ forefront?: boolean; } @@ -1197,9 +1115,6 @@ export interface RequestQueueClientDeleteRequestLockOptions { * @since Added in 2.4.1 */ export interface RequestQueueClientProlongRequestLockResult { - /** - * @since Added in 2.4.1 - */ lockExpiresAt: Date; } @@ -1207,17 +1122,8 @@ export interface RequestQueueClientProlongRequestLockResult { * @since Added in 2.3.0 */ export interface RequestQueueClientBatchAddRequestWithRetriesOptions { - /** - * @since Added in 2.3.0 - */ forefront?: boolean; - /** - * @since Added in 2.3.0 - */ maxUnprocessedRequestsRetries?: number; - /** - * @since Added in 2.3.0 - */ maxParallel?: number; /** * @since Added in 2.4.0 @@ -1232,53 +1138,17 @@ export interface RequestQueueClientBatchAddRequestWithRetriesOptions { * @since Added in 2.0.1 */ export interface RequestQueueClientRequestSchema { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ uniqueKey: string; - /** - * @since Added in 2.0.1 - */ url: string; - /** - * @since Added in 2.0.1 - */ method?: AllowedHttpMethods; - /** - * @since Added in 2.0.1 - */ payload?: string; - /** - * @since Added in 2.0.1 - */ retryCount?: number; - /** - * @since Added in 2.0.1 - */ errorMessages?: string[]; - /** - * @since Added in 2.0.1 - */ headers?: Record; - /** - * @since Added in 2.0.1 - */ userData?: Record; - /** - * @since Added in 2.0.1 - */ handledAt?: string; - /** - * @since Added in 2.0.1 - */ noRetry?: boolean; - /** - * @since Added in 2.0.1 - */ loadedUrl?: string; } @@ -1287,17 +1157,8 @@ export interface RequestQueueClientRequestSchema { * @since Added in 2.0.1 */ export interface RequestQueueClientAddRequestResult { - /** - * @since Added in 2.0.1 - */ requestId: string; - /** - * @since Added in 2.0.1 - */ wasAlreadyPresent: boolean; - /** - * @since Added in 2.0.1 - */ wasAlreadyHandled: boolean; } @@ -1318,9 +1179,6 @@ interface UnprocessedRequest { * @since Added in 2.12.5 */ export interface RequestQueueClientUnlockRequestsResult { - /** - * @since Added in 2.12.5 - */ unlockedCount: number; } @@ -1331,13 +1189,7 @@ export interface RequestQueueClientUnlockRequestsResult { * @since Added in 2.3.0 */ export interface RequestQueueClientBatchRequestsOperationResult { - /** - * @since Added in 2.3.0 - */ processedRequests: ProcessedRequest[]; - /** - * @since Added in 2.3.0 - */ unprocessedRequests: UnprocessedRequest[]; } diff --git a/src/resource_clients/request_queue_collection.ts b/src/resource_clients/request_queue_collection.ts index b738cef3a..904ec5c07 100644 --- a/src/resource_clients/request_queue_collection.ts +++ b/src/resource_clients/request_queue_collection.ts @@ -96,13 +96,7 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient { * @since Added in 2.0.1 */ export interface RequestQueueCollectionListOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ unnamed?: boolean; - /** - * @since Added in 2.0.1 - */ desc?: boolean; /** * Filter by ownership: 'ownedByMe' returns only user's own request queues, 'sharedWithMe' returns only shared request queues. diff --git a/src/resource_clients/run.ts b/src/resource_clients/run.ts index f197feb45..88b0259be 100644 --- a/src/resource_clients/run.ts +++ b/src/resource_clients/run.ts @@ -490,13 +490,7 @@ export class RunClient extends ResourceClient { * @since Added in 2.20.0 */ export interface GetStreamedLogOptions { - /** - * @since Added in 2.20.0 - */ toLog?: Log | null | 'default'; - /** - * @since Added in 2.20.0 - */ fromStart?: boolean; } @@ -505,9 +499,6 @@ export interface GetStreamedLogOptions { * @since Added in 2.0.1 */ export interface RunGetOptions { - /** - * @since Added in 2.0.1 - */ waitForFinish?: number; } @@ -516,9 +507,6 @@ export interface RunGetOptions { * @since Added in 2.0.1 */ export interface RunAbortOptions { - /** - * @since Added in 2.0.1 - */ gracefully?: boolean; } @@ -527,13 +515,7 @@ export interface RunAbortOptions { * @since Added in 2.0.1 */ export interface RunMetamorphOptions { - /** - * @since Added in 2.0.1 - */ contentType?: string; - /** - * @since Added in 2.0.1 - */ build?: string; } @@ -542,9 +524,6 @@ export interface RunMetamorphOptions { * @since Added in 2.6.0 */ export interface RunUpdateOptions { - /** - * @since Added in 2.6.0 - */ statusMessage?: string; /** * @since Added in 2.6.3 @@ -561,17 +540,8 @@ export interface RunUpdateOptions { * @since Added in 2.0.1 */ export interface RunResurrectOptions { - /** - * @since Added in 2.0.1 - */ build?: string; - /** - * @since Added in 2.0.1 - */ memory?: number; - /** - * @since Added in 2.0.1 - */ timeout?: number; /** * @since Added in 2.12.1 @@ -592,20 +562,11 @@ export interface RunResurrectOptions { * @since Added in 2.11.0 */ export interface RunChargeOptions { - /** - * Name of the event to charge. Must be defined in the Actor's pricing info else the API will throw. - * @since Added in 2.11.0 - */ + /** Name of the event to charge. Must be defined in the Actor's pricing info else the API will throw. */ eventName: string; - /** - * Defaults to 1 - * @since Added in 2.11.0 - */ + /** Defaults to 1 */ count?: number; - /** - * Defaults to runId-eventName-timestamp - * @since Added in 2.11.0 - */ + /** Defaults to runId-eventName-timestamp */ idempotencyKey?: string; } @@ -618,7 +579,6 @@ export interface RunWaitForFinishOptions { * Maximum time to wait for the run to finish, in seconds. * If the limit is reached, the returned promise is resolved to a run object that will have * status `READY` or `RUNNING`. If `waitSecs` omitted, the function waits indefinitely. - * @since Added in 2.0.1 */ waitSecs?: number; } diff --git a/src/resource_clients/run_collection.ts b/src/resource_clients/run_collection.ts index 26d4d1be7..35b428fa7 100644 --- a/src/resource_clients/run_collection.ts +++ b/src/resource_clients/run_collection.ts @@ -85,13 +85,7 @@ export class RunCollectionClient extends ResourceCollectionClient { * @since Added in 2.0.1 */ export interface RunCollectionListOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ desc?: boolean; - /** - * @since Added in 2.0.1 - */ status?: | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES] | (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES][]; diff --git a/src/resource_clients/schedule.ts b/src/resource_clients/schedule.ts index dad33078d..567d24bbb 100644 --- a/src/resource_clients/schedule.ts +++ b/src/resource_clients/schedule.ts @@ -190,24 +190,12 @@ export type ScheduleCreateOrUpdateData = Partial< * @since Added in 2.0.1 */ export enum ScheduleActions { - /** - * @since Added in 2.0.1 - */ RunActor = 'RUN_ACTOR', - /** - * @since Added in 2.0.1 - */ RunActorTask = 'RUN_ACTOR_TASK', } interface BaseScheduleAction { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ type: Type; } @@ -222,17 +210,8 @@ export type ScheduleAction = ScheduleActionRunActor | ScheduleActionRunActorTask * @since Added in 2.0.1 */ export interface ScheduleActionRunActor extends BaseScheduleAction { - /** - * @since Added in 2.0.1 - */ actorId: string; - /** - * @since Added in 2.0.1 - */ runInput?: ScheduledActorRunInput; - /** - * @since Added in 2.0.1 - */ runOptions?: ScheduledActorRunOptions; } @@ -241,13 +220,7 @@ export interface ScheduleActionRunActor extends BaseScheduleAction { - /** - * @since Added in 2.0.1 - */ actorTaskId: string; - /** - * @since Added in 2.0.1 - */ input?: string; } diff --git a/src/resource_clients/schedule_collection.ts b/src/resource_clients/schedule_collection.ts index 0d87dcbf8..d050ecd8e 100644 --- a/src/resource_clients/schedule_collection.ts +++ b/src/resource_clients/schedule_collection.ts @@ -94,8 +94,5 @@ export class ScheduleCollectionClient extends ResourceCollectionClient { * @since Added in 2.0.1 */ export interface ScheduleCollectionListOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ desc?: boolean; } diff --git a/src/resource_clients/store_collection.ts b/src/resource_clients/store_collection.ts index 5e37b33dd..412c117ab 100644 --- a/src/resource_clients/store_collection.ts +++ b/src/resource_clients/store_collection.ts @@ -56,7 +56,6 @@ export class StoreCollectionClient extends ResourceCollectionClient { * @param options - Search and pagination options. * @returns A paginated iterator of store Actors. * @see https://docs.apify.com/api/v2/store-get - * @since Added in 2.7.2 */ list(options: StoreCollectionListOptions = {}): PaginatedIterator { ow( @@ -81,9 +80,6 @@ export class StoreCollectionClient extends ResourceCollectionClient { * @since Added in 2.7.2 */ export interface PricingInfo { - /** - * @since Added in 2.7.2 - */ pricingModel: string; } @@ -91,41 +87,14 @@ export interface PricingInfo { * @since Added in 2.7.2 */ export interface ActorStoreList { - /** - * @since Added in 2.7.2 - */ id: string; - /** - * @since Added in 2.7.2 - */ name: string; - /** - * @since Added in 2.7.2 - */ username: string; - /** - * @since Added in 2.7.2 - */ title?: string; - /** - * @since Added in 2.7.2 - */ description?: string; - /** - * @since Added in 2.7.2 - */ stats: ActorStats; - /** - * @since Added in 2.7.2 - */ currentPricingInfo: PricingInfo; - /** - * @since Added in 2.7.2 - */ pictureUrl?: string; - /** - * @since Added in 2.7.2 - */ userPictureUrl?: string; /** * @since Added in 2.8.6 @@ -142,25 +111,10 @@ export interface ActorStoreList { * @since Added in 2.7.2 */ export interface StoreCollectionListOptions extends PaginationOptions { - /** - * @since Added in 2.7.2 - */ search?: string; - /** - * @since Added in 2.7.2 - */ sortBy?: string; - /** - * @since Added in 2.7.2 - */ category?: string; - /** - * @since Added in 2.7.2 - */ username?: string; - /** - * @since Added in 2.7.2 - */ pricingModel?: string; /** * If true, the response will include Actors that cannot be run (e.g., Actors diff --git a/src/resource_clients/task.ts b/src/resource_clients/task.ts index 33d967a5f..e0f23a5ca 100644 --- a/src/resource_clients/task.ts +++ b/src/resource_clients/task.ts @@ -351,9 +351,6 @@ export interface Task { * @since Added in 2.0.1 */ export interface TaskStats { - /** - * @since Added in 2.0.1 - */ totalRuns: number; } @@ -362,17 +359,8 @@ export interface TaskStats { * @since Added in 2.0.1 */ export interface TaskOptions { - /** - * @since Added in 2.0.1 - */ build?: string; - /** - * @since Added in 2.0.1 - */ timeoutSecs?: number; - /** - * @since Added in 2.0.1 - */ memoryMbytes?: number; /** * @since Added in 2.19.0 @@ -393,9 +381,6 @@ export type TaskUpdateData = Partial< * @since Added in 2.0.1 */ export interface TaskLastRunOptions { - /** - * @since Added in 2.0.1 - */ status?: keyof typeof ACT_JOB_STATUSES; } @@ -413,8 +398,5 @@ export type TaskStartOptions = Omit { - /** - * @since Added in 2.6.2 - */ waitSecs?: number; } diff --git a/src/resource_clients/task_collection.ts b/src/resource_clients/task_collection.ts index 0e4e6c977..69987928d 100644 --- a/src/resource_clients/task_collection.ts +++ b/src/resource_clients/task_collection.ts @@ -94,9 +94,6 @@ export class TaskCollectionClient extends ResourceCollectionClient { * @since Added in 2.0.1 */ export interface TaskCollectionListOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ desc?: boolean; } @@ -109,8 +106,5 @@ export type TaskList = Omit; * @since Added in 2.3.0 */ export interface TaskCreateData extends TaskUpdateData { - /** - * @since Added in 2.3.0 - */ actId: string; } diff --git a/src/resource_clients/user.ts b/src/resource_clients/user.ts index 4de91f004..b74c3def5 100644 --- a/src/resource_clients/user.ts +++ b/src/resource_clients/user.ts @@ -184,13 +184,7 @@ export interface User { * @since Added in 2.0.1 */ export interface UserProxy { - /** - * @since Added in 2.0.1 - */ password: string; - /** - * @since Added in 2.0.1 - */ groups: ProxyGroup[]; } @@ -198,17 +192,8 @@ export interface UserProxy { * @since Added in 2.0.1 */ export interface ProxyGroup { - /** - * @since Added in 2.0.1 - */ name: string; - /** - * @since Added in 2.0.1 - */ description: string; - /** - * @since Added in 2.0.1 - */ availableCount: number; } @@ -216,85 +201,25 @@ export interface ProxyGroup { * @since Added in 2.0.1 */ export interface UserPlan { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ description: string; - /** - * @since Added in 2.0.1 - */ isEnabled: boolean; - /** - * @since Added in 2.0.1 - */ monthlyBasePriceUsd: number; - /** - * @since Added in 2.0.1 - */ monthlyUsageCreditsUsd: number; - /** - * @since Added in 2.0.1 - */ usageDiscountPercent: number; - /** - * @since Added in 2.0.1 - */ enabledPlatformFeatures: PlatformFeature[]; - /** - * @since Added in 2.0.1 - */ maxMonthlyUsageUsd: number; - /** - * @since Added in 2.0.1 - */ maxActorMemoryGbytes: number; - /** - * @since Added in 2.0.1 - */ maxMonthlyActorComputeUnits: number; - /** - * @since Added in 2.0.1 - */ maxMonthlyResidentialProxyGbytes: number; - /** - * @since Added in 2.0.1 - */ maxMonthlyProxySerps: number; - /** - * @since Added in 2.0.1 - */ maxMonthlyExternalDataTransferGbytes: number; - /** - * @since Added in 2.0.1 - */ maxActorCount: number; - /** - * @since Added in 2.0.1 - */ maxActorTaskCount: number; - /** - * @since Added in 2.0.1 - */ dataRetentionDays: number; - /** - * @since Added in 2.0.1 - */ availableProxyGroups: Record; - /** - * @since Added in 2.0.1 - */ teamAccountSeatCount: number; - /** - * @since Added in 2.0.1 - */ supportLevel: string; - /** - * @since Added in 2.0.1 - */ availableAddOns: unknown[]; } @@ -302,33 +227,12 @@ export interface UserPlan { * @since Added in 2.0.1 */ export enum PlatformFeature { - /** - * @since Added in 2.0.1 - */ Actors = 'ACTORS', - /** - * @since Added in 2.0.1 - */ Storage = 'STORAGE', - /** - * @since Added in 2.0.1 - */ ProxySERPS = 'PROXY_SERPS', - /** - * @since Added in 2.0.1 - */ Scheduler = 'SCHEDULER', - /** - * @since Added in 2.0.1 - */ Webhooks = 'WEBHOOKS', - /** - * @since Added in 2.0.1 - */ Proxy = 'PROXY', - /** - * @since Added in 2.0.1 - */ ProxyExternalAccess = 'PROXY_EXTERNAL_ACCESS', } @@ -361,25 +265,10 @@ interface EffectivePlatformFeatures { * @since Added in 2.9.2 */ export interface MonthlyUsage { - /** - * @since Added in 2.9.2 - */ usageCycle: UsageCycle; - /** - * @since Added in 2.9.2 - */ monthlyServiceUsage: { [key: string]: MonthlyServiceUsageData }; - /** - * @since Added in 2.9.2 - */ dailyServiceUsages: DailyServiceUsage[]; - /** - * @since Added in 2.9.2 - */ totalUsageCreditsUsdBeforeVolumeDiscount: number; - /** - * @since Added in 2.9.2 - */ totalUsageCreditsUsdAfterVolumeDiscount: number; } @@ -387,13 +276,7 @@ export interface MonthlyUsage { * @since Added in 2.9.2 */ export interface UsageCycle { - /** - * @since Added in 2.9.2 - */ startAt: Date; - /** - * @since Added in 2.9.2 - */ endAt: Date; } @@ -434,17 +317,8 @@ interface DailyServiceUsageData { * @since Added in 2.9.2 */ export interface AccountAndUsageLimits { - /** - * @since Added in 2.9.2 - */ monthlyUsageCycle: MonthlyUsageCycle; - /** - * @since Added in 2.9.2 - */ limits: Limits; - /** - * @since Added in 2.9.2 - */ current: Current; } @@ -452,13 +326,7 @@ export interface AccountAndUsageLimits { * @since Added in 2.9.2 */ export interface MonthlyUsageCycle { - /** - * @since Added in 2.9.2 - */ startAt: Date; - /** - * @since Added in 2.9.2 - */ endAt: Date; } @@ -466,49 +334,16 @@ export interface MonthlyUsageCycle { * @since Added in 2.9.2 */ export interface Limits { - /** - * @since Added in 2.9.2 - */ maxMonthlyUsageUsd: number; - /** - * @since Added in 2.9.2 - */ maxMonthlyActorComputeUnits: number; - /** - * @since Added in 2.9.2 - */ maxMonthlyExternalDataTransferGbytes: number; - /** - * @since Added in 2.9.2 - */ maxMonthlyProxySerps: number; - /** - * @since Added in 2.9.2 - */ maxMonthlyResidentialProxyGbytes: number; - /** - * @since Added in 2.9.2 - */ maxActorMemoryGbytes: number; - /** - * @since Added in 2.9.2 - */ maxActorCount: number; - /** - * @since Added in 2.9.2 - */ maxActorTaskCount: number; - /** - * @since Added in 2.9.2 - */ maxConcurrentActorJobs: number; - /** - * @since Added in 2.9.2 - */ maxTeamAccountSeatCount: number; - /** - * @since Added in 2.9.2 - */ dataRetentionDays: number; } @@ -521,44 +356,14 @@ export type LimitsUpdateOptions = { maxMonthlyUsageUsd: number } | { dataRetenti * @since Added in 2.9.2 */ export interface Current { - /** - * @since Added in 2.9.2 - */ monthlyUsageUsd: number; - /** - * @since Added in 2.9.2 - */ monthlyActorComputeUnits: number; - /** - * @since Added in 2.9.2 - */ monthlyExternalDataTransferGbytes: number; - /** - * @since Added in 2.9.2 - */ monthlyProxySerps: number; - /** - * @since Added in 2.9.2 - */ monthlyResidentialProxyGbytes: number; - /** - * @since Added in 2.9.2 - */ actorMemoryGbytes: number; - /** - * @since Added in 2.9.2 - */ actorCount: number; - /** - * @since Added in 2.9.2 - */ actorTaskCount: number; - /** - * @since Added in 2.9.2 - */ activeActorJobCount: number; - /** - * @since Added in 2.9.2 - */ teamAccountSeatCount: number; } diff --git a/src/resource_clients/webhook.ts b/src/resource_clients/webhook.ts index 799c11670..cf82da9ef 100644 --- a/src/resource_clients/webhook.ts +++ b/src/resource_clients/webhook.ts @@ -207,9 +207,6 @@ export interface Webhook { * @since Added in 2.0.1 */ export interface WebhookIdempotencyKey { - /** - * @since Added in 2.0.1 - */ idempotencyKey?: string; } @@ -243,9 +240,6 @@ export type WebhookUpdateData = Partial< * @since Added in 2.0.1 */ export interface WebhookStats { - /** - * @since Added in 2.0.1 - */ totalDispatches: number; } @@ -268,9 +262,6 @@ export type WebhookCondition = * @since Added in 2.0.1 */ export interface WebhookAnyRunOfActorCondition { - /** - * @since Added in 2.0.1 - */ actorId: string; } @@ -278,9 +269,6 @@ export interface WebhookAnyRunOfActorCondition { * @since Added in 2.0.1 */ export interface WebhookAnyRunOfActorTaskCondition { - /** - * @since Added in 2.0.1 - */ actorTaskId: string; } @@ -288,8 +276,5 @@ export interface WebhookAnyRunOfActorTaskCondition { * @since Added in 2.0.1 */ export interface WebhookCertainRunCondition { - /** - * @since Added in 2.0.1 - */ actorRunId: string; } diff --git a/src/resource_clients/webhook_collection.ts b/src/resource_clients/webhook_collection.ts index f750ab3d6..18845d6b6 100644 --- a/src/resource_clients/webhook_collection.ts +++ b/src/resource_clients/webhook_collection.ts @@ -98,8 +98,5 @@ export class WebhookCollectionClient extends ResourceCollectionClient { * @since Added in 2.0.1 */ export interface WebhookCollectionListOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ desc?: boolean; } diff --git a/src/resource_clients/webhook_dispatch.ts b/src/resource_clients/webhook_dispatch.ts index 24002a518..2688e43ba 100644 --- a/src/resource_clients/webhook_dispatch.ts +++ b/src/resource_clients/webhook_dispatch.ts @@ -90,17 +90,8 @@ export interface WebhookDispatch { * @since Added in 2.0.1 */ export enum WebhookDispatchStatus { - /** - * @since Added in 2.0.1 - */ Active = 'ACTIVE', - /** - * @since Added in 2.0.1 - */ Succeeded = 'SUCCEEDED', - /** - * @since Added in 2.0.1 - */ Failed = 'FAILED', } @@ -108,25 +99,10 @@ export enum WebhookDispatchStatus { * @since Added in 2.0.1 */ export interface WebhookDispatchCall { - /** - * @since Added in 2.0.1 - */ startedAt: Date; - /** - * @since Added in 2.0.1 - */ finishedAt: Date; - /** - * @since Added in 2.0.1 - */ errorMessage: string | null; - /** - * @since Added in 2.0.1 - */ responseStatus: number | null; - /** - * @since Added in 2.0.1 - */ responseBody: string | null; } @@ -134,20 +110,8 @@ export interface WebhookDispatchCall { * @since Added in 2.13.0 */ export interface WebhookDispatchEventData { - /** - * @since Added in 2.13.0 - */ actorRunId?: string; - /** - * @since Added in 2.13.0 - */ actorId?: string; - /** - * @since Added in 2.13.0 - */ actorTaskId?: string; - /** - * @since Added in 2.13.0 - */ actorBuildId?: string; } diff --git a/src/resource_clients/webhook_dispatch_collection.ts b/src/resource_clients/webhook_dispatch_collection.ts index cb87b29a3..bfb2d1a2c 100644 --- a/src/resource_clients/webhook_dispatch_collection.ts +++ b/src/resource_clients/webhook_dispatch_collection.ts @@ -74,8 +74,5 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient { * @since Added in 2.0.1 */ export interface WebhookDispatchCollectionListOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ desc?: boolean; } diff --git a/src/utils.ts b/src/utils.ts index f7d2f980f..2a5b37119 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -255,15 +255,9 @@ export interface RequestQueuePaginationIteratorOptions { * Standard pagination options for API requests. */ export interface PaginationOptions { - /** - * Position of the first returned entry. - * @since Added in 2.0.1 - */ + /** Position of the first returned entry. */ offset?: number; - /** - * Maximum number of entries requested. - * @since Added in 2.0.1 - */ + /** Maximum number of entries requested. */ limit?: number; /** Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator * will fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the @@ -281,15 +275,9 @@ export interface PaginationOptions { * @template Data - The type of items in the response */ export interface PaginatedResponse { - /** - * Total count of entries. - * @since Added in 2.0.1 - */ + /** Total count of entries. */ total: number; - /** - * Entries. - * @since Added in 2.0.1 - */ + /** Entries. */ items: Data[]; } @@ -303,25 +291,13 @@ export interface PaginatedResponse { * @since Added in 2.0.1 */ export interface PaginatedList extends PaginatedResponse { - /** - * Count of dataset entries returned in this set. - * @since Added in 2.0.1 - */ + /** Count of dataset entries returned in this set. */ count: number; - /** - * Position of the first returned entry in the dataset. - * @since Added in 2.0.1 - */ + /** Position of the first returned entry in the dataset. */ offset: number; - /** - * Maximum number of dataset entries requested. - * @since Added in 2.0.1 - */ + /** Maximum number of dataset entries requested. */ limit: number; - /** - * Should the results be in descending order. - * @since Added in 2.0.1 - */ + /** Should the results be in descending order. */ desc: boolean; } From 21a5e0e475f8a177525e2e27e417fd605816acac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jind=C5=99ich=20B=C3=A4r?= Date: Thu, 18 Jun 2026 14:08:08 +0200 Subject: [PATCH 3/5] docs: update `@apify/docusaurus-plugin-typedoc-api` --- pnpm-lock.yaml | 151 +++++++++++++++++++++++++++++-------------- website/package.json | 2 +- 2 files changed, 104 insertions(+), 49 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 8410b0321..33439a312 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -137,10 +137,10 @@ importers: dependencies: '@apify/docs-theme': specifier: ^1.0.251 - version: 1.0.251(959f6a77c61b01e5801039cc98a02b4a) + version: 1.0.251(5a6ccafe0c3a8405a7e18a561832ba83) '@apify/docusaurus-plugin-typedoc-api': - specifier: ^5.1.11 - version: 5.1.11(2fce7341730efb937c1d18fab5517614) + specifier: ^5.1.13 + version: 5.1.13(2fce7341730efb937c1d18fab5517614) '@docusaurus/core': specifier: ^3.8.1 version: 3.10.1(@docusaurus/faster@3.10.1(@docusaurus/types@3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3))(@swc/helpers@0.5.23)(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3))(@mdx-js/react@3.1.1(@types/react@19.2.17)(react@19.2.7))(@rspack/core@1.7.11(@swc/helpers@0.5.23))(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(typescript@6.0.3)(webpack-cli@7.0.3) @@ -359,8 +359,8 @@ packages: react: '*' react-dom: '*' - '@apify/docusaurus-plugin-typedoc-api@5.1.11': - resolution: {integrity: sha512-4936Ajkg3Dv8J1IFlQrQEZhNTVz3PW2U5PWQQ/fRalK1P0h+a8pW77WWgyAJd1dm0VpBYKNmeiERgJqfD6S4dQ==} + '@apify/docusaurus-plugin-typedoc-api@5.1.13': + resolution: {integrity: sha512-q/c44mqTbFM64YdDZSz4WmJF1NUPe0mMpw3rIuF7RL1amzKLdCDmvGWGbpe/+h8j4ysRRaQ9TdkDCgNgrY5hwQ==} engines: {node: '>=16.12.0'} peerDependencies: '@docusaurus/core': ^3.8.1 @@ -9363,7 +9363,7 @@ snapshots: - search-insights - supports-color - '@apify/docs-theme@1.0.251(959f6a77c61b01e5801039cc98a02b4a)': + '@apify/docs-theme@1.0.251(5a6ccafe0c3a8405a7e18a561832ba83)': dependencies: '@apify/docs-search-modal': 1.3.6(@algolia/client-search@5.53.0)(@babel/core@7.29.7)(@types/react@19.2.17)(react-dom@19.2.7(react@19.2.7))(react-is@16.13.1)(react@19.2.7)(search-insights@2.17.3) '@apify/ui-icons': 1.44.0(react-dom@19.2.7(react@19.2.7))(react@19.2.7) @@ -9372,7 +9372,7 @@ snapshots: '@stackql/docusaurus-plugin-hubspot': 1.1.0 algoliasearch: 5.53.0 algoliasearch-helper: 3.29.1(algoliasearch@5.53.0) - babel-loader: 10.1.1(@babel/core@7.29.7)(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + babel-loader: 10.1.1(@babel/core@7.29.7)(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) clsx: 2.1.1 docusaurus-gtm-plugin: 0.0.2 postcss-preset-env: 11.3.0(postcss@8.5.15) @@ -9410,7 +9410,7 @@ snapshots: - webpack - webpack-cli - '@apify/docusaurus-plugin-typedoc-api@5.1.11(2fce7341730efb937c1d18fab5517614)': + '@apify/docusaurus-plugin-typedoc-api@5.1.13(2fce7341730efb937c1d18fab5517614)': dependencies: '@docusaurus/core': 3.10.1(@docusaurus/faster@3.10.1(@docusaurus/types@3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3))(@swc/helpers@0.5.23)(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3))(@mdx-js/react@3.1.1(@types/react@19.2.17)(react@19.2.7))(@rspack/core@1.7.11(@swc/helpers@0.5.23))(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(typescript@6.0.3)(webpack-cli@7.0.3) '@docusaurus/mdx-loader': 3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3) @@ -11108,24 +11108,24 @@ snapshots: '@docusaurus/logger': 3.10.1 '@docusaurus/types': 3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3) '@docusaurus/utils': 3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3) - babel-loader: 9.2.1(@babel/core@7.29.7)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + babel-loader: 9.2.1(@babel/core@7.29.7)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) clean-css: 5.3.3 - copy-webpack-plugin: 11.0.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) - css-loader: 6.11.0(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) - css-minimizer-webpack-plugin: 5.0.1(clean-css@5.3.3)(esbuild@0.28.0)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + copy-webpack-plugin: 11.0.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + css-loader: 6.11.0(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + css-minimizer-webpack-plugin: 5.0.1(clean-css@5.3.3)(esbuild@0.28.0)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) cssnano: 6.1.2(postcss@8.5.15) - file-loader: 6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + file-loader: 6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) html-minifier-terser: 7.2.0 - mini-css-extract-plugin: 2.10.2(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) - null-loader: 4.0.1(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + mini-css-extract-plugin: 2.10.2(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + null-loader: 4.0.1(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) postcss: 8.5.15 - postcss-loader: 7.3.4(postcss@8.5.15)(typescript@6.0.3)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + postcss-loader: 7.3.4(postcss@8.5.15)(typescript@6.0.3)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) postcss-preset-env: 10.6.1(postcss@8.5.15) - terser-webpack-plugin: 5.6.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + terser-webpack-plugin: 5.6.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) tslib: 2.8.1 - url-loader: 4.1.1(file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + url-loader: 4.1.1(file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) - webpackbar: 7.0.0(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + webpackbar: 7.0.0(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) optionalDependencies: '@docusaurus/faster': 3.10.1(@docusaurus/types@3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3))(@swc/helpers@0.5.23)(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3) transitivePeerDependencies: @@ -11169,7 +11169,7 @@ snapshots: execa: 5.1.1 fs-extra: 11.3.5 html-tags: 3.3.1 - html-webpack-plugin: 5.6.7(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + html-webpack-plugin: 5.6.7(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) leven: 3.1.0 lodash: 4.18.1 open: 8.4.2 @@ -11179,7 +11179,7 @@ snapshots: react-dom: 19.2.7(react@19.2.7) react-helmet-async: '@slorber/react-helmet-async@1.3.0(react-dom@19.2.7(react@19.2.7))(react@19.2.7)' react-loadable: '@docusaurus/react-loadable@6.0.0(react@19.2.7)' - react-loadable-ssr-addon-v5-slorber: 1.0.3(@docusaurus/react-loadable@6.0.0(react@19.2.7))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + react-loadable-ssr-addon-v5-slorber: 1.0.3(@docusaurus/react-loadable@6.0.0(react@19.2.7))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) react-router: 5.3.4(react@19.2.7) react-router-config: 5.1.1(react-router@5.3.4(react@19.2.7))(react@19.2.7) react-router-dom: 5.3.4(react@19.2.7) @@ -11190,7 +11190,7 @@ snapshots: update-notifier: 6.0.2 webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) webpack-bundle-analyzer: 4.10.2 - webpack-dev-server: 5.2.4(tslib@2.8.1)(webpack-cli@7.0.3)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + webpack-dev-server: 5.2.4(tslib@2.8.1)(webpack-cli@7.0.3)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) webpack-merge: 6.0.1 optionalDependencies: '@docusaurus/faster': 3.10.1(@docusaurus/types@3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3))(@swc/helpers@0.5.23)(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3) @@ -11232,9 +11232,9 @@ snapshots: browserslist: 4.28.2 lightningcss: 1.32.0 semver: 7.8.2 - swc-loader: 0.2.7(@swc/core@1.15.40(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + swc-loader: 0.2.7(@swc/core@1.15.40(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) tslib: 2.8.1 - webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) + webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3) transitivePeerDependencies: - '@minify-html/node' - '@swc/css' @@ -11262,7 +11262,7 @@ snapshots: '@slorber/remark-comment': 1.0.0 escape-html: 1.0.3 estree-util-value-to-estree: 3.5.0 - file-loader: 6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + file-loader: 6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) fs-extra: 11.3.5 image-size: 2.0.2 mdast-util-mdx: 3.0.0 @@ -11278,7 +11278,7 @@ snapshots: tslib: 2.8.1 unified: 11.0.5 unist-util-visit: 5.1.0 - url-loader: 4.1.1(file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + url-loader: 4.1.1(file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) vfile: 6.0.3 webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) transitivePeerDependencies: @@ -11968,7 +11968,7 @@ snapshots: '@docusaurus/utils-common': 3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3) escape-string-regexp: 4.0.0 execa: 5.1.1 - file-loader: 6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + file-loader: 6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) fs-extra: 11.3.5 github-slugger: 1.5.0 globby: 11.1.0 @@ -11981,7 +11981,7 @@ snapshots: prompts: 2.4.2 resolve-pathname: 3.0.0 tslib: 2.8.1 - url-loader: 4.1.1(file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + url-loader: 4.1.1(file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) utility-types: 3.11.0 webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) transitivePeerDependencies: @@ -14142,7 +14142,7 @@ snapshots: - debug - supports-color - babel-loader@10.1.1(@babel/core@7.29.7)(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + babel-loader@10.1.1(@babel/core@7.29.7)(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: '@babel/core': 7.29.7 find-up: 5.0.0 @@ -14150,7 +14150,7 @@ snapshots: '@rspack/core': 1.7.11(@swc/helpers@0.5.23) webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) - babel-loader@9.2.1(@babel/core@7.29.7)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + babel-loader@9.2.1(@babel/core@7.29.7)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: '@babel/core': 7.29.7 find-cache-dir: 4.0.0 @@ -14663,7 +14663,7 @@ snapshots: copy-text-to-clipboard@3.2.2: {} - copy-webpack-plugin@11.0.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + copy-webpack-plugin@11.0.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: fast-glob: 3.3.3 glob-parent: 6.0.2 @@ -14775,7 +14775,7 @@ snapshots: postcss-selector-parser: 7.1.1 postcss-value-parser: 4.2.0 - css-loader@6.11.0(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + css-loader@6.11.0(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: icss-utils: 5.1.0(postcss@8.5.15) postcss: 8.5.15 @@ -14789,7 +14789,7 @@ snapshots: '@rspack/core': 1.7.11(@swc/helpers@0.5.23) webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) - css-minimizer-webpack-plugin@5.0.1(clean-css@5.3.3)(esbuild@0.28.0)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + css-minimizer-webpack-plugin@5.0.1(clean-css@5.3.3)(esbuild@0.28.0)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: '@jridgewell/trace-mapping': 0.3.31 cssnano: 6.1.2(postcss@8.5.15) @@ -15439,7 +15439,7 @@ snapshots: dependencies: xml-js: 1.6.11 - file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: loader-utils: 2.0.4 schema-utils: 3.3.0 @@ -16030,7 +16030,7 @@ snapshots: html-void-elements@3.0.0: {} - html-webpack-plugin@5.6.7(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + html-webpack-plugin@5.6.7(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: '@types/html-minifier-terser': 6.1.0 html-minifier-terser: 6.1.0 @@ -17206,7 +17206,7 @@ snapshots: mimic-response@4.0.0: {} - mini-css-extract-plugin@2.10.2(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + mini-css-extract-plugin@2.10.2(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: schema-utils: 4.3.3 tapable: 2.3.3 @@ -17287,7 +17287,7 @@ snapshots: dependencies: boolbase: 1.0.0 - null-loader@4.0.1(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + null-loader@4.0.1(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: loader-utils: 2.0.4 schema-utils: 3.3.0 @@ -17867,7 +17867,7 @@ snapshots: '@csstools/utilities': 3.0.0(postcss@8.5.15) postcss: 8.5.15 - postcss-loader@7.3.4(postcss@8.5.15)(typescript@6.0.3)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + postcss-loader@7.3.4(postcss@8.5.15)(typescript@6.0.3)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: cosmiconfig: 8.3.6(typescript@6.0.3) jiti: 1.21.7 @@ -18479,7 +18479,7 @@ snapshots: dependencies: react: 19.2.7 - react-loadable-ssr-addon-v5-slorber@1.0.3(@docusaurus/react-loadable@6.0.0(react@19.2.7))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + react-loadable-ssr-addon-v5-slorber@1.0.3(@docusaurus/react-loadable@6.0.0(react@19.2.7))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: '@babel/runtime': 7.29.7 react-loadable: '@docusaurus/react-loadable@6.0.0(react@19.2.7)' @@ -19394,7 +19394,7 @@ snapshots: picocolors: 1.1.1 sax: 1.6.0 - swc-loader@0.2.7(@swc/core@1.15.40(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + swc-loader@0.2.7(@swc/core@1.15.40(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: '@swc/core': 1.15.40(@swc/helpers@0.5.23) '@swc/counter': 0.1.3 @@ -19404,7 +19404,21 @@ snapshots: tapable@2.3.3: {} - terser-webpack-plugin@5.6.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + terser-webpack-plugin@5.6.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + dependencies: + '@jridgewell/trace-mapping': 0.3.31 + jest-worker: 27.5.1 + schema-utils: 4.3.3 + terser: 5.48.0 + webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) + optionalDependencies: + '@swc/core': 1.15.40(@swc/helpers@0.5.23) + '@swc/html': 1.15.40 + esbuild: 0.28.0 + lightningcss: 1.32.0 + postcss: 8.5.15 + + terser-webpack-plugin@5.6.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: '@jridgewell/trace-mapping': 0.3.31 jest-worker: 27.5.1 @@ -19657,14 +19671,14 @@ snapshots: dependencies: punycode: 2.3.1 - url-loader@4.1.1(file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + url-loader@4.1.1(file-loader@6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: loader-utils: 2.0.4 mime-types: 2.1.35 schema-utils: 3.3.0 webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) optionalDependencies: - file-loader: 6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + file-loader: 6.2.0(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) url@0.11.4: dependencies: @@ -19825,7 +19839,7 @@ snapshots: webpack-bundle-analyzer: 4.10.2 webpack-dev-server: 5.2.4(tslib@2.8.1)(webpack-cli@7.0.3)(webpack@5.107.2) - webpack-dev-middleware@7.4.5(tslib@2.8.1)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + webpack-dev-middleware@7.4.5(tslib@2.8.1)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: colorette: 2.0.20 memfs: 4.57.6(tslib@2.8.1) @@ -19852,7 +19866,7 @@ snapshots: - tslib optional: true - webpack-dev-server@5.2.4(tslib@2.8.1)(webpack-cli@7.0.3)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + webpack-dev-server@5.2.4(tslib@2.8.1)(webpack-cli@7.0.3)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: '@types/bonjour': 3.5.13 '@types/connect-history-api-fallback': 1.5.4 @@ -19880,7 +19894,7 @@ snapshots: serve-index: 1.9.2 sockjs: 0.3.24 spdy: 4.0.2 - webpack-dev-middleware: 7.4.5(tslib@2.8.1)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + webpack-dev-middleware: 7.4.5(tslib@2.8.1)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) ws: 8.21.0 optionalDependencies: webpack: 5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3) @@ -19947,6 +19961,47 @@ snapshots: webpack-sources@3.5.0: {} + webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3): + dependencies: + '@types/estree': 1.0.9 + '@types/json-schema': 7.0.15 + '@webassemblyjs/ast': 1.14.1 + '@webassemblyjs/wasm-edit': 1.14.1 + '@webassemblyjs/wasm-parser': 1.14.1 + acorn: 8.16.0 + acorn-import-phases: 1.0.4(acorn@8.16.0) + browserslist: 4.28.2 + chrome-trace-event: 1.0.4 + enhanced-resolve: 5.23.0 + es-module-lexer: 2.1.0 + eslint-scope: 5.1.1 + events: 3.3.0 + glob-to-regexp: 0.4.1 + graceful-fs: 4.2.11 + loader-runner: 4.3.2 + mime-db: 1.54.0 + neo-async: 2.6.2 + schema-utils: 4.3.3 + tapable: 2.3.3 + terser-webpack-plugin: 5.6.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + watchpack: 2.5.1 + webpack-sources: 3.5.0 + optionalDependencies: + webpack-cli: 7.0.3(webpack-bundle-analyzer@4.10.2)(webpack-dev-server@5.2.4)(webpack@5.107.2) + transitivePeerDependencies: + - '@minify-html/node' + - '@swc/core' + - '@swc/css' + - '@swc/html' + - clean-css + - cssnano + - csso + - esbuild + - html-minifier-terser + - lightningcss + - postcss + - uglify-js + webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack-cli@7.0.3): dependencies: '@types/estree': 1.0.9 @@ -19969,7 +20024,7 @@ snapshots: neo-async: 2.6.2 schema-utils: 4.3.3 tapable: 2.3.3 - terser-webpack-plugin: 5.6.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)) + terser-webpack-plugin: 5.6.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(clean-css@5.3.3)(cssnano@6.1.2(postcss@8.5.15))(esbuild@0.28.0)(html-minifier-terser@7.2.0)(postcss@8.5.15)(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)) watchpack: 2.5.1 webpack-sources: 3.5.0 optionalDependencies: @@ -20029,7 +20084,7 @@ snapshots: - postcss - uglify-js - webpackbar@7.0.0(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(@swc/html@1.15.40)(esbuild@0.28.0)(lightningcss@1.32.0)(postcss@8.5.15)(webpack-cli@7.0.3)): + webpackbar@7.0.0(@rspack/core@1.7.11(@swc/helpers@0.5.23))(webpack@5.107.2(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.0)(postcss@8.5.15)(webpack-cli@7.0.3)): dependencies: ansis: 3.17.0 consola: 3.4.2 diff --git a/website/package.json b/website/package.json index 73fb3ffd8..2e5d11084 100644 --- a/website/package.json +++ b/website/package.json @@ -27,7 +27,7 @@ }, "dependencies": { "@apify/docs-theme": "^1.0.251", - "@apify/docusaurus-plugin-typedoc-api": "^5.1.11", + "@apify/docusaurus-plugin-typedoc-api": "^5.1.13", "@docusaurus/core": "^3.8.1", "@docusaurus/faster": "^3.8.1", "@docusaurus/preset-classic": "^3.8.1", From 4cd78bd8dd09409f5da867ecdc299e04b52ab87f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jind=C5=99ich=20B=C3=A4r?= Date: Thu, 18 Jun 2026 14:09:16 +0200 Subject: [PATCH 4/5] chore: regenerate lockfile after merge --- pnpm-lock.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 43ac58bae..d198e7ef6 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -141,8 +141,8 @@ importers: specifier: ^1.0.251 version: 1.0.251(f5e0b63f7bb87829478b2ea424c206c6) '@apify/docusaurus-plugin-typedoc-api': - specifier: ^5.1.6 - version: 5.1.11(aa6c3cff772a8e8226e8c6611f9e1686) + specifier: ^5.1.13 + version: 5.1.13(aa6c3cff772a8e8226e8c6611f9e1686) '@docusaurus/core': specifier: ^3.8.1 version: 3.10.1(@docusaurus/faster@3.10.1(@docusaurus/types@3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.1)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3))(@swc/helpers@0.5.23)(esbuild@0.28.1)(postcss@8.5.15)(webpack-cli@7.0.3))(@mdx-js/react@3.1.1(@types/react@19.2.17)(react@19.2.7))(@rspack/core@1.7.11(@swc/helpers@0.5.23))(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.1)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(typescript@6.0.3)(webpack-cli@7.0.3) @@ -9418,7 +9418,7 @@ snapshots: - webpack - webpack-cli - '@apify/docusaurus-plugin-typedoc-api@5.1.11(aa6c3cff772a8e8226e8c6611f9e1686)': + '@apify/docusaurus-plugin-typedoc-api@5.1.13(aa6c3cff772a8e8226e8c6611f9e1686)': dependencies: '@docusaurus/core': 3.10.1(@docusaurus/faster@3.10.1(@docusaurus/types@3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.1)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3))(@swc/helpers@0.5.23)(esbuild@0.28.1)(postcss@8.5.15)(webpack-cli@7.0.3))(@mdx-js/react@3.1.1(@types/react@19.2.17)(react@19.2.7))(@rspack/core@1.7.11(@swc/helpers@0.5.23))(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.1)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(typescript@6.0.3)(webpack-cli@7.0.3) '@docusaurus/mdx-loader': 3.10.1(@swc/core@1.15.40(@swc/helpers@0.5.23))(esbuild@0.28.1)(postcss@8.5.15)(react-dom@19.2.7(react@19.2.7))(react@19.2.7)(webpack-cli@7.0.3) From 899121f0914121def5035c99e4d23011c0821982 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jind=C5=99ich=20B=C3=A4r?= Date: Fri, 19 Jun 2026 11:03:35 +0200 Subject: [PATCH 5/5] docs: drop `@since` tags for pre-2.0.1 symbols --- src/apify_api_error.ts | 12 -- src/apify_client.ts | 40 ---- src/base/api_client.ts | 24 --- src/interceptors.ts | 10 - src/resource_clients/actor.ts | 183 ++---------------- src/resource_clients/actor_collection.ts | 18 +- src/resource_clients/actor_version.ts | 31 --- .../actor_version_collection.ts | 7 - src/resource_clients/build.ts | 42 ---- src/resource_clients/build_collection.ts | 11 -- src/resource_clients/dataset.ts | 70 ------- src/resource_clients/dataset_collection.ts | 9 - src/resource_clients/key_value_store.ts | 61 ------ .../key_value_store_collection.ts | 9 - src/resource_clients/log.ts | 3 - src/resource_clients/request_queue.ts | 79 -------- .../request_queue_collection.ts | 9 - src/resource_clients/run.ts | 15 -- src/resource_clients/run_collection.ts | 5 - src/resource_clients/schedule.ts | 51 ----- src/resource_clients/schedule_collection.ts | 6 - src/resource_clients/task.ts | 49 ----- src/resource_clients/task_collection.ts | 9 - src/resource_clients/user.ts | 35 ---- src/resource_clients/webhook.ts | 62 ------ src/resource_clients/webhook_collection.ts | 8 - src/resource_clients/webhook_dispatch.ts | 35 ---- .../webhook_dispatch_collection.ts | 5 - src/utils.ts | 1 - 29 files changed, 23 insertions(+), 876 deletions(-) diff --git a/src/apify_api_error.ts b/src/apify_api_error.ts index eb240dd4b..13847ef59 100644 --- a/src/apify_api_error.ts +++ b/src/apify_api_error.ts @@ -20,61 +20,49 @@ const CLIENT_METHOD_REGEX = /at( async)? ([A-Za-z]+(Collection)?Client)\._?([A-Z * errors and internal errors, which are automatically retried, or validation * errors, which are thrown immediately, because a correction by the user is * needed. - * @since Added in 1.0.0 */ export class ApifyApiError extends Error { - /** - * @since Added in 2.0.1 - */ override name: string; /** * The invoked resource client and the method. Known issue: Sometimes it displays * as `unknown` because it can't be parsed from a stack trace. - * @since Added in 2.0.1 */ clientMethod: string; /** * HTTP status code of the error. - * @since Added in 2.0.1 */ statusCode: number; /** * The type of the error, as returned by the API. - * @since Added in 2.0.1 */ type?: string; /** * Number of the API call attempt. - * @since Added in 2.0.1 */ attempt: number; /** * HTTP method of the API call. - * @since Added in 2.0.1 */ httpMethod?: string; /** * Full path of the API endpoint (URL excluding origin). - * @since Added in 2.0.1 */ path?: string; /** * Original stack trace of the exception. It is replaced * by a more informative stack with API call information. - * @since Added in 2.0.1 */ originalStack: string; /** * Additional data provided by the API about the error - * @since Added in 2.0.1 */ data?: Record; diff --git a/src/apify_client.ts b/src/apify_client.ts index a8e8ccda9..5be0aa6a5 100644 --- a/src/apify_client.ts +++ b/src/apify_client.ts @@ -55,12 +55,8 @@ const DEFAULT_TIMEOUT_SECS = 360; * ``` * * @see https://docs.apify.com/api/v2 - * @since Added in 0.0.3 */ export class ApifyClient { - /** - * @since Added in 2.0.1 - */ baseUrl: string; /** @@ -68,24 +64,12 @@ export class ApifyClient { */ publicBaseUrl: string; - /** - * @since Added in 2.0.1 - */ token?: string; - /** - * @since Added in 2.0.1 - */ stats: Statistics; - /** - * @since Added in 2.0.1 - */ logger: Log; - /** - * @since Added in 2.0.1 - */ httpClient: HttpClient; constructor(options: ApifyClientOptions = {}) { @@ -150,7 +134,6 @@ export class ApifyClient { * * @returns A client for the Actors collection * @see https://docs.apify.com/api/v2/acts-get - * @since Added in 2.0.1 */ actors(): ActorCollectionClient { return new ActorCollectionClient(this._options()); @@ -171,7 +154,6 @@ export class ApifyClient { * // Call an Actor and wait for it to finish * const run = await client.actor('apify/web-scraper').call({ url: 'https://example.com' }); * ``` - * @since Added in 2.0.1 */ actor(id: string): ActorClient { ow(id, ow.string.nonEmpty); @@ -189,7 +171,6 @@ export class ApifyClient { * * @returns A client for Actor builds collection * @see https://docs.apify.com/api/v2/actor-builds-get - * @since Added in 2.0.1 */ builds(): BuildCollectionClient { return new BuildCollectionClient(this._options()); @@ -203,7 +184,6 @@ export class ApifyClient { * @param id - Build ID * @returns A client for the specified build * @see https://docs.apify.com/api/v2/actor-build-get - * @since Added in 2.0.1 */ build(id: string): BuildClient { ow(id, ow.string.nonEmpty); @@ -221,7 +201,6 @@ export class ApifyClient { * * @returns A client for the Datasets collection * @see https://docs.apify.com/api/v2/datasets-get - * @since Added in 2.0.1 */ datasets(): DatasetCollectionClient { return new DatasetCollectionClient(this._options()); @@ -249,7 +228,6 @@ export class ApifyClient { * // Retrieve items * const { items } = await client.dataset('my-dataset').listItems(); * ``` - * @since Added in 2.0.1 */ dataset = Record>( id: string, @@ -269,7 +247,6 @@ export class ApifyClient { * * @returns A client for the Key-value stores collection * @see https://docs.apify.com/api/v2/key-value-stores-get - * @since Added in 2.0.1 */ keyValueStores(): KeyValueStoreCollectionClient { return new KeyValueStoreCollectionClient(this._options()); @@ -293,7 +270,6 @@ export class ApifyClient { * // Get a record * const record = await client.keyValueStore('my-store').getRecord('OUTPUT'); * ``` - * @since Added in 2.0.1 */ keyValueStore(id: string): KeyValueStoreClient { ow(id, ow.string.nonEmpty); @@ -310,7 +286,6 @@ export class ApifyClient { * @param buildOrRunId - Build ID or run ID * @returns A client for accessing logs * @see https://docs.apify.com/api/v2/log-get - * @since Added in 2.0.1 */ log(buildOrRunId: string): LogClient { ow(buildOrRunId, ow.string.nonEmpty); @@ -328,7 +303,6 @@ export class ApifyClient { * * @returns A client for the Request queues collection * @see https://docs.apify.com/api/v2/request-queues-get - * @since Added in 2.0.1 */ requestQueues(): RequestQueueCollectionClient { return new RequestQueueCollectionClient(this._options()); @@ -354,7 +328,6 @@ export class ApifyClient { * // Get and lock the next request * const { items } = await queue.listAndLockHead({ lockSecs: 60 }); * ``` - * @since Added in 2.0.1 */ requestQueue(id: string, options: RequestQueueUserOptions = {}): RequestQueueClient { ow(id, ow.string.nonEmpty); @@ -380,7 +353,6 @@ export class ApifyClient { * * @returns A client for the run collection * @see https://docs.apify.com/api/v2/actor-runs-get - * @since Added in 2.0.1 */ runs(): RunCollectionClient { return new RunCollectionClient({ @@ -407,7 +379,6 @@ export class ApifyClient { * // Access run's dataset * const { items } = await client.run('run-id').dataset().listItems(); * ``` - * @since Added in 2.0.1 */ run(id: string): RunClient { ow(id, ow.string.nonEmpty); @@ -425,7 +396,6 @@ export class ApifyClient { * * @returns A client for the task collection * @see https://docs.apify.com/api/v2/actor-tasks-get - * @since Added in 2.0.1 */ tasks(): TaskCollectionClient { return new TaskCollectionClient(this._options()); @@ -445,7 +415,6 @@ export class ApifyClient { * // Run a task and wait for it to finish * const run = await client.task('my-task').call(); * ``` - * @since Added in 2.0.1 */ task(id: string): TaskClient { ow(id, ow.string.nonEmpty); @@ -463,7 +432,6 @@ export class ApifyClient { * * @returns A client for the Schedules collection * @see https://docs.apify.com/api/v2/schedules-get - * @since Added in 2.0.1 */ schedules(): ScheduleCollectionClient { return new ScheduleCollectionClient(this._options()); @@ -477,7 +445,6 @@ export class ApifyClient { * @param id - Schedule ID * @returns A client for the specific Schedule * @see https://docs.apify.com/api/v2/schedule-get - * @since Added in 2.0.1 */ schedule(id: string): ScheduleClient { ow(id, ow.string.nonEmpty); @@ -496,7 +463,6 @@ export class ApifyClient { * @param id - User ID or username. Defaults to 'me' (current user) * @returns A client for the user * @see https://docs.apify.com/api/v2/user-get - * @since Added in 2.0.1 */ user(id = ME_USER_NAME_PLACEHOLDER): UserClient { ow(id, ow.string.nonEmpty); @@ -514,7 +480,6 @@ export class ApifyClient { * * @returns A client for the Webhooks collection * @see https://docs.apify.com/api/v2/webhooks-get - * @since Added in 2.0.1 */ webhooks(): WebhookCollectionClient { return new WebhookCollectionClient(this._options()); @@ -528,7 +493,6 @@ export class ApifyClient { * @param id - Webhook ID * @returns A client for the specific webhook * @see https://docs.apify.com/api/v2/webhook-get - * @since Added in 2.0.1 */ webhook(id: string): WebhookClient { ow(id, ow.string.nonEmpty); @@ -546,7 +510,6 @@ export class ApifyClient { * * @returns A client for the webhook dispatches collection * @see https://docs.apify.com/api/v2/webhook-dispatches-get - * @since Added in 2.0.1 */ webhookDispatches(): WebhookDispatchCollectionClient { return new WebhookDispatchCollectionClient(this._options()); @@ -558,7 +521,6 @@ export class ApifyClient { * @param id - Webhook dispatch ID * @returns A client for the specific webhook dispatch * @see https://docs.apify.com/api/v2/webhook-dispatch-get - * @since Added in 2.0.1 */ webhookDispatch(id: string): WebhookDispatchClient { ow(id, ow.string.nonEmpty); @@ -576,7 +538,6 @@ export class ApifyClient { * * @returns A client for the Apify Store * @see https://docs.apify.com/api/v2/store-get - * @since Added in 2.0.1 */ store(): StoreCollectionClient { return new StoreCollectionClient(this._options()); @@ -607,7 +568,6 @@ export class ApifyClient { /** * Configuration options for ApifyClient. - * @since Added in 2.0.1 */ export interface ApifyClientOptions { /** @default https://api.apify.com */ diff --git a/src/base/api_client.ts b/src/base/api_client.ts index dd6079849..1013f361c 100644 --- a/src/base/api_client.ts +++ b/src/base/api_client.ts @@ -21,19 +21,10 @@ export type ApiClientSubResourceOptions = Omit /** @private */ export abstract class ApiClient { - /** - * @since Added in 2.0.1 - */ id?: string; - /** - * @since Added in 2.0.1 - */ safeId?: string; - /** - * @since Added in 2.0.1 - */ baseUrl: string; /** @@ -41,29 +32,14 @@ export abstract class ApiClient { */ publicBaseUrl: string; - /** - * @since Added in 2.0.1 - */ resourcePath: string; - /** - * @since Added in 2.0.1 - */ url: string; - /** - * @since Added in 2.0.1 - */ apifyClient: ApifyClient; - /** - * @since Added in 2.0.1 - */ httpClient: HttpClient; - /** - * @since Added in 2.0.1 - */ params?: Record; constructor(options: ApiClientOptions) { diff --git a/src/interceptors.ts b/src/interceptors.ts index 6c267d722..4229ff3e0 100644 --- a/src/interceptors.ts +++ b/src/interceptors.ts @@ -13,22 +13,12 @@ import { isNode, maybeGzipValue } from './utils'; * request. We do that by identifying this error in HttpClient. * * The properties mimic AxiosError for easier integration in HttpClient error handling. - * @since Added in 1.0.0 */ export class InvalidResponseBodyError extends Error { - /** - * @since Added in 2.0.1 - */ code: string; - /** - * @since Added in 2.0.1 - */ response: AxiosResponse; - /** - * @since Added in 2.0.1 - */ declare cause: Error; constructor(response: AxiosResponse, cause: Error) { diff --git a/src/resource_clients/actor.ts b/src/resource_clients/actor.ts index 266e22c1b..1f3c57512 100644 --- a/src/resource_clients/actor.ts +++ b/src/resource_clients/actor.ts @@ -38,7 +38,6 @@ import { WebhookCollectionClient } from './webhook_collection'; * ``` * * @see https://docs.apify.com/platform/actors - * @since Added in 1.0.0 */ export class ActorClient extends ResourceClient { /** @@ -56,7 +55,6 @@ export class ActorClient extends ResourceClient { * * @returns The Actor object, or `undefined` if it does not exist * @see https://docs.apify.com/api/v2/act-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -68,7 +66,6 @@ export class ActorClient extends ResourceClient { * @param newFields - Fields to update in the Actor * @returns The updated Actor object * @see https://docs.apify.com/api/v2/act-put - * @since Added in 2.0.1 */ async update(newFields: ActorUpdateOptions): Promise { ow(newFields, ow.object); @@ -80,7 +77,6 @@ export class ActorClient extends ResourceClient { * Deletes the Actor. * * @see https://docs.apify.com/api/v2/act-delete - * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -119,7 +115,6 @@ export class ActorClient extends ResourceClient { * { build: '0.1.2', memory: 512, timeout: 300 } * ); * ``` - * @since Added in 2.0.1 */ async start(input?: unknown, options: ActorStartOptions = {}): Promise { // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf @@ -221,7 +216,6 @@ export class ActorClient extends ResourceClient { * const log = new Log({ prefix: 'My Actor' }); * const run = await client.actor('my-actor').call({ url: 'https://example.com' }, { log }); * ``` - * @since Added in 2.0.1 */ async call(input?: unknown, options: ActorCallOptions = {}): Promise { // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf @@ -289,7 +283,6 @@ export class ActorClient extends ResourceClient { * useCache: true * }); * ``` - * @since Added in 2.0.1 */ async build(versionNumber: string, options: ActorBuildOptions = {}): Promise { ow(versionNumber, ow.string); @@ -374,7 +367,6 @@ export class ActorClient extends ResourceClient { * // Get the last successful run * const lastRun = await client.actor('my-actor').lastRun({ status: 'SUCCEEDED' }).get(); * ``` - * @since Added in 2.0.1 */ lastRun(options: ActorLastRunOptions = {}): RunClient { ow( @@ -399,7 +391,6 @@ export class ActorClient extends ResourceClient { * * @returns A client for the Actor's build collection * @see https://docs.apify.com/api/v2/act-builds-get - * @since Added in 2.0.1 */ builds(): BuildCollectionClient { return new BuildCollectionClient( @@ -414,7 +405,6 @@ export class ActorClient extends ResourceClient { * * @returns A client for the Actor's run collection * @see https://docs.apify.com/api/v2/act-runs-get - * @since Added in 2.0.1 */ runs(): RunCollectionClient { return new RunCollectionClient( @@ -430,7 +420,6 @@ export class ActorClient extends ResourceClient { * @param versionNumber - Version number (e.g., '0.1', '1.2.3') * @returns A client for the specified Actor version * @see https://docs.apify.com/api/v2/act-version-get - * @since Added in 2.0.1 */ version(versionNumber: string): ActorVersionClient { ow(versionNumber, ow.string); @@ -446,7 +435,6 @@ export class ActorClient extends ResourceClient { * * @returns A client for the Actor's version collection * @see https://docs.apify.com/api/v2/act-versions-get - * @since Added in 2.0.1 */ versions(): ActorVersionCollectionClient { return new ActorVersionCollectionClient(this._subResourceOptions()); @@ -457,7 +445,6 @@ export class ActorClient extends ResourceClient { * * @returns A client for the Actor's webhook collection * @see https://docs.apify.com/api/v2/act-webhooks-get - * @since Added in 2.0.1 */ webhooks(): WebhookCollectionClient { return new WebhookCollectionClient(this._subResourceOptions()); @@ -470,103 +457,48 @@ export class ActorClient extends ResourceClient { * Actors are serverless computing units that can perform arbitrary tasks such as web scraping, * data processing, automation, and more. Each Actor has versions, builds, and can be executed * with different configurations. - * @since Added in 0.5.0 */ export interface Actor { - /** - * Unique Actor ID - * @since Added in 2.0.1 - */ + /** Unique Actor ID */ id: string; - /** - * ID of the user who owns the Actor - * @since Added in 2.0.1 - */ + /** ID of the user who owns the Actor */ userId: string; - /** - * Unique name of the Actor (used in API paths, e.g., 'my-actor') - * @since Added in 2.0.1 - */ + /** Unique name of the Actor (used in API paths, e.g., 'my-actor') */ name: string; - /** - * Username of the Actor's owner - * @since Added in 2.0.1 - */ + /** Username of the Actor's owner */ username: string; - /** - * Detailed description of what the Actor does - * @since Added in 2.0.1 - */ + /** Detailed description of what the Actor does */ description?: string; - /** - * @deprecated Use defaultRunOptions.restartOnError instead - * @since Added in 2.0.1 - */ + /** @deprecated Use defaultRunOptions.restartOnError instead */ restartOnError?: boolean; - /** - * Whether the Actor is publicly available in Apify Store - * @since Added in 2.0.1 - */ + /** Whether the Actor is publicly available in Apify Store */ isPublic: boolean; - /** - * Whether the Actor can be run by anonymous users without authentication - * @since Added in 2.0.1 - */ + /** Whether the Actor can be run by anonymous users without authentication */ isAnonymouslyRunnable?: boolean; - /** - * Timestamp when the Actor was created - * @since Added in 2.0.1 - */ + /** Timestamp when the Actor was created */ createdAt: Date; - /** - * Timestamp when the Actor was last modified - * @since Added in 2.0.1 - */ + /** Timestamp when the Actor was last modified */ modifiedAt: Date; - /** - * Usage and run statistics for the Actor - * @since Added in 2.0.1 - */ + /** Usage and run statistics for the Actor */ stats: ActorStats; - /** - * All versions of this Actor - * @since Added in 2.0.1 - */ + /** All versions of this Actor */ versions: ActorVersion[]; /** * Pricing information for pay-per-result or pay-per-event Actors * @since Added in 2.12.4 */ pricingInfos?: ActorRunPricingInfo[]; - /** - * Default configuration options for Actor runs - * @since Added in 2.0.1 - */ + /** Default configuration options for Actor runs */ defaultRunOptions: ActorDefaultRunOptions; - /** - * Example input to help users understand how to use the Actor - * @since Added in 2.0.1 - */ + /** Example input to help users understand how to use the Actor */ exampleRunInput?: ActorExampleRunInput; - /** - * Whether the Actor is deprecated and should not be used - * @since Added in 2.0.1 - */ + /** Whether the Actor is deprecated and should not be used */ isDeprecated?: boolean; - /** - * Deployment key used for automated deployments - * @since Added in 2.0.1 - */ + /** Deployment key used for automated deployments */ deploymentKey: string; - /** - * Human-readable title of the Actor (displayed in UI) - * @since Added in 2.0.1 - */ + /** Human-readable title of the Actor (displayed in UI) */ title?: string; - /** - * Mapping of tags to specific builds (e.g., 'latest', 'beta') - * @since Added in 2.0.1 - */ + /** Mapping of tags to specific builds (e.g., 'latest', 'beta') */ taggedBuilds?: ActorTaggedBuilds; /** * SEO-optimized title for the Actor's public page @@ -604,7 +536,6 @@ export interface Actor { /** * Statistics about Actor usage and activity. - * @since Added in 2.0.1 */ export interface ActorStats { /** Total number of builds created for this Actor */ @@ -627,7 +558,6 @@ export interface ActorStats { /** * Default configuration options for Actor runs. - * @since Added in 2.0.1 */ export interface ActorDefaultRunOptions { build: string; @@ -641,7 +571,6 @@ export interface ActorDefaultRunOptions { /** * Example input data to demonstrate Actor usage. - * @since Added in 2.0.1 */ export interface ActorExampleRunInput { body: string; @@ -650,13 +579,11 @@ export interface ActorExampleRunInput { /** * Mapping of build tags (e.g., 'latest', 'beta') to their corresponding build information. - * @since Added in 2.0.1 */ export type ActorTaggedBuilds = Record; /** * Information about a specific tagged build. - * @since Added in 2.0.1 */ export interface ActorTaggedBuild { buildId?: string; @@ -666,7 +593,6 @@ export interface ActorTaggedBuild { /** * Fields that can be updated when modifying an Actor. - * @since Added in 2.0.1 */ export type ActorUpdateOptions = Partial< Pick< @@ -711,14 +637,10 @@ export interface ActorStandby { shouldPassActorInput?: boolean; } -/** - * @since Added in 2.0.1 - */ export interface ActorStartOptions { /** * Tag or number of the Actor build to run (e.g. `beta` or `1.2.345`). * If not provided, the run uses build tag or number from the default Actor run configuration (typically `latest`). - * @since Added in 2.0.1 */ build?: string; @@ -727,20 +649,17 @@ export interface ActorStartOptions { * `input` is expected to be an object that will be stringified to JSON and content type set to * `application/json; charset=utf-8`. If `options.contentType` is specified, then `input` must be a * `String` or `Buffer`. - * @since Added in 2.0.1 */ contentType?: string; /** * Memory in megabytes which will be allocated for the new Actor run. * If not provided, the run uses memory of the default Actor run configuration. - * @since Added in 2.0.1 */ memory?: number; /** * Timeout for the Actor run in seconds. Zero value means there is no timeout. * If not provided, the run uses timeout of the default Actor run configuration. - * @since Added in 2.0.1 */ timeout?: number; @@ -758,7 +677,6 @@ export interface ActorStartOptions { * Specifies optional webhooks associated with the Actor run, which can be used * to receive a notification e.g. when the Actor finished or failed, see * [ad hook webhooks documentation](https://docs.apify.com/webhooks/ad-hoc-webhooks) for detailed description. - * @since Added in 2.0.1 */ webhooks?: readonly WebhookUpdateData[]; @@ -783,7 +701,6 @@ export interface ActorStartOptions { /** * Determines whether the run will be restarted if it fails. - * @since Added in 2.0.1 */ restartOnError?: boolean; @@ -824,49 +741,16 @@ export interface ActorCallOptions extends Omit { ow( @@ -85,7 +83,6 @@ export class ActorCollectionClient extends ResourceCollectionClient { * @param actor - The Actor data. * @returns The created Actor object. * @see https://docs.apify.com/api/v2/acts-post - * @since Added in 2.0.1 */ async create(actor: ActorCollectionCreateOptions): Promise { ow(actor, ow.optional.object); @@ -102,9 +99,6 @@ export enum ActorListSortBy { LAST_RUN_STARTED_AT = 'stats.lastRunStartedAt', } -/** - * @since Added in 2.0.1 - */ export interface ActorCollectionListOptions extends PaginationOptions { my?: boolean; desc?: boolean; @@ -114,9 +108,6 @@ export interface ActorCollectionListOptions extends PaginationOptions { sortBy?: ActorListSortBy; } -/** - * @since Added in 2.0.1 - */ export interface ActorCollectionListItem { id: string; createdAt: Date; @@ -125,14 +116,8 @@ export interface ActorCollectionListItem { username: string; } -/** - * @since Added in 2.0.1 - */ export type ActorCollectionListResult = PaginatedList; -/** - * @since Added in 2.0.1 - */ export interface ActorCollectionCreateOptions { /** * @since Added in 2.8.6 @@ -171,5 +156,8 @@ export interface ActorCollectionCreateOptions { actorStandby?: ActorStandby & { isEnabled: boolean; }; + /** + * @since Added in next + */ actorPermissionLevel?: ACTOR_PERMISSION_LEVEL; } diff --git a/src/resource_clients/actor_version.ts b/src/resource_clients/actor_version.ts index d091c17b0..944cc3a5c 100644 --- a/src/resource_clients/actor_version.ts +++ b/src/resource_clients/actor_version.ts @@ -25,7 +25,6 @@ import { ActorEnvVarCollectionClient } from './actor_env_var_collection'; * ``` * * @see https://docs.apify.com/api/v2/act-versions-get - * @since Added in 1.0.0 */ export class ActorVersionClient extends ResourceClient { /** @@ -43,7 +42,6 @@ export class ActorVersionClient extends ResourceClient { * * @returns The Actor version object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/act-version-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -55,7 +53,6 @@ export class ActorVersionClient extends ResourceClient { * @param newFields - Fields to update. * @returns The updated Actor version object. * @see https://docs.apify.com/api/v2/act-version-put - * @since Added in 2.0.1 */ async update(newFields: ActorVersion): Promise { ow(newFields, ow.object); @@ -67,7 +64,6 @@ export class ActorVersionClient extends ResourceClient { * Deletes the Actor version. * * @see https://docs.apify.com/api/v2/act-version-delete - * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -102,9 +98,6 @@ export class ActorVersionClient extends ResourceClient { } } -/** - * @since Added in 2.0.1 - */ export interface BaseActorVersion { versionNumber?: string; sourceType: SourceType; @@ -120,39 +113,24 @@ export interface ActorVersionSourceFiles extends BaseActorVersion { gitRepoUrl: string; } -/** - * @since Added in 2.0.1 - */ export interface ActorVersionTarball extends BaseActorVersion { tarballUrl: string; } -/** - * @since Added in 2.0.1 - */ export interface ActorVersionGitHubGist extends BaseActorVersion { gitHubGistUrl: string; } -/** - * @since Added in 2.0.1 - */ export enum ActorSourceType { SourceFiles = 'SOURCE_FILES', GitRepo = 'GIT_REPO', @@ -160,21 +138,12 @@ export enum ActorSourceType { GitHubGist = 'GITHUB_GIST', } -/** - * @since Added in 2.0.1 - */ export interface ActorEnvironmentVariable { name?: string; value?: string; isSecret?: boolean; } -/** - * @since Added in 0.10.0 - */ export type ActorVersion = ActorVersionSourceFiles | ActorVersionGitRepo | ActorVersionTarball | ActorVersionGitHubGist; -/** - * @since Added in 2.0.1 - */ export type FinalActorVersion = ActorVersion & Required>; diff --git a/src/resource_clients/actor_version_collection.ts b/src/resource_clients/actor_version_collection.ts index 04695a007..af929a2f7 100644 --- a/src/resource_clients/actor_version_collection.ts +++ b/src/resource_clients/actor_version_collection.ts @@ -28,7 +28,6 @@ import type { ActorVersion, FinalActorVersion } from './actor_version'; * ``` * * @see https://docs.apify.com/api/v2/act-versions-get - * @since Added in 1.0.0 */ export class ActorVersionCollectionClient extends ResourceCollectionClient { /** @@ -59,7 +58,6 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { * * @returns A paginated iterator of Actor versions. * @see https://docs.apify.com/api/v2/act-versions-get - * @since Added in 2.0.1 */ list( _options: ActorVersionCollectionListOptions = {}, @@ -73,7 +71,6 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { * @param actorVersion - The Actor version data. * @returns The created Actor version object. * @see https://docs.apify.com/api/v2/act-versions-post - * @since Added in 2.0.1 */ async create(actorVersion: ActorVersion): Promise { ow(actorVersion, ow.optional.object); @@ -85,13 +82,9 @@ export class ActorVersionCollectionClient extends ResourceCollectionClient { /** * @deprecated No options are used in the current API implementation. * https://github.com/apify/apify-client-js/issues/799 - * @since Added in 2.0.1 */ export interface ActorVersionCollectionListOptions extends PaginationOptions { desc?: boolean; } -/** - * @since Added in 2.0.1 - */ export type ActorVersionListResult = Pick, 'total' | 'items'>; diff --git a/src/resource_clients/build.ts b/src/resource_clients/build.ts index a32228ac8..f6dddb31d 100644 --- a/src/resource_clients/build.ts +++ b/src/resource_clients/build.ts @@ -30,7 +30,6 @@ import { LogClient } from './log'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds#builds - * @since Added in 1.0.0 */ export class BuildClient extends ResourceClient { /** @@ -60,7 +59,6 @@ export class BuildClient extends ResourceClient { * // Wait up to 60 seconds for build to finish * const build = await client.build('build-id').get({ waitForFinish: 60 }); * ``` - * @since Added in 2.0.1 */ async get(options: BuildClientGetOptions = {}): Promise { ow( @@ -85,7 +83,6 @@ export class BuildClient extends ResourceClient { * ```javascript * await client.build('build-id').abort(); * ``` - * @since Added in 2.0.1 */ async abort(): Promise { const response = await this.httpClient.call({ @@ -153,7 +150,6 @@ export class BuildClient extends ResourceClient { * const run = await client.actor('my-actor').start(); * } * ``` - * @since Added in 2.0.1 */ async waitForFinish(options: BuildClientWaitForFinishOptions = {}): Promise { ow( @@ -191,7 +187,6 @@ export class BuildClient extends ResourceClient { /** * Options for getting a Build. - * @since Added in 2.0.1 */ export interface BuildClientGetOptions { waitForFinish?: number; @@ -199,7 +194,6 @@ export interface BuildClientGetOptions { /** * Options for waiting for a Build to finish. - * @since Added in 2.0.1 */ export interface BuildClientWaitForFinishOptions { /** @@ -212,7 +206,6 @@ export interface BuildClientWaitForFinishOptions { /** * Metadata about how a Build was initiated. - * @since Added in 2.0.1 */ export interface BuildMeta { origin: string; @@ -225,58 +218,25 @@ export interface BuildMeta { * * Builds compile Actor source code and prepare it for execution. Each build has a unique ID * and can be tagged (e.g., 'latest', 'beta') for easy reference. - * @since Added in 1.0.0 */ export interface Build { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ actId: string; - /** - * @since Added in 2.0.1 - */ userId: string; - /** - * @since Added in 2.0.1 - */ startedAt: Date; - /** - * @since Added in 2.0.1 - */ finishedAt?: Date; - /** - * @since Added in 2.0.1 - */ status: (typeof ACT_JOB_TERMINAL_STATUSES)[number]; - /** - * @since Added in 2.0.1 - */ meta: BuildMeta; - /** - * @since Added in 2.0.1 - */ stats?: BuildStats; - /** - * @since Added in 2.0.1 - */ options?: BuildOptions; /** * @deprecated This property is deprecated in favor of `actorDefinition.input`. - * @since Added in 2.0.1 */ inputSchema?: string; /** * @deprecated This property is deprecated in favor of `actorDefinition.readme`. - * @since Added in 2.0.1 */ readme?: string; - /** - * @since Added in 2.0.1 - */ buildNumber: string; /** * @since Added in 2.7.2 @@ -306,7 +266,6 @@ export interface BuildUsage { /** * Runtime statistics for an Actor build. - * @since Added in 2.0.1 */ export interface BuildStats { durationMillis: number; @@ -316,7 +275,6 @@ export interface BuildStats { /** * Configuration options used for an Actor build. - * @since Added in 2.0.1 */ export interface BuildOptions { useCache?: boolean; diff --git a/src/resource_clients/build_collection.ts b/src/resource_clients/build_collection.ts index 540899efc..36c4a1a2e 100644 --- a/src/resource_clients/build_collection.ts +++ b/src/resource_clients/build_collection.ts @@ -25,7 +25,6 @@ import type { Build } from './build'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds#builds - * @since Added in 1.0.0 */ export class BuildCollectionClient extends ResourceCollectionClient { /** @@ -57,7 +56,6 @@ export class BuildCollectionClient extends ResourceCollectionClient { * @param options - Pagination and sorting options. * @returns A paginated iterator of Actor builds. * @see https://docs.apify.com/api/v2/actor-builds-get - * @since Added in 2.0.1 */ list(options: BuildCollectionClientListOptions = {}): PaginatedIterator { ow( @@ -73,20 +71,11 @@ export class BuildCollectionClient extends ResourceCollectionClient { } } -/** - * @since Added in 2.0.1 - */ export interface BuildCollectionClientListOptions extends PaginationOptions { desc?: boolean; } -/** - * @since Added in 2.0.1 - */ export type BuildCollectionClientListItem = Required> & Partial>; -/** - * @since Added in 2.0.1 - */ export type BuildCollectionClientListResult = PaginatedList; diff --git a/src/resource_clients/dataset.ts b/src/resource_clients/dataset.ts index 56b1ab0cc..7063af4c2 100644 --- a/src/resource_clients/dataset.ts +++ b/src/resource_clients/dataset.ts @@ -43,7 +43,6 @@ import { applyQueryParamsToUrl, cast, catchNotFoundOrThrow, pluckData } from '.. * ``` * * @see https://docs.apify.com/platform/storage/dataset - * @since Added in 1.0.0 */ export class DatasetClient< Data extends Record = Record, @@ -63,7 +62,6 @@ export class DatasetClient< * * @returns The Dataset object, or `undefined` if it does not exist * @see https://docs.apify.com/api/v2/dataset-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get({}, SMALL_TIMEOUT_MILLIS); @@ -75,7 +73,6 @@ export class DatasetClient< * @param newFields - Fields to update in the dataset * @returns The updated Dataset object * @see https://docs.apify.com/api/v2/dataset-put - * @since Added in 2.0.1 */ async update(newFields: DatasetClientUpdateOptions): Promise { ow(newFields, ow.object); @@ -87,7 +84,6 @@ export class DatasetClient< * Deletes the dataset. * * @see https://docs.apify.com/api/v2/dataset-delete - * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(SMALL_TIMEOUT_MILLIS); @@ -136,7 +132,6 @@ export class DatasetClient< * limit: 50 * }); * ``` - * @since Added in 2.0.1 */ listItems(options: DatasetClientListItemOptions = {}): PaginatedIterator { ow( @@ -213,7 +208,6 @@ export class DatasetClient< * xmlRow: 'product' * }); * ``` - * @since Added in 2.0.1 */ async downloadItems(format: DownloadItemsFormat, options: DatasetClientDownloadItemsOptions = {}): Promise { ow(format, ow.string.oneOf(validItemFormats)); @@ -286,7 +280,6 @@ export class DatasetClient< * // Store string items * await client.dataset('my-dataset').pushItems(['item1', 'item2', 'item3']); * ``` - * @since Added in 2.0.1 */ async pushItems(items: Data | Data[] | string | string[]): Promise { ow(items, ow.any(ow.object, ow.string, ow.array.ofType(ow.any(ow.object, ow.string)))); @@ -419,64 +412,27 @@ export class DatasetClient< * * Datasets store structured data as a sequence of items (records). Each item is a JSON object. * Datasets are useful for storing results from web scraping, crawling, or data processing tasks. - * @since Added in 0.1.61 */ export interface Dataset { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ name?: string; /** * @since Added in 2.6.1 */ title?: string; - /** - * @since Added in 2.0.1 - */ userId: string; /** * @since Added in 2.21.0 */ username?: string; - /** - * @since Added in 2.0.1 - */ createdAt: Date; - /** - * @since Added in 2.0.1 - */ modifiedAt: Date; - /** - * @since Added in 2.0.1 - */ accessedAt: Date; - /** - * @since Added in 2.0.1 - */ itemCount: number; - /** - * @since Added in 2.0.1 - */ cleanItemCount: number; - /** - * @since Added in 2.0.1 - */ actId?: string; - /** - * @since Added in 2.0.1 - */ actRunId?: string; - /** - * @since Added in 2.0.1 - */ stats: DatasetStats; - /** - * @since Added in 2.0.1 - */ fields: string[]; /** * @since Added in 2.12.2 @@ -494,7 +450,6 @@ export interface Dataset { /** * Statistics about dataset usage and storage. - * @since Added in 2.0.1 */ export interface DatasetStats { readCount?: number; @@ -505,7 +460,6 @@ export interface DatasetStats { /** * Options for updating a dataset. - * @since Added in 2.0.1 */ export interface DatasetClientUpdateOptions { name?: string | null; @@ -524,40 +478,18 @@ export interface DatasetClientUpdateOptions { * * Provides various filtering, pagination, and transformation options to customize * the output format and content of retrieved items. - * @since Added in 2.0.1 */ export interface DatasetClientListItemOptions extends PaginationOptions { - /** - * @since Added in 2.0.1 - */ clean?: boolean; - /** - * @since Added in 2.0.1 - */ desc?: boolean; /** * @since Added in 2.6.1 */ flatten?: string[]; - /** - * @since Added in 2.0.1 - */ fields?: string[]; - /** - * @since Added in 2.0.1 - */ omit?: string[]; - /** - * @since Added in 2.0.1 - */ skipEmpty?: boolean; - /** - * @since Added in 2.0.1 - */ skipHidden?: boolean; - /** - * @since Added in 2.0.1 - */ unwind?: string | string[]; // TODO: when doing a breaking change release, change to string[] only /** * @since Added in 2.2.0 @@ -581,7 +513,6 @@ export interface DatasetClientCreateItemsUrlOptions extends DatasetClientListIte /** * Supported formats for downloading dataset items. - * @since Added in 2.0.1 */ export enum DownloadItemsFormat { JSON = 'json', @@ -599,7 +530,6 @@ const validItemFormats = [...new Set(Object.values(DownloadItemsFormat).map((ite * Options for downloading dataset items in a specific format. * * Extends {@link DatasetClientListItemOptions} with format-specific options. - * @since Added in 2.0.1 */ export interface DatasetClientDownloadItemsOptions extends DatasetClientListItemOptions { attachment?: boolean; diff --git a/src/resource_clients/dataset_collection.ts b/src/resource_clients/dataset_collection.ts index 0cc1d7c52..b8046fa90 100644 --- a/src/resource_clients/dataset_collection.ts +++ b/src/resource_clients/dataset_collection.ts @@ -26,7 +26,6 @@ import type { Dataset } from './dataset'; * ``` * * @see https://docs.apify.com/platform/storage/dataset - * @since Added in 1.0.0 */ export class DatasetCollectionClient extends ResourceCollectionClient { /** @@ -58,7 +57,6 @@ export class DatasetCollectionClient extends ResourceCollectionClient { * @param options - Pagination options. * @returns A paginated iterator of Datasets. * @see https://docs.apify.com/api/v2/datasets-get - * @since Added in 2.0.1 */ list( options: DatasetCollectionClientListOptions = {}, @@ -84,7 +82,6 @@ export class DatasetCollectionClient extends ResourceCollectionClient { * @param options - Additional options like schema. * @returns The dataset object. * @see https://docs.apify.com/api/v2/datasets-post - * @since Added in 2.0.1 */ async getOrCreate(name?: string, options?: DatasetCollectionClientGetOrCreateOptions): Promise { ow(name, ow.optional.string); @@ -94,9 +91,6 @@ export class DatasetCollectionClient extends ResourceCollectionClient { } } -/** - * @since Added in 2.0.1 - */ export interface DatasetCollectionClientListOptions extends PaginationOptions { unnamed?: boolean; desc?: boolean; @@ -114,7 +108,4 @@ export interface DatasetCollectionClientGetOrCreateOptions { schema?: Record; } -/** - * @since Added in 2.0.1 - */ export type DatasetCollectionClientListResult = PaginatedList & { unnamed: boolean }; diff --git a/src/resource_clients/key_value_store.ts b/src/resource_clients/key_value_store.ts index e896d964e..71e09a138 100644 --- a/src/resource_clients/key_value_store.ts +++ b/src/resource_clients/key_value_store.ts @@ -54,7 +54,6 @@ import { * ``` * * @see https://docs.apify.com/platform/storage/key-value-store - * @since Added in 1.0.0 */ export class KeyValueStoreClient extends ResourceClient { /** @@ -72,7 +71,6 @@ export class KeyValueStoreClient extends ResourceClient { * * @returns The KeyValueStore object, or `undefined` if it does not exist * @see https://docs.apify.com/api/v2/key-value-store-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get({}, SMALL_TIMEOUT_MILLIS); @@ -87,7 +85,6 @@ export class KeyValueStoreClient extends ResourceClient { * @param newFields.generalAccess - General resource access level ('FOLLOW_USER_SETTING', 'ANYONE_WITH_ID_CAN_READ' or 'RESTRICTED') * @returns The updated KeyValueStore object * @see https://docs.apify.com/api/v2/key-value-store-put - * @since Added in 2.0.1 */ async update(newFields: KeyValueClientUpdateOptions): Promise { ow(newFields, ow.object); @@ -99,7 +96,6 @@ export class KeyValueStoreClient extends ResourceClient { * Deletes the key-value store. * * @see https://docs.apify.com/api/v2/key-value-store-delete - * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(SMALL_TIMEOUT_MILLIS); @@ -139,7 +135,6 @@ export class KeyValueStoreClient extends ResourceClient { * exclusiveStartKey = result.nextExclusiveStartKey; * } while (result.isTruncated); * ``` - * @since Added in 2.0.1 */ listKeys( options: KeyValueClientListKeysOptions = {}, @@ -330,7 +325,6 @@ export class KeyValueStoreClient extends ResourceClient { * NOT resolve to a `KeyValueStore` record with an `undefined` value. * * @see https://docs.apify.com/api/v2/key-value-store-record-get - * @since Added in 2.0.1 */ async getRecord(key: string): Promise | undefined>; @@ -438,7 +432,6 @@ export class KeyValueStoreClient extends ResourceClient { * contentType: 'image/png' * }); * ``` - * @since Added in 2.0.1 */ async setRecord(record: KeyValueStoreRecord, options: KeyValueStoreRecordOptions = {}): Promise { ow( @@ -503,7 +496,6 @@ export class KeyValueStoreClient extends ResourceClient { * ```javascript * await client.keyValueStore('my-store').deleteRecord('temp-data'); * ``` - * @since Added in 2.0.1 */ async deleteRecord(key: string): Promise { ow(key, ow.string); @@ -522,52 +514,24 @@ export class KeyValueStoreClient extends ResourceClient { * * Key-value stores are used to store arbitrary data records or files. Each record is identified * by a unique key and can contain any data - JSON objects, strings, binary files, etc. - * @since Added in 0.1.39 */ export interface KeyValueStore { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ name?: string; /** * @since Added in 2.6.1 */ title?: string; - /** - * @since Added in 2.0.1 - */ userId: string; /** * @since Added in 2.21.0 */ username?: string; - /** - * @since Added in 2.0.1 - */ createdAt: Date; - /** - * @since Added in 2.0.1 - */ modifiedAt: Date; - /** - * @since Added in 2.0.1 - */ accessedAt: Date; - /** - * @since Added in 2.0.1 - */ actId?: string; - /** - * @since Added in 2.0.1 - */ actRunId?: string; - /** - * @since Added in 2.0.1 - */ stats?: KeyValueStoreStats; /** * @since Added in 2.12.2 @@ -585,7 +549,6 @@ export interface KeyValueStore { /** * Statistics about Key-Value Store usage and storage. - * @since Added in 2.0.1 */ export interface KeyValueStoreStats { readCount?: number; @@ -597,7 +560,6 @@ export interface KeyValueStoreStats { /** * Options for updating a Key-Value Store. - * @since Added in 2.0.1 */ export interface KeyValueClientUpdateOptions { name?: string | null; @@ -613,20 +575,10 @@ export interface KeyValueClientUpdateOptions { /** * Options for listing keys in a Key-Value Store. - * @since Added in 2.0.1 */ export interface KeyValueClientListKeysOptions { - /** - * @since Added in 2.0.1 - */ limit?: number; - /** - * @since Added in 2.0.1 - */ exclusiveStartKey?: string; - /** - * @since Added in 2.0.1 - */ collection?: string; /** * @since Added in 2.12.5 @@ -652,7 +604,6 @@ export interface KeyValueClientCreateKeysUrlOptions extends KeyValueClientListKe * Result of listing keys in a Key-Value Store. * * Contains paginated list of keys with metadata and pagination information. - * @since Added in 2.0.1 */ export interface KeyValueClientListKeysResult { count: number; @@ -665,7 +616,6 @@ export interface KeyValueClientListKeysResult { /** * Metadata about a single key in a Key-Value Store. - * @since Added in 2.0.1 */ export interface KeyValueListItem { key: string; @@ -678,7 +628,6 @@ export interface KeyValueListItem { /** * Options for retrieving a record from a Key-Value Store. - * @since Added in 2.0.1 */ export interface KeyValueClientGetRecordOptions { buffer?: boolean; @@ -693,20 +642,10 @@ export interface KeyValueClientGetRecordOptions { * Represents a record (key-value pair) in a Key-Value Store. * * @template T - The type of the record's value - * @since Added in 0.1.39 */ export interface KeyValueStoreRecord { - /** - * @since Added in 2.0.1 - */ key: string; - /** - * @since Added in 2.0.1 - */ value: T; - /** - * @since Added in 2.0.1 - */ contentType?: string; } diff --git a/src/resource_clients/key_value_store_collection.ts b/src/resource_clients/key_value_store_collection.ts index 98cfd353f..bf2834103 100644 --- a/src/resource_clients/key_value_store_collection.ts +++ b/src/resource_clients/key_value_store_collection.ts @@ -26,7 +26,6 @@ import type { KeyValueStore } from './key_value_store'; * ``` * * @see https://docs.apify.com/platform/storage/key-value-store - * @since Added in 1.0.0 */ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { /** @@ -58,7 +57,6 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { * @param options - Pagination options. * @returns A paginated iterator of Key-value stores. * @see https://docs.apify.com/api/v2/key-value-stores-get - * @since Added in 2.0.1 */ list( options: KeyValueStoreCollectionClientListOptions = {}, @@ -84,7 +82,6 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { * @param options - Additional options like schema. * @returns The key-value store object. * @see https://docs.apify.com/api/v2/key-value-stores-post - * @since Added in 2.0.1 */ async getOrCreate( name?: string, @@ -97,9 +94,6 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient { } } -/** - * @since Added in 2.0.1 - */ export interface KeyValueStoreCollectionClientListOptions extends PaginationOptions { unnamed?: boolean; desc?: boolean; @@ -117,7 +111,4 @@ export interface KeyValueStoreCollectionClientGetOrCreateOptions { schema?: Record; } -/** - * @since Added in 2.0.1 - */ export type KeyValueStoreCollectionListResult = PaginatedList & { unnamed: boolean }; diff --git a/src/resource_clients/log.ts b/src/resource_clients/log.ts index 48727dc93..4d9644d90 100644 --- a/src/resource_clients/log.ts +++ b/src/resource_clients/log.ts @@ -33,7 +33,6 @@ import { cast, catchNotFoundOrThrow } from '../utils'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds#logging - * @since Added in 1.0.0 */ export class LogClient extends ResourceClient { /** @@ -53,7 +52,6 @@ export class LogClient extends ResourceClient { * @param options.raw - If `true`, returns raw log content without any processing. Default is `false`. * @returns The log content as a string, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/log-get - * @since Added in 2.0.1 */ async get(options: LogOptions = {}): Promise { const requestOpts: ApifyRequestConfig = { @@ -79,7 +77,6 @@ export class LogClient extends ResourceClient { * @param options.raw - If `true`, returns raw log content without any processing. Default is `false`. * @returns The log content as a Readable stream, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/log-get - * @since Added in 2.0.1 */ async stream(options: LogOptions = {}): Promise { const params = { diff --git a/src/resource_clients/request_queue.ts b/src/resource_clients/request_queue.ts index 40b864635..f125009cf 100644 --- a/src/resource_clients/request_queue.ts +++ b/src/resource_clients/request_queue.ts @@ -54,7 +54,6 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01% * ``` * * @see https://docs.apify.com/platform/storage/request-queue - * @since Added in 1.0.0 */ export class RequestQueueClient extends ResourceClient { private clientKey?: string; @@ -79,7 +78,6 @@ export class RequestQueueClient extends ResourceClient { * * @returns The RequestQueue object, or `undefined` if it does not exist * @see https://docs.apify.com/api/v2/request-queue-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get({}, SMALL_TIMEOUT_MILLIS); @@ -91,7 +89,6 @@ export class RequestQueueClient extends ResourceClient { * @param newFields - Fields to update in the Request queue * @returns The updated RequestQueue object * @see https://docs.apify.com/api/v2/request-queue-put - * @since Added in 2.0.1 */ async update(newFields: RequestQueueClientUpdateOptions): Promise { ow(newFields, ow.object); @@ -103,7 +100,6 @@ export class RequestQueueClient extends ResourceClient { * Deletes the Request queue. * * @see https://docs.apify.com/api/v2/request-queue-delete - * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(SMALL_TIMEOUT_MILLIS); @@ -118,7 +114,6 @@ export class RequestQueueClient extends ResourceClient { * @param options - Options for listing (e.g., limit) * @returns List of requests from the queue head * @see https://docs.apify.com/api/v2/request-queue-head-get - * @since Added in 2.0.1 */ async listHead(options: RequestQueueClientListHeadOptions = {}): Promise { ow( @@ -236,7 +231,6 @@ export class RequestQueueClient extends ResourceClient { * { forefront: true } * ); * ``` - * @since Added in 2.0.1 */ async addRequest( request: Omit, @@ -519,7 +513,6 @@ export class RequestQueueClient extends ResourceClient { * @param id - Request ID * @returns The request object, or `undefined` if not found * @see https://docs.apify.com/api/v2/request-queue-request-get - * @since Added in 2.0.1 */ async getRequest(id: string): Promise { ow(id, ow.string); @@ -546,7 +539,6 @@ export class RequestQueueClient extends ResourceClient { * @param options - Update options such as whether to move to front * @returns Information about the updated request * @see https://docs.apify.com/api/v2/request-queue-request-put - * @since Added in 2.0.1 */ async updateRequest( request: RequestQueueClientRequestSchema, @@ -584,7 +576,6 @@ export class RequestQueueClient extends ResourceClient { * Deletes a specific request from the queue. * * @param id - Request ID - * @since Added in 2.0.1 */ async deleteRequest(id: string): Promise { ow(id, ow.string); @@ -835,7 +826,6 @@ export class RequestQueueClient extends ResourceClient { /** * User-specific options for RequestQueueClient. - * @since Added in 2.0.1 */ export interface RequestQueueUserOptions { clientKey?: string; @@ -850,72 +840,29 @@ export interface RequestQueueUserOptions { * * Request queues store URLs (requests) to be processed by web crawlers. They provide * automatic deduplication, request locking for parallel processing, and persistence. - * @since Added in 0.2.4 */ export interface RequestQueue { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ name?: string; /** * @since Added in 2.6.1 */ title?: string; - /** - * @since Added in 2.0.1 - */ userId: string; /** * @since Added in 2.21.0 */ username?: string; - /** - * @since Added in 2.0.1 - */ createdAt: Date; - /** - * @since Added in 2.0.1 - */ modifiedAt: Date; - /** - * @since Added in 2.0.1 - */ accessedAt: Date; - /** - * @since Added in 2.0.1 - */ expireAt?: string; - /** - * @since Added in 2.0.1 - */ totalRequestCount: number; - /** - * @since Added in 2.0.1 - */ handledRequestCount: number; - /** - * @since Added in 2.0.1 - */ pendingRequestCount: number; - /** - * @since Added in 2.0.1 - */ actId?: string; - /** - * @since Added in 2.0.1 - */ actRunId?: string; - /** - * @since Added in 2.0.1 - */ hadMultipleClients: boolean; - /** - * @since Added in 2.0.1 - */ stats: RequestQueueStats; /** * @since Added in 2.12.2 @@ -925,7 +872,6 @@ export interface RequestQueue { /** * Statistics about Request Queue usage and storage. - * @since Added in 2.0.1 */ export interface RequestQueueStats { readCount?: number; @@ -937,7 +883,6 @@ export interface RequestQueueStats { /** * Options for updating a Request Queue. - * @since Added in 2.0.1 */ export interface RequestQueueClientUpdateOptions { name?: string | null; @@ -953,7 +898,6 @@ export interface RequestQueueClientUpdateOptions { /** * Options for listing requests from the queue head. - * @since Added in 2.0.1 */ export interface RequestQueueClientListHeadOptions { limit?: number; @@ -961,24 +905,11 @@ export interface RequestQueueClientListHeadOptions { /** * Result of listing requests from the queue head. - * @since Added in 2.0.1 */ export interface RequestQueueClientListHeadResult { - /** - * @since Added in 2.0.1 - */ limit: number; - /** - * @since Added in 2.0.1 - */ queueModifiedAt: Date; - /** - * @since Added in 2.0.1 - */ hadMultipleClients: boolean; - /** - * @since Added in 2.0.1 - */ items: RequestQueueClientListItem[]; } @@ -1075,7 +1006,6 @@ export interface RequestQueueClientListAndLockHeadResult extends RequestQueueCli /** * Simplified request information used in list results. - * @since Added in 2.0.1 */ export interface RequestQueueClientListItem { id: string; @@ -1089,9 +1019,6 @@ export interface RequestQueueClientListItem { lockExpiresAt?: Date; } -/** - * @since Added in 2.0.1 - */ export interface RequestQueueClientAddRequestOptions { forefront?: boolean; } @@ -1135,7 +1062,6 @@ export interface RequestQueueClientBatchAddRequestWithRetriesOptions { * Complete schema for a request in the queue. * * Represents a URL to be crawled along with its metadata, retry information, and custom data. - * @since Added in 2.0.1 */ export interface RequestQueueClientRequestSchema { id: string; @@ -1154,7 +1080,6 @@ export interface RequestQueueClientRequestSchema { /** * Result of adding a request to the queue. - * @since Added in 2.0.1 */ export interface RequestQueueClientAddRequestResult { requestId: string; @@ -1200,14 +1125,10 @@ export type RequestQueueClientRequestToDelete = | Pick | Pick; -/** - * @since Added in 2.0.1 - */ export type RequestQueueClientGetRequestResult = Omit; /** * HTTP methods supported by Request Queue requests. - * @since Added in 2.0.1 */ export type AllowedHttpMethods = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'TRACE' | 'OPTIONS' | 'CONNECT' | 'PATCH'; diff --git a/src/resource_clients/request_queue_collection.ts b/src/resource_clients/request_queue_collection.ts index 904ec5c07..3024dd7a8 100644 --- a/src/resource_clients/request_queue_collection.ts +++ b/src/resource_clients/request_queue_collection.ts @@ -26,7 +26,6 @@ import type { RequestQueue } from './request_queue'; * ``` * * @see https://docs.apify.com/platform/storage/request-queue - * @since Added in 1.0.0 */ export class RequestQueueCollectionClient extends ResourceCollectionClient { /** @@ -58,7 +57,6 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient { * @param options - Pagination options. * @returns A paginated iterator of Request queues. * @see https://docs.apify.com/api/v2/request-queues-get - * @since Added in 2.0.1 */ list( options: RequestQueueCollectionListOptions = {}, @@ -83,7 +81,6 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient { * @param name - Name of the Request queue. If not provided, a default queue is used. * @returns The Request queue object. * @see https://docs.apify.com/api/v2/request-queues-post - * @since Added in 2.0.1 */ async getOrCreate(name?: string): Promise { ow(name, ow.optional.string); @@ -92,9 +89,6 @@ export class RequestQueueCollectionClient extends ResourceCollectionClient { } } -/** - * @since Added in 2.0.1 - */ export interface RequestQueueCollectionListOptions extends PaginationOptions { unnamed?: boolean; desc?: boolean; @@ -105,7 +99,4 @@ export interface RequestQueueCollectionListOptions extends PaginationOptions { ownership?: STORAGE_OWNERSHIP_FILTER; } -/** - * @since Added in 2.0.1 - */ export type RequestQueueCollectionListResult = PaginatedList & { unnamed: boolean }; diff --git a/src/resource_clients/run.ts b/src/resource_clients/run.ts index 88b0259be..6bf78348f 100644 --- a/src/resource_clients/run.ts +++ b/src/resource_clients/run.ts @@ -38,7 +38,6 @@ const RUN_CHARGE_IDEMPOTENCY_HEADER = 'idempotency-key'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds - * @since Added in 1.0.0 */ export class RunClient extends ResourceClient { /** @@ -68,7 +67,6 @@ export class RunClient extends ResourceClient { * // Wait up to 60 seconds for run to finish * const run = await client.run('run-id').get({ waitForFinish: 60 }); * ``` - * @since Added in 2.0.1 */ async get(options: RunGetOptions = {}): Promise { ow( @@ -97,7 +95,6 @@ export class RunClient extends ResourceClient { * // Abort gracefully (allows cleanup) * await client.run('run-id').abort({ gracefully: true }); * ``` - * @since Added in 2.0.1 */ async abort(options: RunAbortOptions = {}): Promise { ow( @@ -150,7 +147,6 @@ export class RunClient extends ResourceClient { * ); * console.log(`Run ${metamorphedRun.id} is now running ${metamorphedRun.actId}`); * ``` - * @since Added in 2.0.1 */ async metamorph(targetActorId: string, input: unknown, options: RunMetamorphOptions = {}): Promise { ow(targetActorId, ow.string); @@ -264,7 +260,6 @@ export class RunClient extends ResourceClient { * const newRun = await client.run('failed-run-id').resurrect({ memory: 2048 }); * console.log(`New run started: ${newRun.id}`); * ``` - * @since Added in 2.0.1 */ async resurrect(options: RunResurrectOptions = {}): Promise { ow( @@ -357,7 +352,6 @@ export class RunClient extends ResourceClient { * console.log('Run succeeded!'); * } * ``` - * @since Added in 2.0.1 */ async waitForFinish(options: RunWaitForFinishOptions = {}): Promise { ow( @@ -381,7 +375,6 @@ export class RunClient extends ResourceClient { * // Access run's dataset * const { items } = await client.run('run-id').dataset().listItems(); * ``` - * @since Added in 2.0.1 */ dataset(): DatasetClient { return new DatasetClient( @@ -402,7 +395,6 @@ export class RunClient extends ResourceClient { * // Access run's key-value store * const output = await client.run('run-id').keyValueStore().getRecord('OUTPUT'); * ``` - * @since Added in 2.0.1 */ keyValueStore(): KeyValueStoreClient { return new KeyValueStoreClient( @@ -423,7 +415,6 @@ export class RunClient extends ResourceClient { * // Access run's Request queue * const { items } = await client.run('run-id').requestQueue().listHead(); * ``` - * @since Added in 2.0.1 */ requestQueue(): RequestQueueClient { return new RequestQueueClient( @@ -445,7 +436,6 @@ export class RunClient extends ResourceClient { * const log = await client.run('run-id').log().get(); * console.log(log); * ``` - * @since Added in 2.0.1 */ log(): LogClient { return new LogClient( @@ -496,7 +486,6 @@ export interface GetStreamedLogOptions { /** * Options for getting a Run. - * @since Added in 2.0.1 */ export interface RunGetOptions { waitForFinish?: number; @@ -504,7 +493,6 @@ export interface RunGetOptions { /** * Options for aborting a Run. - * @since Added in 2.0.1 */ export interface RunAbortOptions { gracefully?: boolean; @@ -512,7 +500,6 @@ export interface RunAbortOptions { /** * Options for metamorphing a Run into another Actor. - * @since Added in 2.0.1 */ export interface RunMetamorphOptions { contentType?: string; @@ -537,7 +524,6 @@ export interface RunUpdateOptions { /** * Options for resurrecting a finished Run. - * @since Added in 2.0.1 */ export interface RunResurrectOptions { build?: string; @@ -572,7 +558,6 @@ export interface RunChargeOptions { /** * Options for waiting for a Run to finish. - * @since Added in 2.0.1 */ export interface RunWaitForFinishOptions { /** diff --git a/src/resource_clients/run_collection.ts b/src/resource_clients/run_collection.ts index 35b428fa7..4472b8c28 100644 --- a/src/resource_clients/run_collection.ts +++ b/src/resource_clients/run_collection.ts @@ -27,7 +27,6 @@ import type { ActorRunListItem } from './actor'; * ``` * * @see https://docs.apify.com/platform/actors/running/runs-and-builds - * @since Added in 1.0.0 */ export class RunCollectionClient extends ResourceCollectionClient { /** @@ -59,7 +58,6 @@ export class RunCollectionClient extends ResourceCollectionClient { * @param options - Pagination and filtering options. * @returns A paginated iterator of Actor runs. * @see https://docs.apify.com/api/v2/actor-runs-get - * @since Added in 2.0.1 */ list(options: RunCollectionListOptions = {}): PaginatedIterator { ow( @@ -81,9 +79,6 @@ export class RunCollectionClient extends ResourceCollectionClient { } } -/** - * @since Added in 2.0.1 - */ export interface RunCollectionListOptions extends PaginationOptions { desc?: boolean; status?: diff --git a/src/resource_clients/schedule.ts b/src/resource_clients/schedule.ts index 567d24bbb..bc9458279 100644 --- a/src/resource_clients/schedule.ts +++ b/src/resource_clients/schedule.ts @@ -30,7 +30,6 @@ import { cast, catchNotFoundOrThrow, parseDateFields, pluckData } from '../utils * ``` * * @see https://docs.apify.com/platform/schedules - * @since Added in 1.0.0 */ export class ScheduleClient extends ResourceClient { /** @@ -48,7 +47,6 @@ export class ScheduleClient extends ResourceClient { * * @returns The schedule object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/schedule-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -60,7 +58,6 @@ export class ScheduleClient extends ResourceClient { * @param newFields - Fields to update. * @returns The updated schedule object. * @see https://docs.apify.com/api/v2/schedule-put - * @since Added in 2.0.1 */ async update(newFields: ScheduleCreateOrUpdateData): Promise { ow(newFields, ow.object); @@ -71,7 +68,6 @@ export class ScheduleClient extends ResourceClient { * Deletes the schedule. * * @see https://docs.apify.com/api/v2/schedule-delete - * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -82,7 +78,6 @@ export class ScheduleClient extends ResourceClient { * * @returns The schedule log as a string, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/schedule-log-get - * @since Added in 2.0.1 */ async getLog(): Promise { const requestOpts: ApifyRequestConfig = { @@ -105,64 +100,24 @@ export class ScheduleClient extends ResourceClient { * Represents a schedule for automated Actor or Task runs. * * Schedules use cron expressions to define when Actors or Tasks should run automatically. - * @since Added in 1.0.0 */ export interface Schedule { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ userId: string; - /** - * @since Added in 2.0.1 - */ name: string; /** * @since Added in 2.6.1 */ title?: string; - /** - * @since Added in 2.0.1 - */ cronExpression: string; - /** - * @since Added in 2.0.1 - */ timezone: Timezone; - /** - * @since Added in 2.0.1 - */ isEnabled: boolean; - /** - * @since Added in 2.0.1 - */ isExclusive: boolean; - /** - * @since Added in 2.0.1 - */ description?: string; - /** - * @since Added in 2.0.1 - */ createdAt: Date; - /** - * @since Added in 2.0.1 - */ modifiedAt: Date; - /** - * @since Added in 2.0.1 - */ nextRunAt: string; - /** - * @since Added in 2.0.1 - */ lastRunAt: string; - /** - * @since Added in 2.0.1 - */ actions: ScheduleAction[]; /** * @since Added in 2.9.4 @@ -187,7 +142,6 @@ export type ScheduleCreateOrUpdateData = Partial< /** * Types of actions that can be scheduled. - * @since Added in 2.0.1 */ export enum ScheduleActions { RunActor = 'RUN_ACTOR', @@ -201,13 +155,11 @@ interface BaseScheduleAction { /** * Union type representing all possible scheduled actions. - * @since Added in 2.0.1 */ export type ScheduleAction = ScheduleActionRunActor | ScheduleActionRunActorTask; /** * Scheduled action to run an Actor. - * @since Added in 2.0.1 */ export interface ScheduleActionRunActor extends BaseScheduleAction { actorId: string; @@ -217,7 +169,6 @@ export interface ScheduleActionRunActor extends BaseScheduleAction { actorTaskId: string; diff --git a/src/resource_clients/schedule_collection.ts b/src/resource_clients/schedule_collection.ts index d050ecd8e..6a0462634 100644 --- a/src/resource_clients/schedule_collection.ts +++ b/src/resource_clients/schedule_collection.ts @@ -28,7 +28,6 @@ import type { Schedule, ScheduleCreateOrUpdateData } from './schedule'; * ``` * * @see https://docs.apify.com/platform/schedules - * @since Added in 1.0.0 */ export class ScheduleCollectionClient extends ResourceCollectionClient { /** @@ -60,7 +59,6 @@ export class ScheduleCollectionClient extends ResourceCollectionClient { * @param options - Pagination and sorting options. * @returns A paginated iterator of schedules. * @see https://docs.apify.com/api/v2/schedules-get - * @since Added in 2.0.1 */ list(options: ScheduleCollectionListOptions = {}): PaginatedIterator { ow( @@ -81,7 +79,6 @@ export class ScheduleCollectionClient extends ResourceCollectionClient { * @param schedule - The schedule data. * @returns The created schedule object. * @see https://docs.apify.com/api/v2/schedules-post - * @since Added in 2.0.1 */ async create(schedule?: ScheduleCreateOrUpdateData): Promise { ow(schedule, ow.optional.object); @@ -90,9 +87,6 @@ export class ScheduleCollectionClient extends ResourceCollectionClient { } } -/** - * @since Added in 2.0.1 - */ export interface ScheduleCollectionListOptions extends PaginationOptions { desc?: boolean; } diff --git a/src/resource_clients/task.ts b/src/resource_clients/task.ts index e0f23a5ca..7cb782023 100644 --- a/src/resource_clients/task.ts +++ b/src/resource_clients/task.ts @@ -32,7 +32,6 @@ import { WebhookCollectionClient } from './webhook_collection'; * ``` * * @see https://docs.apify.com/platform/actors/running/tasks - * @since Added in 1.0.0 */ export class TaskClient extends ResourceClient { /** @@ -50,7 +49,6 @@ export class TaskClient extends ResourceClient { * * @returns The task object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/actor-task-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -62,7 +60,6 @@ export class TaskClient extends ResourceClient { * @param newFields - Fields to update. * @returns The updated task object. * @see https://docs.apify.com/api/v2/actor-task-put - * @since Added in 2.0.1 */ async update(newFields: TaskUpdateData): Promise { ow(newFields, ow.object); @@ -74,7 +71,6 @@ export class TaskClient extends ResourceClient { * Deletes the Task. * * @see https://docs.apify.com/api/v2/actor-task-delete - * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -95,7 +91,6 @@ export class TaskClient extends ResourceClient { * @param options.restartOnError - Whether to restart the run on error. * @returns The Actor Run object. * @see https://docs.apify.com/api/v2/actor-task-runs-post - * @since Added in 2.0.1 */ async start(input?: Dictionary, options: TaskStartOptions = {}): Promise { ow(input, ow.optional.object); @@ -159,7 +154,6 @@ export class TaskClient extends ResourceClient { * @param options.restartOnError - Whether to restart the run on error. * @returns The Actor run object. * @see https://docs.apify.com/api/v2/actor-task-runs-post - * @since Added in 2.0.1 */ async call(input?: Dictionary, options: TaskCallOptions = {}): Promise { ow(input, ow.optional.object); @@ -192,7 +186,6 @@ export class TaskClient extends ResourceClient { * * @returns The Task's input, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/actor-task-input-get - * @since Added in 2.0.1 */ async getInput(): Promise { const requestOpts: ApifyRequestConfig = { @@ -216,7 +209,6 @@ export class TaskClient extends ResourceClient { * @param newFields - New input data for the task. * @returns The updated task input. * @see https://docs.apify.com/api/v2/actor-task-input-put - * @since Added in 2.0.1 */ async updateInput(newFields: Dictionary | Dictionary[]): Promise { const response = await this.httpClient.call({ @@ -237,7 +229,6 @@ export class TaskClient extends ResourceClient { * @param options.origin - Filter by run origin (e.g., `'WEB'`, `'API'`, `'SCHEDULE'`). * @returns A client for the last run. * @see https://docs.apify.com/api/v2/actor-task-runs-last-get - * @since Added in 2.0.1 */ lastRun(options: TaskLastRunOptions = {}): RunClient { ow( @@ -262,7 +253,6 @@ export class TaskClient extends ResourceClient { * * @returns A client for the task's runs. * @see https://docs.apify.com/api/v2/actor-task-runs-get - * @since Added in 2.0.1 */ runs(): RunCollectionClient { return new RunCollectionClient( @@ -277,7 +267,6 @@ export class TaskClient extends ResourceClient { * * @returns A client for the task's webhooks. * @see https://docs.apify.com/api/v2/actor-task-webhooks-get - * @since Added in 2.0.1 */ webhooks(): WebhookCollectionClient { return new WebhookCollectionClient(this._subResourceOptions()); @@ -289,56 +278,22 @@ export class TaskClient extends ResourceClient { * * Tasks are saved Actor configurations with input and settings that can be executed * repeatedly without having to specify the full input each time. - * @since Added in 0.3.2 */ export interface Task { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ userId: string; - /** - * @since Added in 2.0.1 - */ actId: string; - /** - * @since Added in 2.0.1 - */ name: string; /** * @since Added in 2.6.1 */ title?: string; - /** - * @since Added in 2.0.1 - */ description?: string; - /** - * @since Added in 2.0.1 - */ username?: string; - /** - * @since Added in 2.0.1 - */ createdAt: Date; - /** - * @since Added in 2.0.1 - */ modifiedAt: Date; - /** - * @since Added in 2.0.1 - */ stats: TaskStats; - /** - * @since Added in 2.0.1 - */ options?: TaskOptions; - /** - * @since Added in 2.0.1 - */ input?: Dictionary | Dictionary[]; /** * @since Added in 2.9.5 @@ -348,7 +303,6 @@ export interface Task { /** * Statistics about Actor task usage. - * @since Added in 2.0.1 */ export interface TaskStats { totalRuns: number; @@ -356,7 +310,6 @@ export interface TaskStats { /** * Configuration options for an Actor task. - * @since Added in 2.0.1 */ export interface TaskOptions { build?: string; @@ -370,7 +323,6 @@ export interface TaskOptions { /** * Fields that can be updated when modifying a Task. - * @since Added in 2.0.1 */ export type TaskUpdateData = Partial< Pick @@ -378,7 +330,6 @@ export type TaskUpdateData = Partial< /** * Options for filtering the last run of a Task. - * @since Added in 2.0.1 */ export interface TaskLastRunOptions { status?: keyof typeof ACT_JOB_STATUSES; diff --git a/src/resource_clients/task_collection.ts b/src/resource_clients/task_collection.ts index 69987928d..57e5f85ca 100644 --- a/src/resource_clients/task_collection.ts +++ b/src/resource_clients/task_collection.ts @@ -28,7 +28,6 @@ import type { Task, TaskUpdateData } from './task'; * ``` * * @see https://docs.apify.com/platform/actors/running/tasks - * @since Added in 1.0.0 */ export class TaskCollectionClient extends ResourceCollectionClient { /** @@ -60,7 +59,6 @@ export class TaskCollectionClient extends ResourceCollectionClient { * @param options - Pagination and sorting options. * @returns A paginated iterator of tasks. * @see https://docs.apify.com/api/v2/actor-tasks-get - * @since Added in 2.0.1 */ list(options: TaskCollectionListOptions = {}): PaginatedIterator { ow( @@ -81,7 +79,6 @@ export class TaskCollectionClient extends ResourceCollectionClient { * @param task - The task data. * @returns The created task object. * @see https://docs.apify.com/api/v2/actor-tasks-post - * @since Added in 2.0.1 */ async create(task: TaskCreateData): Promise { ow(task, ow.object); @@ -90,16 +87,10 @@ export class TaskCollectionClient extends ResourceCollectionClient { } } -/** - * @since Added in 2.0.1 - */ export interface TaskCollectionListOptions extends PaginationOptions { desc?: boolean; } -/** - * @since Added in 2.0.1 - */ export type TaskList = Omit; /** diff --git a/src/resource_clients/user.ts b/src/resource_clients/user.ts index b74c3def5..2961f9d49 100644 --- a/src/resource_clients/user.ts +++ b/src/resource_clients/user.ts @@ -27,7 +27,6 @@ import { cast, catchNotFoundOrThrow, parseDateFields, pluckData } from '../utils * ``` * * @see https://docs.apify.com/platform/actors/running - * @since Added in 1.0.0 */ export class UserClient extends ResourceClient { /** @@ -48,7 +47,6 @@ export class UserClient extends ResourceClient { * * @returns The user object. * @see https://docs.apify.com/api/v2/user-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get() as Promise; @@ -129,18 +127,9 @@ export class UserClient extends ResourceClient { // Using token will return private user data // -/** - * @since Added in 0.2.2 - */ export interface User { // Public properties - /** - * @since Added in 2.0.1 - */ username: string; - /** - * @since Added in 2.0.1 - */ profile: { bio?: string; name?: string; @@ -150,21 +139,9 @@ export interface User { twitterUsername?: string; }; // Private properties - /** - * @since Added in 2.0.1 - */ id?: string; - /** - * @since Added in 2.0.1 - */ email?: string; - /** - * @since Added in 2.0.1 - */ proxy?: UserProxy; - /** - * @since Added in 2.0.1 - */ plan?: UserPlan; /** * @since Added in 2.12.5 @@ -180,26 +157,17 @@ export interface User { isPaying?: boolean; } -/** - * @since Added in 2.0.1 - */ export interface UserProxy { password: string; groups: ProxyGroup[]; } -/** - * @since Added in 2.0.1 - */ export interface ProxyGroup { name: string; description: string; availableCount: number; } -/** - * @since Added in 2.0.1 - */ export interface UserPlan { id: string; description: string; @@ -223,9 +191,6 @@ export interface UserPlan { availableAddOns: unknown[]; } -/** - * @since Added in 2.0.1 - */ export enum PlatformFeature { Actors = 'ACTORS', Storage = 'STORAGE', diff --git a/src/resource_clients/webhook.ts b/src/resource_clients/webhook.ts index cf82da9ef..ac28b121d 100644 --- a/src/resource_clients/webhook.ts +++ b/src/resource_clients/webhook.ts @@ -37,7 +37,6 @@ import { WebhookDispatchCollectionClient } from './webhook_dispatch_collection'; * ``` * * @see https://docs.apify.com/platform/integrations/webhooks - * @since Added in 1.0.0 */ export class WebhookClient extends ResourceClient { /** @@ -55,7 +54,6 @@ export class WebhookClient extends ResourceClient { * * @returns The webhook object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/webhook-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get(); @@ -67,7 +65,6 @@ export class WebhookClient extends ResourceClient { * @param newFields - Fields to update. * @returns The updated webhook object. * @see https://docs.apify.com/api/v2/webhook-put - * @since Added in 2.0.1 */ async update(newFields: WebhookUpdateData): Promise { ow(newFields, ow.object); @@ -79,7 +76,6 @@ export class WebhookClient extends ResourceClient { * Deletes the webhook. * * @see https://docs.apify.com/api/v2/webhook-delete - * @since Added in 2.0.1 */ async delete(): Promise { return this._delete(); @@ -90,7 +86,6 @@ export class WebhookClient extends ResourceClient { * * @returns The webhook dispatch object, or `undefined` if the test fails. * @see https://docs.apify.com/api/v2/webhook-test-post - * @since Added in 2.0.1 */ async test(): Promise { const request: ApifyRequestConfig = { @@ -114,7 +109,6 @@ export class WebhookClient extends ResourceClient { * * @returns A client for the webhook's dispatches. * @see https://docs.apify.com/api/v2/webhook-webhook-dispatches-get - * @since Added in 2.0.1 */ dispatches(): WebhookDispatchCollectionClient { return new WebhookDispatchCollectionClient( @@ -130,60 +124,20 @@ export class WebhookClient extends ResourceClient { * * Webhooks send HTTP POST requests to specified URLs when certain events occur * (e.g., Actor run succeeds, fails, or times out). - * @since Added in 0.5.8 */ export interface Webhook { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ userId: string; - /** - * @since Added in 2.0.1 - */ createdAt: Date; - /** - * @since Added in 2.0.1 - */ modifiedAt: Date; - /** - * @since Added in 2.0.1 - */ isAdHoc: boolean; - /** - * @since Added in 2.0.1 - */ eventTypes: WebhookEventType[]; - /** - * @since Added in 2.0.1 - */ condition: WebhookCondition; - /** - * @since Added in 2.0.1 - */ ignoreSslErrors: boolean; - /** - * @since Added in 2.0.1 - */ doNotRetry: boolean; - /** - * @since Added in 2.0.1 - */ requestUrl: string; - /** - * @since Added in 2.0.1 - */ payloadTemplate: string; - /** - * @since Added in 2.0.1 - */ lastDispatch: string; - /** - * @since Added in 2.0.1 - */ stats: WebhookStats; /** * @since Added in 2.7.2 @@ -203,16 +157,12 @@ export interface Webhook { description?: string; } -/** - * @since Added in 2.0.1 - */ export interface WebhookIdempotencyKey { idempotencyKey?: string; } /** * Data for updating a webhook. - * @since Added in 2.0.1 */ export type WebhookUpdateData = Partial< Pick< @@ -237,7 +187,6 @@ export type WebhookUpdateData = Partial< /** * Statistics about webhook usage. - * @since Added in 2.0.1 */ export interface WebhookStats { totalDispatches: number; @@ -245,36 +194,25 @@ export interface WebhookStats { /** * Event types that can trigger webhooks. - * @since Added in 2.0.1 */ export type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[keyof typeof WEBHOOK_EVENT_TYPES]; /** * Condition that determines when a webhook should be triggered. - * @since Added in 2.0.1 */ export type WebhookCondition = | WebhookAnyRunOfActorCondition | WebhookAnyRunOfActorTaskCondition | WebhookCertainRunCondition; -/** - * @since Added in 2.0.1 - */ export interface WebhookAnyRunOfActorCondition { actorId: string; } -/** - * @since Added in 2.0.1 - */ export interface WebhookAnyRunOfActorTaskCondition { actorTaskId: string; } -/** - * @since Added in 2.0.1 - */ export interface WebhookCertainRunCondition { actorRunId: string; } diff --git a/src/resource_clients/webhook_collection.ts b/src/resource_clients/webhook_collection.ts index 18845d6b6..fc706087c 100644 --- a/src/resource_clients/webhook_collection.ts +++ b/src/resource_clients/webhook_collection.ts @@ -27,7 +27,6 @@ import type { Webhook, WebhookUpdateData } from './webhook'; * ``` * * @see https://docs.apify.com/platform/integrations/webhooks - * @since Added in 1.0.0 */ export class WebhookCollectionClient extends ResourceCollectionClient { /** @@ -61,9 +60,6 @@ export class WebhookCollectionClient extends ResourceCollectionClient { * @see https://docs.apify.com/api/v2/webhooks-get */ - /** - * @since Added in 2.0.1 - */ list( options: WebhookCollectionListOptions = {}, ): PaginatedIterator> { @@ -85,7 +81,6 @@ export class WebhookCollectionClient extends ResourceCollectionClient { * @param webhook - The webhook data. * @returns The created webhook object. * @see https://docs.apify.com/api/v2/webhooks-post - * @since Added in 2.0.1 */ async create(webhook?: WebhookUpdateData): Promise { ow(webhook, ow.optional.object); @@ -94,9 +89,6 @@ export class WebhookCollectionClient extends ResourceCollectionClient { } } -/** - * @since Added in 2.0.1 - */ export interface WebhookCollectionListOptions extends PaginationOptions { desc?: boolean; } diff --git a/src/resource_clients/webhook_dispatch.ts b/src/resource_clients/webhook_dispatch.ts index 2688e43ba..4ab6e282c 100644 --- a/src/resource_clients/webhook_dispatch.ts +++ b/src/resource_clients/webhook_dispatch.ts @@ -19,7 +19,6 @@ import type { Webhook, WebhookEventType } from './webhook'; * ``` * * @see https://docs.apify.com/platform/integrations/webhooks - * @since Added in 1.0.0 */ export class WebhookDispatchClient extends ResourceClient { /** @@ -37,48 +36,20 @@ export class WebhookDispatchClient extends ResourceClient { * * @returns The webhook dispatch object, or `undefined` if it does not exist. * @see https://docs.apify.com/api/v2/webhook-dispatch-get - * @since Added in 2.0.1 */ async get(): Promise { return this._get(); } } -/** - * @since Added in 0.5.8 - */ export interface WebhookDispatch { - /** - * @since Added in 2.0.1 - */ id: string; - /** - * @since Added in 2.0.1 - */ userId: string; - /** - * @since Added in 2.0.1 - */ webhookId: string; - /** - * @since Added in 2.0.1 - */ createdAt: Date; - /** - * @since Added in 2.0.1 - */ status: WebhookDispatchStatus; - /** - * @since Added in 2.0.1 - */ eventType: WebhookEventType; - /** - * @since Added in 2.0.1 - */ calls: WebhookDispatchCall[]; - /** - * @since Added in 2.0.1 - */ webhook: Pick; /** * @since Added in 2.13.0 @@ -86,18 +57,12 @@ export interface WebhookDispatch { eventData: WebhookDispatchEventData | null; } -/** - * @since Added in 2.0.1 - */ export enum WebhookDispatchStatus { Active = 'ACTIVE', Succeeded = 'SUCCEEDED', Failed = 'FAILED', } -/** - * @since Added in 2.0.1 - */ export interface WebhookDispatchCall { startedAt: Date; finishedAt: Date; diff --git a/src/resource_clients/webhook_dispatch_collection.ts b/src/resource_clients/webhook_dispatch_collection.ts index bfb2d1a2c..d239d2bf5 100644 --- a/src/resource_clients/webhook_dispatch_collection.ts +++ b/src/resource_clients/webhook_dispatch_collection.ts @@ -22,7 +22,6 @@ import type { WebhookDispatch } from './webhook_dispatch'; * ``` * * @see https://docs.apify.com/platform/integrations/webhooks - * @since Added in 1.0.0 */ export class WebhookDispatchCollectionClient extends ResourceCollectionClient { /** @@ -54,7 +53,6 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient { * @param options - Pagination and sorting options. * @returns A paginated iterator of webhook dispatches. * @see https://docs.apify.com/api/v2/webhook-dispatches-get - * @since Added in 2.0.1 */ list(options: WebhookDispatchCollectionListOptions = {}): PaginatedIterator { ow( @@ -70,9 +68,6 @@ export class WebhookDispatchCollectionClient extends ResourceCollectionClient { } } -/** - * @since Added in 2.0.1 - */ export interface WebhookDispatchCollectionListOptions extends PaginationOptions { desc?: boolean; } diff --git a/src/utils.ts b/src/utils.ts index 2a5b37119..bd2483804 100644 --- a/src/utils.ts +++ b/src/utils.ts @@ -288,7 +288,6 @@ export interface PaginatedResponse { * offset-based pagination and field transformations. * * @template Data - The type of items in the list - * @since Added in 2.0.1 */ export interface PaginatedList extends PaginatedResponse { /** Count of dataset entries returned in this set. */