@emilgroup/billing-sdk 1.1.0 → 1.2.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 (114) hide show
  1. package/.openapi-generator/FILES +7 -0
  2. package/README.md +2 -2
  3. package/api/correction-invoices-api.ts +29 -11
  4. package/api/estimated-invoices-api.ts +17 -9
  5. package/api/initial-invoices-api.ts +29 -11
  6. package/api/invoices-api.ts +95 -87
  7. package/api/recurring-invoices-api.ts +29 -11
  8. package/api.ts +1 -6
  9. package/base.ts +5 -4
  10. package/common.ts +2 -2
  11. package/configuration.ts +1 -1
  12. package/dist/api/correction-invoices-api.d.ts +21 -8
  13. package/dist/api/correction-invoices-api.js +21 -11
  14. package/dist/api/estimated-invoices-api.d.ts +17 -9
  15. package/dist/api/estimated-invoices-api.js +17 -9
  16. package/dist/api/initial-invoices-api.d.ts +21 -8
  17. package/dist/api/initial-invoices-api.js +21 -11
  18. package/dist/api/invoices-api.d.ts +95 -87
  19. package/dist/api/invoices-api.js +53 -45
  20. package/dist/api/recurring-invoices-api.d.ts +21 -8
  21. package/dist/api/recurring-invoices-api.js +21 -11
  22. package/dist/api.d.ts +1 -5
  23. package/dist/api.js +1 -7
  24. package/dist/base.d.ts +4 -3
  25. package/dist/base.js +5 -4
  26. package/dist/common.d.ts +2 -2
  27. package/dist/common.js +1 -1
  28. package/dist/configuration.d.ts +1 -1
  29. package/dist/configuration.js +1 -1
  30. package/dist/index.d.ts +2 -2
  31. package/dist/index.js +3 -2
  32. package/dist/models/create-correction-invoices-response-class.d.ts +5 -5
  33. package/dist/models/create-correction-invoices-response-class.js +1 -1
  34. package/dist/models/create-custom-estimated-invoice-request-dto.d.ts +3 -3
  35. package/dist/models/create-custom-estimated-invoice-request-dto.js +1 -1
  36. package/dist/models/create-custom-estimated-invoice-response-class.d.ts +1 -1
  37. package/dist/models/create-custom-estimated-invoice-response-class.js +1 -1
  38. package/dist/models/create-estimated-invoice-request-dto.d.ts +3 -3
  39. package/dist/models/create-estimated-invoice-request-dto.js +1 -1
  40. package/dist/models/create-estimated-invoice-response-class.d.ts +3 -3
  41. package/dist/models/create-estimated-invoice-response-class.js +1 -1
  42. package/dist/models/create-invoice-request-dto.d.ts +16 -14
  43. package/dist/models/create-invoice-request-dto.js +4 -2
  44. package/dist/models/create-invoice-response-class.d.ts +5 -5
  45. package/dist/models/create-invoice-response-class.js +1 -1
  46. package/dist/models/create-invoice-status-request-dto.d.ts +35 -0
  47. package/dist/models/create-invoice-status-request-dto.js +20 -0
  48. package/dist/models/create-termination-invoice-request-dto.d.ts +48 -0
  49. package/dist/models/create-termination-invoice-request-dto.js +15 -0
  50. package/dist/models/currency-class.d.ts +48 -0
  51. package/dist/models/currency-class.js +15 -0
  52. package/dist/models/index.d.ts +7 -0
  53. package/dist/models/index.js +7 -0
  54. package/dist/models/invoice-class.d.ts +50 -20
  55. package/dist/models/invoice-class.js +16 -1
  56. package/dist/models/invoice-item-class.d.ts +26 -17
  57. package/dist/models/invoice-item-class.js +10 -1
  58. package/dist/models/invoice-status-class.d.ts +47 -0
  59. package/dist/models/invoice-status-class.js +20 -0
  60. package/dist/models/list-invoices-response-class.d.ts +3 -3
  61. package/dist/models/list-invoices-response-class.js +1 -1
  62. package/dist/models/list-policies-billing-dates-response-class.d.ts +6 -5
  63. package/dist/models/list-policies-billing-dates-response-class.js +1 -1
  64. package/dist/models/list-request-dto.d.ts +1 -1
  65. package/dist/models/list-request-dto.js +1 -1
  66. package/dist/models/omit-type-class.d.ts +144 -0
  67. package/dist/models/omit-type-class.js +30 -0
  68. package/dist/models/policy-billing-date-class.d.ts +42 -0
  69. package/dist/models/policy-billing-date-class.js +15 -0
  70. package/dist/models/policy-dto.d.ts +62 -25
  71. package/dist/models/policy-dto.js +8 -1
  72. package/dist/models/policy-object-dto.d.ts +10 -10
  73. package/dist/models/policy-object-dto.js +1 -1
  74. package/dist/models/policy-premium-dto.d.ts +12 -12
  75. package/dist/models/policy-premium-dto.js +1 -1
  76. package/dist/models/policy-premium-item-dto.d.ts +20 -14
  77. package/dist/models/policy-premium-item-dto.js +1 -1
  78. package/dist/models/policy-version-dto.d.ts +17 -17
  79. package/dist/models/policy-version-dto.js +1 -1
  80. package/dist/models/premium-formula-dto.d.ts +20 -20
  81. package/dist/models/premium-formula-dto.js +1 -1
  82. package/dist/models/revert-invoice-request-dto.d.ts +24 -0
  83. package/dist/models/revert-invoice-request-dto.js +15 -0
  84. package/dist/models/timeslice-dto.d.ts +13 -13
  85. package/dist/models/timeslice-dto.js +1 -1
  86. package/index.ts +2 -2
  87. package/models/create-correction-invoices-response-class.ts +5 -5
  88. package/models/create-custom-estimated-invoice-request-dto.ts +3 -3
  89. package/models/create-custom-estimated-invoice-response-class.ts +1 -1
  90. package/models/create-estimated-invoice-request-dto.ts +3 -3
  91. package/models/create-estimated-invoice-response-class.ts +3 -3
  92. package/models/create-invoice-request-dto.ts +17 -15
  93. package/models/create-invoice-response-class.ts +5 -5
  94. package/models/create-invoice-status-request-dto.ts +44 -0
  95. package/models/create-termination-invoice-request-dto.ts +54 -0
  96. package/models/currency-class.ts +54 -0
  97. package/models/index.ts +7 -0
  98. package/models/invoice-class.ts +54 -20
  99. package/models/invoice-item-class.ts +29 -17
  100. package/models/invoice-status-class.ts +56 -0
  101. package/models/list-invoices-response-class.ts +3 -3
  102. package/models/list-policies-billing-dates-response-class.ts +6 -5
  103. package/models/list-request-dto.ts +1 -1
  104. package/models/omit-type-class.ts +154 -0
  105. package/models/policy-billing-date-class.ts +48 -0
  106. package/models/policy-dto.ts +65 -25
  107. package/models/policy-object-dto.ts +10 -10
  108. package/models/policy-premium-dto.ts +12 -12
  109. package/models/policy-premium-item-dto.ts +20 -14
  110. package/models/policy-version-dto.ts +17 -17
  111. package/models/premium-formula-dto.ts +20 -20
  112. package/models/revert-invoice-request-dto.ts +30 -0
  113. package/models/timeslice-dto.ts +13 -13
  114. package/package.json +1 -1
@@ -5,7 +5,7 @@
5
5
  * The EMIL BillingService API description
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
- *
8
+ * Contact: kontakt@emil.de
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -31,18 +31,19 @@ import { ListPoliciesBillingDatesResponseClass } from '../models';
31
31
  export const InvoicesApiAxiosParamCreator = function (configuration?: Configuration) {
32
32
  return {
33
33
  /**
34
- *
34
+ * Returns a list of invoices you have previously created. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
35
+ * @summary List invoices
35
36
  * @param {string} [authorization] Bearer Token
36
- * @param {number} [pageSize] Page size
37
- * @param {string} [pageToken] Page token
38
- * @param {string} [filter] List filter
39
- * @param {string} [search] Search query
40
- * @param {string} [order] Ordering criteria
41
- * @param {string} [expand] Extra fields to fetch
37
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
38
+ * @param {any} [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.
39
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
40
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
41
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
42
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
42
43
  * @param {*} [options] Override http request option.
43
44
  * @throws {RequiredError}
44
45
  */
45
- listInvoices: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
+ listInvoices: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
47
  const localVarPath = `/billingservice/v1/invoices`;
47
48
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
48
49
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -101,18 +102,19 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
101
102
  };
102
103
  },
103
104
  /**
104
- *
105
+ * Returns a list of policies billing dates you have previously created. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
106
+ * @summary List policies billing dates
105
107
  * @param {string} [authorization] Bearer Token
106
- * @param {number} [pageSize] Page size
107
- * @param {string} [pageToken] Page token
108
- * @param {string} [filter] List filter
109
- * @param {string} [search] Search query
110
- * @param {string} [order] Ordering criteria
111
- * @param {string} [expand] Extra fields to fetch
108
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
109
+ * @param {any} [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.
110
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
111
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
112
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
113
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
112
114
  * @param {*} [options] Override http request option.
113
115
  * @throws {RequiredError}
114
116
  */
115
- listPoliciesBillingDates: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
117
+ listPoliciesBillingDates: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
116
118
  const localVarPath = `/billingservice/v1/invoices/policies-billing-dates`;
117
119
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
118
120
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -181,34 +183,36 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
181
183
  const localVarAxiosParamCreator = InvoicesApiAxiosParamCreator(configuration)
182
184
  return {
183
185
  /**
184
- *
186
+ * Returns a list of invoices you have previously created. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
187
+ * @summary List invoices
185
188
  * @param {string} [authorization] Bearer Token
186
- * @param {number} [pageSize] Page size
187
- * @param {string} [pageToken] Page token
188
- * @param {string} [filter] List filter
189
- * @param {string} [search] Search query
190
- * @param {string} [order] Ordering criteria
191
- * @param {string} [expand] Extra fields to fetch
189
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
190
+ * @param {any} [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.
191
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
192
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
193
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
194
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
192
195
  * @param {*} [options] Override http request option.
193
196
  * @throws {RequiredError}
194
197
  */
195
- async listInvoices(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvoicesResponseClass>> {
198
+ async listInvoices(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvoicesResponseClass>> {
196
199
  const localVarAxiosArgs = await localVarAxiosParamCreator.listInvoices(authorization, pageSize, pageToken, filter, search, order, expand, options);
197
200
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
198
201
  },
199
202
  /**
200
- *
203
+ * Returns a list of policies billing dates you have previously created. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
204
+ * @summary List policies billing dates
201
205
  * @param {string} [authorization] Bearer Token
202
- * @param {number} [pageSize] Page size
203
- * @param {string} [pageToken] Page token
204
- * @param {string} [filter] List filter
205
- * @param {string} [search] Search query
206
- * @param {string} [order] Ordering criteria
207
- * @param {string} [expand] Extra fields to fetch
206
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
207
+ * @param {any} [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.
208
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
209
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
210
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
211
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
208
212
  * @param {*} [options] Override http request option.
209
213
  * @throws {RequiredError}
210
214
  */
211
- async listPoliciesBillingDates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesBillingDatesResponseClass>> {
215
+ async listPoliciesBillingDates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesBillingDatesResponseClass>> {
212
216
  const localVarAxiosArgs = await localVarAxiosParamCreator.listPoliciesBillingDates(authorization, pageSize, pageToken, filter, search, order, expand, options);
213
217
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
214
218
  },
@@ -223,33 +227,35 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
223
227
  const localVarFp = InvoicesApiFp(configuration)
224
228
  return {
225
229
  /**
226
- *
230
+ * Returns a list of invoices you have previously created. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
231
+ * @summary List invoices
227
232
  * @param {string} [authorization] Bearer Token
228
- * @param {number} [pageSize] Page size
229
- * @param {string} [pageToken] Page token
230
- * @param {string} [filter] List filter
231
- * @param {string} [search] Search query
232
- * @param {string} [order] Ordering criteria
233
- * @param {string} [expand] Extra fields to fetch
233
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
234
+ * @param {any} [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.
235
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
236
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
237
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
238
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
234
239
  * @param {*} [options] Override http request option.
235
240
  * @throws {RequiredError}
236
241
  */
237
- listInvoices(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListInvoicesResponseClass> {
242
+ listInvoices(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListInvoicesResponseClass> {
238
243
  return localVarFp.listInvoices(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
239
244
  },
240
245
  /**
241
- *
246
+ * Returns a list of policies billing dates you have previously created. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
247
+ * @summary List policies billing dates
242
248
  * @param {string} [authorization] Bearer Token
243
- * @param {number} [pageSize] Page size
244
- * @param {string} [pageToken] Page token
245
- * @param {string} [filter] List filter
246
- * @param {string} [search] Search query
247
- * @param {string} [order] Ordering criteria
248
- * @param {string} [expand] Extra fields to fetch
249
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
250
+ * @param {any} [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.
251
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
252
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
253
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
254
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
249
255
  * @param {*} [options] Override http request option.
250
256
  * @throws {RequiredError}
251
257
  */
252
- listPoliciesBillingDates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPoliciesBillingDatesResponseClass> {
258
+ listPoliciesBillingDates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListPoliciesBillingDatesResponseClass> {
253
259
  return localVarFp.listPoliciesBillingDates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
254
260
  },
255
261
  };
@@ -269,46 +275,46 @@ export interface InvoicesApiListInvoicesRequest {
269
275
  readonly authorization?: string
270
276
 
271
277
  /**
272
- * Page size
273
- * @type {number}
278
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
279
+ * @type {any}
274
280
  * @memberof InvoicesApiListInvoices
275
281
  */
276
- readonly pageSize?: number
282
+ readonly pageSize?: any
277
283
 
278
284
  /**
279
- * Page token
280
- * @type {string}
285
+ * 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.
286
+ * @type {any}
281
287
  * @memberof InvoicesApiListInvoices
282
288
  */
283
- readonly pageToken?: string
289
+ readonly pageToken?: any
284
290
 
285
291
  /**
286
- * List filter
287
- * @type {string}
292
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
293
+ * @type {any}
288
294
  * @memberof InvoicesApiListInvoices
289
295
  */
290
- readonly filter?: string
296
+ readonly filter?: any
291
297
 
292
298
  /**
293
- * Search query
294
- * @type {string}
299
+ * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
300
+ * @type {any}
295
301
  * @memberof InvoicesApiListInvoices
296
302
  */
297
- readonly search?: string
303
+ readonly search?: any
298
304
 
299
305
  /**
300
- * Ordering criteria
301
- * @type {string}
306
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
307
+ * @type {any}
302
308
  * @memberof InvoicesApiListInvoices
303
309
  */
304
- readonly order?: string
310
+ readonly order?: any
305
311
 
306
312
  /**
307
- * Extra fields to fetch
308
- * @type {string}
313
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
314
+ * @type {any}
309
315
  * @memberof InvoicesApiListInvoices
310
316
  */
311
- readonly expand?: string
317
+ readonly expand?: any
312
318
  }
313
319
 
314
320
  /**
@@ -325,46 +331,46 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
325
331
  readonly authorization?: string
326
332
 
327
333
  /**
328
- * Page size
329
- * @type {number}
334
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
335
+ * @type {any}
330
336
  * @memberof InvoicesApiListPoliciesBillingDates
331
337
  */
332
- readonly pageSize?: number
338
+ readonly pageSize?: any
333
339
 
334
340
  /**
335
- * Page token
336
- * @type {string}
341
+ * 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.
342
+ * @type {any}
337
343
  * @memberof InvoicesApiListPoliciesBillingDates
338
344
  */
339
- readonly pageToken?: string
345
+ readonly pageToken?: any
340
346
 
341
347
  /**
342
- * List filter
343
- * @type {string}
348
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
349
+ * @type {any}
344
350
  * @memberof InvoicesApiListPoliciesBillingDates
345
351
  */
346
- readonly filter?: string
352
+ readonly filter?: any
347
353
 
348
354
  /**
349
- * Search query
350
- * @type {string}
355
+ * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
356
+ * @type {any}
351
357
  * @memberof InvoicesApiListPoliciesBillingDates
352
358
  */
353
- readonly search?: string
359
+ readonly search?: any
354
360
 
355
361
  /**
356
- * Ordering criteria
357
- * @type {string}
362
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
363
+ * @type {any}
358
364
  * @memberof InvoicesApiListPoliciesBillingDates
359
365
  */
360
- readonly order?: string
366
+ readonly order?: any
361
367
 
362
368
  /**
363
- * Extra fields to fetch
364
- * @type {string}
369
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
370
+ * @type {any}
365
371
  * @memberof InvoicesApiListPoliciesBillingDates
366
372
  */
367
- readonly expand?: string
373
+ readonly expand?: any
368
374
  }
369
375
 
370
376
  /**
@@ -375,7 +381,8 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
375
381
  */
376
382
  export class InvoicesApi extends BaseAPI {
377
383
  /**
378
- *
384
+ * Returns a list of invoices you have previously created. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
385
+ * @summary List invoices
379
386
  * @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
380
387
  * @param {*} [options] Override http request option.
381
388
  * @throws {RequiredError}
@@ -386,7 +393,8 @@ export class InvoicesApi extends BaseAPI {
386
393
  }
387
394
 
388
395
  /**
389
- *
396
+ * Returns a list of policies billing dates you have previously created. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
397
+ * @summary List policies billing dates
390
398
  * @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
391
399
  * @param {*} [options] Override http request option.
392
400
  * @throws {RequiredError}
@@ -5,7 +5,7 @@
5
5
  * The EMIL BillingService API description
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
- *
8
+ * Contact: kontakt@emil.de
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -31,13 +31,15 @@ import { CreateInvoiceResponseClass } from '../models';
31
31
  export const RecurringInvoicesApiAxiosParamCreator = function (configuration?: Configuration) {
32
32
  return {
33
33
  /**
34
- *
34
+ * This will create recurring invoice. It will be generated on a cyclical basis during the lifetime of a policy.
35
+ * @summary Create the recurring invoice
35
36
  * @param {CreateInvoiceRequestDto} createInvoiceRequestDto
36
37
  * @param {string} [authorization] Bearer Token
38
+ * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
37
39
  * @param {*} [options] Override http request option.
38
40
  * @throws {RequiredError}
39
41
  */
40
- createRecurringInvoice: async (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
42
+ createRecurringInvoice: async (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
41
43
  // verify required parameter 'createInvoiceRequestDto' is not null or undefined
42
44
  assertParamExists('createRecurringInvoice', 'createInvoiceRequestDto', createInvoiceRequestDto)
43
45
  const localVarPath = `/billingservice/v1/recurring-invoices`;
@@ -62,6 +64,10 @@ export const RecurringInvoicesApiAxiosParamCreator = function (configuration?: C
62
64
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
63
65
  }
64
66
 
67
+ if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
68
+ localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
69
+ }
70
+
65
71
 
66
72
 
67
73
  localVarHeaderParameter['Content-Type'] = 'application/json';
@@ -87,14 +93,16 @@ export const RecurringInvoicesApiFp = function(configuration?: Configuration) {
87
93
  const localVarAxiosParamCreator = RecurringInvoicesApiAxiosParamCreator(configuration)
88
94
  return {
89
95
  /**
90
- *
96
+ * This will create recurring invoice. It will be generated on a cyclical basis during the lifetime of a policy.
97
+ * @summary Create the recurring invoice
91
98
  * @param {CreateInvoiceRequestDto} createInvoiceRequestDto
92
99
  * @param {string} [authorization] Bearer Token
100
+ * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
93
101
  * @param {*} [options] Override http request option.
94
102
  * @throws {RequiredError}
95
103
  */
96
- async createRecurringInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInvoiceResponseClass>> {
97
- const localVarAxiosArgs = await localVarAxiosParamCreator.createRecurringInvoice(createInvoiceRequestDto, authorization, options);
104
+ async createRecurringInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInvoiceResponseClass>> {
105
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createRecurringInvoice(createInvoiceRequestDto, authorization, idempotencyKey, options);
98
106
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
99
107
  },
100
108
  }
@@ -108,14 +116,16 @@ export const RecurringInvoicesApiFactory = function (configuration?: Configurati
108
116
  const localVarFp = RecurringInvoicesApiFp(configuration)
109
117
  return {
110
118
  /**
111
- *
119
+ * This will create recurring invoice. It will be generated on a cyclical basis during the lifetime of a policy.
120
+ * @summary Create the recurring invoice
112
121
  * @param {CreateInvoiceRequestDto} createInvoiceRequestDto
113
122
  * @param {string} [authorization] Bearer Token
123
+ * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
114
124
  * @param {*} [options] Override http request option.
115
125
  * @throws {RequiredError}
116
126
  */
117
- createRecurringInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: any): AxiosPromise<CreateInvoiceResponseClass> {
118
- return localVarFp.createRecurringInvoice(createInvoiceRequestDto, authorization, options).then((request) => request(axios, basePath));
127
+ createRecurringInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: any): AxiosPromise<CreateInvoiceResponseClass> {
128
+ return localVarFp.createRecurringInvoice(createInvoiceRequestDto, authorization, idempotencyKey, options).then((request) => request(axios, basePath));
119
129
  },
120
130
  };
121
131
  };
@@ -139,6 +149,13 @@ export interface RecurringInvoicesApiCreateRecurringInvoiceRequest {
139
149
  * @memberof RecurringInvoicesApiCreateRecurringInvoice
140
150
  */
141
151
  readonly authorization?: string
152
+
153
+ /**
154
+ * Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
155
+ * @type {string}
156
+ * @memberof RecurringInvoicesApiCreateRecurringInvoice
157
+ */
158
+ readonly idempotencyKey?: string
142
159
  }
143
160
 
144
161
  /**
@@ -149,13 +166,14 @@ export interface RecurringInvoicesApiCreateRecurringInvoiceRequest {
149
166
  */
150
167
  export class RecurringInvoicesApi extends BaseAPI {
151
168
  /**
152
- *
169
+ * This will create recurring invoice. It will be generated on a cyclical basis during the lifetime of a policy.
170
+ * @summary Create the recurring invoice
153
171
  * @param {RecurringInvoicesApiCreateRecurringInvoiceRequest} requestParameters Request parameters.
154
172
  * @param {*} [options] Override http request option.
155
173
  * @throws {RequiredError}
156
174
  * @memberof RecurringInvoicesApi
157
175
  */
158
176
  public createRecurringInvoice(requestParameters: RecurringInvoicesApiCreateRecurringInvoiceRequest, options?: AxiosRequestConfig) {
159
- return RecurringInvoicesApiFp(this.configuration).createRecurringInvoice(requestParameters.createInvoiceRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
177
+ return RecurringInvoicesApiFp(this.configuration).createRecurringInvoice(requestParameters.createInvoiceRequestDto, requestParameters.authorization, requestParameters.idempotencyKey, options).then((request) => request(this.axios, this.basePath));
160
178
  }
161
179
  }
package/api.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  * The EMIL BillingService API description
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
- *
8
+ * Contact: kontakt@emil.de
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -33,8 +33,3 @@ export * from './api/initial-invoices-api';
33
33
  export * from './api/invoices-api';
34
34
  export * from './api/recurring-invoices-api';
35
35
 
36
-
37
- export enum Environment {
38
- Production = 'https://apiv2.emil.de',
39
- Test = 'https://apiv2-test.emil.de',
40
- }
package/base.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  * The EMIL BillingService API description
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
- *
8
+ * Contact: kontakt@emil.de
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -40,6 +40,7 @@ export interface LoginClass {
40
40
  export enum Environment {
41
41
  Production = 'https://apiv2.emil.de',
42
42
  Test = 'https://apiv2-test.emil.de',
43
+ Development = 'https://apiv2-dev.emil.de',
43
44
  }
44
45
 
45
46
  let _retry_count = 0
@@ -128,7 +129,7 @@ export class BaseAPI {
128
129
  });
129
130
  }
130
131
 
131
- async refreshToken(): Promise<string> {
132
+ async refreshTokenInternal(): Promise<string> {
132
133
  const { username } = this.configuration;
133
134
 
134
135
  if (!username) {
@@ -179,7 +180,7 @@ export class BaseAPI {
179
180
  && !originalConfig._retry) {
180
181
  originalConfig._retry = true;
181
182
  try {
182
- let tokenString = await this.refreshToken();
183
+ let tokenString = await this.refreshTokenInternal();
183
184
  const accessToken = `Bearer ${tokenString}`;
184
185
 
185
186
  delete originalConfig.headers['Authorization']
@@ -205,7 +206,7 @@ export class BaseAPI {
205
206
  ) {
206
207
  _retry_count++;
207
208
  try {
208
- let tokenString = await this.refreshToken();
209
+ let tokenString = await this.refreshTokenInternal();
209
210
  const accessToken = `Bearer ${tokenString}`;
210
211
 
211
212
  _retry = true;
package/common.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  * The EMIL BillingService API description
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
- *
8
+ * Contact: kontakt@emil.de
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -143,7 +143,7 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi
143
143
  * The EMIL BillingService API description
144
144
  *
145
145
  * The version of the OpenAPI document: 1.0
146
- *
146
+ * Contact: kontakt@emil.de
147
147
  *
148
148
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
149
149
  * https://openapi-generator.tech
package/configuration.ts CHANGED
@@ -5,7 +5,7 @@
5
5
  * The EMIL BillingService API description
6
6
  *
7
7
  * The version of the OpenAPI document: 1.0
8
- *
8
+ * Contact: kontakt@emil.de
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
@@ -3,7 +3,7 @@
3
3
  * The EMIL BillingService API description
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0
6
- *
6
+ * Contact: kontakt@emil.de
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
@@ -20,13 +20,15 @@ import { CreateInvoiceRequestDto } from '../models';
20
20
  */
21
21
  export declare const CorrectionInvoicesApiAxiosParamCreator: (configuration?: Configuration) => {
22
22
  /**
23
- *
23
+ * 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.
24
+ * @summary Create the correction invoice
24
25
  * @param {CreateInvoiceRequestDto} createInvoiceRequestDto
25
26
  * @param {string} [authorization] Bearer Token
27
+ * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
26
28
  * @param {*} [options] Override http request option.
27
29
  * @throws {RequiredError}
28
30
  */
29
- createCorrectionInvoice: (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
+ createCorrectionInvoice: (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
30
32
  };
31
33
  /**
32
34
  * CorrectionInvoicesApi - functional programming interface
@@ -34,13 +36,15 @@ export declare const CorrectionInvoicesApiAxiosParamCreator: (configuration?: Co
34
36
  */
35
37
  export declare const CorrectionInvoicesApiFp: (configuration?: Configuration) => {
36
38
  /**
37
- *
39
+ * 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.
40
+ * @summary Create the correction invoice
38
41
  * @param {CreateInvoiceRequestDto} createInvoiceRequestDto
39
42
  * @param {string} [authorization] Bearer Token
43
+ * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
40
44
  * @param {*} [options] Override http request option.
41
45
  * @throws {RequiredError}
42
46
  */
43
- createCorrectionInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCorrectionInvoicesResponseClass>>;
47
+ createCorrectionInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCorrectionInvoicesResponseClass>>;
44
48
  };
45
49
  /**
46
50
  * CorrectionInvoicesApi - factory interface
@@ -48,13 +52,15 @@ export declare const CorrectionInvoicesApiFp: (configuration?: Configuration) =>
48
52
  */
49
53
  export declare const CorrectionInvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
50
54
  /**
51
- *
55
+ * 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.
56
+ * @summary Create the correction invoice
52
57
  * @param {CreateInvoiceRequestDto} createInvoiceRequestDto
53
58
  * @param {string} [authorization] Bearer Token
59
+ * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
54
60
  * @param {*} [options] Override http request option.
55
61
  * @throws {RequiredError}
56
62
  */
57
- createCorrectionInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCorrectionInvoicesResponseClass>;
63
+ createCorrectionInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: any): AxiosPromise<CreateCorrectionInvoicesResponseClass>;
58
64
  };
59
65
  /**
60
66
  * Request parameters for createCorrectionInvoice operation in CorrectionInvoicesApi.
@@ -74,6 +80,12 @@ export interface CorrectionInvoicesApiCreateCorrectionInvoiceRequest {
74
80
  * @memberof CorrectionInvoicesApiCreateCorrectionInvoice
75
81
  */
76
82
  readonly authorization?: string;
83
+ /**
84
+ * Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
85
+ * @type {string}
86
+ * @memberof CorrectionInvoicesApiCreateCorrectionInvoice
87
+ */
88
+ readonly idempotencyKey?: string;
77
89
  }
78
90
  /**
79
91
  * CorrectionInvoicesApi - object-oriented interface
@@ -83,7 +95,8 @@ export interface CorrectionInvoicesApiCreateCorrectionInvoiceRequest {
83
95
  */
84
96
  export declare class CorrectionInvoicesApi extends BaseAPI {
85
97
  /**
86
- *
98
+ * 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.
99
+ * @summary Create the correction invoice
87
100
  * @param {CorrectionInvoicesApiCreateCorrectionInvoiceRequest} requestParameters Request parameters.
88
101
  * @param {*} [options] Override http request option.
89
102
  * @throws {RequiredError}