@emilgroup/payment-sdk-node 1.23.0 → 1.23.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 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +16 -16
- package/api/bank-orders-api.ts +16 -16
- package/api/bank-transaction-api.ts +12 -12
- package/api/billing-addresses-api.ts +681 -0
- package/api/credit-allocation-api.ts +12 -12
- package/api/exceeding-credits-api.ts +12 -12
- package/api/ibanvalidator-api.ts +169 -0
- package/api/payment-methods-api.ts +12 -12
- package/api/payment-receipts-api.ts +680 -0
- package/api/payment-reminders-api.ts +16 -16
- package/api/payment-requests-api.ts +697 -0
- package/api/payments-api.ts +12 -12
- package/api/payout-methods-api.ts +794 -0
- package/api/refunds-api.ts +12 -12
- package/api/tenant-bank-account-api.ts +16 -16
- package/api/webhooks-api.ts +125 -14
- package/api.ts +10 -0
- package/base.ts +1 -0
- package/dist/api/bank-accounts-api.d.ts +16 -16
- package/dist/api/bank-accounts-api.js +13 -13
- package/dist/api/bank-orders-api.d.ts +16 -16
- package/dist/api/bank-orders-api.js +14 -14
- package/dist/api/bank-transaction-api.d.ts +12 -12
- package/dist/api/bank-transaction-api.js +10 -10
- package/dist/api/billing-addresses-api.d.ts +384 -0
- package/dist/api/billing-addresses-api.js +640 -0
- package/dist/api/credit-allocation-api.d.ts +12 -12
- package/dist/api/credit-allocation-api.js +10 -10
- package/dist/api/exceeding-credits-api.d.ts +12 -12
- package/dist/api/exceeding-credits-api.js +10 -10
- package/dist/api/ibanvalidator-api.d.ts +97 -0
- package/dist/api/ibanvalidator-api.js +228 -0
- package/dist/api/payment-methods-api.d.ts +12 -12
- package/dist/api/payment-methods-api.js +10 -10
- package/dist/api/payment-receipts-api.d.ts +383 -0
- package/dist/api/payment-receipts-api.js +641 -0
- package/dist/api/payment-reminders-api.d.ts +16 -16
- package/dist/api/payment-reminders-api.js +13 -13
- package/dist/api/payment-requests-api.d.ts +393 -0
- package/dist/api/payment-requests-api.js +648 -0
- package/dist/api/payments-api.d.ts +12 -12
- package/dist/api/payments-api.js +10 -10
- package/dist/api/payout-methods-api.d.ts +447 -0
- package/dist/api/payout-methods-api.js +738 -0
- package/dist/api/refunds-api.d.ts +12 -12
- package/dist/api/refunds-api.js +10 -10
- package/dist/api/tenant-bank-account-api.d.ts +16 -16
- package/dist/api/tenant-bank-account-api.js +13 -13
- package/dist/api/webhooks-api.d.ts +73 -9
- package/dist/api/webhooks-api.js +100 -11
- package/dist/api.d.ts +5 -0
- package/dist/api.js +5 -0
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/bank-account-class-without-expand-properties.d.ts +6 -0
- package/dist/models/bank-account-class.d.ts +6 -0
- package/dist/models/bank-data-class.d.ts +36 -0
- package/dist/models/bank-data-class.js +15 -0
- package/dist/models/bank-order-class.d.ts +3 -3
- package/dist/models/bank-order-entity.d.ts +3 -2
- package/dist/models/bank-order-entity.js +2 -1
- package/dist/models/billing-address-class.d.ts +108 -0
- package/dist/models/billing-address-class.js +15 -0
- package/dist/models/create-bank-order-request-dto.d.ts +4 -3
- package/dist/models/create-bank-order-request-dto.js +2 -1
- package/dist/models/create-billing-address-request-dto.d.ts +66 -0
- package/dist/models/create-billing-address-request-dto.js +15 -0
- package/dist/models/create-billing-address-response-class.d.ts +25 -0
- package/dist/models/create-billing-address-response-class.js +15 -0
- package/dist/models/create-payment-receipt-request-dto.d.ts +65 -0
- package/dist/models/create-payment-receipt-request-dto.js +20 -0
- package/dist/models/create-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/create-payment-receipt-response-class.js +15 -0
- package/dist/models/create-payment-request-request-dto.d.ts +109 -0
- package/dist/models/create-payment-request-request-dto.js +30 -0
- package/dist/models/create-payment-request-response-class.d.ts +25 -0
- package/dist/models/create-payment-request-response-class.js +15 -0
- package/dist/models/create-payout-method-by-bank-account-request-dto.d.ts +36 -0
- package/dist/models/create-payout-method-by-bank-account-request-dto.js +15 -0
- package/dist/models/create-payout-method-request-dto.d.ts +66 -0
- package/dist/models/create-payout-method-request-dto.js +15 -0
- package/dist/models/create-payout-method-response-class.d.ts +25 -0
- package/dist/models/create-payout-method-response-class.js +15 -0
- package/dist/models/create-tenant-bank-account-request-dto.d.ts +17 -0
- package/dist/models/create-tenant-bank-account-request-dto.js +11 -1
- package/dist/models/get-billing-address-response-class.d.ts +25 -0
- package/dist/models/get-billing-address-response-class.js +15 -0
- package/dist/models/get-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/get-payment-receipt-response-class.js +15 -0
- package/dist/models/get-payment-request-response-class.d.ts +25 -0
- package/dist/models/get-payment-request-response-class.js +15 -0
- package/dist/models/get-payout-method-response-class.d.ts +25 -0
- package/dist/models/get-payout-method-response-class.js +15 -0
- package/dist/models/index.d.ts +29 -0
- package/dist/models/index.js +29 -0
- package/dist/models/list-billing-addresses-response-class.d.ts +43 -0
- package/dist/models/list-billing-addresses-response-class.js +15 -0
- package/dist/models/list-exceeding-credits-response-class.d.ts +18 -6
- package/dist/models/list-payment-receipts-response-class.d.ts +43 -0
- package/dist/models/list-payment-receipts-response-class.js +15 -0
- package/dist/models/list-payment-requests-response-class.d.ts +43 -0
- package/dist/models/list-payment-requests-response-class.js +15 -0
- package/dist/models/list-payout-methods-response-class.d.ts +43 -0
- package/dist/models/list-payout-methods-response-class.js +15 -0
- package/dist/models/list-refunds-response-class.d.ts +18 -6
- package/dist/models/payment-receipt-class.d.ts +101 -0
- package/dist/models/payment-receipt-class.js +20 -0
- package/dist/models/payment-request-class.d.ts +155 -0
- package/dist/models/payment-request-class.js +38 -0
- package/dist/models/payout-method-class.d.ts +121 -0
- package/dist/models/payout-method-class.js +15 -0
- package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +17 -0
- package/dist/models/tenant-bank-account-class-without-expand-properties.js +11 -1
- package/dist/models/tenant-bank-account-class.d.ts +17 -0
- package/dist/models/tenant-bank-account-class.js +11 -1
- package/dist/models/tenant-bank-account-entity.d.ts +17 -0
- package/dist/models/tenant-bank-account-entity.js +11 -1
- package/dist/models/update-bank-order-request-dto.d.ts +3 -3
- package/dist/models/update-billing-address-request-dto.d.ts +66 -0
- package/dist/models/update-billing-address-request-dto.js +15 -0
- package/dist/models/update-billing-address-response-class.d.ts +25 -0
- package/dist/models/update-billing-address-response-class.js +15 -0
- package/dist/models/update-payment-receipt-response-class.d.ts +25 -0
- package/dist/models/update-payment-receipt-response-class.js +15 -0
- package/dist/models/update-payment-request-request-dto.d.ts +39 -0
- package/dist/models/update-payment-request-request-dto.js +24 -0
- package/dist/models/update-payment-request-response-class.d.ts +25 -0
- package/dist/models/update-payment-request-response-class.js +15 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +17 -0
- package/dist/models/update-tenant-bank-account-rest-request-dto.js +11 -1
- package/dist/models/validate-iban-request-dto.d.ts +24 -0
- package/dist/models/validate-iban-request-dto.js +15 -0
- package/dist/models/validate-iban-response-class.d.ts +31 -0
- package/dist/models/validate-iban-response-class.js +15 -0
- package/models/bank-account-class-without-expand-properties.ts +6 -0
- package/models/bank-account-class.ts +6 -0
- package/models/bank-data-class.ts +42 -0
- package/models/bank-order-class.ts +3 -3
- package/models/bank-order-entity.ts +4 -3
- package/models/billing-address-class.ts +114 -0
- package/models/create-bank-order-request-dto.ts +5 -4
- package/models/create-billing-address-request-dto.ts +72 -0
- package/models/create-billing-address-response-class.ts +31 -0
- package/models/create-payment-receipt-request-dto.ts +74 -0
- package/models/create-payment-receipt-response-class.ts +31 -0
- package/models/create-payment-request-request-dto.ts +118 -0
- package/models/create-payment-request-response-class.ts +31 -0
- package/models/create-payout-method-by-bank-account-request-dto.ts +42 -0
- package/models/create-payout-method-request-dto.ts +72 -0
- package/models/create-payout-method-response-class.ts +31 -0
- package/models/create-tenant-bank-account-request-dto.ts +18 -0
- package/models/get-billing-address-response-class.ts +31 -0
- package/models/get-payment-receipt-response-class.ts +31 -0
- package/models/get-payment-request-response-class.ts +31 -0
- package/models/get-payout-method-response-class.ts +31 -0
- package/models/index.ts +29 -0
- package/models/list-billing-addresses-response-class.ts +49 -0
- package/models/list-exceeding-credits-response-class.ts +18 -6
- package/models/list-payment-receipts-response-class.ts +49 -0
- package/models/list-payment-requests-response-class.ts +49 -0
- package/models/list-payout-methods-response-class.ts +49 -0
- package/models/list-refunds-response-class.ts +18 -6
- package/models/payment-receipt-class.ts +110 -0
- package/models/payment-request-class.ts +165 -0
- package/models/payout-method-class.ts +127 -0
- package/models/tenant-bank-account-class-without-expand-properties.ts +18 -0
- package/models/tenant-bank-account-class.ts +18 -0
- package/models/tenant-bank-account-entity.ts +18 -0
- package/models/update-bank-order-request-dto.ts +3 -3
- package/models/update-billing-address-request-dto.ts +72 -0
- package/models/update-billing-address-response-class.ts +31 -0
- package/models/update-payment-receipt-response-class.ts +31 -0
- package/models/update-payment-request-request-dto.ts +48 -0
- package/models/update-payment-request-response-class.ts +31 -0
- package/models/update-tenant-bank-account-rest-request-dto.ts +18 -0
- package/models/validate-iban-request-dto.ts +30 -0
- package/models/validate-iban-response-class.ts +37 -0
- package/package.json +3 -3
|
@@ -53,16 +53,16 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
53
53
|
*/
|
|
54
54
|
getPayment: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55
55
|
/**
|
|
56
|
-
* Returns a list of payments you have previously created.
|
|
56
|
+
* 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\"
|
|
57
57
|
* @summary List payments
|
|
58
58
|
* @param {string} [authorization] Bearer Token
|
|
59
59
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
60
60
|
* @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.
|
|
61
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
61
|
+
* @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>
|
|
62
62
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
63
63
|
* @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>
|
|
64
64
|
* @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>
|
|
65
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
65
|
+
* @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>
|
|
66
66
|
* @param {*} [options] Override http request option.
|
|
67
67
|
* @throws {RequiredError}
|
|
68
68
|
*/
|
|
@@ -104,16 +104,16 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
104
104
|
*/
|
|
105
105
|
getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentResponseClass>>;
|
|
106
106
|
/**
|
|
107
|
-
* Returns a list of payments you have previously created.
|
|
107
|
+
* 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\"
|
|
108
108
|
* @summary List payments
|
|
109
109
|
* @param {string} [authorization] Bearer Token
|
|
110
110
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
111
111
|
* @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.
|
|
112
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
112
|
+
* @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>
|
|
113
113
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
114
114
|
* @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>
|
|
115
115
|
* @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>
|
|
116
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
116
|
+
* @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>
|
|
117
117
|
* @param {*} [options] Override http request option.
|
|
118
118
|
* @throws {RequiredError}
|
|
119
119
|
*/
|
|
@@ -155,16 +155,16 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
|
|
|
155
155
|
*/
|
|
156
156
|
getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPaymentResponseClass>;
|
|
157
157
|
/**
|
|
158
|
-
* Returns a list of payments you have previously created.
|
|
158
|
+
* 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\"
|
|
159
159
|
* @summary List payments
|
|
160
160
|
* @param {string} [authorization] Bearer Token
|
|
161
161
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
162
162
|
* @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.
|
|
163
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
163
|
+
* @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>
|
|
164
164
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
165
165
|
* @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>
|
|
166
166
|
* @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>
|
|
167
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
167
|
+
* @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>
|
|
168
168
|
* @param {*} [options] Override http request option.
|
|
169
169
|
* @throws {RequiredError}
|
|
170
170
|
*/
|
|
@@ -270,7 +270,7 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
270
270
|
*/
|
|
271
271
|
readonly pageToken?: string;
|
|
272
272
|
/**
|
|
273
|
-
* Filter the response by one or multiple fields.
|
|
273
|
+
* 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>
|
|
274
274
|
* @type {string}
|
|
275
275
|
* @memberof PaymentsApiListPayments
|
|
276
276
|
*/
|
|
@@ -294,7 +294,7 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
294
294
|
*/
|
|
295
295
|
readonly expand?: string;
|
|
296
296
|
/**
|
|
297
|
-
* Filters the response by one or multiple fields.
|
|
297
|
+
* 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>
|
|
298
298
|
* @type {string}
|
|
299
299
|
* @memberof PaymentsApiListPayments
|
|
300
300
|
*/
|
|
@@ -335,7 +335,7 @@ export declare class PaymentsApi extends BaseAPI {
|
|
|
335
335
|
*/
|
|
336
336
|
getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentResponseClass, any, {}>>;
|
|
337
337
|
/**
|
|
338
|
-
* Returns a list of payments you have previously created.
|
|
338
|
+
* 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\"
|
|
339
339
|
* @summary List payments
|
|
340
340
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
341
341
|
* @param {*} [options] Override http request option.
|
package/dist/api/payments-api.js
CHANGED
|
@@ -259,16 +259,16 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
259
259
|
});
|
|
260
260
|
},
|
|
261
261
|
/**
|
|
262
|
-
* Returns a list of payments you have previously created.
|
|
262
|
+
* 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\"
|
|
263
263
|
* @summary List payments
|
|
264
264
|
* @param {string} [authorization] Bearer Token
|
|
265
265
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
266
266
|
* @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.
|
|
267
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
267
|
+
* @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>
|
|
268
268
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
269
269
|
* @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>
|
|
270
270
|
* @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>
|
|
271
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
271
|
+
* @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>
|
|
272
272
|
* @param {*} [options] Override http request option.
|
|
273
273
|
* @throws {RequiredError}
|
|
274
274
|
*/
|
|
@@ -407,16 +407,16 @@ var PaymentsApiFp = function (configuration) {
|
|
|
407
407
|
});
|
|
408
408
|
},
|
|
409
409
|
/**
|
|
410
|
-
* Returns a list of payments you have previously created.
|
|
410
|
+
* 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\"
|
|
411
411
|
* @summary List payments
|
|
412
412
|
* @param {string} [authorization] Bearer Token
|
|
413
413
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
414
414
|
* @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.
|
|
415
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
415
|
+
* @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>
|
|
416
416
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
417
417
|
* @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>
|
|
418
418
|
* @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>
|
|
419
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
419
|
+
* @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>
|
|
420
420
|
* @param {*} [options] Override http request option.
|
|
421
421
|
* @throws {RequiredError}
|
|
422
422
|
*/
|
|
@@ -480,16 +480,16 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
480
480
|
return localVarFp.getPayment(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
481
481
|
},
|
|
482
482
|
/**
|
|
483
|
-
* Returns a list of payments you have previously created.
|
|
483
|
+
* 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\"
|
|
484
484
|
* @summary List payments
|
|
485
485
|
* @param {string} [authorization] Bearer Token
|
|
486
486
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
487
487
|
* @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.
|
|
488
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
488
|
+
* @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>
|
|
489
489
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
490
490
|
* @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>
|
|
491
491
|
* @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>
|
|
492
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
492
|
+
* @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>
|
|
493
493
|
* @param {*} [options] Override http request option.
|
|
494
494
|
* @throws {RequiredError}
|
|
495
495
|
*/
|
|
@@ -547,7 +547,7 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
547
547
|
return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
548
548
|
};
|
|
549
549
|
/**
|
|
550
|
-
* Returns a list of payments you have previously created.
|
|
550
|
+
* 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\"
|
|
551
551
|
* @summary List payments
|
|
552
552
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
553
553
|
* @param {*} [options] Override http request option.
|