@emilgroup/billing-sdk-node 1.3.0 → 1.4.1

package/.openapi-generator/FILES

@@ -20,18 +20,25 @@ models/create-estimated-invoice-request-dto.ts
 models/create-estimated-invoice-response-class.ts
 models/create-invoice-request-dto.ts
 models/create-invoice-response-class.ts
+models/create-invoice-status-request-dto.ts
+models/create-termination-invoice-request-dto.ts
+models/currency-class.ts
 models/index.ts
 models/invoice-class.ts
 models/invoice-item-class.ts
+models/invoice-status-class.ts
 models/list-invoices-response-class.ts
 models/list-policies-billing-dates-response-class.ts
 models/list-request-dto.ts
+models/omit-type-class.ts
+models/policy-billing-date-class.ts
 models/policy-dto.ts
 models/policy-object-dto.ts
 models/policy-premium-dto.ts
 models/policy-premium-item-dto.ts
 models/policy-version-dto.ts
 models/premium-formula-dto.ts
+models/revert-invoice-request-dto.ts
 models/timeslice-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/billing-sdk-node@1.3.0 --save
+npm install @emilgroup/billing-sdk-node@1.4.1 --save
 ```
 or 
 ```
-yarn add @emilgroup/billing-sdk-node@1.3.0
+yarn add @emilgroup/billing-sdk-node@1.4.1
 ```
 
 And then you can import `InvoicesApi`.

package/api/correction-invoices-api.ts

@@ -5,7 +5,7 @@
  * The EMIL BillingService 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
@@ -35,13 +35,15 @@ const FormData = require('form-data');
 export const CorrectionInvoicesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.
+         * @summary Create the correction invoice
          * @param {CreateInvoiceRequestDto} createInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
+         * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique.       Usually, a generated v4 UUID is enough.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createCorrectionInvoice: async (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        createCorrectionInvoice: async (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'createInvoiceRequestDto' is not null or undefined
             assertParamExists('createCorrectionInvoice', 'createInvoiceRequestDto', createInvoiceRequestDto)
             const localVarPath = `/billingservice/v1/correction-invoices`;
@@ -66,6 +68,10 @@ export const CorrectionInvoicesApiAxiosParamCreator = function (configuration?:
                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
             }
 
+            if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
+            }
+
 
     
             localVarHeaderParameter['Content-Type'] = 'application/json';
@@ -91,14 +97,16 @@ export const CorrectionInvoicesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = CorrectionInvoicesApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.
+         * @summary Create the correction invoice
          * @param {CreateInvoiceRequestDto} createInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
+         * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique.       Usually, a generated v4 UUID is enough.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async createCorrectionInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCorrectionInvoicesResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.createCorrectionInvoice(createInvoiceRequestDto, authorization, options);
+        async createCorrectionInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCorrectionInvoicesResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createCorrectionInvoice(createInvoiceRequestDto, authorization, idempotencyKey, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     }
@@ -112,14 +120,16 @@ export const CorrectionInvoicesApiFactory = function (configuration?: Configurat
     const localVarFp = CorrectionInvoicesApiFp(configuration)
     return {
         /**
-         * 
+         * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.
+         * @summary Create the correction invoice
          * @param {CreateInvoiceRequestDto} createInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
+         * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique.       Usually, a generated v4 UUID is enough.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createCorrectionInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCorrectionInvoicesResponseClass> {
-            return localVarFp.createCorrectionInvoice(createInvoiceRequestDto, authorization, options).then((request) => request(axios, basePath));
+        createCorrectionInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: any): AxiosPromise<CreateCorrectionInvoicesResponseClass> {
+            return localVarFp.createCorrectionInvoice(createInvoiceRequestDto, authorization, idempotencyKey, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -143,6 +153,13 @@ export interface CorrectionInvoicesApiCreateCorrectionInvoiceRequest {
      * @memberof CorrectionInvoicesApiCreateCorrectionInvoice
      */
     readonly authorization?: string
+
+    /**
+     * Idempotency Key used to make the request idempotent. The key should be unique.       Usually, a generated v4 UUID is enough.
+     * @type {string}
+     * @memberof CorrectionInvoicesApiCreateCorrectionInvoice
+     */
+    readonly idempotencyKey?: string
 }
 
 /**
@@ -153,13 +170,14 @@ export interface CorrectionInvoicesApiCreateCorrectionInvoiceRequest {
  */
 export class CorrectionInvoicesApi extends BaseAPI {
     /**
-     * 
+     * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.
+     * @summary Create the correction invoice
      * @param {CorrectionInvoicesApiCreateCorrectionInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CorrectionInvoicesApi
      */
     public createCorrectionInvoice(requestParameters: CorrectionInvoicesApiCreateCorrectionInvoiceRequest, options?: AxiosRequestConfig) {
-        return CorrectionInvoicesApiFp(this.configuration).createCorrectionInvoice(requestParameters.createInvoiceRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return CorrectionInvoicesApiFp(this.configuration).createCorrectionInvoice(requestParameters.createInvoiceRequestDto, requestParameters.authorization, requestParameters.idempotencyKey, options).then((request) => request(this.axios, this.basePath));
     }
 }

package/api/estimated-invoices-api.ts

@@ -5,7 +5,7 @@
  * The EMIL BillingService 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
@@ -39,7 +39,8 @@ const FormData = require('form-data');
 export const EstimatedInvoicesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * This will create a custom estimated invoice.
+         * @summary Create the custom estimated invoice
          * @param {CreateCustomEstimatedInvoiceRequestDto} createCustomEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -85,7 +86,8 @@ export const EstimatedInvoicesApiAxiosParamCreator = function (configuration?: C
             };
         },
         /**
-         * 
+         * This will create an estimated invoice. It will not be saved in the database.
+         * @summary Create the estimated invoice
          * @param {CreateEstimatedInvoiceRequestDto} createEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -141,7 +143,8 @@ export const EstimatedInvoicesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = EstimatedInvoicesApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * This will create a custom estimated invoice.
+         * @summary Create the custom estimated invoice
          * @param {CreateCustomEstimatedInvoiceRequestDto} createCustomEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -152,7 +155,8 @@ export const EstimatedInvoicesApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * This will create an estimated invoice. It will not be saved in the database.
+         * @summary Create the estimated invoice
          * @param {CreateEstimatedInvoiceRequestDto} createEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -173,7 +177,8 @@ export const EstimatedInvoicesApiFactory = function (configuration?: Configurati
     const localVarFp = EstimatedInvoicesApiFp(configuration)
     return {
         /**
-         * 
+         * This will create a custom estimated invoice.
+         * @summary Create the custom estimated invoice
          * @param {CreateCustomEstimatedInvoiceRequestDto} createCustomEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -183,7 +188,8 @@ export const EstimatedInvoicesApiFactory = function (configuration?: Configurati
             return localVarFp.createCustomEstimatedInvoice(createCustomEstimatedInvoiceRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * This will create an estimated invoice. It will not be saved in the database.
+         * @summary Create the estimated invoice
          * @param {CreateEstimatedInvoiceRequestDto} createEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -245,7 +251,8 @@ export interface EstimatedInvoicesApiCreateEstimatedInvoiceRequest {
  */
 export class EstimatedInvoicesApi extends BaseAPI {
     /**
-     * 
+     * This will create a custom estimated invoice.
+     * @summary Create the custom estimated invoice
      * @param {EstimatedInvoicesApiCreateCustomEstimatedInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -256,7 +263,8 @@ export class EstimatedInvoicesApi extends BaseAPI {
     }
 
     /**
-     * 
+     * This will create an estimated invoice. It will not be saved in the database.
+     * @summary Create the estimated invoice
      * @param {EstimatedInvoicesApiCreateEstimatedInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/api/initial-invoices-api.ts

@@ -5,7 +5,7 @@
  * The EMIL BillingService 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
@@ -35,13 +35,15 @@ const FormData = require('form-data');
 export const InitialInvoicesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.
+         * @summary Create the initial invoice
          * @param {CreateInvoiceRequestDto} createInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
+         * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique.       Usually, a generated v4 UUID is enough.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createInitialInvoice: async (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        createInitialInvoice: async (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'createInvoiceRequestDto' is not null or undefined
             assertParamExists('createInitialInvoice', 'createInvoiceRequestDto', createInvoiceRequestDto)
             const localVarPath = `/billingservice/v1/initial-invoices`;
@@ -66,6 +68,10 @@ export const InitialInvoicesApiAxiosParamCreator = function (configuration?: Con
                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
             }
 
+            if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
+            }
+
 
     
             localVarHeaderParameter['Content-Type'] = 'application/json';
@@ -91,14 +97,16 @@ export const InitialInvoicesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = InitialInvoicesApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.
+         * @summary Create the initial invoice
          * @param {CreateInvoiceRequestDto} createInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
+         * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique.       Usually, a generated v4 UUID is enough.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async createInitialInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInvoiceResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.createInitialInvoice(createInvoiceRequestDto, authorization, options);
+        async createInitialInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInvoiceResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createInitialInvoice(createInvoiceRequestDto, authorization, idempotencyKey, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     }
@@ -112,14 +120,16 @@ export const InitialInvoicesApiFactory = function (configuration?: Configuration
     const localVarFp = InitialInvoicesApiFp(configuration)
     return {
         /**
-         * 
+         * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.
+         * @summary Create the initial invoice
          * @param {CreateInvoiceRequestDto} createInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
+         * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique.       Usually, a generated v4 UUID is enough.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createInitialInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: any): AxiosPromise<CreateInvoiceResponseClass> {
-            return localVarFp.createInitialInvoice(createInvoiceRequestDto, authorization, options).then((request) => request(axios, basePath));
+        createInitialInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: any): AxiosPromise<CreateInvoiceResponseClass> {
+            return localVarFp.createInitialInvoice(createInvoiceRequestDto, authorization, idempotencyKey, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -143,6 +153,13 @@ export interface InitialInvoicesApiCreateInitialInvoiceRequest {
      * @memberof InitialInvoicesApiCreateInitialInvoice
      */
     readonly authorization?: string
+
+    /**
+     * Idempotency Key used to make the request idempotent. The key should be unique.       Usually, a generated v4 UUID is enough.
+     * @type {string}
+     * @memberof InitialInvoicesApiCreateInitialInvoice
+     */
+    readonly idempotencyKey?: string
 }
 
 /**
@@ -153,13 +170,14 @@ export interface InitialInvoicesApiCreateInitialInvoiceRequest {
  */
 export class InitialInvoicesApi extends BaseAPI {
     /**
-     * 
+     * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.
+     * @summary Create the initial invoice
      * @param {InitialInvoicesApiCreateInitialInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof InitialInvoicesApi
      */
     public createInitialInvoice(requestParameters: InitialInvoicesApiCreateInitialInvoiceRequest, options?: AxiosRequestConfig) {
-        return InitialInvoicesApiFp(this.configuration).createInitialInvoice(requestParameters.createInvoiceRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return InitialInvoicesApiFp(this.configuration).createInitialInvoice(requestParameters.createInvoiceRequestDto, requestParameters.authorization, requestParameters.idempotencyKey, options).then((request) => request(this.axios, this.basePath));
     }
 }