@emilgroup/payment-sdk 1.16.1-beta.93 → 1.16.1-beta.95
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api/payment-requests-api.ts +12 -12
- package/api/webhooks-api.ts +41 -54
- package/base.ts +1 -0
- package/dist/api/payment-requests-api.d.ts +12 -12
- package/dist/api/payment-requests-api.js +9 -9
- package/dist/api/webhooks-api.d.ts +27 -36
- package/dist/api/webhooks-api.js +27 -33
- package/dist/base.d.ts +2 -1
- package/dist/base.js +1 -0
- package/dist/models/bank-transaction-entity.d.ts +4 -2
- package/dist/models/create-payment-order-dto.d.ts +4 -2
- package/dist/models/create-payment-order-request-dto.d.ts +4 -2
- package/dist/models/create-payment-request-dto.d.ts +4 -2
- package/dist/models/create-payment-request-request-dto.d.ts +6 -0
- package/dist/models/credit-allocation-class.d.ts +6 -0
- package/dist/models/credit-allocation-entity.d.ts +6 -0
- package/dist/models/invoice-match-suggestion-entity.d.ts +4 -2
- package/dist/models/list-billing-addresses-response-class.d.ts +9 -9
- package/dist/models/list-exceeding-credits-response-class.d.ts +6 -18
- package/dist/models/list-payment-receipts-response-class.d.ts +9 -9
- package/dist/models/list-payment-requests-response-class.d.ts +6 -18
- package/dist/models/list-payout-methods-response-class.d.ts +9 -9
- package/dist/models/list-refunds-response-class.d.ts +6 -18
- package/dist/models/payment-class-without-expand-properties.d.ts +1 -1
- package/dist/models/payment-class.d.ts +1 -1
- package/dist/models/payment-entity.d.ts +5 -3
- package/dist/models/payment-request-class.d.ts +12 -0
- package/dist/models/validate-pspconfig-request-dto.d.ts +4 -2
- package/models/bank-transaction-entity.ts +2 -2
- package/models/create-payment-order-dto.ts +2 -2
- package/models/create-payment-order-request-dto.ts +2 -2
- package/models/create-payment-request-dto.ts +2 -2
- package/models/create-payment-request-request-dto.ts +6 -0
- package/models/credit-allocation-class.ts +6 -0
- package/models/credit-allocation-entity.ts +6 -0
- package/models/invoice-match-suggestion-entity.ts +2 -2
- package/models/list-billing-addresses-response-class.ts +9 -9
- package/models/list-exceeding-credits-response-class.ts +6 -18
- package/models/list-payment-receipts-response-class.ts +9 -9
- package/models/list-payment-requests-response-class.ts +6 -18
- package/models/list-payout-methods-response-class.ts +9 -9
- package/models/list-refunds-response-class.ts +6 -18
- package/models/payment-class-without-expand-properties.ts +1 -1
- package/models/payment-class.ts +1 -1
- package/models/payment-entity.ts +3 -3
- package/models/payment-request-class.ts +12 -0
- package/models/validate-pspconfig-request-dto.ts +2 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/payment-sdk@1.16.1-beta.
|
|
20
|
+
npm install @emilgroup/payment-sdk@1.16.1-beta.95 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/payment-sdk@1.16.1-beta.
|
|
24
|
+
yarn add @emilgroup/payment-sdk@1.16.1-beta.95
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PaymentsApi`.
|
|
@@ -188,11 +188,11 @@ export const PaymentRequestsApiAxiosParamCreator = function (configuration?: Con
|
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
189
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
190
|
* @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.
|
|
191
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
192
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
191
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
192
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
193
193
|
* @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
194
194
|
* @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: paymentReceipts<i>
|
|
195
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
195
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
196
196
|
* @param {*} [options] Override http request option.
|
|
197
197
|
* @throws {RequiredError}
|
|
198
198
|
*/
|
|
@@ -362,11 +362,11 @@ export const PaymentRequestsApiFp = function(configuration?: Configuration) {
|
|
|
362
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
363
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
364
|
* @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.
|
|
365
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
366
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
365
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
366
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
367
367
|
* @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
368
368
|
* @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: paymentReceipts<i>
|
|
369
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
369
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
370
370
|
* @param {*} [options] Override http request option.
|
|
371
371
|
* @throws {RequiredError}
|
|
372
372
|
*/
|
|
@@ -437,11 +437,11 @@ export const PaymentRequestsApiFactory = function (configuration?: Configuration
|
|
|
437
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
438
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
439
|
* @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.
|
|
440
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
441
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
440
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
441
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
442
442
|
* @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
443
443
|
* @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: paymentReceipts<i>
|
|
444
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
444
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
447
|
*/
|
|
@@ -561,14 +561,14 @@ export interface PaymentRequestsApiListPaymentRequestsRequest {
|
|
|
561
561
|
readonly pageToken?: string
|
|
562
562
|
|
|
563
563
|
/**
|
|
564
|
-
* 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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
564
|
+
* 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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
565
565
|
* @type {string}
|
|
566
566
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
567
567
|
*/
|
|
568
568
|
readonly filter?: string
|
|
569
569
|
|
|
570
570
|
/**
|
|
571
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
571
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
572
572
|
* @type {string}
|
|
573
573
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
574
574
|
*/
|
|
@@ -589,7 +589,7 @@ export interface PaymentRequestsApiListPaymentRequestsRequest {
|
|
|
589
589
|
readonly expand?: string
|
|
590
590
|
|
|
591
591
|
/**
|
|
592
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
592
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
593
593
|
* @type {string}
|
|
594
594
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
595
595
|
*/
|
package/api/webhooks-api.ts
CHANGED
|
@@ -31,24 +31,20 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
31
31
|
* @summary Handle the webhook from PSP
|
|
32
32
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
33
33
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
34
|
-
* @param {string} productSlug
|
|
35
34
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
36
35
|
* @param {*} [options] Override http request option.
|
|
37
36
|
* @throws {RequiredError}
|
|
38
37
|
*/
|
|
39
|
-
|
|
38
|
+
postWebhook: async (pspType: string, tenantSlug: string, body: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40
39
|
// verify required parameter 'pspType' is not null or undefined
|
|
41
|
-
assertParamExists('
|
|
40
|
+
assertParamExists('postWebhook', 'pspType', pspType)
|
|
42
41
|
// verify required parameter 'tenantSlug' is not null or undefined
|
|
43
|
-
assertParamExists('
|
|
44
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
45
|
-
assertParamExists('postWebhook0', 'productSlug', productSlug)
|
|
42
|
+
assertParamExists('postWebhook', 'tenantSlug', tenantSlug)
|
|
46
43
|
// verify required parameter 'body' is not null or undefined
|
|
47
|
-
assertParamExists('
|
|
44
|
+
assertParamExists('postWebhook', 'body', body)
|
|
48
45
|
const localVarPath = `/paymentservice/v1/webhooks/{pspType}/{tenantSlug}`
|
|
49
46
|
.replace(`{${"pspType"}}`, encodeURIComponent(String(pspType)))
|
|
50
|
-
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)))
|
|
51
|
-
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
47
|
+
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)));
|
|
52
48
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
53
49
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54
50
|
let baseOptions;
|
|
@@ -81,20 +77,20 @@ export const WebhooksApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
81
77
|
* @summary Handle the webhook from PSP
|
|
82
78
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
83
79
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
84
|
-
* @param {string} productSlug
|
|
80
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
85
81
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
86
82
|
* @param {*} [options] Override http request option.
|
|
87
83
|
* @throws {RequiredError}
|
|
88
84
|
*/
|
|
89
|
-
|
|
85
|
+
postWebhookWithProductSlug: async (pspType: string, tenantSlug: string, productSlug: string, body: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
90
86
|
// verify required parameter 'pspType' is not null or undefined
|
|
91
|
-
assertParamExists('
|
|
87
|
+
assertParamExists('postWebhookWithProductSlug', 'pspType', pspType)
|
|
92
88
|
// verify required parameter 'tenantSlug' is not null or undefined
|
|
93
|
-
assertParamExists('
|
|
89
|
+
assertParamExists('postWebhookWithProductSlug', 'tenantSlug', tenantSlug)
|
|
94
90
|
// verify required parameter 'productSlug' is not null or undefined
|
|
95
|
-
assertParamExists('
|
|
91
|
+
assertParamExists('postWebhookWithProductSlug', 'productSlug', productSlug)
|
|
96
92
|
// verify required parameter 'body' is not null or undefined
|
|
97
|
-
assertParamExists('
|
|
93
|
+
assertParamExists('postWebhookWithProductSlug', 'body', body)
|
|
98
94
|
const localVarPath = `/paymentservice/v1/webhooks/{pspType}/{tenantSlug}/{productSlug}`
|
|
99
95
|
.replace(`{${"pspType"}}`, encodeURIComponent(String(pspType)))
|
|
100
96
|
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)))
|
|
@@ -141,13 +137,12 @@ export const WebhooksApiFp = function(configuration?: Configuration) {
|
|
|
141
137
|
* @summary Handle the webhook from PSP
|
|
142
138
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
143
139
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
144
|
-
* @param {string} productSlug
|
|
145
140
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
146
141
|
* @param {*} [options] Override http request option.
|
|
147
142
|
* @throws {RequiredError}
|
|
148
143
|
*/
|
|
149
|
-
async
|
|
150
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
144
|
+
async postWebhook(pspType: string, tenantSlug: string, body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
145
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postWebhook(pspType, tenantSlug, body, options);
|
|
151
146
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
152
147
|
},
|
|
153
148
|
/**
|
|
@@ -155,13 +150,13 @@ export const WebhooksApiFp = function(configuration?: Configuration) {
|
|
|
155
150
|
* @summary Handle the webhook from PSP
|
|
156
151
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
157
152
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
158
|
-
* @param {string} productSlug
|
|
153
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
159
154
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
160
155
|
* @param {*} [options] Override http request option.
|
|
161
156
|
* @throws {RequiredError}
|
|
162
157
|
*/
|
|
163
|
-
async
|
|
164
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
158
|
+
async postWebhookWithProductSlug(pspType: string, tenantSlug: string, productSlug: string, body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
159
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.postWebhookWithProductSlug(pspType, tenantSlug, productSlug, body, options);
|
|
165
160
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
166
161
|
},
|
|
167
162
|
}
|
|
@@ -179,96 +174,88 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP
|
|
|
179
174
|
* @summary Handle the webhook from PSP
|
|
180
175
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
181
176
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
182
|
-
* @param {string} productSlug
|
|
183
177
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
184
178
|
* @param {*} [options] Override http request option.
|
|
185
179
|
* @throws {RequiredError}
|
|
186
180
|
*/
|
|
187
|
-
|
|
188
|
-
return localVarFp.
|
|
181
|
+
postWebhook(pspType: string, tenantSlug: string, body: object, options?: any): AxiosPromise<void> {
|
|
182
|
+
return localVarFp.postWebhook(pspType, tenantSlug, body, options).then((request) => request(axios, basePath));
|
|
189
183
|
},
|
|
190
184
|
/**
|
|
191
185
|
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
192
186
|
* @summary Handle the webhook from PSP
|
|
193
187
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
194
188
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
195
|
-
* @param {string} productSlug
|
|
189
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
196
190
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
197
191
|
* @param {*} [options] Override http request option.
|
|
198
192
|
* @throws {RequiredError}
|
|
199
193
|
*/
|
|
200
|
-
|
|
201
|
-
return localVarFp.
|
|
194
|
+
postWebhookWithProductSlug(pspType: string, tenantSlug: string, productSlug: string, body: object, options?: any): AxiosPromise<void> {
|
|
195
|
+
return localVarFp.postWebhookWithProductSlug(pspType, tenantSlug, productSlug, body, options).then((request) => request(axios, basePath));
|
|
202
196
|
},
|
|
203
197
|
};
|
|
204
198
|
};
|
|
205
199
|
|
|
206
200
|
/**
|
|
207
|
-
* Request parameters for
|
|
201
|
+
* Request parameters for postWebhook operation in WebhooksApi.
|
|
208
202
|
* @export
|
|
209
|
-
* @interface
|
|
203
|
+
* @interface WebhooksApiPostWebhookRequest
|
|
210
204
|
*/
|
|
211
|
-
export interface
|
|
205
|
+
export interface WebhooksApiPostWebhookRequest {
|
|
212
206
|
/**
|
|
213
207
|
* The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
214
208
|
* @type {string}
|
|
215
|
-
* @memberof
|
|
209
|
+
* @memberof WebhooksApiPostWebhook
|
|
216
210
|
*/
|
|
217
211
|
readonly pspType: string
|
|
218
212
|
|
|
219
213
|
/**
|
|
220
214
|
* Unique slug identifier representing a tenant.
|
|
221
215
|
* @type {string}
|
|
222
|
-
* @memberof
|
|
216
|
+
* @memberof WebhooksApiPostWebhook
|
|
223
217
|
*/
|
|
224
218
|
readonly tenantSlug: string
|
|
225
219
|
|
|
226
|
-
/**
|
|
227
|
-
*
|
|
228
|
-
* @type {string}
|
|
229
|
-
* @memberof WebhooksApiPostWebhook0
|
|
230
|
-
*/
|
|
231
|
-
readonly productSlug: string
|
|
232
|
-
|
|
233
220
|
/**
|
|
234
221
|
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
235
222
|
* @type {object}
|
|
236
|
-
* @memberof
|
|
223
|
+
* @memberof WebhooksApiPostWebhook
|
|
237
224
|
*/
|
|
238
225
|
readonly body: object
|
|
239
226
|
}
|
|
240
227
|
|
|
241
228
|
/**
|
|
242
|
-
* Request parameters for
|
|
229
|
+
* Request parameters for postWebhookWithProductSlug operation in WebhooksApi.
|
|
243
230
|
* @export
|
|
244
|
-
* @interface
|
|
231
|
+
* @interface WebhooksApiPostWebhookWithProductSlugRequest
|
|
245
232
|
*/
|
|
246
|
-
export interface
|
|
233
|
+
export interface WebhooksApiPostWebhookWithProductSlugRequest {
|
|
247
234
|
/**
|
|
248
235
|
* The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
249
236
|
* @type {string}
|
|
250
|
-
* @memberof
|
|
237
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
251
238
|
*/
|
|
252
239
|
readonly pspType: string
|
|
253
240
|
|
|
254
241
|
/**
|
|
255
242
|
* Unique slug identifier representing a tenant.
|
|
256
243
|
* @type {string}
|
|
257
|
-
* @memberof
|
|
244
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
258
245
|
*/
|
|
259
246
|
readonly tenantSlug: string
|
|
260
247
|
|
|
261
248
|
/**
|
|
262
|
-
*
|
|
249
|
+
* Optional product slug associated with the webhook.
|
|
263
250
|
* @type {string}
|
|
264
|
-
* @memberof
|
|
251
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
265
252
|
*/
|
|
266
253
|
readonly productSlug: string
|
|
267
254
|
|
|
268
255
|
/**
|
|
269
256
|
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
270
257
|
* @type {object}
|
|
271
|
-
* @memberof
|
|
258
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
272
259
|
*/
|
|
273
260
|
readonly body: object
|
|
274
261
|
}
|
|
@@ -283,24 +270,24 @@ export class WebhooksApi extends BaseAPI {
|
|
|
283
270
|
/**
|
|
284
271
|
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
285
272
|
* @summary Handle the webhook from PSP
|
|
286
|
-
* @param {
|
|
273
|
+
* @param {WebhooksApiPostWebhookRequest} requestParameters Request parameters.
|
|
287
274
|
* @param {*} [options] Override http request option.
|
|
288
275
|
* @throws {RequiredError}
|
|
289
276
|
* @memberof WebhooksApi
|
|
290
277
|
*/
|
|
291
|
-
public
|
|
292
|
-
return WebhooksApiFp(this.configuration).
|
|
278
|
+
public postWebhook(requestParameters: WebhooksApiPostWebhookRequest, options?: AxiosRequestConfig) {
|
|
279
|
+
return WebhooksApiFp(this.configuration).postWebhook(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
293
280
|
}
|
|
294
281
|
|
|
295
282
|
/**
|
|
296
283
|
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
297
284
|
* @summary Handle the webhook from PSP
|
|
298
|
-
* @param {
|
|
285
|
+
* @param {WebhooksApiPostWebhookWithProductSlugRequest} requestParameters Request parameters.
|
|
299
286
|
* @param {*} [options] Override http request option.
|
|
300
287
|
* @throws {RequiredError}
|
|
301
288
|
* @memberof WebhooksApi
|
|
302
289
|
*/
|
|
303
|
-
public
|
|
304
|
-
return WebhooksApiFp(this.configuration).
|
|
290
|
+
public postWebhookWithProductSlug(requestParameters: WebhooksApiPostWebhookWithProductSlugRequest, options?: AxiosRequestConfig) {
|
|
291
|
+
return WebhooksApiFp(this.configuration).postWebhookWithProductSlug(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.productSlug, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
305
292
|
}
|
|
306
293
|
}
|
package/base.ts
CHANGED
|
@@ -53,6 +53,7 @@ export enum Environment {
|
|
|
53
53
|
Staging = 'https://apiv2-staging.emil.de',
|
|
54
54
|
Development = 'https://apiv2-dev.emil.de',
|
|
55
55
|
ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
|
|
56
|
+
StagingZurich = 'https://eu-central-2.apiv2-staging.emil.de',
|
|
56
57
|
}
|
|
57
58
|
|
|
58
59
|
let _retry_count = 0
|
|
@@ -57,11 +57,11 @@ export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Confi
|
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
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.
|
|
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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
61
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
61
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
62
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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
63
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/> <i>Allowed values: paymentReceipts<i>
|
|
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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
@@ -116,11 +116,11 @@ export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
|
116
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
118
|
* @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.
|
|
119
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
120
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
119
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
120
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
121
121
|
* @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
122
122
|
* @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: paymentReceipts<i>
|
|
123
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
123
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
@@ -175,11 +175,11 @@ export declare const PaymentRequestsApiFactory: (configuration?: Configuration,
|
|
|
175
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
177
|
* @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.
|
|
178
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
179
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
178
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
179
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
180
180
|
* @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
181
181
|
* @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: paymentReceipts<i>
|
|
182
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
182
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
@@ -283,13 +283,13 @@ export interface PaymentRequestsApiListPaymentRequestsRequest {
|
|
|
283
283
|
*/
|
|
284
284
|
readonly pageToken?: string;
|
|
285
285
|
/**
|
|
286
|
-
* 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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
286
|
+
* 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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
287
287
|
* @type {string}
|
|
288
288
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
289
289
|
*/
|
|
290
290
|
readonly filter?: string;
|
|
291
291
|
/**
|
|
292
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
292
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
293
293
|
* @type {string}
|
|
294
294
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
295
295
|
*/
|
|
@@ -307,7 +307,7 @@ export interface PaymentRequestsApiListPaymentRequestsRequest {
|
|
|
307
307
|
*/
|
|
308
308
|
readonly expand?: string;
|
|
309
309
|
/**
|
|
310
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
310
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
311
311
|
* @type {string}
|
|
312
312
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
313
313
|
*/
|
|
@@ -249,11 +249,11 @@ var PaymentRequestsApiAxiosParamCreator = function (configuration) {
|
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
251
|
* @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.
|
|
252
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
253
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
252
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
253
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
254
254
|
* @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
255
255
|
* @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: paymentReceipts<i>
|
|
256
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
256
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
@@ -448,11 +448,11 @@ var PaymentRequestsApiFp = function (configuration) {
|
|
|
448
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
449
449
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
450
450
|
* @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
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
452
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
451
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
452
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
453
453
|
* @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
454
454
|
* @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: paymentReceipts<i>
|
|
455
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
455
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
456
456
|
* @param {*} [options] Override http request option.
|
|
457
457
|
* @throws {RequiredError}
|
|
458
458
|
*/
|
|
@@ -541,11 +541,11 @@ var PaymentRequestsApiFactory = function (configuration, basePath, axios) {
|
|
|
541
541
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
542
542
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
543
543
|
* @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.
|
|
544
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
545
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber</i>
|
|
544
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
545
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, paymentRequestNumber, financialEntityCode, financialEntityNumber, domainEntityCode, domainEntityNumber, settlementCode</i>
|
|
546
546
|
* @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, paymentRequestNumber, financialEntityNumber, domainEntityNumber, createdAt, status</i>
|
|
547
547
|
* @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: paymentReceipts<i>
|
|
548
|
-
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt</i>
|
|
548
|
+
* @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: id, code, paymentRequestNumber, status, direction, financialEntityType, domainEntityType, paymentMethodPsp, paymentMethodType, createdAt, settlementCode</i>
|
|
549
549
|
* @param {*} [options] Override http request option.
|
|
550
550
|
* @throws {RequiredError}
|
|
551
551
|
*/
|