@emilgroup/payment-sdk 1.4.1-beta.5 → 1.4.1-beta.6
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 +6 -0
- package/README.md +2 -2
- package/api/bank-transaction-api.ts +202 -0
- package/api/refunds-api.ts +476 -0
- package/api.ts +2 -0
- package/dist/api/bank-transaction-api.d.ts +110 -0
- package/dist/api/bank-transaction-api.js +184 -0
- package/dist/api/refunds-api.d.ts +269 -0
- package/dist/api/refunds-api.js +449 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/create-refund-request-dto.d.ts +24 -0
- package/dist/models/create-refund-request-dto.js +15 -0
- package/dist/models/create-refund-response-class.d.ts +25 -0
- package/dist/models/create-refund-response-class.js +15 -0
- package/dist/models/get-refund-response-class.d.ts +25 -0
- package/dist/models/get-refund-response-class.js +15 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/dist/models/list-refunds-response-class.d.ts +31 -0
- package/dist/models/list-refunds-response-class.js +15 -0
- package/dist/models/refund-class.d.ts +104 -0
- package/dist/models/refund-class.js +28 -0
- package/models/create-refund-request-dto.ts +30 -0
- package/models/create-refund-response-class.ts +31 -0
- package/models/get-refund-response-class.ts +31 -0
- package/models/index.ts +5 -0
- package/models/list-refunds-response-class.ts +37 -0
- package/models/refund-class.ts +114 -0
- package/package.json +1 -1
|
@@ -194,6 +194,54 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
194
194
|
});
|
|
195
195
|
});
|
|
196
196
|
},
|
|
197
|
+
/**
|
|
198
|
+
* Links a bank transaction with an invoice
|
|
199
|
+
* @summary Link Bank Transaction
|
|
200
|
+
* @param {string} code Code of the bank transaction to link
|
|
201
|
+
* @param {string} [authorization] Bearer Token
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
*/
|
|
205
|
+
linkBankTransaction: function (code, authorization, options) {
|
|
206
|
+
if (options === void 0) { options = {}; }
|
|
207
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
208
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
209
|
+
return __generator(this, function (_a) {
|
|
210
|
+
switch (_a.label) {
|
|
211
|
+
case 0:
|
|
212
|
+
// verify required parameter 'code' is not null or undefined
|
|
213
|
+
(0, common_1.assertParamExists)('linkBankTransaction', 'code', code);
|
|
214
|
+
localVarPath = "/paymentservice/v1/tenant/bank-transactions/{code}/link"
|
|
215
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
216
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
217
|
+
if (configuration) {
|
|
218
|
+
baseOptions = configuration.baseOptions;
|
|
219
|
+
baseAccessToken = configuration.accessToken;
|
|
220
|
+
}
|
|
221
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
222
|
+
localVarHeaderParameter = {};
|
|
223
|
+
localVarQueryParameter = {};
|
|
224
|
+
// authentication bearer required
|
|
225
|
+
// http bearer authentication required
|
|
226
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
227
|
+
case 1:
|
|
228
|
+
// authentication bearer required
|
|
229
|
+
// http bearer authentication required
|
|
230
|
+
_a.sent();
|
|
231
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
232
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
233
|
+
}
|
|
234
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
235
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
236
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
237
|
+
return [2 /*return*/, {
|
|
238
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
239
|
+
options: localVarRequestOptions,
|
|
240
|
+
}];
|
|
241
|
+
}
|
|
242
|
+
});
|
|
243
|
+
});
|
|
244
|
+
},
|
|
197
245
|
/**
|
|
198
246
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
199
247
|
* @summary List bank transactions
|
|
@@ -266,6 +314,54 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
266
314
|
});
|
|
267
315
|
});
|
|
268
316
|
},
|
|
317
|
+
/**
|
|
318
|
+
* Unlinks an already linked bank transaction
|
|
319
|
+
* @summary Unlink Bank Transaction
|
|
320
|
+
* @param {string} code Code of the bank transaction to unlink
|
|
321
|
+
* @param {string} [authorization] Bearer Token
|
|
322
|
+
* @param {*} [options] Override http request option.
|
|
323
|
+
* @throws {RequiredError}
|
|
324
|
+
*/
|
|
325
|
+
unlinkBankTransaction: function (code, authorization, options) {
|
|
326
|
+
if (options === void 0) { options = {}; }
|
|
327
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
328
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
329
|
+
return __generator(this, function (_a) {
|
|
330
|
+
switch (_a.label) {
|
|
331
|
+
case 0:
|
|
332
|
+
// verify required parameter 'code' is not null or undefined
|
|
333
|
+
(0, common_1.assertParamExists)('unlinkBankTransaction', 'code', code);
|
|
334
|
+
localVarPath = "/paymentservice/v1/tenant/bank-transactions/{code}/unlink"
|
|
335
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
336
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
337
|
+
if (configuration) {
|
|
338
|
+
baseOptions = configuration.baseOptions;
|
|
339
|
+
baseAccessToken = configuration.accessToken;
|
|
340
|
+
}
|
|
341
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
342
|
+
localVarHeaderParameter = {};
|
|
343
|
+
localVarQueryParameter = {};
|
|
344
|
+
// authentication bearer required
|
|
345
|
+
// http bearer authentication required
|
|
346
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
347
|
+
case 1:
|
|
348
|
+
// authentication bearer required
|
|
349
|
+
// http bearer authentication required
|
|
350
|
+
_a.sent();
|
|
351
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
352
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
353
|
+
}
|
|
354
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
355
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
356
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
357
|
+
return [2 /*return*/, {
|
|
358
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
359
|
+
options: localVarRequestOptions,
|
|
360
|
+
}];
|
|
361
|
+
}
|
|
362
|
+
});
|
|
363
|
+
});
|
|
364
|
+
},
|
|
269
365
|
};
|
|
270
366
|
};
|
|
271
367
|
exports.BankTransactionApiAxiosParamCreator = BankTransactionApiAxiosParamCreator;
|
|
@@ -319,6 +415,27 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
319
415
|
});
|
|
320
416
|
});
|
|
321
417
|
},
|
|
418
|
+
/**
|
|
419
|
+
* Links a bank transaction with an invoice
|
|
420
|
+
* @summary Link Bank Transaction
|
|
421
|
+
* @param {string} code Code of the bank transaction to link
|
|
422
|
+
* @param {string} [authorization] Bearer Token
|
|
423
|
+
* @param {*} [options] Override http request option.
|
|
424
|
+
* @throws {RequiredError}
|
|
425
|
+
*/
|
|
426
|
+
linkBankTransaction: function (code, authorization, options) {
|
|
427
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
428
|
+
var localVarAxiosArgs;
|
|
429
|
+
return __generator(this, function (_a) {
|
|
430
|
+
switch (_a.label) {
|
|
431
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.linkBankTransaction(code, authorization, options)];
|
|
432
|
+
case 1:
|
|
433
|
+
localVarAxiosArgs = _a.sent();
|
|
434
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
435
|
+
}
|
|
436
|
+
});
|
|
437
|
+
});
|
|
438
|
+
},
|
|
322
439
|
/**
|
|
323
440
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
324
441
|
* @summary List bank transactions
|
|
@@ -346,6 +463,27 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
346
463
|
});
|
|
347
464
|
});
|
|
348
465
|
},
|
|
466
|
+
/**
|
|
467
|
+
* Unlinks an already linked bank transaction
|
|
468
|
+
* @summary Unlink Bank Transaction
|
|
469
|
+
* @param {string} code Code of the bank transaction to unlink
|
|
470
|
+
* @param {string} [authorization] Bearer Token
|
|
471
|
+
* @param {*} [options] Override http request option.
|
|
472
|
+
* @throws {RequiredError}
|
|
473
|
+
*/
|
|
474
|
+
unlinkBankTransaction: function (code, authorization, options) {
|
|
475
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
476
|
+
var localVarAxiosArgs;
|
|
477
|
+
return __generator(this, function (_a) {
|
|
478
|
+
switch (_a.label) {
|
|
479
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.unlinkBankTransaction(code, authorization, options)];
|
|
480
|
+
case 1:
|
|
481
|
+
localVarAxiosArgs = _a.sent();
|
|
482
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
483
|
+
}
|
|
484
|
+
});
|
|
485
|
+
});
|
|
486
|
+
},
|
|
349
487
|
};
|
|
350
488
|
};
|
|
351
489
|
exports.BankTransactionApiFp = BankTransactionApiFp;
|
|
@@ -379,6 +517,17 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
379
517
|
importBankTransactions: function (authorization, file, options) {
|
|
380
518
|
return localVarFp.importBankTransactions(authorization, file, options).then(function (request) { return request(axios, basePath); });
|
|
381
519
|
},
|
|
520
|
+
/**
|
|
521
|
+
* Links a bank transaction with an invoice
|
|
522
|
+
* @summary Link Bank Transaction
|
|
523
|
+
* @param {string} code Code of the bank transaction to link
|
|
524
|
+
* @param {string} [authorization] Bearer Token
|
|
525
|
+
* @param {*} [options] Override http request option.
|
|
526
|
+
* @throws {RequiredError}
|
|
527
|
+
*/
|
|
528
|
+
linkBankTransaction: function (code, authorization, options) {
|
|
529
|
+
return localVarFp.linkBankTransaction(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
530
|
+
},
|
|
382
531
|
/**
|
|
383
532
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
384
533
|
* @summary List bank transactions
|
|
@@ -396,6 +545,17 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
396
545
|
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
397
546
|
return localVarFp.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
398
547
|
},
|
|
548
|
+
/**
|
|
549
|
+
* Unlinks an already linked bank transaction
|
|
550
|
+
* @summary Unlink Bank Transaction
|
|
551
|
+
* @param {string} code Code of the bank transaction to unlink
|
|
552
|
+
* @param {string} [authorization] Bearer Token
|
|
553
|
+
* @param {*} [options] Override http request option.
|
|
554
|
+
* @throws {RequiredError}
|
|
555
|
+
*/
|
|
556
|
+
unlinkBankTransaction: function (code, authorization, options) {
|
|
557
|
+
return localVarFp.unlinkBankTransaction(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
558
|
+
},
|
|
399
559
|
};
|
|
400
560
|
};
|
|
401
561
|
exports.BankTransactionApiFactory = BankTransactionApiFactory;
|
|
@@ -435,6 +595,18 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
435
595
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
436
596
|
return (0, exports.BankTransactionApiFp)(this.configuration).importBankTransactions(requestParameters.authorization, requestParameters.file, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
437
597
|
};
|
|
598
|
+
/**
|
|
599
|
+
* Links a bank transaction with an invoice
|
|
600
|
+
* @summary Link Bank Transaction
|
|
601
|
+
* @param {BankTransactionApiLinkBankTransactionRequest} requestParameters Request parameters.
|
|
602
|
+
* @param {*} [options] Override http request option.
|
|
603
|
+
* @throws {RequiredError}
|
|
604
|
+
* @memberof BankTransactionApi
|
|
605
|
+
*/
|
|
606
|
+
BankTransactionApi.prototype.linkBankTransaction = function (requestParameters, options) {
|
|
607
|
+
var _this = this;
|
|
608
|
+
return (0, exports.BankTransactionApiFp)(this.configuration).linkBankTransaction(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
609
|
+
};
|
|
438
610
|
/**
|
|
439
611
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
440
612
|
* @summary List bank transactions
|
|
@@ -448,6 +620,18 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
448
620
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
449
621
|
return (0, exports.BankTransactionApiFp)(this.configuration).listBankTransactions(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); });
|
|
450
622
|
};
|
|
623
|
+
/**
|
|
624
|
+
* Unlinks an already linked bank transaction
|
|
625
|
+
* @summary Unlink Bank Transaction
|
|
626
|
+
* @param {BankTransactionApiUnlinkBankTransactionRequest} requestParameters Request parameters.
|
|
627
|
+
* @param {*} [options] Override http request option.
|
|
628
|
+
* @throws {RequiredError}
|
|
629
|
+
* @memberof BankTransactionApi
|
|
630
|
+
*/
|
|
631
|
+
BankTransactionApi.prototype.unlinkBankTransaction = function (requestParameters, options) {
|
|
632
|
+
var _this = this;
|
|
633
|
+
return (0, exports.BankTransactionApiFp)(this.configuration).unlinkBankTransaction(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
634
|
+
};
|
|
451
635
|
return BankTransactionApi;
|
|
452
636
|
}(base_1.BaseAPI));
|
|
453
637
|
exports.BankTransactionApi = BankTransactionApi;
|
|
@@ -0,0 +1,269 @@
|
|
|
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 { CreateRefundRequestDto } from '../models';
|
|
16
|
+
import { CreateRefundResponseClass } from '../models';
|
|
17
|
+
import { GetRefundResponseClass } from '../models';
|
|
18
|
+
import { ListRefundsResponseClass } from '../models';
|
|
19
|
+
/**
|
|
20
|
+
* RefundsApi - axios parameter creator
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
27
|
+
* @param {string} [authorization] Bearer Token
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
createRefund: (createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @param {string} code
|
|
35
|
+
* @param {string} code2 Unique identifier for the object.
|
|
36
|
+
* @param {string} expand Fields to expand response by
|
|
37
|
+
* @param {string} [authorization] Bearer Token
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
getRefund: (code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @param {string} [authorization] Bearer Token
|
|
45
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
46
|
+
* @param {any} [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.
|
|
47
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
48
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
49
|
+
* @param {any} [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.
|
|
50
|
+
* @param {any} [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.
|
|
51
|
+
* @param {any} [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.
|
|
52
|
+
* @param {*} [options] Override http request option.
|
|
53
|
+
* @throws {RequiredError}
|
|
54
|
+
*/
|
|
55
|
+
listRefunds: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
|
+
};
|
|
57
|
+
/**
|
|
58
|
+
* RefundsApi - functional programming interface
|
|
59
|
+
* @export
|
|
60
|
+
*/
|
|
61
|
+
export declare const RefundsApiFp: (configuration?: Configuration) => {
|
|
62
|
+
/**
|
|
63
|
+
*
|
|
64
|
+
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
65
|
+
* @param {string} [authorization] Bearer Token
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateRefundResponseClass>>;
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @param {string} code
|
|
73
|
+
* @param {string} code2 Unique identifier for the object.
|
|
74
|
+
* @param {string} expand Fields to expand response by
|
|
75
|
+
* @param {string} [authorization] Bearer Token
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
getRefund(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRefundResponseClass>>;
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @param {string} [authorization] Bearer Token
|
|
83
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
84
|
+
* @param {any} [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.
|
|
85
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
86
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
87
|
+
* @param {any} [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.
|
|
88
|
+
* @param {any} [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.
|
|
89
|
+
* @param {any} [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.
|
|
90
|
+
* @param {*} [options] Override http request option.
|
|
91
|
+
* @throws {RequiredError}
|
|
92
|
+
*/
|
|
93
|
+
listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListRefundsResponseClass>>;
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* RefundsApi - factory interface
|
|
97
|
+
* @export
|
|
98
|
+
*/
|
|
99
|
+
export declare const RefundsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
100
|
+
/**
|
|
101
|
+
*
|
|
102
|
+
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
103
|
+
* @param {string} [authorization] Bearer Token
|
|
104
|
+
* @param {*} [options] Override http request option.
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
*/
|
|
107
|
+
createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<CreateRefundResponseClass>;
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @param {string} code
|
|
111
|
+
* @param {string} code2 Unique identifier for the object.
|
|
112
|
+
* @param {string} expand Fields to expand response by
|
|
113
|
+
* @param {string} [authorization] Bearer Token
|
|
114
|
+
* @param {*} [options] Override http request option.
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
getRefund(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetRefundResponseClass>;
|
|
118
|
+
/**
|
|
119
|
+
*
|
|
120
|
+
* @param {string} [authorization] Bearer Token
|
|
121
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
122
|
+
* @param {any} [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.
|
|
123
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
124
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
125
|
+
* @param {any} [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.
|
|
126
|
+
* @param {any} [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.
|
|
127
|
+
* @param {any} [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.
|
|
128
|
+
* @param {*} [options] Override http request option.
|
|
129
|
+
* @throws {RequiredError}
|
|
130
|
+
*/
|
|
131
|
+
listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListRefundsResponseClass>;
|
|
132
|
+
};
|
|
133
|
+
/**
|
|
134
|
+
* Request parameters for createRefund operation in RefundsApi.
|
|
135
|
+
* @export
|
|
136
|
+
* @interface RefundsApiCreateRefundRequest
|
|
137
|
+
*/
|
|
138
|
+
export interface RefundsApiCreateRefundRequest {
|
|
139
|
+
/**
|
|
140
|
+
*
|
|
141
|
+
* @type {CreateRefundRequestDto}
|
|
142
|
+
* @memberof RefundsApiCreateRefund
|
|
143
|
+
*/
|
|
144
|
+
readonly createRefundRequestDto: CreateRefundRequestDto;
|
|
145
|
+
/**
|
|
146
|
+
* Bearer Token
|
|
147
|
+
* @type {string}
|
|
148
|
+
* @memberof RefundsApiCreateRefund
|
|
149
|
+
*/
|
|
150
|
+
readonly authorization?: string;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Request parameters for getRefund operation in RefundsApi.
|
|
154
|
+
* @export
|
|
155
|
+
* @interface RefundsApiGetRefundRequest
|
|
156
|
+
*/
|
|
157
|
+
export interface RefundsApiGetRefundRequest {
|
|
158
|
+
/**
|
|
159
|
+
*
|
|
160
|
+
* @type {string}
|
|
161
|
+
* @memberof RefundsApiGetRefund
|
|
162
|
+
*/
|
|
163
|
+
readonly code: string;
|
|
164
|
+
/**
|
|
165
|
+
* Unique identifier for the object.
|
|
166
|
+
* @type {string}
|
|
167
|
+
* @memberof RefundsApiGetRefund
|
|
168
|
+
*/
|
|
169
|
+
readonly code2: string;
|
|
170
|
+
/**
|
|
171
|
+
* Fields to expand response by
|
|
172
|
+
* @type {string}
|
|
173
|
+
* @memberof RefundsApiGetRefund
|
|
174
|
+
*/
|
|
175
|
+
readonly expand: string;
|
|
176
|
+
/**
|
|
177
|
+
* Bearer Token
|
|
178
|
+
* @type {string}
|
|
179
|
+
* @memberof RefundsApiGetRefund
|
|
180
|
+
*/
|
|
181
|
+
readonly authorization?: string;
|
|
182
|
+
}
|
|
183
|
+
/**
|
|
184
|
+
* Request parameters for listRefunds operation in RefundsApi.
|
|
185
|
+
* @export
|
|
186
|
+
* @interface RefundsApiListRefundsRequest
|
|
187
|
+
*/
|
|
188
|
+
export interface RefundsApiListRefundsRequest {
|
|
189
|
+
/**
|
|
190
|
+
* Bearer Token
|
|
191
|
+
* @type {string}
|
|
192
|
+
* @memberof RefundsApiListRefunds
|
|
193
|
+
*/
|
|
194
|
+
readonly authorization?: string;
|
|
195
|
+
/**
|
|
196
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
197
|
+
* @type {any}
|
|
198
|
+
* @memberof RefundsApiListRefunds
|
|
199
|
+
*/
|
|
200
|
+
readonly pageSize?: any;
|
|
201
|
+
/**
|
|
202
|
+
* 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.
|
|
203
|
+
* @type {any}
|
|
204
|
+
* @memberof RefundsApiListRefunds
|
|
205
|
+
*/
|
|
206
|
+
readonly pageToken?: any;
|
|
207
|
+
/**
|
|
208
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
209
|
+
* @type {any}
|
|
210
|
+
* @memberof RefundsApiListRefunds
|
|
211
|
+
*/
|
|
212
|
+
readonly filter?: any;
|
|
213
|
+
/**
|
|
214
|
+
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
215
|
+
* @type {any}
|
|
216
|
+
* @memberof RefundsApiListRefunds
|
|
217
|
+
*/
|
|
218
|
+
readonly search?: any;
|
|
219
|
+
/**
|
|
220
|
+
* 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.
|
|
221
|
+
* @type {any}
|
|
222
|
+
* @memberof RefundsApiListRefunds
|
|
223
|
+
*/
|
|
224
|
+
readonly order?: any;
|
|
225
|
+
/**
|
|
226
|
+
* 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.
|
|
227
|
+
* @type {any}
|
|
228
|
+
* @memberof RefundsApiListRefunds
|
|
229
|
+
*/
|
|
230
|
+
readonly expand?: any;
|
|
231
|
+
/**
|
|
232
|
+
* 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.
|
|
233
|
+
* @type {any}
|
|
234
|
+
* @memberof RefundsApiListRefunds
|
|
235
|
+
*/
|
|
236
|
+
readonly filters?: any;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* RefundsApi - object-oriented interface
|
|
240
|
+
* @export
|
|
241
|
+
* @class RefundsApi
|
|
242
|
+
* @extends {BaseAPI}
|
|
243
|
+
*/
|
|
244
|
+
export declare class RefundsApi extends BaseAPI {
|
|
245
|
+
/**
|
|
246
|
+
*
|
|
247
|
+
* @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
|
|
248
|
+
* @param {*} [options] Override http request option.
|
|
249
|
+
* @throws {RequiredError}
|
|
250
|
+
* @memberof RefundsApi
|
|
251
|
+
*/
|
|
252
|
+
createRefund(requestParameters: RefundsApiCreateRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateRefundResponseClass, any>>;
|
|
253
|
+
/**
|
|
254
|
+
*
|
|
255
|
+
* @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
|
|
256
|
+
* @param {*} [options] Override http request option.
|
|
257
|
+
* @throws {RequiredError}
|
|
258
|
+
* @memberof RefundsApi
|
|
259
|
+
*/
|
|
260
|
+
getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetRefundResponseClass, any>>;
|
|
261
|
+
/**
|
|
262
|
+
*
|
|
263
|
+
* @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
|
|
264
|
+
* @param {*} [options] Override http request option.
|
|
265
|
+
* @throws {RequiredError}
|
|
266
|
+
* @memberof RefundsApi
|
|
267
|
+
*/
|
|
268
|
+
listRefunds(requestParameters?: RefundsApiListRefundsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListRefundsResponseClass, any>>;
|
|
269
|
+
}
|