@sokol111/ecommerce-image-service-api 1.0.3 → 1.0.5
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 +323 -463
- package/dist/api.js +440 -591
- package/dist/base.d.ts +2 -2
- package/dist/base.js +3 -3
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Image Service API
|
|
3
|
-
* API for
|
|
3
|
+
* API for managing images
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0.
|
|
5
|
+
* The version of the OpenAPI document: 1.0.5
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -42,25 +42,19 @@ export interface ConfirmRequest {
|
|
|
42
42
|
* @type {string}
|
|
43
43
|
* @memberof ConfirmRequest
|
|
44
44
|
*/
|
|
45
|
-
'
|
|
45
|
+
'alt': string;
|
|
46
46
|
/**
|
|
47
47
|
*
|
|
48
48
|
* @type {string}
|
|
49
49
|
* @memberof ConfirmRequest
|
|
50
50
|
*/
|
|
51
|
-
'
|
|
52
|
-
/**
|
|
53
|
-
*
|
|
54
|
-
* @type {string}
|
|
55
|
-
* @memberof ConfirmRequest
|
|
56
|
-
*/
|
|
57
|
-
'mime'?: ConfirmRequestMimeEnum;
|
|
51
|
+
'mime': ConfirmRequestMimeEnum;
|
|
58
52
|
/**
|
|
59
53
|
*
|
|
60
54
|
* @type {ImageRole}
|
|
61
55
|
* @memberof ConfirmRequest
|
|
62
56
|
*/
|
|
63
|
-
'role'
|
|
57
|
+
'role': ImageRole;
|
|
64
58
|
/**
|
|
65
59
|
* e.g., SHA256 hex for additional integrity check
|
|
66
60
|
* @type {string}
|
|
@@ -318,7 +312,7 @@ export interface PresignRequest {
|
|
|
318
312
|
* @type {ImageRole}
|
|
319
313
|
* @memberof PresignRequest
|
|
320
314
|
*/
|
|
321
|
-
'role'
|
|
315
|
+
'role': ImageRole;
|
|
322
316
|
}
|
|
323
317
|
export declare const PresignRequestContentTypeEnum: {
|
|
324
318
|
readonly ImageJpeg: "image/jpeg";
|
|
@@ -338,31 +332,25 @@ export interface PresignResponse {
|
|
|
338
332
|
* @type {string}
|
|
339
333
|
* @memberof PresignResponse
|
|
340
334
|
*/
|
|
341
|
-
'uploadUrl'
|
|
335
|
+
'uploadUrl': string;
|
|
342
336
|
/**
|
|
343
337
|
* Final S3 key to PUT to
|
|
344
338
|
* @type {string}
|
|
345
339
|
* @memberof PresignResponse
|
|
346
340
|
*/
|
|
347
|
-
'key'
|
|
348
|
-
/**
|
|
349
|
-
* Temporary ID for idempotency/confirm
|
|
350
|
-
* @type {string}
|
|
351
|
-
* @memberof PresignResponse
|
|
352
|
-
*/
|
|
353
|
-
'tempId'?: string;
|
|
341
|
+
'key': string;
|
|
354
342
|
/**
|
|
355
343
|
* TTL in seconds
|
|
356
344
|
* @type {number}
|
|
357
345
|
* @memberof PresignResponse
|
|
358
346
|
*/
|
|
359
|
-
'expiresIn'
|
|
347
|
+
'expiresIn': number;
|
|
360
348
|
/**
|
|
361
349
|
*
|
|
362
350
|
* @type {{ [key: string]: string; }}
|
|
363
351
|
* @memberof PresignResponse
|
|
364
352
|
*/
|
|
365
|
-
'requiredHeaders'
|
|
353
|
+
'requiredHeaders': {
|
|
366
354
|
[key: string]: string;
|
|
367
355
|
};
|
|
368
356
|
}
|
|
@@ -516,32 +504,35 @@ export interface Variant {
|
|
|
516
504
|
'size'?: number;
|
|
517
505
|
}
|
|
518
506
|
/**
|
|
519
|
-
*
|
|
507
|
+
* DefaultApi - axios parameter creator
|
|
520
508
|
* @export
|
|
521
509
|
*/
|
|
522
|
-
export declare const
|
|
510
|
+
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
523
511
|
/**
|
|
524
512
|
*
|
|
525
|
-
* @summary
|
|
513
|
+
* @summary Confirm upload (HEAD against S3), persist metadata
|
|
514
|
+
* @param {ConfirmRequest} confirmRequest
|
|
515
|
+
* @param {*} [options] Override http request option.
|
|
516
|
+
* @throws {RequiredError}
|
|
517
|
+
*/
|
|
518
|
+
confirmUpload: (confirmRequest: ConfirmRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
519
|
+
/**
|
|
520
|
+
*
|
|
521
|
+
* @summary Create a presigned PUT URL for uploading an image to MinIO/S3
|
|
522
|
+
* @param {PresignRequest} presignRequest
|
|
523
|
+
* @param {*} [options] Override http request option.
|
|
524
|
+
* @throws {RequiredError}
|
|
525
|
+
*/
|
|
526
|
+
createPresign: (presignRequest: PresignRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
527
|
+
/**
|
|
528
|
+
*
|
|
529
|
+
* @summary Delete image (soft or hard, per policy)
|
|
526
530
|
* @param {string} id
|
|
527
|
-
* @param {
|
|
528
|
-
* @param {number} [w]
|
|
529
|
-
* @param {number} [h]
|
|
530
|
-
* @param {GetDeliveryUrlFitEnum} [fit]
|
|
531
|
-
* @param {GetDeliveryUrlFormatEnum} [format]
|
|
532
|
-
* @param {number} [quality]
|
|
533
|
-
* @param {number} [dpr]
|
|
534
|
-
* @param {number} [ttlSeconds]
|
|
531
|
+
* @param {boolean} [hard]
|
|
535
532
|
* @param {*} [options] Override http request option.
|
|
536
533
|
* @throws {RequiredError}
|
|
537
534
|
*/
|
|
538
|
-
|
|
539
|
-
};
|
|
540
|
-
/**
|
|
541
|
-
* DeliveryApi - functional programming interface
|
|
542
|
-
* @export
|
|
543
|
-
*/
|
|
544
|
-
export declare const DeliveryApiFp: (configuration?: Configuration) => {
|
|
535
|
+
deleteImage: (id: string, hard?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
545
536
|
/**
|
|
546
537
|
*
|
|
547
538
|
* @summary Generate a signed imgproxy URL for delivery with requested params
|
|
@@ -557,136 +548,84 @@ export declare const DeliveryApiFp: (configuration?: Configuration) => {
|
|
|
557
548
|
* @param {*} [options] Override http request option.
|
|
558
549
|
* @throws {RequiredError}
|
|
559
550
|
*/
|
|
560
|
-
getDeliveryUrl(id: string, variant?: string, w?: number, h?: number, fit?: GetDeliveryUrlFitEnum, format?: GetDeliveryUrlFormatEnum, quality?: number, dpr?: number, ttlSeconds?: number, options?: RawAxiosRequestConfig)
|
|
561
|
-
};
|
|
562
|
-
/**
|
|
563
|
-
* DeliveryApi - factory interface
|
|
564
|
-
* @export
|
|
565
|
-
*/
|
|
566
|
-
export declare const DeliveryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
551
|
+
getDeliveryUrl: (id: string, variant?: string, w?: number, h?: number, fit?: GetDeliveryUrlFitEnum, format?: GetDeliveryUrlFormatEnum, quality?: number, dpr?: number, ttlSeconds?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
567
552
|
/**
|
|
568
553
|
*
|
|
569
|
-
* @summary
|
|
570
|
-
* @param {
|
|
554
|
+
* @summary Get image metadata
|
|
555
|
+
* @param {string} id
|
|
571
556
|
* @param {*} [options] Override http request option.
|
|
572
557
|
* @throws {RequiredError}
|
|
573
558
|
*/
|
|
574
|
-
|
|
575
|
-
};
|
|
576
|
-
/**
|
|
577
|
-
* Request parameters for getDeliveryUrl operation in DeliveryApi.
|
|
578
|
-
* @export
|
|
579
|
-
* @interface DeliveryApiGetDeliveryUrlRequest
|
|
580
|
-
*/
|
|
581
|
-
export interface DeliveryApiGetDeliveryUrlRequest {
|
|
582
|
-
/**
|
|
583
|
-
*
|
|
584
|
-
* @type {string}
|
|
585
|
-
* @memberof DeliveryApiGetDeliveryUrl
|
|
586
|
-
*/
|
|
587
|
-
readonly id: string;
|
|
588
|
-
/**
|
|
589
|
-
*
|
|
590
|
-
* @type {string}
|
|
591
|
-
* @memberof DeliveryApiGetDeliveryUrl
|
|
592
|
-
*/
|
|
593
|
-
readonly variant?: string;
|
|
594
|
-
/**
|
|
595
|
-
*
|
|
596
|
-
* @type {number}
|
|
597
|
-
* @memberof DeliveryApiGetDeliveryUrl
|
|
598
|
-
*/
|
|
599
|
-
readonly w?: number;
|
|
600
|
-
/**
|
|
601
|
-
*
|
|
602
|
-
* @type {number}
|
|
603
|
-
* @memberof DeliveryApiGetDeliveryUrl
|
|
604
|
-
*/
|
|
605
|
-
readonly h?: number;
|
|
606
|
-
/**
|
|
607
|
-
*
|
|
608
|
-
* @type {'cover' | 'contain' | 'fill' | 'inside' | 'outside'}
|
|
609
|
-
* @memberof DeliveryApiGetDeliveryUrl
|
|
610
|
-
*/
|
|
611
|
-
readonly fit?: GetDeliveryUrlFitEnum;
|
|
559
|
+
getImage: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
612
560
|
/**
|
|
613
561
|
*
|
|
614
|
-
* @
|
|
615
|
-
* @
|
|
562
|
+
* @summary List/search images by owner/filters
|
|
563
|
+
* @param {OwnerType} [ownerType]
|
|
564
|
+
* @param {string} [ownerId]
|
|
565
|
+
* @param {ImageStatus} [status]
|
|
566
|
+
* @param {number} [page]
|
|
567
|
+
* @param {number} [pageSize]
|
|
568
|
+
* @param {*} [options] Override http request option.
|
|
569
|
+
* @throws {RequiredError}
|
|
616
570
|
*/
|
|
617
|
-
|
|
571
|
+
listImages: (ownerType?: OwnerType, ownerId?: string, status?: ImageStatus, page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
618
572
|
/**
|
|
619
573
|
*
|
|
620
|
-
* @
|
|
621
|
-
* @
|
|
574
|
+
* @summary Trigger (or retry) variant generation for an image
|
|
575
|
+
* @param {ProcessImageRequest} processImageRequest
|
|
576
|
+
* @param {*} [options] Override http request option.
|
|
577
|
+
* @throws {RequiredError}
|
|
622
578
|
*/
|
|
623
|
-
|
|
579
|
+
processImage: (processImageRequest: ProcessImageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
624
580
|
/**
|
|
625
581
|
*
|
|
626
|
-
* @
|
|
627
|
-
* @
|
|
582
|
+
* @summary Promote images from a product draft to a final product
|
|
583
|
+
* @param {PromoteRequest} promoteRequest
|
|
584
|
+
* @param {*} [options] Override http request option.
|
|
585
|
+
* @throws {RequiredError}
|
|
628
586
|
*/
|
|
629
|
-
|
|
587
|
+
promoteImages: (promoteRequest: PromoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
630
588
|
/**
|
|
631
589
|
*
|
|
632
|
-
* @
|
|
633
|
-
* @
|
|
590
|
+
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
591
|
+
* @param {{ [key: string]: any; }} requestBody
|
|
592
|
+
* @param {*} [options] Override http request option.
|
|
593
|
+
* @throws {RequiredError}
|
|
634
594
|
*/
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
* DeliveryApi - object-oriented interface
|
|
639
|
-
* @export
|
|
640
|
-
* @class DeliveryApi
|
|
641
|
-
* @extends {BaseAPI}
|
|
642
|
-
*/
|
|
643
|
-
export declare class DeliveryApi extends BaseAPI {
|
|
595
|
+
s3Webhook: (requestBody: {
|
|
596
|
+
[key: string]: any;
|
|
597
|
+
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
644
598
|
/**
|
|
645
599
|
*
|
|
646
|
-
* @summary
|
|
647
|
-
* @param {
|
|
600
|
+
* @summary Update image metadata (alt, role, order)
|
|
601
|
+
* @param {string} id
|
|
602
|
+
* @param {ImagePatch} imagePatch
|
|
648
603
|
* @param {*} [options] Override http request option.
|
|
649
604
|
* @throws {RequiredError}
|
|
650
|
-
* @memberof DeliveryApi
|
|
651
605
|
*/
|
|
652
|
-
|
|
653
|
-
}
|
|
654
|
-
/**
|
|
655
|
-
* @export
|
|
656
|
-
*/
|
|
657
|
-
export declare const GetDeliveryUrlFitEnum: {
|
|
658
|
-
readonly Cover: "cover";
|
|
659
|
-
readonly Contain: "contain";
|
|
660
|
-
readonly Fill: "fill";
|
|
661
|
-
readonly Inside: "inside";
|
|
662
|
-
readonly Outside: "outside";
|
|
663
|
-
};
|
|
664
|
-
export type GetDeliveryUrlFitEnum = typeof GetDeliveryUrlFitEnum[keyof typeof GetDeliveryUrlFitEnum];
|
|
665
|
-
/**
|
|
666
|
-
* @export
|
|
667
|
-
*/
|
|
668
|
-
export declare const GetDeliveryUrlFormatEnum: {
|
|
669
|
-
readonly Original: "original";
|
|
670
|
-
readonly Webp: "webp";
|
|
671
|
-
readonly Avif: "avif";
|
|
672
|
-
readonly Jpeg: "jpeg";
|
|
673
|
-
readonly Png: "png";
|
|
606
|
+
updateImage: (id: string, imagePatch: ImagePatch, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
674
607
|
};
|
|
675
|
-
export type GetDeliveryUrlFormatEnum = typeof GetDeliveryUrlFormatEnum[keyof typeof GetDeliveryUrlFormatEnum];
|
|
676
608
|
/**
|
|
677
|
-
*
|
|
609
|
+
* DefaultApi - functional programming interface
|
|
678
610
|
* @export
|
|
679
611
|
*/
|
|
680
|
-
export declare const
|
|
612
|
+
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
681
613
|
/**
|
|
682
614
|
*
|
|
683
615
|
* @summary Confirm upload (HEAD against S3), persist metadata
|
|
684
616
|
* @param {ConfirmRequest} confirmRequest
|
|
685
|
-
* @param {string} [idempotencyKey] Idempotency key for safe retries.
|
|
686
617
|
* @param {*} [options] Override http request option.
|
|
687
618
|
* @throws {RequiredError}
|
|
688
619
|
*/
|
|
689
|
-
confirmUpload
|
|
620
|
+
confirmUpload(confirmRequest: ConfirmRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Image>>;
|
|
621
|
+
/**
|
|
622
|
+
*
|
|
623
|
+
* @summary Create a presigned PUT URL for uploading an image to MinIO/S3
|
|
624
|
+
* @param {PresignRequest} presignRequest
|
|
625
|
+
* @param {*} [options] Override http request option.
|
|
626
|
+
* @throws {RequiredError}
|
|
627
|
+
*/
|
|
628
|
+
createPresign(presignRequest: PresignRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PresignResponse>>;
|
|
690
629
|
/**
|
|
691
630
|
*
|
|
692
631
|
* @summary Delete image (soft or hard, per policy)
|
|
@@ -695,7 +634,23 @@ export declare const ImagesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
695
634
|
* @param {*} [options] Override http request option.
|
|
696
635
|
* @throws {RequiredError}
|
|
697
636
|
*/
|
|
698
|
-
deleteImage
|
|
637
|
+
deleteImage(id: string, hard?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
638
|
+
/**
|
|
639
|
+
*
|
|
640
|
+
* @summary Generate a signed imgproxy URL for delivery with requested params
|
|
641
|
+
* @param {string} id
|
|
642
|
+
* @param {string} [variant]
|
|
643
|
+
* @param {number} [w]
|
|
644
|
+
* @param {number} [h]
|
|
645
|
+
* @param {GetDeliveryUrlFitEnum} [fit]
|
|
646
|
+
* @param {GetDeliveryUrlFormatEnum} [format]
|
|
647
|
+
* @param {number} [quality]
|
|
648
|
+
* @param {number} [dpr]
|
|
649
|
+
* @param {number} [ttlSeconds]
|
|
650
|
+
* @param {*} [options] Override http request option.
|
|
651
|
+
* @throws {RequiredError}
|
|
652
|
+
*/
|
|
653
|
+
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>>;
|
|
699
654
|
/**
|
|
700
655
|
*
|
|
701
656
|
* @summary Get image metadata
|
|
@@ -703,7 +658,7 @@ export declare const ImagesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
703
658
|
* @param {*} [options] Override http request option.
|
|
704
659
|
* @throws {RequiredError}
|
|
705
660
|
*/
|
|
706
|
-
getImage
|
|
661
|
+
getImage(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Image>>;
|
|
707
662
|
/**
|
|
708
663
|
*
|
|
709
664
|
* @summary List/search images by owner/filters
|
|
@@ -715,7 +670,33 @@ export declare const ImagesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
715
670
|
* @param {*} [options] Override http request option.
|
|
716
671
|
* @throws {RequiredError}
|
|
717
672
|
*/
|
|
718
|
-
listImages
|
|
673
|
+
listImages(ownerType?: OwnerType, ownerId?: string, status?: ImageStatus, page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListImages200Response>>;
|
|
674
|
+
/**
|
|
675
|
+
*
|
|
676
|
+
* @summary Trigger (or retry) variant generation for an image
|
|
677
|
+
* @param {ProcessImageRequest} processImageRequest
|
|
678
|
+
* @param {*} [options] Override http request option.
|
|
679
|
+
* @throws {RequiredError}
|
|
680
|
+
*/
|
|
681
|
+
processImage(processImageRequest: ProcessImageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
682
|
+
/**
|
|
683
|
+
*
|
|
684
|
+
* @summary Promote images from a product draft to a final product
|
|
685
|
+
* @param {PromoteRequest} promoteRequest
|
|
686
|
+
* @param {*} [options] Override http request option.
|
|
687
|
+
* @throws {RequiredError}
|
|
688
|
+
*/
|
|
689
|
+
promoteImages(promoteRequest: PromoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromoteImages200Response>>;
|
|
690
|
+
/**
|
|
691
|
+
*
|
|
692
|
+
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
693
|
+
* @param {{ [key: string]: any; }} requestBody
|
|
694
|
+
* @param {*} [options] Override http request option.
|
|
695
|
+
* @throws {RequiredError}
|
|
696
|
+
*/
|
|
697
|
+
s3Webhook(requestBody: {
|
|
698
|
+
[key: string]: any;
|
|
699
|
+
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
719
700
|
/**
|
|
720
701
|
*
|
|
721
702
|
* @summary Update image metadata (alt, role, order)
|
|
@@ -724,548 +705,427 @@ export declare const ImagesApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
724
705
|
* @param {*} [options] Override http request option.
|
|
725
706
|
* @throws {RequiredError}
|
|
726
707
|
*/
|
|
727
|
-
updateImage
|
|
708
|
+
updateImage(id: string, imagePatch: ImagePatch, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Image>>;
|
|
728
709
|
};
|
|
729
710
|
/**
|
|
730
|
-
*
|
|
711
|
+
* DefaultApi - factory interface
|
|
731
712
|
* @export
|
|
732
713
|
*/
|
|
733
|
-
export declare const
|
|
714
|
+
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
734
715
|
/**
|
|
735
716
|
*
|
|
736
717
|
* @summary Confirm upload (HEAD against S3), persist metadata
|
|
737
|
-
* @param {
|
|
738
|
-
* @param {string} [idempotencyKey] Idempotency key for safe retries.
|
|
718
|
+
* @param {DefaultApiConfirmUploadRequest} requestParameters Request parameters.
|
|
739
719
|
* @param {*} [options] Override http request option.
|
|
740
720
|
* @throws {RequiredError}
|
|
741
721
|
*/
|
|
742
|
-
confirmUpload(
|
|
722
|
+
confirmUpload(requestParameters: DefaultApiConfirmUploadRequest, options?: RawAxiosRequestConfig): AxiosPromise<Image>;
|
|
743
723
|
/**
|
|
744
724
|
*
|
|
745
|
-
* @summary
|
|
746
|
-
* @param {
|
|
747
|
-
* @param {boolean} [hard]
|
|
725
|
+
* @summary Create a presigned PUT URL for uploading an image to MinIO/S3
|
|
726
|
+
* @param {DefaultApiCreatePresignRequest} requestParameters Request parameters.
|
|
748
727
|
* @param {*} [options] Override http request option.
|
|
749
728
|
* @throws {RequiredError}
|
|
750
729
|
*/
|
|
751
|
-
|
|
730
|
+
createPresign(requestParameters: DefaultApiCreatePresignRequest, options?: RawAxiosRequestConfig): AxiosPromise<PresignResponse>;
|
|
752
731
|
/**
|
|
753
732
|
*
|
|
754
|
-
* @summary
|
|
755
|
-
* @param {
|
|
733
|
+
* @summary Delete image (soft or hard, per policy)
|
|
734
|
+
* @param {DefaultApiDeleteImageRequest} requestParameters Request parameters.
|
|
756
735
|
* @param {*} [options] Override http request option.
|
|
757
736
|
* @throws {RequiredError}
|
|
758
737
|
*/
|
|
759
|
-
|
|
738
|
+
deleteImage(requestParameters: DefaultApiDeleteImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
760
739
|
/**
|
|
761
740
|
*
|
|
762
|
-
* @summary
|
|
763
|
-
* @param {
|
|
764
|
-
* @param {string} [ownerId]
|
|
765
|
-
* @param {ImageStatus} [status]
|
|
766
|
-
* @param {number} [page]
|
|
767
|
-
* @param {number} [pageSize]
|
|
741
|
+
* @summary Generate a signed imgproxy URL for delivery with requested params
|
|
742
|
+
* @param {DefaultApiGetDeliveryUrlRequest} requestParameters Request parameters.
|
|
768
743
|
* @param {*} [options] Override http request option.
|
|
769
744
|
* @throws {RequiredError}
|
|
770
745
|
*/
|
|
771
|
-
|
|
746
|
+
getDeliveryUrl(requestParameters: DefaultApiGetDeliveryUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeliveryUrl200Response>;
|
|
772
747
|
/**
|
|
773
748
|
*
|
|
774
|
-
* @summary
|
|
775
|
-
* @param {
|
|
776
|
-
* @param {ImagePatch} imagePatch
|
|
749
|
+
* @summary Get image metadata
|
|
750
|
+
* @param {DefaultApiGetImageRequest} requestParameters Request parameters.
|
|
777
751
|
* @param {*} [options] Override http request option.
|
|
778
752
|
* @throws {RequiredError}
|
|
779
753
|
*/
|
|
780
|
-
|
|
781
|
-
};
|
|
782
|
-
/**
|
|
783
|
-
* ImagesApi - factory interface
|
|
784
|
-
* @export
|
|
785
|
-
*/
|
|
786
|
-
export declare const ImagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
754
|
+
getImage(requestParameters: DefaultApiGetImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Image>;
|
|
787
755
|
/**
|
|
788
756
|
*
|
|
789
|
-
* @summary
|
|
790
|
-
* @param {
|
|
757
|
+
* @summary List/search images by owner/filters
|
|
758
|
+
* @param {DefaultApiListImagesRequest} requestParameters Request parameters.
|
|
791
759
|
* @param {*} [options] Override http request option.
|
|
792
760
|
* @throws {RequiredError}
|
|
793
761
|
*/
|
|
794
|
-
|
|
762
|
+
listImages(requestParameters?: DefaultApiListImagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListImages200Response>;
|
|
795
763
|
/**
|
|
796
764
|
*
|
|
797
|
-
* @summary
|
|
798
|
-
* @param {
|
|
765
|
+
* @summary Trigger (or retry) variant generation for an image
|
|
766
|
+
* @param {DefaultApiProcessImageRequest} requestParameters Request parameters.
|
|
799
767
|
* @param {*} [options] Override http request option.
|
|
800
768
|
* @throws {RequiredError}
|
|
801
769
|
*/
|
|
802
|
-
|
|
770
|
+
processImage(requestParameters: DefaultApiProcessImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
803
771
|
/**
|
|
804
772
|
*
|
|
805
|
-
* @summary
|
|
806
|
-
* @param {
|
|
773
|
+
* @summary Promote images from a product draft to a final product
|
|
774
|
+
* @param {DefaultApiPromoteImagesRequest} requestParameters Request parameters.
|
|
807
775
|
* @param {*} [options] Override http request option.
|
|
808
776
|
* @throws {RequiredError}
|
|
809
777
|
*/
|
|
810
|
-
|
|
778
|
+
promoteImages(requestParameters: DefaultApiPromoteImagesRequest, options?: RawAxiosRequestConfig): AxiosPromise<PromoteImages200Response>;
|
|
811
779
|
/**
|
|
812
780
|
*
|
|
813
|
-
* @summary
|
|
814
|
-
* @param {
|
|
781
|
+
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
782
|
+
* @param {DefaultApiS3WebhookRequest} requestParameters Request parameters.
|
|
815
783
|
* @param {*} [options] Override http request option.
|
|
816
784
|
* @throws {RequiredError}
|
|
817
785
|
*/
|
|
818
|
-
|
|
786
|
+
s3Webhook(requestParameters: DefaultApiS3WebhookRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
819
787
|
/**
|
|
820
788
|
*
|
|
821
789
|
* @summary Update image metadata (alt, role, order)
|
|
822
|
-
* @param {
|
|
790
|
+
* @param {DefaultApiUpdateImageRequest} requestParameters Request parameters.
|
|
823
791
|
* @param {*} [options] Override http request option.
|
|
824
792
|
* @throws {RequiredError}
|
|
825
793
|
*/
|
|
826
|
-
updateImage(requestParameters:
|
|
794
|
+
updateImage(requestParameters: DefaultApiUpdateImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<Image>;
|
|
827
795
|
};
|
|
828
796
|
/**
|
|
829
|
-
* Request parameters for confirmUpload operation in
|
|
797
|
+
* Request parameters for confirmUpload operation in DefaultApi.
|
|
830
798
|
* @export
|
|
831
|
-
* @interface
|
|
799
|
+
* @interface DefaultApiConfirmUploadRequest
|
|
832
800
|
*/
|
|
833
|
-
export interface
|
|
801
|
+
export interface DefaultApiConfirmUploadRequest {
|
|
834
802
|
/**
|
|
835
803
|
*
|
|
836
804
|
* @type {ConfirmRequest}
|
|
837
|
-
* @memberof
|
|
805
|
+
* @memberof DefaultApiConfirmUpload
|
|
838
806
|
*/
|
|
839
807
|
readonly confirmRequest: ConfirmRequest;
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* Request parameters for createPresign operation in DefaultApi.
|
|
811
|
+
* @export
|
|
812
|
+
* @interface DefaultApiCreatePresignRequest
|
|
813
|
+
*/
|
|
814
|
+
export interface DefaultApiCreatePresignRequest {
|
|
840
815
|
/**
|
|
841
|
-
*
|
|
842
|
-
* @type {
|
|
843
|
-
* @memberof
|
|
816
|
+
*
|
|
817
|
+
* @type {PresignRequest}
|
|
818
|
+
* @memberof DefaultApiCreatePresign
|
|
844
819
|
*/
|
|
845
|
-
readonly
|
|
820
|
+
readonly presignRequest: PresignRequest;
|
|
846
821
|
}
|
|
847
822
|
/**
|
|
848
|
-
* Request parameters for deleteImage operation in
|
|
823
|
+
* Request parameters for deleteImage operation in DefaultApi.
|
|
849
824
|
* @export
|
|
850
|
-
* @interface
|
|
825
|
+
* @interface DefaultApiDeleteImageRequest
|
|
851
826
|
*/
|
|
852
|
-
export interface
|
|
827
|
+
export interface DefaultApiDeleteImageRequest {
|
|
853
828
|
/**
|
|
854
829
|
*
|
|
855
830
|
* @type {string}
|
|
856
|
-
* @memberof
|
|
831
|
+
* @memberof DefaultApiDeleteImage
|
|
857
832
|
*/
|
|
858
833
|
readonly id: string;
|
|
859
834
|
/**
|
|
860
835
|
*
|
|
861
836
|
* @type {boolean}
|
|
862
|
-
* @memberof
|
|
837
|
+
* @memberof DefaultApiDeleteImage
|
|
863
838
|
*/
|
|
864
839
|
readonly hard?: boolean;
|
|
865
840
|
}
|
|
866
841
|
/**
|
|
867
|
-
* Request parameters for
|
|
842
|
+
* Request parameters for getDeliveryUrl operation in DefaultApi.
|
|
868
843
|
* @export
|
|
869
|
-
* @interface
|
|
844
|
+
* @interface DefaultApiGetDeliveryUrlRequest
|
|
870
845
|
*/
|
|
871
|
-
export interface
|
|
846
|
+
export interface DefaultApiGetDeliveryUrlRequest {
|
|
872
847
|
/**
|
|
873
848
|
*
|
|
874
849
|
* @type {string}
|
|
875
|
-
* @memberof
|
|
850
|
+
* @memberof DefaultApiGetDeliveryUrl
|
|
876
851
|
*/
|
|
877
852
|
readonly id: string;
|
|
878
|
-
}
|
|
879
|
-
/**
|
|
880
|
-
* Request parameters for listImages operation in ImagesApi.
|
|
881
|
-
* @export
|
|
882
|
-
* @interface ImagesApiListImagesRequest
|
|
883
|
-
*/
|
|
884
|
-
export interface ImagesApiListImagesRequest {
|
|
885
853
|
/**
|
|
886
854
|
*
|
|
887
|
-
* @type {
|
|
888
|
-
* @memberof
|
|
855
|
+
* @type {string}
|
|
856
|
+
* @memberof DefaultApiGetDeliveryUrl
|
|
889
857
|
*/
|
|
890
|
-
readonly
|
|
858
|
+
readonly variant?: string;
|
|
891
859
|
/**
|
|
892
860
|
*
|
|
893
|
-
* @type {
|
|
894
|
-
* @memberof
|
|
861
|
+
* @type {number}
|
|
862
|
+
* @memberof DefaultApiGetDeliveryUrl
|
|
895
863
|
*/
|
|
896
|
-
readonly
|
|
864
|
+
readonly w?: number;
|
|
897
865
|
/**
|
|
898
866
|
*
|
|
899
|
-
* @type {
|
|
900
|
-
* @memberof
|
|
867
|
+
* @type {number}
|
|
868
|
+
* @memberof DefaultApiGetDeliveryUrl
|
|
901
869
|
*/
|
|
902
|
-
readonly
|
|
870
|
+
readonly h?: number;
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @type {'cover' | 'contain' | 'fill' | 'inside' | 'outside'}
|
|
874
|
+
* @memberof DefaultApiGetDeliveryUrl
|
|
875
|
+
*/
|
|
876
|
+
readonly fit?: GetDeliveryUrlFitEnum;
|
|
877
|
+
/**
|
|
878
|
+
*
|
|
879
|
+
* @type {'original' | 'webp' | 'avif' | 'jpeg' | 'png'}
|
|
880
|
+
* @memberof DefaultApiGetDeliveryUrl
|
|
881
|
+
*/
|
|
882
|
+
readonly format?: GetDeliveryUrlFormatEnum;
|
|
903
883
|
/**
|
|
904
884
|
*
|
|
905
885
|
* @type {number}
|
|
906
|
-
* @memberof
|
|
886
|
+
* @memberof DefaultApiGetDeliveryUrl
|
|
907
887
|
*/
|
|
908
|
-
readonly
|
|
888
|
+
readonly quality?: number;
|
|
909
889
|
/**
|
|
910
890
|
*
|
|
911
891
|
* @type {number}
|
|
912
|
-
* @memberof
|
|
892
|
+
* @memberof DefaultApiGetDeliveryUrl
|
|
913
893
|
*/
|
|
914
|
-
readonly
|
|
894
|
+
readonly dpr?: number;
|
|
895
|
+
/**
|
|
896
|
+
*
|
|
897
|
+
* @type {number}
|
|
898
|
+
* @memberof DefaultApiGetDeliveryUrl
|
|
899
|
+
*/
|
|
900
|
+
readonly ttlSeconds?: number;
|
|
915
901
|
}
|
|
916
902
|
/**
|
|
917
|
-
* Request parameters for
|
|
903
|
+
* Request parameters for getImage operation in DefaultApi.
|
|
918
904
|
* @export
|
|
919
|
-
* @interface
|
|
905
|
+
* @interface DefaultApiGetImageRequest
|
|
920
906
|
*/
|
|
921
|
-
export interface
|
|
907
|
+
export interface DefaultApiGetImageRequest {
|
|
922
908
|
/**
|
|
923
909
|
*
|
|
924
910
|
* @type {string}
|
|
925
|
-
* @memberof
|
|
911
|
+
* @memberof DefaultApiGetImage
|
|
926
912
|
*/
|
|
927
913
|
readonly id: string;
|
|
928
|
-
/**
|
|
929
|
-
*
|
|
930
|
-
* @type {ImagePatch}
|
|
931
|
-
* @memberof ImagesApiUpdateImage
|
|
932
|
-
*/
|
|
933
|
-
readonly imagePatch: ImagePatch;
|
|
934
914
|
}
|
|
935
915
|
/**
|
|
936
|
-
*
|
|
916
|
+
* Request parameters for listImages operation in DefaultApi.
|
|
937
917
|
* @export
|
|
938
|
-
* @
|
|
939
|
-
* @extends {BaseAPI}
|
|
918
|
+
* @interface DefaultApiListImagesRequest
|
|
940
919
|
*/
|
|
941
|
-
export
|
|
920
|
+
export interface DefaultApiListImagesRequest {
|
|
942
921
|
/**
|
|
943
922
|
*
|
|
944
|
-
* @
|
|
945
|
-
* @
|
|
946
|
-
* @param {*} [options] Override http request option.
|
|
947
|
-
* @throws {RequiredError}
|
|
948
|
-
* @memberof ImagesApi
|
|
923
|
+
* @type {OwnerType}
|
|
924
|
+
* @memberof DefaultApiListImages
|
|
949
925
|
*/
|
|
950
|
-
|
|
926
|
+
readonly ownerType?: OwnerType;
|
|
951
927
|
/**
|
|
952
928
|
*
|
|
953
|
-
* @
|
|
954
|
-
* @
|
|
955
|
-
* @param {*} [options] Override http request option.
|
|
956
|
-
* @throws {RequiredError}
|
|
957
|
-
* @memberof ImagesApi
|
|
929
|
+
* @type {string}
|
|
930
|
+
* @memberof DefaultApiListImages
|
|
958
931
|
*/
|
|
959
|
-
|
|
932
|
+
readonly ownerId?: string;
|
|
960
933
|
/**
|
|
961
934
|
*
|
|
962
|
-
* @
|
|
963
|
-
* @
|
|
964
|
-
* @param {*} [options] Override http request option.
|
|
965
|
-
* @throws {RequiredError}
|
|
966
|
-
* @memberof ImagesApi
|
|
935
|
+
* @type {ImageStatus}
|
|
936
|
+
* @memberof DefaultApiListImages
|
|
967
937
|
*/
|
|
968
|
-
|
|
938
|
+
readonly status?: ImageStatus;
|
|
969
939
|
/**
|
|
970
940
|
*
|
|
971
|
-
* @
|
|
972
|
-
* @
|
|
973
|
-
* @param {*} [options] Override http request option.
|
|
974
|
-
* @throws {RequiredError}
|
|
975
|
-
* @memberof ImagesApi
|
|
941
|
+
* @type {number}
|
|
942
|
+
* @memberof DefaultApiListImages
|
|
976
943
|
*/
|
|
977
|
-
|
|
944
|
+
readonly page?: number;
|
|
978
945
|
/**
|
|
979
946
|
*
|
|
980
|
-
* @
|
|
981
|
-
* @
|
|
982
|
-
* @param {*} [options] Override http request option.
|
|
983
|
-
* @throws {RequiredError}
|
|
984
|
-
* @memberof ImagesApi
|
|
947
|
+
* @type {number}
|
|
948
|
+
* @memberof DefaultApiListImages
|
|
985
949
|
*/
|
|
986
|
-
|
|
950
|
+
readonly pageSize?: number;
|
|
987
951
|
}
|
|
988
952
|
/**
|
|
989
|
-
*
|
|
953
|
+
* Request parameters for processImage operation in DefaultApi.
|
|
990
954
|
* @export
|
|
955
|
+
* @interface DefaultApiProcessImageRequest
|
|
991
956
|
*/
|
|
992
|
-
export
|
|
993
|
-
/**
|
|
994
|
-
*
|
|
995
|
-
* @summary Trigger (or retry) variant generation for an image
|
|
996
|
-
* @param {ProcessImageRequest} processImageRequest
|
|
997
|
-
* @param {*} [options] Override http request option.
|
|
998
|
-
* @throws {RequiredError}
|
|
999
|
-
*/
|
|
1000
|
-
processImage: (processImageRequest: ProcessImageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
957
|
+
export interface DefaultApiProcessImageRequest {
|
|
1001
958
|
/**
|
|
1002
959
|
*
|
|
1003
|
-
* @
|
|
1004
|
-
* @
|
|
1005
|
-
* @param {*} [options] Override http request option.
|
|
1006
|
-
* @throws {RequiredError}
|
|
960
|
+
* @type {ProcessImageRequest}
|
|
961
|
+
* @memberof DefaultApiProcessImage
|
|
1007
962
|
*/
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
}, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1011
|
-
};
|
|
963
|
+
readonly processImageRequest: ProcessImageRequest;
|
|
964
|
+
}
|
|
1012
965
|
/**
|
|
1013
|
-
*
|
|
966
|
+
* Request parameters for promoteImages operation in DefaultApi.
|
|
1014
967
|
* @export
|
|
968
|
+
* @interface DefaultApiPromoteImagesRequest
|
|
1015
969
|
*/
|
|
1016
|
-
export
|
|
970
|
+
export interface DefaultApiPromoteImagesRequest {
|
|
1017
971
|
/**
|
|
1018
972
|
*
|
|
1019
|
-
* @
|
|
1020
|
-
* @
|
|
1021
|
-
* @param {*} [options] Override http request option.
|
|
1022
|
-
* @throws {RequiredError}
|
|
1023
|
-
*/
|
|
1024
|
-
processImage(processImageRequest: ProcessImageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1025
|
-
/**
|
|
1026
|
-
*
|
|
1027
|
-
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
1028
|
-
* @param {{ [key: string]: any; }} requestBody
|
|
1029
|
-
* @param {*} [options] Override http request option.
|
|
1030
|
-
* @throws {RequiredError}
|
|
973
|
+
* @type {PromoteRequest}
|
|
974
|
+
* @memberof DefaultApiPromoteImages
|
|
1031
975
|
*/
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
}, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1035
|
-
};
|
|
976
|
+
readonly promoteRequest: PromoteRequest;
|
|
977
|
+
}
|
|
1036
978
|
/**
|
|
1037
|
-
*
|
|
979
|
+
* Request parameters for s3Webhook operation in DefaultApi.
|
|
1038
980
|
* @export
|
|
981
|
+
* @interface DefaultApiS3WebhookRequest
|
|
1039
982
|
*/
|
|
1040
|
-
export
|
|
983
|
+
export interface DefaultApiS3WebhookRequest {
|
|
1041
984
|
/**
|
|
1042
985
|
*
|
|
1043
|
-
* @
|
|
1044
|
-
* @
|
|
1045
|
-
* @param {*} [options] Override http request option.
|
|
1046
|
-
* @throws {RequiredError}
|
|
1047
|
-
*/
|
|
1048
|
-
processImage(requestParameters: InternalApiProcessImageRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1049
|
-
/**
|
|
1050
|
-
*
|
|
1051
|
-
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
1052
|
-
* @param {InternalApiS3WebhookRequest} requestParameters Request parameters.
|
|
1053
|
-
* @param {*} [options] Override http request option.
|
|
1054
|
-
* @throws {RequiredError}
|
|
986
|
+
* @type {{ [key: string]: any; }}
|
|
987
|
+
* @memberof DefaultApiS3Webhook
|
|
1055
988
|
*/
|
|
1056
|
-
|
|
1057
|
-
|
|
989
|
+
readonly requestBody: {
|
|
990
|
+
[key: string]: any;
|
|
991
|
+
};
|
|
992
|
+
}
|
|
1058
993
|
/**
|
|
1059
|
-
* Request parameters for
|
|
994
|
+
* Request parameters for updateImage operation in DefaultApi.
|
|
1060
995
|
* @export
|
|
1061
|
-
* @interface
|
|
996
|
+
* @interface DefaultApiUpdateImageRequest
|
|
1062
997
|
*/
|
|
1063
|
-
export interface
|
|
998
|
+
export interface DefaultApiUpdateImageRequest {
|
|
1064
999
|
/**
|
|
1065
1000
|
*
|
|
1066
|
-
* @type {
|
|
1067
|
-
* @memberof
|
|
1001
|
+
* @type {string}
|
|
1002
|
+
* @memberof DefaultApiUpdateImage
|
|
1068
1003
|
*/
|
|
1069
|
-
readonly
|
|
1070
|
-
}
|
|
1071
|
-
/**
|
|
1072
|
-
* Request parameters for s3Webhook operation in InternalApi.
|
|
1073
|
-
* @export
|
|
1074
|
-
* @interface InternalApiS3WebhookRequest
|
|
1075
|
-
*/
|
|
1076
|
-
export interface InternalApiS3WebhookRequest {
|
|
1004
|
+
readonly id: string;
|
|
1077
1005
|
/**
|
|
1078
1006
|
*
|
|
1079
|
-
* @type {
|
|
1080
|
-
* @memberof
|
|
1007
|
+
* @type {ImagePatch}
|
|
1008
|
+
* @memberof DefaultApiUpdateImage
|
|
1081
1009
|
*/
|
|
1082
|
-
readonly
|
|
1083
|
-
[key: string]: any;
|
|
1084
|
-
};
|
|
1010
|
+
readonly imagePatch: ImagePatch;
|
|
1085
1011
|
}
|
|
1086
1012
|
/**
|
|
1087
|
-
*
|
|
1013
|
+
* DefaultApi - object-oriented interface
|
|
1088
1014
|
* @export
|
|
1089
|
-
* @class
|
|
1015
|
+
* @class DefaultApi
|
|
1090
1016
|
* @extends {BaseAPI}
|
|
1091
1017
|
*/
|
|
1092
|
-
export declare class
|
|
1018
|
+
export declare class DefaultApi extends BaseAPI {
|
|
1093
1019
|
/**
|
|
1094
1020
|
*
|
|
1095
|
-
* @summary
|
|
1096
|
-
* @param {
|
|
1021
|
+
* @summary Confirm upload (HEAD against S3), persist metadata
|
|
1022
|
+
* @param {DefaultApiConfirmUploadRequest} requestParameters Request parameters.
|
|
1097
1023
|
* @param {*} [options] Override http request option.
|
|
1098
1024
|
* @throws {RequiredError}
|
|
1099
|
-
* @memberof
|
|
1025
|
+
* @memberof DefaultApi
|
|
1100
1026
|
*/
|
|
1101
|
-
|
|
1027
|
+
confirmUpload(requestParameters: DefaultApiConfirmUploadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Image, any, {}>>;
|
|
1102
1028
|
/**
|
|
1103
1029
|
*
|
|
1104
|
-
* @summary
|
|
1105
|
-
* @param {
|
|
1030
|
+
* @summary Create a presigned PUT URL for uploading an image to MinIO/S3
|
|
1031
|
+
* @param {DefaultApiCreatePresignRequest} requestParameters Request parameters.
|
|
1106
1032
|
* @param {*} [options] Override http request option.
|
|
1107
1033
|
* @throws {RequiredError}
|
|
1108
|
-
* @memberof
|
|
1034
|
+
* @memberof DefaultApi
|
|
1109
1035
|
*/
|
|
1110
|
-
|
|
1111
|
-
}
|
|
1112
|
-
/**
|
|
1113
|
-
* LinkingApi - axios parameter creator
|
|
1114
|
-
* @export
|
|
1115
|
-
*/
|
|
1116
|
-
export declare const LinkingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1036
|
+
createPresign(requestParameters: DefaultApiCreatePresignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PresignResponse, any, {}>>;
|
|
1117
1037
|
/**
|
|
1118
1038
|
*
|
|
1119
|
-
* @summary
|
|
1120
|
-
* @param {
|
|
1121
|
-
* @param {string} [idempotencyKey]
|
|
1039
|
+
* @summary Delete image (soft or hard, per policy)
|
|
1040
|
+
* @param {DefaultApiDeleteImageRequest} requestParameters Request parameters.
|
|
1122
1041
|
* @param {*} [options] Override http request option.
|
|
1123
1042
|
* @throws {RequiredError}
|
|
1043
|
+
* @memberof DefaultApi
|
|
1124
1044
|
*/
|
|
1125
|
-
|
|
1126
|
-
};
|
|
1127
|
-
/**
|
|
1128
|
-
* LinkingApi - functional programming interface
|
|
1129
|
-
* @export
|
|
1130
|
-
*/
|
|
1131
|
-
export declare const LinkingApiFp: (configuration?: Configuration) => {
|
|
1045
|
+
deleteImage(requestParameters: DefaultApiDeleteImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1132
1046
|
/**
|
|
1133
1047
|
*
|
|
1134
|
-
* @summary
|
|
1135
|
-
* @param {
|
|
1136
|
-
* @param {string} [idempotencyKey]
|
|
1048
|
+
* @summary Generate a signed imgproxy URL for delivery with requested params
|
|
1049
|
+
* @param {DefaultApiGetDeliveryUrlRequest} requestParameters Request parameters.
|
|
1137
1050
|
* @param {*} [options] Override http request option.
|
|
1138
1051
|
* @throws {RequiredError}
|
|
1052
|
+
* @memberof DefaultApi
|
|
1139
1053
|
*/
|
|
1140
|
-
|
|
1141
|
-
};
|
|
1142
|
-
/**
|
|
1143
|
-
* LinkingApi - factory interface
|
|
1144
|
-
* @export
|
|
1145
|
-
*/
|
|
1146
|
-
export declare const LinkingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1054
|
+
getDeliveryUrl(requestParameters: DefaultApiGetDeliveryUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDeliveryUrl200Response, any, {}>>;
|
|
1147
1055
|
/**
|
|
1148
1056
|
*
|
|
1149
|
-
* @summary
|
|
1150
|
-
* @param {
|
|
1057
|
+
* @summary Get image metadata
|
|
1058
|
+
* @param {DefaultApiGetImageRequest} requestParameters Request parameters.
|
|
1151
1059
|
* @param {*} [options] Override http request option.
|
|
1152
1060
|
* @throws {RequiredError}
|
|
1061
|
+
* @memberof DefaultApi
|
|
1153
1062
|
*/
|
|
1154
|
-
|
|
1155
|
-
};
|
|
1156
|
-
/**
|
|
1157
|
-
* Request parameters for promoteImages operation in LinkingApi.
|
|
1158
|
-
* @export
|
|
1159
|
-
* @interface LinkingApiPromoteImagesRequest
|
|
1160
|
-
*/
|
|
1161
|
-
export interface LinkingApiPromoteImagesRequest {
|
|
1063
|
+
getImage(requestParameters: DefaultApiGetImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Image, any, {}>>;
|
|
1162
1064
|
/**
|
|
1163
1065
|
*
|
|
1164
|
-
* @
|
|
1165
|
-
* @
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
*
|
|
1170
|
-
* @type {string}
|
|
1171
|
-
* @memberof LinkingApiPromoteImages
|
|
1066
|
+
* @summary List/search images by owner/filters
|
|
1067
|
+
* @param {DefaultApiListImagesRequest} requestParameters Request parameters.
|
|
1068
|
+
* @param {*} [options] Override http request option.
|
|
1069
|
+
* @throws {RequiredError}
|
|
1070
|
+
* @memberof DefaultApi
|
|
1172
1071
|
*/
|
|
1173
|
-
|
|
1174
|
-
}
|
|
1175
|
-
/**
|
|
1176
|
-
* LinkingApi - object-oriented interface
|
|
1177
|
-
* @export
|
|
1178
|
-
* @class LinkingApi
|
|
1179
|
-
* @extends {BaseAPI}
|
|
1180
|
-
*/
|
|
1181
|
-
export declare class LinkingApi extends BaseAPI {
|
|
1072
|
+
listImages(requestParameters?: DefaultApiListImagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListImages200Response, any, {}>>;
|
|
1182
1073
|
/**
|
|
1183
1074
|
*
|
|
1184
|
-
* @summary
|
|
1185
|
-
* @param {
|
|
1075
|
+
* @summary Trigger (or retry) variant generation for an image
|
|
1076
|
+
* @param {DefaultApiProcessImageRequest} requestParameters Request parameters.
|
|
1186
1077
|
* @param {*} [options] Override http request option.
|
|
1187
1078
|
* @throws {RequiredError}
|
|
1188
|
-
* @memberof
|
|
1079
|
+
* @memberof DefaultApi
|
|
1189
1080
|
*/
|
|
1190
|
-
|
|
1191
|
-
}
|
|
1192
|
-
/**
|
|
1193
|
-
* PresignApi - axios parameter creator
|
|
1194
|
-
* @export
|
|
1195
|
-
*/
|
|
1196
|
-
export declare const PresignApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1081
|
+
processImage(requestParameters: DefaultApiProcessImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1197
1082
|
/**
|
|
1198
1083
|
*
|
|
1199
|
-
* @summary
|
|
1200
|
-
* @param {
|
|
1201
|
-
* @param {string} [idempotencyKey] Idempotency key for safe retries.
|
|
1084
|
+
* @summary Promote images from a product draft to a final product
|
|
1085
|
+
* @param {DefaultApiPromoteImagesRequest} requestParameters Request parameters.
|
|
1202
1086
|
* @param {*} [options] Override http request option.
|
|
1203
1087
|
* @throws {RequiredError}
|
|
1088
|
+
* @memberof DefaultApi
|
|
1204
1089
|
*/
|
|
1205
|
-
|
|
1206
|
-
};
|
|
1207
|
-
/**
|
|
1208
|
-
* PresignApi - functional programming interface
|
|
1209
|
-
* @export
|
|
1210
|
-
*/
|
|
1211
|
-
export declare const PresignApiFp: (configuration?: Configuration) => {
|
|
1090
|
+
promoteImages(requestParameters: DefaultApiPromoteImagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoteImages200Response, any, {}>>;
|
|
1212
1091
|
/**
|
|
1213
1092
|
*
|
|
1214
|
-
* @summary
|
|
1215
|
-
* @param {
|
|
1216
|
-
* @param {string} [idempotencyKey] Idempotency key for safe retries.
|
|
1093
|
+
* @summary MinIO/S3 event webhook (ObjectCreated/Delete) for auto-confirm/triggers
|
|
1094
|
+
* @param {DefaultApiS3WebhookRequest} requestParameters Request parameters.
|
|
1217
1095
|
* @param {*} [options] Override http request option.
|
|
1218
1096
|
* @throws {RequiredError}
|
|
1097
|
+
* @memberof DefaultApi
|
|
1219
1098
|
*/
|
|
1220
|
-
|
|
1221
|
-
};
|
|
1222
|
-
/**
|
|
1223
|
-
* PresignApi - factory interface
|
|
1224
|
-
* @export
|
|
1225
|
-
*/
|
|
1226
|
-
export declare const PresignApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1099
|
+
s3Webhook(requestParameters: DefaultApiS3WebhookRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
1227
1100
|
/**
|
|
1228
1101
|
*
|
|
1229
|
-
* @summary
|
|
1230
|
-
* @param {
|
|
1102
|
+
* @summary Update image metadata (alt, role, order)
|
|
1103
|
+
* @param {DefaultApiUpdateImageRequest} requestParameters Request parameters.
|
|
1231
1104
|
* @param {*} [options] Override http request option.
|
|
1232
1105
|
* @throws {RequiredError}
|
|
1106
|
+
* @memberof DefaultApi
|
|
1233
1107
|
*/
|
|
1234
|
-
|
|
1235
|
-
}
|
|
1108
|
+
updateImage(requestParameters: DefaultApiUpdateImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Image, any, {}>>;
|
|
1109
|
+
}
|
|
1236
1110
|
/**
|
|
1237
|
-
* Request parameters for createPresign operation in PresignApi.
|
|
1238
1111
|
* @export
|
|
1239
|
-
* @interface PresignApiCreatePresignRequest
|
|
1240
1112
|
*/
|
|
1241
|
-
export
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
* Idempotency key for safe retries.
|
|
1250
|
-
* @type {string}
|
|
1251
|
-
* @memberof PresignApiCreatePresign
|
|
1252
|
-
*/
|
|
1253
|
-
readonly idempotencyKey?: string;
|
|
1254
|
-
}
|
|
1113
|
+
export declare const GetDeliveryUrlFitEnum: {
|
|
1114
|
+
readonly Cover: "cover";
|
|
1115
|
+
readonly Contain: "contain";
|
|
1116
|
+
readonly Fill: "fill";
|
|
1117
|
+
readonly Inside: "inside";
|
|
1118
|
+
readonly Outside: "outside";
|
|
1119
|
+
};
|
|
1120
|
+
export type GetDeliveryUrlFitEnum = typeof GetDeliveryUrlFitEnum[keyof typeof GetDeliveryUrlFitEnum];
|
|
1255
1121
|
/**
|
|
1256
|
-
* PresignApi - object-oriented interface
|
|
1257
1122
|
* @export
|
|
1258
|
-
* @class PresignApi
|
|
1259
|
-
* @extends {BaseAPI}
|
|
1260
1123
|
*/
|
|
1261
|
-
export declare
|
|
1262
|
-
|
|
1263
|
-
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
*/
|
|
1270
|
-
createPresign(requestParameters: PresignApiCreatePresignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PresignResponse, any, {}>>;
|
|
1271
|
-
}
|
|
1124
|
+
export declare const GetDeliveryUrlFormatEnum: {
|
|
1125
|
+
readonly Original: "original";
|
|
1126
|
+
readonly Webp: "webp";
|
|
1127
|
+
readonly Avif: "avif";
|
|
1128
|
+
readonly Jpeg: "jpeg";
|
|
1129
|
+
readonly Png: "png";
|
|
1130
|
+
};
|
|
1131
|
+
export type GetDeliveryUrlFormatEnum = typeof GetDeliveryUrlFormatEnum[keyof typeof GetDeliveryUrlFormatEnum];
|