@sokol111/ecommerce-image-service-api 1.0.25 → 1.0.27

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,46 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import type { RequestArgs } from './base';
 import { BaseAPI } from './base';
+export interface BatchUrlRequest {
+    /**
+     * List of image IDs to get URLs for (max 50)
+     */
+    'imageIds': Array<string>;
+    /**
+     * Width in pixels
+     */
+    'w'?: number;
+    /**
+     * Height in pixels
+     */
+    'h'?: number;
+    'fit'?: BatchUrlRequestFitEnum;
+    'format'?: BatchUrlRequestFormatEnum;
+    'quality'?: number;
+}
+export declare const BatchUrlRequestFitEnum: {
+    readonly Cover: "cover";
+    readonly Contain: "contain";
+    readonly Fill: "fill";
+    readonly Inside: "inside";
+    readonly Outside: "outside";
+};
+export type BatchUrlRequestFitEnum = typeof BatchUrlRequestFitEnum[keyof typeof BatchUrlRequestFitEnum];
+export declare const BatchUrlRequestFormatEnum: {
+    readonly Original: "original";
+    readonly Webp: "webp";
+    readonly Avif: "avif";
+    readonly Jpeg: "jpeg";
+    readonly Png: "png";
+};
+export type BatchUrlRequestFormatEnum = typeof BatchUrlRequestFormatEnum[keyof typeof BatchUrlRequestFormatEnum];
+export interface BatchUrlResponse {
+    'urls': Array<ImageUrl>;
+    /**
+     * Image IDs that were not found
+     */
+    'notFound'?: Array<string>;
+}
 export interface ConfirmRequest {
     /**
      * Signed JWT token from presign response
@@ -74,6 +114,11 @@ export declare const ImageStatus: {
     readonly Deleted: "deleted";
 };
 export type ImageStatus = typeof ImageStatus[keyof typeof ImageStatus];
+export interface ImageUrl {
+    'imageId': string;
+    'url': string;
+    'expiresAt'?: string;
+}
 export interface ListImages200Response {
     'items'?: Array<Image>;
     'page'?: number;
@@ -215,6 +260,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getDeliveryUrl: (id: string, variant?: string, w?: number, h?: number, fit?: GetDeliveryUrlFitEnum, format?: GetDeliveryUrlFormatEnum, quality?: number, dpr?: number, ttlSeconds?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Generate signed imgproxy URLs for multiple images in a single request
+     * @param {BatchUrlRequest} batchUrlRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDeliveryUrls: (batchUrlRequest: BatchUrlRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get image metadata
@@ -306,6 +359,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     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>>;
+    /**
+     *
+     * @summary Generate signed imgproxy URLs for multiple images in a single request
+     * @param {BatchUrlRequest} batchUrlRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDeliveryUrls(batchUrlRequest: BatchUrlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BatchUrlResponse>>;
     /**
      *
      * @summary Get image metadata
@@ -388,6 +449,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getDeliveryUrl(requestParameters: DefaultApiGetDeliveryUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetDeliveryUrl200Response>;
+    /**
+     *
+     * @summary Generate signed imgproxy URLs for multiple images in a single request
+     * @param {DefaultApiGetDeliveryUrlsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDeliveryUrls(requestParameters: DefaultApiGetDeliveryUrlsRequest, options?: RawAxiosRequestConfig): AxiosPromise<BatchUrlResponse>;
     /**
      *
      * @summary Get image metadata
@@ -462,6 +531,12 @@ export interface DefaultApiGetDeliveryUrlRequest {
     readonly dpr?: number;
     readonly ttlSeconds?: number;
 }
+/**
+ * Request parameters for getDeliveryUrls operation in DefaultApi.
+ */
+export interface DefaultApiGetDeliveryUrlsRequest {
+    readonly batchUrlRequest: BatchUrlRequest;
+}
 /**
  * Request parameters for getImage operation in DefaultApi.
  */
@@ -533,6 +608,14 @@ export declare class DefaultApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getDeliveryUrl(requestParameters: DefaultApiGetDeliveryUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDeliveryUrl200Response, any, {}>>;
+    /**
+     *
+     * @summary Generate signed imgproxy URLs for multiple images in a single request
+     * @param {DefaultApiGetDeliveryUrlsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDeliveryUrls(requestParameters: DefaultApiGetDeliveryUrlsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BatchUrlResponse, any, {}>>;
     /**
      *
      * @summary Get image metadata

package/dist/api.js

@@ -4,7 +4,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,6 +26,20 @@ import globalAxios from 'axios';
 import { DUMMY_BASE_URL, assertParamExists, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
 // @ts-ignore
 import { BASE_PATH, BaseAPI, operationServerMap } from './base';
+export const BatchUrlRequestFitEnum = {
+    Cover: 'cover',
+    Contain: 'contain',
+    Fill: 'fill',
+    Inside: 'inside',
+    Outside: 'outside'
+};
+export const BatchUrlRequestFormatEnum = {
+    Original: 'original',
+    Webp: 'webp',
+    Avif: 'avif',
+    Jpeg: 'jpeg',
+    Png: 'png'
+};
 export const ImageRole = {
     Main: 'main',
     Gallery: 'gallery',
@@ -209,6 +223,36 @@ export const DefaultApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         }),
+        /**
+         *
+         * @summary Generate signed imgproxy URLs for multiple images in a single request
+         * @param {BatchUrlRequest} batchUrlRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDeliveryUrls: (batchUrlRequest_1, ...args_1) => __awaiter(this, [batchUrlRequest_1, ...args_1], void 0, function* (batchUrlRequest, options = {}) {
+            // verify required parameter 'batchUrlRequest' is not null or undefined
+            assertParamExists('getDeliveryUrls', 'batchUrlRequest', batchUrlRequest);
+            const localVarPath = `/v1/images/urls`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(batchUrlRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
         /**
          *
          * @summary Get image metadata
@@ -458,6 +502,22 @@ export const DefaultApiFp = function (configuration) {
                 return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
             });
         },
+        /**
+         *
+         * @summary Generate signed imgproxy URLs for multiple images in a single request
+         * @param {BatchUrlRequest} batchUrlRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDeliveryUrls(batchUrlRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getDeliveryUrls(batchUrlRequest, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DefaultApi.getDeliveryUrls']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
         /**
          *
          * @summary Get image metadata
@@ -591,6 +651,16 @@ export const DefaultApiFactory = function (configuration, basePath, axios) {
         getDeliveryUrl(requestParameters, options) {
             return localVarFp.getDeliveryUrl(requestParameters.id, requestParameters.variant, requestParameters.w, requestParameters.h, requestParameters.fit, requestParameters.format, requestParameters.quality, requestParameters.dpr, requestParameters.ttlSeconds, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Generate signed imgproxy URLs for multiple images in a single request
+         * @param {DefaultApiGetDeliveryUrlsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDeliveryUrls(requestParameters, options) {
+            return localVarFp.getDeliveryUrls(requestParameters.batchUrlRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Get image metadata
@@ -687,6 +757,16 @@ export class DefaultApi extends BaseAPI {
     getDeliveryUrl(requestParameters, options) {
         return DefaultApiFp(this.configuration).getDeliveryUrl(requestParameters.id, requestParameters.variant, requestParameters.w, requestParameters.h, requestParameters.fit, requestParameters.format, requestParameters.quality, requestParameters.dpr, requestParameters.ttlSeconds, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Generate signed imgproxy URLs for multiple images in a single request
+     * @param {DefaultApiGetDeliveryUrlsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getDeliveryUrls(requestParameters, options) {
+        return DefaultApiFp(this.configuration).getDeliveryUrls(requestParameters.batchUrlRequest, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Get image metadata

package/dist/base.d.ts

@@ -2,7 +2,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/base.js

@@ -4,7 +4,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.d.ts

@@ -2,7 +2,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.js

@@ -4,7 +4,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.d.ts

@@ -2,7 +2,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.js

@@ -3,7 +3,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

@@ -2,7 +2,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.js

@@ -4,7 +4,7 @@
  * Image Service API
  * API for managing images
  *
- * The version of the OpenAPI document: 1.0.25
+ * The version of the OpenAPI document: 1.0.27
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sokol111/ecommerce-image-service-api",
   "description": "Generated TypeScript Axios client from OpenAPI for ecommerce-image-service-api",
-  "version": "1.0.25",
+  "version": "1.0.27",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.js",