@emilgroup/payment-sdk 1.16.1-beta.67 → 1.16.1-beta.68
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 +125 -14
- 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 +73 -9
- package/dist/api/webhooks-api.js +100 -11
- package/dist/models/create-payment-request-request-dto.d.ts +10 -2
- package/dist/models/credit-allocation-class.d.ts +6 -0
- package/dist/models/credit-allocation-entity.d.ts +6 -0
- package/dist/models/payment-request-class.d.ts +10 -2
- package/models/create-payment-request-request-dto.ts +8 -2
- package/models/credit-allocation-class.ts +6 -0
- package/models/credit-allocation-entity.ts +6 -0
- package/models/payment-request-class.ts +8 -2
- package/package.json +1 -1
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.68 --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.68
|
|
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,20 +31,66 @@ 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
|
-
postWebhook: async (pspType: string, tenantSlug: string,
|
|
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
40
|
assertParamExists('postWebhook', 'pspType', pspType)
|
|
42
41
|
// verify required parameter 'tenantSlug' is not null or undefined
|
|
43
42
|
assertParamExists('postWebhook', 'tenantSlug', tenantSlug)
|
|
44
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
45
|
-
assertParamExists('postWebhook', 'productSlug', productSlug)
|
|
46
43
|
// verify required parameter 'body' is not null or undefined
|
|
47
44
|
assertParamExists('postWebhook', 'body', body)
|
|
45
|
+
const localVarPath = `/paymentservice/v1/webhooks/{pspType}/{tenantSlug}`
|
|
46
|
+
.replace(`{${"pspType"}}`, encodeURIComponent(String(pspType)))
|
|
47
|
+
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)));
|
|
48
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
49
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50
|
+
let baseOptions;
|
|
51
|
+
let baseAccessToken;
|
|
52
|
+
if (configuration) {
|
|
53
|
+
baseOptions = configuration.baseOptions;
|
|
54
|
+
baseAccessToken = configuration.accessToken;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
58
|
+
const localVarHeaderParameter = {} as any;
|
|
59
|
+
const localVarQueryParameter = {} as any;
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
64
|
+
|
|
65
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
67
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
68
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
|
|
69
|
+
|
|
70
|
+
return {
|
|
71
|
+
url: toPathString(localVarUrlObj),
|
|
72
|
+
options: localVarRequestOptions,
|
|
73
|
+
};
|
|
74
|
+
},
|
|
75
|
+
/**
|
|
76
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
77
|
+
* @summary Handle the webhook from PSP
|
|
78
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
79
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
80
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
81
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
82
|
+
* @param {*} [options] Override http request option.
|
|
83
|
+
* @throws {RequiredError}
|
|
84
|
+
*/
|
|
85
|
+
postWebhookWithProductSlug: async (pspType: string, tenantSlug: string, productSlug: string, body: object, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
86
|
+
// verify required parameter 'pspType' is not null or undefined
|
|
87
|
+
assertParamExists('postWebhookWithProductSlug', 'pspType', pspType)
|
|
88
|
+
// verify required parameter 'tenantSlug' is not null or undefined
|
|
89
|
+
assertParamExists('postWebhookWithProductSlug', 'tenantSlug', tenantSlug)
|
|
90
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
91
|
+
assertParamExists('postWebhookWithProductSlug', 'productSlug', productSlug)
|
|
92
|
+
// verify required parameter 'body' is not null or undefined
|
|
93
|
+
assertParamExists('postWebhookWithProductSlug', 'body', body)
|
|
48
94
|
const localVarPath = `/paymentservice/v1/webhooks/{pspType}/{tenantSlug}/{productSlug}`
|
|
49
95
|
.replace(`{${"pspType"}}`, encodeURIComponent(String(pspType)))
|
|
50
96
|
.replace(`{${"tenantSlug"}}`, encodeURIComponent(String(tenantSlug)))
|
|
@@ -91,13 +137,26 @@ export const WebhooksApiFp = function(configuration?: Configuration) {
|
|
|
91
137
|
* @summary Handle the webhook from PSP
|
|
92
138
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
93
139
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
94
|
-
* @param {string} productSlug
|
|
95
140
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
96
141
|
* @param {*} [options] Override http request option.
|
|
97
142
|
* @throws {RequiredError}
|
|
98
143
|
*/
|
|
99
|
-
async postWebhook(pspType: string, tenantSlug: string,
|
|
100
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.postWebhook(pspType, tenantSlug,
|
|
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);
|
|
146
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
147
|
+
},
|
|
148
|
+
/**
|
|
149
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
150
|
+
* @summary Handle the webhook from PSP
|
|
151
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
152
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
153
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
154
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
155
|
+
* @param {*} [options] Override http request option.
|
|
156
|
+
* @throws {RequiredError}
|
|
157
|
+
*/
|
|
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);
|
|
101
160
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
102
161
|
},
|
|
103
162
|
}
|
|
@@ -115,13 +174,25 @@ export const WebhooksApiFactory = function (configuration?: Configuration, baseP
|
|
|
115
174
|
* @summary Handle the webhook from PSP
|
|
116
175
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
117
176
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
118
|
-
* @param {string} productSlug
|
|
119
177
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
120
178
|
* @param {*} [options] Override http request option.
|
|
121
179
|
* @throws {RequiredError}
|
|
122
180
|
*/
|
|
123
|
-
postWebhook(pspType: string, tenantSlug: string,
|
|
124
|
-
return localVarFp.postWebhook(pspType, tenantSlug,
|
|
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));
|
|
183
|
+
},
|
|
184
|
+
/**
|
|
185
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
186
|
+
* @summary Handle the webhook from PSP
|
|
187
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
188
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
189
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
190
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
191
|
+
* @param {*} [options] Override http request option.
|
|
192
|
+
* @throws {RequiredError}
|
|
193
|
+
*/
|
|
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));
|
|
125
196
|
},
|
|
126
197
|
};
|
|
127
198
|
};
|
|
@@ -147,16 +218,44 @@ export interface WebhooksApiPostWebhookRequest {
|
|
|
147
218
|
readonly tenantSlug: string
|
|
148
219
|
|
|
149
220
|
/**
|
|
150
|
-
*
|
|
151
|
-
* @type {
|
|
221
|
+
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
222
|
+
* @type {object}
|
|
152
223
|
* @memberof WebhooksApiPostWebhook
|
|
153
224
|
*/
|
|
225
|
+
readonly body: object
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* Request parameters for postWebhookWithProductSlug operation in WebhooksApi.
|
|
230
|
+
* @export
|
|
231
|
+
* @interface WebhooksApiPostWebhookWithProductSlugRequest
|
|
232
|
+
*/
|
|
233
|
+
export interface WebhooksApiPostWebhookWithProductSlugRequest {
|
|
234
|
+
/**
|
|
235
|
+
* The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
236
|
+
* @type {string}
|
|
237
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
238
|
+
*/
|
|
239
|
+
readonly pspType: string
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* Unique slug identifier representing a tenant.
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
245
|
+
*/
|
|
246
|
+
readonly tenantSlug: string
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Optional product slug associated with the webhook.
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
252
|
+
*/
|
|
154
253
|
readonly productSlug: string
|
|
155
254
|
|
|
156
255
|
/**
|
|
157
256
|
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
158
257
|
* @type {object}
|
|
159
|
-
* @memberof
|
|
258
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
160
259
|
*/
|
|
161
260
|
readonly body: object
|
|
162
261
|
}
|
|
@@ -177,6 +276,18 @@ export class WebhooksApi extends BaseAPI {
|
|
|
177
276
|
* @memberof WebhooksApi
|
|
178
277
|
*/
|
|
179
278
|
public postWebhook(requestParameters: WebhooksApiPostWebhookRequest, options?: AxiosRequestConfig) {
|
|
180
|
-
return WebhooksApiFp(this.configuration).postWebhook(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.
|
|
279
|
+
return WebhooksApiFp(this.configuration).postWebhook(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
284
|
+
* @summary Handle the webhook from PSP
|
|
285
|
+
* @param {WebhooksApiPostWebhookWithProductSlugRequest} requestParameters Request parameters.
|
|
286
|
+
* @param {*} [options] Override http request option.
|
|
287
|
+
* @throws {RequiredError}
|
|
288
|
+
* @memberof WebhooksApi
|
|
289
|
+
*/
|
|
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));
|
|
181
292
|
}
|
|
182
293
|
}
|
|
@@ -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
|
*/
|
|
@@ -22,12 +22,22 @@ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
22
22
|
* @summary Handle the webhook from PSP
|
|
23
23
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
24
24
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
25
|
-
* @param {string} productSlug
|
|
26
25
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
27
26
|
* @param {*} [options] Override http request option.
|
|
28
27
|
* @throws {RequiredError}
|
|
29
28
|
*/
|
|
30
|
-
postWebhook: (pspType: string, tenantSlug: string,
|
|
29
|
+
postWebhook: (pspType: string, tenantSlug: string, body: object, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30
|
+
/**
|
|
31
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
32
|
+
* @summary Handle the webhook from PSP
|
|
33
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
34
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
35
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
36
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
postWebhookWithProductSlug: (pspType: string, tenantSlug: string, productSlug: string, body: object, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31
41
|
};
|
|
32
42
|
/**
|
|
33
43
|
* WebhooksApi - functional programming interface
|
|
@@ -39,12 +49,22 @@ export declare const WebhooksApiFp: (configuration?: Configuration) => {
|
|
|
39
49
|
* @summary Handle the webhook from PSP
|
|
40
50
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
41
51
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
42
|
-
* @param {string} productSlug
|
|
43
52
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
44
53
|
* @param {*} [options] Override http request option.
|
|
45
54
|
* @throws {RequiredError}
|
|
46
55
|
*/
|
|
47
|
-
postWebhook(pspType: string, tenantSlug: string,
|
|
56
|
+
postWebhook(pspType: string, tenantSlug: string, body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
57
|
+
/**
|
|
58
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
59
|
+
* @summary Handle the webhook from PSP
|
|
60
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
61
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
62
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
63
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
postWebhookWithProductSlug(pspType: string, tenantSlug: string, productSlug: string, body: object, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
48
68
|
};
|
|
49
69
|
/**
|
|
50
70
|
* WebhooksApi - factory interface
|
|
@@ -56,12 +76,22 @@ export declare const WebhooksApiFactory: (configuration?: Configuration, basePat
|
|
|
56
76
|
* @summary Handle the webhook from PSP
|
|
57
77
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
58
78
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
59
|
-
* @param {string} productSlug
|
|
60
79
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
61
80
|
* @param {*} [options] Override http request option.
|
|
62
81
|
* @throws {RequiredError}
|
|
63
82
|
*/
|
|
64
|
-
postWebhook(pspType: string, tenantSlug: string,
|
|
83
|
+
postWebhook(pspType: string, tenantSlug: string, body: object, options?: any): AxiosPromise<void>;
|
|
84
|
+
/**
|
|
85
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
86
|
+
* @summary Handle the webhook from PSP
|
|
87
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
88
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
89
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
90
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
postWebhookWithProductSlug(pspType: string, tenantSlug: string, productSlug: string, body: object, options?: any): AxiosPromise<void>;
|
|
65
95
|
};
|
|
66
96
|
/**
|
|
67
97
|
* Request parameters for postWebhook operation in WebhooksApi.
|
|
@@ -82,15 +112,40 @@ export interface WebhooksApiPostWebhookRequest {
|
|
|
82
112
|
*/
|
|
83
113
|
readonly tenantSlug: string;
|
|
84
114
|
/**
|
|
85
|
-
*
|
|
86
|
-
* @type {
|
|
115
|
+
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
116
|
+
* @type {object}
|
|
87
117
|
* @memberof WebhooksApiPostWebhook
|
|
88
118
|
*/
|
|
119
|
+
readonly body: object;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Request parameters for postWebhookWithProductSlug operation in WebhooksApi.
|
|
123
|
+
* @export
|
|
124
|
+
* @interface WebhooksApiPostWebhookWithProductSlugRequest
|
|
125
|
+
*/
|
|
126
|
+
export interface WebhooksApiPostWebhookWithProductSlugRequest {
|
|
127
|
+
/**
|
|
128
|
+
* The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
129
|
+
* @type {string}
|
|
130
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
131
|
+
*/
|
|
132
|
+
readonly pspType: string;
|
|
133
|
+
/**
|
|
134
|
+
* Unique slug identifier representing a tenant.
|
|
135
|
+
* @type {string}
|
|
136
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
137
|
+
*/
|
|
138
|
+
readonly tenantSlug: string;
|
|
139
|
+
/**
|
|
140
|
+
* Optional product slug associated with the webhook.
|
|
141
|
+
* @type {string}
|
|
142
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
143
|
+
*/
|
|
89
144
|
readonly productSlug: string;
|
|
90
145
|
/**
|
|
91
146
|
* Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
92
147
|
* @type {object}
|
|
93
|
-
* @memberof
|
|
148
|
+
* @memberof WebhooksApiPostWebhookWithProductSlug
|
|
94
149
|
*/
|
|
95
150
|
readonly body: object;
|
|
96
151
|
}
|
|
@@ -110,4 +165,13 @@ export declare class WebhooksApi extends BaseAPI {
|
|
|
110
165
|
* @memberof WebhooksApi
|
|
111
166
|
*/
|
|
112
167
|
postWebhook(requestParameters: WebhooksApiPostWebhookRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
168
|
+
/**
|
|
169
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
170
|
+
* @summary Handle the webhook from PSP
|
|
171
|
+
* @param {WebhooksApiPostWebhookWithProductSlugRequest} requestParameters Request parameters.
|
|
172
|
+
* @param {*} [options] Override http request option.
|
|
173
|
+
* @throws {RequiredError}
|
|
174
|
+
* @memberof WebhooksApi
|
|
175
|
+
*/
|
|
176
|
+
postWebhookWithProductSlug(requestParameters: WebhooksApiPostWebhookWithProductSlugRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
113
177
|
}
|
package/dist/api/webhooks-api.js
CHANGED
|
@@ -97,12 +97,11 @@ var WebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
* @summary Handle the webhook from PSP
|
|
98
98
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
99
99
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
100
|
-
* @param {string} productSlug
|
|
101
100
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
102
101
|
* @param {*} [options] Override http request option.
|
|
103
102
|
* @throws {RequiredError}
|
|
104
103
|
*/
|
|
105
|
-
postWebhook: function (pspType, tenantSlug,
|
|
104
|
+
postWebhook: function (pspType, tenantSlug, body, options) {
|
|
106
105
|
if (options === void 0) { options = {}; }
|
|
107
106
|
return __awaiter(_this, void 0, void 0, function () {
|
|
108
107
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -111,10 +110,54 @@ var WebhooksApiAxiosParamCreator = function (configuration) {
|
|
|
111
110
|
(0, common_1.assertParamExists)('postWebhook', 'pspType', pspType);
|
|
112
111
|
// verify required parameter 'tenantSlug' is not null or undefined
|
|
113
112
|
(0, common_1.assertParamExists)('postWebhook', 'tenantSlug', tenantSlug);
|
|
114
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
115
|
-
(0, common_1.assertParamExists)('postWebhook', 'productSlug', productSlug);
|
|
116
113
|
// verify required parameter 'body' is not null or undefined
|
|
117
114
|
(0, common_1.assertParamExists)('postWebhook', 'body', body);
|
|
115
|
+
localVarPath = "/paymentservice/v1/webhooks/{pspType}/{tenantSlug}"
|
|
116
|
+
.replace("{".concat("pspType", "}"), encodeURIComponent(String(pspType)))
|
|
117
|
+
.replace("{".concat("tenantSlug", "}"), encodeURIComponent(String(tenantSlug)));
|
|
118
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
119
|
+
if (configuration) {
|
|
120
|
+
baseOptions = configuration.baseOptions;
|
|
121
|
+
baseAccessToken = configuration.accessToken;
|
|
122
|
+
}
|
|
123
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
124
|
+
localVarHeaderParameter = {};
|
|
125
|
+
localVarQueryParameter = {};
|
|
126
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
127
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
128
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
129
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
130
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
131
|
+
return [2 /*return*/, {
|
|
132
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
133
|
+
options: localVarRequestOptions,
|
|
134
|
+
}];
|
|
135
|
+
});
|
|
136
|
+
});
|
|
137
|
+
},
|
|
138
|
+
/**
|
|
139
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
140
|
+
* @summary Handle the webhook from PSP
|
|
141
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
142
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
143
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
144
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
145
|
+
* @param {*} [options] Override http request option.
|
|
146
|
+
* @throws {RequiredError}
|
|
147
|
+
*/
|
|
148
|
+
postWebhookWithProductSlug: function (pspType, tenantSlug, productSlug, body, options) {
|
|
149
|
+
if (options === void 0) { options = {}; }
|
|
150
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
151
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
152
|
+
return __generator(this, function (_a) {
|
|
153
|
+
// verify required parameter 'pspType' is not null or undefined
|
|
154
|
+
(0, common_1.assertParamExists)('postWebhookWithProductSlug', 'pspType', pspType);
|
|
155
|
+
// verify required parameter 'tenantSlug' is not null or undefined
|
|
156
|
+
(0, common_1.assertParamExists)('postWebhookWithProductSlug', 'tenantSlug', tenantSlug);
|
|
157
|
+
// verify required parameter 'productSlug' is not null or undefined
|
|
158
|
+
(0, common_1.assertParamExists)('postWebhookWithProductSlug', 'productSlug', productSlug);
|
|
159
|
+
// verify required parameter 'body' is not null or undefined
|
|
160
|
+
(0, common_1.assertParamExists)('postWebhookWithProductSlug', 'body', body);
|
|
118
161
|
localVarPath = "/paymentservice/v1/webhooks/{pspType}/{tenantSlug}/{productSlug}"
|
|
119
162
|
.replace("{".concat("pspType", "}"), encodeURIComponent(String(pspType)))
|
|
120
163
|
.replace("{".concat("tenantSlug", "}"), encodeURIComponent(String(tenantSlug)))
|
|
@@ -154,17 +197,39 @@ var WebhooksApiFp = function (configuration) {
|
|
|
154
197
|
* @summary Handle the webhook from PSP
|
|
155
198
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
156
199
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
157
|
-
* @param {string} productSlug
|
|
158
200
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
159
201
|
* @param {*} [options] Override http request option.
|
|
160
202
|
* @throws {RequiredError}
|
|
161
203
|
*/
|
|
162
|
-
postWebhook: function (pspType, tenantSlug,
|
|
204
|
+
postWebhook: function (pspType, tenantSlug, body, options) {
|
|
163
205
|
return __awaiter(this, void 0, void 0, function () {
|
|
164
206
|
var localVarAxiosArgs;
|
|
165
207
|
return __generator(this, function (_a) {
|
|
166
208
|
switch (_a.label) {
|
|
167
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postWebhook(pspType, tenantSlug,
|
|
209
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postWebhook(pspType, tenantSlug, body, options)];
|
|
210
|
+
case 1:
|
|
211
|
+
localVarAxiosArgs = _a.sent();
|
|
212
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
213
|
+
}
|
|
214
|
+
});
|
|
215
|
+
});
|
|
216
|
+
},
|
|
217
|
+
/**
|
|
218
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
219
|
+
* @summary Handle the webhook from PSP
|
|
220
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
221
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
222
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
223
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
224
|
+
* @param {*} [options] Override http request option.
|
|
225
|
+
* @throws {RequiredError}
|
|
226
|
+
*/
|
|
227
|
+
postWebhookWithProductSlug: function (pspType, tenantSlug, productSlug, body, options) {
|
|
228
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
229
|
+
var localVarAxiosArgs;
|
|
230
|
+
return __generator(this, function (_a) {
|
|
231
|
+
switch (_a.label) {
|
|
232
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postWebhookWithProductSlug(pspType, tenantSlug, productSlug, body, options)];
|
|
168
233
|
case 1:
|
|
169
234
|
localVarAxiosArgs = _a.sent();
|
|
170
235
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -187,13 +252,25 @@ var WebhooksApiFactory = function (configuration, basePath, axios) {
|
|
|
187
252
|
* @summary Handle the webhook from PSP
|
|
188
253
|
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
189
254
|
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
190
|
-
* @param {string} productSlug
|
|
191
255
|
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
192
256
|
* @param {*} [options] Override http request option.
|
|
193
257
|
* @throws {RequiredError}
|
|
194
258
|
*/
|
|
195
|
-
postWebhook: function (pspType, tenantSlug,
|
|
196
|
-
return localVarFp.postWebhook(pspType, tenantSlug,
|
|
259
|
+
postWebhook: function (pspType, tenantSlug, body, options) {
|
|
260
|
+
return localVarFp.postWebhook(pspType, tenantSlug, body, options).then(function (request) { return request(axios, basePath); });
|
|
261
|
+
},
|
|
262
|
+
/**
|
|
263
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
264
|
+
* @summary Handle the webhook from PSP
|
|
265
|
+
* @param {string} pspType The type of the payment service provider (PSP).<br/> <br/> <i>Supported PSP: braintree, stripe, b4u, eis, adyen</i>
|
|
266
|
+
* @param {string} tenantSlug Unique slug identifier representing a tenant.
|
|
267
|
+
* @param {string} productSlug Optional product slug associated with the webhook.
|
|
268
|
+
* @param {object} body Accepts a webhook payload. The structure may vary depending on the payment service provider.
|
|
269
|
+
* @param {*} [options] Override http request option.
|
|
270
|
+
* @throws {RequiredError}
|
|
271
|
+
*/
|
|
272
|
+
postWebhookWithProductSlug: function (pspType, tenantSlug, productSlug, body, options) {
|
|
273
|
+
return localVarFp.postWebhookWithProductSlug(pspType, tenantSlug, productSlug, body, options).then(function (request) { return request(axios, basePath); });
|
|
197
274
|
},
|
|
198
275
|
};
|
|
199
276
|
};
|
|
@@ -219,7 +296,19 @@ var WebhooksApi = /** @class */ (function (_super) {
|
|
|
219
296
|
*/
|
|
220
297
|
WebhooksApi.prototype.postWebhook = function (requestParameters, options) {
|
|
221
298
|
var _this = this;
|
|
222
|
-
return (0, exports.WebhooksApiFp)(this.configuration).postWebhook(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.
|
|
299
|
+
return (0, exports.WebhooksApiFp)(this.configuration).postWebhook(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.body, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
300
|
+
};
|
|
301
|
+
/**
|
|
302
|
+
* This will processes the webhook from external payment service provider. **Required Permissions** none
|
|
303
|
+
* @summary Handle the webhook from PSP
|
|
304
|
+
* @param {WebhooksApiPostWebhookWithProductSlugRequest} requestParameters Request parameters.
|
|
305
|
+
* @param {*} [options] Override http request option.
|
|
306
|
+
* @throws {RequiredError}
|
|
307
|
+
* @memberof WebhooksApi
|
|
308
|
+
*/
|
|
309
|
+
WebhooksApi.prototype.postWebhookWithProductSlug = function (requestParameters, options) {
|
|
310
|
+
var _this = this;
|
|
311
|
+
return (0, exports.WebhooksApiFp)(this.configuration).postWebhookWithProductSlug(requestParameters.pspType, requestParameters.tenantSlug, requestParameters.productSlug, requestParameters.body, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
223
312
|
};
|
|
224
313
|
return WebhooksApi;
|
|
225
314
|
}(base_1.BaseAPI));
|
|
@@ -69,6 +69,12 @@ export interface CreatePaymentRequestRequestDto {
|
|
|
69
69
|
* @memberof CreatePaymentRequestRequestDto
|
|
70
70
|
*/
|
|
71
71
|
'domainEntityType': CreatePaymentRequestRequestDtoDomainEntityTypeEnum;
|
|
72
|
+
/**
|
|
73
|
+
* Code of the settlement the payment request was created for.
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof CreatePaymentRequestRequestDto
|
|
76
|
+
*/
|
|
77
|
+
'settlementCode'?: string;
|
|
72
78
|
/**
|
|
73
79
|
* Code of the payment method to be used for this payment request. If not provided, a default payment method may be selected.
|
|
74
80
|
* @type {string}
|
|
@@ -77,10 +83,12 @@ export interface CreatePaymentRequestRequestDto {
|
|
|
77
83
|
'paymentMethodCode'?: string;
|
|
78
84
|
/**
|
|
79
85
|
* Optional field containing extra information about the payment request.
|
|
80
|
-
* @type {object}
|
|
86
|
+
* @type {{ [key: string]: object; }}
|
|
81
87
|
* @memberof CreatePaymentRequestRequestDto
|
|
82
88
|
*/
|
|
83
|
-
'metadata'?:
|
|
89
|
+
'metadata'?: {
|
|
90
|
+
[key: string]: object;
|
|
91
|
+
};
|
|
84
92
|
}
|
|
85
93
|
export declare const CreatePaymentRequestRequestDtoDirectionEnum: {
|
|
86
94
|
readonly Collect: "collect";
|
|
@@ -34,6 +34,12 @@ export interface CreditAllocationClass {
|
|
|
34
34
|
* @memberof CreditAllocationClass
|
|
35
35
|
*/
|
|
36
36
|
'exceedingCreditCodes': Array<string>;
|
|
37
|
+
/**
|
|
38
|
+
* Partner code derived from the policy related to the exceeding credits.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof CreditAllocationClass
|
|
41
|
+
*/
|
|
42
|
+
'partnerCode': string;
|
|
37
43
|
/**
|
|
38
44
|
* Policy code associated with the credit.
|
|
39
45
|
* @type {string}
|
|
@@ -94,6 +94,12 @@ export interface PaymentRequestClass {
|
|
|
94
94
|
* @memberof PaymentRequestClass
|
|
95
95
|
*/
|
|
96
96
|
'status': PaymentRequestClassStatusEnum;
|
|
97
|
+
/**
|
|
98
|
+
* Code of the settlement the payment request was created for.
|
|
99
|
+
* @type {string}
|
|
100
|
+
* @memberof PaymentRequestClass
|
|
101
|
+
*/
|
|
102
|
+
'settlementCode'?: string;
|
|
97
103
|
/**
|
|
98
104
|
* Code of the payment method used for this payment request.
|
|
99
105
|
* @type {string}
|
|
@@ -114,10 +120,12 @@ export interface PaymentRequestClass {
|
|
|
114
120
|
'paymentMethodPsp'?: string;
|
|
115
121
|
/**
|
|
116
122
|
* Optional field containing extra information about the payment request.
|
|
117
|
-
* @type {object}
|
|
123
|
+
* @type {{ [key: string]: object; }}
|
|
118
124
|
* @memberof PaymentRequestClass
|
|
119
125
|
*/
|
|
120
|
-
'metadata'?:
|
|
126
|
+
'metadata'?: {
|
|
127
|
+
[key: string]: object;
|
|
128
|
+
};
|
|
121
129
|
/**
|
|
122
130
|
* The list of payment receipts.
|
|
123
131
|
* @type {Array<PaymentReceiptClass>}
|
|
@@ -74,6 +74,12 @@ export interface CreatePaymentRequestRequestDto {
|
|
|
74
74
|
* @memberof CreatePaymentRequestRequestDto
|
|
75
75
|
*/
|
|
76
76
|
'domainEntityType': CreatePaymentRequestRequestDtoDomainEntityTypeEnum;
|
|
77
|
+
/**
|
|
78
|
+
* Code of the settlement the payment request was created for.
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof CreatePaymentRequestRequestDto
|
|
81
|
+
*/
|
|
82
|
+
'settlementCode'?: string;
|
|
77
83
|
/**
|
|
78
84
|
* Code of the payment method to be used for this payment request. If not provided, a default payment method may be selected.
|
|
79
85
|
* @type {string}
|
|
@@ -82,10 +88,10 @@ export interface CreatePaymentRequestRequestDto {
|
|
|
82
88
|
'paymentMethodCode'?: string;
|
|
83
89
|
/**
|
|
84
90
|
* Optional field containing extra information about the payment request.
|
|
85
|
-
* @type {object}
|
|
91
|
+
* @type {{ [key: string]: object; }}
|
|
86
92
|
* @memberof CreatePaymentRequestRequestDto
|
|
87
93
|
*/
|
|
88
|
-
'metadata'?: object;
|
|
94
|
+
'metadata'?: { [key: string]: object; };
|
|
89
95
|
}
|
|
90
96
|
|
|
91
97
|
export const CreatePaymentRequestRequestDtoDirectionEnum = {
|
|
@@ -39,6 +39,12 @@ export interface CreditAllocationClass {
|
|
|
39
39
|
* @memberof CreditAllocationClass
|
|
40
40
|
*/
|
|
41
41
|
'exceedingCreditCodes': Array<string>;
|
|
42
|
+
/**
|
|
43
|
+
* Partner code derived from the policy related to the exceeding credits.
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof CreditAllocationClass
|
|
46
|
+
*/
|
|
47
|
+
'partnerCode': string;
|
|
42
48
|
/**
|
|
43
49
|
* Policy code associated with the credit.
|
|
44
50
|
* @type {string}
|
|
@@ -99,6 +99,12 @@ export interface PaymentRequestClass {
|
|
|
99
99
|
* @memberof PaymentRequestClass
|
|
100
100
|
*/
|
|
101
101
|
'status': PaymentRequestClassStatusEnum;
|
|
102
|
+
/**
|
|
103
|
+
* Code of the settlement the payment request was created for.
|
|
104
|
+
* @type {string}
|
|
105
|
+
* @memberof PaymentRequestClass
|
|
106
|
+
*/
|
|
107
|
+
'settlementCode'?: string;
|
|
102
108
|
/**
|
|
103
109
|
* Code of the payment method used for this payment request.
|
|
104
110
|
* @type {string}
|
|
@@ -119,10 +125,10 @@ export interface PaymentRequestClass {
|
|
|
119
125
|
'paymentMethodPsp'?: string;
|
|
120
126
|
/**
|
|
121
127
|
* Optional field containing extra information about the payment request.
|
|
122
|
-
* @type {object}
|
|
128
|
+
* @type {{ [key: string]: object; }}
|
|
123
129
|
* @memberof PaymentRequestClass
|
|
124
130
|
*/
|
|
125
|
-
'metadata'?: object;
|
|
131
|
+
'metadata'?: { [key: string]: object; };
|
|
126
132
|
/**
|
|
127
133
|
* The list of payment receipts.
|
|
128
134
|
* @type {Array<PaymentReceiptClass>}
|