@emilgroup/billing-sdk 1.56.1-beta.6 → 1.56.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@1.56.1-beta.
|
|
20
|
+
npm install @emilgroup/billing-sdk@1.56.1-beta.9 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/billing-sdk@1.56.1-beta.
|
|
24
|
+
yarn add @emilgroup/billing-sdk@1.56.1-beta.9
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `InvoicesApi`.
|
package/api/invoices-api.ts
CHANGED
|
@@ -141,16 +141,16 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
141
141
|
};
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
|
-
* Returns a list of invoices you have previously created.
|
|
144
|
+
* 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\"
|
|
145
145
|
* @summary List invoices
|
|
146
146
|
* @param {string} [authorization] Bearer Token
|
|
147
147
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
148
148
|
* @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.
|
|
149
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
149
|
+
* @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>
|
|
150
150
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
151
151
|
* @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>
|
|
152
152
|
* @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>
|
|
153
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
153
|
+
* @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>
|
|
154
154
|
* @param {*} [options] Override http request option.
|
|
155
155
|
* @throws {RequiredError}
|
|
156
156
|
*/
|
|
@@ -217,16 +217,16 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
217
217
|
};
|
|
218
218
|
},
|
|
219
219
|
/**
|
|
220
|
-
* Returns a list of policies billing dates you have previously created.
|
|
220
|
+
* 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\"
|
|
221
221
|
* @summary List policies billing dates
|
|
222
222
|
* @param {string} [authorization] Bearer Token
|
|
223
223
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
224
224
|
* @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.
|
|
225
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
225
|
+
* @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>
|
|
226
226
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
227
227
|
* @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>
|
|
228
228
|
* @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/>
|
|
229
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
229
|
+
* @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>
|
|
230
230
|
* @param {*} [options] Override http request option.
|
|
231
231
|
* @deprecated
|
|
232
232
|
* @throws {RequiredError}
|
|
@@ -330,16 +330,16 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
|
|
|
330
330
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
331
331
|
},
|
|
332
332
|
/**
|
|
333
|
-
* Returns a list of invoices you have previously created.
|
|
333
|
+
* 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\"
|
|
334
334
|
* @summary List invoices
|
|
335
335
|
* @param {string} [authorization] Bearer Token
|
|
336
336
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
337
337
|
* @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.
|
|
338
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
338
|
+
* @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>
|
|
339
339
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
340
340
|
* @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>
|
|
341
341
|
* @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>
|
|
342
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
342
|
+
* @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>
|
|
343
343
|
* @param {*} [options] Override http request option.
|
|
344
344
|
* @throws {RequiredError}
|
|
345
345
|
*/
|
|
@@ -348,16 +348,16 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
|
|
|
348
348
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
349
349
|
},
|
|
350
350
|
/**
|
|
351
|
-
* Returns a list of policies billing dates you have previously created.
|
|
351
|
+
* 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\"
|
|
352
352
|
* @summary List policies billing dates
|
|
353
353
|
* @param {string} [authorization] Bearer Token
|
|
354
354
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
355
355
|
* @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.
|
|
356
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
356
|
+
* @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>
|
|
357
357
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
358
358
|
* @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>
|
|
359
359
|
* @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/>
|
|
360
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
360
|
+
* @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>
|
|
361
361
|
* @param {*} [options] Override http request option.
|
|
362
362
|
* @deprecated
|
|
363
363
|
* @throws {RequiredError}
|
|
@@ -401,16 +401,16 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
|
|
|
401
401
|
return localVarFp.getInvoice(code, expand, authorization, options).then((request) => request(axios, basePath));
|
|
402
402
|
},
|
|
403
403
|
/**
|
|
404
|
-
* Returns a list of invoices you have previously created.
|
|
404
|
+
* 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\"
|
|
405
405
|
* @summary List invoices
|
|
406
406
|
* @param {string} [authorization] Bearer Token
|
|
407
407
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
408
408
|
* @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.
|
|
409
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
409
|
+
* @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>
|
|
410
410
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
411
411
|
* @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>
|
|
412
412
|
* @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>
|
|
413
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
413
|
+
* @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>
|
|
414
414
|
* @param {*} [options] Override http request option.
|
|
415
415
|
* @throws {RequiredError}
|
|
416
416
|
*/
|
|
@@ -418,16 +418,16 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
|
|
|
418
418
|
return localVarFp.listInvoices(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
419
419
|
},
|
|
420
420
|
/**
|
|
421
|
-
* Returns a list of policies billing dates you have previously created.
|
|
421
|
+
* 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\"
|
|
422
422
|
* @summary List policies billing dates
|
|
423
423
|
* @param {string} [authorization] Bearer Token
|
|
424
424
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
425
425
|
* @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.
|
|
426
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
426
|
+
* @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>
|
|
427
427
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
428
428
|
* @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>
|
|
429
429
|
* @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/>
|
|
430
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
430
|
+
* @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>
|
|
431
431
|
* @param {*} [options] Override http request option.
|
|
432
432
|
* @deprecated
|
|
433
433
|
* @throws {RequiredError}
|
|
@@ -522,7 +522,7 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
522
522
|
readonly pageToken?: string
|
|
523
523
|
|
|
524
524
|
/**
|
|
525
|
-
* Filter the response by one or multiple fields.
|
|
525
|
+
* 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>
|
|
526
526
|
* @type {string}
|
|
527
527
|
* @memberof InvoicesApiListInvoices
|
|
528
528
|
*/
|
|
@@ -550,7 +550,7 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
550
550
|
readonly expand?: string
|
|
551
551
|
|
|
552
552
|
/**
|
|
553
|
-
* Filters the response by one or multiple fields.
|
|
553
|
+
* 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>
|
|
554
554
|
* @type {string}
|
|
555
555
|
* @memberof InvoicesApiListInvoices
|
|
556
556
|
*/
|
|
@@ -585,7 +585,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
585
585
|
readonly pageToken?: string
|
|
586
586
|
|
|
587
587
|
/**
|
|
588
|
-
* Filter the response by one or multiple fields.
|
|
588
|
+
* 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>
|
|
589
589
|
* @type {string}
|
|
590
590
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
591
591
|
*/
|
|
@@ -613,7 +613,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
613
613
|
readonly expand?: string
|
|
614
614
|
|
|
615
615
|
/**
|
|
616
|
-
* Filters the response by one or multiple fields.
|
|
616
|
+
* 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>
|
|
617
617
|
* @type {string}
|
|
618
618
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
619
619
|
*/
|
|
@@ -652,7 +652,7 @@ export class InvoicesApi extends BaseAPI {
|
|
|
652
652
|
}
|
|
653
653
|
|
|
654
654
|
/**
|
|
655
|
-
* Returns a list of invoices you have previously created.
|
|
655
|
+
* 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\"
|
|
656
656
|
* @summary List invoices
|
|
657
657
|
* @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
|
|
658
658
|
* @param {*} [options] Override http request option.
|
|
@@ -664,7 +664,7 @@ export class InvoicesApi extends BaseAPI {
|
|
|
664
664
|
}
|
|
665
665
|
|
|
666
666
|
/**
|
|
667
|
-
* Returns a list of policies billing dates you have previously created.
|
|
667
|
+
* 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\"
|
|
668
668
|
* @summary List policies billing dates
|
|
669
669
|
* @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
|
|
670
670
|
* @param {*} [options] Override http request option.
|
|
@@ -82,16 +82,16 @@ export const PolicyBillingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
82
82
|
};
|
|
83
83
|
},
|
|
84
84
|
/**
|
|
85
|
-
* Returns a list of policies billings you have previously created.
|
|
85
|
+
* 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\"
|
|
86
86
|
* @summary List policies billings
|
|
87
87
|
* @param {string} [authorization] Bearer Token
|
|
88
88
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
89
89
|
* @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.
|
|
90
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
90
|
+
* @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>
|
|
91
91
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
92
92
|
* @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>
|
|
93
93
|
* @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/>
|
|
94
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
94
|
+
* @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>
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
96
96
|
* @throws {RequiredError}
|
|
97
97
|
*/
|
|
@@ -231,16 +231,16 @@ export const PolicyBillingApiFp = function(configuration?: Configuration) {
|
|
|
231
231
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
232
232
|
},
|
|
233
233
|
/**
|
|
234
|
-
* Returns a list of policies billings you have previously created.
|
|
234
|
+
* 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\"
|
|
235
235
|
* @summary List policies billings
|
|
236
236
|
* @param {string} [authorization] Bearer Token
|
|
237
237
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
238
238
|
* @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.
|
|
239
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
239
|
+
* @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>
|
|
240
240
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
241
241
|
* @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>
|
|
242
242
|
* @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/>
|
|
243
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
243
|
+
* @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>
|
|
244
244
|
* @param {*} [options] Override http request option.
|
|
245
245
|
* @throws {RequiredError}
|
|
246
246
|
*/
|
|
@@ -283,16 +283,16 @@ export const PolicyBillingApiFactory = function (configuration?: Configuration,
|
|
|
283
283
|
return localVarFp.createPolicyBilling(createPolicyBillingRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
284
284
|
},
|
|
285
285
|
/**
|
|
286
|
-
* Returns a list of policies billings you have previously created.
|
|
286
|
+
* 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\"
|
|
287
287
|
* @summary List policies billings
|
|
288
288
|
* @param {string} [authorization] Bearer Token
|
|
289
289
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
290
290
|
* @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.
|
|
291
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
291
|
+
* @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>
|
|
292
292
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
293
293
|
* @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>
|
|
294
294
|
* @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/>
|
|
295
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
295
|
+
* @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>
|
|
296
296
|
* @param {*} [options] Override http request option.
|
|
297
297
|
* @throws {RequiredError}
|
|
298
298
|
*/
|
|
@@ -363,7 +363,7 @@ export interface PolicyBillingApiListPoliciesBillingsRequest {
|
|
|
363
363
|
readonly pageToken?: string
|
|
364
364
|
|
|
365
365
|
/**
|
|
366
|
-
* Filter the response by one or multiple fields.
|
|
366
|
+
* 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>
|
|
367
367
|
* @type {string}
|
|
368
368
|
* @memberof PolicyBillingApiListPoliciesBillings
|
|
369
369
|
*/
|
|
@@ -391,7 +391,7 @@ export interface PolicyBillingApiListPoliciesBillingsRequest {
|
|
|
391
391
|
readonly expand?: string
|
|
392
392
|
|
|
393
393
|
/**
|
|
394
|
-
* Filters the response by one or multiple fields.
|
|
394
|
+
* 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>
|
|
395
395
|
* @type {string}
|
|
396
396
|
* @memberof PolicyBillingApiListPoliciesBillings
|
|
397
397
|
*/
|
|
@@ -446,7 +446,7 @@ export class PolicyBillingApi extends BaseAPI {
|
|
|
446
446
|
}
|
|
447
447
|
|
|
448
448
|
/**
|
|
449
|
-
* Returns a list of policies billings you have previously created.
|
|
449
|
+
* 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\"
|
|
450
450
|
* @summary List policies billings
|
|
451
451
|
* @param {PolicyBillingApiListPoliciesBillingsRequest} requestParameters Request parameters.
|
|
452
452
|
* @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
|
@@ -200,16 +200,16 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
200
200
|
});
|
|
201
201
|
},
|
|
202
202
|
/**
|
|
203
|
-
* Returns a list of invoices you have previously created.
|
|
203
|
+
* 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\"
|
|
204
204
|
* @summary List invoices
|
|
205
205
|
* @param {string} [authorization] Bearer Token
|
|
206
206
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
207
207
|
* @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.
|
|
208
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
208
|
+
* @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>
|
|
209
209
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
210
210
|
* @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>
|
|
211
211
|
* @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>
|
|
212
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
212
|
+
* @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>
|
|
213
213
|
* @param {*} [options] Override http request option.
|
|
214
214
|
* @throws {RequiredError}
|
|
215
215
|
*/
|
|
@@ -272,16 +272,16 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
272
272
|
});
|
|
273
273
|
},
|
|
274
274
|
/**
|
|
275
|
-
* Returns a list of policies billing dates you have previously created.
|
|
275
|
+
* 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\"
|
|
276
276
|
* @summary List policies billing dates
|
|
277
277
|
* @param {string} [authorization] Bearer Token
|
|
278
278
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
279
279
|
* @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.
|
|
280
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
280
|
+
* @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>
|
|
281
281
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
282
282
|
* @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>
|
|
283
283
|
* @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/>
|
|
284
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
284
|
+
* @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>
|
|
285
285
|
* @param {*} [options] Override http request option.
|
|
286
286
|
* @deprecated
|
|
287
287
|
* @throws {RequiredError}
|
|
@@ -399,16 +399,16 @@ var InvoicesApiFp = function (configuration) {
|
|
|
399
399
|
});
|
|
400
400
|
},
|
|
401
401
|
/**
|
|
402
|
-
* Returns a list of invoices you have previously created.
|
|
402
|
+
* 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\"
|
|
403
403
|
* @summary List invoices
|
|
404
404
|
* @param {string} [authorization] Bearer Token
|
|
405
405
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
406
406
|
* @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.
|
|
407
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
407
|
+
* @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>
|
|
408
408
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
409
409
|
* @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>
|
|
410
410
|
* @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>
|
|
411
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
411
|
+
* @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>
|
|
412
412
|
* @param {*} [options] Override http request option.
|
|
413
413
|
* @throws {RequiredError}
|
|
414
414
|
*/
|
|
@@ -426,16 +426,16 @@ var InvoicesApiFp = function (configuration) {
|
|
|
426
426
|
});
|
|
427
427
|
},
|
|
428
428
|
/**
|
|
429
|
-
* Returns a list of policies billing dates you have previously created.
|
|
429
|
+
* 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\"
|
|
430
430
|
* @summary List policies billing dates
|
|
431
431
|
* @param {string} [authorization] Bearer Token
|
|
432
432
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
433
433
|
* @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.
|
|
434
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
434
|
+
* @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>
|
|
435
435
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
436
436
|
* @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>
|
|
437
437
|
* @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/>
|
|
438
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
438
|
+
* @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>
|
|
439
439
|
* @param {*} [options] Override http request option.
|
|
440
440
|
* @deprecated
|
|
441
441
|
* @throws {RequiredError}
|
|
@@ -488,16 +488,16 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
488
488
|
return localVarFp.getInvoice(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
489
489
|
},
|
|
490
490
|
/**
|
|
491
|
-
* Returns a list of invoices you have previously created.
|
|
491
|
+
* 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\"
|
|
492
492
|
* @summary List invoices
|
|
493
493
|
* @param {string} [authorization] Bearer Token
|
|
494
494
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
495
495
|
* @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.
|
|
496
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
496
|
+
* @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>
|
|
497
497
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
498
498
|
* @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>
|
|
499
499
|
* @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>
|
|
500
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
500
|
+
* @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>
|
|
501
501
|
* @param {*} [options] Override http request option.
|
|
502
502
|
* @throws {RequiredError}
|
|
503
503
|
*/
|
|
@@ -505,16 +505,16 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
505
505
|
return localVarFp.listInvoices(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
506
506
|
},
|
|
507
507
|
/**
|
|
508
|
-
* Returns a list of policies billing dates you have previously created.
|
|
508
|
+
* 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\"
|
|
509
509
|
* @summary List policies billing dates
|
|
510
510
|
* @param {string} [authorization] Bearer Token
|
|
511
511
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
512
512
|
* @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.
|
|
513
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
513
|
+
* @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>
|
|
514
514
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
515
515
|
* @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>
|
|
516
516
|
* @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/>
|
|
517
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
517
|
+
* @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>
|
|
518
518
|
* @param {*} [options] Override http request option.
|
|
519
519
|
* @deprecated
|
|
520
520
|
* @throws {RequiredError}
|
|
@@ -561,7 +561,7 @@ var InvoicesApi = /** @class */ (function (_super) {
|
|
|
561
561
|
return (0, exports.InvoicesApiFp)(this.configuration).getInvoice(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
562
562
|
};
|
|
563
563
|
/**
|
|
564
|
-
* Returns a list of invoices you have previously created.
|
|
564
|
+
* 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\"
|
|
565
565
|
* @summary List invoices
|
|
566
566
|
* @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
|
|
567
567
|
* @param {*} [options] Override http request option.
|
|
@@ -574,7 +574,7 @@ var InvoicesApi = /** @class */ (function (_super) {
|
|
|
574
574
|
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); });
|
|
575
575
|
};
|
|
576
576
|
/**
|
|
577
|
-
* Returns a list of policies billing dates you have previously created.
|
|
577
|
+
* 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\"
|
|
578
578
|
* @summary List policies billing dates
|
|
579
579
|
* @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
|
|
580
580
|
* @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.
|
|
@@ -142,16 +142,16 @@ var PolicyBillingApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
* Returns a list of policies billings you have previously created.
|
|
145
|
+
* 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\"
|
|
146
146
|
* @summary List policies billings
|
|
147
147
|
* @param {string} [authorization] Bearer Token
|
|
148
148
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
149
149
|
* @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.
|
|
150
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
150
|
+
* @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>
|
|
151
151
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
152
152
|
* @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>
|
|
153
153
|
* @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/>
|
|
154
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
154
|
+
* @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>
|
|
155
155
|
* @param {*} [options] Override http request option.
|
|
156
156
|
* @throws {RequiredError}
|
|
157
157
|
*/
|
|
@@ -298,16 +298,16 @@ var PolicyBillingApiFp = function (configuration) {
|
|
|
298
298
|
});
|
|
299
299
|
},
|
|
300
300
|
/**
|
|
301
|
-
* Returns a list of policies billings you have previously created.
|
|
301
|
+
* 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\"
|
|
302
302
|
* @summary List policies billings
|
|
303
303
|
* @param {string} [authorization] Bearer Token
|
|
304
304
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
305
305
|
* @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.
|
|
306
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
306
|
+
* @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>
|
|
307
307
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
308
308
|
* @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>
|
|
309
309
|
* @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/>
|
|
310
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
310
|
+
* @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>
|
|
311
311
|
* @param {*} [options] Override http request option.
|
|
312
312
|
* @throws {RequiredError}
|
|
313
313
|
*/
|
|
@@ -368,16 +368,16 @@ var PolicyBillingApiFactory = function (configuration, basePath, axios) {
|
|
|
368
368
|
return localVarFp.createPolicyBilling(createPolicyBillingRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
369
369
|
},
|
|
370
370
|
/**
|
|
371
|
-
* Returns a list of policies billings you have previously created.
|
|
371
|
+
* 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\"
|
|
372
372
|
* @summary List policies billings
|
|
373
373
|
* @param {string} [authorization] Bearer Token
|
|
374
374
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
375
375
|
* @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.
|
|
376
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
376
|
+
* @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>
|
|
377
377
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
378
378
|
* @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>
|
|
379
379
|
* @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/>
|
|
380
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
380
|
+
* @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>
|
|
381
381
|
* @param {*} [options] Override http request option.
|
|
382
382
|
* @throws {RequiredError}
|
|
383
383
|
*/
|
|
@@ -423,7 +423,7 @@ var PolicyBillingApi = /** @class */ (function (_super) {
|
|
|
423
423
|
return (0, exports.PolicyBillingApiFp)(this.configuration).createPolicyBilling(requestParameters.createPolicyBillingRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
424
424
|
};
|
|
425
425
|
/**
|
|
426
|
-
* Returns a list of policies billings you have previously created.
|
|
426
|
+
* 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\"
|
|
427
427
|
* @summary List policies billings
|
|
428
428
|
* @param {PolicyBillingApiListPoliciesBillingsRequest} requestParameters Request parameters.
|
|
429
429
|
* @param {*} [options] Override http request option.
|