@emilgroup/payment-sdk 1.13.1-beta.1 → 1.13.1-beta.100
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 +34 -1
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +55 -13
- package/api/bank-orders-api.ts +691 -0
- package/api/bank-transaction-api.ts +177 -63
- package/api/exceeding-credits-api.ts +349 -0
- package/api/payment-methods-api.ts +59 -17
- package/api/payment-reminders-api.ts +55 -13
- package/api/payments-api.ts +188 -21
- package/api/policy-payment-methods-api.ts +353 -0
- package/api/refunds-api.ts +45 -17
- package/api/tenant-bank-account-api.ts +45 -17
- package/api.ts +6 -0
- package/base.ts +52 -3
- package/dist/api/bank-accounts-api.d.ts +35 -8
- package/dist/api/bank-accounts-api.js +29 -11
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +642 -0
- package/dist/api/bank-transaction-api.d.ts +110 -46
- package/dist/api/bank-transaction-api.js +141 -44
- package/dist/api/exceeding-credits-api.d.ts +206 -0
- package/dist/api/exceeding-credits-api.js +352 -0
- package/dist/api/payment-methods-api.d.ts +39 -12
- package/dist/api/payment-methods-api.js +32 -14
- package/dist/api/payment-reminders-api.d.ts +35 -8
- package/dist/api/payment-reminders-api.js +29 -11
- package/dist/api/payments-api.d.ts +112 -16
- package/dist/api/payments-api.js +141 -18
- package/dist/api/policy-payment-methods-api.d.ts +207 -0
- package/dist/api/policy-payment-methods-api.js +353 -0
- package/dist/api/refunds-api.d.ts +28 -10
- package/dist/api/refunds-api.js +24 -12
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/base.d.ts +10 -1
- package/dist/base.js +46 -2
- package/dist/models/bank-order-class.d.ts +122 -0
- package/dist/models/bank-order-xml-file-class.d.ts +72 -0
- package/dist/models/bank-order-xml-file-class.js +15 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +18 -18
- package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
- package/dist/models/bank-transaction-class.d.ts +36 -22
- package/dist/models/bank-transaction-class.js +5 -0
- package/dist/models/bank-transaction-invoice-class.d.ts +60 -0
- package/dist/models/bank-transaction-invoice-class.js +15 -0
- package/dist/models/bank-transfer-dto.d.ts +25 -0
- package/dist/models/bank-transfer-dto.js +15 -0
- package/dist/models/billing-address-dto.d.ts +54 -0
- package/dist/models/billing-address-dto.js +15 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.js +3 -1
- package/dist/models/complete-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/complete-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +7 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +3 -1
- 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-order-dto.d.ts +48 -0
- package/dist/models/create-payment-order-dto.js +15 -0
- package/dist/models/create-payment-order-request-dto.d.ts +48 -0
- package/dist/models/create-payment-order-request-dto.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-policy-payment-method-request-dto.d.ts +30 -0
- package/dist/models/create-policy-payment-method-request-dto.js +15 -0
- package/dist/models/create-policy-payment-method-response-class.d.ts +25 -0
- package/dist/models/create-policy-payment-method-response-class.js +15 -0
- package/dist/models/create-psp-payment-method-request-dto.d.ts +29 -1
- package/dist/models/create-psp-payment-method-request-dto.js +3 -1
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/eis-sepa-debit-dto.d.ts +55 -0
- package/dist/models/eis-sepa-debit-dto.js +15 -0
- package/dist/models/exceeding-credit-class.d.ts +116 -0
- package/dist/models/exceeding-credit-class.js +29 -0
- 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/get-exceeding-credit-response-class.d.ts +25 -0
- package/dist/models/get-exceeding-credit-response-class.js +15 -0
- package/dist/models/index.d.ts +31 -1
- package/dist/models/index.js +31 -1
- 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-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +3 -2
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/{unlink-bank-transaction-request-dto-rest.d.ts → invoice-allocation-dto.d.ts} +10 -4
- package/dist/models/invoice-allocation-dto.js +15 -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/link-bank-transaction-request-dto-rest.d.ts +4 -3
- 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/list-exceeding-credits-response-class.d.ts +31 -0
- package/dist/models/list-exceeding-credits-response-class.js +15 -0
- package/dist/models/list-policy-payment-methods-response-class.d.ts +31 -0
- package/dist/models/list-policy-payment-methods-response-class.js +15 -0
- package/dist/models/mandate-dto.d.ts +43 -0
- package/dist/models/mandate-dto.js +15 -0
- package/dist/models/mandate-hash-data-dto.d.ts +42 -0
- package/dist/models/mandate-hash-data-dto.js +15 -0
- package/dist/models/mandate-reference-class.d.ts +90 -0
- package/dist/models/mandate-reference-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-method-class.d.ts +6 -0
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/policy-payment-method-class.d.ts +86 -0
- package/dist/models/policy-payment-method-class.js +15 -0
- 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 +18 -0
- package/dist/models/unlinked-bank-transaction-response-class.js +5 -0
- package/dist/models/update-bank-order-request-dto.d.ts +62 -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 +128 -0
- package/models/bank-order-xml-file-class.ts +78 -0
- package/models/bank-transaction-class-without-expand-properties.ts +21 -18
- package/models/bank-transaction-class.ts +39 -22
- package/models/bank-transaction-invoice-class.ts +66 -0
- package/models/bank-transfer-dto.ts +31 -0
- package/models/billing-address-dto.ts +60 -0
- package/models/complete-adyen-payment-setup-request-dto.ts +3 -1
- package/models/complete-eis-payment-setup-request-dto.ts +42 -0
- package/models/complete-payment-setup-request-dto.ts +7 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +3 -1
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-order-dto.ts +54 -0
- package/models/create-payment-order-request-dto.ts +54 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-policy-payment-method-request-dto.ts +36 -0
- package/models/create-policy-payment-method-response-class.ts +31 -0
- package/models/create-psp-payment-method-request-dto.ts +30 -2
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/eis-sepa-debit-dto.ts +61 -0
- package/models/exceeding-credit-class.ts +125 -0
- 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/get-exceeding-credit-response-class.ts +31 -0
- package/models/index.ts +31 -1
- 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-eis-payment-setup-request-dto.ts +42 -0
- package/models/initiate-payment-setup-request-dto.ts +3 -2
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/{unlink-bank-transaction-request-dto-rest.ts → invoice-allocation-dto.ts} +10 -4
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/link-bank-transaction-request-dto-rest.ts +4 -3
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/list-exceeding-credits-response-class.ts +37 -0
- package/models/list-policy-payment-methods-response-class.ts +37 -0
- package/models/mandate-dto.ts +49 -0
- package/models/mandate-hash-data-dto.ts +48 -0
- package/models/mandate-reference-class.ts +96 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-method-class.ts +6 -0
- package/models/payment-reminder-class.ts +7 -1
- package/models/policy-payment-method-class.ts +92 -0
- package/models/refund-class.ts +7 -1
- package/models/suggestion-generation-progress-class.ts +52 -0
- package/models/unlinked-bank-transaction-response-class.ts +21 -0
- package/models/update-bank-order-request-dto.ts +71 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
- /package/dist/models/{unlink-bank-transaction-request-dto-rest.js → bank-order-class.js} +0 -0
|
@@ -55,14 +55,17 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
|
|
|
55
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
|
|
@@ -101,14 +104,17 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
|
101
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
|
|
@@ -147,14 +153,17 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
|
|
|
147
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.
|
|
@@ -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
|
|
@@ -246,14 +246,17 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
246
246
|
* 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\"
|
|
247
247
|
* @summary List payment reminders
|
|
248
248
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
249
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
250
|
+
* @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.
|
|
249
251
|
* @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>
|
|
250
|
-
* @param {string} [
|
|
252
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
251
253
|
* @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>
|
|
252
254
|
* @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/>
|
|
255
|
+
* @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>
|
|
253
256
|
* @param {*} [options] Override http request option.
|
|
254
257
|
* @throws {RequiredError}
|
|
255
258
|
*/
|
|
256
|
-
listPaymentReminders: function (authorization, filter,
|
|
259
|
+
listPaymentReminders: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
257
260
|
if (options === void 0) { options = {}; }
|
|
258
261
|
return __awaiter(_this, void 0, void 0, function () {
|
|
259
262
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -276,11 +279,17 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
276
279
|
// authentication bearer required
|
|
277
280
|
// http bearer authentication required
|
|
278
281
|
_a.sent();
|
|
282
|
+
if (pageSize !== undefined) {
|
|
283
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
284
|
+
}
|
|
285
|
+
if (pageToken !== undefined) {
|
|
286
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
287
|
+
}
|
|
279
288
|
if (filter !== undefined) {
|
|
280
289
|
localVarQueryParameter['filter'] = filter;
|
|
281
290
|
}
|
|
282
|
-
if (
|
|
283
|
-
localVarQueryParameter['
|
|
291
|
+
if (search !== undefined) {
|
|
292
|
+
localVarQueryParameter['search'] = search;
|
|
284
293
|
}
|
|
285
294
|
if (order !== undefined) {
|
|
286
295
|
localVarQueryParameter['order'] = order;
|
|
@@ -288,6 +297,9 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
288
297
|
if (expand !== undefined) {
|
|
289
298
|
localVarQueryParameter['expand'] = expand;
|
|
290
299
|
}
|
|
300
|
+
if (filters !== undefined) {
|
|
301
|
+
localVarQueryParameter['filters'] = filters;
|
|
302
|
+
}
|
|
291
303
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
292
304
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
293
305
|
}
|
|
@@ -380,19 +392,22 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
380
392
|
* 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\"
|
|
381
393
|
* @summary List payment reminders
|
|
382
394
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
395
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
396
|
+
* @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.
|
|
383
397
|
* @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>
|
|
384
|
-
* @param {string} [
|
|
398
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
385
399
|
* @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>
|
|
386
400
|
* @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/>
|
|
401
|
+
* @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>
|
|
387
402
|
* @param {*} [options] Override http request option.
|
|
388
403
|
* @throws {RequiredError}
|
|
389
404
|
*/
|
|
390
|
-
listPaymentReminders: function (authorization, filter,
|
|
405
|
+
listPaymentReminders: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
391
406
|
return __awaiter(this, void 0, void 0, function () {
|
|
392
407
|
var localVarAxiosArgs;
|
|
393
408
|
return __generator(this, function (_a) {
|
|
394
409
|
switch (_a.label) {
|
|
395
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentReminders(authorization, filter,
|
|
410
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
396
411
|
case 1:
|
|
397
412
|
localVarAxiosArgs = _a.sent();
|
|
398
413
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -448,15 +463,18 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
448
463
|
* 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\"
|
|
449
464
|
* @summary List payment reminders
|
|
450
465
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
466
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
467
|
+
* @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.
|
|
451
468
|
* @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>
|
|
452
|
-
* @param {string} [
|
|
469
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
453
470
|
* @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>
|
|
454
471
|
* @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/>
|
|
472
|
+
* @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>
|
|
455
473
|
* @param {*} [options] Override http request option.
|
|
456
474
|
* @throws {RequiredError}
|
|
457
475
|
*/
|
|
458
|
-
listPaymentReminders: function (authorization, filter,
|
|
459
|
-
return localVarFp.listPaymentReminders(authorization, filter,
|
|
476
|
+
listPaymentReminders: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
477
|
+
return localVarFp.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
460
478
|
},
|
|
461
479
|
};
|
|
462
480
|
};
|
|
@@ -519,7 +537,7 @@ var PaymentRemindersApi = /** @class */ (function (_super) {
|
|
|
519
537
|
PaymentRemindersApi.prototype.listPaymentReminders = function (requestParameters, options) {
|
|
520
538
|
var _this = this;
|
|
521
539
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
522
|
-
return (0, exports.PaymentRemindersApiFp)(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
540
|
+
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); });
|
|
523
541
|
};
|
|
524
542
|
return PaymentRemindersApi;
|
|
525
543
|
}(base_1.BaseAPI));
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreatePaymentOrderDto } from '../models';
|
|
15
16
|
import { CreatePaymentRequestDto } from '../models';
|
|
16
17
|
import { CreatePaymentResponseClass } from '../models';
|
|
17
18
|
import { GetPaymentResponseClass } from '../models';
|
|
@@ -22,15 +23,26 @@ import { ListPaymentsResponseClass } from '../models';
|
|
|
22
23
|
*/
|
|
23
24
|
export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
25
|
/**
|
|
25
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
26
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
26
27
|
* @summary Create the payment
|
|
27
28
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
28
29
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
29
30
|
* @param {string} [authorization] Bearer Token
|
|
30
31
|
* @param {*} [options] Override http request option.
|
|
32
|
+
* @deprecated
|
|
31
33
|
* @throws {RequiredError}
|
|
32
34
|
*/
|
|
33
35
|
createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
|
+
/**
|
|
37
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
38
|
+
* @summary Create the payment
|
|
39
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
40
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
41
|
+
* @param {string} [authorization] Bearer Token
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
createPaymentOrder: (idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
46
|
/**
|
|
35
47
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
36
48
|
* @summary Retrieve the payment
|
|
@@ -45,14 +57,17 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
45
57
|
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
46
58
|
* @summary List payments
|
|
47
59
|
* @param {string} [authorization] Bearer Token
|
|
48
|
-
* @param {
|
|
49
|
-
* @param {string} [
|
|
60
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
61
|
+
* @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.
|
|
62
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
63
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
50
64
|
* @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, code, amount</i>
|
|
51
65
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
66
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
52
67
|
* @param {*} [options] Override http request option.
|
|
53
68
|
* @throws {RequiredError}
|
|
54
69
|
*/
|
|
55
|
-
listPayments: (authorization?: string, filter?: string,
|
|
70
|
+
listPayments: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
71
|
};
|
|
57
72
|
/**
|
|
58
73
|
* PaymentsApi - functional programming interface
|
|
@@ -60,15 +75,26 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
60
75
|
*/
|
|
61
76
|
export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
62
77
|
/**
|
|
63
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
78
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
64
79
|
* @summary Create the payment
|
|
65
80
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
66
81
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
67
82
|
* @param {string} [authorization] Bearer Token
|
|
68
83
|
* @param {*} [options] Override http request option.
|
|
84
|
+
* @deprecated
|
|
69
85
|
* @throws {RequiredError}
|
|
70
86
|
*/
|
|
71
87
|
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
|
|
88
|
+
/**
|
|
89
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
90
|
+
* @summary Create the payment
|
|
91
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
92
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
93
|
+
* @param {string} [authorization] Bearer Token
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
|
|
72
98
|
/**
|
|
73
99
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
74
100
|
* @summary Retrieve the payment
|
|
@@ -83,14 +109,17 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
83
109
|
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
84
110
|
* @summary List payments
|
|
85
111
|
* @param {string} [authorization] Bearer Token
|
|
86
|
-
* @param {
|
|
87
|
-
* @param {string} [
|
|
112
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
113
|
+
* @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.
|
|
114
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
115
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
88
116
|
* @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, code, amount</i>
|
|
89
117
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
118
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
90
119
|
* @param {*} [options] Override http request option.
|
|
91
120
|
* @throws {RequiredError}
|
|
92
121
|
*/
|
|
93
|
-
listPayments(authorization?: string, filter?: string,
|
|
122
|
+
listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentsResponseClass>>;
|
|
94
123
|
};
|
|
95
124
|
/**
|
|
96
125
|
* PaymentsApi - factory interface
|
|
@@ -98,15 +127,26 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
98
127
|
*/
|
|
99
128
|
export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
100
129
|
/**
|
|
101
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
130
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
102
131
|
* @summary Create the payment
|
|
103
132
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
104
133
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
105
134
|
* @param {string} [authorization] Bearer Token
|
|
106
135
|
* @param {*} [options] Override http request option.
|
|
136
|
+
* @deprecated
|
|
107
137
|
* @throws {RequiredError}
|
|
108
138
|
*/
|
|
109
139
|
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
|
|
140
|
+
/**
|
|
141
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
142
|
+
* @summary Create the payment
|
|
143
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
144
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
145
|
+
* @param {string} [authorization] Bearer Token
|
|
146
|
+
* @param {*} [options] Override http request option.
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
*/
|
|
149
|
+
createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
|
|
110
150
|
/**
|
|
111
151
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
112
152
|
* @summary Retrieve the payment
|
|
@@ -121,14 +161,17 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
|
|
|
121
161
|
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
122
162
|
* @summary List payments
|
|
123
163
|
* @param {string} [authorization] Bearer Token
|
|
124
|
-
* @param {
|
|
125
|
-
* @param {string} [
|
|
164
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
165
|
+
* @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.
|
|
166
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
167
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
126
168
|
* @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, code, amount</i>
|
|
127
169
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
170
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
128
171
|
* @param {*} [options] Override http request option.
|
|
129
172
|
* @throws {RequiredError}
|
|
130
173
|
*/
|
|
131
|
-
listPayments(authorization?: string, filter?: string,
|
|
174
|
+
listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentsResponseClass>;
|
|
132
175
|
};
|
|
133
176
|
/**
|
|
134
177
|
* Request parameters for createPayment operation in PaymentsApi.
|
|
@@ -155,6 +198,31 @@ export interface PaymentsApiCreatePaymentRequest {
|
|
|
155
198
|
*/
|
|
156
199
|
readonly authorization?: string;
|
|
157
200
|
}
|
|
201
|
+
/**
|
|
202
|
+
* Request parameters for createPaymentOrder operation in PaymentsApi.
|
|
203
|
+
* @export
|
|
204
|
+
* @interface PaymentsApiCreatePaymentOrderRequest
|
|
205
|
+
*/
|
|
206
|
+
export interface PaymentsApiCreatePaymentOrderRequest {
|
|
207
|
+
/**
|
|
208
|
+
* Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
209
|
+
* @type {string}
|
|
210
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
211
|
+
*/
|
|
212
|
+
readonly idempotencyKey: string;
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @type {CreatePaymentOrderDto}
|
|
216
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
217
|
+
*/
|
|
218
|
+
readonly createPaymentOrderDto: CreatePaymentOrderDto;
|
|
219
|
+
/**
|
|
220
|
+
* Bearer Token
|
|
221
|
+
* @type {string}
|
|
222
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
223
|
+
*/
|
|
224
|
+
readonly authorization?: string;
|
|
225
|
+
}
|
|
158
226
|
/**
|
|
159
227
|
* Request parameters for getPayment operation in PaymentsApi.
|
|
160
228
|
* @export
|
|
@@ -193,17 +261,29 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
193
261
|
*/
|
|
194
262
|
readonly authorization?: string;
|
|
195
263
|
/**
|
|
196
|
-
*
|
|
264
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
265
|
+
* @type {number}
|
|
266
|
+
* @memberof PaymentsApiListPayments
|
|
267
|
+
*/
|
|
268
|
+
readonly pageSize?: number;
|
|
269
|
+
/**
|
|
270
|
+
* 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.
|
|
271
|
+
* @type {string}
|
|
272
|
+
* @memberof PaymentsApiListPayments
|
|
273
|
+
*/
|
|
274
|
+
readonly pageToken?: string;
|
|
275
|
+
/**
|
|
276
|
+
* 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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
197
277
|
* @type {string}
|
|
198
278
|
* @memberof PaymentsApiListPayments
|
|
199
279
|
*/
|
|
200
280
|
readonly filter?: string;
|
|
201
281
|
/**
|
|
202
|
-
*
|
|
282
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
203
283
|
* @type {string}
|
|
204
284
|
* @memberof PaymentsApiListPayments
|
|
205
285
|
*/
|
|
206
|
-
readonly
|
|
286
|
+
readonly search?: string;
|
|
207
287
|
/**
|
|
208
288
|
* 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, code, amount</i>
|
|
209
289
|
* @type {string}
|
|
@@ -216,6 +296,12 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
216
296
|
* @memberof PaymentsApiListPayments
|
|
217
297
|
*/
|
|
218
298
|
readonly expand?: string;
|
|
299
|
+
/**
|
|
300
|
+
* 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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
301
|
+
* @type {string}
|
|
302
|
+
* @memberof PaymentsApiListPayments
|
|
303
|
+
*/
|
|
304
|
+
readonly filters?: string;
|
|
219
305
|
}
|
|
220
306
|
/**
|
|
221
307
|
* PaymentsApi - object-oriented interface
|
|
@@ -225,14 +311,24 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
225
311
|
*/
|
|
226
312
|
export declare class PaymentsApi extends BaseAPI {
|
|
227
313
|
/**
|
|
228
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
314
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
229
315
|
* @summary Create the payment
|
|
230
316
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
231
317
|
* @param {*} [options] Override http request option.
|
|
318
|
+
* @deprecated
|
|
232
319
|
* @throws {RequiredError}
|
|
233
320
|
* @memberof PaymentsApi
|
|
234
321
|
*/
|
|
235
322
|
createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
|
|
323
|
+
/**
|
|
324
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
325
|
+
* @summary Create the payment
|
|
326
|
+
* @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
|
|
327
|
+
* @param {*} [options] Override http request option.
|
|
328
|
+
* @throws {RequiredError}
|
|
329
|
+
* @memberof PaymentsApi
|
|
330
|
+
*/
|
|
331
|
+
createPaymentOrder(requestParameters: PaymentsApiCreatePaymentOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
|
|
236
332
|
/**
|
|
237
333
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
238
334
|
* @summary Retrieve the payment
|