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

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 (57) hide show
  1. package/.openapi-generator/FILES +4 -1
  2. package/README.md +2 -2
  3. package/api/draft-invoice-api.ts +346 -0
  4. package/api/estimated-invoices-api.ts +111 -4
  5. package/api/invoices-api.ts +108 -214
  6. package/api.ts +2 -0
  7. package/dist/api/draft-invoice-api.d.ts +185 -0
  8. package/dist/api/draft-invoice-api.js +396 -0
  9. package/dist/api/estimated-invoices-api.d.ts +61 -4
  10. package/dist/api/estimated-invoices-api.js +97 -4
  11. package/dist/api/invoices-api.d.ts +92 -149
  12. package/dist/api/invoices-api.js +70 -163
  13. package/dist/api.d.ts +1 -0
  14. package/dist/api.js +1 -0
  15. package/dist/models/create-draft-invoice-request-dto.d.ts +89 -0
  16. package/dist/models/create-draft-invoice-request-dto.js +26 -0
  17. package/dist/models/create-estimated-invoice-for-interval-request-dto.d.ts +49 -0
  18. package/dist/models/{create-invoice-payment-response-class.d.ts → create-estimated-invoice-for-interval-response-class.d.ts} +7 -7
  19. package/dist/models/create-estimated-invoice-for-interval-response-class.js +15 -0
  20. package/dist/models/create-invoice-payment-request-dto.d.ts +6 -0
  21. package/dist/models/create-invoice-request-dto.d.ts +3 -3
  22. package/dist/models/create-invoice-status-request-dto.d.ts +1 -0
  23. package/dist/models/create-invoice-status-request-dto.js +2 -1
  24. package/dist/models/index.d.ts +3 -1
  25. package/dist/models/index.js +3 -1
  26. package/dist/models/inline-response200.d.ts +6 -6
  27. package/dist/models/inline-response503.d.ts +6 -6
  28. package/dist/models/invoice-class.d.ts +1 -0
  29. package/dist/models/invoice-class.js +2 -1
  30. package/dist/models/invoice-item-class.d.ts +12 -0
  31. package/dist/models/invoice-payment-class.d.ts +7 -7
  32. package/dist/models/invoice-status-class.d.ts +1 -0
  33. package/dist/models/invoice-status-class.js +2 -1
  34. package/dist/models/omit-type-class.d.ts +8 -0
  35. package/dist/models/omit-type-class.js +2 -1
  36. package/dist/models/policy-dto.d.ts +7 -1
  37. package/dist/models/policy-object-dto.d.ts +12 -12
  38. package/dist/models/policy-version-dto.d.ts +6 -0
  39. package/models/create-draft-invoice-request-dto.ts +98 -0
  40. package/models/create-estimated-invoice-for-interval-request-dto.ts +55 -0
  41. package/models/{create-invoice-payment-response-class.ts → create-estimated-invoice-for-interval-response-class.ts} +7 -7
  42. package/models/create-invoice-payment-request-dto.ts +6 -0
  43. package/models/create-invoice-request-dto.ts +3 -3
  44. package/models/create-invoice-status-request-dto.ts +2 -1
  45. package/models/index.ts +3 -1
  46. package/models/inline-response200.ts +6 -6
  47. package/models/inline-response503.ts +6 -6
  48. package/models/invoice-class.ts +2 -1
  49. package/models/invoice-item-class.ts +12 -0
  50. package/models/invoice-payment-class.ts +7 -7
  51. package/models/invoice-status-class.ts +2 -1
  52. package/models/omit-type-class.ts +9 -1
  53. package/models/policy-dto.ts +7 -1
  54. package/models/policy-object-dto.ts +12 -12
  55. package/models/policy-version-dto.ts +6 -0
  56. package/package.json +1 -1
  57. /package/dist/models/{create-invoice-payment-response-class.js → create-estimated-invoice-for-interval-request-dto.js} +0 -0
@@ -12,8 +12,6 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
- import { CreateInvoicePaymentRequestDto } from '../models';
16
- import { CreateInvoicePaymentResponseClass } from '../models';
17
15
  import { GetInvoiceResponseClass } from '../models';
18
16
  import { ListInvoicesResponseClass } from '../models';
19
17
  import { ListPoliciesBillingDatesResponseClass } from '../models';
@@ -23,19 +21,8 @@ import { ListPoliciesBillingDatesResponseClass } from '../models';
23
21
  */
24
22
  export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuration) => {
25
23
  /**
26
- * This will create an invoice payment.
27
- * @summary Create the invoice payment
28
- * @param {number} id
29
- * @param {CreateInvoicePaymentRequestDto} createInvoicePaymentRequestDto
30
- * @param {string} [authorization] Bearer Token
31
- * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
32
- * @param {*} [options] Override http request option.
33
- * @throws {RequiredError}
34
- */
35
- createInvoicePayment: (id: number, createInvoicePaymentRequestDto: CreateInvoicePaymentRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
- /**
37
- * 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.
38
- * @summary List invoices
24
+ * Gets an invoice.
25
+ * @summary Retrieve the invoice
39
26
  * @param {string} code
40
27
  * @param {string} expand
41
28
  * @param {string} [authorization] Bearer Token
@@ -44,33 +31,35 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
44
31
  */
45
32
  getInvoice: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
33
  /**
47
- * 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.
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.
48
35
  * @summary List invoices
49
36
  * @param {string} [authorization] Bearer Token
50
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
37
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
51
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
52
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
53
- * @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.
54
- * @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.
55
- * @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.
39
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt&lt;/i&gt;
40
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
41
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id&lt;/i&gt;
42
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: statuses, payments.&lt;i&gt;
43
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt&lt;/i&gt;
56
44
  * @param {*} [options] Override http request option.
57
45
  * @throws {RequiredError}
58
46
  */
59
- listInvoices: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47
+ listInvoices: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
60
48
  /**
61
- * 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.
49
+ * 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.
62
50
  * @summary List policies billing dates
63
51
  * @param {string} [authorization] Bearer Token
64
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
52
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
65
53
  * @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.
66
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
67
- * @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.
68
- * @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.
69
- * @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.
54
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo&lt;/i&gt;
55
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
56
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
57
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: .&lt;i&gt;
58
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo&lt;/i&gt;
70
59
  * @param {*} [options] Override http request option.
71
60
  * @throws {RequiredError}
72
61
  */
73
- listPoliciesBillingDates: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
+ listPoliciesBillingDates: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
63
  };
75
64
  /**
76
65
  * InvoicesApi - functional programming interface
@@ -78,19 +67,8 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
78
67
  */
79
68
  export declare const InvoicesApiFp: (configuration?: Configuration) => {
80
69
  /**
81
- * This will create an invoice payment.
82
- * @summary Create the invoice payment
83
- * @param {number} id
84
- * @param {CreateInvoicePaymentRequestDto} createInvoicePaymentRequestDto
85
- * @param {string} [authorization] Bearer Token
86
- * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
87
- * @param {*} [options] Override http request option.
88
- * @throws {RequiredError}
89
- */
90
- createInvoicePayment(id: number, createInvoicePaymentRequestDto: CreateInvoicePaymentRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInvoicePaymentResponseClass>>;
91
- /**
92
- * 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.
93
- * @summary List invoices
70
+ * Gets an invoice.
71
+ * @summary Retrieve the invoice
94
72
  * @param {string} code
95
73
  * @param {string} expand
96
74
  * @param {string} [authorization] Bearer Token
@@ -99,33 +77,35 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
99
77
  */
100
78
  getInvoice(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvoiceResponseClass>>;
101
79
  /**
102
- * 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.
80
+ * 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.
103
81
  * @summary List invoices
104
82
  * @param {string} [authorization] Bearer Token
105
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
83
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
106
84
  * @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.
107
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
108
- * @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.
109
- * @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.
110
- * @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.
85
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt&lt;/i&gt;
86
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
87
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id&lt;/i&gt;
88
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: statuses, payments.&lt;i&gt;
89
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt&lt;/i&gt;
111
90
  * @param {*} [options] Override http request option.
112
91
  * @throws {RequiredError}
113
92
  */
114
- listInvoices(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvoicesResponseClass>>;
93
+ listInvoices(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvoicesResponseClass>>;
115
94
  /**
116
- * 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.
95
+ * 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.
117
96
  * @summary List policies billing dates
118
97
  * @param {string} [authorization] Bearer Token
119
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
98
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
120
99
  * @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.
121
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
122
- * @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.
123
- * @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.
124
- * @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.
100
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo&lt;/i&gt;
101
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
102
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
103
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: .&lt;i&gt;
104
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo&lt;/i&gt;
125
105
  * @param {*} [options] Override http request option.
126
106
  * @throws {RequiredError}
127
107
  */
128
- listPoliciesBillingDates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesBillingDatesResponseClass>>;
108
+ listPoliciesBillingDates(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesBillingDatesResponseClass>>;
129
109
  };
130
110
  /**
131
111
  * InvoicesApi - factory interface
@@ -133,19 +113,8 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
133
113
  */
134
114
  export declare const InvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
135
115
  /**
136
- * This will create an invoice payment.
137
- * @summary Create the invoice payment
138
- * @param {number} id
139
- * @param {CreateInvoicePaymentRequestDto} createInvoicePaymentRequestDto
140
- * @param {string} [authorization] Bearer Token
141
- * @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
142
- * @param {*} [options] Override http request option.
143
- * @throws {RequiredError}
144
- */
145
- createInvoicePayment(id: number, createInvoicePaymentRequestDto: CreateInvoicePaymentRequestDto, authorization?: string, idempotencyKey?: string, options?: any): AxiosPromise<CreateInvoicePaymentResponseClass>;
146
- /**
147
- * 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.
148
- * @summary List invoices
116
+ * Gets an invoice.
117
+ * @summary Retrieve the invoice
149
118
  * @param {string} code
150
119
  * @param {string} expand
151
120
  * @param {string} [authorization] Bearer Token
@@ -154,65 +123,36 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
154
123
  */
155
124
  getInvoice(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetInvoiceResponseClass>;
156
125
  /**
157
- * 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.
126
+ * 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.
158
127
  * @summary List invoices
159
128
  * @param {string} [authorization] Bearer Token
160
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
129
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
161
130
  * @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.
162
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
163
- * @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.
164
- * @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.
165
- * @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.
131
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt&lt;/i&gt;
132
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
133
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id&lt;/i&gt;
134
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: statuses, payments.&lt;i&gt;
135
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt&lt;/i&gt;
166
136
  * @param {*} [options] Override http request option.
167
137
  * @throws {RequiredError}
168
138
  */
169
- listInvoices(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListInvoicesResponseClass>;
139
+ listInvoices(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListInvoicesResponseClass>;
170
140
  /**
171
- * 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.
141
+ * 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.
172
142
  * @summary List policies billing dates
173
143
  * @param {string} [authorization] Bearer Token
174
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
144
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
175
145
  * @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.
176
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
177
- * @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.
178
- * @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.
179
- * @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.
146
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo&lt;/i&gt;
147
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
148
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
149
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: .&lt;i&gt;
150
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo&lt;/i&gt;
180
151
  * @param {*} [options] Override http request option.
181
152
  * @throws {RequiredError}
182
153
  */
183
- listPoliciesBillingDates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListPoliciesBillingDatesResponseClass>;
154
+ listPoliciesBillingDates(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPoliciesBillingDatesResponseClass>;
184
155
  };
185
- /**
186
- * Request parameters for createInvoicePayment operation in InvoicesApi.
187
- * @export
188
- * @interface InvoicesApiCreateInvoicePaymentRequest
189
- */
190
- export interface InvoicesApiCreateInvoicePaymentRequest {
191
- /**
192
- *
193
- * @type {number}
194
- * @memberof InvoicesApiCreateInvoicePayment
195
- */
196
- readonly id: number;
197
- /**
198
- *
199
- * @type {CreateInvoicePaymentRequestDto}
200
- * @memberof InvoicesApiCreateInvoicePayment
201
- */
202
- readonly createInvoicePaymentRequestDto: CreateInvoicePaymentRequestDto;
203
- /**
204
- * Bearer Token
205
- * @type {string}
206
- * @memberof InvoicesApiCreateInvoicePayment
207
- */
208
- readonly authorization?: string;
209
- /**
210
- * Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
211
- * @type {string}
212
- * @memberof InvoicesApiCreateInvoicePayment
213
- */
214
- readonly idempotencyKey?: string;
215
- }
216
156
  /**
217
157
  * Request parameters for getInvoice operation in InvoicesApi.
218
158
  * @export
@@ -251,7 +191,7 @@ export interface InvoicesApiListInvoicesRequest {
251
191
  */
252
192
  readonly authorization?: string;
253
193
  /**
254
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
194
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
255
195
  * @type {any}
256
196
  * @memberof InvoicesApiListInvoices
257
197
  */
@@ -263,29 +203,35 @@ export interface InvoicesApiListInvoicesRequest {
263
203
  */
264
204
  readonly pageToken?: any;
265
205
  /**
266
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
267
- * @type {any}
206
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt&lt;/i&gt;
207
+ * @type {string}
268
208
  * @memberof InvoicesApiListInvoices
269
209
  */
270
- readonly filter?: any;
210
+ readonly filter?: string;
271
211
  /**
272
- * 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.
212
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
273
213
  * @type {any}
274
214
  * @memberof InvoicesApiListInvoices
275
215
  */
276
216
  readonly search?: any;
277
217
  /**
278
- * 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.
279
- * @type {any}
218
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id&lt;/i&gt;
219
+ * @type {string}
280
220
  * @memberof InvoicesApiListInvoices
281
221
  */
282
- readonly order?: any;
222
+ readonly order?: string;
283
223
  /**
284
- * 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.
285
- * @type {any}
224
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: statuses, payments.&lt;i&gt;
225
+ * @type {string}
226
+ * @memberof InvoicesApiListInvoices
227
+ */
228
+ readonly expand?: string;
229
+ /**
230
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt&lt;/i&gt;
231
+ * @type {string}
286
232
  * @memberof InvoicesApiListInvoices
287
233
  */
288
- readonly expand?: any;
234
+ readonly filters?: string;
289
235
  }
290
236
  /**
291
237
  * Request parameters for listPoliciesBillingDates operation in InvoicesApi.
@@ -300,7 +246,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
300
246
  */
301
247
  readonly authorization?: string;
302
248
  /**
303
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
249
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
304
250
  * @type {any}
305
251
  * @memberof InvoicesApiListPoliciesBillingDates
306
252
  */
@@ -312,29 +258,35 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
312
258
  */
313
259
  readonly pageToken?: any;
314
260
  /**
315
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
316
- * @type {any}
261
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo&lt;/i&gt;
262
+ * @type {string}
317
263
  * @memberof InvoicesApiListPoliciesBillingDates
318
264
  */
319
- readonly filter?: any;
265
+ readonly filter?: string;
320
266
  /**
321
- * 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.
267
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
322
268
  * @type {any}
323
269
  * @memberof InvoicesApiListPoliciesBillingDates
324
270
  */
325
271
  readonly search?: any;
326
272
  /**
327
- * 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.
328
- * @type {any}
273
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: createdAt&lt;/i&gt;
274
+ * @type {string}
329
275
  * @memberof InvoicesApiListPoliciesBillingDates
330
276
  */
331
- readonly order?: any;
277
+ readonly order?: string;
332
278
  /**
333
- * 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.
334
- * @type {any}
279
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: .&lt;i&gt;
280
+ * @type {string}
335
281
  * @memberof InvoicesApiListPoliciesBillingDates
336
282
  */
337
- readonly expand?: any;
283
+ readonly expand?: string;
284
+ /**
285
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo&lt;/i&gt;
286
+ * @type {string}
287
+ * @memberof InvoicesApiListPoliciesBillingDates
288
+ */
289
+ readonly filters?: string;
338
290
  }
339
291
  /**
340
292
  * InvoicesApi - object-oriented interface
@@ -344,17 +296,8 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
344
296
  */
345
297
  export declare class InvoicesApi extends BaseAPI {
346
298
  /**
347
- * This will create an invoice payment.
348
- * @summary Create the invoice payment
349
- * @param {InvoicesApiCreateInvoicePaymentRequest} requestParameters Request parameters.
350
- * @param {*} [options] Override http request option.
351
- * @throws {RequiredError}
352
- * @memberof InvoicesApi
353
- */
354
- createInvoicePayment(requestParameters: InvoicesApiCreateInvoicePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateInvoicePaymentResponseClass, any>>;
355
- /**
356
- * 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.
357
- * @summary List invoices
299
+ * Gets an invoice.
300
+ * @summary Retrieve the invoice
358
301
  * @param {InvoicesApiGetInvoiceRequest} requestParameters Request parameters.
359
302
  * @param {*} [options] Override http request option.
360
303
  * @throws {RequiredError}
@@ -362,7 +305,7 @@ export declare class InvoicesApi extends BaseAPI {
362
305
  */
363
306
  getInvoice(requestParameters: InvoicesApiGetInvoiceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInvoiceResponseClass, any>>;
364
307
  /**
365
- * 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.
308
+ * 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.
366
309
  * @summary List invoices
367
310
  * @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
368
311
  * @param {*} [options] Override http request option.
@@ -371,7 +314,7 @@ export declare class InvoicesApi extends BaseAPI {
371
314
  */
372
315
  listInvoices(requestParameters?: InvoicesApiListInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInvoicesResponseClass, any>>;
373
316
  /**
374
- * 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.
317
+ * 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.
375
318
  * @summary List policies billing dates
376
319
  * @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
377
320
  * @param {*} [options] Override http request option.