apify-client

Index

Classes

• ActorClient
• ActorCollectionClient
• ApifyApiError
• ApifyClient
• BuildClient
• BuildCollectionClient
• DatasetClient
• DatasetCollectionClient
• InvalidResponseBodyError
• KeyValueStoreClient
• KeyValueStoreCollectionClient
• LogClient
• RequestQueueClient
• RequestQueueCollectionClient
• RunClient
• RunCollectionClient
• ScheduleClient
• ScheduleCollectionClient
• StoreCollectionClient
• TaskClient
• TaskCollectionClient
• UserClient
• WebhookClient
• WebhookCollectionClient
• WebhookDispatchClient
• WebhookDispatchCollectionClient

Enumerations

• DownloadItemsFormat
• PlatformFeature
• ScheduleActions
• WebhookDispatchStatus

Interfaces

• AccountAndUsageLimits
• Actor
• ActorBuildOptions
• ActorCallOptions
• ActorCollectionCreateOptions
• ActorCollectionListItem
• ActorCollectionListOptions
• ActorDefaultRunOptions
• ActorExampleRunInput
• ActorLastRunOptions
• ActorRun
• ActorRunListItem
• ActorRunMeta
• ActorRunOptions
• ActorRunStats
• ActorRunUsage
• ActorStartOptions
• ActorStats
• ActorStoreList
• ActorTaggedBuild
• ActorTaggedBuilds
• ApifyClientOptions
• Build
• BuildClientGetOptions
• BuildClientWaitForFinishOptions
• BuildCollectionClientListOptions
• BuildMeta
• BuildOptions
• BuildStats
• BuildUsage
• Current
• Dataset
• DatasetClientDownloadItemsOptions
• DatasetClientListItemOptions
• DatasetClientUpdateOptions
• DatasetCollectionClientGetOrCreateOptions
• DatasetCollectionClientListOptions
• DatasetStats
• KeyValueClientGetRecordOptions
• KeyValueClientListKeysOptions
• KeyValueClientListKeysResult
• KeyValueClientUpdateOptions
• KeyValueListItem
• KeyValueStore
• KeyValueStoreCollectionClientGetOrCreateOptions
• KeyValueStoreCollectionClientListOptions
• KeyValueStoreRecord
• KeyValueStoreStats
• Limits
• MonthlyUsage
• MonthlyUsageCycle
• PaginatedList
• PricingInfo
• ProxyGroup
• RequestQueue
• RequestQueueClientAddRequestOptions
• RequestQueueClientAddRequestResult
• RequestQueueClientBatchAddRequestWithRetriesOptions
• RequestQueueClientBatchRequestsOperationResult
• RequestQueueClientDeleteRequestLockOptions
• RequestQueueClientListAndLockHeadOptions
• RequestQueueClientListAndLockHeadResult
• RequestQueueClientListHeadOptions
• RequestQueueClientListHeadResult
• RequestQueueClientListItem
• RequestQueueClientListRequestsOptions
• RequestQueueClientListRequestsResult
• RequestQueueClientPaginateRequestsOptions
• RequestQueueClientProlongRequestLockOptions
• RequestQueueClientProlongRequestLockResult
• RequestQueueClientRequestSchema
• RequestQueueClientUpdateOptions
• RequestQueueCollectionListOptions
• RequestQueueStats
• RequestQueueUserOptions
• RunAbortOptions
• RunCollectionListOptions
• RunGetOptions
• RunMetamorphOptions
• RunResurrectOptions
• RunUpdateOptions
• RunWaitForFinishOptions
• Schedule
• ScheduleActionRunActor
• ScheduleActionRunActorTask
• ScheduleCollectionListOptions
• ScheduledActorRunInput
• ScheduledActorRunOptions
• StoreCollectionListOptions
• Task
• TaskCallOptions
• TaskCollectionListOptions
• TaskCreateData
• TaskLastRunOptions
• TaskOptions
• TaskStats
• UsageCycle
• User
• UserPlan
• UserProxy
• Webhook
• WebhookAnyRunOfActorCondition
• WebhookAnyRunOfActorTaskCondition
• WebhookCertainRunCondition
• WebhookCollectionListOptions
• WebhookDispatch
• WebhookDispatchCall
• WebhookDispatchCollectionListOptions
• WebhookIdempotencyKey
• WebhookStats

Type Aliases

• ActorCollectionListResult
• ActorUpdateOptions
• AllowedHttpMethods
• BuildCollectionClientListItem
• BuildCollectionClientListResult
• DatasetCollectionClientListResult
• Dictionary
• KeyValueStoreCollectionListResult
• RequestQueueClientGetRequestResult
• RequestQueueClientRequestToDelete
• RequestQueueCollectionListResult
• RequestQueueRequestsAsyncIterable
• ReturnTypeFromOptions
• ScheduleAction
• ScheduleCreateOrUpdateData
• TaskList
• TaskStartOptions
• TaskUpdateData
• WebhookCondition
• WebhookEventType
• WebhookUpdateData

Type Aliases

ActorCollectionListResult

ActorCollectionListResult: PaginatedList<ActorCollectionListItem>

ActorUpdateOptions

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

AllowedHttpMethods

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

BuildCollectionClientListItem

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

BuildCollectionClientListResult

BuildCollectionClientListResult: PaginatedList<BuildCollectionClientListItem>

DatasetCollectionClientListResult

DatasetCollectionClientListResult: PaginatedList<Dataset>

Dictionary

Dictionary<T>: Record<PropertyKey, T>

Type parameters

• T = unknown

KeyValueStoreCollectionListResult

KeyValueStoreCollectionListResult: Omit<KeyValueStore, stats> & { username?: string }

RequestQueueClientGetRequestResult

RequestQueueClientGetRequestResult: Omit<RequestQueueClientListItem, retryCount>

RequestQueueClientRequestToDelete

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

RequestQueueCollectionListResult

RequestQueueCollectionListResult: PaginatedList<RequestQueue & { username?: string }> & { unnamed: boolean }

RequestQueueRequestsAsyncIterable

RequestQueueRequestsAsyncIterable<T>: AsyncIterable<T>

Type parameters

• T

ReturnTypeFromOptions

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

Type parameters

• Options: KeyValueClientGetRecordOptions

ScheduleAction

ScheduleAction: ScheduleActionRunActor | ScheduleActionRunActorTask

ScheduleCreateOrUpdateData

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

TaskList

TaskList: Omit<Task, options | input>

TaskStartOptions

TaskStartOptions: Omit<ActorStartOptions, contentType>

TaskUpdateData

TaskUpdateData: Partial<Pick<Task, name | title | description | options | input>>

WebhookCondition

WebhookCondition: WebhookAnyRunOfActorCondition | WebhookAnyRunOfActorTaskCondition | WebhookCertainRunCondition

WebhookEventType

WebhookEventType: typeof WEBHOOK_EVENT_TYPES[keyof typeof WEBHOOK_EVENT_TYPES]

WebhookUpdateData

WebhookUpdateData: Partial<Pick<Webhook, isAdHoc | eventTypes | condition | ignoreSslErrors | doNotRetry | requestUrl | payloadTemplate | shouldInterpolateStrings | isApifyIntegration | headersTemplate | description>> & WebhookIdempotencyKey