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