@emilgroup/document-sdk 1.11.1 → 1.12.2

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/document-sdk@1.11.1 --save
+npm install @emilgroup/document-sdk@1.12.2 --save
 ```
 or 
 ```
-yarn add @emilgroup/document-sdk@1.11.1
+yarn add @emilgroup/document-sdk@1.12.2
 ```
 
 And then you can import `DocumentsApi`.

package/api/product-documents-api.ts

@@ -186,6 +186,7 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
         /**
          * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
          * @summary List product documents
+         * @param {string} productSlug 
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
@@ -196,8 +197,86 @@ export const ProductDocumentsApiAxiosParamCreator = function (configuration?: Co
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listProductDocuments: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            const localVarPath = `/documentservice/v1/documents/product`;
+        listProductDocuments: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'productSlug' is not null or undefined
+            assertParamExists('listProductDocuments', 'productSlug', productSlug)
+            const localVarPath = `/documentservice/v1/documents/product/{productSlug}`
+                .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (filter !== undefined) {
+                localVarQueryParameter['filter'] = filter;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List product documents
+         * @param {string} productSlug 
+         * @param {string} [authorization] Bearer Token
+         * @param {number} [pageSize] Page size
+         * @param {string} [pageToken] Page token
+         * @param {string} [filter] List filter
+         * @param {string} [search] Search query
+         * @param {string} [order] Ordering criteria
+         * @param {string} [expand] Extra fields to fetch
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listProductDocuments_1: async (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'productSlug' is not null or undefined
+            assertParamExists('listProductDocuments_1', 'productSlug', productSlug)
+            const localVarPath = `/documentservice/v1/documents/product`
+                .replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -357,6 +436,7 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
         /**
          * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
          * @summary List product documents
+         * @param {string} productSlug 
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
@@ -367,8 +447,26 @@ export const ProductDocumentsApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listProductDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options);
+        async listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List product documents
+         * @param {string} productSlug 
+         * @param {string} [authorization] Bearer Token
+         * @param {number} [pageSize] Page size
+         * @param {string} [pageToken] Page token
+         * @param {string} [filter] List filter
+         * @param {string} [search] Search query
+         * @param {string} [order] Ordering criteria
+         * @param {string} [expand] Extra fields to fetch
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listProductDocuments_1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments_1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -433,6 +531,24 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
         /**
          * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
          * @summary List product documents
+         * @param {string} productSlug 
+         * @param {string} [authorization] Bearer Token
+         * @param {number} [pageSize] Page size
+         * @param {string} [pageToken] Page token
+         * @param {string} [filter] List filter
+         * @param {string} [search] Search query
+         * @param {string} [order] Ordering criteria
+         * @param {string} [expand] Extra fields to fetch
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
+            return localVarFp.listProductDocuments(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List product documents
+         * @param {string} productSlug 
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
@@ -443,8 +559,8 @@ export const ProductDocumentsApiFactory = function (configuration?: Configuratio
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listProductDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
-            return localVarFp.listProductDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
+        listProductDocuments_1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
+            return localVarFp.listProductDocuments_1(productSlug, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
         },
         /**
          * Upload a product document.
@@ -551,6 +667,13 @@ export interface ProductDocumentsApiGetProductDocumentRequest {
  * @interface ProductDocumentsApiListProductDocumentsRequest
  */
 export interface ProductDocumentsApiListProductDocumentsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments
+     */
+    readonly productSlug: string
+
     /**
      * Bearer Token
      * @type {string}
@@ -601,6 +724,69 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
     readonly expand?: string
 }
 
+/**
+ * Request parameters for listProductDocuments_1 operation in ProductDocumentsApi.
+ * @export
+ * @interface ProductDocumentsApiListProductDocuments0Request
+ */
+export interface ProductDocumentsApiListProductDocuments0Request {
+    /**
+     * 
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments0
+     */
+    readonly productSlug: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments0
+     */
+    readonly authorization?: string
+
+    /**
+     * Page size
+     * @type {number}
+     * @memberof ProductDocumentsApiListProductDocuments0
+     */
+    readonly pageSize?: number
+
+    /**
+     * Page token
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments0
+     */
+    readonly pageToken?: string
+
+    /**
+     * List filter
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments0
+     */
+    readonly filter?: string
+
+    /**
+     * Search query
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments0
+     */
+    readonly search?: string
+
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments0
+     */
+    readonly order?: string
+
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments0
+     */
+    readonly expand?: string
+}
+
 /**
  * Request parameters for uploadProductDocument operation in ProductDocumentsApi.
  * @export
@@ -680,8 +866,20 @@ export class ProductDocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ProductDocumentsApi
      */
-    public listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest = {}, options?: AxiosRequestConfig) {
-        return ProductDocumentsApiFp(this.configuration).listProductDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    public listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
+        return ProductDocumentsApiFp(this.configuration).listProductDocuments(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List product documents
+     * @param {ProductDocumentsApiListProductDocuments0Request} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductDocumentsApi
+     */
+    public listProductDocuments_1(requestParameters: ProductDocumentsApiListProductDocuments0Request, options?: AxiosRequestConfig) {
+        return ProductDocumentsApiFp(this.configuration).listProductDocuments_1(requestParameters.productSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/models/inline-response200.ts

@@ -28,21 +28,21 @@ export interface InlineResponse200 {
     'status'?: string;
     /**
      * 
-     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @type {{ [key: string]: { [key: string]: object; }; }}
      * @memberof InlineResponse200
      */
-    'info'?: { [key: string]: { [key: string]: string; }; } | null;
+    'info'?: { [key: string]: { [key: string]: object; }; } | null;
     /**
      * 
-     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @type {{ [key: string]: { [key: string]: object; }; }}
      * @memberof InlineResponse200
      */
-    'error'?: { [key: string]: { [key: string]: string; }; } | null;
+    'error'?: { [key: string]: { [key: string]: object; }; } | null;
     /**
      * 
-     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @type {{ [key: string]: { [key: string]: object; }; }}
      * @memberof InlineResponse200
      */
-    'details'?: { [key: string]: { [key: string]: string; }; };
+    'details'?: { [key: string]: { [key: string]: object; }; };
 }
 

package/models/inline-response503.ts

@@ -28,21 +28,21 @@ export interface InlineResponse503 {
     'status'?: string;
     /**
      * 
-     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @type {{ [key: string]: { [key: string]: object; }; }}
      * @memberof InlineResponse503
      */
-    'info'?: { [key: string]: { [key: string]: string; }; } | null;
+    'info'?: { [key: string]: { [key: string]: object; }; } | null;
     /**
      * 
-     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @type {{ [key: string]: { [key: string]: object; }; }}
      * @memberof InlineResponse503
      */
-    'error'?: { [key: string]: { [key: string]: string; }; } | null;
+    'error'?: { [key: string]: { [key: string]: object; }; } | null;
     /**
      * 
-     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @type {{ [key: string]: { [key: string]: object; }; }}
      * @memberof InlineResponse503
      */
-    'details'?: { [key: string]: { [key: string]: string; }; };
+    'details'?: { [key: string]: { [key: string]: object; }; };
 }
 

package/models/product-document-class.ts

@@ -69,7 +69,7 @@ export interface ProductDocumentClass {
      */
     's3Key': string;
     /**
-     * Type of the document expressed with its file extension.
+     * Extension of the file.
      * @type {string}
      * @memberof ProductDocumentClass
      */
@@ -80,6 +80,12 @@ export interface ProductDocumentClass {
      * @memberof ProductDocumentClass
      */
     'entityType': string;
+    /**
+     * The file name the end user will see when downloading it.
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'filename': string;
     /**
      * A slug is a human-readable, unique identifier, used to identify a resource     instead of a less human-readable identifier like an id.
      * @type {string}
@@ -110,21 +116,9 @@ export const ProductDocumentClassContentTypeEnum = {
     Pdf: 'pdf',
     Jpg: 'jpg',
     Png: 'png',
-    Gz: 'gz',
     Csv: 'csv',
     Doc: 'doc',
-    Docx: 'docx',
-    Html: 'html',
-    Json: 'json',
-    Xml: 'xml',
-    Txt: 'txt',
-    Zip: 'zip',
-    Tar: 'tar',
-    Rar: 'rar',
-    Mp4: 'MP4',
-    Mov: 'MOV',
-    Wmv: 'WMV',
-    Avi: 'AVI'
+    Docx: 'docx'
 } as const;
 
 export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/document-sdk",
-  "version": "1.11.1",
+  "version": "1.12.2",
   "description": "OpenAPI client for @emilgroup/document-sdk",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [