@emilgroup/document-sdk 1.11.0 → 1.12.0

package/.openapi-generator/FILES

@@ -32,11 +32,13 @@ models/delete-request-dto.ts
 models/delete-response-class.ts
 models/doc-template-class.ts
 models/document-class.ts
+models/docx-template-class.ts
 models/download-document-request-dto.ts
 models/get-doc-template-request-dto.ts
 models/get-doc-template-response-class.ts
 models/get-document-download-url-response-class.ts
 models/get-docx-template-download-url-response-class.ts
+models/get-docx-template-response-class.ts
 models/get-layout-request-dto.ts
 models/get-layout-response-class.ts
 models/get-product-document-download-url-response-class.ts
@@ -52,6 +54,7 @@ models/layout-class.ts
 models/list-doc-template-request-dto.ts
 models/list-doc-templates-response-class.ts
 models/list-documents-response-class.ts
+models/list-docx-templates-response-class.ts
 models/list-layouts-response-class.ts
 models/list-product-documents-response-class.ts
 models/list-request-dto.ts
@@ -69,10 +72,12 @@ models/update-doc-template-request-dto.ts
 models/update-doc-template-response-class.ts
 models/update-document-request-dto.ts
 models/update-document-response-class.ts
+models/update-docx-template-response-class.ts
 models/update-html-template-dto.ts
 models/update-layout-request-dto.ts
 models/update-layout-response-class.ts
 models/upload-docx-template-request-dto.ts
+models/upload-docx-template-response-class.ts
 models/upload-product-document-request-dto.ts
 package.json
 tsconfig.json

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

package/api/docx-templates-api.ts

@@ -25,9 +25,17 @@ import { DeleteResponseClass } from '../models';
 // @ts-ignore
 import { GetDocxTemplateDownloadUrlResponseClass } from '../models';
 // @ts-ignore
+import { GetDocxTemplateResponseClass } from '../models';
+// @ts-ignore
+import { ListDocxTemplatesResponseClass } from '../models';
+// @ts-ignore
 import { SharedUpdateDocxTemplateRequestDto } from '../models';
 // @ts-ignore
+import { UpdateDocxTemplateResponseClass } from '../models';
+// @ts-ignore
 import { UploadDocxTemplateRequestDto } from '../models';
+// @ts-ignore
+import { UploadDocxTemplateResponseClass } from '../models';
 /**
  * DocxTemplatesApi - axios parameter creator
  * @export
@@ -380,7 +388,7 @@ export const DocxTemplatesApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async getDocxTemplate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocxTemplateResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.getDocxTemplate(code, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -397,7 +405,7 @@ export const DocxTemplatesApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocxTemplatesResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listDocxTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -410,7 +418,7 @@ export const DocxTemplatesApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocxTemplateResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.updateDocxTemplate(code, sharedUpdateDocxTemplateRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -422,7 +430,7 @@ export const DocxTemplatesApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
+        async uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadDocxTemplateResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocxTemplate(uploadDocxTemplateRequestDto, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -466,7 +474,7 @@ export const DocxTemplatesApiFactory = function (configuration?: Configuration,
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<object> {
+        getDocxTemplate(code: string, authorization?: string, options?: any): AxiosPromise<GetDocxTemplateResponseClass> {
             return localVarFp.getDocxTemplate(code, authorization, options).then((request) => request(axios, basePath));
         },
         /**
@@ -482,7 +490,7 @@ export const DocxTemplatesApiFactory = function (configuration?: Configuration,
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<object> {
+        listDocxTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocxTemplatesResponseClass> {
             return localVarFp.listDocxTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
         },
         /**
@@ -494,7 +502,7 @@ export const DocxTemplatesApiFactory = function (configuration?: Configuration,
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
+        updateDocxTemplate(code: string, sharedUpdateDocxTemplateRequestDto: SharedUpdateDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocxTemplateResponseClass> {
             return localVarFp.updateDocxTemplate(code, sharedUpdateDocxTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
@@ -505,7 +513,7 @@ export const DocxTemplatesApiFactory = function (configuration?: Configuration,
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
+        uploadDocxTemplate(uploadDocxTemplateRequestDto: UploadDocxTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UploadDocxTemplateResponseClass> {
             return localVarFp.uploadDocxTemplate(uploadDocxTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
     };

package/models/docx-template-class.ts

@@ -0,0 +1,110 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DocxTemplateClass
+ */
+export interface DocxTemplateClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof DocxTemplateClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'code': 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}
+     * @memberof DocxTemplateClass
+     */
+    'slug': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof DocxTemplateClass
+     */
+    'productVersionId': number;
+    /**
+     * 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 DocxTemplateClass
+     */
+    'productSlug': string;
+    /**
+     * Description of the document. Usually a short summary about the      context in which the document is being used.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'description': string;
+    /**
+     * The unique key used by Amazon Simple Storage Service (S3).
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    's3Key': string;
+    /**
+     * Document entity type.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'entityType': DocxTemplateClassEntityTypeEnum;
+    /**
+     * Name of the file the end user will see when he downloads it.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'filename': string;
+    /**
+     * Version number of the template, incremented each time a new version is uploaded.
+     * @type {number}
+     * @memberof DocxTemplateClass
+     */
+    'versionNumber': number;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof DocxTemplateClass
+     */
+    'updatedAt': string;
+}
+
+export const DocxTemplateClassEntityTypeEnum = {
+    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 DocxTemplateClassEntityTypeEnum = typeof DocxTemplateClassEntityTypeEnum[keyof typeof DocxTemplateClassEntityTypeEnum];
+
+

package/models/get-docx-template-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { DocxTemplateClass } from './docx-template-class';
+
+/**
+ * 
+ * @export
+ * @interface GetDocxTemplateResponseClass
+ */
+export interface GetDocxTemplateResponseClass {
+    /**
+     * Docx Template
+     * @type {DocxTemplateClass}
+     * @memberof GetDocxTemplateResponseClass
+     */
+    'docxTemplate': DocxTemplateClass;
+}
+

package/models/index.ts

@@ -13,11 +13,13 @@ export * from './delete-request-dto';
 export * from './delete-response-class';
 export * from './doc-template-class';
 export * from './document-class';
+export * from './docx-template-class';
 export * from './download-document-request-dto';
 export * from './get-doc-template-request-dto';
 export * from './get-doc-template-response-class';
 export * from './get-document-download-url-response-class';
 export * from './get-docx-template-download-url-response-class';
+export * from './get-docx-template-response-class';
 export * from './get-layout-request-dto';
 export * from './get-layout-response-class';
 export * from './get-product-document-download-url-response-class';
@@ -32,6 +34,7 @@ export * from './layout-class';
 export * from './list-doc-template-request-dto';
 export * from './list-doc-templates-response-class';
 export * from './list-documents-response-class';
+export * from './list-docx-templates-response-class';
 export * from './list-layouts-response-class';
 export * from './list-product-documents-response-class';
 export * from './list-request-dto';
@@ -49,8 +52,10 @@ export * from './update-doc-template-request-dto';
 export * from './update-doc-template-response-class';
 export * from './update-document-request-dto';
 export * from './update-document-response-class';
+export * from './update-docx-template-response-class';
 export * from './update-html-template-dto';
 export * from './update-layout-request-dto';
 export * from './update-layout-response-class';
 export * from './upload-docx-template-request-dto';
+export * from './upload-docx-template-response-class';
 export * from './upload-product-document-request-dto';

package/models/list-docx-templates-response-class.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { DocxTemplateClass } from './docx-template-class';
+
+/**
+ * 
+ * @export
+ * @interface ListDocxTemplatesResponseClass
+ */
+export interface ListDocxTemplatesResponseClass {
+    /**
+     * The list of docx templates.
+     * @type {Array<DocxTemplateClass>}
+     * @memberof ListDocxTemplatesResponseClass
+     */
+    'items': Array<DocxTemplateClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListDocxTemplatesResponseClass
+     */
+    'nextPageToken': string;
+}
+

package/models/update-docx-template-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { DocxTemplateClass } from './docx-template-class';
+
+/**
+ * 
+ * @export
+ * @interface UpdateDocxTemplateResponseClass
+ */
+export interface UpdateDocxTemplateResponseClass {
+    /**
+     * Document
+     * @type {DocxTemplateClass}
+     * @memberof UpdateDocxTemplateResponseClass
+     */
+    'docxTemplate': DocxTemplateClass;
+}
+

package/models/upload-docx-template-response-class.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL DocumentService
+ * The EMIL DocumentService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface UploadDocxTemplateResponseClass
+ */
+export interface UploadDocxTemplateResponseClass {
+    /**
+     * Pre-signed url for uploading the docx template.
+     * @type {string}
+     * @memberof UploadDocxTemplateResponseClass
+     */
+    'url': string;
+    /**
+     * Upload document fields.
+     * @type {object}
+     * @memberof UploadDocxTemplateResponseClass
+     */
+    'fields': object;
+}
+

package/package.json

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