@emilgroup/billing-sdk-node 1.23.0 → 1.23.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/billing-sdk-node@1.23.
|
|
20
|
+
npm install @emilgroup/billing-sdk-node@1.23.1-beta.1 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/billing-sdk-node@1.23.
|
|
24
|
+
yarn add @emilgroup/billing-sdk-node@1.23.1-beta.1
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `InvoicesApi`.
|
package/api/invoices-api.ts
CHANGED
|
@@ -91,7 +91,7 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
91
91
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
92
92
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
93
93
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
|
|
94
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
94
|
+
* @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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
95
95
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
96
96
|
* @param {*} [options] Override http request option.
|
|
97
97
|
* @throws {RequiredError}
|
|
@@ -167,7 +167,7 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
167
167
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
168
168
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
169
169
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
170
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
170
|
+
* @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.<br/> <br/> <i>Allowed values: <i>
|
|
171
171
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
172
172
|
* @param {*} [options] Override http request option.
|
|
173
173
|
* @throws {RequiredError}
|
|
@@ -266,7 +266,7 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
|
|
|
266
266
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
267
267
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
268
268
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
|
|
269
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
269
|
+
* @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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
270
270
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
271
271
|
* @param {*} [options] Override http request option.
|
|
272
272
|
* @throws {RequiredError}
|
|
@@ -284,7 +284,7 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
|
|
|
284
284
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
285
285
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
286
286
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
287
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
287
|
+
* @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.<br/> <br/> <i>Allowed values: <i>
|
|
288
288
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
289
289
|
* @param {*} [options] Override http request option.
|
|
290
290
|
* @throws {RequiredError}
|
|
@@ -324,7 +324,7 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
|
|
|
324
324
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
325
325
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
326
326
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
|
|
327
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
327
|
+
* @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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
328
328
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
329
329
|
* @param {*} [options] Override http request option.
|
|
330
330
|
* @throws {RequiredError}
|
|
@@ -341,7 +341,7 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
|
|
|
341
341
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
342
342
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
343
343
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
344
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
344
|
+
* @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.<br/> <br/> <i>Allowed values: <i>
|
|
345
345
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
346
346
|
* @param {*} [options] Override http request option.
|
|
347
347
|
* @throws {RequiredError}
|
|
@@ -429,7 +429,7 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
429
429
|
readonly order?: string
|
|
430
430
|
|
|
431
431
|
/**
|
|
432
|
-
* Expand to fetch additional information about the list items.
|
|
432
|
+
* 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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
433
433
|
* @type {string}
|
|
434
434
|
* @memberof InvoicesApiListInvoices
|
|
435
435
|
*/
|
|
@@ -492,7 +492,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
492
492
|
readonly order?: string
|
|
493
493
|
|
|
494
494
|
/**
|
|
495
|
-
* Expand to fetch additional information about the list items.
|
|
495
|
+
* 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.<br/> <br/> <i>Allowed values: <i>
|
|
496
496
|
* @type {string}
|
|
497
497
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
498
498
|
*/
|
|
@@ -36,7 +36,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
36
36
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
37
37
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
38
38
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
|
|
39
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
39
|
+
* @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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
40
40
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
41
41
|
* @param {*} [options] Override http request option.
|
|
42
42
|
* @throws {RequiredError}
|
|
@@ -51,7 +51,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
51
51
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
52
52
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
53
53
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
54
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
54
|
+
* @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.<br/> <br/> <i>Allowed values: <i>
|
|
55
55
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
56
56
|
* @param {*} [options] Override http request option.
|
|
57
57
|
* @throws {RequiredError}
|
|
@@ -82,7 +82,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
82
82
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
83
83
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
84
84
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
|
|
85
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
85
|
+
* @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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
86
86
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
87
87
|
* @param {*} [options] Override http request option.
|
|
88
88
|
* @throws {RequiredError}
|
|
@@ -97,7 +97,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
97
97
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
98
98
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
99
99
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
100
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
100
|
+
* @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.<br/> <br/> <i>Allowed values: <i>
|
|
101
101
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
102
102
|
* @param {*} [options] Override http request option.
|
|
103
103
|
* @throws {RequiredError}
|
|
@@ -128,7 +128,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
128
128
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
129
129
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
130
130
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
|
|
131
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
131
|
+
* @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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
132
132
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
133
133
|
* @param {*} [options] Override http request option.
|
|
134
134
|
* @throws {RequiredError}
|
|
@@ -143,7 +143,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
143
143
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
144
144
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
145
145
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
146
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
146
|
+
* @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.<br/> <br/> <i>Allowed values: <i>
|
|
147
147
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
149
149
|
* @throws {RequiredError}
|
|
@@ -218,7 +218,7 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
218
218
|
*/
|
|
219
219
|
readonly order?: string;
|
|
220
220
|
/**
|
|
221
|
-
* Expand to fetch additional information about the list items.
|
|
221
|
+
* 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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
222
222
|
* @type {string}
|
|
223
223
|
* @memberof InvoicesApiListInvoices
|
|
224
224
|
*/
|
|
@@ -273,7 +273,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
273
273
|
*/
|
|
274
274
|
readonly order?: string;
|
|
275
275
|
/**
|
|
276
|
-
* Expand to fetch additional information about the list items.
|
|
276
|
+
* 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.<br/> <br/> <i>Allowed values: <i>
|
|
277
277
|
* @type {string}
|
|
278
278
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
279
279
|
*/
|
package/dist/api/invoices-api.js
CHANGED
|
@@ -159,7 +159,7 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
159
159
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
160
160
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
161
161
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
|
|
162
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
162
|
+
* @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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
163
163
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
164
164
|
* @param {*} [options] Override http request option.
|
|
165
165
|
* @throws {RequiredError}
|
|
@@ -231,7 +231,7 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
231
231
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
232
232
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
233
233
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
234
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
234
|
+
* @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.<br/> <br/> <i>Allowed values: <i>
|
|
235
235
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
236
236
|
* @param {*} [options] Override http request option.
|
|
237
237
|
* @throws {RequiredError}
|
|
@@ -335,7 +335,7 @@ var InvoicesApiFp = function (configuration) {
|
|
|
335
335
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
336
336
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
337
337
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
|
|
338
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
338
|
+
* @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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
339
339
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
340
340
|
* @param {*} [options] Override http request option.
|
|
341
341
|
* @throws {RequiredError}
|
|
@@ -362,7 +362,7 @@ var InvoicesApiFp = function (configuration) {
|
|
|
362
362
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
363
363
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
364
364
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
365
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
365
|
+
* @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.<br/> <br/> <i>Allowed values: <i>
|
|
366
366
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
367
367
|
* @param {*} [options] Override http request option.
|
|
368
368
|
* @throws {RequiredError}
|
|
@@ -411,7 +411,7 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
411
411
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
412
412
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
413
413
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
|
|
414
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
414
|
+
* @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.<br/> <br/> <i>Allowed values: statuses, payments<i>
|
|
415
415
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
416
416
|
* @param {*} [options] Override http request option.
|
|
417
417
|
* @throws {RequiredError}
|
|
@@ -428,7 +428,7 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
428
428
|
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
429
429
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
430
430
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
431
|
-
* @param {string} [expand] Expand to fetch additional information about the list items.
|
|
431
|
+
* @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.<br/> <br/> <i>Allowed values: <i>
|
|
432
432
|
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: policyCode, isInvoiced, nextBillingDate, accountNumber, status, billingIntervalFrom, billingIntervalTo</i>
|
|
433
433
|
* @param {*} [options] Override http request option.
|
|
434
434
|
* @throws {RequiredError}
|
|
@@ -51,4 +51,10 @@ export interface ListRequestDto {
|
|
|
51
51
|
* @memberof ListRequestDto
|
|
52
52
|
*/
|
|
53
53
|
'expand'?: string;
|
|
54
|
+
/**
|
|
55
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof ListRequestDto
|
|
58
|
+
*/
|
|
59
|
+
'filters'?: string;
|
|
54
60
|
}
|
|
@@ -56,5 +56,11 @@ export interface ListRequestDto {
|
|
|
56
56
|
* @memberof ListRequestDto
|
|
57
57
|
*/
|
|
58
58
|
'expand'?: string;
|
|
59
|
+
/**
|
|
60
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof ListRequestDto
|
|
63
|
+
*/
|
|
64
|
+
'filters'?: string;
|
|
59
65
|
}
|
|
60
66
|
|