@sokol111/ecommerce-image-service-api 1.0.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/dist/api.d.ts +1325 -0
- package/dist/api.js +1095 -0
- package/dist/base.d.ts +66 -0
- package/dist/base.js +60 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +149 -0
- package/dist/configuration.d.ts +91 -0
- package/dist/configuration.js +40 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +15 -0
- package/package.json +31 -0
package/dist/api.d.ts
ADDED
|
@@ -0,0 +1,1325 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Image Service API
|
|
3
|
+
* API for image management in an e-commerce system using the **Draft → Promote** pattern. Responsibilities: - Generate presigned URLs for direct PUT uploads to MinIO/S3. - Confirm uploads and persist image metadata to the database. - Promote/attach images from a product draft to a final product. - Read/update/delete image metadata. - Generate signed delivery URLs for imgproxy. Notes: - No authentication is configured yet (public API for now). Add auth later when ready. - Idempotency is supported via the `Idempotency-Key` header for POST/DELETE operations.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import type { RequestArgs } from './base';
|
|
15
|
+
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ConfirmRequest
|
|
20
|
+
*/
|
|
21
|
+
export interface ConfirmRequest {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @type {OwnerType}
|
|
25
|
+
* @memberof ConfirmRequest
|
|
26
|
+
*/
|
|
27
|
+
'ownerType': OwnerType;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof ConfirmRequest
|
|
32
|
+
*/
|
|
33
|
+
'ownerId': string;
|
|
34
|
+
/**
|
|
35
|
+
* S3 key that was used for PUT
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof ConfirmRequest
|
|
38
|
+
*/
|
|
39
|
+
'key': string;
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof ConfirmRequest
|
|
44
|
+
*/
|
|
45
|
+
'tempId'?: string | null;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof ConfirmRequest
|
|
50
|
+
*/
|
|
51
|
+
'alt'?: string;
|
|
52
|
+
/**
|
|
53
|
+
*
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof ConfirmRequest
|
|
56
|
+
*/
|
|
57
|
+
'mime'?: string;
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @type {ImageRole}
|
|
61
|
+
* @memberof ConfirmRequest
|
|
62
|
+
*/
|
|
63
|
+
'role'?: ImageRole;
|
|
64
|
+
/**
|
|
65
|
+
* e.g., SHA256 hex for additional integrity check
|
|
66
|
+
* @type {string}
|
|
67
|
+
* @memberof ConfirmRequest
|
|
68
|
+
*/
|
|
69
|
+
'checksum'?: string | null;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
*
|
|
73
|
+
* @export
|
|
74
|
+
* @interface GetDeliveryUrl200Response
|
|
75
|
+
*/
|
|
76
|
+
export interface GetDeliveryUrl200Response {
|
|
77
|
+
/**
|
|
78
|
+
*
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof GetDeliveryUrl200Response
|
|
81
|
+
*/
|
|
82
|
+
'url'?: string;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof GetDeliveryUrl200Response
|
|
87
|
+
*/
|
|
88
|
+
'expiresAt'?: string | null;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
*
|
|
92
|
+
* @export
|
|
93
|
+
* @interface Healthz200Response
|
|
94
|
+
*/
|
|
95
|
+
export interface Healthz200Response {
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @type {string}
|
|
99
|
+
* @memberof Healthz200Response
|
|
100
|
+
*/
|
|
101
|
+
'status'?: string;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
*
|
|
105
|
+
* @export
|
|
106
|
+
* @interface Image
|
|
107
|
+
*/
|
|
108
|
+
export interface Image {
|
|
109
|
+
/**
|
|
110
|
+
*
|
|
111
|
+
* @type {string}
|
|
112
|
+
* @memberof Image
|
|
113
|
+
*/
|
|
114
|
+
'id'?: string;
|
|
115
|
+
/**
|
|
116
|
+
*
|
|
117
|
+
* @type {OwnerType}
|
|
118
|
+
* @memberof Image
|
|
119
|
+
*/
|
|
120
|
+
'ownerType'?: OwnerType;
|
|
121
|
+
/**
|
|
122
|
+
*
|
|
123
|
+
* @type {string}
|
|
124
|
+
* @memberof Image
|
|
125
|
+
*/
|
|
126
|
+
'ownerId'?: string;
|
|
127
|
+
/**
|
|
128
|
+
*
|
|
129
|
+
* @type {ImageRole}
|
|
130
|
+
* @memberof Image
|
|
131
|
+
*/
|
|
132
|
+
'role'?: ImageRole;
|
|
133
|
+
/**
|
|
134
|
+
* S3 key of the original image
|
|
135
|
+
* @type {string}
|
|
136
|
+
* @memberof Image
|
|
137
|
+
*/
|
|
138
|
+
'key'?: string;
|
|
139
|
+
/**
|
|
140
|
+
* Optional — direct URL if public or via proxy
|
|
141
|
+
* @type {string}
|
|
142
|
+
* @memberof Image
|
|
143
|
+
*/
|
|
144
|
+
'url'?: string | null;
|
|
145
|
+
/**
|
|
146
|
+
*
|
|
147
|
+
* @type {string}
|
|
148
|
+
* @memberof Image
|
|
149
|
+
*/
|
|
150
|
+
'alt'?: string;
|
|
151
|
+
/**
|
|
152
|
+
*
|
|
153
|
+
* @type {string}
|
|
154
|
+
* @memberof Image
|
|
155
|
+
*/
|
|
156
|
+
'mime'?: string;
|
|
157
|
+
/**
|
|
158
|
+
*
|
|
159
|
+
* @type {number}
|
|
160
|
+
* @memberof Image
|
|
161
|
+
*/
|
|
162
|
+
'size'?: number;
|
|
163
|
+
/**
|
|
164
|
+
*
|
|
165
|
+
* @type {string}
|
|
166
|
+
* @memberof Image
|
|
167
|
+
*/
|
|
168
|
+
'hash'?: string | null;
|
|
169
|
+
/**
|
|
170
|
+
*
|
|
171
|
+
* @type {ImageStatus}
|
|
172
|
+
* @memberof Image
|
|
173
|
+
*/
|
|
174
|
+
'status'?: ImageStatus;
|
|
175
|
+
/**
|
|
176
|
+
*
|
|
177
|
+
* @type {Array<Variant>}
|
|
178
|
+
* @memberof Image
|
|
179
|
+
*/
|
|
180
|
+
'variants'?: Array<Variant>;
|
|
181
|
+
/**
|
|
182
|
+
*
|
|
183
|
+
* @type {string}
|
|
184
|
+
* @memberof Image
|
|
185
|
+
*/
|
|
186
|
+
'createdAt'?: string;
|
|
187
|
+
/**
|
|
188
|
+
*
|
|
189
|
+
* @type {string}
|
|
190
|
+
* @memberof Image
|
|
191
|
+
*/
|
|
192
|
+
'updatedAt'?: string;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
*
|
|
196
|
+
* @export
|
|
197
|
+
* @interface ImagePatch
|
|
198
|
+
*/
|
|
199
|
+
export interface ImagePatch {
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @type {string}
|
|
203
|
+
* @memberof ImagePatch
|
|
204
|
+
*/
|
|
205
|
+
'alt'?: string;
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @type {ImageRole}
|
|
209
|
+
* @memberof ImagePatch
|
|
210
|
+
*/
|
|
211
|
+
'role'?: ImageRole;
|
|
212
|
+
/**
|
|
213
|
+
* Position in the product gallery
|
|
214
|
+
* @type {number}
|
|
215
|
+
* @memberof ImagePatch
|
|
216
|
+
*/
|
|
217
|
+
'order'?: number;
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
*
|
|
221
|
+
* @export
|
|
222
|
+
* @enum {string}
|
|
223
|
+
*/
|
|
224
|
+
export declare const ImageRole: {
|
|
225
|
+
readonly Main: "main";
|
|
226
|
+
readonly Gallery: "gallery";
|
|
227
|
+
readonly Other: "other";
|
|
228
|
+
};
|
|
229
|
+
export type ImageRole = typeof ImageRole[keyof typeof ImageRole];
|
|
230
|
+
/**
|
|
231
|
+
*
|
|
232
|
+
* @export
|
|
233
|
+
* @enum {string}
|
|
234
|
+
*/
|
|
235
|
+
export declare const ImageStatus: {
|
|
236
|
+
readonly Pending: "pending";
|
|
237
|
+
readonly Uploaded: "uploaded";
|
|
238
|
+
readonly Processing: "processing";
|
|
239
|
+
readonly Ready: "ready";
|
|
240
|
+
readonly Failed: "failed";
|
|
241
|
+
readonly Deleted: "deleted";
|
|
242
|
+
};
|
|
243
|
+
export type ImageStatus = typeof ImageStatus[keyof typeof ImageStatus];
|
|
244
|
+
/**
|
|
245
|
+
*
|
|
246
|
+
* @export
|
|
247
|
+
* @interface ListImages200Response
|
|
248
|
+
*/
|
|
249
|
+
export interface ListImages200Response {
|
|
250
|
+
/**
|
|
251
|
+
*
|
|
252
|
+
* @type {Array<Image>}
|
|
253
|
+
* @memberof ListImages200Response
|
|
254
|
+
*/
|
|
255
|
+
'items'?: Array<Image>;
|
|
256
|
+
/**
|
|
257
|
+
*
|
|
258
|
+
* @type {number}
|
|
259
|
+
* @memberof ListImages200Response
|
|
260
|
+
*/
|
|
261
|
+
'page'?: number;
|
|
262
|
+
/**
|
|
263
|
+
*
|
|
264
|
+
* @type {number}
|
|
265
|
+
* @memberof ListImages200Response
|
|
266
|
+
*/
|
|
267
|
+
'pageSize'?: number;
|
|
268
|
+
/**
|
|
269
|
+
*
|
|
270
|
+
* @type {number}
|
|
271
|
+
* @memberof ListImages200Response
|
|
272
|
+
*/
|
|
273
|
+
'total'?: number;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
*
|
|
277
|
+
* @export
|
|
278
|
+
* @enum {string}
|
|
279
|
+
*/
|
|
280
|
+
export declare const OwnerType: {
|
|
281
|
+
readonly ProductDraft: "productDraft";
|
|
282
|
+
readonly Product: "product";
|
|
283
|
+
readonly User: "user";
|
|
284
|
+
};
|
|
285
|
+
export type OwnerType = typeof OwnerType[keyof typeof OwnerType];
|
|
286
|
+
/**
|
|
287
|
+
*
|
|
288
|
+
* @export
|
|
289
|
+
* @interface PresignRequest
|
|
290
|
+
*/
|
|
291
|
+
export interface PresignRequest {
|
|
292
|
+
/**
|
|
293
|
+
*
|
|
294
|
+
* @type {OwnerType}
|
|
295
|
+
* @memberof PresignRequest
|
|
296
|
+
*/
|
|
297
|
+
'ownerType': OwnerType;
|
|
298
|
+
/**
|
|
299
|
+
* Draft ID or owner ID
|
|
300
|
+
* @type {string}
|
|
301
|
+
* @memberof PresignRequest
|
|
302
|
+
*/
|
|
303
|
+
'ownerId': string;
|
|
304
|
+
/**
|
|
305
|
+
*
|
|
306
|
+
* @type {string}
|
|
307
|
+
* @memberof PresignRequest
|
|
308
|
+
*/
|
|
309
|
+
'filename': string;
|
|
310
|
+
/**
|
|
311
|
+
*
|
|
312
|
+
* @type {string}
|
|
313
|
+
* @memberof PresignRequest
|
|
314
|
+
*/
|
|
315
|
+
'contentType': string;
|
|
316
|
+
/**
|
|
317
|
+
* Size in bytes
|
|
318
|
+
* @type {number}
|
|
319
|
+
* @memberof PresignRequest
|
|
320
|
+
*/
|
|
321
|
+
'size': number;
|
|
322
|
+
/**
|
|
323
|
+
*
|
|
324
|
+
* @type {ImageRole}
|
|
325
|
+
* @memberof PresignRequest
|
|
326
|
+
*/
|
|
327
|
+
'role'?: ImageRole;
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
*
|
|
331
|
+
* @export
|
|
332
|
+
* @interface PresignResponse
|
|
333
|
+
*/
|
|
334
|
+
export interface PresignResponse {
|
|
335
|
+
/**
|
|
336
|
+
*
|
|
337
|
+
* @type {string}
|
|
338
|
+
* @memberof PresignResponse
|
|
339
|
+
*/
|
|
340
|
+
'uploadUrl'?: string;
|
|
341
|
+
/**
|
|
342
|
+
* Final S3 key to PUT to
|
|
343
|
+
* @type {string}
|
|
344
|
+
* @memberof PresignResponse
|
|
345
|
+
*/
|
|
346
|
+
'key'?: string;
|
|
347
|
+
/**
|
|
348
|
+
* Temporary ID for idempotency/confirm
|
|
349
|
+
* @type {string}
|
|
350
|
+
* @memberof PresignResponse
|
|
351
|
+
*/
|
|
352
|
+
'tempId'?: string;
|
|
353
|
+
/**
|
|
354
|
+
* TTL in seconds
|
|
355
|
+
* @type {number}
|
|
356
|
+
* @memberof PresignResponse
|
|
357
|
+
*/
|
|
358
|
+
'expiresIn'?: number;
|
|
359
|
+
/**
|
|
360
|
+
*
|
|
361
|
+
* @type {{ [key: string]: string; }}
|
|
362
|
+
* @memberof PresignResponse
|
|
363
|
+
*/
|
|
364
|
+
'requiredHeaders'?: {
|
|
365
|
+
[key: string]: string;
|
|
366
|
+
};
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* RFC7807 Problem Details
|
|
370
|
+
* @export
|
|
371
|
+
* @interface Problem
|
|
372
|
+
*/
|
|
373
|
+
export interface Problem {
|
|
374
|
+
/**
|
|
375
|
+
*
|
|
376
|
+
* @type {string}
|
|
377
|
+
* @memberof Problem
|
|
378
|
+
*/
|
|
379
|
+
'type'?: string;
|
|
380
|
+
/**
|
|
381
|
+
*
|
|
382
|
+
* @type {string}
|
|
383
|
+
* @memberof Problem
|
|
384
|
+
*/
|
|
385
|
+
'title'?: string;
|
|
386
|
+
/**
|
|
387
|
+
*
|
|
388
|
+
* @type {number}
|
|
389
|
+
* @memberof Problem
|
|
390
|
+
*/
|
|
391
|
+
'status'?: number;
|
|
392
|
+
/**
|
|
393
|
+
*
|
|
394
|
+
* @type {string}
|
|
395
|
+
* @memberof Problem
|
|
396
|
+
*/
|
|
397
|
+
'detail'?: string;
|
|
398
|
+
/**
|
|
399
|
+
*
|
|
400
|
+
* @type {string}
|
|
401
|
+
* @memberof Problem
|
|
402
|
+
*/
|
|
403
|
+
'instance'?: string;
|
|
404
|
+
/**
|
|
405
|
+
*
|
|
406
|
+
* @type {string}
|
|
407
|
+
* @memberof Problem
|
|
408
|
+
*/
|
|
409
|
+
'traceId'?: string;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
*
|
|
413
|
+
* @export
|
|
414
|
+
* @interface ProcessImageRequest
|
|
415
|
+
*/
|
|
416
|
+
export interface ProcessImageRequest {
|
|
417
|
+
/**
|
|
418
|
+
*
|
|
419
|
+
* @type {string}
|
|
420
|
+
* @memberof ProcessImageRequest
|
|
421
|
+
*/
|
|
422
|
+
'imageId'?: string;
|
|
423
|
+
/**
|
|
424
|
+
* Name of the preset (variant set), if used
|
|
425
|
+
* @type {string}
|
|
426
|
+
* @memberof ProcessImageRequest
|
|
427
|
+
*/
|
|
428
|
+
'preset'?: string;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
*
|
|
432
|
+
* @export
|
|
433
|
+
* @interface PromoteImages200Response
|
|
434
|
+
*/
|
|
435
|
+
export interface PromoteImages200Response {
|
|
436
|
+
/**
|
|
437
|
+
*
|
|
438
|
+
* @type {Array<Image>}
|
|
439
|
+
* @memberof PromoteImages200Response
|
|
440
|
+
*/
|
|
441
|
+
'promoted'?: Array<Image>;
|
|
442
|
+
}
|
|
443
|
+
/**
|
|
444
|
+
*
|
|
445
|
+
* @export
|
|
446
|
+
* @interface PromoteRequest
|
|
447
|
+
*/
|
|
448
|
+
export interface PromoteRequest {
|
|
449
|
+
/**
|
|
450
|
+
*
|
|
451
|
+
* @type {string}
|
|
452
|
+
* @memberof PromoteRequest
|
|
453
|
+
*/
|
|
454
|
+
'fromDraft': string;
|
|
455
|
+
/**
|
|
456
|
+
*
|
|
457
|
+
* @type {string}
|
|
458
|
+
* @memberof PromoteRequest
|
|
459
|
+
*/
|
|
460
|
+
'toProduct': string;
|
|
461
|
+
/**
|
|
462
|
+
* If true — copy to products/{productId}/... and remove old objects
|
|
463
|
+
* @type {boolean}
|
|
464
|
+
* @memberof PromoteRequest
|
|
465
|
+
*/
|
|
466
|
+
'move'?: boolean;
|
|
467
|
+
/**
|
|
468
|
+
* If omitted — promote all images of the draft
|
|
469
|
+
* @type {Array<string>}
|
|
470
|
+
* @memberof PromoteRequest
|
|
471
|
+
*/
|
|
472
|
+
'images'?: Array<string>;
|
|
473
|
+
}
|
|
474
|
+
/**
|
|
475
|
+
*
|
|
476
|
+
* @export
|
|
477
|
+
* @interface Variant
|
|
478
|
+
*/
|
|
479
|
+
export interface Variant {
|
|
480
|
+
/**
|
|
481
|
+
*
|
|
482
|
+
* @type {string}
|
|
483
|
+
* @memberof Variant
|
|
484
|
+
*/
|
|
485
|
+
'name'?: string;
|
|
486
|
+
/**
|
|
487
|
+
* S3 key of the variant
|
|
488
|
+
* @type {string}
|
|
489
|
+
* @memberof Variant
|
|
490
|
+
*/
|
|
491
|
+
'key'?: string;
|
|
492
|
+
/**
|
|
493
|
+
*
|
|
494
|
+
* @type {number}
|
|
495
|
+
* @memberof Variant
|
|
496
|
+
*/
|
|
497
|
+
'width'?: number;
|
|
498
|
+
/**
|
|
499
|
+
*
|
|
500
|
+
* @type {number}
|
|
501
|
+
* @memberof Variant
|
|
502
|
+
*/
|
|
503
|
+
'height'?: number;
|
|
504
|
+
/**
|
|
505
|
+
*
|
|
506
|
+
* @type {string}
|
|
507
|
+
* @memberof Variant
|
|
508
|
+
*/
|
|
509
|
+
'mime'?: string;
|
|
510
|
+
/**
|
|
511
|
+
*
|
|
512
|
+
* @type {number}
|
|
513
|
+
* @memberof Variant
|
|
514
|
+
*/
|
|
515
|
+
'size'?: number;
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* DeliveryApi - axios parameter creator
|
|
519
|
+
* @export
|
|
520
|
+
*/
|
|
521
|
+
export declare const DeliveryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
522
|
+
/**
|
|
523
|
+
*
|
|
524
|
+
* @summary Generate a signed imgproxy URL for delivery with requested params
|
|
525
|
+
* @param {string} id
|
|
526
|
+
* @param {string} [variant]
|
|
527
|
+
* @param {number} [w]
|
|
528
|
+
* @param {number} [h]
|
|
529
|
+
* @param {GetDeliveryUrlFitEnum} [fit]
|
|
530
|
+
* @param {GetDeliveryUrlFormatEnum} [format]
|
|
531
|
+
* @param {number} [quality]
|
|
532
|
+
* @param {number} [dpr]
|
|
533
|
+
* @param {number} [ttlSeconds]
|
|
534
|
+
* @param {*} [options] Override http request option.
|
|
535
|
+
* @throws {RequiredError}
|
|
536
|
+
*/
|
|
537
|
+
getDeliveryUrl: (id: string, variant?: string, w?: number, h?: number, fit?: GetDeliveryUrlFitEnum, format?: GetDeliveryUrlFormatEnum, quality?: number, dpr?: number, ttlSeconds?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
538
|
+
};
|
|
539
|
+
/**
|
|
540
|
+
* DeliveryApi - functional programming interface
|
|
541
|
+
* @export
|
|
542
|
+
*/
|
|
543
|
+
export declare const DeliveryApiFp: (configuration?: Configuration) => {
|
|
544
|
+
/**
|
|
545
|
+
*
|
|
546
|
+
* @summary Generate a signed imgproxy URL for delivery with requested params
|
|
547
|
+
* @param {string} id
|
|
548
|
+
* @param {string} [variant]
|
|
549
|
+
* @param {number} [w]
|
|
550
|
+
* @param {number} [h]
|
|
551
|
+
* @param {GetDeliveryUrlFitEnum} [fit]
|
|
552
|
+
* @param {GetDeliveryUrlFormatEnum} [format]
|
|
553
|
+
* @param {number} [quality]
|
|
554
|
+
* @param {number} [dpr]
|
|
555
|
+
* @param {number} [ttlSeconds]
|
|
556
|
+
* @param {*} [options] Override http request option.
|
|
557
|
+
* @throws {RequiredError}
|
|
558
|
+
*/
|
|
559
|
+
getDeliveryUrl(id: string, variant?: string, w?: number, h?: number, fit?: GetDeliveryUrlFitEnum, format?: GetDeliveryUrlFormatEnum, quality?: number, dpr?: number, ttlSeconds?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDeliveryUrl200Response>>;
|
|
560
|
+
};
|
|
561
|
+
/**
|
|
562
|
+
* DeliveryApi - factory interface
|
|
563
|
+
* @export
|
|
564
|
+
*/
|
|
565
|
+
export declare const DeliveryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
566
|
+
/**
|
|
567
|
+
*
|
|
568
|
+
* @summary Generate a signed imgproxy URL for delivery with requested params
|
|
569
|
+
* @param {DeliveryApiGetDeliveryUrlRequest} requestParameters Request parameters.
|
|
570
|
+
* @param {*} [options] Override http request option.
|
|
571
|
+
* @throws {RequiredError}
|
|
572
|
+
*/
|
|
573
|
+
getDeliveryUrl(requestParameters: DeliveryApiGetDeliveryUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeliveryUrl200Response>;
|
|
574
|
+
};
|
|
575
|
+
/**
|
|
576
|
+
* Request parameters for getDeliveryUrl operation in DeliveryApi.
|
|
577
|
+
* @export
|
|
578
|
+
* @interface DeliveryApiGetDeliveryUrlRequest
|
|
579
|
+
*/
|
|
580
|
+
export interface DeliveryApiGetDeliveryUrlRequest {
|
|
581
|
+
/**
|
|
582
|
+
*
|
|
583
|
+
* @type {string}
|
|
584
|
+
* @memberof DeliveryApiGetDeliveryUrl
|
|
585
|
+
*/
|
|
586
|
+
readonly id: string;
|
|
587
|
+
/**
|
|
588
|
+
*
|
|
589
|
+
* @type {string}
|
|
590
|
+
* @memberof DeliveryApiGetDeliveryUrl
|
|
591
|
+
*/
|
|
592
|
+
readonly variant?: string;
|
|
593
|
+
/**
|
|
594
|
+
*
|
|
595
|
+
* @type {number}
|
|
596
|
+
* @memberof DeliveryApiGetDeliveryUrl
|
|
597
|
+
*/
|
|
598
|
+
readonly w?: number;
|
|
599
|
+
/**
|
|
600
|
+
*
|
|
601
|
+
* @type {number}
|
|
602
|
+
* @memberof DeliveryApiGetDeliveryUrl
|
|
603
|
+
*/
|
|
604
|
+
readonly h?: number;
|
|
605
|
+
/**
|
|
606
|
+
*
|
|
607
|
+
* @type {'cover' | 'contain' | 'fill' | 'inside' | 'outside'}
|
|
608
|
+
* @memberof DeliveryApiGetDeliveryUrl
|
|
609
|
+
*/
|
|
610
|
+
readonly fit?: GetDeliveryUrlFitEnum;
|
|
611
|
+
/**
|
|
612
|
+
*
|
|
613
|
+
* @type {'original' | 'webp' | 'avif' | 'jpeg' | 'png'}
|
|
614
|
+
* @memberof DeliveryApiGetDeliveryUrl
|
|
615
|
+
*/
|
|
616
|
+
readonly format?: GetDeliveryUrlFormatEnum;
|
|
617
|
+
/**
|
|
618
|
+
*
|
|
619
|
+
* @type {number}
|
|
620
|
+
* @memberof DeliveryApiGetDeliveryUrl
|
|
621
|
+
*/
|
|
622
|
+
readonly quality?: number;
|
|
623
|
+
/**
|
|
624
|
+
*
|
|
625
|
+
* @type {number}
|
|
626
|
+
* @memberof DeliveryApiGetDeliveryUrl
|
|
627
|
+
*/
|
|
628
|
+
readonly dpr?: number;
|
|
629
|
+
/**
|
|
630
|
+
*
|
|
631
|
+
* @type {number}
|
|
632
|
+
* @memberof DeliveryApiGetDeliveryUrl
|
|
633
|
+
*/
|
|
634
|
+
readonly ttlSeconds?: number;
|
|
635
|
+
}
|
|
636
|
+
/**
|
|
637
|
+
* DeliveryApi - object-oriented interface
|
|
638
|
+
* @export
|
|
639
|
+
* @class DeliveryApi
|
|
640
|
+
* @extends {BaseAPI}
|
|
641
|
+
*/
|
|
642
|
+
export declare class DeliveryApi extends BaseAPI {
|
|
643
|
+
/**
|
|
644
|
+
*
|
|
645
|
+
* @summary Generate a signed imgproxy URL for delivery with requested params
|
|
646
|
+
* @param {DeliveryApiGetDeliveryUrlRequest} requestParameters Request parameters.
|
|
647
|
+
* @param {*} [options] Override http request option.
|
|
648
|
+
* @throws {RequiredError}
|
|
649
|
+
* @memberof DeliveryApi
|
|
650
|
+
*/
|
|
651
|
+
getDeliveryUrl(requestParameters: DeliveryApiGetDeliveryUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDeliveryUrl200Response, any, {}>>;
|
|
652
|
+
}
|
|
653
|
+
/**
|
|
654
|
+
* @export
|
|
655
|
+
*/
|
|
656
|
+
export declare const GetDeliveryUrlFitEnum: {
|
|
657
|
+
readonly Cover: "cover";
|
|
658
|
+
readonly Contain: "contain";
|
|
659
|
+
readonly Fill: "fill";
|
|
660
|
+
readonly Inside: "inside";
|
|
661
|
+
readonly Outside: "outside";
|
|
662
|
+
};
|
|
663
|
+
export type GetDeliveryUrlFitEnum = typeof GetDeliveryUrlFitEnum[keyof typeof GetDeliveryUrlFitEnum];
|
|
664
|
+
/**
|
|
665
|
+
* @export
|
|
666
|
+
*/
|
|
667
|
+
export declare const GetDeliveryUrlFormatEnum: {
|
|
668
|
+
readonly Original: "original";
|
|
669
|
+
readonly Webp: "webp";
|
|
670
|
+
readonly Avif: "avif";
|
|
671
|
+
readonly Jpeg: "jpeg";
|
|
672
|
+
readonly Png: "png";
|
|
673
|
+
};
|
|
674
|
+
export type GetDeliveryUrlFormatEnum = typeof GetDeliveryUrlFormatEnum[keyof typeof GetDeliveryUrlFormatEnum];
|
|
675
|
+
/**
|
|
676
|
+
* HealthApi - axios parameter creator
|
|
677
|
+
* @export
|
|
678
|
+
*/
|
|
679
|
+
export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
680
|
+
/**
|
|
681
|
+
*
|
|
682
|
+
* @summary Health check
|
|
683
|
+
* @param {*} [options] Override http request option.
|
|
684
|
+
* @throws {RequiredError}
|
|
685
|
+
*/
|
|
686
|
+
healthz: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
687
|
+
};
|
|
688
|
+
/**
|
|
689
|
+
* HealthApi - functional programming interface
|
|
690
|
+
* @export
|
|
691
|
+
*/
|
|
692
|
+
export declare const HealthApiFp: (configuration?: Configuration) => {
|
|
693
|
+
/**
|
|
694
|
+
*
|
|
695
|
+
* @summary Health check
|
|
696
|
+
* @param {*} [options] Override http request option.
|
|
697
|
+
* @throws {RequiredError}
|
|
698
|
+
*/
|
|
699
|
+
healthz(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Healthz200Response>>;
|
|
700
|
+
};
|
|
701
|
+
/**
|
|
702
|
+
* HealthApi - factory interface
|
|
703
|
+
* @export
|
|
704
|
+
*/
|
|
705
|
+
export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
706
|
+
/**
|
|
707
|
+
*
|
|
708
|
+
* @summary Health check
|
|
709
|
+
* @param {*} [options] Override http request option.
|
|
710
|
+
* @throws {RequiredError}
|
|
711
|
+
*/
|
|
712
|
+
healthz(options?: RawAxiosRequestConfig): AxiosPromise<Healthz200Response>;
|
|
713
|
+
};
|
|
714
|
+
/**
|
|
715
|
+
* HealthApi - object-oriented interface
|
|
716
|
+
* @export
|
|
717
|
+
* @class HealthApi
|
|
718
|
+
* @extends {BaseAPI}
|
|
719
|
+
*/
|
|
720
|
+
export declare class HealthApi extends BaseAPI {
|
|
721
|
+
/**
|
|
722
|
+
*
|
|
723
|
+
* @summary Health check
|
|
724
|
+
* @param {*} [options] Override http request option.
|
|
725
|
+
* @throws {RequiredError}
|
|
726
|
+
* @memberof HealthApi
|
|
727
|
+
*/
|
|
728
|
+
healthz(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Healthz200Response, any, {}>>;
|
|
729
|
+
}
|
|
730
|
+
/**
|
|
731
|
+
* ImagesApi - axios parameter creator
|
|
732
|
+
* @export
|
|
733
|
+
*/
|
|
734
|
+
export declare const ImagesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
735
|
+
/**
|
|
736
|
+
*
|
|
737
|
+
* @summary Confirm upload (HEAD against S3), persist metadata
|
|
738
|
+
* @param {ConfirmRequest} confirmRequest
|
|
739
|
+
* @param {string} [idempotencyKey] Idempotency key for safe retries.
|
|
740
|
+
* @param {*} [options] Override http request option.
|
|
741
|
+
* @throws {RequiredError}
|
|
742
|
+
*/
|
|
743
|
+
confirmUpload: (confirmRequest: ConfirmRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
744
|
+
/**
|
|
745
|
+
*
|
|
746
|
+
* @summary Delete image (soft or hard, per policy)
|
|
747
|
+
* @param {string} id
|
|
748
|
+
* @param {boolean} [hard]
|
|
749
|
+
* @param {*} [options] Override http request option.
|
|
750
|
+
* @throws {RequiredError}
|
|
751
|
+
*/
|
|
752
|
+
deleteImage: (id: string, hard?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
753
|
+
/**
|
|
754
|
+
*
|
|
755
|
+
* @summary Get image metadata
|
|
756
|
+
* @param {string} id
|
|
757
|
+
* @param {*} [options] Override http request option.
|
|
758
|
+
* @throws {RequiredError}
|
|
759
|
+
*/
|
|
760
|
+
getImage: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
761
|
+
/**
|
|
762
|
+
*
|
|
763
|
+
* @summary List/search images by owner/filters
|
|
764
|
+
* @param {OwnerType} [ownerType]
|
|
765
|
+
* @param {string} [ownerId]
|
|
766
|
+
* @param {ImageStatus} [status]
|
|
767
|
+
* @param {number} [page]
|
|
768
|
+
* @param {number} [pageSize]
|
|
769
|
+
* @param {*} [options] Override http request option.
|
|
770
|
+
* @throws {RequiredError}
|
|
771
|
+
*/
|
|
772
|
+
listImages: (ownerType?: OwnerType, ownerId?: string, status?: ImageStatus, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
773
|
+
/**
|
|
774
|
+
*
|
|
775
|
+
* @summary Update image metadata (alt, role, order)
|
|
776
|
+
* @param {string} id
|
|
777
|
+
* @param {ImagePatch} imagePatch
|
|
778
|
+
* @param {*} [options] Override http request option.
|
|
779
|
+
* @throws {RequiredError}
|
|
780
|
+
*/
|
|
781
|
+
updateImage: (id: string, imagePatch: ImagePatch, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
782
|
+
};
|
|
783
|
+
/**
|
|
784
|
+
* ImagesApi - functional programming interface
|
|
785
|
+
* @export
|
|
786
|
+
*/
|
|
787
|
+
export declare const ImagesApiFp: (configuration?: Configuration) => {
|
|
788
|
+
/**
|
|
789
|
+
*
|
|
790
|
+
* @summary Confirm upload (HEAD against S3), persist metadata
|
|
791
|
+
* @param {ConfirmRequest} confirmRequest
|
|
792
|
+
* @param {string} [idempotencyKey] Idempotency key for safe retries.
|
|
793
|
+
* @param {*} [options] Override http request option.
|
|
794
|
+
* @throws {RequiredError}
|
|
795
|
+
*/
|
|
796
|
+
confirmUpload(confirmRequest: ConfirmRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Image>>;
|
|
797
|
+
/**
|
|
798
|
+
*
|
|
799
|
+
* @summary Delete image (soft or hard, per policy)
|
|
800
|
+
* @param {string} id
|
|
801
|
+
* @param {boolean} [hard]
|
|
802
|
+
* @param {*} [options] Override http request option.
|
|
803
|
+
* @throws {RequiredError}
|
|
804
|
+
*/
|
|
805
|
+
deleteImage(id: string, hard?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
806
|
+
/**
|
|
807
|
+
*
|
|
808
|
+
* @summary Get image metadata
|
|
809
|
+
* @param {string} id
|
|
810
|
+
* @param {*} [options] Override http request option.
|
|
811
|
+
* @throws {RequiredError}
|
|
812
|
+
*/
|
|
813
|
+
getImage(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Image>>;
|
|
814
|
+
/**
|
|
815
|
+
*
|
|
816
|
+
* @summary List/search images by owner/filters
|
|
817
|
+
* @param {OwnerType} [ownerType]
|
|
818
|
+
* @param {string} [ownerId]
|
|
819
|
+
* @param {ImageStatus} [status]
|
|
820
|
+
* @param {number} [page]
|
|
821
|
+
* @param {number} [pageSize]
|
|
822
|
+
* @param {*} [options] Override http request option.
|
|
823
|
+
* @throws {RequiredError}
|
|
824
|
+
*/
|
|
825
|
+
listImages(ownerType?: OwnerType, ownerId?: string, status?: ImageStatus, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListImages200Response>>;
|
|
826
|
+
/**
|
|
827
|
+
*
|
|
828
|
+
* @summary Update image metadata (alt, role, order)
|
|
829
|
+
* @param {string} id
|
|
830
|
+
* @param {ImagePatch} imagePatch
|
|
831
|
+
* @param {*} [options] Override http request option.
|
|
832
|
+
* @throws {RequiredError}
|
|
833
|
+
*/
|
|
834
|
+
updateImage(id: string, imagePatch: ImagePatch, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Image>>;
|
|
835
|
+
};
|
|
836
|
+
/**
|
|
837
|
+
* ImagesApi - factory interface
|
|
838
|
+
* @export
|
|
839
|
+
*/
|
|
840
|
+
export declare const ImagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
841
|
+
/**
|
|
842
|
+
*
|
|
843
|
+
* @summary Confirm upload (HEAD against S3), persist metadata
|
|
844
|
+
* @param {ImagesApiConfirmUploadRequest} requestParameters Request parameters.
|
|
845
|
+
* @param {*} [options] Override http request option.
|
|
846
|
+
* @throws {RequiredError}
|
|
847
|
+
*/
|
|
848
|
+
confirmUpload(requestParameters: ImagesApiConfirmUploadRequest, options?: RawAxiosRequestConfig): AxiosPromise<Image>;
|
|
849
|
+
/**
|
|
850
|
+
*
|
|
851
|
+
* @summary Delete image (soft or hard, per policy)
|
|
852
|
+
* @param {ImagesApiDeleteImageRequest} requestParameters Request parameters.
|
|
853
|
+
* @param {*} [options] Override http request option.
|
|
854
|
+
* @throws {RequiredError}
|
|
855
|
+
*/
|
|
856
|
+
deleteImage(requestParameters: ImagesApiDeleteImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
857
|
+
/**
|
|
858
|
+
*
|
|
859
|
+
* @summary Get image metadata
|
|
860
|
+
* @param {ImagesApiGetImageRequest} requestParameters Request parameters.
|
|
861
|
+
* @param {*} [options] Override http request option.
|
|
862
|
+
* @throws {RequiredError}
|
|
863
|
+
*/
|
|
864
|
+
getImage(requestParameters: ImagesApiGetImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Image>;
|
|
865
|
+
/**
|
|
866
|
+
*
|
|
867
|
+
* @summary List/search images by owner/filters
|
|
868
|
+
* @param {ImagesApiListImagesRequest} requestParameters Request parameters.
|
|
869
|
+
* @param {*} [options] Override http request option.
|
|
870
|
+
* @throws {RequiredError}
|
|
871
|
+
*/
|
|
872
|
+
listImages(requestParameters?: ImagesApiListImagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListImages200Response>;
|
|
873
|
+
/**
|
|
874
|
+
*
|
|
875
|
+
* @summary Update image metadata (alt, role, order)
|
|
876
|
+
* @param {ImagesApiUpdateImageRequest} requestParameters Request parameters.
|
|
877
|
+
* @param {*} [options] Override http request option.
|
|
878
|
+
* @throws {RequiredError}
|
|
879
|
+
*/
|
|
880
|
+
updateImage(requestParameters: ImagesApiUpdateImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Image>;
|
|
881
|
+
};
|
|
882
|
+
/**
|
|
883
|
+
* Request parameters for confirmUpload operation in ImagesApi.
|
|
884
|
+
* @export
|
|
885
|
+
* @interface ImagesApiConfirmUploadRequest
|
|
886
|
+
*/
|
|
887
|
+
export interface ImagesApiConfirmUploadRequest {
|
|
888
|
+
/**
|
|
889
|
+
*
|
|
890
|
+
* @type {ConfirmRequest}
|
|
891
|
+
* @memberof ImagesApiConfirmUpload
|
|
892
|
+
*/
|
|
893
|
+
readonly confirmRequest: ConfirmRequest;
|
|
894
|
+
/**
|
|
895
|
+
* Idempotency key for safe retries.
|
|
896
|
+
* @type {string}
|
|
897
|
+
* @memberof ImagesApiConfirmUpload
|
|
898
|
+
*/
|
|
899
|
+
readonly idempotencyKey?: string;
|
|
900
|
+
}
|
|
901
|
+
/**
|
|
902
|
+
* Request parameters for deleteImage operation in ImagesApi.
|
|
903
|
+
* @export
|
|
904
|
+
* @interface ImagesApiDeleteImageRequest
|
|
905
|
+
*/
|
|
906
|
+
export interface ImagesApiDeleteImageRequest {
|
|
907
|
+
/**
|
|
908
|
+
*
|
|
909
|
+
* @type {string}
|
|
910
|
+
* @memberof ImagesApiDeleteImage
|
|
911
|
+
*/
|
|
912
|
+
readonly id: string;
|
|
913
|
+
/**
|
|
914
|
+
*
|
|
915
|
+
* @type {boolean}
|
|
916
|
+
* @memberof ImagesApiDeleteImage
|
|
917
|
+
*/
|
|
918
|
+
readonly hard?: boolean;
|
|
919
|
+
}
|
|
920
|
+
/**
|
|
921
|
+
* Request parameters for getImage operation in ImagesApi.
|
|
922
|
+
* @export
|
|
923
|
+
* @interface ImagesApiGetImageRequest
|
|
924
|
+
*/
|
|
925
|
+
export interface ImagesApiGetImageRequest {
|
|
926
|
+
/**
|
|
927
|
+
*
|
|
928
|
+
* @type {string}
|
|
929
|
+
* @memberof ImagesApiGetImage
|
|
930
|
+
*/
|
|
931
|
+
readonly id: string;
|
|
932
|
+
}
|
|
933
|
+
/**
|
|
934
|
+
* Request parameters for listImages operation in ImagesApi.
|
|
935
|
+
* @export
|
|
936
|
+
* @interface ImagesApiListImagesRequest
|
|
937
|
+
*/
|
|
938
|
+
export interface ImagesApiListImagesRequest {
|
|
939
|
+
/**
|
|
940
|
+
*
|
|
941
|
+
* @type {OwnerType}
|
|
942
|
+
* @memberof ImagesApiListImages
|
|
943
|
+
*/
|
|
944
|
+
readonly ownerType?: OwnerType;
|
|
945
|
+
/**
|
|
946
|
+
*
|
|
947
|
+
* @type {string}
|
|
948
|
+
* @memberof ImagesApiListImages
|
|
949
|
+
*/
|
|
950
|
+
readonly ownerId?: string;
|
|
951
|
+
/**
|
|
952
|
+
*
|
|
953
|
+
* @type {ImageStatus}
|
|
954
|
+
* @memberof ImagesApiListImages
|
|
955
|
+
*/
|
|
956
|
+
readonly status?: ImageStatus;
|
|
957
|
+
/**
|
|
958
|
+
*
|
|
959
|
+
* @type {number}
|
|
960
|
+
* @memberof ImagesApiListImages
|
|
961
|
+
*/
|
|
962
|
+
readonly page?: number;
|
|
963
|
+
/**
|
|
964
|
+
*
|
|
965
|
+
* @type {number}
|
|
966
|
+
* @memberof ImagesApiListImages
|
|
967
|
+
*/
|
|
968
|
+
readonly pageSize?: number;
|
|
969
|
+
}
|
|
970
|
+
/**
|
|
971
|
+
* Request parameters for updateImage operation in ImagesApi.
|
|
972
|
+
* @export
|
|
973
|
+
* @interface ImagesApiUpdateImageRequest
|
|
974
|
+
*/
|
|
975
|
+
export interface ImagesApiUpdateImageRequest {
|
|
976
|
+
/**
|
|
977
|
+
*
|
|
978
|
+
* @type {string}
|
|
979
|
+
* @memberof ImagesApiUpdateImage
|
|
980
|
+
*/
|
|
981
|
+
readonly id: string;
|
|
982
|
+
/**
|
|
983
|
+
*
|
|
984
|
+
* @type {ImagePatch}
|
|
985
|
+
* @memberof ImagesApiUpdateImage
|
|
986
|
+
*/
|
|
987
|
+
readonly imagePatch: ImagePatch;
|
|
988
|
+
}
|
|
989
|
+
/**
|
|
990
|
+
* ImagesApi - object-oriented interface
|
|
991
|
+
* @export
|
|
992
|
+
* @class ImagesApi
|
|
993
|
+
* @extends {BaseAPI}
|
|
994
|
+
*/
|
|
995
|
+
export declare class ImagesApi extends BaseAPI {
|
|
996
|
+
/**
|
|
997
|
+
*
|
|
998
|
+
* @summary Confirm upload (HEAD against S3), persist metadata
|
|
999
|
+
* @param {ImagesApiConfirmUploadRequest} requestParameters Request parameters.
|
|
1000
|
+
* @param {*} [options] Override http request option.
|
|
1001
|
+
* @throws {RequiredError}
|
|
1002
|
+
* @memberof ImagesApi
|
|
1003
|
+
*/
|
|
1004
|
+
confirmUpload(requestParameters: ImagesApiConfirmUploadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Image, any, {}>>;
|
|
1005
|
+
/**
|
|
1006
|
+
*
|
|
1007
|
+
* @summary Delete image (soft or hard, per policy)
|
|
1008
|
+
* @param {ImagesApiDeleteImageRequest} requestParameters Request parameters.
|
|
1009
|
+
* @param {*} [options] Override http request option.
|
|
1010
|
+
* @throws {RequiredError}
|
|
1011
|
+
* @memberof ImagesApi
|
|
1012
|
+
*/
|
|
1013
|
+
deleteImage(requestParameters: ImagesApiDeleteImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1014
|
+
/**
|
|
1015
|
+
*
|
|
1016
|
+
* @summary Get image metadata
|
|
1017
|
+
* @param {ImagesApiGetImageRequest} requestParameters Request parameters.
|
|
1018
|
+
* @param {*} [options] Override http request option.
|
|
1019
|
+
* @throws {RequiredError}
|
|
1020
|
+
* @memberof ImagesApi
|
|
1021
|
+
*/
|
|
1022
|
+
getImage(requestParameters: ImagesApiGetImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Image, any, {}>>;
|
|
1023
|
+
/**
|
|
1024
|
+
*
|
|
1025
|
+
* @summary List/search images by owner/filters
|
|
1026
|
+
* @param {ImagesApiListImagesRequest} requestParameters Request parameters.
|
|
1027
|
+
* @param {*} [options] Override http request option.
|
|
1028
|
+
* @throws {RequiredError}
|
|
1029
|
+
* @memberof ImagesApi
|
|
1030
|
+
*/
|
|
1031
|
+
listImages(requestParameters?: ImagesApiListImagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListImages200Response, any, {}>>;
|
|
1032
|
+
/**
|
|
1033
|
+
*
|
|
1034
|
+
* @summary Update image metadata (alt, role, order)
|
|
1035
|
+
* @param {ImagesApiUpdateImageRequest} requestParameters Request parameters.
|
|
1036
|
+
* @param {*} [options] Override http request option.
|
|
1037
|
+
* @throws {RequiredError}
|
|
1038
|
+
* @memberof ImagesApi
|
|
1039
|
+
*/
|
|
1040
|
+
updateImage(requestParameters: ImagesApiUpdateImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Image, any, {}>>;
|
|
1041
|
+
}
|
|
1042
|
+
/**
|
|
1043
|
+
* InternalApi - axios parameter creator
|
|
1044
|
+
* @export
|
|
1045
|
+
*/
|
|
1046
|
+
export declare const InternalApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1047
|
+
/**
|
|
1048
|
+
*
|
|
1049
|
+
* @summary Trigger (or retry) variant generation for an image
|
|
1050
|
+
* @param {ProcessImageRequest} processImageRequest
|
|
1051
|
+
* @param {*} [options] Override http request option.
|
|
1052
|
+
* @throws {RequiredError}
|
|
1053
|
+
*/
|
|
1054
|
+
processImage: (processImageRequest: ProcessImageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1055
|
+
/**
|
|
1056
|
+
*
|
|
1057
|
+
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
1058
|
+
* @param {{ [key: string]: any; }} requestBody
|
|
1059
|
+
* @param {*} [options] Override http request option.
|
|
1060
|
+
* @throws {RequiredError}
|
|
1061
|
+
*/
|
|
1062
|
+
s3Webhook: (requestBody: {
|
|
1063
|
+
[key: string]: any;
|
|
1064
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1065
|
+
};
|
|
1066
|
+
/**
|
|
1067
|
+
* InternalApi - functional programming interface
|
|
1068
|
+
* @export
|
|
1069
|
+
*/
|
|
1070
|
+
export declare const InternalApiFp: (configuration?: Configuration) => {
|
|
1071
|
+
/**
|
|
1072
|
+
*
|
|
1073
|
+
* @summary Trigger (or retry) variant generation for an image
|
|
1074
|
+
* @param {ProcessImageRequest} processImageRequest
|
|
1075
|
+
* @param {*} [options] Override http request option.
|
|
1076
|
+
* @throws {RequiredError}
|
|
1077
|
+
*/
|
|
1078
|
+
processImage(processImageRequest: ProcessImageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1079
|
+
/**
|
|
1080
|
+
*
|
|
1081
|
+
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
1082
|
+
* @param {{ [key: string]: any; }} requestBody
|
|
1083
|
+
* @param {*} [options] Override http request option.
|
|
1084
|
+
* @throws {RequiredError}
|
|
1085
|
+
*/
|
|
1086
|
+
s3Webhook(requestBody: {
|
|
1087
|
+
[key: string]: any;
|
|
1088
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1089
|
+
};
|
|
1090
|
+
/**
|
|
1091
|
+
* InternalApi - factory interface
|
|
1092
|
+
* @export
|
|
1093
|
+
*/
|
|
1094
|
+
export declare const InternalApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1095
|
+
/**
|
|
1096
|
+
*
|
|
1097
|
+
* @summary Trigger (or retry) variant generation for an image
|
|
1098
|
+
* @param {InternalApiProcessImageRequest} requestParameters Request parameters.
|
|
1099
|
+
* @param {*} [options] Override http request option.
|
|
1100
|
+
* @throws {RequiredError}
|
|
1101
|
+
*/
|
|
1102
|
+
processImage(requestParameters: InternalApiProcessImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1103
|
+
/**
|
|
1104
|
+
*
|
|
1105
|
+
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
1106
|
+
* @param {InternalApiS3WebhookRequest} requestParameters Request parameters.
|
|
1107
|
+
* @param {*} [options] Override http request option.
|
|
1108
|
+
* @throws {RequiredError}
|
|
1109
|
+
*/
|
|
1110
|
+
s3Webhook(requestParameters: InternalApiS3WebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1111
|
+
};
|
|
1112
|
+
/**
|
|
1113
|
+
* Request parameters for processImage operation in InternalApi.
|
|
1114
|
+
* @export
|
|
1115
|
+
* @interface InternalApiProcessImageRequest
|
|
1116
|
+
*/
|
|
1117
|
+
export interface InternalApiProcessImageRequest {
|
|
1118
|
+
/**
|
|
1119
|
+
*
|
|
1120
|
+
* @type {ProcessImageRequest}
|
|
1121
|
+
* @memberof InternalApiProcessImage
|
|
1122
|
+
*/
|
|
1123
|
+
readonly processImageRequest: ProcessImageRequest;
|
|
1124
|
+
}
|
|
1125
|
+
/**
|
|
1126
|
+
* Request parameters for s3Webhook operation in InternalApi.
|
|
1127
|
+
* @export
|
|
1128
|
+
* @interface InternalApiS3WebhookRequest
|
|
1129
|
+
*/
|
|
1130
|
+
export interface InternalApiS3WebhookRequest {
|
|
1131
|
+
/**
|
|
1132
|
+
*
|
|
1133
|
+
* @type {{ [key: string]: any; }}
|
|
1134
|
+
* @memberof InternalApiS3Webhook
|
|
1135
|
+
*/
|
|
1136
|
+
readonly requestBody: {
|
|
1137
|
+
[key: string]: any;
|
|
1138
|
+
};
|
|
1139
|
+
}
|
|
1140
|
+
/**
|
|
1141
|
+
* InternalApi - object-oriented interface
|
|
1142
|
+
* @export
|
|
1143
|
+
* @class InternalApi
|
|
1144
|
+
* @extends {BaseAPI}
|
|
1145
|
+
*/
|
|
1146
|
+
export declare class InternalApi extends BaseAPI {
|
|
1147
|
+
/**
|
|
1148
|
+
*
|
|
1149
|
+
* @summary Trigger (or retry) variant generation for an image
|
|
1150
|
+
* @param {InternalApiProcessImageRequest} requestParameters Request parameters.
|
|
1151
|
+
* @param {*} [options] Override http request option.
|
|
1152
|
+
* @throws {RequiredError}
|
|
1153
|
+
* @memberof InternalApi
|
|
1154
|
+
*/
|
|
1155
|
+
processImage(requestParameters: InternalApiProcessImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1156
|
+
/**
|
|
1157
|
+
*
|
|
1158
|
+
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
1159
|
+
* @param {InternalApiS3WebhookRequest} requestParameters Request parameters.
|
|
1160
|
+
* @param {*} [options] Override http request option.
|
|
1161
|
+
* @throws {RequiredError}
|
|
1162
|
+
* @memberof InternalApi
|
|
1163
|
+
*/
|
|
1164
|
+
s3Webhook(requestParameters: InternalApiS3WebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1165
|
+
}
|
|
1166
|
+
/**
|
|
1167
|
+
* LinkingApi - axios parameter creator
|
|
1168
|
+
* @export
|
|
1169
|
+
*/
|
|
1170
|
+
export declare const LinkingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1171
|
+
/**
|
|
1172
|
+
*
|
|
1173
|
+
* @summary Promote images from a product draft to a final product
|
|
1174
|
+
* @param {PromoteRequest} promoteRequest
|
|
1175
|
+
* @param {string} [idempotencyKey]
|
|
1176
|
+
* @param {*} [options] Override http request option.
|
|
1177
|
+
* @throws {RequiredError}
|
|
1178
|
+
*/
|
|
1179
|
+
promoteImages: (promoteRequest: PromoteRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1180
|
+
};
|
|
1181
|
+
/**
|
|
1182
|
+
* LinkingApi - functional programming interface
|
|
1183
|
+
* @export
|
|
1184
|
+
*/
|
|
1185
|
+
export declare const LinkingApiFp: (configuration?: Configuration) => {
|
|
1186
|
+
/**
|
|
1187
|
+
*
|
|
1188
|
+
* @summary Promote images from a product draft to a final product
|
|
1189
|
+
* @param {PromoteRequest} promoteRequest
|
|
1190
|
+
* @param {string} [idempotencyKey]
|
|
1191
|
+
* @param {*} [options] Override http request option.
|
|
1192
|
+
* @throws {RequiredError}
|
|
1193
|
+
*/
|
|
1194
|
+
promoteImages(promoteRequest: PromoteRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoteImages200Response>>;
|
|
1195
|
+
};
|
|
1196
|
+
/**
|
|
1197
|
+
* LinkingApi - factory interface
|
|
1198
|
+
* @export
|
|
1199
|
+
*/
|
|
1200
|
+
export declare const LinkingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1201
|
+
/**
|
|
1202
|
+
*
|
|
1203
|
+
* @summary Promote images from a product draft to a final product
|
|
1204
|
+
* @param {LinkingApiPromoteImagesRequest} requestParameters Request parameters.
|
|
1205
|
+
* @param {*} [options] Override http request option.
|
|
1206
|
+
* @throws {RequiredError}
|
|
1207
|
+
*/
|
|
1208
|
+
promoteImages(requestParameters: LinkingApiPromoteImagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<PromoteImages200Response>;
|
|
1209
|
+
};
|
|
1210
|
+
/**
|
|
1211
|
+
* Request parameters for promoteImages operation in LinkingApi.
|
|
1212
|
+
* @export
|
|
1213
|
+
* @interface LinkingApiPromoteImagesRequest
|
|
1214
|
+
*/
|
|
1215
|
+
export interface LinkingApiPromoteImagesRequest {
|
|
1216
|
+
/**
|
|
1217
|
+
*
|
|
1218
|
+
* @type {PromoteRequest}
|
|
1219
|
+
* @memberof LinkingApiPromoteImages
|
|
1220
|
+
*/
|
|
1221
|
+
readonly promoteRequest: PromoteRequest;
|
|
1222
|
+
/**
|
|
1223
|
+
*
|
|
1224
|
+
* @type {string}
|
|
1225
|
+
* @memberof LinkingApiPromoteImages
|
|
1226
|
+
*/
|
|
1227
|
+
readonly idempotencyKey?: string;
|
|
1228
|
+
}
|
|
1229
|
+
/**
|
|
1230
|
+
* LinkingApi - object-oriented interface
|
|
1231
|
+
* @export
|
|
1232
|
+
* @class LinkingApi
|
|
1233
|
+
* @extends {BaseAPI}
|
|
1234
|
+
*/
|
|
1235
|
+
export declare class LinkingApi extends BaseAPI {
|
|
1236
|
+
/**
|
|
1237
|
+
*
|
|
1238
|
+
* @summary Promote images from a product draft to a final product
|
|
1239
|
+
* @param {LinkingApiPromoteImagesRequest} requestParameters Request parameters.
|
|
1240
|
+
* @param {*} [options] Override http request option.
|
|
1241
|
+
* @throws {RequiredError}
|
|
1242
|
+
* @memberof LinkingApi
|
|
1243
|
+
*/
|
|
1244
|
+
promoteImages(requestParameters: LinkingApiPromoteImagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoteImages200Response, any, {}>>;
|
|
1245
|
+
}
|
|
1246
|
+
/**
|
|
1247
|
+
* PresignApi - axios parameter creator
|
|
1248
|
+
* @export
|
|
1249
|
+
*/
|
|
1250
|
+
export declare const PresignApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1251
|
+
/**
|
|
1252
|
+
*
|
|
1253
|
+
* @summary Create a presigned PUT URL for uploading an image to MinIO/S3
|
|
1254
|
+
* @param {PresignRequest} presignRequest
|
|
1255
|
+
* @param {string} [idempotencyKey] Idempotency key for safe retries.
|
|
1256
|
+
* @param {*} [options] Override http request option.
|
|
1257
|
+
* @throws {RequiredError}
|
|
1258
|
+
*/
|
|
1259
|
+
createPresign: (presignRequest: PresignRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1260
|
+
};
|
|
1261
|
+
/**
|
|
1262
|
+
* PresignApi - functional programming interface
|
|
1263
|
+
* @export
|
|
1264
|
+
*/
|
|
1265
|
+
export declare const PresignApiFp: (configuration?: Configuration) => {
|
|
1266
|
+
/**
|
|
1267
|
+
*
|
|
1268
|
+
* @summary Create a presigned PUT URL for uploading an image to MinIO/S3
|
|
1269
|
+
* @param {PresignRequest} presignRequest
|
|
1270
|
+
* @param {string} [idempotencyKey] Idempotency key for safe retries.
|
|
1271
|
+
* @param {*} [options] Override http request option.
|
|
1272
|
+
* @throws {RequiredError}
|
|
1273
|
+
*/
|
|
1274
|
+
createPresign(presignRequest: PresignRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PresignResponse>>;
|
|
1275
|
+
};
|
|
1276
|
+
/**
|
|
1277
|
+
* PresignApi - factory interface
|
|
1278
|
+
* @export
|
|
1279
|
+
*/
|
|
1280
|
+
export declare const PresignApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1281
|
+
/**
|
|
1282
|
+
*
|
|
1283
|
+
* @summary Create a presigned PUT URL for uploading an image to MinIO/S3
|
|
1284
|
+
* @param {PresignApiCreatePresignRequest} requestParameters Request parameters.
|
|
1285
|
+
* @param {*} [options] Override http request option.
|
|
1286
|
+
* @throws {RequiredError}
|
|
1287
|
+
*/
|
|
1288
|
+
createPresign(requestParameters: PresignApiCreatePresignRequest, options?: RawAxiosRequestConfig): AxiosPromise<PresignResponse>;
|
|
1289
|
+
};
|
|
1290
|
+
/**
|
|
1291
|
+
* Request parameters for createPresign operation in PresignApi.
|
|
1292
|
+
* @export
|
|
1293
|
+
* @interface PresignApiCreatePresignRequest
|
|
1294
|
+
*/
|
|
1295
|
+
export interface PresignApiCreatePresignRequest {
|
|
1296
|
+
/**
|
|
1297
|
+
*
|
|
1298
|
+
* @type {PresignRequest}
|
|
1299
|
+
* @memberof PresignApiCreatePresign
|
|
1300
|
+
*/
|
|
1301
|
+
readonly presignRequest: PresignRequest;
|
|
1302
|
+
/**
|
|
1303
|
+
* Idempotency key for safe retries.
|
|
1304
|
+
* @type {string}
|
|
1305
|
+
* @memberof PresignApiCreatePresign
|
|
1306
|
+
*/
|
|
1307
|
+
readonly idempotencyKey?: string;
|
|
1308
|
+
}
|
|
1309
|
+
/**
|
|
1310
|
+
* PresignApi - object-oriented interface
|
|
1311
|
+
* @export
|
|
1312
|
+
* @class PresignApi
|
|
1313
|
+
* @extends {BaseAPI}
|
|
1314
|
+
*/
|
|
1315
|
+
export declare class PresignApi extends BaseAPI {
|
|
1316
|
+
/**
|
|
1317
|
+
*
|
|
1318
|
+
* @summary Create a presigned PUT URL for uploading an image to MinIO/S3
|
|
1319
|
+
* @param {PresignApiCreatePresignRequest} requestParameters Request parameters.
|
|
1320
|
+
* @param {*} [options] Override http request option.
|
|
1321
|
+
* @throws {RequiredError}
|
|
1322
|
+
* @memberof PresignApi
|
|
1323
|
+
*/
|
|
1324
|
+
createPresign(requestParameters: PresignApiCreatePresignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PresignResponse, any, {}>>;
|
|
1325
|
+
}
|