Skip to main content
Version: Next

apify-client

Index

Enumerations

Classes

Interfaces

Type Aliases

Type Aliases

ActorCollectionListResult

ActorCollectionListResult: PaginatedList<ActorCollectionListItem>

ActorTaggedBuilds

ActorTaggedBuilds: Record<string, ActorTaggedBuild>

ActorUpdateOptions

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

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 }

LimitsUpdateOptions

LimitsUpdateOptions: Pick<Limits, maxMonthlyUsageUsd | dataRetentionDays>

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

RunChargeOptions

RunChargeOptions: { count?: number; eventName: string; idempotencyKey?: string }

Type declaration

  • optionalcount?: number

    Defaults to 1

  • eventName: string

    Name of the event to charge. Must be defined in the Actor's pricing info else the API will throw.

  • optionalidempotencyKey?: string

    Defaults to runId-eventName-timestamp

ScheduleAction

ScheduleAction: ScheduleActionRunActor | ScheduleActionRunActorTask

ScheduleCreateOrUpdateData

ScheduleCreateOrUpdateData: Partial<Pick<Schedule, name | title | cronExpression | timezone | isEnabled | isExclusive | description | notifications> & { 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 | actorStandby>>

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
Page Options