@emilgroup/payment-sdk 1.22.0 → 1.22.1-beta.0
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-reminders-api.ts +12 -12
- package/api/payment-requests-api.ts +113 -12
- package/api/webhooks-api.ts +125 -14
- package/dist/api/payment-reminders-api.d.ts +12 -12
- package/dist/api/payment-reminders-api.js +9 -9
- package/dist/api/payment-requests-api.d.ts +67 -12
- package/dist/api/payment-requests-api.js +101 -9
- package/dist/api/webhooks-api.d.ts +73 -9
- package/dist/api/webhooks-api.js +100 -11
- 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 +16 -2
- 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/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 +16 -2
- 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 +14 -2
- 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/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 +14 -2
- package/models/validate-pspconfig-request-dto.ts +2 -2
- package/package.json +1 -1
|
@@ -248,11 +248,11 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
248
248
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
249
249
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
250
250
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
251
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
251
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate, isActive</i>
|
|
252
252
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
253
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
253
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, isActive</i>
|
|
254
254
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
255
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
255
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate, isActive</i>
|
|
256
256
|
* @param {*} [options] Override http request option.
|
|
257
257
|
* @throws {RequiredError}
|
|
258
258
|
*/
|
|
@@ -394,11 +394,11 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
394
394
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
395
395
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
396
396
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
397
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
397
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate, isActive</i>
|
|
398
398
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
399
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
399
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, isActive</i>
|
|
400
400
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
401
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
401
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate, isActive</i>
|
|
402
402
|
* @param {*} [options] Override http request option.
|
|
403
403
|
* @throws {RequiredError}
|
|
404
404
|
*/
|
|
@@ -465,11 +465,11 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
465
465
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
466
466
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
467
467
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
468
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
468
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate, isActive</i>
|
|
469
469
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
470
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt</i>
|
|
470
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, isActive</i>
|
|
471
471
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
472
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate</i>
|
|
472
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, policyCode, nextReminderDate, isActive</i>
|
|
473
473
|
* @param {*} [options] Override http request option.
|
|
474
474
|
* @throws {RequiredError}
|
|
475
475
|
*/
|
|
@@ -32,6 +32,15 @@ export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Confi
|
|
|
32
32
|
* @throws {RequiredError}
|
|
33
33
|
*/
|
|
34
34
|
createPaymentRequest: (createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
|
+
/**
|
|
36
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
37
|
+
* @summary Delete the payment request
|
|
38
|
+
* @param {string} code Unique identifier for the object.
|
|
39
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
deletePaymentRequest: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35
44
|
/**
|
|
36
45
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
37
46
|
* @summary Retrieve the payment request
|
|
@@ -48,11 +57,11 @@ export declare const PaymentRequestsApiAxiosParamCreator: (configuration?: Confi
|
|
|
48
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
49
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
50
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.
|
|
51
|
-
* @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>
|
|
52
|
-
* @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>
|
|
53
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>
|
|
54
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>
|
|
55
|
-
* @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>
|
|
56
65
|
* @param {*} [options] Override http request option.
|
|
57
66
|
* @throws {RequiredError}
|
|
58
67
|
*/
|
|
@@ -82,6 +91,15 @@ export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
|
82
91
|
* @throws {RequiredError}
|
|
83
92
|
*/
|
|
84
93
|
createPaymentRequest(createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentRequestResponseClass>>;
|
|
94
|
+
/**
|
|
95
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
96
|
+
* @summary Delete the payment request
|
|
97
|
+
* @param {string} code Unique identifier for the object.
|
|
98
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
|
+
* @param {*} [options] Override http request option.
|
|
100
|
+
* @throws {RequiredError}
|
|
101
|
+
*/
|
|
102
|
+
deletePaymentRequest(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
85
103
|
/**
|
|
86
104
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
87
105
|
* @summary Retrieve the payment request
|
|
@@ -98,11 +116,11 @@ export declare const PaymentRequestsApiFp: (configuration?: Configuration) => {
|
|
|
98
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
100
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.
|
|
101
|
-
* @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>
|
|
102
|
-
* @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>
|
|
103
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>
|
|
104
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>
|
|
105
|
-
* @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>
|
|
106
124
|
* @param {*} [options] Override http request option.
|
|
107
125
|
* @throws {RequiredError}
|
|
108
126
|
*/
|
|
@@ -132,6 +150,15 @@ export declare const PaymentRequestsApiFactory: (configuration?: Configuration,
|
|
|
132
150
|
* @throws {RequiredError}
|
|
133
151
|
*/
|
|
134
152
|
createPaymentRequest(createPaymentRequestRequestDto: CreatePaymentRequestRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentRequestResponseClass>;
|
|
153
|
+
/**
|
|
154
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
155
|
+
* @summary Delete the payment request
|
|
156
|
+
* @param {string} code Unique identifier for the object.
|
|
157
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
deletePaymentRequest(code: string, authorization?: string, options?: any): AxiosPromise<object>;
|
|
135
162
|
/**
|
|
136
163
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
137
164
|
* @summary Retrieve the payment request
|
|
@@ -148,11 +175,11 @@ export declare const PaymentRequestsApiFactory: (configuration?: Configuration,
|
|
|
148
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
149
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
150
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.
|
|
151
|
-
* @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>
|
|
152
|
-
* @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>
|
|
153
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>
|
|
154
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>
|
|
155
|
-
* @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>
|
|
156
183
|
* @param {*} [options] Override http request option.
|
|
157
184
|
* @throws {RequiredError}
|
|
158
185
|
*/
|
|
@@ -187,6 +214,25 @@ export interface PaymentRequestsApiCreatePaymentRequestRequest {
|
|
|
187
214
|
*/
|
|
188
215
|
readonly authorization?: string;
|
|
189
216
|
}
|
|
217
|
+
/**
|
|
218
|
+
* Request parameters for deletePaymentRequest operation in PaymentRequestsApi.
|
|
219
|
+
* @export
|
|
220
|
+
* @interface PaymentRequestsApiDeletePaymentRequestRequest
|
|
221
|
+
*/
|
|
222
|
+
export interface PaymentRequestsApiDeletePaymentRequestRequest {
|
|
223
|
+
/**
|
|
224
|
+
* Unique identifier for the object.
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof PaymentRequestsApiDeletePaymentRequest
|
|
227
|
+
*/
|
|
228
|
+
readonly code: string;
|
|
229
|
+
/**
|
|
230
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
231
|
+
* @type {string}
|
|
232
|
+
* @memberof PaymentRequestsApiDeletePaymentRequest
|
|
233
|
+
*/
|
|
234
|
+
readonly authorization?: string;
|
|
235
|
+
}
|
|
190
236
|
/**
|
|
191
237
|
* Request parameters for getPaymentRequest operation in PaymentRequestsApi.
|
|
192
238
|
* @export
|
|
@@ -237,13 +283,13 @@ export interface PaymentRequestsApiListPaymentRequestsRequest {
|
|
|
237
283
|
*/
|
|
238
284
|
readonly pageToken?: string;
|
|
239
285
|
/**
|
|
240
|
-
* 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>
|
|
241
287
|
* @type {string}
|
|
242
288
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
243
289
|
*/
|
|
244
290
|
readonly filter?: string;
|
|
245
291
|
/**
|
|
246
|
-
* 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>
|
|
247
293
|
* @type {string}
|
|
248
294
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
249
295
|
*/
|
|
@@ -261,7 +307,7 @@ export interface PaymentRequestsApiListPaymentRequestsRequest {
|
|
|
261
307
|
*/
|
|
262
308
|
readonly expand?: string;
|
|
263
309
|
/**
|
|
264
|
-
* 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>
|
|
265
311
|
* @type {string}
|
|
266
312
|
* @memberof PaymentRequestsApiListPaymentRequests
|
|
267
313
|
*/
|
|
@@ -308,6 +354,15 @@ export declare class PaymentRequestsApi extends BaseAPI {
|
|
|
308
354
|
* @memberof PaymentRequestsApi
|
|
309
355
|
*/
|
|
310
356
|
createPaymentRequest(requestParameters: PaymentRequestsApiCreatePaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentRequestResponseClass, any, {}>>;
|
|
357
|
+
/**
|
|
358
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
359
|
+
* @summary Delete the payment request
|
|
360
|
+
* @param {PaymentRequestsApiDeletePaymentRequestRequest} requestParameters Request parameters.
|
|
361
|
+
* @param {*} [options] Override http request option.
|
|
362
|
+
* @throws {RequiredError}
|
|
363
|
+
* @memberof PaymentRequestsApi
|
|
364
|
+
*/
|
|
365
|
+
deletePaymentRequest(requestParameters: PaymentRequestsApiDeletePaymentRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
311
366
|
/**
|
|
312
367
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
313
368
|
* @summary Retrieve the payment request
|
|
@@ -141,6 +141,54 @@ var PaymentRequestsApiAxiosParamCreator = function (configuration) {
|
|
|
141
141
|
});
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
|
+
/**
|
|
145
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
146
|
+
* @summary Delete the payment request
|
|
147
|
+
* @param {string} code Unique identifier for the object.
|
|
148
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
149
|
+
* @param {*} [options] Override http request option.
|
|
150
|
+
* @throws {RequiredError}
|
|
151
|
+
*/
|
|
152
|
+
deletePaymentRequest: function (code, authorization, options) {
|
|
153
|
+
if (options === void 0) { options = {}; }
|
|
154
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
155
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
156
|
+
return __generator(this, function (_a) {
|
|
157
|
+
switch (_a.label) {
|
|
158
|
+
case 0:
|
|
159
|
+
// verify required parameter 'code' is not null or undefined
|
|
160
|
+
(0, common_1.assertParamExists)('deletePaymentRequest', 'code', code);
|
|
161
|
+
localVarPath = "/paymentservice/v1/payment-requests/{code}"
|
|
162
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
163
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
164
|
+
if (configuration) {
|
|
165
|
+
baseOptions = configuration.baseOptions;
|
|
166
|
+
baseAccessToken = configuration.accessToken;
|
|
167
|
+
}
|
|
168
|
+
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
|
|
169
|
+
localVarHeaderParameter = {};
|
|
170
|
+
localVarQueryParameter = {};
|
|
171
|
+
// authentication bearer required
|
|
172
|
+
// http bearer authentication required
|
|
173
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
174
|
+
case 1:
|
|
175
|
+
// authentication bearer required
|
|
176
|
+
// http bearer authentication required
|
|
177
|
+
_a.sent();
|
|
178
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
179
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
180
|
+
}
|
|
181
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
182
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
183
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
184
|
+
return [2 /*return*/, {
|
|
185
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
186
|
+
options: localVarRequestOptions,
|
|
187
|
+
}];
|
|
188
|
+
}
|
|
189
|
+
});
|
|
190
|
+
});
|
|
191
|
+
},
|
|
144
192
|
/**
|
|
145
193
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
146
194
|
* @summary Retrieve the payment request
|
|
@@ -201,11 +249,11 @@ var PaymentRequestsApiAxiosParamCreator = function (configuration) {
|
|
|
201
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
202
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
203
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.
|
|
204
|
-
* @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>
|
|
205
|
-
* @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>
|
|
206
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>
|
|
207
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>
|
|
208
|
-
* @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>
|
|
209
257
|
* @param {*} [options] Override http request option.
|
|
210
258
|
* @throws {RequiredError}
|
|
211
259
|
*/
|
|
@@ -351,6 +399,27 @@ var PaymentRequestsApiFp = function (configuration) {
|
|
|
351
399
|
});
|
|
352
400
|
});
|
|
353
401
|
},
|
|
402
|
+
/**
|
|
403
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
404
|
+
* @summary Delete the payment request
|
|
405
|
+
* @param {string} code Unique identifier for the object.
|
|
406
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
407
|
+
* @param {*} [options] Override http request option.
|
|
408
|
+
* @throws {RequiredError}
|
|
409
|
+
*/
|
|
410
|
+
deletePaymentRequest: function (code, authorization, options) {
|
|
411
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
412
|
+
var localVarAxiosArgs;
|
|
413
|
+
return __generator(this, function (_a) {
|
|
414
|
+
switch (_a.label) {
|
|
415
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deletePaymentRequest(code, authorization, options)];
|
|
416
|
+
case 1:
|
|
417
|
+
localVarAxiosArgs = _a.sent();
|
|
418
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
419
|
+
}
|
|
420
|
+
});
|
|
421
|
+
});
|
|
422
|
+
},
|
|
354
423
|
/**
|
|
355
424
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
356
425
|
* @summary Retrieve the payment request
|
|
@@ -379,11 +448,11 @@ var PaymentRequestsApiFp = function (configuration) {
|
|
|
379
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
380
449
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
381
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.
|
|
382
|
-
* @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>
|
|
383
|
-
* @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>
|
|
384
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>
|
|
385
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>
|
|
386
|
-
* @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>
|
|
387
456
|
* @param {*} [options] Override http request option.
|
|
388
457
|
* @throws {RequiredError}
|
|
389
458
|
*/
|
|
@@ -443,6 +512,17 @@ var PaymentRequestsApiFactory = function (configuration, basePath, axios) {
|
|
|
443
512
|
createPaymentRequest: function (createPaymentRequestRequestDto, authorization, options) {
|
|
444
513
|
return localVarFp.createPaymentRequest(createPaymentRequestRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
445
514
|
},
|
|
515
|
+
/**
|
|
516
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
517
|
+
* @summary Delete the payment request
|
|
518
|
+
* @param {string} code Unique identifier for the object.
|
|
519
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
520
|
+
* @param {*} [options] Override http request option.
|
|
521
|
+
* @throws {RequiredError}
|
|
522
|
+
*/
|
|
523
|
+
deletePaymentRequest: function (code, authorization, options) {
|
|
524
|
+
return localVarFp.deletePaymentRequest(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
525
|
+
},
|
|
446
526
|
/**
|
|
447
527
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
448
528
|
* @summary Retrieve the payment request
|
|
@@ -461,11 +541,11 @@ var PaymentRequestsApiFactory = function (configuration, basePath, axios) {
|
|
|
461
541
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
462
542
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
463
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.
|
|
464
|
-
* @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>
|
|
465
|
-
* @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>
|
|
466
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>
|
|
467
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>
|
|
468
|
-
* @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>
|
|
469
549
|
* @param {*} [options] Override http request option.
|
|
470
550
|
* @throws {RequiredError}
|
|
471
551
|
*/
|
|
@@ -510,6 +590,18 @@ var PaymentRequestsApi = /** @class */ (function (_super) {
|
|
|
510
590
|
var _this = this;
|
|
511
591
|
return (0, exports.PaymentRequestsApiFp)(this.configuration).createPaymentRequest(requestParameters.createPaymentRequestRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
512
592
|
};
|
|
593
|
+
/**
|
|
594
|
+
* This will delete payment request. **Required Permissions** \"payment-management.payments.delete\"
|
|
595
|
+
* @summary Delete the payment request
|
|
596
|
+
* @param {PaymentRequestsApiDeletePaymentRequestRequest} requestParameters Request parameters.
|
|
597
|
+
* @param {*} [options] Override http request option.
|
|
598
|
+
* @throws {RequiredError}
|
|
599
|
+
* @memberof PaymentRequestsApi
|
|
600
|
+
*/
|
|
601
|
+
PaymentRequestsApi.prototype.deletePaymentRequest = function (requestParameters, options) {
|
|
602
|
+
var _this = this;
|
|
603
|
+
return (0, exports.PaymentRequestsApiFp)(this.configuration).deletePaymentRequest(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
604
|
+
};
|
|
513
605
|
/**
|
|
514
606
|
* This will get payment request. **Required Permissions** \"payment-management.payments.view\"
|
|
515
607
|
* @summary Retrieve the payment request
|
|
@@ -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
|
}
|