@emilgroup/billing-sdk 1.7.0 → 1.8.0

package/.openapi-generator/FILES

@@ -19,6 +19,7 @@ models/create-custom-estimated-invoice-request-dto.ts
 models/create-custom-estimated-invoice-response-class.ts
 models/create-estimated-invoice-request-dto.ts
 models/create-estimated-invoice-response-class.ts
+models/create-invoice-payment-request-dto.ts
 models/create-invoice-request-dto.ts
 models/create-invoice-response-class.ts
 models/create-invoice-status-request-dto.ts
@@ -29,6 +30,8 @@ models/inline-response200.ts
 models/inline-response503.ts
 models/invoice-class.ts
 models/invoice-item-class.ts
+models/invoice-payment-class.ts
+models/invoice-payments-class.ts
 models/invoice-status-class.ts
 models/list-invoices-response-class.ts
 models/list-policies-billing-dates-response-class.ts

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@1.7.0 --save
+npm install @emilgroup/billing-sdk@1.8.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/billing-sdk@1.7.0
+yarn add @emilgroup/billing-sdk@1.8.0
 ```
 
 And then you can import `InvoicesApi`.

package/models/create-invoice-payment-request-dto.ts

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL BillingService
+ * 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
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreateInvoicePaymentRequestDto
+ */
+export interface CreateInvoicePaymentRequestDto {
+    /**
+     * Payment amount.
+     * @type {number}
+     * @memberof CreateInvoicePaymentRequestDto
+     */
+    'transactionAmount': number;
+    /**
+     * Payment date.
+     * @type {string}
+     * @memberof CreateInvoicePaymentRequestDto
+     */
+    'transactionDate': string;
+    /**
+     * Transaction reference.
+     * @type {string}
+     * @memberof CreateInvoicePaymentRequestDto
+     */
+    'transactionReference': string;
+    /**
+     * Payment comment.
+     * @type {string}
+     * @memberof CreateInvoicePaymentRequestDto
+     */
+    'comment'?: string;
+    /**
+     * Payment id.
+     * @type {number}
+     * @memberof CreateInvoicePaymentRequestDto
+     */
+    'paymentId': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateInvoicePaymentRequestDto
+     */
+    'invoiceId': number;
+}
+

package/models/create-invoice-status-request-dto.ts

@@ -36,7 +36,8 @@ export interface CreateInvoiceStatusRequestDto {
 
 export const CreateInvoiceStatusRequestDtoStatusEnum = {
     Open: 'open',
-    Paid: 'paid'
+    Paid: 'paid',
+    PartiallyPaid: 'partially-paid'
 } as const;
 
 export type CreateInvoiceStatusRequestDtoStatusEnum = typeof CreateInvoiceStatusRequestDtoStatusEnum[keyof typeof CreateInvoiceStatusRequestDtoStatusEnum];

package/models/index.ts

@@ -3,6 +3,7 @@ export * from './create-custom-estimated-invoice-request-dto';
 export * from './create-custom-estimated-invoice-response-class';
 export * from './create-estimated-invoice-request-dto';
 export * from './create-estimated-invoice-response-class';
+export * from './create-invoice-payment-request-dto';
 export * from './create-invoice-request-dto';
 export * from './create-invoice-response-class';
 export * from './create-invoice-status-request-dto';
@@ -12,6 +13,8 @@ export * from './inline-response200';
 export * from './inline-response503';
 export * from './invoice-class';
 export * from './invoice-item-class';
+export * from './invoice-payment-class';
+export * from './invoice-payments-class';
 export * from './invoice-status-class';
 export * from './list-invoices-response-class';
 export * from './list-policies-billing-dates-response-class';

package/models/invoice-class.ts

@@ -14,6 +14,7 @@
 
 
 import { InvoiceItemClass } from './invoice-item-class';
+import { InvoicePaymentsClass } from './invoice-payments-class';
 import { InvoiceStatusClass } from './invoice-status-class';
 
 /**
@@ -82,6 +83,12 @@ export interface InvoiceClass {
      * @memberof InvoiceClass
      */
     'grossAmount': number;
+    /**
+     * Paid amount. This property is amount paid by this invoice. The amount corresponds to the sum (positives and negatives) of all payments relating to that invoice.
+     * @type {number}
+     * @memberof InvoiceClass
+     */
+    'paidAmount': number;
     /**
      * Invoice status.
      * @type {string}
@@ -136,6 +143,12 @@ export interface InvoiceClass {
      * @memberof InvoiceClass
      */
     'currency': string;
+    /**
+     * Invoice payments.
+     * @type {InvoicePaymentsClass}
+     * @memberof InvoiceClass
+     */
+    'payments': InvoicePaymentsClass;
 }
 
 export const InvoiceClassTypeEnum = {
@@ -152,7 +165,8 @@ export const InvoiceClassTypeEnum = {
 export type InvoiceClassTypeEnum = typeof InvoiceClassTypeEnum[keyof typeof InvoiceClassTypeEnum];
 export const InvoiceClassStatusEnum = {
     Open: 'open',
-    Paid: 'paid'
+    Paid: 'paid',
+    PartiallyPaid: 'partially-paid'
 } as const;
 
 export type InvoiceClassStatusEnum = typeof InvoiceClassStatusEnum[keyof typeof InvoiceClassStatusEnum];

package/models/invoice-payment-class.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL BillingService
+ * 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
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface InvoicePaymentClass
+ */
+export interface InvoicePaymentClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the invoice.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'invoiceId': number;
+    /**
+     * Payment amount is in cents.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'transactionAmount': number;
+    /**
+     * This is the date when the payment was made.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'transactionDate': string;
+    /**
+     * Transaction reference.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'transactionReference': string;
+    /**
+     * Payment comment.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'commment': string;
+    /**
+     * User who added payment.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'createdBy': string;
+    /**
+     * Invoice gross amount is in cents.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'invoiceGrossAmount': number;
+    /**
+     * Invoice paid amount before payment. The amount is in cents.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'oldInvoicePaidAmount': number;
+    /**
+     * Invoice paid amount after payment. The amount is in cents.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'newInvoicePaidAmount': number;
+    /**
+     * Invoice status before payment.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'oldInvoiceStatus': string;
+    /**
+     * Invoice status after payment.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'newInvoiceStatus': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'createdAt': string;
+}
+

package/{dist/models/create-custom-estimated-invoice-request-dto.js → models/invoice-payments-class.ts}

@@ -1,4 +1,3 @@
-"use strict";
 /* tslint:disable */
 /* eslint-disable */
 /**
@@ -12,9 +11,21 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateCustomEstimatedInvoiceRequestDtoProviderEnum = void 0;
-exports.CreateCustomEstimatedInvoiceRequestDtoProviderEnum = {
-    Squarelife: 'squarelife',
-    Janitos: 'janitos'
-};
+
+
+import { InvoicePaymentClass } from './invoice-payment-class';
+
+/**
+ * 
+ * @export
+ * @interface InvoicePaymentsClass
+ */
+export interface InvoicePaymentsClass {
+    /**
+     * Invoice payments.
+     * @type {Array<InvoicePaymentClass>}
+     * @memberof InvoicePaymentsClass
+     */
+    'payments': Array<InvoicePaymentClass>;
+}
+

package/models/invoice-status-class.ts

@@ -48,7 +48,8 @@ export interface InvoiceStatusClass {
 
 export const InvoiceStatusClassStatusEnum = {
     Open: 'open',
-    Paid: 'paid'
+    Paid: 'paid',
+    PartiallyPaid: 'partially-paid'
 } as const;
 
 export type InvoiceStatusClassStatusEnum = typeof InvoiceStatusClassStatusEnum[keyof typeof InvoiceStatusClassStatusEnum];

package/models/omit-type-class.ts

@@ -14,6 +14,7 @@
 
 
 import { InvoiceItemClass } from './invoice-item-class';
+import { InvoicePaymentsClass } from './invoice-payments-class';
 
 /**
  * 
@@ -81,6 +82,12 @@ export interface OmitTypeClass {
      * @memberof OmitTypeClass
      */
     'grossAmount': number;
+    /**
+     * Paid amount. This property is amount paid by this invoice. The amount corresponds to the sum (positives and negatives) of all payments relating to that invoice.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'paidAmount': number;
     /**
      * Invoice status.
      * @type {string}
@@ -129,6 +136,12 @@ export interface OmitTypeClass {
      * @memberof OmitTypeClass
      */
     'currency': string;
+    /**
+     * Invoice payments.
+     * @type {InvoicePaymentsClass}
+     * @memberof OmitTypeClass
+     */
+    'payments': InvoicePaymentsClass;
 }
 
 export const OmitTypeClassTypeEnum = {
@@ -145,7 +158,8 @@ export const OmitTypeClassTypeEnum = {
 export type OmitTypeClassTypeEnum = typeof OmitTypeClassTypeEnum[keyof typeof OmitTypeClassTypeEnum];
 export const OmitTypeClassStatusEnum = {
     Open: 'open',
-    Paid: 'paid'
+    Paid: 'paid',
+    PartiallyPaid: 'partially-paid'
 } as const;
 
 export type OmitTypeClassStatusEnum = typeof OmitTypeClassStatusEnum[keyof typeof OmitTypeClassStatusEnum];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/billing-sdk",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "OpenAPI client for @emilgroup/billing-sdk",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [
@@ -21,7 +21,6 @@
     "axios": "^0.27.2"
   },
   "devDependencies": {
-   
     "typescript": "^4.0"
   }
 }

package/dist/api/correction-invoices-api.d.ts

@@ -1,106 +0,0 @@
-/**
- * EMIL BillingService
- * 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
- * Do not edit the class manually.
- */
-import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { Configuration } from '../configuration';
-import { RequestArgs, BaseAPI } from '../base';
-import { CreateCorrectionInvoicesResponseClass } from '../models';
-import { CreateInvoiceRequestDto } from '../models';
-/**
- * CorrectionInvoicesApi - axios parameter creator
- * @export
- */
-export declare const CorrectionInvoicesApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * 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, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * CorrectionInvoicesApi - functional programming interface
- * @export
- */
-export declare const CorrectionInvoicesApiFp: (configuration?: Configuration) => {
-    /**
-     * 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, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCorrectionInvoicesResponseClass>>;
-};
-/**
- * CorrectionInvoicesApi - factory interface
- * @export
- */
-export declare const CorrectionInvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * 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, idempotencyKey?: string, options?: any): AxiosPromise<CreateCorrectionInvoicesResponseClass>;
-};
-/**
- * Request parameters for createCorrectionInvoice operation in CorrectionInvoicesApi.
- * @export
- * @interface CorrectionInvoicesApiCreateCorrectionInvoiceRequest
- */
-export interface CorrectionInvoicesApiCreateCorrectionInvoiceRequest {
-    /**
-     *
-     * @type {CreateInvoiceRequestDto}
-     * @memberof CorrectionInvoicesApiCreateCorrectionInvoice
-     */
-    readonly createInvoiceRequestDto: CreateInvoiceRequestDto;
-    /**
-     * Bearer Token
-     * @type {string}
-     * @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;
-}
-/**
- * CorrectionInvoicesApi - object-oriented interface
- * @export
- * @class CorrectionInvoicesApi
- * @extends {BaseAPI}
- */
-export declare 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
-     */
-    createCorrectionInvoice(requestParameters: CorrectionInvoicesApiCreateCorrectionInvoiceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCorrectionInvoicesResponseClass, any>>;
-}