@emilgroup/billing-sdk 1.41.1-beta.10 → 1.41.1-beta.11
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/correction-invoices-api.ts +4 -4
- package/api/draft-invoice-api.ts +12 -12
- package/api/estimated-invoices-api.ts +12 -12
- package/api/initial-invoices-api.ts +4 -4
- package/api/invoices-api.ts +62 -62
- package/api/policy-billing-api.ts +31 -31
- package/api/recurring-invoices-api.ts +4 -4
- package/dist/api/correction-invoices-api.d.ts +4 -4
- package/dist/api/correction-invoices-api.js +4 -4
- package/dist/api/draft-invoice-api.d.ts +12 -12
- package/dist/api/draft-invoice-api.js +12 -12
- package/dist/api/estimated-invoices-api.d.ts +12 -12
- package/dist/api/estimated-invoices-api.js +12 -12
- package/dist/api/initial-invoices-api.d.ts +4 -4
- package/dist/api/initial-invoices-api.js +4 -4
- package/dist/api/invoices-api.d.ts +62 -62
- package/dist/api/invoices-api.js +40 -40
- package/dist/api/policy-billing-api.d.ts +31 -31
- package/dist/api/policy-billing-api.js +21 -21
- package/dist/api/recurring-invoices-api.d.ts +4 -4
- package/dist/api/recurring-invoices-api.js +4 -4
- package/dist/models/create-invoice-for-policy-request-dto.d.ts +6 -0
- package/models/create-invoice-for-policy-request-dto.ts +6 -0
- package/package.json +1 -1
|
@@ -23,7 +23,7 @@ import { ListPoliciesBillingsResponseClass } from '../models';
|
|
|
23
23
|
*/
|
|
24
24
|
export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
25
|
/**
|
|
26
|
-
* This will create invoice for a policy and save it in the DB.
|
|
26
|
+
* This will create invoice for a policy and save it in the DB. **Required Permissions** \"billing-management.invoices.create\"
|
|
27
27
|
* @summary Create the invoice
|
|
28
28
|
* @param {CreateInvoiceRequestDto} createInvoiceRequestDto
|
|
29
29
|
* @param {string} [authorization] Bearer Token
|
|
@@ -33,7 +33,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
33
33
|
*/
|
|
34
34
|
createInvoice: (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
* Gets an invoice.
|
|
36
|
+
* Gets an invoice. **Required Permissions** \"billing-management.invoices.view\"
|
|
37
37
|
* @summary Retrieve the invoice
|
|
38
38
|
* @param {string} code
|
|
39
39
|
* @param {string} expand
|
|
@@ -43,28 +43,28 @@ 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. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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
|
-
* @param {
|
|
50
|
-
* @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: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
52
|
-
* @param {
|
|
49
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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. 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</i>
|
|
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</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<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: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</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: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
56
56
|
* @param {*} [options] Override http request option.
|
|
57
57
|
* @throws {RequiredError}
|
|
58
58
|
*/
|
|
59
|
-
listInvoices: (authorization?: string, pageSize?:
|
|
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. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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
|
-
* @param {
|
|
65
|
-
* @param {
|
|
64
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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>
|
|
@@ -72,7 +72,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
72
72
|
* @deprecated
|
|
73
73
|
* @throws {RequiredError}
|
|
74
74
|
*/
|
|
75
|
-
listPoliciesBillingDates: (authorization?: string, pageSize?:
|
|
75
|
+
listPoliciesBillingDates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
76
|
};
|
|
77
77
|
/**
|
|
78
78
|
* InvoicesApi - functional programming interface
|
|
@@ -80,7 +80,7 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
80
80
|
*/
|
|
81
81
|
export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
82
82
|
/**
|
|
83
|
-
* This will create invoice for a policy and save it in the DB.
|
|
83
|
+
* This will create invoice for a policy and save it in the DB. **Required Permissions** \"billing-management.invoices.create\"
|
|
84
84
|
* @summary Create the invoice
|
|
85
85
|
* @param {CreateInvoiceRequestDto} createInvoiceRequestDto
|
|
86
86
|
* @param {string} [authorization] Bearer Token
|
|
@@ -90,7 +90,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
90
90
|
*/
|
|
91
91
|
createInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInvoiceResponseClass>>;
|
|
92
92
|
/**
|
|
93
|
-
* Gets an invoice.
|
|
93
|
+
* Gets an invoice. **Required Permissions** \"billing-management.invoices.view\"
|
|
94
94
|
* @summary Retrieve the invoice
|
|
95
95
|
* @param {string} code
|
|
96
96
|
* @param {string} expand
|
|
@@ -100,28 +100,28 @@ 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. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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
|
-
* @param {
|
|
107
|
-
* @param {
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
109
|
-
* @param {
|
|
106
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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. 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</i>
|
|
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</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<i>
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
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</i>
|
|
113
113
|
* @param {*} [options] Override http request option.
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
116
|
-
listInvoices(authorization?: string, pageSize?:
|
|
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. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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
|
-
* @param {
|
|
122
|
-
* @param {
|
|
121
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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>
|
|
@@ -129,7 +129,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
129
129
|
* @deprecated
|
|
130
130
|
* @throws {RequiredError}
|
|
131
131
|
*/
|
|
132
|
-
listPoliciesBillingDates(authorization?: string, pageSize?:
|
|
132
|
+
listPoliciesBillingDates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesBillingsResponseClass>>;
|
|
133
133
|
};
|
|
134
134
|
/**
|
|
135
135
|
* InvoicesApi - factory interface
|
|
@@ -137,7 +137,7 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
137
137
|
*/
|
|
138
138
|
export declare const InvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
139
139
|
/**
|
|
140
|
-
* This will create invoice for a policy and save it in the DB.
|
|
140
|
+
* This will create invoice for a policy and save it in the DB. **Required Permissions** \"billing-management.invoices.create\"
|
|
141
141
|
* @summary Create the invoice
|
|
142
142
|
* @param {CreateInvoiceRequestDto} createInvoiceRequestDto
|
|
143
143
|
* @param {string} [authorization] Bearer Token
|
|
@@ -147,7 +147,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
147
147
|
*/
|
|
148
148
|
createInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: any): AxiosPromise<CreateInvoiceResponseClass>;
|
|
149
149
|
/**
|
|
150
|
-
* Gets an invoice.
|
|
150
|
+
* Gets an invoice. **Required Permissions** \"billing-management.invoices.view\"
|
|
151
151
|
* @summary Retrieve the invoice
|
|
152
152
|
* @param {string} code
|
|
153
153
|
* @param {string} expand
|
|
@@ -157,28 +157,28 @@ 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. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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
|
-
* @param {
|
|
164
|
-
* @param {
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
166
|
-
* @param {
|
|
163
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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. 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</i>
|
|
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</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<i>
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
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</i>
|
|
170
170
|
* @param {*} [options] Override http request option.
|
|
171
171
|
* @throws {RequiredError}
|
|
172
172
|
*/
|
|
173
|
-
listInvoices(authorization?: string, pageSize?:
|
|
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. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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
|
-
* @param {
|
|
179
|
-
* @param {
|
|
178
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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>
|
|
@@ -186,7 +186,7 @@ export declare const InvoicesApiFactory: (configuration?: Configuration, basePat
|
|
|
186
186
|
* @deprecated
|
|
187
187
|
* @throws {RequiredError}
|
|
188
188
|
*/
|
|
189
|
-
listPoliciesBillingDates(authorization?: string, pageSize?:
|
|
189
|
+
listPoliciesBillingDates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPoliciesBillingsResponseClass>;
|
|
190
190
|
};
|
|
191
191
|
/**
|
|
192
192
|
* Request parameters for createInvoice operation in InvoicesApi.
|
|
@@ -252,28 +252,28 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
252
252
|
readonly authorization?: string;
|
|
253
253
|
/**
|
|
254
254
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
255
|
-
* @type {
|
|
255
|
+
* @type {number}
|
|
256
256
|
* @memberof InvoicesApiListInvoices
|
|
257
257
|
*/
|
|
258
|
-
readonly pageSize?:
|
|
258
|
+
readonly pageSize?: number;
|
|
259
259
|
/**
|
|
260
|
-
* 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,
|
|
261
|
-
* @type {
|
|
260
|
+
* 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.
|
|
261
|
+
* @type {string}
|
|
262
262
|
* @memberof InvoicesApiListInvoices
|
|
263
263
|
*/
|
|
264
|
-
readonly pageToken?:
|
|
264
|
+
readonly pageToken?: string;
|
|
265
265
|
/**
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
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</i>
|
|
267
267
|
* @type {string}
|
|
268
268
|
* @memberof InvoicesApiListInvoices
|
|
269
269
|
*/
|
|
270
270
|
readonly filter?: string;
|
|
271
271
|
/**
|
|
272
272
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
273
|
-
* @type {
|
|
273
|
+
* @type {string}
|
|
274
274
|
* @memberof InvoicesApiListInvoices
|
|
275
275
|
*/
|
|
276
|
-
readonly search?:
|
|
276
|
+
readonly search?: string;
|
|
277
277
|
/**
|
|
278
278
|
* 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>
|
|
279
279
|
* @type {string}
|
|
@@ -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. 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>
|
|
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</i>
|
|
291
291
|
* @type {string}
|
|
292
292
|
* @memberof InvoicesApiListInvoices
|
|
293
293
|
*/
|
|
@@ -307,16 +307,16 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
307
307
|
readonly authorization?: string;
|
|
308
308
|
/**
|
|
309
309
|
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
310
|
-
* @type {
|
|
310
|
+
* @type {number}
|
|
311
311
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
312
312
|
*/
|
|
313
|
-
readonly pageSize?:
|
|
313
|
+
readonly pageSize?: number;
|
|
314
314
|
/**
|
|
315
|
-
* 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,
|
|
316
|
-
* @type {
|
|
315
|
+
* 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.
|
|
316
|
+
* @type {string}
|
|
317
317
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
318
318
|
*/
|
|
319
|
-
readonly pageToken?:
|
|
319
|
+
readonly pageToken?: string;
|
|
320
320
|
/**
|
|
321
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}
|
|
@@ -325,10 +325,10 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
325
325
|
readonly filter?: string;
|
|
326
326
|
/**
|
|
327
327
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
328
|
-
* @type {
|
|
328
|
+
* @type {string}
|
|
329
329
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
330
330
|
*/
|
|
331
|
-
readonly search?:
|
|
331
|
+
readonly search?: string;
|
|
332
332
|
/**
|
|
333
333
|
* 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>
|
|
334
334
|
* @type {string}
|
|
@@ -356,7 +356,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
356
356
|
*/
|
|
357
357
|
export declare class InvoicesApi extends BaseAPI {
|
|
358
358
|
/**
|
|
359
|
-
* This will create invoice for a policy and save it in the DB.
|
|
359
|
+
* This will create invoice for a policy and save it in the DB. **Required Permissions** \"billing-management.invoices.create\"
|
|
360
360
|
* @summary Create the invoice
|
|
361
361
|
* @param {InvoicesApiCreateInvoiceRequest} requestParameters Request parameters.
|
|
362
362
|
* @param {*} [options] Override http request option.
|
|
@@ -365,7 +365,7 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
365
365
|
*/
|
|
366
366
|
createInvoice(requestParameters: InvoicesApiCreateInvoiceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateInvoiceResponseClass, any>>;
|
|
367
367
|
/**
|
|
368
|
-
* Gets an invoice.
|
|
368
|
+
* Gets an invoice. **Required Permissions** \"billing-management.invoices.view\"
|
|
369
369
|
* @summary Retrieve the invoice
|
|
370
370
|
* @param {InvoicesApiGetInvoiceRequest} requestParameters Request parameters.
|
|
371
371
|
* @param {*} [options] Override http request option.
|
|
@@ -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. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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
|
@@ -93,7 +93,7 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* This will create invoice for a policy and save it in the DB.
|
|
96
|
+
* This will create invoice for a policy and save it in the DB. **Required Permissions** \"billing-management.invoices.create\"
|
|
97
97
|
* @summary Create the invoice
|
|
98
98
|
* @param {CreateInvoiceRequestDto} createInvoiceRequestDto
|
|
99
99
|
* @param {string} [authorization] Bearer Token
|
|
@@ -146,7 +146,7 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
* Gets an invoice.
|
|
149
|
+
* Gets an invoice. **Required Permissions** \"billing-management.invoices.view\"
|
|
150
150
|
* @summary Retrieve the invoice
|
|
151
151
|
* @param {string} code
|
|
152
152
|
* @param {string} expand
|
|
@@ -200,16 +200,16 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
200
200
|
});
|
|
201
201
|
},
|
|
202
202
|
/**
|
|
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.
|
|
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
|
-
* @param {
|
|
207
|
-
* @param {
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
209
|
-
* @param {
|
|
206
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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. 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</i>
|
|
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</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<i>
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
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</i>
|
|
213
213
|
* @param {*} [options] Override http request option.
|
|
214
214
|
* @throws {RequiredError}
|
|
215
215
|
*/
|
|
@@ -272,13 +272,13 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
272
272
|
});
|
|
273
273
|
},
|
|
274
274
|
/**
|
|
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.
|
|
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
|
-
* @param {
|
|
279
|
-
* @param {
|
|
278
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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>
|
|
@@ -355,7 +355,7 @@ var InvoicesApiFp = function (configuration) {
|
|
|
355
355
|
var localVarAxiosParamCreator = (0, exports.InvoicesApiAxiosParamCreator)(configuration);
|
|
356
356
|
return {
|
|
357
357
|
/**
|
|
358
|
-
* This will create invoice for a policy and save it in the DB.
|
|
358
|
+
* This will create invoice for a policy and save it in the DB. **Required Permissions** \"billing-management.invoices.create\"
|
|
359
359
|
* @summary Create the invoice
|
|
360
360
|
* @param {CreateInvoiceRequestDto} createInvoiceRequestDto
|
|
361
361
|
* @param {string} [authorization] Bearer Token
|
|
@@ -377,7 +377,7 @@ var InvoicesApiFp = function (configuration) {
|
|
|
377
377
|
});
|
|
378
378
|
},
|
|
379
379
|
/**
|
|
380
|
-
* Gets an invoice.
|
|
380
|
+
* Gets an invoice. **Required Permissions** \"billing-management.invoices.view\"
|
|
381
381
|
* @summary Retrieve the invoice
|
|
382
382
|
* @param {string} code
|
|
383
383
|
* @param {string} expand
|
|
@@ -399,16 +399,16 @@ var InvoicesApiFp = function (configuration) {
|
|
|
399
399
|
});
|
|
400
400
|
},
|
|
401
401
|
/**
|
|
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.
|
|
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
|
-
* @param {
|
|
406
|
-
* @param {
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
408
|
-
* @param {
|
|
405
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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. 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</i>
|
|
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</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<i>
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
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</i>
|
|
412
412
|
* @param {*} [options] Override http request option.
|
|
413
413
|
* @throws {RequiredError}
|
|
414
414
|
*/
|
|
@@ -426,13 +426,13 @@ var InvoicesApiFp = function (configuration) {
|
|
|
426
426
|
});
|
|
427
427
|
},
|
|
428
428
|
/**
|
|
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.
|
|
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
|
-
* @param {
|
|
433
|
-
* @param {
|
|
432
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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>
|
|
@@ -464,7 +464,7 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
464
464
|
var localVarFp = (0, exports.InvoicesApiFp)(configuration);
|
|
465
465
|
return {
|
|
466
466
|
/**
|
|
467
|
-
* This will create invoice for a policy and save it in the DB.
|
|
467
|
+
* This will create invoice for a policy and save it in the DB. **Required Permissions** \"billing-management.invoices.create\"
|
|
468
468
|
* @summary Create the invoice
|
|
469
469
|
* @param {CreateInvoiceRequestDto} createInvoiceRequestDto
|
|
470
470
|
* @param {string} [authorization] Bearer Token
|
|
@@ -476,7 +476,7 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
476
476
|
return localVarFp.createInvoice(createInvoiceRequestDto, authorization, idempotencyKey, options).then(function (request) { return request(axios, basePath); });
|
|
477
477
|
},
|
|
478
478
|
/**
|
|
479
|
-
* Gets an invoice.
|
|
479
|
+
* Gets an invoice. **Required Permissions** \"billing-management.invoices.view\"
|
|
480
480
|
* @summary Retrieve the invoice
|
|
481
481
|
* @param {string} code
|
|
482
482
|
* @param {string} expand
|
|
@@ -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. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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
|
-
* @param {
|
|
495
|
-
* @param {
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
497
|
-
* @param {
|
|
494
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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. 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</i>
|
|
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</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<i>
|
|
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, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
|
|
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</i>
|
|
501
501
|
* @param {*} [options] Override http request option.
|
|
502
502
|
* @throws {RequiredError}
|
|
503
503
|
*/
|
|
@@ -505,13 +505,13 @@ 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. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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
|
-
* @param {
|
|
512
|
-
* @param {
|
|
511
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
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
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
|
-
* @param {
|
|
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
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>
|
|
@@ -537,7 +537,7 @@ var InvoicesApi = /** @class */ (function (_super) {
|
|
|
537
537
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
538
538
|
}
|
|
539
539
|
/**
|
|
540
|
-
* This will create invoice for a policy and save it in the DB.
|
|
540
|
+
* This will create invoice for a policy and save it in the DB. **Required Permissions** \"billing-management.invoices.create\"
|
|
541
541
|
* @summary Create the invoice
|
|
542
542
|
* @param {InvoicesApiCreateInvoiceRequest} requestParameters Request parameters.
|
|
543
543
|
* @param {*} [options] Override http request option.
|
|
@@ -549,7 +549,7 @@ var InvoicesApi = /** @class */ (function (_super) {
|
|
|
549
549
|
return (0, exports.InvoicesApiFp)(this.configuration).createInvoice(requestParameters.createInvoiceRequestDto, requestParameters.authorization, requestParameters.idempotencyKey, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
550
550
|
};
|
|
551
551
|
/**
|
|
552
|
-
* Gets an invoice.
|
|
552
|
+
* Gets an invoice. **Required Permissions** \"billing-management.invoices.view\"
|
|
553
553
|
* @summary Retrieve the invoice
|
|
554
554
|
* @param {InvoicesApiGetInvoiceRequest} requestParameters Request parameters.
|
|
555
555
|
* @param {*} [options] Override http request option.
|
|
@@ -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. The invoices are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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. The policies billing dates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
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.
|