@emilgroup/payment-sdk-node 1.21.1-beta.2 → 1.21.1-beta.20
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 +12 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +79 -37
- package/api/bank-orders-api.ts +695 -0
- package/api/bank-transaction-api.ts +187 -56
- package/api/payment-methods-api.ts +67 -25
- package/api/payment-reminders-api.ts +85 -43
- package/api/payment-setup-api.ts +8 -8
- package/api/payments-api.ts +67 -25
- package/api/refunds-api.ts +57 -29
- package/api/tenant-bank-account-api.ts +45 -17
- package/api/webhooks-api.ts +4 -4
- package/api.ts +2 -0
- package/base.ts +1 -1
- package/dist/api/bank-accounts-api.d.ts +59 -32
- package/dist/api/bank-accounts-api.js +53 -35
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +646 -0
- package/dist/api/bank-transaction-api.d.ts +123 -49
- package/dist/api/bank-transaction-api.js +151 -47
- package/dist/api/payment-methods-api.d.ts +47 -20
- package/dist/api/payment-methods-api.js +41 -23
- package/dist/api/payment-reminders-api.d.ts +61 -34
- package/dist/api/payment-reminders-api.js +54 -36
- package/dist/api/payment-setup-api.d.ts +8 -8
- package/dist/api/payment-setup-api.js +8 -8
- package/dist/api/payments-api.d.ts +47 -20
- package/dist/api/payments-api.js +41 -23
- package/dist/api/refunds-api.d.ts +40 -22
- package/dist/api/refunds-api.js +36 -24
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api/webhooks-api.d.ts +4 -4
- package/dist/api/webhooks-api.js +4 -4
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-order-class.js +15 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +8 -2
- package/dist/models/bank-transaction-class.d.ts +22 -2
- package/dist/models/create-bank-order-request-dto.d.ts +74 -0
- package/dist/models/create-bank-order-request-dto.js +28 -0
- package/dist/models/create-bank-order-response-class.d.ts +25 -0
- package/dist/models/create-bank-order-response-class.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-psp-payment-method-request-dto.d.ts +7 -1
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
- package/dist/models/get-bank-order-response-class.d.ts +25 -0
- package/dist/models/get-bank-order-response-class.js +15 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
- package/dist/models/invoice-match-suggestion-class.js +15 -0
- package/dist/models/list-bank-orders-response-class.d.ts +31 -0
- package/dist/models/list-bank-orders-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
- package/dist/models/payment-class.d.ts +7 -1
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/refund-class.d.ts +7 -1
- package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
- package/dist/models/suggestion-generation-progress-class.js +22 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +8 -2
- package/dist/models/update-bank-order-request-dto.d.ts +56 -0
- package/dist/models/update-bank-order-request-dto.js +23 -0
- package/dist/models/update-bank-order-response-class.d.ts +25 -0
- package/dist/models/update-bank-order-response-class.js +15 -0
- package/models/bank-order-class.ts +121 -0
- package/models/bank-transaction-class-without-expand-properties.ts +8 -2
- package/models/bank-transaction-class.ts +22 -2
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-psp-payment-method-request-dto.ts +7 -1
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/financial-account-class.ts +120 -0
- package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
- package/models/get-bank-order-response-class.ts +31 -0
- package/models/index.ts +11 -0
- package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
- package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-reminder-class.ts +7 -1
- package/models/refund-class.ts +7 -1
- package/models/suggestion-generation-progress-class.ts +52 -0
- package/models/unlinked-bank-transaction-response-class.ts +8 -2
- package/models/update-bank-order-request-dto.ts +65 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
|
@@ -24,7 +24,7 @@ import { ListPaymentRemindersResponseClass } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
* This will create a payment reminder in the database.
|
|
27
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
28
28
|
* @summary Create the payment reminder
|
|
29
29
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
30
30
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -33,7 +33,7 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
|
|
|
33
33
|
*/
|
|
34
34
|
createPaymentReminder: (createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
35
|
/**
|
|
36
|
-
* This will deactivate the payment reminder
|
|
36
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
37
37
|
* @summary Deactivate payment reminder
|
|
38
38
|
* @param {string} code Unique identifier for the object.
|
|
39
39
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -43,26 +43,29 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
|
|
|
43
43
|
*/
|
|
44
44
|
deactivatePaymentReminder: (code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
45
|
/**
|
|
46
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
46
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
47
47
|
* @summary Retrieve the payment reminder
|
|
48
48
|
* @param {string} code
|
|
49
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
50
|
* @param {*} [options] Override http request option.
|
|
51
51
|
* @throws {RequiredError}
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
getPaymentReminder: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
54
54
|
/**
|
|
55
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
55
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
56
56
|
* @summary List payment reminders
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @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.
|
|
58
60
|
* @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, id, policyCode, nextReminderDate</i>
|
|
59
|
-
* @param {string} [
|
|
61
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
62
|
* @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: id, createdAt, updatedAt</i>
|
|
61
63
|
* @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/>
|
|
64
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
62
65
|
* @param {*} [options] Override http request option.
|
|
63
66
|
* @throws {RequiredError}
|
|
64
67
|
*/
|
|
65
|
-
listPaymentReminders: (authorization?: string, filter?: string,
|
|
68
|
+
listPaymentReminders: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
69
|
};
|
|
67
70
|
/**
|
|
68
71
|
* PaymentRemindersApi - functional programming interface
|
|
@@ -70,7 +73,7 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
|
|
|
70
73
|
*/
|
|
71
74
|
export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
72
75
|
/**
|
|
73
|
-
* This will create a payment reminder in the database.
|
|
76
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
74
77
|
* @summary Create the payment reminder
|
|
75
78
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
76
79
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -79,7 +82,7 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
|
79
82
|
*/
|
|
80
83
|
createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentReminderResponseClass>>;
|
|
81
84
|
/**
|
|
82
|
-
* This will deactivate the payment reminder
|
|
85
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
83
86
|
* @summary Deactivate payment reminder
|
|
84
87
|
* @param {string} code Unique identifier for the object.
|
|
85
88
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -89,26 +92,29 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
|
89
92
|
*/
|
|
90
93
|
deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeactivatePaymentReminderResponseClass>>;
|
|
91
94
|
/**
|
|
92
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
95
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
93
96
|
* @summary Retrieve the payment reminder
|
|
94
97
|
* @param {string} code
|
|
95
98
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
96
99
|
* @param {*} [options] Override http request option.
|
|
97
100
|
* @throws {RequiredError}
|
|
98
101
|
*/
|
|
99
|
-
|
|
102
|
+
getPaymentReminder(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>>;
|
|
100
103
|
/**
|
|
101
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
104
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
102
105
|
* @summary List payment reminders
|
|
103
106
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
107
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
108
|
+
* @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.
|
|
104
109
|
* @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, id, policyCode, nextReminderDate</i>
|
|
105
|
-
* @param {string} [
|
|
110
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
106
111
|
* @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: id, createdAt, updatedAt</i>
|
|
107
112
|
* @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/>
|
|
113
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
108
114
|
* @param {*} [options] Override http request option.
|
|
109
115
|
* @throws {RequiredError}
|
|
110
116
|
*/
|
|
111
|
-
listPaymentReminders(authorization?: string, filter?: string,
|
|
117
|
+
listPaymentReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentRemindersResponseClass>>;
|
|
112
118
|
};
|
|
113
119
|
/**
|
|
114
120
|
* PaymentRemindersApi - factory interface
|
|
@@ -116,7 +122,7 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
|
116
122
|
*/
|
|
117
123
|
export declare const PaymentRemindersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
118
124
|
/**
|
|
119
|
-
* This will create a payment reminder in the database.
|
|
125
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
120
126
|
* @summary Create the payment reminder
|
|
121
127
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
122
128
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -125,7 +131,7 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
|
|
|
125
131
|
*/
|
|
126
132
|
createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentReminderResponseClass>;
|
|
127
133
|
/**
|
|
128
|
-
* This will deactivate the payment reminder
|
|
134
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
129
135
|
* @summary Deactivate payment reminder
|
|
130
136
|
* @param {string} code Unique identifier for the object.
|
|
131
137
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -135,26 +141,29 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
|
|
|
135
141
|
*/
|
|
136
142
|
deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<DeactivatePaymentReminderResponseClass>;
|
|
137
143
|
/**
|
|
138
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
144
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
139
145
|
* @summary Retrieve the payment reminder
|
|
140
146
|
* @param {string} code
|
|
141
147
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
142
148
|
* @param {*} [options] Override http request option.
|
|
143
149
|
* @throws {RequiredError}
|
|
144
150
|
*/
|
|
145
|
-
|
|
151
|
+
getPaymentReminder(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass>;
|
|
146
152
|
/**
|
|
147
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
153
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
148
154
|
* @summary List payment reminders
|
|
149
155
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
156
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
157
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
150
158
|
* @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, id, policyCode, nextReminderDate</i>
|
|
151
|
-
* @param {string} [
|
|
159
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
152
160
|
* @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: id, createdAt, updatedAt</i>
|
|
153
161
|
* @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/>
|
|
162
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
154
163
|
* @param {*} [options] Override http request option.
|
|
155
164
|
* @throws {RequiredError}
|
|
156
165
|
*/
|
|
157
|
-
listPaymentReminders(authorization?: string, filter?: string,
|
|
166
|
+
listPaymentReminders(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentRemindersResponseClass>;
|
|
158
167
|
};
|
|
159
168
|
/**
|
|
160
169
|
* Request parameters for createPaymentReminder operation in PaymentRemindersApi.
|
|
@@ -201,21 +210,21 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
|
|
|
201
210
|
readonly authorization?: string;
|
|
202
211
|
}
|
|
203
212
|
/**
|
|
204
|
-
* Request parameters for
|
|
213
|
+
* Request parameters for getPaymentReminder operation in PaymentRemindersApi.
|
|
205
214
|
* @export
|
|
206
|
-
* @interface
|
|
215
|
+
* @interface PaymentRemindersApiGetPaymentReminderRequest
|
|
207
216
|
*/
|
|
208
|
-
export interface
|
|
217
|
+
export interface PaymentRemindersApiGetPaymentReminderRequest {
|
|
209
218
|
/**
|
|
210
219
|
*
|
|
211
220
|
* @type {string}
|
|
212
|
-
* @memberof
|
|
221
|
+
* @memberof PaymentRemindersApiGetPaymentReminder
|
|
213
222
|
*/
|
|
214
223
|
readonly code: string;
|
|
215
224
|
/**
|
|
216
225
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
217
226
|
* @type {string}
|
|
218
|
-
* @memberof
|
|
227
|
+
* @memberof PaymentRemindersApiGetPaymentReminder
|
|
219
228
|
*/
|
|
220
229
|
readonly authorization?: string;
|
|
221
230
|
}
|
|
@@ -231,6 +240,18 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
231
240
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
232
241
|
*/
|
|
233
242
|
readonly authorization?: string;
|
|
243
|
+
/**
|
|
244
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
|
+
* @type {number}
|
|
246
|
+
* @memberof PaymentRemindersApiListPaymentReminders
|
|
247
|
+
*/
|
|
248
|
+
readonly pageSize?: number;
|
|
249
|
+
/**
|
|
250
|
+
* 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
|
+
* @type {string}
|
|
252
|
+
* @memberof PaymentRemindersApiListPaymentReminders
|
|
253
|
+
*/
|
|
254
|
+
readonly pageToken?: string;
|
|
234
255
|
/**
|
|
235
256
|
* 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, id, policyCode, nextReminderDate</i>
|
|
236
257
|
* @type {string}
|
|
@@ -238,11 +259,11 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
238
259
|
*/
|
|
239
260
|
readonly filter?: string;
|
|
240
261
|
/**
|
|
241
|
-
*
|
|
262
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
242
263
|
* @type {string}
|
|
243
264
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
244
265
|
*/
|
|
245
|
-
readonly
|
|
266
|
+
readonly search?: string;
|
|
246
267
|
/**
|
|
247
268
|
* 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: id, createdAt, updatedAt</i>
|
|
248
269
|
* @type {string}
|
|
@@ -255,6 +276,12 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
255
276
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
256
277
|
*/
|
|
257
278
|
readonly expand?: string;
|
|
279
|
+
/**
|
|
280
|
+
* 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, id, policyCode, nextReminderDate</i>
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof PaymentRemindersApiListPaymentReminders
|
|
283
|
+
*/
|
|
284
|
+
readonly filters?: string;
|
|
258
285
|
}
|
|
259
286
|
/**
|
|
260
287
|
* PaymentRemindersApi - object-oriented interface
|
|
@@ -264,7 +291,7 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
264
291
|
*/
|
|
265
292
|
export declare class PaymentRemindersApi extends BaseAPI {
|
|
266
293
|
/**
|
|
267
|
-
* This will create a payment reminder in the database.
|
|
294
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
268
295
|
* @summary Create the payment reminder
|
|
269
296
|
* @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
|
|
270
297
|
* @param {*} [options] Override http request option.
|
|
@@ -273,7 +300,7 @@ export declare class PaymentRemindersApi extends BaseAPI {
|
|
|
273
300
|
*/
|
|
274
301
|
createPaymentReminder(requestParameters: PaymentRemindersApiCreatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentReminderResponseClass, any>>;
|
|
275
302
|
/**
|
|
276
|
-
* This will deactivate the payment reminder
|
|
303
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
277
304
|
* @summary Deactivate payment reminder
|
|
278
305
|
* @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
|
|
279
306
|
* @param {*} [options] Override http request option.
|
|
@@ -282,16 +309,16 @@ export declare class PaymentRemindersApi extends BaseAPI {
|
|
|
282
309
|
*/
|
|
283
310
|
deactivatePaymentReminder(requestParameters: PaymentRemindersApiDeactivatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeactivatePaymentReminderResponseClass, any>>;
|
|
284
311
|
/**
|
|
285
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
312
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
286
313
|
* @summary Retrieve the payment reminder
|
|
287
|
-
* @param {
|
|
314
|
+
* @param {PaymentRemindersApiGetPaymentReminderRequest} requestParameters Request parameters.
|
|
288
315
|
* @param {*} [options] Override http request option.
|
|
289
316
|
* @throws {RequiredError}
|
|
290
317
|
* @memberof PaymentRemindersApi
|
|
291
318
|
*/
|
|
292
|
-
|
|
319
|
+
getPaymentReminder(requestParameters: PaymentRemindersApiGetPaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentReminderResponseClass, any>>;
|
|
293
320
|
/**
|
|
294
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
321
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
295
322
|
* @summary List payment reminders
|
|
296
323
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
297
324
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* This will create a payment reminder in the database.
|
|
100
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
101
101
|
* @summary Create the payment reminder
|
|
102
102
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
103
103
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -146,7 +146,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
146
146
|
});
|
|
147
147
|
},
|
|
148
148
|
/**
|
|
149
|
-
* This will deactivate the payment reminder
|
|
149
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
150
150
|
* @summary Deactivate payment reminder
|
|
151
151
|
* @param {string} code Unique identifier for the object.
|
|
152
152
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -199,14 +199,14 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
199
199
|
});
|
|
200
200
|
},
|
|
201
201
|
/**
|
|
202
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
202
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
203
203
|
* @summary Retrieve the payment reminder
|
|
204
204
|
* @param {string} code
|
|
205
205
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
206
206
|
* @param {*} [options] Override http request option.
|
|
207
207
|
* @throws {RequiredError}
|
|
208
208
|
*/
|
|
209
|
-
|
|
209
|
+
getPaymentReminder: function (code, authorization, options) {
|
|
210
210
|
if (options === void 0) { options = {}; }
|
|
211
211
|
return __awaiter(_this, void 0, void 0, function () {
|
|
212
212
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -214,7 +214,7 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
214
214
|
switch (_a.label) {
|
|
215
215
|
case 0:
|
|
216
216
|
// verify required parameter 'code' is not null or undefined
|
|
217
|
-
(0, common_1.assertParamExists)('
|
|
217
|
+
(0, common_1.assertParamExists)('getPaymentReminder', 'code', code);
|
|
218
218
|
localVarPath = "/paymentservice/v1/payment-reminders/{code}"
|
|
219
219
|
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
220
220
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -247,17 +247,20 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
247
247
|
});
|
|
248
248
|
},
|
|
249
249
|
/**
|
|
250
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
250
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
251
251
|
* @summary List payment reminders
|
|
252
252
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
253
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
254
|
+
* @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.
|
|
253
255
|
* @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, id, policyCode, nextReminderDate</i>
|
|
254
|
-
* @param {string} [
|
|
256
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
255
257
|
* @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: id, createdAt, updatedAt</i>
|
|
256
258
|
* @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/>
|
|
259
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
257
260
|
* @param {*} [options] Override http request option.
|
|
258
261
|
* @throws {RequiredError}
|
|
259
262
|
*/
|
|
260
|
-
listPaymentReminders: function (authorization, filter,
|
|
263
|
+
listPaymentReminders: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
261
264
|
if (options === void 0) { options = {}; }
|
|
262
265
|
return __awaiter(_this, void 0, void 0, function () {
|
|
263
266
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -280,11 +283,17 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
280
283
|
// authentication bearer required
|
|
281
284
|
// http bearer authentication required
|
|
282
285
|
_a.sent();
|
|
286
|
+
if (pageSize !== undefined) {
|
|
287
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
288
|
+
}
|
|
289
|
+
if (pageToken !== undefined) {
|
|
290
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
291
|
+
}
|
|
283
292
|
if (filter !== undefined) {
|
|
284
293
|
localVarQueryParameter['filter'] = filter;
|
|
285
294
|
}
|
|
286
|
-
if (
|
|
287
|
-
localVarQueryParameter['
|
|
295
|
+
if (search !== undefined) {
|
|
296
|
+
localVarQueryParameter['search'] = search;
|
|
288
297
|
}
|
|
289
298
|
if (order !== undefined) {
|
|
290
299
|
localVarQueryParameter['order'] = order;
|
|
@@ -292,6 +301,9 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
292
301
|
if (expand !== undefined) {
|
|
293
302
|
localVarQueryParameter['expand'] = expand;
|
|
294
303
|
}
|
|
304
|
+
if (filters !== undefined) {
|
|
305
|
+
localVarQueryParameter['filters'] = filters;
|
|
306
|
+
}
|
|
295
307
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
296
308
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
297
309
|
}
|
|
@@ -317,7 +329,7 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
317
329
|
var localVarAxiosParamCreator = (0, exports.PaymentRemindersApiAxiosParamCreator)(configuration);
|
|
318
330
|
return {
|
|
319
331
|
/**
|
|
320
|
-
* This will create a payment reminder in the database.
|
|
332
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
321
333
|
* @summary Create the payment reminder
|
|
322
334
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
323
335
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -338,7 +350,7 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
338
350
|
});
|
|
339
351
|
},
|
|
340
352
|
/**
|
|
341
|
-
* This will deactivate the payment reminder
|
|
353
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
342
354
|
* @summary Deactivate payment reminder
|
|
343
355
|
* @param {string} code Unique identifier for the object.
|
|
344
356
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -360,19 +372,19 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
360
372
|
});
|
|
361
373
|
},
|
|
362
374
|
/**
|
|
363
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
375
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
364
376
|
* @summary Retrieve the payment reminder
|
|
365
377
|
* @param {string} code
|
|
366
378
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
379
|
* @param {*} [options] Override http request option.
|
|
368
380
|
* @throws {RequiredError}
|
|
369
381
|
*/
|
|
370
|
-
|
|
382
|
+
getPaymentReminder: function (code, authorization, options) {
|
|
371
383
|
return __awaiter(this, void 0, void 0, function () {
|
|
372
384
|
var localVarAxiosArgs;
|
|
373
385
|
return __generator(this, function (_a) {
|
|
374
386
|
switch (_a.label) {
|
|
375
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.
|
|
387
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPaymentReminder(code, authorization, options)];
|
|
376
388
|
case 1:
|
|
377
389
|
localVarAxiosArgs = _a.sent();
|
|
378
390
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -381,22 +393,25 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
381
393
|
});
|
|
382
394
|
},
|
|
383
395
|
/**
|
|
384
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
396
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
385
397
|
* @summary List payment reminders
|
|
386
398
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
399
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
400
|
+
* @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.
|
|
387
401
|
* @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, id, policyCode, nextReminderDate</i>
|
|
388
|
-
* @param {string} [
|
|
402
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
389
403
|
* @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: id, createdAt, updatedAt</i>
|
|
390
404
|
* @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/>
|
|
405
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
391
406
|
* @param {*} [options] Override http request option.
|
|
392
407
|
* @throws {RequiredError}
|
|
393
408
|
*/
|
|
394
|
-
listPaymentReminders: function (authorization, filter,
|
|
409
|
+
listPaymentReminders: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
395
410
|
return __awaiter(this, void 0, void 0, function () {
|
|
396
411
|
var localVarAxiosArgs;
|
|
397
412
|
return __generator(this, function (_a) {
|
|
398
413
|
switch (_a.label) {
|
|
399
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentReminders(authorization, filter,
|
|
414
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
400
415
|
case 1:
|
|
401
416
|
localVarAxiosArgs = _a.sent();
|
|
402
417
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -415,7 +430,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
415
430
|
var localVarFp = (0, exports.PaymentRemindersApiFp)(configuration);
|
|
416
431
|
return {
|
|
417
432
|
/**
|
|
418
|
-
* This will create a payment reminder in the database.
|
|
433
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
419
434
|
* @summary Create the payment reminder
|
|
420
435
|
* @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
|
|
421
436
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -426,7 +441,7 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
426
441
|
return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
427
442
|
},
|
|
428
443
|
/**
|
|
429
|
-
* This will deactivate the payment reminder
|
|
444
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
430
445
|
* @summary Deactivate payment reminder
|
|
431
446
|
* @param {string} code Unique identifier for the object.
|
|
432
447
|
* @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
|
|
@@ -438,29 +453,32 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
438
453
|
return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
439
454
|
},
|
|
440
455
|
/**
|
|
441
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
456
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
442
457
|
* @summary Retrieve the payment reminder
|
|
443
458
|
* @param {string} code
|
|
444
459
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
445
460
|
* @param {*} [options] Override http request option.
|
|
446
461
|
* @throws {RequiredError}
|
|
447
462
|
*/
|
|
448
|
-
|
|
449
|
-
return localVarFp.
|
|
463
|
+
getPaymentReminder: function (code, authorization, options) {
|
|
464
|
+
return localVarFp.getPaymentReminder(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
450
465
|
},
|
|
451
466
|
/**
|
|
452
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
467
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
453
468
|
* @summary List payment reminders
|
|
454
469
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
470
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
471
|
+
* @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.
|
|
455
472
|
* @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, id, policyCode, nextReminderDate</i>
|
|
456
|
-
* @param {string} [
|
|
473
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
457
474
|
* @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: id, createdAt, updatedAt</i>
|
|
458
475
|
* @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/>
|
|
476
|
+
* @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, id, policyCode, nextReminderDate</i>
|
|
459
477
|
* @param {*} [options] Override http request option.
|
|
460
478
|
* @throws {RequiredError}
|
|
461
479
|
*/
|
|
462
|
-
listPaymentReminders: function (authorization, filter,
|
|
463
|
-
return localVarFp.listPaymentReminders(authorization, filter,
|
|
480
|
+
listPaymentReminders: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
481
|
+
return localVarFp.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
464
482
|
},
|
|
465
483
|
};
|
|
466
484
|
};
|
|
@@ -477,7 +495,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
477
495
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
478
496
|
}
|
|
479
497
|
/**
|
|
480
|
-
* This will create a payment reminder in the database.
|
|
498
|
+
* This will create a payment reminder in the database. **Required Permissions** \"payment-management.reminders.create\"
|
|
481
499
|
* @summary Create the payment reminder
|
|
482
500
|
* @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
|
|
483
501
|
* @param {*} [options] Override http request option.
|
|
@@ -489,7 +507,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
489
507
|
return (0, exports.PaymentRemindersApiFp)(this.configuration).createPaymentReminder(requestParameters.createPaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
490
508
|
};
|
|
491
509
|
/**
|
|
492
|
-
* This will deactivate the payment reminder
|
|
510
|
+
* This will deactivate the payment reminder **Required Permissions** \"payment-management.reminders.update\"
|
|
493
511
|
* @summary Deactivate payment reminder
|
|
494
512
|
* @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
|
|
495
513
|
* @param {*} [options] Override http request option.
|
|
@@ -501,19 +519,19 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
501
519
|
return (0, exports.PaymentRemindersApiFp)(this.configuration).deactivatePaymentReminder(requestParameters.code, requestParameters.deactivatePaymentReminderRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
502
520
|
};
|
|
503
521
|
/**
|
|
504
|
-
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
|
|
522
|
+
* Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information. **Required Permissions** \"payment-management.reminders.view\"
|
|
505
523
|
* @summary Retrieve the payment reminder
|
|
506
|
-
* @param {
|
|
524
|
+
* @param {PaymentRemindersApiGetPaymentReminderRequest} requestParameters Request parameters.
|
|
507
525
|
* @param {*} [options] Override http request option.
|
|
508
526
|
* @throws {RequiredError}
|
|
509
527
|
* @memberof PaymentRemindersApi
|
|
510
528
|
*/
|
|
511
|
-
PaymentRemindersApi.prototype.
|
|
529
|
+
PaymentRemindersApi.prototype.getPaymentReminder = function (requestParameters, options) {
|
|
512
530
|
var _this = this;
|
|
513
|
-
return (0, exports.PaymentRemindersApiFp)(this.configuration).
|
|
531
|
+
return (0, exports.PaymentRemindersApiFp)(this.configuration).getPaymentReminder(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
514
532
|
};
|
|
515
533
|
/**
|
|
516
|
-
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
534
|
+
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.reminders.view\"
|
|
517
535
|
* @summary List payment reminders
|
|
518
536
|
* @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
|
|
519
537
|
* @param {*} [options] Override http request option.
|
|
@@ -523,7 +541,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
523
541
|
PaymentRemindersApi.prototype.listPaymentReminders = function (requestParameters, options) {
|
|
524
542
|
var _this = this;
|
|
525
543
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
526
|
-
return (0, exports.PaymentRemindersApiFp)(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
544
|
+
return (0, exports.PaymentRemindersApiFp)(this.configuration).listPaymentReminders(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); });
|
|
527
545
|
};
|
|
528
546
|
return PaymentRemindersApi;
|
|
529
547
|
}(base_1.BaseAPI));
|