@emilgroup/document-sdk-node 1.2.0 → 1.3.0

package/dist/api/layouts-api.js

@@ -97,7 +97,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         *
+         * This will create a layout.
+         * @summary Create the layout
          * @param {CreateLayoutRequestDto} createLayoutRequestDto
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -145,7 +146,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         *
+         * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+         * @summary Delete the layout
          * @param {number} id
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -192,9 +194,10 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         *
+         * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+         * @summary Retrieve the layout
          * @param {string} id
-         * @param {number} id2 Layout id
+         * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -245,7 +248,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         *
+         * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List layouts
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
@@ -312,7 +316,8 @@ var LayoutsApiAxiosParamCreator = function (configuration) {
             });
         },
         /**
-         *
+         * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the layout
          * @param {number} id
          * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
          * @param {string} [authorization] Bearer Token
@@ -374,7 +379,8 @@ var LayoutsApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.LayoutsApiAxiosParamCreator)(configuration);
     return {
         /**
-         *
+         * This will create a layout.
+         * @summary Create the layout
          * @param {CreateLayoutRequestDto} createLayoutRequestDto
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -394,7 +400,8 @@ var LayoutsApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+         * @summary Delete the layout
          * @param {number} id
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -414,9 +421,10 @@ var LayoutsApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+         * @summary Retrieve the layout
          * @param {string} id
-         * @param {number} id2 Layout id
+         * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -435,7 +443,8 @@ var LayoutsApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List layouts
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
@@ -460,7 +469,8 @@ var LayoutsApiFp = function (configuration) {
             });
         },
         /**
-         *
+         * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the layout
          * @param {number} id
          * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
          * @param {string} [authorization] Bearer Token
@@ -491,7 +501,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.LayoutsApiFp)(configuration);
     return {
         /**
-         *
+         * This will create a layout.
+         * @summary Create the layout
          * @param {CreateLayoutRequestDto} createLayoutRequestDto
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -501,7 +512,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.createLayout(createLayoutRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         *
+         * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+         * @summary Delete the layout
          * @param {number} id
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -511,9 +523,10 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteLayout(id, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         *
+         * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+         * @summary Retrieve the layout
          * @param {string} id
-         * @param {number} id2 Layout id
+         * @param {number} id2 Internal unique identifier for the object. You should not have to use this, use code instead.
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -522,7 +535,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getLayout(id, id2, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         *
+         * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List layouts
          * @param {string} [authorization] Bearer Token
          * @param {number} [pageSize] Page size
          * @param {string} [pageToken] Page token
@@ -537,7 +551,8 @@ var LayoutsApiFactory = function (configuration, basePath, axios) {
             return localVarFp.listLayouts(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
         },
         /**
-         *
+         * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the layout
          * @param {number} id
          * @param {UpdateLayoutRequestDto} updateLayoutRequestDto
          * @param {string} [authorization] Bearer Token
@@ -562,7 +577,8 @@ var LayoutsApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
+     * This will create a layout.
+     * @summary Create the layout
      * @param {LayoutsApiCreateLayoutRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -573,7 +589,8 @@ var LayoutsApi = /** @class */ (function (_super) {
         return (0, exports.LayoutsApiFp)(this.configuration).createLayout(requestParameters.createLayoutRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     *
+     * Permanently deletes the layout. Supply the unique code that was returned when you created the layout and this will delete it.
+     * @summary Delete the layout
      * @param {LayoutsApiDeleteLayoutRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -584,7 +601,8 @@ var LayoutsApi = /** @class */ (function (_super) {
         return (0, exports.LayoutsApiFp)(this.configuration).deleteLayout(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     *
+     * Retrieves the details of the layout that was previously created. Supply the unique layout id that was returned when you created it and Emil Api will return the corresponding layout information.
+     * @summary Retrieve the layout
      * @param {LayoutsApiGetLayoutRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -595,7 +613,8 @@ var LayoutsApi = /** @class */ (function (_super) {
         return (0, exports.LayoutsApiFp)(this.configuration).getLayout(requestParameters.id, requestParameters.id2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     *
+     * Returns a list of layouts you have previously created. The layouts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List layouts
      * @param {LayoutsApiListLayoutsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -607,7 +626,8 @@ var LayoutsApi = /** @class */ (function (_super) {
         return (0, exports.LayoutsApiFp)(this.configuration).listLayouts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
-     *
+     * Updates the specified layout by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the layout
      * @param {LayoutsApiUpdateLayoutRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

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

@@ -0,0 +1,345 @@
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { GetProductDocumentResponseClass } from '../models';
+import { ListProductDocumentsResponseClass } from '../models';
+import { ProductDocumentClass } from '../models';
+import { UploadProductDocumentRequestDto } from '../models';
+/**
+ * ProductDocumentsApi - axios parameter creator
+ * @export
+ */
+export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
+     * @summary Delete the product document
+     * @param {string} code
+     * @param {string} productSlug
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProductDocument: (code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a product document.
+     * @summary Retrieve the product document
+     * @param {string} productSlug
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    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.
+     * @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?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Upload a product document.
+     * @summary Create the product document
+     * @param {string} productSlug
+     * @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadProductDocument: (productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProductDocumentsApi - functional programming interface
+ * @export
+ */
+export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
+    /**
+     * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
+     * @summary Delete the product document
+     * @param {string} code
+     * @param {string} productSlug
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Get a product document.
+     * @summary Retrieve the product document
+     * @param {string} productSlug
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @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 {*} [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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
+    /**
+     * Upload a product document.
+     * @summary Create the product document
+     * @param {string} productSlug
+     * @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductDocumentClass>>;
+};
+/**
+ * ProductDocumentsApi - factory interface
+ * @export
+ */
+export declare const ProductDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
+     * @summary Delete the product document
+     * @param {string} code
+     * @param {string} productSlug
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * Get a product document.
+     * @summary Retrieve the product document
+     * @param {string} productSlug
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): 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 {*} [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>;
+    /**
+     * Upload a product document.
+     * @summary Create the product document
+     * @param {string} productSlug
+     * @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<ProductDocumentClass>;
+};
+/**
+ * Request parameters for deleteProductDocument operation in ProductDocumentsApi.
+ * @export
+ * @interface ProductDocumentsApiDeleteProductDocumentRequest
+ */
+export interface ProductDocumentsApiDeleteProductDocumentRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProductDocumentsApiDeleteProductDocument
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProductDocumentsApiDeleteProductDocument
+     */
+    readonly productSlug: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductDocumentsApiDeleteProductDocument
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getProductDocument operation in ProductDocumentsApi.
+ * @export
+ * @interface ProductDocumentsApiGetProductDocumentRequest
+ */
+export interface ProductDocumentsApiGetProductDocumentRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProductDocumentsApiGetProductDocument
+     */
+    readonly productSlug: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ProductDocumentsApiGetProductDocument
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductDocumentsApiGetProductDocument
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listProductDocuments operation in ProductDocumentsApi.
+ * @export
+ * @interface ProductDocumentsApiListProductDocumentsRequest
+ */
+export interface ProductDocumentsApiListProductDocumentsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments
+     */
+    readonly productSlug: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments
+     */
+    readonly authorization?: string;
+    /**
+     * Page size
+     * @type {number}
+     * @memberof ProductDocumentsApiListProductDocuments
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments
+     */
+    readonly filter?: string;
+    /**
+     * Search query
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof ProductDocumentsApiListProductDocuments
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for uploadProductDocument operation in ProductDocumentsApi.
+ * @export
+ * @interface ProductDocumentsApiUploadProductDocumentRequest
+ */
+export interface ProductDocumentsApiUploadProductDocumentRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProductDocumentsApiUploadProductDocument
+     */
+    readonly productSlug: string;
+    /**
+     *
+     * @type {UploadProductDocumentRequestDto}
+     * @memberof ProductDocumentsApiUploadProductDocument
+     */
+    readonly uploadProductDocumentRequestDto: UploadProductDocumentRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ProductDocumentsApiUploadProductDocument
+     */
+    readonly authorization?: string;
+}
+/**
+ * ProductDocumentsApi - object-oriented interface
+ * @export
+ * @class ProductDocumentsApi
+ * @extends {BaseAPI}
+ */
+export declare class ProductDocumentsApi extends BaseAPI {
+    /**
+     * Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
+     * @summary Delete the product document
+     * @param {ProductDocumentsApiDeleteProductDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductDocumentsApi
+     */
+    deleteProductDocument(requestParameters: ProductDocumentsApiDeleteProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
+    /**
+     * Get a product document.
+     * @summary Retrieve the product document
+     * @param {ProductDocumentsApiGetProductDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductDocumentsApi
+     */
+    getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentResponseClass, 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 {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>>;
+    /**
+     * Upload a product document.
+     * @summary Create the product document
+     * @param {ProductDocumentsApiUploadProductDocumentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProductDocumentsApi
+     */
+    uploadProductDocument(requestParameters: ProductDocumentsApiUploadProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductDocumentClass, any>>;
+}