@emilgroup/document-sdk-node 1.4.0 → 1.4.1

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-node@1.4.0 --save
+npm install @emilgroup/document-sdk-node@1.4.1 --save
 ```
 or 
 ```
-yarn add @emilgroup/document-sdk-node@1.4.0
+yarn add @emilgroup/document-sdk-node@1.4.1
 ```
 
 And then you can import `DocumentsApi`.

package/api/document-templates-api.ts

@@ -193,12 +193,13 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
          * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
          * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.    For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
          * @param {string} [filter] Filter response by productSlug, slug and name.
+         * @param {string} [search] Search document templates by name | slug
          * @param {string} [order] Order response by createdAt.
          * @param {string} [expand] Expand response by bodyTemplate.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listDocTemplates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/documentservice/v1/doc-templates`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -229,6 +230,10 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
                 localVarQueryParameter['filter'] = filter;
             }
 
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
             if (order !== undefined) {
                 localVarQueryParameter['order'] = order;
             }
@@ -357,13 +362,14 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
          * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
          * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.    For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,   your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
          * @param {string} [filter] Filter response by productSlug, slug and name.
+         * @param {string} [search] Search document templates by name | slug
          * @param {string} [order] Order response by createdAt.
          * @param {string} [expand] Expand response by bodyTemplate.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options);
+        async listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -430,13 +436,14 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
          * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
          * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.    For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,   your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
          * @param {string} [filter] Filter response by productSlug, slug and name.
+         * @param {string} [search] Search document templates by name | slug
          * @param {string} [order] Order response by createdAt.
          * @param {string} [expand] Expand response by bodyTemplate.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass> {
-            return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options).then((request) => request(axios, basePath));
+        listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass> {
+            return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
         },
         /**
          * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -557,6 +564,13 @@ export interface DocumentTemplatesApiListDocTemplatesRequest {
      */
     readonly filter?: string
 
+    /**
+     * Search document templates by name | slug
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly search?: string
+
     /**
      * Order response by createdAt.
      * @type {string}
@@ -652,7 +666,7 @@ export class DocumentTemplatesApi extends BaseAPI {
      * @memberof DocumentTemplatesApi
      */
     public listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest = {}, options?: AxiosRequestConfig) {
-        return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+        return DocumentTemplatesApiFp(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/dist/api/document-templates-api.d.ts

@@ -59,12 +59,13 @@ export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Con
      * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
      * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.    For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
      * @param {string} [filter] Filter response by productSlug, slug and name.
+     * @param {string} [search] Search document templates by name | slug
      * @param {string} [order] Order response by createdAt.
      * @param {string} [expand] Expand response by bodyTemplate.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listDocTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listDocTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      * @summary Update the document template
@@ -116,12 +117,13 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
      * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
      * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.    For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,   your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
      * @param {string} [filter] Filter response by productSlug, slug and name.
+     * @param {string} [search] Search document templates by name | slug
      * @param {string} [order] Order response by createdAt.
      * @param {string} [expand] Expand response by bodyTemplate.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>>;
+    listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>>;
     /**
      * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      * @summary Update the document template
@@ -173,12 +175,13 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
      * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
      * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.    For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,   your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
      * @param {string} [filter] Filter response by productSlug, slug and name.
+     * @param {string} [search] Search document templates by name | slug
      * @param {string} [order] Order response by createdAt.
      * @param {string} [expand] Expand response by bodyTemplate.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass>;
+    listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass>;
     /**
      * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
      * @summary Update the document template
@@ -283,6 +286,12 @@ export interface DocumentTemplatesApiListDocTemplatesRequest {
      * @memberof DocumentTemplatesApiListDocTemplates
      */
     readonly filter?: string;
+    /**
+     * Search document templates by name | slug
+     * @type {string}
+     * @memberof DocumentTemplatesApiListDocTemplates
+     */
+    readonly search?: string;
     /**
      * Order response by createdAt.
      * @type {string}

package/dist/api/document-templates-api.js

@@ -252,12 +252,13 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
          * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
          * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.    For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
          * @param {string} [filter] Filter response by productSlug, slug and name.
+         * @param {string} [search] Search document templates by name | slug
          * @param {string} [order] Order response by createdAt.
          * @param {string} [expand] Expand response by bodyTemplate.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocTemplates: function (authorization, pageSize, pageToken, filter, order, expand, options) {
+        listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -289,6 +290,9 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
                             if (filter !== undefined) {
                                 localVarQueryParameter['filter'] = filter;
                             }
+                            if (search !== undefined) {
+                                localVarQueryParameter['search'] = search;
+                            }
                             if (order !== undefined) {
                                 localVarQueryParameter['order'] = order;
                             }
@@ -443,17 +447,18 @@ var DocumentTemplatesApiFp = function (configuration) {
          * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
          * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.    For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
          * @param {string} [filter] Filter response by productSlug, slug and name.
+         * @param {string} [search] Search document templates by name | slug
          * @param {string} [order] Order response by createdAt.
          * @param {string} [expand] Expand response by bodyTemplate.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocTemplates: function (authorization, pageSize, pageToken, filter, order, expand, options) {
+        listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -534,13 +539,14 @@ var DocumentTemplatesApiFactory = function (configuration, basePath, axios) {
          * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
          * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list.    For instance, if you make a list request and receive 100 objects and pageToken=1,   your subsequent call can include pageToken=2 in order to fetch the next page of the list.
          * @param {string} [filter] Filter response by productSlug, slug and name.
+         * @param {string} [search] Search document templates by name | slug
          * @param {string} [order] Order response by createdAt.
          * @param {string} [expand] Expand response by bodyTemplate.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocTemplates: function (authorization, pageSize, pageToken, filter, order, expand, options) {
-            return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options).then(function (request) { return request(axios, basePath); });
+        listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
+            return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -615,7 +621,7 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
     DocumentTemplatesApi.prototype.listDocTemplates = function (requestParameters, options) {
         var _this = this;
         if (requestParameters === void 0) { requestParameters = {}; }
-        return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(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 document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

package/dist/models/list-doc-template-request-dto.d.ts

@@ -33,6 +33,12 @@ export interface ListDocTemplateRequestDto {
      * @memberof ListDocTemplateRequestDto
      */
     'filter'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'search'?: string;
     /**
      *
      * @type {string}

package/dist/models/product-document-class.d.ts

@@ -63,12 +63,24 @@ export interface ProductDocumentClass {
      * @memberof ProductDocumentClass
      */
     'contentType': ProductDocumentClassContentTypeEnum;
+    /**
+     * Product Document entity type.
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'entityType': ProductDocumentClassEntityTypeEnum;
     /**
      * 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}
      * @memberof ProductDocumentClass
      */
     'productSlug': string;
+    /**
+     * Product document filename
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'filename'?: string;
     /**
      * Time at which the object was created.
      * @type {string}
@@ -97,3 +109,14 @@ export declare const ProductDocumentClassContentTypeEnum: {
     readonly Avi: "AVI";
 };
 export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];
+export declare const ProductDocumentClassEntityTypeEnum: {
+    readonly PolicyApplication: "policy_application";
+    readonly PolicyContract: "policy_contract";
+    readonly PolicyAddendum: "policy_addendum";
+    readonly InitialInvoice: "initial_invoice";
+    readonly CorrectionInvoice: "correction_invoice";
+    readonly RecurringInvoice: "recurring_invoice";
+    readonly SepaMandate: "sepa_mandate";
+    readonly Static: "static";
+};
+export type ProductDocumentClassEntityTypeEnum = typeof ProductDocumentClassEntityTypeEnum[keyof typeof ProductDocumentClassEntityTypeEnum];

package/dist/models/product-document-class.js

@@ -13,7 +13,7 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProductDocumentClassContentTypeEnum = void 0;
+exports.ProductDocumentClassEntityTypeEnum = exports.ProductDocumentClassContentTypeEnum = void 0;
 exports.ProductDocumentClassContentTypeEnum = {
     Pdf: 'pdf',
     Jpg: 'jpg',
@@ -34,3 +34,13 @@ exports.ProductDocumentClassContentTypeEnum = {
     Wmv: 'WMV',
     Avi: 'AVI'
 };
+exports.ProductDocumentClassEntityTypeEnum = {
+    PolicyApplication: 'policy_application',
+    PolicyContract: 'policy_contract',
+    PolicyAddendum: 'policy_addendum',
+    InitialInvoice: 'initial_invoice',
+    CorrectionInvoice: 'correction_invoice',
+    RecurringInvoice: 'recurring_invoice',
+    SepaMandate: 'sepa_mandate',
+    Static: 'static'
+};

package/dist/models/upload-product-document-request-dto.d.ts

@@ -45,6 +45,12 @@ export interface UploadProductDocumentRequestDto {
      * @memberof UploadProductDocumentRequestDto
      */
     'type': string;
+    /**
+     * Entity type of the product document.
+     * @type {string}
+     * @memberof UploadProductDocumentRequestDto
+     */
+    'entityType': string;
     /**
      * Id of the product version, and is optional. If not provided, the document will be attached        to the latest version of the product.
      * @type {number}

package/models/list-doc-template-request-dto.ts

@@ -38,6 +38,12 @@ export interface ListDocTemplateRequestDto {
      * @memberof ListDocTemplateRequestDto
      */
     'filter'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ListDocTemplateRequestDto
+     */
+    'search'?: string;
     /**
      * 
      * @type {string}

package/models/product-document-class.ts

@@ -68,12 +68,24 @@ export interface ProductDocumentClass {
      * @memberof ProductDocumentClass
      */
     'contentType': ProductDocumentClassContentTypeEnum;
+    /**
+     * Product Document entity type.
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'entityType': ProductDocumentClassEntityTypeEnum;
     /**
      * 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}
      * @memberof ProductDocumentClass
      */
     'productSlug': string;
+    /**
+     * Product document filename
+     * @type {string}
+     * @memberof ProductDocumentClass
+     */
+    'filename'?: string;
     /**
      * Time at which the object was created.
      * @type {string}
@@ -104,5 +116,17 @@ export const ProductDocumentClassContentTypeEnum = {
 } as const;
 
 export type ProductDocumentClassContentTypeEnum = typeof ProductDocumentClassContentTypeEnum[keyof typeof ProductDocumentClassContentTypeEnum];
+export const ProductDocumentClassEntityTypeEnum = {
+    PolicyApplication: 'policy_application',
+    PolicyContract: 'policy_contract',
+    PolicyAddendum: 'policy_addendum',
+    InitialInvoice: 'initial_invoice',
+    CorrectionInvoice: 'correction_invoice',
+    RecurringInvoice: 'recurring_invoice',
+    SepaMandate: 'sepa_mandate',
+    Static: 'static'
+} as const;
+
+export type ProductDocumentClassEntityTypeEnum = typeof ProductDocumentClassEntityTypeEnum[keyof typeof ProductDocumentClassEntityTypeEnum];
 
 

package/models/upload-product-document-request-dto.ts

@@ -50,6 +50,12 @@ export interface UploadProductDocumentRequestDto {
      * @memberof UploadProductDocumentRequestDto
      */
     'type': string;
+    /**
+     * Entity type of the product document.
+     * @type {string}
+     * @memberof UploadProductDocumentRequestDto
+     */
+    'entityType': string;
     /**
      * Id of the product version, and is optional. If not provided, the document will be attached        to the latest version of the product.
      * @type {number}

package/package.json

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