apify-client 3.0.0-beta.8 → 3.0.0-rc.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -2
- package/dist/apify_api_error.d.ts +11 -26
- package/dist/apify_api_error.js +31 -22
- package/dist/apify_client.d.ts +125 -10
- package/dist/apify_client.js +133 -48
- package/dist/base/api_client.d.ts +7 -7
- package/dist/base/api_client.js +36 -24
- package/dist/base/resource_client.d.ts +21 -8
- package/dist/base/resource_client.js +67 -33
- package/dist/base/resource_collection_client.d.ts +12 -4
- package/dist/base/resource_collection_client.js +34 -11
- package/dist/body_parser.d.ts +3 -4
- package/dist/body_parser.js +19 -26
- package/dist/bundle.js +27 -22
- package/dist/bundle.js.map +1 -1
- package/dist/generated/api.d.ts +785 -290
- package/dist/generated/schemas.d.ts +720 -747
- package/dist/generated/schemas.js +166 -162
- package/dist/http_clients/axios.d.ts +60 -0
- package/dist/http_clients/axios.js +117 -0
- package/dist/http_clients/base.d.ts +331 -0
- package/dist/http_clients/base.js +563 -0
- package/dist/http_clients/index.d.ts +4 -0
- package/dist/http_clients/index.js +2 -0
- package/dist/http_compressors/base.d.ts +40 -0
- package/dist/http_compressors/base.js +9 -0
- package/dist/http_compressors/brotli.d.ts +33 -0
- package/dist/http_compressors/brotli.js +39 -0
- package/dist/http_compressors/gzip.d.ts +33 -0
- package/dist/http_compressors/gzip.js +39 -0
- package/dist/http_compressors/index.d.ts +6 -0
- package/dist/http_compressors/index.js +2 -0
- package/dist/http_compressors/resolve.d.ts +23 -0
- package/dist/http_compressors/resolve.js +27 -0
- package/dist/index.d.ts +4 -1
- package/dist/index.js +3 -1
- package/dist/invalid_response_body_error.d.ts +13 -0
- package/dist/invalid_response_body_error.js +17 -0
- package/dist/models.d.ts +162 -194
- package/dist/models.js +6 -4
- package/dist/resource_clients/actor.d.ts +74 -34
- package/dist/resource_clients/actor.js +87 -56
- package/dist/resource_clients/actor_collection.d.ts +18 -12
- package/dist/resource_clients/actor_collection.js +11 -3
- package/dist/resource_clients/actor_env_var.d.ts +11 -4
- package/dist/resource_clients/actor_env_var.js +16 -6
- package/dist/resource_clients/actor_env_var_collection.d.ts +9 -4
- package/dist/resource_clients/actor_env_var_collection.js +11 -4
- package/dist/resource_clients/actor_version.d.ts +20 -5
- package/dist/resource_clients/actor_version.js +19 -9
- package/dist/resource_clients/actor_version_collection.d.ts +11 -4
- package/dist/resource_clients/actor_version_collection.js +13 -4
- package/dist/resource_clients/build.d.ts +20 -7
- package/dist/resource_clients/build.js +35 -15
- package/dist/resource_clients/build_collection.d.ts +7 -5
- package/dist/resource_clients/build_collection.js +4 -1
- package/dist/resource_clients/dataset.d.ts +53 -35
- package/dist/resource_clients/dataset.js +105 -80
- package/dist/resource_clients/dataset_collection.d.ts +10 -6
- package/dist/resource_clients/dataset_collection.js +13 -2
- package/dist/resource_clients/key_value_store.d.ts +62 -20
- package/dist/resource_clients/key_value_store.js +78 -40
- package/dist/resource_clients/key_value_store_collection.d.ts +10 -6
- package/dist/resource_clients/key_value_store_collection.js +13 -2
- package/dist/resource_clients/log.d.ts +13 -20
- package/dist/resource_clients/log.js +141 -59
- package/dist/resource_clients/request_queue.d.ts +68 -31
- package/dist/resource_clients/request_queue.js +173 -91
- package/dist/resource_clients/request_queue_collection.d.ts +9 -5
- package/dist/resource_clients/request_queue_collection.js +9 -3
- package/dist/resource_clients/run.d.ts +119 -28
- package/dist/resource_clients/run.js +190 -49
- package/dist/resource_clients/run_collection.d.ts +5 -3
- package/dist/resource_clients/run_collection.js +4 -1
- package/dist/resource_clients/schedule.d.ts +16 -7
- package/dist/resource_clients/schedule.js +30 -22
- package/dist/resource_clients/schedule_collection.d.ts +6 -2
- package/dist/resource_clients/schedule_collection.js +9 -3
- package/dist/resource_clients/store_collection.d.ts +6 -4
- package/dist/resource_clients/store_collection.js +4 -1
- package/dist/resource_clients/task.d.ts +36 -13
- package/dist/resource_clients/task.js +79 -46
- package/dist/resource_clients/task_collection.d.ts +9 -5
- package/dist/resource_clients/task_collection.js +9 -3
- package/dist/resource_clients/user.d.ts +19 -10
- package/dist/resource_clients/user.js +42 -38
- package/dist/resource_clients/webhook.d.ts +17 -8
- package/dist/resource_clients/webhook.js +30 -22
- package/dist/resource_clients/webhook_collection.d.ts +8 -4
- package/dist/resource_clients/webhook_collection.js +9 -3
- package/dist/resource_clients/webhook_dispatch.d.ts +4 -1
- package/dist/resource_clients/webhook_dispatch.js +7 -2
- package/dist/resource_clients/webhook_dispatch_collection.d.ts +3 -1
- package/dist/resource_clients/webhook_dispatch_collection.js +4 -1
- package/dist/runtime/node.d.ts +6 -0
- package/dist/runtime/node.js +49 -0
- package/dist/runtime/types.d.ts +52 -0
- package/dist/runtime/types.js +1 -0
- package/dist/runtime/web.d.ts +5 -0
- package/dist/runtime/web.js +18 -0
- package/dist/schemas.d.ts +1 -1
- package/dist/schemas.js +1 -1
- package/dist/statistics.d.ts +1 -6
- package/dist/statistics.js +2 -2
- package/dist/timeouts.d.ts +84 -0
- package/dist/timeouts.js +37 -0
- package/dist/timezones.d.ts +1 -1
- package/dist/utils.d.ts +82 -45
- package/dist/utils.js +197 -146
- package/dist/wait_for_resources.d.ts +8 -0
- package/dist/wait_for_resources.js +39 -0
- package/package.json +32 -29
- package/dist/http_client.d.ts +0 -88
- package/dist/http_client.js +0 -255
- package/dist/interceptors.d.ts +0 -19
- package/dist/interceptors.js +0 -105
package/dist/models.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Public models adapted from the generated OpenAPI types in `./generated/api`.
|
|
3
3
|
*
|
|
4
|
+
* Each model takes the name of the spec schema it is declared on, as the Python client does.
|
|
5
|
+
*
|
|
4
6
|
* The generated file is never re-exported directly. Every type here is declared on top of a generated
|
|
5
7
|
* schema so the compiler reports drift, and the spec is adopted as-is wherever it is trustworthy. What
|
|
6
8
|
* remains is deliberately small, and each deviation falls into exactly one of five kinds, one block per
|
|
@@ -31,7 +33,7 @@ type Schemas = components['schemas'];
|
|
|
31
33
|
/**
|
|
32
34
|
* Event types that can trigger webhooks.
|
|
33
35
|
*
|
|
34
|
-
* Declared here rather than in `./resource_clients/webhook` so that both `
|
|
36
|
+
* Declared here rather than in `./resource_clients/webhook` so that both `WebhookResource` and
|
|
35
37
|
* `WebhookDispatch` can reference it without closing an import cycle. It is re-exported from there, so
|
|
36
38
|
* the public name and import path are unchanged.
|
|
37
39
|
*/
|
|
@@ -53,21 +55,21 @@ export declare enum WebhookDispatchStatus {
|
|
|
53
55
|
*
|
|
54
56
|
* Declared here, next to the other spec-derived types, and re-exported from `./apify_api_error`.
|
|
55
57
|
*/
|
|
56
|
-
export type
|
|
58
|
+
export type ErrorType = Schemas['ErrorType'];
|
|
57
59
|
/**
|
|
58
60
|
* Fields the API returns on a dataset that the OpenAPI spec does not describe yet.
|
|
59
61
|
*
|
|
60
62
|
* TODO: Remove once the spec covers them.
|
|
61
63
|
*/
|
|
62
|
-
export interface
|
|
64
|
+
export interface DatasetResourceSpecGaps {
|
|
63
65
|
title?: string;
|
|
64
66
|
username?: string;
|
|
65
67
|
}
|
|
66
|
-
export interface
|
|
68
|
+
export interface DatasetResourceRePointed {
|
|
67
69
|
stats?: DatasetStats;
|
|
68
70
|
generalAccess?: STORAGE_GENERAL_ACCESS | null;
|
|
69
71
|
}
|
|
70
|
-
export interface
|
|
72
|
+
export interface DatasetResourceSpecNarrowings {
|
|
71
73
|
consoleUrl?: string;
|
|
72
74
|
}
|
|
73
75
|
/**
|
|
@@ -76,7 +78,7 @@ export interface DatasetSpecNarrowings {
|
|
|
76
78
|
* Datasets store structured data as a sequence of items (records). Each item is a JSON object.
|
|
77
79
|
* Datasets are useful for storing results from web scraping, crawling, or data processing tasks.
|
|
78
80
|
*/
|
|
79
|
-
export interface
|
|
81
|
+
export interface DatasetResource extends Omit<Schemas['DatasetResource'], keyof DatasetResourceRePointed | keyof DatasetResourceSpecNarrowings>, DatasetResourceRePointed, DatasetResourceSpecNarrowings, DatasetResourceSpecGaps {
|
|
80
82
|
}
|
|
81
83
|
/**
|
|
82
84
|
* Fields the API returns in dataset stats that the OpenAPI spec does not describe yet.
|
|
@@ -99,7 +101,7 @@ export interface DatasetStatisticsRePointed {
|
|
|
99
101
|
* Statistics such as `min`, `max`, `nullCount` and `emptyCount` for each field of the dataset's
|
|
100
102
|
* [fields schema](https://docs.apify.com/platform/actors/development/actor-definition/dataset-schema/validation).
|
|
101
103
|
*/
|
|
102
|
-
fieldStatistics?: Record<string,
|
|
104
|
+
fieldStatistics?: Record<string, DatasetFieldStatistics> | null;
|
|
103
105
|
}
|
|
104
106
|
/**
|
|
105
107
|
* Statistical information about dataset fields.
|
|
@@ -113,7 +115,7 @@ export interface DatasetStatistics extends Omit<Schemas['DatasetStatistics'], ke
|
|
|
113
115
|
* Statistics for a single field in a dataset.
|
|
114
116
|
* @since Added in 2.11.2
|
|
115
117
|
*/
|
|
116
|
-
export interface
|
|
118
|
+
export interface DatasetFieldStatistics extends GeneratedDatasetFieldStatistics {
|
|
117
119
|
}
|
|
118
120
|
export interface WebhookDispatchWebhookSummaryRePointed {
|
|
119
121
|
condition?: WebhookCondition;
|
|
@@ -146,10 +148,10 @@ type GeneratedKeyValueStoreKey = Schemas['KeyValueStoreKey'];
|
|
|
146
148
|
*
|
|
147
149
|
* TODO: Remove once the spec covers them.
|
|
148
150
|
*/
|
|
149
|
-
export interface
|
|
151
|
+
export interface KeyValueStoreResourceSpecGaps {
|
|
150
152
|
title?: string;
|
|
151
153
|
}
|
|
152
|
-
export interface
|
|
154
|
+
export interface KeyValueStoreResourceRePointed {
|
|
153
155
|
stats?: KeyValueStoreStats;
|
|
154
156
|
generalAccess?: STORAGE_GENERAL_ACCESS | null;
|
|
155
157
|
}
|
|
@@ -159,23 +161,23 @@ export interface KeyValueStoreRePointed {
|
|
|
159
161
|
* Key-value stores are used to store arbitrary data records or files. Each record is identified
|
|
160
162
|
* by a unique key and can contain any data - JSON objects, strings, binary files, etc.
|
|
161
163
|
*/
|
|
162
|
-
export interface
|
|
164
|
+
export interface KeyValueStoreResource extends Omit<Schemas['KeyValueStoreResource'], keyof KeyValueStoreResourceRePointed>, KeyValueStoreResourceRePointed, KeyValueStoreResourceSpecGaps {
|
|
163
165
|
}
|
|
164
166
|
/** Statistics about Key-Value Store usage and storage. */
|
|
165
167
|
export interface KeyValueStoreStats extends GeneratedKeyValueStoreStats {
|
|
166
168
|
}
|
|
167
169
|
/** Metadata about a single key in a Key-Value Store. */
|
|
168
|
-
export interface
|
|
170
|
+
export interface KeyValueStoreKey extends GeneratedKeyValueStoreKey {
|
|
169
171
|
}
|
|
170
|
-
export interface
|
|
171
|
-
items:
|
|
172
|
+
export interface ListOfKeysRePointed {
|
|
173
|
+
items: KeyValueStoreKey[];
|
|
172
174
|
}
|
|
173
175
|
/**
|
|
174
176
|
* Result of listing keys in a Key-Value Store.
|
|
175
177
|
*
|
|
176
178
|
* Contains paginated list of keys with metadata and pagination information.
|
|
177
179
|
*/
|
|
178
|
-
export interface
|
|
180
|
+
export interface ListOfKeys extends Omit<Schemas['ListOfKeys'], keyof ListOfKeysRePointed>, ListOfKeysRePointed {
|
|
179
181
|
}
|
|
180
182
|
type GeneratedVersion = Schemas['Version'];
|
|
181
183
|
type GeneratedSourceCodeFile = Schemas['SourceCodeFile'];
|
|
@@ -196,10 +198,10 @@ export declare enum ActorSourceType {
|
|
|
196
198
|
SourceCode = "SOURCE_CODE"
|
|
197
199
|
}
|
|
198
200
|
/** An environment variable of an Actor version. */
|
|
199
|
-
export interface
|
|
201
|
+
export interface EnvVar extends GeneratedEnvVar {
|
|
200
202
|
}
|
|
201
203
|
/** A single file of an Actor version's source code. */
|
|
202
|
-
export interface
|
|
204
|
+
export interface SourceCodeFile extends GeneratedSourceCodeFile {
|
|
203
205
|
}
|
|
204
206
|
/**
|
|
205
207
|
* A folder in an Actor version's source code tree.
|
|
@@ -207,19 +209,19 @@ export interface ActorVersionSourceFile extends GeneratedSourceCodeFile {
|
|
|
207
209
|
* `sourceFiles` is a flat list that mixes files and folders, told apart by this shape's `folder` flag
|
|
208
210
|
* rather than by nesting.
|
|
209
211
|
*/
|
|
210
|
-
export interface
|
|
212
|
+
export interface SourceCodeFolder extends GeneratedSourceCodeFolder {
|
|
211
213
|
}
|
|
212
214
|
/**
|
|
213
215
|
* The four fields that hold a version's source location, exactly one of which applies per source
|
|
214
216
|
* type. The spec marks all of them optional on a single flat schema; each union variant below
|
|
215
217
|
* reinstates the one that its `sourceType` implies, as required.
|
|
216
218
|
*/
|
|
217
|
-
export type
|
|
218
|
-
export interface
|
|
219
|
-
envVars?:
|
|
219
|
+
export type VersionSourceLocation = 'sourceFiles' | 'gitRepoUrl' | 'tarballUrl' | 'gitHubGistUrl';
|
|
220
|
+
export interface VersionRePointed {
|
|
221
|
+
envVars?: EnvVar[] | null;
|
|
220
222
|
}
|
|
221
|
-
export interface
|
|
222
|
-
sourceType: ActorSourceType
|
|
223
|
+
export interface VersionClientNarrowings {
|
|
224
|
+
sourceType: `${ActorSourceType}`;
|
|
223
225
|
}
|
|
224
226
|
/**
|
|
225
227
|
* Fields every Actor version carries, whatever its source type.
|
|
@@ -228,38 +230,38 @@ export interface ActorVersionClientNarrowings {
|
|
|
228
230
|
* keeps a union discriminated on `sourceType` instead, because that narrows the source location down
|
|
229
231
|
* to the single field which applies -- so the four are dropped here and reinstated per variant.
|
|
230
232
|
*/
|
|
231
|
-
export interface
|
|
233
|
+
export interface BaseVersion<SourceType extends `${ActorSourceType}`> extends Omit<GeneratedVersion, keyof VersionClientNarrowings | keyof VersionRePointed | VersionSourceLocation>, VersionRePointed {
|
|
232
234
|
sourceType: SourceType;
|
|
233
235
|
}
|
|
234
236
|
/**
|
|
235
237
|
* An Actor version whose source code is stored on the Apify platform.
|
|
236
238
|
* @since Added in 2.6.1
|
|
237
239
|
*/
|
|
238
|
-
export interface
|
|
239
|
-
sourceFiles: (
|
|
240
|
+
export interface VersionSourceFiles extends BaseVersion<`${ActorSourceType.SourceFiles}`> {
|
|
241
|
+
sourceFiles: (SourceCodeFile | SourceCodeFolder)[];
|
|
240
242
|
}
|
|
241
243
|
/** An Actor version built from a Git repository. */
|
|
242
|
-
export interface
|
|
244
|
+
export interface VersionGitRepo extends BaseVersion<`${ActorSourceType.GitRepo}`> {
|
|
243
245
|
gitRepoUrl: NonNullable<GeneratedVersion['gitRepoUrl']>;
|
|
244
246
|
}
|
|
245
247
|
/** An Actor version built from a downloadable tarball or ZIP archive. */
|
|
246
|
-
export interface
|
|
248
|
+
export interface VersionTarball extends BaseVersion<`${ActorSourceType.Tarball}`> {
|
|
247
249
|
tarballUrl: NonNullable<GeneratedVersion['tarballUrl']>;
|
|
248
250
|
}
|
|
249
251
|
/** An Actor version built from a GitHub Gist. */
|
|
250
|
-
export interface
|
|
252
|
+
export interface VersionGitHubGist extends BaseVersion<`${ActorSourceType.GitHubGist}`> {
|
|
251
253
|
gitHubGistUrl: NonNullable<GeneratedVersion['gitHubGistUrl']>;
|
|
252
254
|
}
|
|
253
255
|
/**
|
|
254
256
|
* An Actor version whose source is a single inline script.
|
|
255
257
|
*
|
|
256
|
-
* It carries no source location of its own, so it adds nothing to `
|
|
258
|
+
* It carries no source location of its own, so it adds nothing to `BaseVersion`; the variant
|
|
257
259
|
* exists so that `SOURCE_CODE`, which both the spec and `@apify/consts` list, is representable.
|
|
258
260
|
*/
|
|
259
|
-
export interface
|
|
261
|
+
export interface VersionSourceCode extends BaseVersion<`${ActorSourceType.SourceCode}`> {
|
|
260
262
|
}
|
|
261
263
|
/** A version of an Actor, discriminated on where its source code comes from. */
|
|
262
|
-
export type
|
|
264
|
+
export type Version = VersionSourceFiles | VersionGitRepo | VersionTarball | VersionGitHubGist | VersionSourceCode;
|
|
263
265
|
/**
|
|
264
266
|
* An Actor version as the API returns it, where the build tag is always set.
|
|
265
267
|
*
|
|
@@ -267,8 +269,8 @@ export type ActorVersion = ActorVersionSourceFiles | ActorVersionGitRepo | Actor
|
|
|
267
269
|
* `buildTag`, so a caller would still have to null-check a field this type promises is set. It is
|
|
268
270
|
* unwrapped with `NonNullable` instead.
|
|
269
271
|
*/
|
|
270
|
-
export type
|
|
271
|
-
buildTag: NonNullable<
|
|
272
|
+
export type FinalVersion = Version & {
|
|
273
|
+
buildTag: NonNullable<Version['buildTag']>;
|
|
272
274
|
};
|
|
273
275
|
type GeneratedActorStats = Schemas['ActorStats'];
|
|
274
276
|
type GeneratedActorStandby = Schemas['ActorStandby'];
|
|
@@ -288,18 +290,18 @@ export interface ActorStats extends GeneratedActorStats {
|
|
|
288
290
|
export interface ActorStandby extends GeneratedActorStandby {
|
|
289
291
|
}
|
|
290
292
|
/** Example input data to demonstrate Actor usage. */
|
|
291
|
-
export interface
|
|
293
|
+
export interface ExampleRunInput extends GeneratedExampleRunInput {
|
|
292
294
|
}
|
|
293
295
|
/** Information about a specific tagged build. */
|
|
294
|
-
export interface
|
|
296
|
+
export interface TaggedBuildInfo extends GeneratedTaggedBuildInfo {
|
|
295
297
|
}
|
|
296
298
|
/** Mapping of build tags (e.g. 'latest', 'beta') to their corresponding build information. */
|
|
297
|
-
export type
|
|
298
|
-
export interface
|
|
299
|
+
export type TaggedBuilds = Record<string, TaggedBuildInfo | null>;
|
|
300
|
+
export interface DefaultRunOptionsRePointed {
|
|
299
301
|
forcePermissionLevel?: ACTOR_PERMISSION_LEVEL | null;
|
|
300
302
|
}
|
|
301
303
|
/** Default configuration options for Actor runs. */
|
|
302
|
-
export interface
|
|
304
|
+
export interface DefaultRunOptions extends Omit<Schemas['DefaultRunOptions'], keyof DefaultRunOptionsRePointed>, DefaultRunOptionsRePointed {
|
|
303
305
|
}
|
|
304
306
|
/**
|
|
305
307
|
* Fields of an Actor definition that the OpenAPI spec does not describe yet.
|
|
@@ -361,7 +363,7 @@ export interface PricePerDatasetItemActorPricingInfoRePointed {
|
|
|
361
363
|
*/
|
|
362
364
|
export interface PricePerDatasetItemActorPricingInfo extends Omit<Schemas['PricePerDatasetItemActorPricingInfo'], keyof PricePerDatasetItemActorPricingInfoRePointed>, PricePerDatasetItemActorPricingInfoRePointed {
|
|
363
365
|
}
|
|
364
|
-
export interface
|
|
366
|
+
export interface PayPerEventActorPricingInfoRePointed {
|
|
365
367
|
pricingPerEvent: {
|
|
366
368
|
actorChargeEvents?: ActorChargeEvents;
|
|
367
369
|
};
|
|
@@ -369,17 +371,16 @@ export interface PricePerEventActorPricingInfoRePointed {
|
|
|
369
371
|
/**
|
|
370
372
|
* Pricing information for pay-per-event Actors.
|
|
371
373
|
*
|
|
372
|
-
* These Actors charge based on specific events (e.g., emails sent, API calls made).
|
|
373
|
-
* this schema `PayPerEventActorPricingInfo`; the published name is kept as it is.
|
|
374
|
+
* These Actors charge based on specific events (e.g., emails sent, API calls made).
|
|
374
375
|
* @since Added in 2.11.1
|
|
375
376
|
*/
|
|
376
|
-
export interface
|
|
377
|
+
export interface PayPerEventActorPricingInfo extends Omit<Schemas['PayPerEventActorPricingInfo'], keyof PayPerEventActorPricingInfoRePointed>, PayPerEventActorPricingInfoRePointed {
|
|
377
378
|
}
|
|
378
379
|
/**
|
|
379
380
|
* Union type representing all possible Actor pricing models.
|
|
380
381
|
* @since Added in 2.11.1
|
|
381
382
|
*/
|
|
382
|
-
export type ActorRunPricingInfo =
|
|
383
|
+
export type ActorRunPricingInfo = PayPerEventActorPricingInfo | PricePerDatasetItemActorPricingInfo | FlatPricePerMonthActorPricingInfo | FreeActorPricingInfo;
|
|
383
384
|
/** One subscription tier's price per dataset item. */
|
|
384
385
|
export interface TieredPricingPerDatasetItemEntry extends GeneratedTieredPricingPerDatasetItemEntry {
|
|
385
386
|
}
|
|
@@ -404,17 +405,17 @@ export interface TieredPricingPerEvent {
|
|
|
404
405
|
*
|
|
405
406
|
* TODO: Remove once the spec covers them.
|
|
406
407
|
*/
|
|
407
|
-
export interface
|
|
408
|
+
export interface ActorResourceSpecGaps {
|
|
408
409
|
/** Whether the Actor can be run by anonymous users without authentication */
|
|
409
410
|
isAnonymouslyRunnable?: boolean;
|
|
410
411
|
}
|
|
411
|
-
export interface
|
|
412
|
+
export interface ActorResourceRePointed {
|
|
412
413
|
stats: ActorStats;
|
|
413
|
-
versions:
|
|
414
|
+
versions: Version[];
|
|
414
415
|
pricingInfos?: ActorRunPricingInfo[];
|
|
415
|
-
defaultRunOptions:
|
|
416
|
-
exampleRunInput?:
|
|
417
|
-
taggedBuilds?:
|
|
416
|
+
defaultRunOptions: DefaultRunOptions;
|
|
417
|
+
exampleRunInput?: ExampleRunInput | null;
|
|
418
|
+
taggedBuilds?: TaggedBuilds | null;
|
|
418
419
|
actorStandby?: ActorStandby | null;
|
|
419
420
|
actorPermissionLevel?: ACTOR_PERMISSION_LEVEL;
|
|
420
421
|
}
|
|
@@ -425,13 +426,13 @@ export interface ActorRePointed {
|
|
|
425
426
|
* data processing, automation, and more. Each Actor has versions, builds, and can be executed
|
|
426
427
|
* with different configurations.
|
|
427
428
|
*/
|
|
428
|
-
export interface
|
|
429
|
+
export interface ActorResource extends Omit<Schemas['ActorResource'], keyof ActorResourceRePointed>, ActorResourceRePointed, ActorResourceSpecGaps {
|
|
429
430
|
}
|
|
430
|
-
export interface
|
|
431
|
+
export interface ActorListItemRePointed {
|
|
431
432
|
stats?: ActorStats | null;
|
|
432
433
|
}
|
|
433
434
|
/** An Actor as it appears in a listing, which carries fewer fields than the full resource. */
|
|
434
|
-
export interface
|
|
435
|
+
export interface ActorListItem extends Omit<Schemas['ActorListItem'], keyof ActorListItemRePointed>, ActorListItemRePointed {
|
|
435
436
|
}
|
|
436
437
|
type GeneratedBuildUsage = Schemas['BuildUsage'];
|
|
437
438
|
type GeneratedBuildStats = Schemas['BuildStats'];
|
|
@@ -451,12 +452,8 @@ export interface BuildOptions extends GeneratedBuildOptions {
|
|
|
451
452
|
export interface BuildMetaRePointed {
|
|
452
453
|
origin: ValueOf<typeof META_ORIGINS>;
|
|
453
454
|
}
|
|
454
|
-
/**
|
|
455
|
-
|
|
456
|
-
*
|
|
457
|
-
* The spec names this schema `BuildsMeta`; the published name is kept as it is.
|
|
458
|
-
*/
|
|
459
|
-
export interface BuildMeta extends Omit<Schemas['BuildsMeta'], keyof BuildMetaRePointed>, BuildMetaRePointed {
|
|
455
|
+
/** Metadata about how a Build was initiated. */
|
|
456
|
+
export interface BuildMeta extends Omit<Schemas['BuildMeta'], keyof BuildMetaRePointed>, BuildMetaRePointed {
|
|
460
457
|
}
|
|
461
458
|
export interface BuildRePointed {
|
|
462
459
|
meta: BuildMeta;
|
|
@@ -475,37 +472,37 @@ export interface BuildRePointed {
|
|
|
475
472
|
*/
|
|
476
473
|
export interface Build extends Omit<Schemas['Build'], keyof BuildRePointed>, BuildRePointed {
|
|
477
474
|
}
|
|
478
|
-
export interface
|
|
475
|
+
export interface BuildListItemRePointed {
|
|
479
476
|
meta?: BuildMeta;
|
|
480
477
|
status: ValueOf<typeof ACTOR_JOB_STATUSES>;
|
|
481
478
|
}
|
|
482
479
|
/** A build as it appears in a listing, which carries fewer fields than the full resource. */
|
|
483
|
-
export interface
|
|
480
|
+
export interface BuildListItem extends Omit<Schemas['BuildListItem'], keyof BuildListItemRePointed>, BuildListItemRePointed {
|
|
484
481
|
}
|
|
485
482
|
type GeneratedRunUsage = Schemas['RunUsage'];
|
|
486
483
|
type GeneratedRunStats = Schemas['RunStats'];
|
|
487
484
|
type GeneratedRunOptions = Schemas['RunOptions'];
|
|
488
|
-
type
|
|
485
|
+
type GeneratedRunMetamorphEvent = Schemas['RunMetamorphEvent'];
|
|
489
486
|
type GeneratedRunStorageIds = NonNullable<Schemas['Run']['storageIds']>;
|
|
490
487
|
/**
|
|
491
488
|
* Resource usage metrics for an Actor run.
|
|
492
489
|
*
|
|
493
490
|
* All values represent the total consumption during the run's lifetime. The same shape doubles as the
|
|
494
|
-
* cost breakdown on `
|
|
495
|
-
*
|
|
491
|
+
* cost breakdown on `Run.usageUsd`, where the spec names it `RunUsageUsd`; the two are structurally
|
|
492
|
+
* identical, so the published type stays single.
|
|
496
493
|
* @since Added in 2.7.0
|
|
497
494
|
*/
|
|
498
|
-
export interface
|
|
495
|
+
export interface RunUsage extends GeneratedRunUsage {
|
|
499
496
|
}
|
|
500
497
|
/**
|
|
501
498
|
* Runtime statistics for an Actor run.
|
|
502
499
|
*
|
|
503
500
|
* Provides detailed metrics about resource consumption and performance during the run.
|
|
504
501
|
*/
|
|
505
|
-
export interface
|
|
502
|
+
export interface RunStats extends GeneratedRunStats {
|
|
506
503
|
}
|
|
507
504
|
/** A metamorph event that occurred during an Actor run. */
|
|
508
|
-
export interface
|
|
505
|
+
export interface RunMetamorphEvent extends GeneratedRunMetamorphEvent {
|
|
509
506
|
}
|
|
510
507
|
/**
|
|
511
508
|
* Aliased storage IDs associated with an Actor run, grouped by storage type.
|
|
@@ -516,18 +513,18 @@ export interface ActorRunMetamorph extends GeneratedMetamorph {
|
|
|
516
513
|
*/
|
|
517
514
|
export interface ActorRunStorageIds extends GeneratedRunStorageIds {
|
|
518
515
|
}
|
|
519
|
-
export interface
|
|
516
|
+
export interface RunMetaRePointed {
|
|
520
517
|
origin: ValueOf<typeof META_ORIGINS>;
|
|
521
518
|
}
|
|
522
519
|
/** Metadata about how an Actor run was initiated. */
|
|
523
|
-
export interface
|
|
520
|
+
export interface RunMeta extends Omit<Schemas['RunMeta'], keyof RunMetaRePointed>, RunMetaRePointed {
|
|
524
521
|
}
|
|
525
522
|
/**
|
|
526
523
|
* Fields the API returns in an Actor run's options that the OpenAPI spec does not describe yet.
|
|
527
524
|
*
|
|
528
525
|
* TODO: Remove once the spec covers it.
|
|
529
526
|
*/
|
|
530
|
-
export interface
|
|
527
|
+
export interface RunOptionsSpecGaps {
|
|
531
528
|
restartOnError?: boolean;
|
|
532
529
|
}
|
|
533
530
|
/**
|
|
@@ -535,30 +532,30 @@ export interface ActorRunOptionsSpecGaps {
|
|
|
535
532
|
*
|
|
536
533
|
* These are the actual options that were applied to the run (may differ from requested options).
|
|
537
534
|
*/
|
|
538
|
-
export interface
|
|
535
|
+
export interface RunOptions extends GeneratedRunOptions, RunOptionsSpecGaps {
|
|
539
536
|
}
|
|
540
|
-
export interface
|
|
541
|
-
meta:
|
|
537
|
+
export interface RunListItemRePointed {
|
|
538
|
+
meta: RunMeta;
|
|
542
539
|
status: ValueOf<typeof ACTOR_JOB_STATUSES>;
|
|
543
540
|
}
|
|
544
541
|
/**
|
|
545
542
|
* An Actor run as it appears in a listing, which carries fewer fields than the full resource.
|
|
546
543
|
* @since Added in 2.7.0
|
|
547
544
|
*/
|
|
548
|
-
export interface
|
|
545
|
+
export interface RunListItem extends Omit<Schemas['RunListItem'], keyof RunListItemRePointed>, RunListItemRePointed {
|
|
549
546
|
}
|
|
550
|
-
export interface
|
|
551
|
-
meta:
|
|
552
|
-
stats:
|
|
553
|
-
options:
|
|
554
|
-
usage?:
|
|
555
|
-
usageUsd?:
|
|
547
|
+
export interface RunRePointed {
|
|
548
|
+
meta: RunMeta;
|
|
549
|
+
stats: RunStats;
|
|
550
|
+
options: RunOptions;
|
|
551
|
+
usage?: RunUsage | null;
|
|
552
|
+
usageUsd?: RunUsage | null;
|
|
556
553
|
storageIds?: ActorRunStorageIds;
|
|
557
|
-
metamorphs?:
|
|
554
|
+
metamorphs?: RunMetamorphEvent[] | null;
|
|
558
555
|
pricingInfo?: ActorRunPricingInfo;
|
|
559
556
|
status: ValueOf<typeof ACTOR_JOB_STATUSES>;
|
|
560
557
|
}
|
|
561
|
-
export interface
|
|
558
|
+
export interface RunClientNarrowings {
|
|
562
559
|
generalAccess?: RUN_GENERAL_ACCESS | null;
|
|
563
560
|
}
|
|
564
561
|
/**
|
|
@@ -567,7 +564,7 @@ export interface ActorRunClientNarrowings {
|
|
|
567
564
|
* Represents a single execution of an Actor with all its configuration, status,
|
|
568
565
|
* and resource usage information.
|
|
569
566
|
*/
|
|
570
|
-
export interface
|
|
567
|
+
export interface Run extends Omit<Schemas['Run'], keyof RunRePointed | keyof RunClientNarrowings>, RunRePointed, RunClientNarrowings {
|
|
571
568
|
}
|
|
572
569
|
type GeneratedTaskStats = Schemas['TaskStats'];
|
|
573
570
|
type GeneratedTaskOptions = Schemas['TaskOptions'];
|
|
@@ -589,14 +586,6 @@ export interface TaskOptions extends GeneratedTaskOptions {
|
|
|
589
586
|
*/
|
|
590
587
|
export interface TaskPublicConfig extends GeneratedTaskPublicConfig {
|
|
591
588
|
}
|
|
592
|
-
/**
|
|
593
|
-
* Fields the API returns on a task that the OpenAPI spec does not describe yet.
|
|
594
|
-
*
|
|
595
|
-
* TODO: Remove once the spec covers it.
|
|
596
|
-
*/
|
|
597
|
-
export interface TaskSpecGaps {
|
|
598
|
-
description?: string;
|
|
599
|
-
}
|
|
600
589
|
export interface TaskRePointed {
|
|
601
590
|
stats?: TaskStats | null;
|
|
602
591
|
options?: TaskOptions | null;
|
|
@@ -610,44 +599,43 @@ export interface TaskRePointed {
|
|
|
610
599
|
* Tasks are saved Actor configurations with input and settings that can be executed
|
|
611
600
|
* repeatedly without having to specify the full input each time.
|
|
612
601
|
*/
|
|
613
|
-
export interface Task extends Omit<Schemas['Task'], keyof TaskRePointed>, TaskRePointed
|
|
602
|
+
export interface Task extends Omit<Schemas['Task'], keyof TaskRePointed>, TaskRePointed {
|
|
614
603
|
}
|
|
615
|
-
export interface
|
|
604
|
+
export interface TaskListItemRePointed {
|
|
616
605
|
stats?: TaskStats | null;
|
|
617
606
|
}
|
|
618
607
|
/**
|
|
619
608
|
* Fields the API returns on a listed task that the OpenAPI spec does not describe yet.
|
|
620
609
|
*
|
|
621
|
-
* `description` is deliberately not here, although
|
|
610
|
+
* `description` is deliberately not here, although the spec has it on the full `Task` resource: the
|
|
622
611
|
* list endpoint publishes a smaller set of fields, and that is one of the fields it leaves out.
|
|
623
612
|
*
|
|
624
613
|
* TODO: Remove once the spec covers it.
|
|
625
614
|
*/
|
|
626
|
-
export interface
|
|
615
|
+
export interface TaskListItemSpecGaps {
|
|
627
616
|
title?: string | null;
|
|
628
617
|
}
|
|
629
618
|
/** A task as it appears in a listing, which carries fewer fields than the full resource. */
|
|
630
|
-
export interface
|
|
619
|
+
export interface TaskListItem extends Omit<Schemas['TaskListItem'], keyof TaskListItemRePointed>, TaskListItemRePointed, TaskListItemSpecGaps {
|
|
631
620
|
}
|
|
632
|
-
export interface
|
|
621
|
+
export interface StoreActorRePointed {
|
|
633
622
|
stats: ActorStats;
|
|
634
|
-
currentPricingInfo?:
|
|
623
|
+
currentPricingInfo?: CurrentPricingInfo;
|
|
635
624
|
}
|
|
636
625
|
/**
|
|
637
626
|
* Pricing information as Apify Store reports it.
|
|
638
627
|
*
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
* and every price field is optional.
|
|
628
|
+
* It is a flat summary rather than one of the `ActorRunPricingInfo` variants, so `pricingModel` is a plain
|
|
629
|
+
* string and every price field is optional.
|
|
642
630
|
* @since Added in 2.7.2
|
|
643
631
|
*/
|
|
644
|
-
export interface
|
|
632
|
+
export interface CurrentPricingInfo extends GeneratedCurrentPricingInfo {
|
|
645
633
|
}
|
|
646
634
|
/**
|
|
647
635
|
* An Actor as it appears in Apify Store.
|
|
648
636
|
* @since Added in 2.7.2
|
|
649
637
|
*/
|
|
650
|
-
export interface
|
|
638
|
+
export interface StoreActor extends Omit<Schemas['StoreActor'], keyof StoreActorRePointed>, StoreActorRePointed {
|
|
651
639
|
}
|
|
652
640
|
type GeneratedWebhookStats = Schemas['WebhookStats'];
|
|
653
641
|
type GeneratedWebhookCondition = Schemas['WebhookCondition'];
|
|
@@ -684,25 +672,21 @@ export type WebhookCondition = WebhookAnyRunOfActorCondition | WebhookAnyRunOfAc
|
|
|
684
672
|
export interface WebhookLastDispatchRePointed {
|
|
685
673
|
status: WebhookDispatchStatus;
|
|
686
674
|
}
|
|
687
|
-
/**
|
|
688
|
-
|
|
689
|
-
*
|
|
690
|
-
* The spec names this schema `ExampleWebhookDispatch`.
|
|
691
|
-
*/
|
|
692
|
-
export interface WebhookLastDispatch extends Omit<Schemas['ExampleWebhookDispatch'], keyof WebhookLastDispatchRePointed>, WebhookLastDispatchRePointed {
|
|
675
|
+
/** The summary of a webhook's most recent dispatch that the webhook resource carries. */
|
|
676
|
+
export interface WebhookLastDispatch extends Omit<Schemas['WebhookLastDispatch'], keyof WebhookLastDispatchRePointed>, WebhookLastDispatchRePointed {
|
|
693
677
|
}
|
|
694
678
|
/**
|
|
695
679
|
* Fields the API returns on a webhook that the OpenAPI spec does not describe yet.
|
|
696
680
|
*
|
|
697
|
-
* The spec does carry `isApifyIntegration` on `
|
|
698
|
-
* from the full `
|
|
681
|
+
* The spec does carry `isApifyIntegration` on `WebhookListItem`, the listing shape, and simply omits it
|
|
682
|
+
* from the full `WebhookResource` schema.
|
|
699
683
|
*
|
|
700
684
|
* TODO: Remove once the spec covers it.
|
|
701
685
|
*/
|
|
702
|
-
export interface
|
|
686
|
+
export interface WebhookResourceSpecGaps {
|
|
703
687
|
isApifyIntegration?: boolean;
|
|
704
688
|
}
|
|
705
|
-
export interface
|
|
689
|
+
export interface WebhookResourceRePointed {
|
|
706
690
|
condition: WebhookCondition;
|
|
707
691
|
stats?: WebhookStats | null;
|
|
708
692
|
lastDispatch?: WebhookLastDispatch | null;
|
|
@@ -714,7 +698,7 @@ export interface WebhookRePointed {
|
|
|
714
698
|
* Webhooks send HTTP POST requests to specified URLs when certain events occur
|
|
715
699
|
* (e.g., Actor run succeeds, fails, or times out).
|
|
716
700
|
*/
|
|
717
|
-
export interface
|
|
701
|
+
export interface WebhookResource extends Omit<Schemas['WebhookResource'], keyof WebhookResourceRePointed>, WebhookResourceRePointed, WebhookResourceSpecGaps {
|
|
718
702
|
}
|
|
719
703
|
type GeneratedScheduleActionRunInput = Schemas['ScheduleActionRunInput'];
|
|
720
704
|
/**
|
|
@@ -729,34 +713,27 @@ export declare enum ScheduleActions {
|
|
|
729
713
|
RunActorTask = "RUN_ACTOR_TASK"
|
|
730
714
|
}
|
|
731
715
|
/** Input configuration for a scheduled Actor run. */
|
|
732
|
-
export interface
|
|
733
|
-
}
|
|
734
|
-
/**
|
|
735
|
-
* Run options for a scheduled Actor run.
|
|
736
|
-
*
|
|
737
|
-
* The spec reuses its `TaskOptions` schema here; the published name is kept as it is.
|
|
738
|
-
*/
|
|
739
|
-
export interface ScheduledActorRunOptions extends GeneratedTaskOptions {
|
|
716
|
+
export interface ScheduleActionRunInput extends GeneratedScheduleActionRunInput {
|
|
740
717
|
}
|
|
741
718
|
export interface ScheduleActionRunActorRePointed {
|
|
742
|
-
type: ScheduleActions.RunActor
|
|
743
|
-
runInput?:
|
|
744
|
-
runOptions?:
|
|
719
|
+
type: `${ScheduleActions.RunActor}`;
|
|
720
|
+
runInput?: ScheduleActionRunInput | null;
|
|
721
|
+
runOptions?: TaskOptions | null;
|
|
745
722
|
}
|
|
746
723
|
/** Scheduled action to run an Actor. */
|
|
747
724
|
export interface ScheduleActionRunActor extends Omit<Schemas['ScheduleActionRunActor'], keyof ScheduleActionRunActorRePointed>, ScheduleActionRunActorRePointed {
|
|
748
725
|
}
|
|
749
726
|
export interface ScheduleActionRunActorTaskRePointed {
|
|
750
|
-
type: ScheduleActions.RunActorTask
|
|
727
|
+
type: `${ScheduleActions.RunActorTask}`;
|
|
751
728
|
}
|
|
752
729
|
/** Scheduled action to run an Actor task. */
|
|
753
730
|
export interface ScheduleActionRunActorTask extends Omit<Schemas['ScheduleActionRunActorTask'], keyof ScheduleActionRunActorTaskRePointed>, ScheduleActionRunActorTaskRePointed {
|
|
754
731
|
}
|
|
755
732
|
/** Union type representing all possible scheduled actions. */
|
|
756
733
|
export type ScheduleAction = ScheduleActionRunActor | ScheduleActionRunActorTask;
|
|
757
|
-
type
|
|
734
|
+
type GeneratedScheduleLogEntry = Schemas['ScheduleLogEntry'];
|
|
758
735
|
/** One entry of a schedule's log: an invocation of the schedule and how it went. */
|
|
759
|
-
export interface
|
|
736
|
+
export interface ScheduleLogEntry extends GeneratedScheduleLogEntry {
|
|
760
737
|
}
|
|
761
738
|
export interface ScheduleRePointed {
|
|
762
739
|
actions: ScheduleAction[];
|
|
@@ -771,20 +748,20 @@ export interface ScheduleClientNarrowings {
|
|
|
771
748
|
*/
|
|
772
749
|
export interface Schedule extends Omit<Schemas['Schedule'], keyof ScheduleRePointed | keyof ScheduleClientNarrowings>, ScheduleRePointed, ScheduleClientNarrowings {
|
|
773
750
|
}
|
|
774
|
-
type
|
|
751
|
+
type GeneratedUserProfile = Schemas['UserProfile'];
|
|
775
752
|
type GeneratedProxyGroup = Schemas['ProxyGroup'];
|
|
776
753
|
type GeneratedEffectivePlatformFeature = Schemas['EffectivePlatformFeature'];
|
|
777
754
|
type GeneratedUsageCycle = Schemas['UsageCycle'];
|
|
778
|
-
type
|
|
755
|
+
type GeneratedPriceTier = Schemas['PriceTier'];
|
|
779
756
|
type GeneratedLimits = Schemas['Limits'];
|
|
780
|
-
type
|
|
757
|
+
type GeneratedCurrentUsage = Schemas['CurrentUsage'];
|
|
781
758
|
/**
|
|
782
759
|
* Platform features a plan can enable.
|
|
783
760
|
*
|
|
784
|
-
* This enum is not the element type of `UserPlan.enabledPlatformFeatures`, which the spec types
|
|
785
|
-
*
|
|
786
|
-
*
|
|
787
|
-
*
|
|
761
|
+
* This enum is not the element type of `UserPlan.enabledPlatformFeatures`, which the spec types as a plain
|
|
762
|
+
* `string[]`: the platform has features this list never gained -- `PROXY_RESIDENTIAL`, `ACTORS_PUBLIC_ALL`
|
|
763
|
+
* and `ACTORS_PUBLIC_DEVELOPER` all appear as keys of `EffectivePlatformFeatures` -- so using it there
|
|
764
|
+
* promised a completeness that was not real. It stays published for comparisons.
|
|
788
765
|
*
|
|
789
766
|
* Declared here rather than in `./resource_clients/user` so the user types can live alongside it. It is
|
|
790
767
|
* re-exported from there, so the public name and import path are unchanged.
|
|
@@ -799,13 +776,13 @@ export declare enum PlatformFeature {
|
|
|
799
776
|
ProxyExternalAccess = "PROXY_EXTERNAL_ACCESS"
|
|
800
777
|
}
|
|
801
778
|
/** The public part of a user's profile. */
|
|
802
|
-
export interface UserProfile extends
|
|
779
|
+
export interface UserProfile extends GeneratedUserProfile {
|
|
803
780
|
}
|
|
804
|
-
export interface
|
|
781
|
+
export interface ProxyResourceRePointed {
|
|
805
782
|
groups: ProxyGroup[];
|
|
806
783
|
}
|
|
807
784
|
/** A user's proxy credentials and the groups they may use. */
|
|
808
|
-
export interface
|
|
785
|
+
export interface ProxyResource extends Omit<Schemas['ProxyResource'], keyof ProxyResourceRePointed>, ProxyResourceRePointed {
|
|
809
786
|
}
|
|
810
787
|
/** One proxy group available to a user. */
|
|
811
788
|
export interface ProxyGroup extends GeneratedProxyGroup {
|
|
@@ -832,11 +809,11 @@ export interface UserPlanRePointed {
|
|
|
832
809
|
availableProxyGroups: Record<string, number>;
|
|
833
810
|
}
|
|
834
811
|
/** The subscription plan a user is on, with the quotas it grants. */
|
|
835
|
-
export interface UserPlan extends Omit<Schemas['
|
|
812
|
+
export interface UserPlan extends Omit<Schemas['UserPlan'], keyof UserPlanRePointed>, UserPlanRePointed {
|
|
836
813
|
}
|
|
837
|
-
export interface
|
|
814
|
+
export interface UserPrivateInfoRePointed {
|
|
838
815
|
profile?: UserProfile;
|
|
839
|
-
proxy?:
|
|
816
|
+
proxy?: ProxyResource;
|
|
840
817
|
plan?: UserPlan;
|
|
841
818
|
effectivePlatformFeatures?: EffectivePlatformFeatures;
|
|
842
819
|
}
|
|
@@ -846,7 +823,7 @@ export interface UserRePointed {
|
|
|
846
823
|
* The private fields are only populated for `GET /v2/users/me`, which needs a token; the public
|
|
847
824
|
* endpoint returns the username and profile alone.
|
|
848
825
|
*/
|
|
849
|
-
export interface
|
|
826
|
+
export interface UserPrivateInfo extends Omit<Schemas['UserPrivateInfo'], keyof UserPrivateInfoRePointed>, UserPrivateInfoRePointed {
|
|
850
827
|
}
|
|
851
828
|
/**
|
|
852
829
|
* The start and end of a billing cycle.
|
|
@@ -854,14 +831,8 @@ export interface User extends Omit<Schemas['UserPrivateInfo'], keyof UserRePoint
|
|
|
854
831
|
*/
|
|
855
832
|
export interface UsageCycle extends GeneratedUsageCycle {
|
|
856
833
|
}
|
|
857
|
-
/**
|
|
858
|
-
|
|
859
|
-
* @since Added in 2.9.2
|
|
860
|
-
*/
|
|
861
|
-
export interface MonthlyUsageCycle extends GeneratedUsageCycle {
|
|
862
|
-
}
|
|
863
|
-
/** One tier of a volume-discounted price. The spec names this schema `PriceTiers`. */
|
|
864
|
-
export interface PriceTier extends GeneratedPriceTiers {
|
|
834
|
+
/** One tier of a volume-discounted price. */
|
|
835
|
+
export interface PriceTier extends GeneratedPriceTier {
|
|
865
836
|
}
|
|
866
837
|
export interface UsageItemRePointed {
|
|
867
838
|
priceTiers?: PriceTier[];
|
|
@@ -881,8 +852,8 @@ export interface ServiceUsage {
|
|
|
881
852
|
export interface DailyServiceUsageRePointed {
|
|
882
853
|
serviceUsage: ServiceUsage;
|
|
883
854
|
}
|
|
884
|
-
/** A single day's usage within a monthly cycle.
|
|
885
|
-
export interface DailyServiceUsage extends Omit<Schemas['
|
|
855
|
+
/** A single day's usage within a monthly cycle. */
|
|
856
|
+
export interface DailyServiceUsage extends Omit<Schemas['DailyServiceUsage'], keyof DailyServiceUsageRePointed>, DailyServiceUsageRePointed {
|
|
886
857
|
}
|
|
887
858
|
export interface MonthlyUsageRePointed {
|
|
888
859
|
usageCycle: UsageCycle;
|
|
@@ -905,51 +876,50 @@ export interface Limits extends GeneratedLimits {
|
|
|
905
876
|
* How much of each quota a user has consumed in the current cycle.
|
|
906
877
|
* @since Added in 2.9.2
|
|
907
878
|
*/
|
|
908
|
-
export interface
|
|
879
|
+
export interface CurrentUsage extends GeneratedCurrentUsage {
|
|
909
880
|
}
|
|
910
|
-
export interface
|
|
911
|
-
monthlyUsageCycle:
|
|
881
|
+
export interface AccountLimitsRePointed {
|
|
882
|
+
monthlyUsageCycle: UsageCycle;
|
|
912
883
|
limits: Limits;
|
|
913
|
-
current:
|
|
884
|
+
current: CurrentUsage;
|
|
914
885
|
}
|
|
915
886
|
/**
|
|
916
887
|
* A user's quotas together with their current consumption.
|
|
917
888
|
* @since Added in 2.9.2
|
|
918
889
|
*/
|
|
919
|
-
export interface
|
|
890
|
+
export interface AccountLimits extends Omit<Schemas['AccountLimits'], keyof AccountLimitsRePointed>, AccountLimitsRePointed {
|
|
920
891
|
}
|
|
921
892
|
type GeneratedRequestQueueStats = Schemas['RequestQueueStats'];
|
|
922
|
-
type
|
|
923
|
-
type
|
|
893
|
+
type GeneratedRequestQueueHeadItem = Schemas['RequestQueueHeadItem'];
|
|
894
|
+
type GeneratedLockedRequestQueueHeadItem = Schemas['LockedRequestQueueHeadItem'];
|
|
924
895
|
type GeneratedRequestRegistration = Schemas['RequestRegistration'];
|
|
925
896
|
type GeneratedRequestLockInfo = Schemas['RequestLockInfo'];
|
|
926
897
|
type GeneratedUnlockRequestsResult = Schemas['UnlockRequestsResult'];
|
|
927
898
|
type GeneratedBatchAddResult = Schemas['BatchAddResult'];
|
|
928
899
|
type GeneratedBatchDeleteResult = Schemas['BatchDeleteResult'];
|
|
929
|
-
type
|
|
930
|
-
/** HTTP methods
|
|
931
|
-
export type
|
|
900
|
+
type GeneratedRequestResource = Schemas['RequestResource'];
|
|
901
|
+
/** HTTP methods the API specification lists: a request queue request's `method`, and what the HTTP client sends. */
|
|
902
|
+
export type HttpMethod = Schemas['HttpMethod'];
|
|
932
903
|
/** Statistics about Request Queue usage and storage. */
|
|
933
904
|
export interface RequestQueueStats extends GeneratedRequestQueueStats {
|
|
934
905
|
}
|
|
935
906
|
/**
|
|
936
907
|
* Fields the API returns on a request queue that the OpenAPI spec does not describe yet.
|
|
937
908
|
*
|
|
938
|
-
* The spec does carry `username`
|
|
939
|
-
*
|
|
909
|
+
* The spec does carry `username` on `RequestQueueListItem`, the listing shape, and simply omits it from the
|
|
910
|
+
* full `RequestQueueResource` schema. `title` is absent from either.
|
|
940
911
|
*
|
|
941
912
|
* TODO: Remove once the spec covers them.
|
|
942
913
|
*/
|
|
943
|
-
export interface
|
|
914
|
+
export interface RequestQueueResourceSpecGaps {
|
|
944
915
|
title?: string;
|
|
945
916
|
username?: string;
|
|
946
|
-
expireAt?: Date;
|
|
947
917
|
}
|
|
948
|
-
export interface
|
|
918
|
+
export interface RequestQueueResourceRePointed {
|
|
949
919
|
stats?: RequestQueueStats;
|
|
950
920
|
generalAccess?: STORAGE_GENERAL_ACCESS | null;
|
|
951
921
|
}
|
|
952
|
-
export interface
|
|
922
|
+
export interface RequestQueueResourceSpecNarrowings {
|
|
953
923
|
consoleUrl?: string;
|
|
954
924
|
}
|
|
955
925
|
/**
|
|
@@ -958,80 +928,78 @@ export interface RequestQueueSpecNarrowings {
|
|
|
958
928
|
* Request queues store URLs (requests) to be processed by web crawlers. They provide
|
|
959
929
|
* automatic deduplication, request locking for parallel processing, and persistence.
|
|
960
930
|
*/
|
|
961
|
-
export interface
|
|
931
|
+
export interface RequestQueueResource extends Omit<Schemas['RequestQueueResource'], keyof RequestQueueResourceRePointed | keyof RequestQueueResourceSpecNarrowings>, RequestQueueResourceRePointed, RequestQueueResourceSpecNarrowings, RequestQueueResourceSpecGaps {
|
|
962
932
|
}
|
|
963
933
|
/** Simplified request information used in queue-head results. */
|
|
964
|
-
export interface
|
|
934
|
+
export interface RequestQueueHeadItem extends GeneratedRequestQueueHeadItem {
|
|
965
935
|
}
|
|
966
936
|
/** A queue-head request that has been locked for processing, so it also reports its lock expiry. */
|
|
967
|
-
export interface
|
|
937
|
+
export interface LockedRequestQueueHeadItem extends GeneratedLockedRequestQueueHeadItem {
|
|
968
938
|
}
|
|
969
|
-
export interface
|
|
970
|
-
items:
|
|
939
|
+
export interface RequestQueueHeadRePointed {
|
|
940
|
+
items: RequestQueueHeadItem[];
|
|
971
941
|
}
|
|
972
942
|
/** Result of listing requests from the queue head. */
|
|
973
|
-
export interface
|
|
943
|
+
export interface RequestQueueHead extends Omit<Schemas['RequestQueueHead'], keyof RequestQueueHeadRePointed>, RequestQueueHeadRePointed {
|
|
974
944
|
}
|
|
975
|
-
export interface
|
|
976
|
-
items:
|
|
945
|
+
export interface LockedRequestQueueHeadRePointed {
|
|
946
|
+
items: LockedRequestQueueHeadItem[];
|
|
977
947
|
}
|
|
978
948
|
/**
|
|
979
949
|
* Result of listing and locking requests from the queue head.
|
|
980
950
|
*
|
|
981
|
-
* The spec describes this and {@link
|
|
982
|
-
*
|
|
983
|
-
* so both are derived independently.
|
|
951
|
+
* The spec describes this and {@link RequestQueueHead} as separate schemas that disagree about which fields
|
|
952
|
+
* are required, and the locked variant carries a different element type, so both are derived independently.
|
|
984
953
|
* @since Added in 2.4.1
|
|
985
954
|
*/
|
|
986
|
-
export interface
|
|
955
|
+
export interface LockedRequestQueueHead extends Omit<Schemas['LockedRequestQueueHead'], keyof LockedRequestQueueHeadRePointed>, LockedRequestQueueHeadRePointed {
|
|
987
956
|
}
|
|
988
957
|
/**
|
|
989
958
|
* Complete schema for a request in the queue.
|
|
990
959
|
*
|
|
991
960
|
* Represents a URL to be crawled along with its metadata, retry information, and custom data.
|
|
992
961
|
*/
|
|
993
|
-
export interface
|
|
962
|
+
export interface RequestResource extends GeneratedRequestResource {
|
|
994
963
|
}
|
|
995
964
|
/**
|
|
996
965
|
* A request as the caller submits it to the queue.
|
|
997
966
|
*
|
|
998
967
|
* The API assigns the id, so it is dropped. The unique key and the URL the caller has to supply come
|
|
999
|
-
* required from {@link
|
|
968
|
+
* required from {@link RequestResource}.
|
|
1000
969
|
*/
|
|
1001
|
-
export interface RequestQueueClientRequestToAdd extends Omit<
|
|
970
|
+
export interface RequestQueueClientRequestToAdd extends Omit<RequestResource, 'id'> {
|
|
1002
971
|
}
|
|
1003
972
|
/**
|
|
1004
973
|
* A request as the caller submits it to an update of a stored one.
|
|
1005
974
|
*
|
|
1006
975
|
* The update addresses that request by its id, which a stored request always carries, so the shape is
|
|
1007
|
-
* {@link
|
|
1008
|
-
* `updateRequest()`.
|
|
976
|
+
* {@link RequestResource} unchanged. The name stays published as the argument type of `updateRequest()`.
|
|
1009
977
|
*/
|
|
1010
|
-
export interface RequestQueueClientRequestToUpdate extends
|
|
978
|
+
export interface RequestQueueClientRequestToUpdate extends RequestResource {
|
|
1011
979
|
}
|
|
1012
|
-
export interface
|
|
1013
|
-
items:
|
|
980
|
+
export interface ListOfRequestsRePointed {
|
|
981
|
+
items: RequestResource[];
|
|
1014
982
|
}
|
|
1015
983
|
/**
|
|
1016
984
|
* Result of listing all requests in the queue.
|
|
1017
985
|
* @since Added in 2.5.1
|
|
1018
986
|
*/
|
|
1019
|
-
export interface
|
|
987
|
+
export interface ListOfRequests extends Omit<Schemas['ListOfRequests'], keyof ListOfRequestsRePointed>, ListOfRequestsRePointed {
|
|
1020
988
|
}
|
|
1021
989
|
/** Result of adding a request to the queue. */
|
|
1022
|
-
export interface
|
|
990
|
+
export interface RequestRegistration extends GeneratedRequestRegistration {
|
|
1023
991
|
}
|
|
1024
992
|
/**
|
|
1025
993
|
* Result of prolonging a request lock.
|
|
1026
994
|
* @since Added in 2.4.1
|
|
1027
995
|
*/
|
|
1028
|
-
export interface
|
|
996
|
+
export interface RequestLockInfo extends GeneratedRequestLockInfo {
|
|
1029
997
|
}
|
|
1030
998
|
/**
|
|
1031
999
|
* Result of unlocking requests in the queue.
|
|
1032
1000
|
* @since Added in 2.12.5
|
|
1033
1001
|
*/
|
|
1034
|
-
export interface
|
|
1002
|
+
export interface UnlockRequestsResult extends GeneratedUnlockRequestsResult {
|
|
1035
1003
|
}
|
|
1036
1004
|
/**
|
|
1037
1005
|
* Result of a batch add operation on requests.
|
|
@@ -1039,7 +1007,7 @@ export interface RequestQueueClientUnlockRequestsResult extends GeneratedUnlockR
|
|
|
1039
1007
|
* Contains lists of successfully processed and unprocessed requests.
|
|
1040
1008
|
* @since Added in 2.3.0
|
|
1041
1009
|
*/
|
|
1042
|
-
export interface
|
|
1010
|
+
export interface BatchAddResult extends GeneratedBatchAddResult {
|
|
1043
1011
|
}
|
|
1044
1012
|
/**
|
|
1045
1013
|
* Result of a batch delete operation on requests.
|
|
@@ -1048,6 +1016,6 @@ export interface RequestQueueClientBatchRequestsOperationResult extends Generate
|
|
|
1048
1016
|
* and `uniqueKey` rather than the `requestId`, `wasAlreadyPresent` and `wasAlreadyHandled` that a batch
|
|
1049
1017
|
* add reports.
|
|
1050
1018
|
*/
|
|
1051
|
-
export interface
|
|
1019
|
+
export interface BatchDeleteResult extends GeneratedBatchDeleteResult {
|
|
1052
1020
|
}
|
|
1053
1021
|
export {};
|