@emilgroup/billing-sdk-node 1.3.0 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +7 -0
- package/README.md +2 -2
- package/api/correction-invoices-api.ts +29 -11
- package/api/estimated-invoices-api.ts +17 -9
- package/api/initial-invoices-api.ts +29 -11
- package/api/invoices-api.ts +95 -87
- package/api/recurring-invoices-api.ts +29 -11
- package/api.ts +1 -6
- package/base.ts +6 -5
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api/correction-invoices-api.d.ts +21 -8
- package/dist/api/correction-invoices-api.js +21 -11
- package/dist/api/estimated-invoices-api.d.ts +17 -9
- package/dist/api/estimated-invoices-api.js +17 -9
- package/dist/api/initial-invoices-api.d.ts +21 -8
- package/dist/api/initial-invoices-api.js +21 -11
- package/dist/api/invoices-api.d.ts +95 -87
- package/dist/api/invoices-api.js +53 -45
- package/dist/api/recurring-invoices-api.d.ts +21 -8
- package/dist/api/recurring-invoices-api.js +21 -11
- package/dist/api.d.ts +1 -5
- package/dist/api.js +1 -7
- package/dist/base.d.ts +4 -3
- package/dist/base.js +6 -5
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -2
- package/dist/models/create-correction-invoices-response-class.d.ts +5 -5
- package/dist/models/create-correction-invoices-response-class.js +1 -1
- package/dist/models/create-custom-estimated-invoice-request-dto.d.ts +3 -3
- package/dist/models/create-custom-estimated-invoice-request-dto.js +1 -1
- package/dist/models/create-custom-estimated-invoice-response-class.d.ts +1 -1
- package/dist/models/create-custom-estimated-invoice-response-class.js +1 -1
- package/dist/models/create-estimated-invoice-request-dto.d.ts +3 -3
- package/dist/models/create-estimated-invoice-request-dto.js +1 -1
- package/dist/models/create-estimated-invoice-response-class.d.ts +3 -3
- package/dist/models/create-estimated-invoice-response-class.js +1 -1
- package/dist/models/create-invoice-request-dto.d.ts +16 -14
- package/dist/models/create-invoice-request-dto.js +4 -2
- package/dist/models/create-invoice-response-class.d.ts +5 -5
- package/dist/models/create-invoice-response-class.js +1 -1
- package/dist/models/create-invoice-status-request-dto.d.ts +35 -0
- package/dist/models/create-invoice-status-request-dto.js +20 -0
- package/dist/models/create-termination-invoice-request-dto.d.ts +48 -0
- package/dist/models/create-termination-invoice-request-dto.js +15 -0
- package/dist/models/currency-class.d.ts +48 -0
- package/dist/models/currency-class.js +15 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/invoice-class.d.ts +50 -20
- package/dist/models/invoice-class.js +16 -1
- package/dist/models/invoice-item-class.d.ts +26 -17
- package/dist/models/invoice-item-class.js +10 -1
- package/dist/models/invoice-status-class.d.ts +47 -0
- package/dist/models/invoice-status-class.js +20 -0
- package/dist/models/list-invoices-response-class.d.ts +3 -3
- package/dist/models/list-invoices-response-class.js +1 -1
- package/dist/models/list-policies-billing-dates-response-class.d.ts +6 -5
- package/dist/models/list-policies-billing-dates-response-class.js +1 -1
- package/dist/models/list-request-dto.d.ts +1 -1
- package/dist/models/list-request-dto.js +1 -1
- package/dist/models/omit-type-class.d.ts +144 -0
- package/dist/models/omit-type-class.js +30 -0
- package/dist/models/policy-billing-date-class.d.ts +42 -0
- package/dist/models/policy-billing-date-class.js +15 -0
- package/dist/models/policy-dto.d.ts +62 -25
- package/dist/models/policy-dto.js +8 -1
- package/dist/models/policy-object-dto.d.ts +10 -10
- package/dist/models/policy-object-dto.js +1 -1
- package/dist/models/policy-premium-dto.d.ts +12 -12
- package/dist/models/policy-premium-dto.js +1 -1
- package/dist/models/policy-premium-item-dto.d.ts +20 -14
- package/dist/models/policy-premium-item-dto.js +1 -1
- package/dist/models/policy-version-dto.d.ts +17 -17
- package/dist/models/policy-version-dto.js +1 -1
- package/dist/models/premium-formula-dto.d.ts +20 -20
- package/dist/models/premium-formula-dto.js +1 -1
- package/dist/models/revert-invoice-request-dto.d.ts +24 -0
- package/dist/models/revert-invoice-request-dto.js +15 -0
- package/dist/models/timeslice-dto.d.ts +13 -13
- package/dist/models/timeslice-dto.js +1 -1
- package/index.ts +2 -2
- package/models/create-correction-invoices-response-class.ts +5 -5
- package/models/create-custom-estimated-invoice-request-dto.ts +3 -3
- package/models/create-custom-estimated-invoice-response-class.ts +1 -1
- package/models/create-estimated-invoice-request-dto.ts +3 -3
- package/models/create-estimated-invoice-response-class.ts +3 -3
- package/models/create-invoice-request-dto.ts +17 -15
- package/models/create-invoice-response-class.ts +5 -5
- package/models/create-invoice-status-request-dto.ts +44 -0
- package/models/create-termination-invoice-request-dto.ts +54 -0
- package/models/currency-class.ts +54 -0
- package/models/index.ts +7 -0
- package/models/invoice-class.ts +54 -20
- package/models/invoice-item-class.ts +29 -17
- package/models/invoice-status-class.ts +56 -0
- package/models/list-invoices-response-class.ts +3 -3
- package/models/list-policies-billing-dates-response-class.ts +6 -5
- package/models/list-request-dto.ts +1 -1
- package/models/omit-type-class.ts +154 -0
- package/models/policy-billing-date-class.ts +48 -0
- package/models/policy-dto.ts +65 -25
- package/models/policy-object-dto.ts +10 -10
- package/models/policy-premium-dto.ts +12 -12
- package/models/policy-premium-item-dto.ts +20 -14
- package/models/policy-version-dto.ts +17 -17
- package/models/premium-formula-dto.ts +20 -20
- package/models/revert-invoice-request-dto.ts +30 -0
- package/models/timeslice-dto.ts +13 -13
- package/package.json +1 -1
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* The EMIL BillingService API description
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0
|
|
6
|
-
*
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -20,31 +20,33 @@ import { ListPoliciesBillingDatesResponseClass } from '../models';
|
|
|
20
20
|
*/
|
|
21
21
|
export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* 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.
|
|
24
|
+
* @summary List invoices
|
|
24
25
|
* @param {string} [authorization] Bearer Token
|
|
25
|
-
* @param {
|
|
26
|
-
* @param {
|
|
27
|
-
* @param {
|
|
28
|
-
* @param {
|
|
29
|
-
* @param {
|
|
30
|
-
* @param {
|
|
26
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
27
|
+
* @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.
|
|
28
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
29
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
30
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
31
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
31
32
|
* @param {*} [options] Override http request option.
|
|
32
33
|
* @throws {RequiredError}
|
|
33
34
|
*/
|
|
34
|
-
listInvoices: (authorization?: string, pageSize?:
|
|
35
|
+
listInvoices: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
36
|
/**
|
|
36
|
-
*
|
|
37
|
+
* 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.
|
|
38
|
+
* @summary List policies billing dates
|
|
37
39
|
* @param {string} [authorization] Bearer Token
|
|
38
|
-
* @param {
|
|
39
|
-
* @param {
|
|
40
|
-
* @param {
|
|
41
|
-
* @param {
|
|
42
|
-
* @param {
|
|
43
|
-
* @param {
|
|
40
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
41
|
+
* @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.
|
|
42
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
43
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
44
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
45
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
44
46
|
* @param {*} [options] Override http request option.
|
|
45
47
|
* @throws {RequiredError}
|
|
46
48
|
*/
|
|
47
|
-
listPoliciesBillingDates: (authorization?: string, pageSize?:
|
|
49
|
+
listPoliciesBillingDates: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
50
|
};
|
|
49
51
|
/**
|
|
50
52
|
* InvoicesApi - functional programming interface
|
|
@@ -52,31 +54,33 @@ export declare const InvoicesApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
52
54
|
*/
|
|
53
55
|
export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
54
56
|
/**
|
|
55
|
-
*
|
|
57
|
+
* 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.
|
|
58
|
+
* @summary List invoices
|
|
56
59
|
* @param {string} [authorization] Bearer Token
|
|
57
|
-
* @param {
|
|
58
|
-
* @param {
|
|
59
|
-
* @param {
|
|
60
|
-
* @param {
|
|
61
|
-
* @param {
|
|
62
|
-
* @param {
|
|
60
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
61
|
+
* @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.
|
|
62
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
63
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
64
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
65
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
63
66
|
* @param {*} [options] Override http request option.
|
|
64
67
|
* @throws {RequiredError}
|
|
65
68
|
*/
|
|
66
|
-
listInvoices(authorization?: string, pageSize?:
|
|
69
|
+
listInvoices(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvoicesResponseClass>>;
|
|
67
70
|
/**
|
|
68
|
-
*
|
|
71
|
+
* 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.
|
|
72
|
+
* @summary List policies billing dates
|
|
69
73
|
* @param {string} [authorization] Bearer Token
|
|
70
|
-
* @param {
|
|
71
|
-
* @param {
|
|
72
|
-
* @param {
|
|
73
|
-
* @param {
|
|
74
|
-
* @param {
|
|
75
|
-
* @param {
|
|
74
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
75
|
+
* @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.
|
|
76
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
77
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
78
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
79
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
76
80
|
* @param {*} [options] Override http request option.
|
|
77
81
|
* @throws {RequiredError}
|
|
78
82
|
*/
|
|
79
|
-
listPoliciesBillingDates(authorization?: string, pageSize?:
|
|
83
|
+
listPoliciesBillingDates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesBillingDatesResponseClass>>;
|
|
80
84
|
};
|
|
81
85
|
/**
|
|
82
86
|
* InvoicesApi - factory interface
|
|
@@ -84,31 +88,33 @@ export declare const InvoicesApiFp: (configuration?: Configuration) => {
|
|
|
84
88
|
*/
|
|
85
89
|
export declare const InvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
86
90
|
/**
|
|
87
|
-
*
|
|
91
|
+
* 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.
|
|
92
|
+
* @summary List invoices
|
|
88
93
|
* @param {string} [authorization] Bearer Token
|
|
89
|
-
* @param {
|
|
90
|
-
* @param {
|
|
91
|
-
* @param {
|
|
92
|
-
* @param {
|
|
93
|
-
* @param {
|
|
94
|
-
* @param {
|
|
94
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
95
|
+
* @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.
|
|
96
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
97
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
98
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
99
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
95
100
|
* @param {*} [options] Override http request option.
|
|
96
101
|
* @throws {RequiredError}
|
|
97
102
|
*/
|
|
98
|
-
listInvoices(authorization?: string, pageSize?:
|
|
103
|
+
listInvoices(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListInvoicesResponseClass>;
|
|
99
104
|
/**
|
|
100
|
-
*
|
|
105
|
+
* 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.
|
|
106
|
+
* @summary List policies billing dates
|
|
101
107
|
* @param {string} [authorization] Bearer Token
|
|
102
|
-
* @param {
|
|
103
|
-
* @param {
|
|
104
|
-
* @param {
|
|
105
|
-
* @param {
|
|
106
|
-
* @param {
|
|
107
|
-
* @param {
|
|
108
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
109
|
+
* @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.
|
|
110
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
111
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
112
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
113
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
108
114
|
* @param {*} [options] Override http request option.
|
|
109
115
|
* @throws {RequiredError}
|
|
110
116
|
*/
|
|
111
|
-
listPoliciesBillingDates(authorization?: string, pageSize?:
|
|
117
|
+
listPoliciesBillingDates(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListPoliciesBillingDatesResponseClass>;
|
|
112
118
|
};
|
|
113
119
|
/**
|
|
114
120
|
* Request parameters for listInvoices operation in InvoicesApi.
|
|
@@ -123,41 +129,41 @@ export interface InvoicesApiListInvoicesRequest {
|
|
|
123
129
|
*/
|
|
124
130
|
readonly authorization?: string;
|
|
125
131
|
/**
|
|
126
|
-
*
|
|
127
|
-
* @type {
|
|
132
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
133
|
+
* @type {any}
|
|
128
134
|
* @memberof InvoicesApiListInvoices
|
|
129
135
|
*/
|
|
130
|
-
readonly pageSize?:
|
|
136
|
+
readonly pageSize?: any;
|
|
131
137
|
/**
|
|
132
|
-
*
|
|
133
|
-
* @type {
|
|
138
|
+
* 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.
|
|
139
|
+
* @type {any}
|
|
134
140
|
* @memberof InvoicesApiListInvoices
|
|
135
141
|
*/
|
|
136
|
-
readonly pageToken?:
|
|
142
|
+
readonly pageToken?: any;
|
|
137
143
|
/**
|
|
138
|
-
*
|
|
139
|
-
* @type {
|
|
144
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
145
|
+
* @type {any}
|
|
140
146
|
* @memberof InvoicesApiListInvoices
|
|
141
147
|
*/
|
|
142
|
-
readonly filter?:
|
|
148
|
+
readonly filter?: any;
|
|
143
149
|
/**
|
|
144
|
-
* Search
|
|
145
|
-
* @type {
|
|
150
|
+
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
151
|
+
* @type {any}
|
|
146
152
|
* @memberof InvoicesApiListInvoices
|
|
147
153
|
*/
|
|
148
|
-
readonly search?:
|
|
154
|
+
readonly search?: any;
|
|
149
155
|
/**
|
|
150
|
-
*
|
|
151
|
-
* @type {
|
|
156
|
+
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
157
|
+
* @type {any}
|
|
152
158
|
* @memberof InvoicesApiListInvoices
|
|
153
159
|
*/
|
|
154
|
-
readonly order?:
|
|
160
|
+
readonly order?: any;
|
|
155
161
|
/**
|
|
156
|
-
*
|
|
157
|
-
* @type {
|
|
162
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
163
|
+
* @type {any}
|
|
158
164
|
* @memberof InvoicesApiListInvoices
|
|
159
165
|
*/
|
|
160
|
-
readonly expand?:
|
|
166
|
+
readonly expand?: any;
|
|
161
167
|
}
|
|
162
168
|
/**
|
|
163
169
|
* Request parameters for listPoliciesBillingDates operation in InvoicesApi.
|
|
@@ -172,41 +178,41 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
172
178
|
*/
|
|
173
179
|
readonly authorization?: string;
|
|
174
180
|
/**
|
|
175
|
-
*
|
|
176
|
-
* @type {
|
|
181
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
182
|
+
* @type {any}
|
|
177
183
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
178
184
|
*/
|
|
179
|
-
readonly pageSize?:
|
|
185
|
+
readonly pageSize?: any;
|
|
180
186
|
/**
|
|
181
|
-
*
|
|
182
|
-
* @type {
|
|
187
|
+
* 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.
|
|
188
|
+
* @type {any}
|
|
183
189
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
184
190
|
*/
|
|
185
|
-
readonly pageToken?:
|
|
191
|
+
readonly pageToken?: any;
|
|
186
192
|
/**
|
|
187
|
-
*
|
|
188
|
-
* @type {
|
|
193
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
194
|
+
* @type {any}
|
|
189
195
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
190
196
|
*/
|
|
191
|
-
readonly filter?:
|
|
197
|
+
readonly filter?: any;
|
|
192
198
|
/**
|
|
193
|
-
* Search
|
|
194
|
-
* @type {
|
|
199
|
+
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
200
|
+
* @type {any}
|
|
195
201
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
196
202
|
*/
|
|
197
|
-
readonly search?:
|
|
203
|
+
readonly search?: any;
|
|
198
204
|
/**
|
|
199
|
-
*
|
|
200
|
-
* @type {
|
|
205
|
+
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
206
|
+
* @type {any}
|
|
201
207
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
202
208
|
*/
|
|
203
|
-
readonly order?:
|
|
209
|
+
readonly order?: any;
|
|
204
210
|
/**
|
|
205
|
-
*
|
|
206
|
-
* @type {
|
|
211
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
212
|
+
* @type {any}
|
|
207
213
|
* @memberof InvoicesApiListPoliciesBillingDates
|
|
208
214
|
*/
|
|
209
|
-
readonly expand?:
|
|
215
|
+
readonly expand?: any;
|
|
210
216
|
}
|
|
211
217
|
/**
|
|
212
218
|
* InvoicesApi - object-oriented interface
|
|
@@ -216,7 +222,8 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
|
|
|
216
222
|
*/
|
|
217
223
|
export declare class InvoicesApi extends BaseAPI {
|
|
218
224
|
/**
|
|
219
|
-
*
|
|
225
|
+
* 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.
|
|
226
|
+
* @summary List invoices
|
|
220
227
|
* @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
|
|
221
228
|
* @param {*} [options] Override http request option.
|
|
222
229
|
* @throws {RequiredError}
|
|
@@ -224,7 +231,8 @@ export declare class InvoicesApi extends BaseAPI {
|
|
|
224
231
|
*/
|
|
225
232
|
listInvoices(requestParameters?: InvoicesApiListInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInvoicesResponseClass, any>>;
|
|
226
233
|
/**
|
|
227
|
-
*
|
|
234
|
+
* 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.
|
|
235
|
+
* @summary List policies billing dates
|
|
228
236
|
* @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
|
|
229
237
|
* @param {*} [options] Override http request option.
|
|
230
238
|
* @throws {RequiredError}
|
package/dist/api/invoices-api.js
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
* The EMIL BillingService API description
|
|
7
7
|
*
|
|
8
8
|
* The version of the OpenAPI document: 1.0
|
|
9
|
-
*
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
12
|
* https://openapi-generator.tech
|
|
@@ -97,14 +97,15 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* 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.
|
|
101
|
+
* @summary List invoices
|
|
101
102
|
* @param {string} [authorization] Bearer Token
|
|
102
|
-
* @param {
|
|
103
|
-
* @param {
|
|
104
|
-
* @param {
|
|
105
|
-
* @param {
|
|
106
|
-
* @param {
|
|
107
|
-
* @param {
|
|
103
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
104
|
+
* @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.
|
|
105
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
106
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
107
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
108
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
108
109
|
* @param {*} [options] Override http request option.
|
|
109
110
|
* @throws {RequiredError}
|
|
110
111
|
*/
|
|
@@ -164,14 +165,15 @@ var InvoicesApiAxiosParamCreator = function (configuration) {
|
|
|
164
165
|
});
|
|
165
166
|
},
|
|
166
167
|
/**
|
|
167
|
-
*
|
|
168
|
+
* 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.
|
|
169
|
+
* @summary List policies billing dates
|
|
168
170
|
* @param {string} [authorization] Bearer Token
|
|
169
|
-
* @param {
|
|
170
|
-
* @param {
|
|
171
|
-
* @param {
|
|
172
|
-
* @param {
|
|
173
|
-
* @param {
|
|
174
|
-
* @param {
|
|
171
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
172
|
+
* @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.
|
|
173
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
174
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
175
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
176
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
175
177
|
* @param {*} [options] Override http request option.
|
|
176
178
|
* @throws {RequiredError}
|
|
177
179
|
*/
|
|
@@ -241,14 +243,15 @@ var InvoicesApiFp = function (configuration) {
|
|
|
241
243
|
var localVarAxiosParamCreator = (0, exports.InvoicesApiAxiosParamCreator)(configuration);
|
|
242
244
|
return {
|
|
243
245
|
/**
|
|
244
|
-
*
|
|
246
|
+
* 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.
|
|
247
|
+
* @summary List invoices
|
|
245
248
|
* @param {string} [authorization] Bearer Token
|
|
246
|
-
* @param {
|
|
247
|
-
* @param {
|
|
248
|
-
* @param {
|
|
249
|
-
* @param {
|
|
250
|
-
* @param {
|
|
251
|
-
* @param {
|
|
249
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
250
|
+
* @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.
|
|
251
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
252
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
253
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
254
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
252
255
|
* @param {*} [options] Override http request option.
|
|
253
256
|
* @throws {RequiredError}
|
|
254
257
|
*/
|
|
@@ -266,14 +269,15 @@ var InvoicesApiFp = function (configuration) {
|
|
|
266
269
|
});
|
|
267
270
|
},
|
|
268
271
|
/**
|
|
269
|
-
*
|
|
272
|
+
* 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.
|
|
273
|
+
* @summary List policies billing dates
|
|
270
274
|
* @param {string} [authorization] Bearer Token
|
|
271
|
-
* @param {
|
|
272
|
-
* @param {
|
|
273
|
-
* @param {
|
|
274
|
-
* @param {
|
|
275
|
-
* @param {
|
|
276
|
-
* @param {
|
|
275
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
276
|
+
* @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.
|
|
277
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
278
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
279
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
280
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
277
281
|
* @param {*} [options] Override http request option.
|
|
278
282
|
* @throws {RequiredError}
|
|
279
283
|
*/
|
|
@@ -301,14 +305,15 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
301
305
|
var localVarFp = (0, exports.InvoicesApiFp)(configuration);
|
|
302
306
|
return {
|
|
303
307
|
/**
|
|
304
|
-
*
|
|
308
|
+
* 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.
|
|
309
|
+
* @summary List invoices
|
|
305
310
|
* @param {string} [authorization] Bearer Token
|
|
306
|
-
* @param {
|
|
307
|
-
* @param {
|
|
308
|
-
* @param {
|
|
309
|
-
* @param {
|
|
310
|
-
* @param {
|
|
311
|
-
* @param {
|
|
311
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
312
|
+
* @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.
|
|
313
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
314
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
315
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
316
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
312
317
|
* @param {*} [options] Override http request option.
|
|
313
318
|
* @throws {RequiredError}
|
|
314
319
|
*/
|
|
@@ -316,14 +321,15 @@ var InvoicesApiFactory = function (configuration, basePath, axios) {
|
|
|
316
321
|
return localVarFp.listInvoices(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
|
|
317
322
|
},
|
|
318
323
|
/**
|
|
319
|
-
*
|
|
324
|
+
* 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.
|
|
325
|
+
* @summary List policies billing dates
|
|
320
326
|
* @param {string} [authorization] Bearer Token
|
|
321
|
-
* @param {
|
|
322
|
-
* @param {
|
|
323
|
-
* @param {
|
|
324
|
-
* @param {
|
|
325
|
-
* @param {
|
|
326
|
-
* @param {
|
|
327
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
328
|
+
* @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.
|
|
329
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
330
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
331
|
+
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
332
|
+
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
327
333
|
* @param {*} [options] Override http request option.
|
|
328
334
|
* @throws {RequiredError}
|
|
329
335
|
*/
|
|
@@ -345,7 +351,8 @@ var InvoicesApi = /** @class */ (function (_super) {
|
|
|
345
351
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
346
352
|
}
|
|
347
353
|
/**
|
|
348
|
-
*
|
|
354
|
+
* 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.
|
|
355
|
+
* @summary List invoices
|
|
349
356
|
* @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
|
|
350
357
|
* @param {*} [options] Override http request option.
|
|
351
358
|
* @throws {RequiredError}
|
|
@@ -357,7 +364,8 @@ var InvoicesApi = /** @class */ (function (_super) {
|
|
|
357
364
|
return (0, exports.InvoicesApiFp)(this.configuration).listInvoices(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
358
365
|
};
|
|
359
366
|
/**
|
|
360
|
-
*
|
|
367
|
+
* 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.
|
|
368
|
+
* @summary List policies billing dates
|
|
361
369
|
* @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
|
|
362
370
|
* @param {*} [options] Override http request option.
|
|
363
371
|
* @throws {RequiredError}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* The EMIL BillingService API description
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 1.0
|
|
6
|
-
*
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
@@ -20,13 +20,15 @@ import { CreateInvoiceResponseClass } from '../models';
|
|
|
20
20
|
*/
|
|
21
21
|
export declare const RecurringInvoicesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* This will create recurring invoice. It will be generated on a cyclical basis during the lifetime of a policy.
|
|
24
|
+
* @summary Create the recurring invoice
|
|
24
25
|
* @param {CreateInvoiceRequestDto} createInvoiceRequestDto
|
|
25
26
|
* @param {string} [authorization] Bearer Token
|
|
27
|
+
* @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
26
28
|
* @param {*} [options] Override http request option.
|
|
27
29
|
* @throws {RequiredError}
|
|
28
30
|
*/
|
|
29
|
-
createRecurringInvoice: (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
|
+
createRecurringInvoice: (createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30
32
|
};
|
|
31
33
|
/**
|
|
32
34
|
* RecurringInvoicesApi - functional programming interface
|
|
@@ -34,13 +36,15 @@ export declare const RecurringInvoicesApiAxiosParamCreator: (configuration?: Con
|
|
|
34
36
|
*/
|
|
35
37
|
export declare const RecurringInvoicesApiFp: (configuration?: Configuration) => {
|
|
36
38
|
/**
|
|
37
|
-
*
|
|
39
|
+
* This will create recurring invoice. It will be generated on a cyclical basis during the lifetime of a policy.
|
|
40
|
+
* @summary Create the recurring invoice
|
|
38
41
|
* @param {CreateInvoiceRequestDto} createInvoiceRequestDto
|
|
39
42
|
* @param {string} [authorization] Bearer Token
|
|
43
|
+
* @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
40
44
|
* @param {*} [options] Override http request option.
|
|
41
45
|
* @throws {RequiredError}
|
|
42
46
|
*/
|
|
43
|
-
createRecurringInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInvoiceResponseClass>>;
|
|
47
|
+
createRecurringInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInvoiceResponseClass>>;
|
|
44
48
|
};
|
|
45
49
|
/**
|
|
46
50
|
* RecurringInvoicesApi - factory interface
|
|
@@ -48,13 +52,15 @@ export declare const RecurringInvoicesApiFp: (configuration?: Configuration) =>
|
|
|
48
52
|
*/
|
|
49
53
|
export declare const RecurringInvoicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
50
54
|
/**
|
|
51
|
-
*
|
|
55
|
+
* This will create recurring invoice. It will be generated on a cyclical basis during the lifetime of a policy.
|
|
56
|
+
* @summary Create the recurring invoice
|
|
52
57
|
* @param {CreateInvoiceRequestDto} createInvoiceRequestDto
|
|
53
58
|
* @param {string} [authorization] Bearer Token
|
|
59
|
+
* @param {string} [idempotencyKey] Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
54
60
|
* @param {*} [options] Override http request option.
|
|
55
61
|
* @throws {RequiredError}
|
|
56
62
|
*/
|
|
57
|
-
createRecurringInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, options?: any): AxiosPromise<CreateInvoiceResponseClass>;
|
|
63
|
+
createRecurringInvoice(createInvoiceRequestDto: CreateInvoiceRequestDto, authorization?: string, idempotencyKey?: string, options?: any): AxiosPromise<CreateInvoiceResponseClass>;
|
|
58
64
|
};
|
|
59
65
|
/**
|
|
60
66
|
* Request parameters for createRecurringInvoice operation in RecurringInvoicesApi.
|
|
@@ -74,6 +80,12 @@ export interface RecurringInvoicesApiCreateRecurringInvoiceRequest {
|
|
|
74
80
|
* @memberof RecurringInvoicesApiCreateRecurringInvoice
|
|
75
81
|
*/
|
|
76
82
|
readonly authorization?: string;
|
|
83
|
+
/**
|
|
84
|
+
* Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof RecurringInvoicesApiCreateRecurringInvoice
|
|
87
|
+
*/
|
|
88
|
+
readonly idempotencyKey?: string;
|
|
77
89
|
}
|
|
78
90
|
/**
|
|
79
91
|
* RecurringInvoicesApi - object-oriented interface
|
|
@@ -83,7 +95,8 @@ export interface RecurringInvoicesApiCreateRecurringInvoiceRequest {
|
|
|
83
95
|
*/
|
|
84
96
|
export declare class RecurringInvoicesApi extends BaseAPI {
|
|
85
97
|
/**
|
|
86
|
-
*
|
|
98
|
+
* This will create recurring invoice. It will be generated on a cyclical basis during the lifetime of a policy.
|
|
99
|
+
* @summary Create the recurring invoice
|
|
87
100
|
* @param {RecurringInvoicesApiCreateRecurringInvoiceRequest} requestParameters Request parameters.
|
|
88
101
|
* @param {*} [options] Override http request option.
|
|
89
102
|
* @throws {RequiredError}
|