@emilgroup/billing-sdk-node 1.57.1-beta.8 → 1.57.1-beta.9
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 +2 -2
- package/api/invoices-api.ts +24 -24
- package/api/policy-billing-api.ts +12 -12
- package/dist/api/invoices-api.d.ts +24 -24
- package/dist/api/invoices-api.js +20 -20
- package/dist/api/policy-billing-api.d.ts +12 -12
- package/dist/api/policy-billing-api.js +10 -10
- package/package.json +1 -1
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.57.1-beta.
|
|
20
|
+
npm install @emilgroup/billing-sdk-node@1.57.1-beta.9 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/billing-sdk-node@1.57.1-beta.
|
|
24
|
+
yarn add @emilgroup/billing-sdk-node@1.57.1-beta.9
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `InvoicesApi`.
|
package/api/invoices-api.ts
CHANGED
|
@@ -145,16 +145,16 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
145
145
|
};
|
|
146
146
|
},
|
|
147
147
|
/**
|
|
148
|
-
* Returns a list of invoices you have previously created.
|
|
148
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
149
149
|
* @summary List invoices
|
|
150
150
|
* @param {string} [authorization] Bearer Token
|
|
151
151
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
152
152
|
* @param {string} [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.
|
|
153
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
153
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
154
154
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
155
155
|
* @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, paymentMethodType, paymentMethodPsp</i>
|
|
156
156
|
* @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, invoiceItems<i>
|
|
157
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
157
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
159
159
|
* @throws {RequiredError}
|
|
160
160
|
*/
|
|
@@ -221,16 +221,16 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
221
221
|
};
|
|
222
222
|
},
|
|
223
223
|
/**
|
|
224
|
-
* Returns a list of policies billing dates you have previously created.
|
|
224
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
225
225
|
* @summary List policies billing dates
|
|
226
226
|
* @param {string} [authorization] Bearer Token
|
|
227
227
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
228
228
|
* @param {string} [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.
|
|
229
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
229
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
230
230
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
231
231
|
* @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>
|
|
232
232
|
* @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/>
|
|
233
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
233
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
234
234
|
* @param {*} [options] Override http request option.
|
|
235
235
|
* @deprecated
|
|
236
236
|
* @throws {RequiredError}
|
|
@@ -334,16 +334,16 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
|
|
|
334
334
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
335
335
|
},
|
|
336
336
|
/**
|
|
337
|
-
* Returns a list of invoices you have previously created.
|
|
337
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
338
338
|
* @summary List invoices
|
|
339
339
|
* @param {string} [authorization] Bearer Token
|
|
340
340
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
341
341
|
* @param {string} [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.
|
|
342
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
342
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
343
343
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
344
344
|
* @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, paymentMethodType, paymentMethodPsp</i>
|
|
345
345
|
* @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, invoiceItems<i>
|
|
346
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
346
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
347
347
|
* @param {*} [options] Override http request option.
|
|
348
348
|
* @throws {RequiredError}
|
|
349
349
|
*/
|
|
@@ -352,16 +352,16 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
|
|
|
352
352
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
353
353
|
},
|
|
354
354
|
/**
|
|
355
|
-
* Returns a list of policies billing dates you have previously created.
|
|
355
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
356
356
|
* @summary List policies billing dates
|
|
357
357
|
* @param {string} [authorization] Bearer Token
|
|
358
358
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
359
359
|
* @param {string} [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.
|
|
360
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
360
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
361
361
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
362
362
|
* @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>
|
|
363
363
|
* @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/>
|
|
364
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
364
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
365
365
|
* @param {*} [options] Override http request option.
|
|
366
366
|
* @deprecated
|
|
367
367
|
* @throws {RequiredError}
|
|
@@ -405,16 +405,16 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
|
|
|
405
405
|
return localVarFp.getInvoice(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
406
406
|
},
|
|
407
407
|
/**
|
|
408
|
-
* Returns a list of invoices you have previously created.
|
|
408
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
409
409
|
* @summary List invoices
|
|
410
410
|
* @param {string} [authorization] Bearer Token
|
|
411
411
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
412
412
|
* @param {string} [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.
|
|
413
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
413
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
414
414
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
415
415
|
* @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, paymentMethodType, paymentMethodPsp</i>
|
|
416
416
|
* @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, invoiceItems<i>
|
|
417
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
417
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
418
418
|
* @param {*} [options] Override http request option.
|
|
419
419
|
* @throws {RequiredError}
|
|
420
420
|
*/
|
|
@@ -422,16 +422,16 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
|
|
|
422
422
|
return localVarFp.listInvoices(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
423
423
|
},
|
|
424
424
|
/**
|
|
425
|
-
* Returns a list of policies billing dates you have previously created.
|
|
425
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
426
426
|
* @summary List policies billing dates
|
|
427
427
|
* @param {string} [authorization] Bearer Token
|
|
428
428
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
429
429
|
* @param {string} [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.
|
|
430
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
430
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
431
431
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
432
432
|
* @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>
|
|
433
433
|
* @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/>
|
|
434
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
434
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
435
435
|
* @param {*} [options] Override http request option.
|
|
436
436
|
* @deprecated
|
|
437
437
|
* @throws {RequiredError}
|
|
@@ -526,7 +526,7 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
526
526
|
readonly pageToken?: string
|
|
527
527
|
|
|
528
528
|
/**
|
|
529
|
-
* Filter the response by one or multiple fields.
|
|
529
|
+
* 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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
530
530
|
* @type {string}
|
|
531
531
|
* @memberof InvoicesApiListInvoices
|
|
532
532
|
*/
|
|
@@ -554,7 +554,7 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
554
554
|
readonly expand?: string
|
|
555
555
|
|
|
556
556
|
/**
|
|
557
|
-
* Filters the response by one or multiple fields.
|
|
557
|
+
* 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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
558
558
|
* @type {string}
|
|
559
559
|
* @memberof InvoicesApiListInvoices
|
|
560
560
|
*/
|
|
@@ -589,7 +589,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
589
589
|
readonly pageToken?: string
|
|
590
590
|
|
|
591
591
|
/**
|
|
592
|
-
* Filter the response by one or multiple fields.
|
|
592
|
+
* 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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
593
593
|
* @type {string}
|
|
594
594
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
595
595
|
*/
|
|
@@ -617,7 +617,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
617
617
|
readonly expand?: string
|
|
618
618
|
|
|
619
619
|
/**
|
|
620
|
-
* Filters the response by one or multiple fields.
|
|
620
|
+
* 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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
621
621
|
* @type {string}
|
|
622
622
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
623
623
|
*/
|
|
@@ -656,7 +656,7 @@ export class InvoicesApi extends BaseAPI {
|
|
|
656
656
|
}
|
|
657
657
|
|
|
658
658
|
/**
|
|
659
|
-
* Returns a list of invoices you have previously created.
|
|
659
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
660
660
|
* @summary List invoices
|
|
661
661
|
* @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
|
|
662
662
|
* @param {*} [options] Override http request option.
|
|
@@ -668,7 +668,7 @@ export class InvoicesApi extends BaseAPI {
|
|
|
668
668
|
}
|
|
669
669
|
|
|
670
670
|
/**
|
|
671
|
-
* Returns a list of policies billing dates you have previously created.
|
|
671
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
672
672
|
* @summary List policies billing dates
|
|
673
673
|
* @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
|
|
674
674
|
* @param {*} [options] Override http request option.
|
|
@@ -86,16 +86,16 @@ export const PolicyBillingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
86
86
|
};
|
|
87
87
|
},
|
|
88
88
|
/**
|
|
89
|
-
* Returns a list of policies billings you have previously created.
|
|
89
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
90
90
|
* @summary List policies billings
|
|
91
91
|
* @param {string} [authorization] Bearer Token
|
|
92
92
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
93
93
|
* @param {string} [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.
|
|
94
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
94
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
95
95
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
96
96
|
* @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>
|
|
97
97
|
* @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/>
|
|
98
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
98
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
99
99
|
* @param {*} [options] Override http request option.
|
|
100
100
|
* @throws {RequiredError}
|
|
101
101
|
*/
|
|
@@ -235,16 +235,16 @@ export const PolicyBillingApiFp = function(configuration?: Configuration) {
|
|
|
235
235
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
236
236
|
},
|
|
237
237
|
/**
|
|
238
|
-
* Returns a list of policies billings you have previously created.
|
|
238
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
239
239
|
* @summary List policies billings
|
|
240
240
|
* @param {string} [authorization] Bearer Token
|
|
241
241
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
242
242
|
* @param {string} [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.
|
|
243
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
243
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
244
244
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
245
245
|
* @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>
|
|
246
246
|
* @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/>
|
|
247
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
247
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
248
248
|
* @param {*} [options] Override http request option.
|
|
249
249
|
* @throws {RequiredError}
|
|
250
250
|
*/
|
|
@@ -287,16 +287,16 @@ export const PolicyBillingApiFactory = function (configuration?: Configuration,
|
|
|
287
287
|
return localVarFp.createPolicyBilling(createPolicyBillingRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
288
288
|
},
|
|
289
289
|
/**
|
|
290
|
-
* Returns a list of policies billings you have previously created.
|
|
290
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
291
291
|
* @summary List policies billings
|
|
292
292
|
* @param {string} [authorization] Bearer Token
|
|
293
293
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
294
294
|
* @param {string} [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.
|
|
295
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
295
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
296
296
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
297
297
|
* @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>
|
|
298
298
|
* @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/>
|
|
299
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
299
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
300
300
|
* @param {*} [options] Override http request option.
|
|
301
301
|
* @throws {RequiredError}
|
|
302
302
|
*/
|
|
@@ -367,7 +367,7 @@ export interface PolicyBillingApiListPoliciesBillingsRequest {
|
|
|
367
367
|
readonly pageToken?: string
|
|
368
368
|
|
|
369
369
|
/**
|
|
370
|
-
* Filter the response by one or multiple fields.
|
|
370
|
+
* 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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
371
371
|
* @type {string}
|
|
372
372
|
* @memberof PolicyBillingApiListPoliciesBillings
|
|
373
373
|
*/
|
|
@@ -395,7 +395,7 @@ export interface PolicyBillingApiListPoliciesBillingsRequest {
|
|
|
395
395
|
readonly expand?: string
|
|
396
396
|
|
|
397
397
|
/**
|
|
398
|
-
* Filters the response by one or multiple fields.
|
|
398
|
+
* 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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
399
399
|
* @type {string}
|
|
400
400
|
* @memberof PolicyBillingApiListPoliciesBillings
|
|
401
401
|
*/
|
|
@@ -450,7 +450,7 @@ export class PolicyBillingApi extends BaseAPI {
|
|
|
450
450
|
}
|
|
451
451
|
|
|
452
452
|
/**
|
|
453
|
-
* Returns a list of policies billings you have previously created.
|
|
453
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
454
454
|
* @summary List policies billings
|
|
455
455
|
* @param {PolicyBillingApiListPoliciesBillingsRequest} requestParameters Request parameters.
|
|
456
456
|
* @param {*} [options] Override http request option.
|
|
@@ -43,31 +43,31 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
43
43
|
*/
|
|
44
44
|
getInvoice: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
45
|
/**
|
|
46
|
-
* Returns a list of invoices you have previously created.
|
|
46
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
47
47
|
* @summary List invoices
|
|
48
48
|
* @param {string} [authorization] Bearer Token
|
|
49
49
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
50
50
|
* @param {string} [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.
|
|
51
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
52
52
|
* @param {string} [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: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id, paymentMethodType, paymentMethodPsp</i>
|
|
54
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: statuses, payments, invoiceItems<i>
|
|
55
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
56
56
|
* @param {*} [options] Override http request option.
|
|
57
57
|
* @throws {RequiredError}
|
|
58
58
|
*/
|
|
59
59
|
listInvoices: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
60
|
/**
|
|
61
|
-
* Returns a list of policies billing dates you have previously created.
|
|
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. **Required Permissions** \"billing-management.invoices.view\"
|
|
62
62
|
* @summary List policies billing dates
|
|
63
63
|
* @param {string} [authorization] Bearer Token
|
|
64
64
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
65
65
|
* @param {string} [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.
|
|
66
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
66
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
67
67
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
68
68
|
* @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>
|
|
69
69
|
* @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/>
|
|
70
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
70
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
71
71
|
* @param {*} [options] Override http request option.
|
|
72
72
|
* @deprecated
|
|
73
73
|
* @throws {RequiredError}
|
|
@@ -100,31 +100,31 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
100
100
|
*/
|
|
101
101
|
getInvoice(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInvoiceResponseClass>>;
|
|
102
102
|
/**
|
|
103
|
-
* Returns a list of invoices you have previously created.
|
|
103
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
104
104
|
* @summary List invoices
|
|
105
105
|
* @param {string} [authorization] Bearer Token
|
|
106
106
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
107
107
|
* @param {string} [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.
|
|
108
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
108
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
109
109
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
110
110
|
* @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, paymentMethodType, paymentMethodPsp</i>
|
|
111
111
|
* @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, invoiceItems<i>
|
|
112
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
112
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
113
113
|
* @param {*} [options] Override http request option.
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
116
116
|
listInvoices(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvoicesResponseClass>>;
|
|
117
117
|
/**
|
|
118
|
-
* Returns a list of policies billing dates you have previously created.
|
|
118
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
119
119
|
* @summary List policies billing dates
|
|
120
120
|
* @param {string} [authorization] Bearer Token
|
|
121
121
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
122
122
|
* @param {string} [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.
|
|
123
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
123
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
124
124
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
125
125
|
* @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>
|
|
126
126
|
* @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/>
|
|
127
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
127
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
128
128
|
* @param {*} [options] Override http request option.
|
|
129
129
|
* @deprecated
|
|
130
130
|
* @throws {RequiredError}
|
|
@@ -157,31 +157,31 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
157
157
|
*/
|
|
158
158
|
getInvoice(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetInvoiceResponseClass>;
|
|
159
159
|
/**
|
|
160
|
-
* Returns a list of invoices you have previously created.
|
|
160
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
161
161
|
* @summary List invoices
|
|
162
162
|
* @param {string} [authorization] Bearer Token
|
|
163
163
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
164
164
|
* @param {string} [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.
|
|
165
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
165
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
166
166
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
167
167
|
* @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, paymentMethodType, paymentMethodPsp</i>
|
|
168
168
|
* @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, invoiceItems<i>
|
|
169
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
169
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
170
170
|
* @param {*} [options] Override http request option.
|
|
171
171
|
* @throws {RequiredError}
|
|
172
172
|
*/
|
|
173
173
|
listInvoices(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListInvoicesResponseClass>;
|
|
174
174
|
/**
|
|
175
|
-
* Returns a list of policies billing dates you have previously created.
|
|
175
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
176
176
|
* @summary List policies billing dates
|
|
177
177
|
* @param {string} [authorization] Bearer Token
|
|
178
178
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
179
179
|
* @param {string} [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.
|
|
180
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
180
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
181
181
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
182
182
|
* @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>
|
|
183
183
|
* @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/>
|
|
184
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
184
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
185
185
|
* @param {*} [options] Override http request option.
|
|
186
186
|
* @deprecated
|
|
187
187
|
* @throws {RequiredError}
|
|
@@ -263,7 +263,7 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
263
263
|
*/
|
|
264
264
|
readonly pageToken?: string;
|
|
265
265
|
/**
|
|
266
|
-
* Filter the response by one or multiple fields.
|
|
266
|
+
* 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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
267
267
|
* @type {string}
|
|
268
268
|
* @memberof InvoicesApiListInvoices
|
|
269
269
|
*/
|
|
@@ -287,7 +287,7 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
287
287
|
*/
|
|
288
288
|
readonly expand?: string;
|
|
289
289
|
/**
|
|
290
|
-
* Filters the response by one or multiple fields.
|
|
290
|
+
* 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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
291
291
|
* @type {string}
|
|
292
292
|
* @memberof InvoicesApiListInvoices
|
|
293
293
|
*/
|
|
@@ -318,7 +318,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
318
318
|
*/
|
|
319
319
|
readonly pageToken?: string;
|
|
320
320
|
/**
|
|
321
|
-
* Filter the response by one or multiple fields.
|
|
321
|
+
* 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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
322
322
|
* @type {string}
|
|
323
323
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
324
324
|
*/
|
|
@@ -342,7 +342,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
342
342
|
*/
|
|
343
343
|
readonly expand?: string;
|
|
344
344
|
/**
|
|
345
|
-
* Filters the response by one or multiple fields.
|
|
345
|
+
* 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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
346
346
|
* @type {string}
|
|
347
347
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
348
348
|
*/
|
|
@@ -374,7 +374,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
374
374
|
*/
|
|
375
375
|
getInvoice(requestParameters: InvoicesApiGetInvoiceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetInvoiceResponseClass, any, {}>>;
|
|
376
376
|
/**
|
|
377
|
-
* Returns a list of invoices you have previously created.
|
|
377
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
378
378
|
* @summary List invoices
|
|
379
379
|
* @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
|
|
380
380
|
* @param {*} [options] Override http request option.
|
|
@@ -383,7 +383,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
383
383
|
*/
|
|
384
384
|
listInvoices(requestParameters?: InvoicesApiListInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInvoicesResponseClass, any, {}>>;
|
|
385
385
|
/**
|
|
386
|
-
* Returns a list of policies billing dates you have previously created.
|
|
386
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
387
387
|
* @summary List policies billing dates
|
|
388
388
|
* @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
|
|
389
389
|
* @param {*} [options] Override http request option.
|
package/dist/api/invoices-api.js
CHANGED
|
@@ -204,16 +204,16 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
204
204
|
});
|
|
205
205
|
},
|
|
206
206
|
/**
|
|
207
|
-
* Returns a list of invoices you have previously created.
|
|
207
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
208
208
|
* @summary List invoices
|
|
209
209
|
* @param {string} [authorization] Bearer Token
|
|
210
210
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
211
211
|
* @param {string} [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.
|
|
212
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
212
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
213
213
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
214
214
|
* @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, paymentMethodType, paymentMethodPsp</i>
|
|
215
215
|
* @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, invoiceItems<i>
|
|
216
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
216
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
217
217
|
* @param {*} [options] Override http request option.
|
|
218
218
|
* @throws {RequiredError}
|
|
219
219
|
*/
|
|
@@ -276,16 +276,16 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
276
276
|
});
|
|
277
277
|
},
|
|
278
278
|
/**
|
|
279
|
-
* Returns a list of policies billing dates you have previously created.
|
|
279
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
280
280
|
* @summary List policies billing dates
|
|
281
281
|
* @param {string} [authorization] Bearer Token
|
|
282
282
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
283
283
|
* @param {string} [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.
|
|
284
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
285
285
|
* @param {string} [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
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/>
|
|
288
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
289
289
|
* @param {*} [options] Override http request option.
|
|
290
290
|
* @deprecated
|
|
291
291
|
* @throws {RequiredError}
|
|
@@ -403,16 +403,16 @@ var InvoicesApiFp = function (configuration) {
|
|
|
403
403
|
});
|
|
404
404
|
},
|
|
405
405
|
/**
|
|
406
|
-
* Returns a list of invoices you have previously created.
|
|
406
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
407
407
|
* @summary List invoices
|
|
408
408
|
* @param {string} [authorization] Bearer Token
|
|
409
409
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
410
410
|
* @param {string} [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.
|
|
411
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
412
412
|
* @param {string} [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, paymentMethodType, paymentMethodPsp</i>
|
|
414
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, invoiceItems<i>
|
|
415
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
416
416
|
* @param {*} [options] Override http request option.
|
|
417
417
|
* @throws {RequiredError}
|
|
418
418
|
*/
|
|
@@ -430,16 +430,16 @@ var InvoicesApiFp = function (configuration) {
|
|
|
430
430
|
});
|
|
431
431
|
},
|
|
432
432
|
/**
|
|
433
|
-
* Returns a list of policies billing dates you have previously created.
|
|
433
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
434
434
|
* @summary List policies billing dates
|
|
435
435
|
* @param {string} [authorization] Bearer Token
|
|
436
436
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
437
437
|
* @param {string} [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.
|
|
438
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
438
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
439
439
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
440
440
|
* @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>
|
|
441
441
|
* @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/>
|
|
442
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
442
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
443
443
|
* @param {*} [options] Override http request option.
|
|
444
444
|
* @deprecated
|
|
445
445
|
* @throws {RequiredError}
|
|
@@ -492,16 +492,16 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
492
492
|
return localVarFp.getInvoice(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
493
493
|
},
|
|
494
494
|
/**
|
|
495
|
-
* Returns a list of invoices you have previously created.
|
|
495
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
496
496
|
* @summary List invoices
|
|
497
497
|
* @param {string} [authorization] Bearer Token
|
|
498
498
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
499
499
|
* @param {string} [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.
|
|
500
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
500
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
501
501
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
502
502
|
* @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, paymentMethodType, paymentMethodPsp</i>
|
|
503
503
|
* @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, invoiceItems<i>
|
|
504
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
504
|
+
* @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, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt, dueDate, paymentMethodType, paymentMethodPsp</i>
|
|
505
505
|
* @param {*} [options] Override http request option.
|
|
506
506
|
* @throws {RequiredError}
|
|
507
507
|
*/
|
|
@@ -509,16 +509,16 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
509
509
|
return localVarFp.listInvoices(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
510
510
|
},
|
|
511
511
|
/**
|
|
512
|
-
* Returns a list of policies billing dates you have previously created.
|
|
512
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
513
513
|
* @summary List policies billing dates
|
|
514
514
|
* @param {string} [authorization] Bearer Token
|
|
515
515
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
516
516
|
* @param {string} [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.
|
|
517
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
517
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
518
518
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
519
519
|
* @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>
|
|
520
520
|
* @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/>
|
|
521
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
521
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
522
522
|
* @param {*} [options] Override http request option.
|
|
523
523
|
* @deprecated
|
|
524
524
|
* @throws {RequiredError}
|
|
@@ -565,7 +565,7 @@ var InvoicesApi = /** @class */ (function (_super) {
|
|
|
565
565
|
return (0, exports.InvoicesApiFp)(this.configuration).getInvoice(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
566
566
|
};
|
|
567
567
|
/**
|
|
568
|
-
* Returns a list of invoices you have previously created.
|
|
568
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
569
569
|
* @summary List invoices
|
|
570
570
|
* @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
|
|
571
571
|
* @param {*} [options] Override http request option.
|
|
@@ -578,7 +578,7 @@ var InvoicesApi = /** @class */ (function (_super) {
|
|
|
578
578
|
return (0, exports.InvoicesApiFp)(this.configuration).listInvoices(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
579
579
|
};
|
|
580
580
|
/**
|
|
581
|
-
* Returns a list of policies billing dates you have previously created.
|
|
581
|
+
* 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. **Required Permissions** \"billing-management.invoices.view\"
|
|
582
582
|
* @summary List policies billing dates
|
|
583
583
|
* @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
|
|
584
584
|
* @param {*} [options] Override http request option.
|
|
@@ -31,16 +31,16 @@ export declare const PolicyBillingApiAxiosParamCreator: (configuration?: Configu
|
|
|
31
31
|
*/
|
|
32
32
|
createPolicyBilling: (createPolicyBillingRequestDto: CreatePolicyBillingRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
|
-
* Returns a list of policies billings you have previously created.
|
|
34
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
35
35
|
* @summary List policies billings
|
|
36
36
|
* @param {string} [authorization] Bearer Token
|
|
37
37
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
38
38
|
* @param {string} [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 {string} [filter] Filter the response by one or multiple fields.
|
|
39
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
40
40
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
41
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.<br/> <br/> <i>Allowed values: createdAt</i>
|
|
42
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.<br/> <br/>
|
|
43
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
43
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
44
44
|
* @param {*} [options] Override http request option.
|
|
45
45
|
* @throws {RequiredError}
|
|
46
46
|
*/
|
|
@@ -71,16 +71,16 @@ export declare const PolicyBillingApiFp: (configuration?: Configuration) => {
|
|
|
71
71
|
*/
|
|
72
72
|
createPolicyBilling(createPolicyBillingRequestDto: CreatePolicyBillingRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePolicyBillingResponseClass>>;
|
|
73
73
|
/**
|
|
74
|
-
* Returns a list of policies billings you have previously created.
|
|
74
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
75
75
|
* @summary List policies billings
|
|
76
76
|
* @param {string} [authorization] Bearer Token
|
|
77
77
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
78
78
|
* @param {string} [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.
|
|
79
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
79
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
80
80
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
81
81
|
* @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>
|
|
82
82
|
* @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/>
|
|
83
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
83
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
84
84
|
* @param {*} [options] Override http request option.
|
|
85
85
|
* @throws {RequiredError}
|
|
86
86
|
*/
|
|
@@ -111,16 +111,16 @@ export declare const PolicyBillingApiFactory: (configuration?: Configuration, ba
|
|
|
111
111
|
*/
|
|
112
112
|
createPolicyBilling(createPolicyBillingRequestDto: CreatePolicyBillingRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePolicyBillingResponseClass>;
|
|
113
113
|
/**
|
|
114
|
-
* Returns a list of policies billings you have previously created.
|
|
114
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
115
115
|
* @summary List policies billings
|
|
116
116
|
* @param {string} [authorization] Bearer Token
|
|
117
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
118
|
* @param {string} [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.
|
|
119
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
119
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
120
120
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
121
121
|
* @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>
|
|
122
122
|
* @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/>
|
|
123
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
123
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
@@ -180,7 +180,7 @@ export interface PolicyBillingApiListPoliciesBillingsRequest {
|
|
|
180
180
|
*/
|
|
181
181
|
readonly pageToken?: string;
|
|
182
182
|
/**
|
|
183
|
-
* Filter the response by one or multiple fields.
|
|
183
|
+
* 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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
184
184
|
* @type {string}
|
|
185
185
|
* @memberof PolicyBillingApiListPoliciesBillings
|
|
186
186
|
*/
|
|
@@ -204,7 +204,7 @@ export interface PolicyBillingApiListPoliciesBillingsRequest {
|
|
|
204
204
|
*/
|
|
205
205
|
readonly expand?: string;
|
|
206
206
|
/**
|
|
207
|
-
* Filters the response by one or multiple fields.
|
|
207
|
+
* 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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
208
208
|
* @type {string}
|
|
209
209
|
* @memberof PolicyBillingApiListPoliciesBillings
|
|
210
210
|
*/
|
|
@@ -252,7 +252,7 @@ export declare class PolicyBillingApi extends BaseAPI {
|
|
|
252
252
|
*/
|
|
253
253
|
createPolicyBilling(requestParameters: PolicyBillingApiCreatePolicyBillingRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyBillingResponseClass, any, {}>>;
|
|
254
254
|
/**
|
|
255
|
-
* Returns a list of policies billings you have previously created.
|
|
255
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
256
256
|
* @summary List policies billings
|
|
257
257
|
* @param {PolicyBillingApiListPoliciesBillingsRequest} requestParameters Request parameters.
|
|
258
258
|
* @param {*} [options] Override http request option.
|
|
@@ -146,16 +146,16 @@ var PolicyBillingApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
* Returns a list of policies billings you have previously created.
|
|
149
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
150
150
|
* @summary List policies billings
|
|
151
151
|
* @param {string} [authorization] Bearer Token
|
|
152
152
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
153
153
|
* @param {string} [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.
|
|
154
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
154
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
155
155
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
156
156
|
* @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>
|
|
157
157
|
* @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/>
|
|
158
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
158
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
159
159
|
* @param {*} [options] Override http request option.
|
|
160
160
|
* @throws {RequiredError}
|
|
161
161
|
*/
|
|
@@ -302,16 +302,16 @@ var PolicyBillingApiFp = function (configuration) {
|
|
|
302
302
|
});
|
|
303
303
|
},
|
|
304
304
|
/**
|
|
305
|
-
* Returns a list of policies billings you have previously created.
|
|
305
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
306
306
|
* @summary List policies billings
|
|
307
307
|
* @param {string} [authorization] Bearer Token
|
|
308
308
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
309
309
|
* @param {string} [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.
|
|
310
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
310
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
311
311
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
312
312
|
* @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>
|
|
313
313
|
* @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/>
|
|
314
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
314
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
315
315
|
* @param {*} [options] Override http request option.
|
|
316
316
|
* @throws {RequiredError}
|
|
317
317
|
*/
|
|
@@ -372,16 +372,16 @@ var PolicyBillingApiFactory = function (configuration, basePath, axios) {
|
|
|
372
372
|
return localVarFp.createPolicyBilling(createPolicyBillingRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
373
373
|
},
|
|
374
374
|
/**
|
|
375
|
-
* Returns a list of policies billings you have previously created.
|
|
375
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
376
376
|
* @summary List policies billings
|
|
377
377
|
* @param {string} [authorization] Bearer Token
|
|
378
378
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
379
379
|
* @param {string} [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.
|
|
380
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
380
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
381
381
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
382
382
|
* @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>
|
|
383
383
|
* @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/>
|
|
384
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
384
|
+
* @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, status, billingIntervalFrom, billingIntervalTo</i>
|
|
385
385
|
* @param {*} [options] Override http request option.
|
|
386
386
|
* @throws {RequiredError}
|
|
387
387
|
*/
|
|
@@ -427,7 +427,7 @@ var PolicyBillingApi = /** @class */ (function (_super) {
|
|
|
427
427
|
return (0, exports.PolicyBillingApiFp)(this.configuration).createPolicyBilling(requestParameters.createPolicyBillingRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
428
428
|
};
|
|
429
429
|
/**
|
|
430
|
-
* Returns a list of policies billings you have previously created.
|
|
430
|
+
* Returns a list of policies billings you have previously created. The policies billings are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"billing-management.invoices.view\"
|
|
431
431
|
* @summary List policies billings
|
|
432
432
|
* @param {PolicyBillingApiListPoliciesBillingsRequest} requestParameters Request parameters.
|
|
433
433
|
* @param {*} [options] Override http request option.
|