@emilgroup/payment-sdk 1.13.1-beta.1 → 1.13.1-beta.100
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +34 -1
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +55 -13
- package/api/bank-orders-api.ts +691 -0
- package/api/bank-transaction-api.ts +177 -63
- package/api/exceeding-credits-api.ts +349 -0
- package/api/payment-methods-api.ts +59 -17
- package/api/payment-reminders-api.ts +55 -13
- package/api/payments-api.ts +188 -21
- package/api/policy-payment-methods-api.ts +353 -0
- package/api/refunds-api.ts +45 -17
- package/api/tenant-bank-account-api.ts +45 -17
- package/api.ts +6 -0
- package/base.ts +52 -3
- package/dist/api/bank-accounts-api.d.ts +35 -8
- package/dist/api/bank-accounts-api.js +29 -11
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +642 -0
- package/dist/api/bank-transaction-api.d.ts +110 -46
- package/dist/api/bank-transaction-api.js +141 -44
- package/dist/api/exceeding-credits-api.d.ts +206 -0
- package/dist/api/exceeding-credits-api.js +352 -0
- package/dist/api/payment-methods-api.d.ts +39 -12
- package/dist/api/payment-methods-api.js +32 -14
- package/dist/api/payment-reminders-api.d.ts +35 -8
- package/dist/api/payment-reminders-api.js +29 -11
- package/dist/api/payments-api.d.ts +112 -16
- package/dist/api/payments-api.js +141 -18
- package/dist/api/policy-payment-methods-api.d.ts +207 -0
- package/dist/api/policy-payment-methods-api.js +353 -0
- package/dist/api/refunds-api.d.ts +28 -10
- package/dist/api/refunds-api.js +24 -12
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/base.d.ts +10 -1
- package/dist/base.js +46 -2
- package/dist/models/bank-order-class.d.ts +122 -0
- package/dist/models/bank-order-xml-file-class.d.ts +72 -0
- package/dist/models/bank-order-xml-file-class.js +15 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +18 -18
- package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
- package/dist/models/bank-transaction-class.d.ts +36 -22
- package/dist/models/bank-transaction-class.js +5 -0
- package/dist/models/bank-transaction-invoice-class.d.ts +60 -0
- package/dist/models/bank-transaction-invoice-class.js +15 -0
- package/dist/models/bank-transfer-dto.d.ts +25 -0
- package/dist/models/bank-transfer-dto.js +15 -0
- package/dist/models/billing-address-dto.d.ts +54 -0
- package/dist/models/billing-address-dto.js +15 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.js +3 -1
- package/dist/models/complete-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/complete-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +7 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +3 -1
- package/dist/models/create-bank-order-request-dto.d.ts +74 -0
- package/dist/models/create-bank-order-request-dto.js +28 -0
- package/dist/models/create-bank-order-response-class.d.ts +25 -0
- package/dist/models/create-bank-order-response-class.js +15 -0
- package/dist/models/create-payment-order-dto.d.ts +48 -0
- package/dist/models/create-payment-order-dto.js +15 -0
- package/dist/models/create-payment-order-request-dto.d.ts +48 -0
- package/dist/models/create-payment-order-request-dto.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-policy-payment-method-request-dto.d.ts +30 -0
- package/dist/models/create-policy-payment-method-request-dto.js +15 -0
- package/dist/models/create-policy-payment-method-response-class.d.ts +25 -0
- package/dist/models/create-policy-payment-method-response-class.js +15 -0
- package/dist/models/create-psp-payment-method-request-dto.d.ts +29 -1
- package/dist/models/create-psp-payment-method-request-dto.js +3 -1
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/eis-sepa-debit-dto.d.ts +55 -0
- package/dist/models/eis-sepa-debit-dto.js +15 -0
- package/dist/models/exceeding-credit-class.d.ts +116 -0
- package/dist/models/exceeding-credit-class.js +29 -0
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
- package/dist/models/get-bank-order-response-class.d.ts +25 -0
- package/dist/models/get-bank-order-response-class.js +15 -0
- package/dist/models/get-exceeding-credit-response-class.d.ts +25 -0
- package/dist/models/get-exceeding-credit-response-class.js +15 -0
- package/dist/models/index.d.ts +31 -1
- package/dist/models/index.js +31 -1
- package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +3 -2
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/{unlink-bank-transaction-request-dto-rest.d.ts → invoice-allocation-dto.d.ts} +10 -4
- package/dist/models/invoice-allocation-dto.js +15 -0
- package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
- package/dist/models/invoice-match-suggestion-class.js +15 -0
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +4 -3
- package/dist/models/list-bank-orders-response-class.d.ts +31 -0
- package/dist/models/list-bank-orders-response-class.js +15 -0
- package/dist/models/list-exceeding-credits-response-class.d.ts +31 -0
- package/dist/models/list-exceeding-credits-response-class.js +15 -0
- package/dist/models/list-policy-payment-methods-response-class.d.ts +31 -0
- package/dist/models/list-policy-payment-methods-response-class.js +15 -0
- package/dist/models/mandate-dto.d.ts +43 -0
- package/dist/models/mandate-dto.js +15 -0
- package/dist/models/mandate-hash-data-dto.d.ts +42 -0
- package/dist/models/mandate-hash-data-dto.js +15 -0
- package/dist/models/mandate-reference-class.d.ts +90 -0
- package/dist/models/mandate-reference-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
- package/dist/models/payment-class.d.ts +7 -1
- package/dist/models/payment-method-class.d.ts +6 -0
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/policy-payment-method-class.d.ts +86 -0
- package/dist/models/policy-payment-method-class.js +15 -0
- package/dist/models/refund-class.d.ts +7 -1
- package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
- package/dist/models/suggestion-generation-progress-class.js +22 -0
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +18 -0
- package/dist/models/unlinked-bank-transaction-response-class.js +5 -0
- package/dist/models/update-bank-order-request-dto.d.ts +62 -0
- package/dist/models/update-bank-order-request-dto.js +23 -0
- package/dist/models/update-bank-order-response-class.d.ts +25 -0
- package/dist/models/update-bank-order-response-class.js +15 -0
- package/models/bank-order-class.ts +128 -0
- package/models/bank-order-xml-file-class.ts +78 -0
- package/models/bank-transaction-class-without-expand-properties.ts +21 -18
- package/models/bank-transaction-class.ts +39 -22
- package/models/bank-transaction-invoice-class.ts +66 -0
- package/models/bank-transfer-dto.ts +31 -0
- package/models/billing-address-dto.ts +60 -0
- package/models/complete-adyen-payment-setup-request-dto.ts +3 -1
- package/models/complete-eis-payment-setup-request-dto.ts +42 -0
- package/models/complete-payment-setup-request-dto.ts +7 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +3 -1
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-order-dto.ts +54 -0
- package/models/create-payment-order-request-dto.ts +54 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-policy-payment-method-request-dto.ts +36 -0
- package/models/create-policy-payment-method-response-class.ts +31 -0
- package/models/create-psp-payment-method-request-dto.ts +30 -2
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/eis-sepa-debit-dto.ts +61 -0
- package/models/exceeding-credit-class.ts +125 -0
- package/models/financial-account-class.ts +120 -0
- package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
- package/models/get-bank-order-response-class.ts +31 -0
- package/models/get-exceeding-credit-response-class.ts +31 -0
- package/models/index.ts +31 -1
- package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
- package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
- package/models/initiate-eis-payment-setup-request-dto.ts +42 -0
- package/models/initiate-payment-setup-request-dto.ts +3 -2
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/{unlink-bank-transaction-request-dto-rest.ts → invoice-allocation-dto.ts} +10 -4
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/link-bank-transaction-request-dto-rest.ts +4 -3
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/list-exceeding-credits-response-class.ts +37 -0
- package/models/list-policy-payment-methods-response-class.ts +37 -0
- package/models/mandate-dto.ts +49 -0
- package/models/mandate-hash-data-dto.ts +48 -0
- package/models/mandate-reference-class.ts +96 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-method-class.ts +6 -0
- package/models/payment-reminder-class.ts +7 -1
- package/models/policy-payment-method-class.ts +92 -0
- package/models/refund-class.ts +7 -1
- package/models/suggestion-generation-progress-class.ts +52 -0
- package/models/unlinked-bank-transaction-response-class.ts +21 -0
- package/models/update-bank-order-request-dto.ts +71 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
- /package/dist/models/{unlink-bank-transaction-request-dto-rest.js → bank-order-class.js} +0 -0
package/dist/api/payments-api.js
CHANGED
|
@@ -93,12 +93,13 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
96
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
97
97
|
* @summary Create the payment
|
|
98
98
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
99
99
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
100
100
|
* @param {string} [authorization] Bearer Token
|
|
101
101
|
* @param {*} [options] Override http request option.
|
|
102
|
+
* @deprecated
|
|
102
103
|
* @throws {RequiredError}
|
|
103
104
|
*/
|
|
104
105
|
createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
|
|
@@ -147,6 +148,61 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
147
148
|
});
|
|
148
149
|
});
|
|
149
150
|
},
|
|
151
|
+
/**
|
|
152
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
153
|
+
* @summary Create the payment
|
|
154
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
155
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
156
|
+
* @param {string} [authorization] Bearer Token
|
|
157
|
+
* @param {*} [options] Override http request option.
|
|
158
|
+
* @throws {RequiredError}
|
|
159
|
+
*/
|
|
160
|
+
createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
|
|
161
|
+
if (options === void 0) { options = {}; }
|
|
162
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
163
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
164
|
+
return __generator(this, function (_a) {
|
|
165
|
+
switch (_a.label) {
|
|
166
|
+
case 0:
|
|
167
|
+
// verify required parameter 'idempotencyKey' is not null or undefined
|
|
168
|
+
(0, common_1.assertParamExists)('createPaymentOrder', 'idempotencyKey', idempotencyKey);
|
|
169
|
+
// verify required parameter 'createPaymentOrderDto' is not null or undefined
|
|
170
|
+
(0, common_1.assertParamExists)('createPaymentOrder', 'createPaymentOrderDto', createPaymentOrderDto);
|
|
171
|
+
localVarPath = "/paymentservice/v1/payments/order";
|
|
172
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
173
|
+
if (configuration) {
|
|
174
|
+
baseOptions = configuration.baseOptions;
|
|
175
|
+
baseAccessToken = configuration.accessToken;
|
|
176
|
+
}
|
|
177
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
178
|
+
localVarHeaderParameter = {};
|
|
179
|
+
localVarQueryParameter = {};
|
|
180
|
+
// authentication bearer required
|
|
181
|
+
// http bearer authentication required
|
|
182
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
183
|
+
case 1:
|
|
184
|
+
// authentication bearer required
|
|
185
|
+
// http bearer authentication required
|
|
186
|
+
_a.sent();
|
|
187
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
188
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
189
|
+
}
|
|
190
|
+
if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
191
|
+
localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
|
|
192
|
+
}
|
|
193
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
194
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
195
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
196
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
197
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPaymentOrderDto, localVarRequestOptions, configuration);
|
|
198
|
+
return [2 /*return*/, {
|
|
199
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
200
|
+
options: localVarRequestOptions,
|
|
201
|
+
}];
|
|
202
|
+
}
|
|
203
|
+
});
|
|
204
|
+
});
|
|
205
|
+
},
|
|
150
206
|
/**
|
|
151
207
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
152
208
|
* @summary Retrieve the payment
|
|
@@ -203,14 +259,17 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
203
259
|
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
204
260
|
* @summary List payments
|
|
205
261
|
* @param {string} [authorization] Bearer Token
|
|
206
|
-
* @param {
|
|
207
|
-
* @param {string} [
|
|
262
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
263
|
+
* @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.
|
|
264
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
265
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
208
266
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
209
267
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
268
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
210
269
|
* @param {*} [options] Override http request option.
|
|
211
270
|
* @throws {RequiredError}
|
|
212
271
|
*/
|
|
213
|
-
listPayments: function (authorization, filter,
|
|
272
|
+
listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
214
273
|
if (options === void 0) { options = {}; }
|
|
215
274
|
return __awaiter(_this, void 0, void 0, function () {
|
|
216
275
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -233,11 +292,17 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
233
292
|
// authentication bearer required
|
|
234
293
|
// http bearer authentication required
|
|
235
294
|
_a.sent();
|
|
295
|
+
if (pageSize !== undefined) {
|
|
296
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
297
|
+
}
|
|
298
|
+
if (pageToken !== undefined) {
|
|
299
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
300
|
+
}
|
|
236
301
|
if (filter !== undefined) {
|
|
237
302
|
localVarQueryParameter['filter'] = filter;
|
|
238
303
|
}
|
|
239
|
-
if (
|
|
240
|
-
localVarQueryParameter['
|
|
304
|
+
if (search !== undefined) {
|
|
305
|
+
localVarQueryParameter['search'] = search;
|
|
241
306
|
}
|
|
242
307
|
if (order !== undefined) {
|
|
243
308
|
localVarQueryParameter['order'] = order;
|
|
@@ -245,6 +310,9 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
245
310
|
if (expand !== undefined) {
|
|
246
311
|
localVarQueryParameter['expand'] = expand;
|
|
247
312
|
}
|
|
313
|
+
if (filters !== undefined) {
|
|
314
|
+
localVarQueryParameter['filters'] = filters;
|
|
315
|
+
}
|
|
248
316
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
249
317
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
250
318
|
}
|
|
@@ -270,12 +338,13 @@ var PaymentsApiFp = function (configuration) {
|
|
|
270
338
|
var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
|
|
271
339
|
return {
|
|
272
340
|
/**
|
|
273
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
341
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
274
342
|
* @summary Create the payment
|
|
275
343
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
276
344
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
277
345
|
* @param {string} [authorization] Bearer Token
|
|
278
346
|
* @param {*} [options] Override http request option.
|
|
347
|
+
* @deprecated
|
|
279
348
|
* @throws {RequiredError}
|
|
280
349
|
*/
|
|
281
350
|
createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
|
|
@@ -291,6 +360,28 @@ var PaymentsApiFp = function (configuration) {
|
|
|
291
360
|
});
|
|
292
361
|
});
|
|
293
362
|
},
|
|
363
|
+
/**
|
|
364
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
365
|
+
* @summary Create the payment
|
|
366
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
367
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
368
|
+
* @param {string} [authorization] Bearer Token
|
|
369
|
+
* @param {*} [options] Override http request option.
|
|
370
|
+
* @throws {RequiredError}
|
|
371
|
+
*/
|
|
372
|
+
createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
|
|
373
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
374
|
+
var localVarAxiosArgs;
|
|
375
|
+
return __generator(this, function (_a) {
|
|
376
|
+
switch (_a.label) {
|
|
377
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options)];
|
|
378
|
+
case 1:
|
|
379
|
+
localVarAxiosArgs = _a.sent();
|
|
380
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
381
|
+
}
|
|
382
|
+
});
|
|
383
|
+
});
|
|
384
|
+
},
|
|
294
385
|
/**
|
|
295
386
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
296
387
|
* @summary Retrieve the payment
|
|
@@ -317,19 +408,22 @@ var PaymentsApiFp = function (configuration) {
|
|
|
317
408
|
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
318
409
|
* @summary List payments
|
|
319
410
|
* @param {string} [authorization] Bearer Token
|
|
320
|
-
* @param {
|
|
321
|
-
* @param {string} [
|
|
411
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
412
|
+
* @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.
|
|
413
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
414
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
322
415
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
323
416
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
417
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
324
418
|
* @param {*} [options] Override http request option.
|
|
325
419
|
* @throws {RequiredError}
|
|
326
420
|
*/
|
|
327
|
-
listPayments: function (authorization, filter,
|
|
421
|
+
listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
328
422
|
return __awaiter(this, void 0, void 0, function () {
|
|
329
423
|
var localVarAxiosArgs;
|
|
330
424
|
return __generator(this, function (_a) {
|
|
331
425
|
switch (_a.label) {
|
|
332
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, filter,
|
|
426
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
333
427
|
case 1:
|
|
334
428
|
localVarAxiosArgs = _a.sent();
|
|
335
429
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -348,17 +442,30 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
348
442
|
var localVarFp = (0, exports.PaymentsApiFp)(configuration);
|
|
349
443
|
return {
|
|
350
444
|
/**
|
|
351
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
445
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
352
446
|
* @summary Create the payment
|
|
353
447
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
354
448
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
355
449
|
* @param {string} [authorization] Bearer Token
|
|
356
450
|
* @param {*} [options] Override http request option.
|
|
451
|
+
* @deprecated
|
|
357
452
|
* @throws {RequiredError}
|
|
358
453
|
*/
|
|
359
454
|
createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
|
|
360
455
|
return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
361
456
|
},
|
|
457
|
+
/**
|
|
458
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
459
|
+
* @summary Create the payment
|
|
460
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
461
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
462
|
+
* @param {string} [authorization] Bearer Token
|
|
463
|
+
* @param {*} [options] Override http request option.
|
|
464
|
+
* @throws {RequiredError}
|
|
465
|
+
*/
|
|
466
|
+
createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
|
|
467
|
+
return localVarFp.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
468
|
+
},
|
|
362
469
|
/**
|
|
363
470
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
364
471
|
* @summary Retrieve the payment
|
|
@@ -375,15 +482,18 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
375
482
|
* Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.payments.view\"
|
|
376
483
|
* @summary List payments
|
|
377
484
|
* @param {string} [authorization] Bearer Token
|
|
378
|
-
* @param {
|
|
379
|
-
* @param {string} [
|
|
485
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
486
|
+
* @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.
|
|
487
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
488
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
380
489
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, code, amount</i>
|
|
381
490
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: transactions<i>
|
|
491
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, pspCustomerId, psp, type, amount, receivedDate, referenceNumber, productSlug, accountCode, partnerCode</i>
|
|
382
492
|
* @param {*} [options] Override http request option.
|
|
383
493
|
* @throws {RequiredError}
|
|
384
494
|
*/
|
|
385
|
-
listPayments: function (authorization, filter,
|
|
386
|
-
return localVarFp.listPayments(authorization, filter,
|
|
495
|
+
listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
496
|
+
return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
387
497
|
},
|
|
388
498
|
};
|
|
389
499
|
};
|
|
@@ -400,10 +510,11 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
400
510
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
401
511
|
}
|
|
402
512
|
/**
|
|
403
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
513
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
404
514
|
* @summary Create the payment
|
|
405
515
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
406
516
|
* @param {*} [options] Override http request option.
|
|
517
|
+
* @deprecated
|
|
407
518
|
* @throws {RequiredError}
|
|
408
519
|
* @memberof PaymentsApi
|
|
409
520
|
*/
|
|
@@ -411,6 +522,18 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
411
522
|
var _this = this;
|
|
412
523
|
return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
413
524
|
};
|
|
525
|
+
/**
|
|
526
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
527
|
+
* @summary Create the payment
|
|
528
|
+
* @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
|
|
529
|
+
* @param {*} [options] Override http request option.
|
|
530
|
+
* @throws {RequiredError}
|
|
531
|
+
* @memberof PaymentsApi
|
|
532
|
+
*/
|
|
533
|
+
PaymentsApi.prototype.createPaymentOrder = function (requestParameters, options) {
|
|
534
|
+
var _this = this;
|
|
535
|
+
return (0, exports.PaymentsApiFp)(this.configuration).createPaymentOrder(requestParameters.idempotencyKey, requestParameters.createPaymentOrderDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
536
|
+
};
|
|
414
537
|
/**
|
|
415
538
|
* Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information. **Required Permissions** \"payment-management.payments.view\"
|
|
416
539
|
* @summary Retrieve the payment
|
|
@@ -434,7 +557,7 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
434
557
|
PaymentsApi.prototype.listPayments = function (requestParameters, options) {
|
|
435
558
|
var _this = this;
|
|
436
559
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
437
|
-
return (0, exports.PaymentsApiFp)(this.configuration).listPayments(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
560
|
+
return (0, exports.PaymentsApiFp)(this.configuration).listPayments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
438
561
|
};
|
|
439
562
|
return PaymentsApi;
|
|
440
563
|
}(base_1.BaseAPI));
|
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Emil Payment Service
|
|
3
|
+
* This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
+
import { Configuration } from '../configuration';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreatePolicyPaymentMethodRequestDto } from '../models';
|
|
16
|
+
import { CreatePolicyPaymentMethodResponseClass } from '../models';
|
|
17
|
+
import { ListPolicyPaymentMethodsResponseClass } from '../models';
|
|
18
|
+
/**
|
|
19
|
+
* PolicyPaymentMethodsApi - axios parameter creator
|
|
20
|
+
* @export
|
|
21
|
+
*/
|
|
22
|
+
export declare const PolicyPaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
|
+
/**
|
|
24
|
+
* Attaches a payment method to a policy by creating a policy payment method and setting it as active. Any previous payment method attachment will be deactivated. **Required Permissions** \"payment-management.payments.create\"
|
|
25
|
+
* @summary Create the policy payment method
|
|
26
|
+
* @param {CreatePolicyPaymentMethodRequestDto} createPolicyPaymentMethodRequestDto
|
|
27
|
+
* @param {string} [authorization] Bearer Token
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
createPolicyPaymentMethod: (createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
/**
|
|
33
|
+
* List policy payment methods **Required Permissions** \"payment-management.payments.view\"
|
|
34
|
+
* @summary Retrieve the policy payment methods
|
|
35
|
+
* @param {string} [authorization] Bearer Token
|
|
36
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
37
|
+
* @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.
|
|
38
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
39
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
40
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
41
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
42
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
43
|
+
* @param {*} [options] Override http request option.
|
|
44
|
+
* @throws {RequiredError}
|
|
45
|
+
*/
|
|
46
|
+
listPolicyPaymentMethods: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* PolicyPaymentMethodsApi - functional programming interface
|
|
50
|
+
* @export
|
|
51
|
+
*/
|
|
52
|
+
export declare const PolicyPaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
53
|
+
/**
|
|
54
|
+
* Attaches a payment method to a policy by creating a policy payment method and setting it as active. Any previous payment method attachment will be deactivated. **Required Permissions** \"payment-management.payments.create\"
|
|
55
|
+
* @summary Create the policy payment method
|
|
56
|
+
* @param {CreatePolicyPaymentMethodRequestDto} createPolicyPaymentMethodRequestDto
|
|
57
|
+
* @param {string} [authorization] Bearer Token
|
|
58
|
+
* @param {*} [options] Override http request option.
|
|
59
|
+
* @throws {RequiredError}
|
|
60
|
+
*/
|
|
61
|
+
createPolicyPaymentMethod(createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePolicyPaymentMethodResponseClass>>;
|
|
62
|
+
/**
|
|
63
|
+
* List policy payment methods **Required Permissions** \"payment-management.payments.view\"
|
|
64
|
+
* @summary Retrieve the policy payment methods
|
|
65
|
+
* @param {string} [authorization] Bearer Token
|
|
66
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
67
|
+
* @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.
|
|
68
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
69
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
70
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
71
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
72
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
listPolicyPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPolicyPaymentMethodsResponseClass>>;
|
|
77
|
+
};
|
|
78
|
+
/**
|
|
79
|
+
* PolicyPaymentMethodsApi - factory interface
|
|
80
|
+
* @export
|
|
81
|
+
*/
|
|
82
|
+
export declare const PolicyPaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
83
|
+
/**
|
|
84
|
+
* Attaches a payment method to a policy by creating a policy payment method and setting it as active. Any previous payment method attachment will be deactivated. **Required Permissions** \"payment-management.payments.create\"
|
|
85
|
+
* @summary Create the policy payment method
|
|
86
|
+
* @param {CreatePolicyPaymentMethodRequestDto} createPolicyPaymentMethodRequestDto
|
|
87
|
+
* @param {string} [authorization] Bearer Token
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
createPolicyPaymentMethod(createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePolicyPaymentMethodResponseClass>;
|
|
92
|
+
/**
|
|
93
|
+
* List policy payment methods **Required Permissions** \"payment-management.payments.view\"
|
|
94
|
+
* @summary Retrieve the policy payment methods
|
|
95
|
+
* @param {string} [authorization] Bearer Token
|
|
96
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
97
|
+
* @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.
|
|
98
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
99
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
100
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
101
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
102
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
103
|
+
* @param {*} [options] Override http request option.
|
|
104
|
+
* @throws {RequiredError}
|
|
105
|
+
*/
|
|
106
|
+
listPolicyPaymentMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPolicyPaymentMethodsResponseClass>;
|
|
107
|
+
};
|
|
108
|
+
/**
|
|
109
|
+
* Request parameters for createPolicyPaymentMethod operation in PolicyPaymentMethodsApi.
|
|
110
|
+
* @export
|
|
111
|
+
* @interface PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest
|
|
112
|
+
*/
|
|
113
|
+
export interface PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest {
|
|
114
|
+
/**
|
|
115
|
+
*
|
|
116
|
+
* @type {CreatePolicyPaymentMethodRequestDto}
|
|
117
|
+
* @memberof PolicyPaymentMethodsApiCreatePolicyPaymentMethod
|
|
118
|
+
*/
|
|
119
|
+
readonly createPolicyPaymentMethodRequestDto: CreatePolicyPaymentMethodRequestDto;
|
|
120
|
+
/**
|
|
121
|
+
* Bearer Token
|
|
122
|
+
* @type {string}
|
|
123
|
+
* @memberof PolicyPaymentMethodsApiCreatePolicyPaymentMethod
|
|
124
|
+
*/
|
|
125
|
+
readonly authorization?: string;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Request parameters for listPolicyPaymentMethods operation in PolicyPaymentMethodsApi.
|
|
129
|
+
* @export
|
|
130
|
+
* @interface PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest
|
|
131
|
+
*/
|
|
132
|
+
export interface PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest {
|
|
133
|
+
/**
|
|
134
|
+
* Bearer Token
|
|
135
|
+
* @type {string}
|
|
136
|
+
* @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
|
|
137
|
+
*/
|
|
138
|
+
readonly authorization?: string;
|
|
139
|
+
/**
|
|
140
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
141
|
+
* @type {number}
|
|
142
|
+
* @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
|
|
143
|
+
*/
|
|
144
|
+
readonly pageSize?: number;
|
|
145
|
+
/**
|
|
146
|
+
* 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.
|
|
147
|
+
* @type {string}
|
|
148
|
+
* @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
|
|
149
|
+
*/
|
|
150
|
+
readonly pageToken?: string;
|
|
151
|
+
/**
|
|
152
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
153
|
+
* @type {string}
|
|
154
|
+
* @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
|
|
155
|
+
*/
|
|
156
|
+
readonly filter?: string;
|
|
157
|
+
/**
|
|
158
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
159
|
+
* @type {string}
|
|
160
|
+
* @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
|
|
161
|
+
*/
|
|
162
|
+
readonly search?: string;
|
|
163
|
+
/**
|
|
164
|
+
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
165
|
+
* @type {string}
|
|
166
|
+
* @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
|
|
167
|
+
*/
|
|
168
|
+
readonly order?: string;
|
|
169
|
+
/**
|
|
170
|
+
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
171
|
+
* @type {string}
|
|
172
|
+
* @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
|
|
173
|
+
*/
|
|
174
|
+
readonly expand?: string;
|
|
175
|
+
/**
|
|
176
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
177
|
+
* @type {string}
|
|
178
|
+
* @memberof PolicyPaymentMethodsApiListPolicyPaymentMethods
|
|
179
|
+
*/
|
|
180
|
+
readonly filters?: string;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* PolicyPaymentMethodsApi - object-oriented interface
|
|
184
|
+
* @export
|
|
185
|
+
* @class PolicyPaymentMethodsApi
|
|
186
|
+
* @extends {BaseAPI}
|
|
187
|
+
*/
|
|
188
|
+
export declare class PolicyPaymentMethodsApi extends BaseAPI {
|
|
189
|
+
/**
|
|
190
|
+
* Attaches a payment method to a policy by creating a policy payment method and setting it as active. Any previous payment method attachment will be deactivated. **Required Permissions** \"payment-management.payments.create\"
|
|
191
|
+
* @summary Create the policy payment method
|
|
192
|
+
* @param {PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest} requestParameters Request parameters.
|
|
193
|
+
* @param {*} [options] Override http request option.
|
|
194
|
+
* @throws {RequiredError}
|
|
195
|
+
* @memberof PolicyPaymentMethodsApi
|
|
196
|
+
*/
|
|
197
|
+
createPolicyPaymentMethod(requestParameters: PolicyPaymentMethodsApiCreatePolicyPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyPaymentMethodResponseClass, any>>;
|
|
198
|
+
/**
|
|
199
|
+
* List policy payment methods **Required Permissions** \"payment-management.payments.view\"
|
|
200
|
+
* @summary Retrieve the policy payment methods
|
|
201
|
+
* @param {PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest} requestParameters Request parameters.
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
* @memberof PolicyPaymentMethodsApi
|
|
205
|
+
*/
|
|
206
|
+
listPolicyPaymentMethods(requestParameters?: PolicyPaymentMethodsApiListPolicyPaymentMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyPaymentMethodsResponseClass, any>>;
|
|
207
|
+
}
|