@emilgroup/document-sdk-node 1.22.0 → 1.22.1-beta.0

package/dist/api/product-documents-api.d.ts

@@ -12,10 +12,6 @@
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
-import { CreatePresignedPostResponseClass } from '../models';
-import { GetProductDocumentDownloadUrlResponseClass } from '../models';
-import { GetProductDocumentResponseClass } from '../models';
-import { ListProductDocumentsResponseClass } from '../models';
 import { UploadProductDocumentRequestDto } from '../models';
 /**
  * ProductDocumentsApi - axios parameter creator
@@ -35,13 +31,14 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
     /**
      * Get a pre-signed download url for the given product document.
      * @summary Get pre-signed url for downloading product document
-     * @param {string} productSlug
-     * @param {string} code
+     * @param {string} productSlug Product slug
+     * @param {string} code Product document code
+     * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    downloadProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    downloadProductDocument: (productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get a product document.
      * @summary Retrieve the product document
@@ -53,7 +50,7 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
      */
     getProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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.
+     * 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
@@ -68,22 +65,6 @@ export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Conf
      * @throws {RequiredError}
      */
     listProductDocuments: (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * 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 {string} [filters] List filters
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listProductDocuments_1: (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Upload a product document.
      * @summary Create the product document
@@ -109,17 +90,18 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Get a pre-signed download url for the given product document.
      * @summary Get pre-signed url for downloading product document
-     * @param {string} productSlug
-     * @param {string} code
+     * @param {string} productSlug Product slug
+     * @param {string} code Product document code
+     * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentDownloadUrlResponseClass>>;
+    downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Get a product document.
      * @summary Retrieve the product document
@@ -129,25 +111,9 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentResponseClass>>;
-    /**
-     * 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 {string} [filters] List filters
-     * @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, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
+    getProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     * 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.
+     * 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
@@ -161,7 +127,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listProductDocuments_1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
+    listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Upload a product document.
      * @summary Create the product document
@@ -171,7 +137,7 @@ export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
+    uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * ProductDocumentsApi - factory interface
@@ -187,17 +153,18 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: any): AxiosPromise<object>;
+    deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: any): AxiosPromise<void>;
     /**
      * Get a pre-signed download url for the given product document.
      * @summary Get pre-signed url for downloading product document
-     * @param {string} productSlug
-     * @param {string} code
+     * @param {string} productSlug Product slug
+     * @param {string} code Product document code
+     * @param {'attachment' | 'inline'} contentDisposition Content disposition override. Default will be depending on the document type.
      * @param {string} [authorization] Bearer Token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    downloadProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentDownloadUrlResponseClass>;
+    downloadProductDocument(productSlug: string, code: string, contentDisposition: 'attachment' | 'inline', authorization?: string, options?: any): AxiosPromise<void>;
     /**
      * Get a product document.
      * @summary Retrieve the product document
@@ -207,9 +174,9 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentResponseClass>;
+    getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<void>;
     /**
-     * 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.
+     * 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
@@ -223,23 +190,7 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
      * @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, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
-    /**
-     * 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 {string} [filters] List filters
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    listProductDocuments_1(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
+    listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
     /**
      * Upload a product document.
      * @summary Create the product document
@@ -249,7 +200,7 @@ export declare const ProductDocumentsApiFactory: (configuration?: Configuration,
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
+    uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
 };
 /**
  * Request parameters for deleteProductDocument operation in ProductDocumentsApi.
@@ -283,17 +234,23 @@ export interface ProductDocumentsApiDeleteProductDocumentRequest {
  */
 export interface ProductDocumentsApiDownloadProductDocumentRequest {
     /**
-     *
+     * Product slug
      * @type {string}
      * @memberof ProductDocumentsApiDownloadProductDocument
      */
     readonly productSlug: string;
     /**
-     *
+     * Product document code
      * @type {string}
      * @memberof ProductDocumentsApiDownloadProductDocument
      */
     readonly code: string;
+    /**
+     * Content disposition override. Default will be depending on the document type.
+     * @type {'attachment' | 'inline'}
+     * @memberof ProductDocumentsApiDownloadProductDocument
+     */
+    readonly contentDisposition: 'attachment' | 'inline';
     /**
      * Bearer Token
      * @type {string}
@@ -387,67 +344,6 @@ export interface ProductDocumentsApiListProductDocumentsRequest {
      */
     readonly filters?: 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;
-    /**
-     * List filters
-     * @type {string}
-     * @memberof ProductDocumentsApiListProductDocuments0
-     */
-    readonly filters?: string;
-}
 /**
  * Request parameters for uploadProductDocument operation in ProductDocumentsApi.
  * @export
@@ -488,7 +384,7 @@ export declare class ProductDocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ProductDocumentsApi
      */
-    deleteProductDocument(requestParameters: ProductDocumentsApiDeleteProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    deleteProductDocument(requestParameters: ProductDocumentsApiDeleteProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Get a pre-signed download url for the given product document.
      * @summary Get pre-signed url for downloading product document
@@ -497,7 +393,7 @@ export declare class ProductDocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ProductDocumentsApi
      */
-    downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentDownloadUrlResponseClass, any>>;
+    downloadProductDocument(requestParameters: ProductDocumentsApiDownloadProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Get a product document.
      * @summary Retrieve the product document
@@ -506,25 +402,16 @@ export declare class ProductDocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ProductDocumentsApi
      */
-    getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentResponseClass, any>>;
+    getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     * 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.
+     * 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 {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductDocumentsApi
      */
-    listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
-    /**
-     * 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
-     */
-    listProductDocuments_1(requestParameters: ProductDocumentsApiListProductDocuments0Request, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
+    listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Upload a product document.
      * @summary Create the product document
@@ -533,5 +420,5 @@ export declare class ProductDocumentsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof ProductDocumentsApi
      */
-    uploadProductDocument(requestParameters: ProductDocumentsApiUploadProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
+    uploadProductDocument(requestParameters: ProductDocumentsApiUploadProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }