Skip to main content
Version: Next

apify-client

Index

Enumerations

Classes

Interfaces

Type Aliases

Type Aliases

ActorChargeEvents

ActorChargeEvents: Record<string, ActorChargeEvent>

Mapping of event names to their pricing information.

Added in 2.11.1

ActorCollectionListResult

ActorCollectionListResult: PaginatedList<ActorCollectionListItem>

ActorEnvVarListResult

ActorEnvVarListResult: Pick<PaginatedList<ActorEnvironmentVariable>, total | items>

Added in 2.1.0

ActorRunPricingInfo

ActorRunPricingInfo: PricePerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo

Union type representing all possible Actor pricing models.

Added in 2.11.1

ActorTaggedBuilds

ActorTaggedBuilds: Record<string, ActorTaggedBuild>

Mapping of build tags (e.g., 'latest', 'beta') to their corresponding build information.

ActorUpdateOptions

ActorUpdateOptions: Partial<Pick<Actor, name | description | isPublic | isDeprecated | seoTitle | seoDescription | title | restartOnError | versions | categories | defaultRunOptions | actorStandby | actorPermissionLevel | taggedBuilds>>

Fields that can be updated when modifying an Actor.

ActorVersion

ActorVersion: ActorVersionSourceFiles | ActorVersionGitRepo | ActorVersionTarball | ActorVersionGitHubGist

ActorVersionListResult

ActorVersionListResult: Pick<PaginatedList<FinalActorVersion>, total | items>

AllowedHttpMethods

AllowedHttpMethods: GET | HEAD | POST | PUT | DELETE | TRACE | OPTIONS | CONNECT | PATCH

HTTP methods supported by Request Queue requests.

BuildCollectionClientListItem

BuildCollectionClientListItem: Required<Pick<Build, id | status | startedAt | finishedAt>> & Partial<Pick<Build, meta | usageTotalUsd>>

BuildCollectionClientListResult

BuildCollectionClientListResult: PaginatedList<BuildCollectionClientListItem>

DatasetCollectionClientListResult

DatasetCollectionClientListResult: PaginatedList<Dataset> & { unnamed: boolean }

Dictionary

Dictionary<T>: Record<PropertyKey, T>

Generic dictionary type (key-value map).

Type parameters

  • T = unknown

    The type of values in the dictionary

Added in 2.0.4

FinalActorVersion

FinalActorVersion: ActorVersion & Required<Pick<ActorVersion, versionNumber | buildTag>>

KeyValueStoreCollectionListResult

KeyValueStoreCollectionListResult: PaginatedList<KeyValueStore> & { unnamed: boolean }

LimitsUpdateOptions

LimitsUpdateOptions: { maxMonthlyUsageUsd: number } | { dataRetentionDays: number }

Added in 2.10.0

RequestQueueClientGetRequestResult

RequestQueueClientGetRequestResult: Omit<RequestQueueClientListItem, retryCount>

RequestQueueClientRequestToDelete

RequestQueueClientRequestToDelete: Pick<RequestQueueClientRequestSchema, id> | Pick<RequestQueueClientRequestSchema, uniqueKey>

Added in 2.3.0

RequestQueueCollectionListResult

RequestQueueCollectionListResult: PaginatedList<RequestQueue> & { unnamed: boolean }

RequestQueueListRequestsFilter

RequestQueueListRequestsFilter: locked | pending

Added in 2.23.2

RequestQueueRequestsAsyncIterable

RequestQueueRequestsAsyncIterable<T>: AsyncIterable<T>

Type parameters

  • T

Added in 2.5.1

ReturnTypeFromOptions

ReturnTypeFromOptions<Options>: Options[stream] extends true ? Readable : Options[buffer] extends true ? Buffer : JsonValue

Helper type to determine the return type based on getRecord options.

Returns Readable if stream option is true, Buffer if buffer option is true, otherwise returns JsonValue.

Type parameters

Added in 2.0.6

ScheduleAction

ScheduleAction: ScheduleActionRunActor | ScheduleActionRunActorTask

Union type representing all possible scheduled actions.

ScheduleCreateOrUpdateData

ScheduleCreateOrUpdateData: Partial<Pick<Schedule, name | title | cronExpression | timezone | isEnabled | isExclusive | description | notifications> & { actions: DistributiveOptional<ScheduleAction, id>[] }>

Data for creating or updating a Schedule.

Added in 2.6.2

TaskList

TaskList: Omit<Task, options | input>

TaskStartOptions

TaskStartOptions: Omit<ActorStartOptions, contentType | forcePermissionLevel>

Options for starting a Task.

Similar to ActorStartOptions but without contentType (Task input is predefined) and forcePermissionLevel.

Added in 2.0.4

TaskUpdateData

TaskUpdateData: Partial<Pick<Task, name | title | description | options | input | actorStandby | isPublic>> & { publicConfig?: Omit<TaskPublicConfig, publishedAt> }

Fields that can be updated when modifying a Task.

WebhookCondition

WebhookCondition: WebhookAnyRunOfActorCondition | WebhookAnyRunOfActorTaskCondition | WebhookCertainRunCondition

Condition that determines when a webhook should be triggered.

WebhookEventType

WebhookEventType: typeof WEBHOOK_EVENT_TYPES[keyof typeof WEBHOOK_EVENT_TYPES]

Event types that can trigger webhooks.

WebhookUpdateData

WebhookUpdateData: Partial<Pick<Webhook, isAdHoc | condition | ignoreSslErrors | doNotRetry | requestUrl | payloadTemplate | shouldInterpolateStrings | isApifyIntegration | headersTemplate | description> & { eventTypes: readonly WebhookEventType[] }> & WebhookIdempotencyKey

Data for updating a webhook.

Page Options