@sokol111/ecommerce-image-service-api 1.0.17 → 1.0.18

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.17
+ * The version of the OpenAPI document: 1.0.18
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,52 +13,18 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
-/**
- *
- * @export
- * @interface ConfirmRequest
- */
 export interface ConfirmRequest {
-    /**
-     *
-     * @type {OwnerType}
-     * @memberof ConfirmRequest
-     */
     'ownerType': OwnerType;
-    /**
-     *
-     * @type {string}
-     * @memberof ConfirmRequest
-     */
     'ownerId': string;
     /**
      * S3 key that was used for PUT
-     * @type {string}
-     * @memberof ConfirmRequest
      */
     'key': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ConfirmRequest
-     */
     'alt': string;
-    /**
-     *
-     * @type {string}
-     * @memberof ConfirmRequest
-     */
     'mime': ConfirmRequestMimeEnum;
-    /**
-     *
-     * @type {ImageRole}
-     * @memberof ConfirmRequest
-     */
     'role': ImageRole;
     /**
      * e.g., SHA256 hex for additional integrity check
-     * @type {string}
-     * @memberof ConfirmRequest
      */
     'checksum'?: string | null;
 }
@@ -69,157 +35,46 @@ export declare const ConfirmRequestMimeEnum: {
     readonly ImageAvif: "image/avif";
 };
 export type ConfirmRequestMimeEnum = typeof ConfirmRequestMimeEnum[keyof typeof ConfirmRequestMimeEnum];
-/**
- *
- * @export
- * @interface GetDeliveryUrl200Response
- */
 export interface GetDeliveryUrl200Response {
-    /**
-     *
-     * @type {string}
-     * @memberof GetDeliveryUrl200Response
-     */
-    'url'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof GetDeliveryUrl200Response
-     */
+    'url': string;
     'expiresAt'?: string | null;
 }
-/**
- *
- * @export
- * @interface Image
- */
 export interface Image {
-    /**
-     *
-     * @type {string}
-     * @memberof Image
-     */
     'id': string;
-    /**
-     *
-     * @type {OwnerType}
-     * @memberof Image
-     */
     'ownerType': OwnerType;
-    /**
-     *
-     * @type {string}
-     * @memberof Image
-     */
     'ownerId': string;
-    /**
-     *
-     * @type {ImageRole}
-     * @memberof Image
-     */
     'role': ImageRole;
     /**
      * S3 key of the original image
-     * @type {string}
-     * @memberof Image
      */
     'key': string;
     /**
      * Optional — direct URL if public or via proxy
-     * @type {string}
-     * @memberof Image
      */
     'url'?: string | null;
-    /**
-     *
-     * @type {string}
-     * @memberof Image
-     */
     'alt': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Image
-     */
     'mime': string;
-    /**
-     *
-     * @type {number}
-     * @memberof Image
-     */
     'size': number;
-    /**
-     *
-     * @type {string}
-     * @memberof Image
-     */
     'hash'?: string | null;
-    /**
-     *
-     * @type {ImageStatus}
-     * @memberof Image
-     */
     'status': ImageStatus;
-    /**
-     *
-     * @type {Array<Variant>}
-     * @memberof Image
-     */
     'variants'?: Array<Variant>;
-    /**
-     *
-     * @type {string}
-     * @memberof Image
-     */
     'createdAt': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Image
-     */
     'modifiedAt': string;
 }
-/**
- *
- * @export
- * @interface ImagePatch
- */
 export interface ImagePatch {
-    /**
-     *
-     * @type {string}
-     * @memberof ImagePatch
-     */
     'alt'?: string;
-    /**
-     *
-     * @type {ImageRole}
-     * @memberof ImagePatch
-     */
     'role'?: ImageRole;
     /**
      * Position in the product gallery
-     * @type {number}
-     * @memberof ImagePatch
      */
     'order'?: number;
 }
-/**
- *
- * @export
- * @enum {string}
- */
 export declare const ImageRole: {
     readonly Main: "main";
     readonly Gallery: "gallery";
     readonly Other: "other";
 };
 export type ImageRole = typeof ImageRole[keyof typeof ImageRole];
-/**
- *
- * @export
- * @enum {string}
- */
 export declare const ImageStatus: {
     readonly Pending: "pending";
     readonly Uploaded: "uploaded";
@@ -229,89 +84,30 @@ export declare const ImageStatus: {
     readonly Deleted: "deleted";
 };
 export type ImageStatus = typeof ImageStatus[keyof typeof ImageStatus];
-/**
- *
- * @export
- * @interface ListImages200Response
- */
 export interface ListImages200Response {
-    /**
-     *
-     * @type {Array<Image>}
-     * @memberof ListImages200Response
-     */
     'items'?: Array<Image>;
-    /**
-     *
-     * @type {number}
-     * @memberof ListImages200Response
-     */
     'page'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ListImages200Response
-     */
     'pageSize'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof ListImages200Response
-     */
     'total'?: number;
 }
-/**
- *
- * @export
- * @enum {string}
- */
 export declare const OwnerType: {
     readonly ProductDraft: "productDraft";
     readonly Product: "product";
     readonly User: "user";
 };
 export type OwnerType = typeof OwnerType[keyof typeof OwnerType];
-/**
- *
- * @export
- * @interface PresignRequest
- */
 export interface PresignRequest {
-    /**
-     *
-     * @type {OwnerType}
-     * @memberof PresignRequest
-     */
     'ownerType': OwnerType;
     /**
      * Draft ID or owner ID
-     * @type {string}
-     * @memberof PresignRequest
      */
     'ownerId': string;
-    /**
-     *
-     * @type {string}
-     * @memberof PresignRequest
-     */
     'filename': string;
-    /**
-     *
-     * @type {string}
-     * @memberof PresignRequest
-     */
     'contentType': PresignRequestContentTypeEnum;
     /**
      * Size in bytes
-     * @type {number}
-     * @memberof PresignRequest
      */
     'size': number;
-    /**
-     *
-     * @type {ImageRole}
-     * @memberof PresignRequest
-     */
     'role': ImageRole;
 }
 export declare const PresignRequestContentTypeEnum: {
@@ -321,216 +117,71 @@ export declare const PresignRequestContentTypeEnum: {
     readonly ImageAvif: "image/avif";
 };
 export type PresignRequestContentTypeEnum = typeof PresignRequestContentTypeEnum[keyof typeof PresignRequestContentTypeEnum];
-/**
- *
- * @export
- * @interface PresignResponse
- */
 export interface PresignResponse {
-    /**
-     *
-     * @type {string}
-     * @memberof PresignResponse
-     */
     'uploadUrl': string;
     /**
      * Final S3 key to PUT to
-     * @type {string}
-     * @memberof PresignResponse
      */
     'key': string;
     /**
      * TTL in seconds
-     * @type {number}
-     * @memberof PresignResponse
      */
     'expiresIn': number;
-    /**
-     *
-     * @type {{ [key: string]: string; }}
-     * @memberof PresignResponse
-     */
     'requiredHeaders': {
         [key: string]: string;
     };
 }
 /**
  * RFC7807 Problem Details
- * @export
- * @interface Problem
  */
 export interface Problem {
-    /**
-     *
-     * @type {string}
-     * @memberof Problem
-     */
     'type': string;
-    /**
-     *
-     * @type {string}
-     * @memberof Problem
-     */
     'title': string;
-    /**
-     *
-     * @type {number}
-     * @memberof Problem
-     */
     'status': number;
-    /**
-     *
-     * @type {string}
-     * @memberof Problem
-     */
     'detail'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Problem
-     */
     'instance'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Problem
-     */
     'traceId'?: string;
-    /**
-     *
-     * @type {Array<ProblemErrorsInner>}
-     * @memberof Problem
-     */
     'errors'?: Array<ProblemErrorsInner>;
 }
-/**
- *
- * @export
- * @interface ProblemErrorsInner
- */
 export interface ProblemErrorsInner {
-    /**
-     *
-     * @type {string}
-     * @memberof ProblemErrorsInner
-     */
     'field'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof ProblemErrorsInner
-     */
     'message'?: string;
 }
-/**
- *
- * @export
- * @interface ProcessImageRequest
- */
 export interface ProcessImageRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof ProcessImageRequest
-     */
     'imageId'?: string;
     /**
      * Name of the preset (variant set), if used
-     * @type {string}
-     * @memberof ProcessImageRequest
      */
     'preset'?: string;
 }
-/**
- *
- * @export
- * @interface PromoteImages200Response
- */
 export interface PromoteImages200Response {
-    /**
-     *
-     * @type {Array<Image>}
-     * @memberof PromoteImages200Response
-     */
     'promoted'?: Array<Image>;
 }
-/**
- *
- * @export
- * @interface PromoteRequest
- */
 export interface PromoteRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof PromoteRequest
-     */
     'draftId': string;
-    /**
-     *
-     * @type {string}
-     * @memberof PromoteRequest
-     */
     'productId': string;
     /**
      * If true — copy to products/{productId}/... and remove old objects
-     * @type {boolean}
-     * @memberof PromoteRequest
      */
     'move': boolean;
     /**
      * If omitted — promote all images of the draft
-     * @type {Array<string>}
-     * @memberof PromoteRequest
      */
     'images'?: Array<string>;
 }
-/**
- *
- * @export
- * @interface Variant
- */
 export interface Variant {
-    /**
-     *
-     * @type {string}
-     * @memberof Variant
-     */
     'name'?: string;
     /**
      * S3 key of the variant
-     * @type {string}
-     * @memberof Variant
      */
     'key'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof Variant
-     */
     'width'?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof Variant
-     */
     'height'?: number;
-    /**
-     *
-     * @type {string}
-     * @memberof Variant
-     */
     'mime'?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof Variant
-     */
     'size'?: number;
 }
 /**
  * DefaultApi - axios parameter creator
- * @export
  */
 export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -622,7 +273,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
 };
 /**
  * DefaultApi - functional programming interface
- * @export
  */
 export declare const DefaultApiFp: (configuration?: Configuration) => {
     /**
@@ -714,7 +364,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
 };
 /**
  * DefaultApi - factory interface
- * @export
  */
 export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -792,210 +441,74 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
 };
 /**
  * Request parameters for confirmUpload operation in DefaultApi.
- * @export
- * @interface DefaultApiConfirmUploadRequest
  */
 export interface DefaultApiConfirmUploadRequest {
-    /**
-     *
-     * @type {ConfirmRequest}
-     * @memberof DefaultApiConfirmUpload
-     */
     readonly confirmRequest: ConfirmRequest;
 }
 /**
  * Request parameters for createPresign operation in DefaultApi.
- * @export
- * @interface DefaultApiCreatePresignRequest
  */
 export interface DefaultApiCreatePresignRequest {
-    /**
-     *
-     * @type {PresignRequest}
-     * @memberof DefaultApiCreatePresign
-     */
     readonly presignRequest: PresignRequest;
 }
 /**
  * Request parameters for deleteImage operation in DefaultApi.
- * @export
- * @interface DefaultApiDeleteImageRequest
  */
 export interface DefaultApiDeleteImageRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof DefaultApiDeleteImage
-     */
     readonly id: string;
-    /**
-     *
-     * @type {boolean}
-     * @memberof DefaultApiDeleteImage
-     */
     readonly hard?: boolean;
 }
 /**
  * Request parameters for getDeliveryUrl operation in DefaultApi.
- * @export
- * @interface DefaultApiGetDeliveryUrlRequest
  */
 export interface DefaultApiGetDeliveryUrlRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof DefaultApiGetDeliveryUrl
-     */
     readonly id: string;
-    /**
-     *
-     * @type {string}
-     * @memberof DefaultApiGetDeliveryUrl
-     */
     readonly variant?: string;
-    /**
-     *
-     * @type {number}
-     * @memberof DefaultApiGetDeliveryUrl
-     */
     readonly w?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof DefaultApiGetDeliveryUrl
-     */
     readonly h?: number;
-    /**
-     *
-     * @type {'cover' | 'contain' | 'fill' | 'inside' | 'outside'}
-     * @memberof DefaultApiGetDeliveryUrl
-     */
     readonly fit?: GetDeliveryUrlFitEnum;
-    /**
-     *
-     * @type {'original' | 'webp' | 'avif' | 'jpeg' | 'png'}
-     * @memberof DefaultApiGetDeliveryUrl
-     */
     readonly format?: GetDeliveryUrlFormatEnum;
-    /**
-     *
-     * @type {number}
-     * @memberof DefaultApiGetDeliveryUrl
-     */
     readonly quality?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof DefaultApiGetDeliveryUrl
-     */
     readonly dpr?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof DefaultApiGetDeliveryUrl
-     */
     readonly ttlSeconds?: number;
 }
 /**
  * Request parameters for getImage operation in DefaultApi.
- * @export
- * @interface DefaultApiGetImageRequest
  */
 export interface DefaultApiGetImageRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof DefaultApiGetImage
-     */
     readonly id: string;
 }
 /**
  * Request parameters for listImages operation in DefaultApi.
- * @export
- * @interface DefaultApiListImagesRequest
  */
 export interface DefaultApiListImagesRequest {
-    /**
-     *
-     * @type {OwnerType}
-     * @memberof DefaultApiListImages
-     */
     readonly ownerType?: OwnerType;
-    /**
-     *
-     * @type {string}
-     * @memberof DefaultApiListImages
-     */
     readonly ownerId?: string;
-    /**
-     *
-     * @type {ImageStatus}
-     * @memberof DefaultApiListImages
-     */
     readonly status?: ImageStatus;
-    /**
-     *
-     * @type {number}
-     * @memberof DefaultApiListImages
-     */
     readonly page?: number;
-    /**
-     *
-     * @type {number}
-     * @memberof DefaultApiListImages
-     */
     readonly pageSize?: number;
 }
 /**
  * Request parameters for processImage operation in DefaultApi.
- * @export
- * @interface DefaultApiProcessImageRequest
  */
 export interface DefaultApiProcessImageRequest {
-    /**
-     *
-     * @type {ProcessImageRequest}
-     * @memberof DefaultApiProcessImage
-     */
     readonly processImageRequest: ProcessImageRequest;
 }
 /**
  * Request parameters for promoteImages operation in DefaultApi.
- * @export
- * @interface DefaultApiPromoteImagesRequest
  */
 export interface DefaultApiPromoteImagesRequest {
-    /**
-     *
-     * @type {PromoteRequest}
-     * @memberof DefaultApiPromoteImages
-     */
     readonly promoteRequest: PromoteRequest;
 }
 /**
  * Request parameters for updateImage operation in DefaultApi.
- * @export
- * @interface DefaultApiUpdateImageRequest
  */
 export interface DefaultApiUpdateImageRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof DefaultApiUpdateImage
-     */
     readonly id: string;
-    /**
-     *
-     * @type {ImagePatch}
-     * @memberof DefaultApiUpdateImage
-     */
     readonly imagePatch: ImagePatch;
 }
 /**
  * DefaultApi - object-oriented interface
- * @export
- * @class DefaultApi
- * @extends {BaseAPI}
  */
 export declare class DefaultApi extends BaseAPI {
     /**
@@ -1004,7 +517,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DefaultApiConfirmUploadRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     confirmUpload(requestParameters: DefaultApiConfirmUploadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Image, any, {}>>;
     /**
@@ -1013,7 +525,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DefaultApiCreatePresignRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     createPresign(requestParameters: DefaultApiCreatePresignRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PresignResponse, any, {}>>;
     /**
@@ -1022,7 +533,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DefaultApiDeleteImageRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     deleteImage(requestParameters: DefaultApiDeleteImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
@@ -1031,7 +541,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DefaultApiGetDeliveryUrlRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     getDeliveryUrl(requestParameters: DefaultApiGetDeliveryUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDeliveryUrl200Response, any, {}>>;
     /**
@@ -1040,7 +549,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DefaultApiGetImageRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     getImage(requestParameters: DefaultApiGetImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Image, any, {}>>;
     /**
@@ -1049,7 +557,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DefaultApiListImagesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     listImages(requestParameters?: DefaultApiListImagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListImages200Response, any, {}>>;
     /**
@@ -1058,7 +565,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DefaultApiProcessImageRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     processImage(requestParameters: DefaultApiProcessImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
@@ -1067,7 +573,6 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DefaultApiPromoteImagesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     promoteImages(requestParameters: DefaultApiPromoteImagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PromoteImages200Response, any, {}>>;
     /**
@@ -1076,13 +581,9 @@ export declare class DefaultApi extends BaseAPI {
      * @param {DefaultApiUpdateImageRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof DefaultApi
      */
     updateImage(requestParameters: DefaultApiUpdateImageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Image, any, {}>>;
 }
-/**
- * @export
- */
 export declare const GetDeliveryUrlFitEnum: {
     readonly Cover: "cover";
     readonly Contain: "contain";
@@ -1091,9 +592,6 @@ export declare const GetDeliveryUrlFitEnum: {
     readonly Outside: "outside";
 };
 export type GetDeliveryUrlFitEnum = typeof GetDeliveryUrlFitEnum[keyof typeof GetDeliveryUrlFitEnum];
-/**
- * @export
- */
 export declare const GetDeliveryUrlFormatEnum: {
     readonly Original: "original";
     readonly Webp: "webp";