@emilgroup/billing-sdk-node 1.17.0 → 1.17.1-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/.openapi-generator/FILES +2 -1
  2. package/README.md +2 -2
  3. package/api/estimated-invoices-api.ts +111 -4
  4. package/api/invoices-api.ts +48 -154
  5. package/dist/api/estimated-invoices-api.d.ts +61 -4
  6. package/dist/api/estimated-invoices-api.js +97 -4
  7. package/dist/api/invoices-api.d.ts +32 -89
  8. package/dist/api/invoices-api.js +30 -123
  9. package/dist/models/create-estimated-invoice-for-interval-request-dto.d.ts +49 -0
  10. package/dist/models/{create-invoice-payment-response-class.d.ts → create-estimated-invoice-for-interval-response-class.d.ts} +7 -7
  11. package/dist/models/create-estimated-invoice-for-interval-response-class.js +15 -0
  12. package/dist/models/create-invoice-payment-request-dto.d.ts +6 -0
  13. package/dist/models/create-invoice-request-dto.d.ts +1 -1
  14. package/dist/models/create-invoice-status-request-dto.d.ts +1 -0
  15. package/dist/models/create-invoice-status-request-dto.js +2 -1
  16. package/dist/models/index.d.ts +2 -1
  17. package/dist/models/index.js +2 -1
  18. package/dist/models/inline-response200.d.ts +6 -6
  19. package/dist/models/inline-response503.d.ts +6 -6
  20. package/dist/models/invoice-class.d.ts +1 -0
  21. package/dist/models/invoice-class.js +2 -1
  22. package/dist/models/invoice-payment-class.d.ts +7 -7
  23. package/dist/models/invoice-status-class.d.ts +1 -0
  24. package/dist/models/invoice-status-class.js +2 -1
  25. package/dist/models/omit-type-class.d.ts +8 -0
  26. package/dist/models/omit-type-class.js +2 -1
  27. package/dist/models/policy-dto.d.ts +1 -1
  28. package/dist/models/policy-object-dto.d.ts +12 -12
  29. package/dist/models/policy-version-dto.d.ts +6 -0
  30. package/models/create-estimated-invoice-for-interval-request-dto.ts +55 -0
  31. package/models/{create-invoice-payment-response-class.ts → create-estimated-invoice-for-interval-response-class.ts} +7 -7
  32. package/models/create-invoice-payment-request-dto.ts +6 -0
  33. package/models/create-invoice-request-dto.ts +1 -1
  34. package/models/create-invoice-status-request-dto.ts +2 -1
  35. package/models/index.ts +2 -1
  36. package/models/inline-response200.ts +6 -6
  37. package/models/inline-response503.ts +6 -6
  38. package/models/invoice-class.ts +2 -1
  39. package/models/invoice-payment-class.ts +7 -7
  40. package/models/invoice-status-class.ts +2 -1
  41. package/models/omit-type-class.ts +9 -1
  42. package/models/policy-dto.ts +1 -1
  43. package/models/policy-object-dto.ts +12 -12
  44. package/models/policy-version-dto.ts +6 -0
  45. package/package.json +1 -1
  46. /package/dist/models/{create-invoice-payment-response-class.js → create-estimated-invoice-for-interval-request-dto.js} +0 -0
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { InvoiceItemClass } from './invoice-item-class';
13
+ import { InvoicePaymentsClass } from './invoice-payments-class';
13
14
  /**
14
15
  *
15
16
  * @export
@@ -136,6 +137,12 @@ export interface OmitTypeClass {
136
137
  * @memberof OmitTypeClass
137
138
  */
138
139
  'currency': string;
140
+ /**
141
+ * Invoice payments.
142
+ * @type {InvoicePaymentsClass}
143
+ * @memberof OmitTypeClass
144
+ */
145
+ 'payments': InvoicePaymentsClass;
139
146
  }
140
147
  export declare const OmitTypeClassTypeEnum: {
141
148
  readonly Initial: "initial";
@@ -152,5 +159,6 @@ export declare const OmitTypeClassStatusEnum: {
152
159
  readonly Open: "open";
153
160
  readonly Paid: "paid";
154
161
  readonly PartiallyPaid: "partially-paid";
162
+ readonly Refunded: "refunded";
155
163
  };
156
164
  export type OmitTypeClassStatusEnum = typeof OmitTypeClassStatusEnum[keyof typeof OmitTypeClassStatusEnum];
@@ -27,5 +27,6 @@ exports.OmitTypeClassTypeEnum = {
27
27
  exports.OmitTypeClassStatusEnum = {
28
28
  Open: 'open',
29
29
  Paid: 'paid',
30
- PartiallyPaid: 'partially-paid'
30
+ PartiallyPaid: 'partially-paid',
31
+ Refunded: 'refunded'
31
32
  };
@@ -95,7 +95,7 @@ export interface PolicyDto {
95
95
  */
96
96
  'productName': string;
97
97
  /**
98
- * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
98
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
99
99
  * @type {string}
100
100
  * @memberof PolicyDto
101
101
  */
@@ -27,6 +27,18 @@ export interface PolicyObjectDto {
27
27
  * @memberof PolicyObjectDto
28
28
  */
29
29
  'insuredObjectName': string;
30
+ /**
31
+ * Insured object label.
32
+ * @type {string}
33
+ * @memberof PolicyObjectDto
34
+ */
35
+ 'insuredObjectLabel': string;
36
+ /**
37
+ * A boolean value indicating whether the insured object accepts multiple objects.
38
+ * @type {boolean}
39
+ * @memberof PolicyObjectDto
40
+ */
41
+ 'isMultiInsuredObject': boolean;
30
42
  /**
31
43
  * Insured object summary.
32
44
  * @type {string}
@@ -57,16 +69,4 @@ export interface PolicyObjectDto {
57
69
  * @memberof PolicyObjectDto
58
70
  */
59
71
  'code': string;
60
- /**
61
- *
62
- * @type {string}
63
- * @memberof PolicyObjectDto
64
- */
65
- 'insuredObjectLabel': string;
66
- /**
67
- *
68
- * @type {boolean}
69
- * @memberof PolicyObjectDto
70
- */
71
- 'isMultiInsuredObject': boolean;
72
72
  }
@@ -52,4 +52,10 @@ export interface PolicyVersionDto {
52
52
  * @memberof PolicyVersionDto
53
53
  */
54
54
  'timeline': Array<TimesliceDto>;
55
+ /**
56
+ * Is this a draft policy version?
57
+ * @type {boolean}
58
+ * @memberof PolicyVersionDto
59
+ */
60
+ 'isDraft': boolean;
55
61
  }
@@ -0,0 +1,55 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL BillingService
5
+ * The EMIL BillingService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { PolicyDto } from './policy-dto';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface CreateEstimatedInvoiceForIntervalRequestDto
22
+ */
23
+ export interface CreateEstimatedInvoiceForIntervalRequestDto {
24
+ /**
25
+ * The policy object that the invoice is attached to. This contains all relevant policy details associated with this invoice.
26
+ * @type {PolicyDto}
27
+ * @memberof CreateEstimatedInvoiceForIntervalRequestDto
28
+ */
29
+ 'policy': PolicyDto;
30
+ /**
31
+ * Metadata contains extra information that the object would need for specific cases.
32
+ * @type {object}
33
+ * @memberof CreateEstimatedInvoiceForIntervalRequestDto
34
+ */
35
+ 'metadata'?: object;
36
+ /**
37
+ * A boolean flag indicating whether the invoice should be calculated on a pro rata basis. When true, the invoice amount is adjusted proportionally based on the duration of service.
38
+ * @type {object}
39
+ * @memberof CreateEstimatedInvoiceForIntervalRequestDto
40
+ */
41
+ 'calculateProRata'?: object;
42
+ /**
43
+ * The start date of the billing interval. This is the date from which the invoice period begins.
44
+ * @type {string}
45
+ * @memberof CreateEstimatedInvoiceForIntervalRequestDto
46
+ */
47
+ 'billingIntervalFrom': string;
48
+ /**
49
+ * The end date of the billing interval. This is the date until which the invoice period runs. Together with billingIntervalFrom, it defines the time period for which the invoice is issued.
50
+ * @type {string}
51
+ * @memberof CreateEstimatedInvoiceForIntervalRequestDto
52
+ */
53
+ 'billingIntervalTo': string;
54
+ }
55
+
@@ -13,19 +13,19 @@
13
13
  */
14
14
 
15
15
 
16
- import { OmitTypeClass } from './omit-type-class';
16
+ import { InvoiceClass } from './invoice-class';
17
17
 
18
18
  /**
19
19
  *
20
20
  * @export
21
- * @interface CreateInvoicePaymentResponseClass
21
+ * @interface CreateEstimatedInvoiceForIntervalResponseClass
22
22
  */
23
- export interface CreateInvoicePaymentResponseClass {
23
+ export interface CreateEstimatedInvoiceForIntervalResponseClass {
24
24
  /**
25
- * Invoice updated after payment.
26
- * @type {OmitTypeClass}
27
- * @memberof CreateInvoicePaymentResponseClass
25
+ * Estimated invoice response
26
+ * @type {InvoiceClass}
27
+ * @memberof CreateEstimatedInvoiceForIntervalResponseClass
28
28
  */
29
- 'invoice': OmitTypeClass;
29
+ 'invoice': InvoiceClass;
30
30
  }
31
31
 
@@ -50,5 +50,11 @@ export interface CreateInvoicePaymentRequestDto {
50
50
  * @memberof CreateInvoicePaymentRequestDto
51
51
  */
52
52
  'paymentId': number;
53
+ /**
54
+ *
55
+ * @type {number}
56
+ * @memberof CreateInvoicePaymentRequestDto
57
+ */
58
+ 'invoiceId': number;
53
59
  }
54
60
 
@@ -49,7 +49,7 @@ export interface CreateInvoiceRequestDto {
49
49
  * @type {string}
50
50
  * @memberof CreateInvoiceRequestDto
51
51
  */
52
- 'type': CreateInvoiceRequestDtoTypeEnum;
52
+ 'type'?: CreateInvoiceRequestDtoTypeEnum;
53
53
  /**
54
54
  * Metadata contains extra information that the object would need for specific cases.
55
55
  * @type {object}
@@ -37,7 +37,8 @@ export interface CreateInvoiceStatusRequestDto {
37
37
  export const CreateInvoiceStatusRequestDtoStatusEnum = {
38
38
  Open: 'open',
39
39
  Paid: 'paid',
40
- PartiallyPaid: 'partially-paid'
40
+ PartiallyPaid: 'partially-paid',
41
+ Refunded: 'refunded'
41
42
  } as const;
42
43
 
43
44
  export type CreateInvoiceStatusRequestDtoStatusEnum = typeof CreateInvoiceStatusRequestDtoStatusEnum[keyof typeof CreateInvoiceStatusRequestDtoStatusEnum];
package/models/index.ts CHANGED
@@ -1,10 +1,11 @@
1
1
  export * from './create-correction-invoices-response-class';
2
2
  export * from './create-custom-estimated-invoice-request-dto';
3
3
  export * from './create-custom-estimated-invoice-response-class';
4
+ export * from './create-estimated-invoice-for-interval-request-dto';
5
+ export * from './create-estimated-invoice-for-interval-response-class';
4
6
  export * from './create-estimated-invoice-request-dto';
5
7
  export * from './create-estimated-invoice-response-class';
6
8
  export * from './create-invoice-payment-request-dto';
7
- export * from './create-invoice-payment-response-class';
8
9
  export * from './create-invoice-request-dto';
9
10
  export * from './create-invoice-response-class';
10
11
  export * from './create-invoice-status-request-dto';
@@ -28,21 +28,21 @@ export interface InlineResponse200 {
28
28
  'status'?: string;
29
29
  /**
30
30
  *
31
- * @type {{ [key: string]: { [key: string]: string; }; }}
31
+ * @type {{ [key: string]: { [key: string]: object; }; }}
32
32
  * @memberof InlineResponse200
33
33
  */
34
- 'info'?: { [key: string]: { [key: string]: string; }; } | null;
34
+ 'info'?: { [key: string]: { [key: string]: object; }; } | null;
35
35
  /**
36
36
  *
37
- * @type {{ [key: string]: { [key: string]: string; }; }}
37
+ * @type {{ [key: string]: { [key: string]: object; }; }}
38
38
  * @memberof InlineResponse200
39
39
  */
40
- 'error'?: { [key: string]: { [key: string]: string; }; } | null;
40
+ 'error'?: { [key: string]: { [key: string]: object; }; } | null;
41
41
  /**
42
42
  *
43
- * @type {{ [key: string]: { [key: string]: string; }; }}
43
+ * @type {{ [key: string]: { [key: string]: object; }; }}
44
44
  * @memberof InlineResponse200
45
45
  */
46
- 'details'?: { [key: string]: { [key: string]: string; }; };
46
+ 'details'?: { [key: string]: { [key: string]: object; }; };
47
47
  }
48
48
 
@@ -28,21 +28,21 @@ export interface InlineResponse503 {
28
28
  'status'?: string;
29
29
  /**
30
30
  *
31
- * @type {{ [key: string]: { [key: string]: string; }; }}
31
+ * @type {{ [key: string]: { [key: string]: object; }; }}
32
32
  * @memberof InlineResponse503
33
33
  */
34
- 'info'?: { [key: string]: { [key: string]: string; }; } | null;
34
+ 'info'?: { [key: string]: { [key: string]: object; }; } | null;
35
35
  /**
36
36
  *
37
- * @type {{ [key: string]: { [key: string]: string; }; }}
37
+ * @type {{ [key: string]: { [key: string]: object; }; }}
38
38
  * @memberof InlineResponse503
39
39
  */
40
- 'error'?: { [key: string]: { [key: string]: string; }; } | null;
40
+ 'error'?: { [key: string]: { [key: string]: object; }; } | null;
41
41
  /**
42
42
  *
43
- * @type {{ [key: string]: { [key: string]: string; }; }}
43
+ * @type {{ [key: string]: { [key: string]: object; }; }}
44
44
  * @memberof InlineResponse503
45
45
  */
46
- 'details'?: { [key: string]: { [key: string]: string; }; };
46
+ 'details'?: { [key: string]: { [key: string]: object; }; };
47
47
  }
48
48
 
@@ -172,7 +172,8 @@ export type InvoiceClassTypeEnum = typeof InvoiceClassTypeEnum[keyof typeof Invo
172
172
  export const InvoiceClassStatusEnum = {
173
173
  Open: 'open',
174
174
  Paid: 'paid',
175
- PartiallyPaid: 'partially-paid'
175
+ PartiallyPaid: 'partially-paid',
176
+ Refunded: 'refunded'
176
177
  } as const;
177
178
 
178
179
  export type InvoiceClassStatusEnum = typeof InvoiceClassStatusEnum[keyof typeof InvoiceClassStatusEnum];
@@ -55,7 +55,7 @@ export interface InvoicePaymentClass {
55
55
  * @type {string}
56
56
  * @memberof InvoicePaymentClass
57
57
  */
58
- 'comment': string;
58
+ 'commment': string;
59
59
  /**
60
60
  * User who added payment.
61
61
  * @type {string}
@@ -93,16 +93,16 @@ export interface InvoicePaymentClass {
93
93
  */
94
94
  'newInvoiceStatus': string;
95
95
  /**
96
- * Time at which the object was created.
97
- * @type {string}
96
+ * Id of the payment linked to the invoice.
97
+ * @type {number}
98
98
  * @memberof InvoicePaymentClass
99
99
  */
100
- 'createdAt': string;
100
+ 'paymentId': number;
101
101
  /**
102
- * Invoice payment id.
103
- * @type {number}
102
+ * Time at which the object was created.
103
+ * @type {string}
104
104
  * @memberof InvoicePaymentClass
105
105
  */
106
- 'paymentId': number;
106
+ 'createdAt': string;
107
107
  }
108
108
 
@@ -49,7 +49,8 @@ export interface InvoiceStatusClass {
49
49
  export const InvoiceStatusClassStatusEnum = {
50
50
  Open: 'open',
51
51
  Paid: 'paid',
52
- PartiallyPaid: 'partially-paid'
52
+ PartiallyPaid: 'partially-paid',
53
+ Refunded: 'refunded'
53
54
  } as const;
54
55
 
55
56
  export type InvoiceStatusClassStatusEnum = typeof InvoiceStatusClassStatusEnum[keyof typeof InvoiceStatusClassStatusEnum];
@@ -14,6 +14,7 @@
14
14
 
15
15
 
16
16
  import { InvoiceItemClass } from './invoice-item-class';
17
+ import { InvoicePaymentsClass } from './invoice-payments-class';
17
18
 
18
19
  /**
19
20
  *
@@ -141,6 +142,12 @@ export interface OmitTypeClass {
141
142
  * @memberof OmitTypeClass
142
143
  */
143
144
  'currency': string;
145
+ /**
146
+ * Invoice payments.
147
+ * @type {InvoicePaymentsClass}
148
+ * @memberof OmitTypeClass
149
+ */
150
+ 'payments': InvoicePaymentsClass;
144
151
  }
145
152
 
146
153
  export const OmitTypeClassTypeEnum = {
@@ -158,7 +165,8 @@ export type OmitTypeClassTypeEnum = typeof OmitTypeClassTypeEnum[keyof typeof Om
158
165
  export const OmitTypeClassStatusEnum = {
159
166
  Open: 'open',
160
167
  Paid: 'paid',
161
- PartiallyPaid: 'partially-paid'
168
+ PartiallyPaid: 'partially-paid',
169
+ Refunded: 'refunded'
162
170
  } as const;
163
171
 
164
172
  export type OmitTypeClassStatusEnum = typeof OmitTypeClassStatusEnum[keyof typeof OmitTypeClassStatusEnum];
@@ -100,7 +100,7 @@ export interface PolicyDto {
100
100
  */
101
101
  'productName': string;
102
102
  /**
103
- * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
103
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
104
104
  * @type {string}
105
105
  * @memberof PolicyDto
106
106
  */
@@ -32,6 +32,18 @@ export interface PolicyObjectDto {
32
32
  * @memberof PolicyObjectDto
33
33
  */
34
34
  'insuredObjectName': string;
35
+ /**
36
+ * Insured object label.
37
+ * @type {string}
38
+ * @memberof PolicyObjectDto
39
+ */
40
+ 'insuredObjectLabel': string;
41
+ /**
42
+ * A boolean value indicating whether the insured object accepts multiple objects.
43
+ * @type {boolean}
44
+ * @memberof PolicyObjectDto
45
+ */
46
+ 'isMultiInsuredObject': boolean;
35
47
  /**
36
48
  * Insured object summary.
37
49
  * @type {string}
@@ -62,17 +74,5 @@ export interface PolicyObjectDto {
62
74
  * @memberof PolicyObjectDto
63
75
  */
64
76
  'code': string;
65
- /**
66
- *
67
- * @type {string}
68
- * @memberof PolicyObjectDto
69
- */
70
- 'insuredObjectLabel': string;
71
- /**
72
- *
73
- * @type {boolean}
74
- * @memberof PolicyObjectDto
75
- */
76
- 'isMultiInsuredObject': boolean;
77
77
  }
78
78
 
@@ -57,5 +57,11 @@ export interface PolicyVersionDto {
57
57
  * @memberof PolicyVersionDto
58
58
  */
59
59
  'timeline': Array<TimesliceDto>;
60
+ /**
61
+ * Is this a draft policy version?
62
+ * @type {boolean}
63
+ * @memberof PolicyVersionDto
64
+ */
65
+ 'isDraft': boolean;
60
66
  }
61
67
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/billing-sdk-node",
3
- "version": "1.17.0",
3
+ "version": "1.17.1-beta.1",
4
4
  "description": "OpenAPI client for @emilgroup/billing-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [