@emilgroup/payment-sdk-node 1.3.0 → 1.5.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/.openapi-generator/FILES +9 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +174 -0
- package/api/default-api.ts +124 -0
- package/api/payment-methods-api.ts +16 -16
- package/api/payment-reminders-api.ts +16 -16
- package/api/payments-api.ts +16 -16
- package/api.ts +2 -0
- package/dist/api/bank-accounts-api.d.ts +101 -0
- package/dist/api/bank-accounts-api.js +123 -0
- package/dist/api/default-api.d.ts +66 -0
- package/dist/api/default-api.js +200 -0
- package/dist/api/payment-methods-api.d.ts +16 -16
- package/dist/api/payment-methods-api.js +12 -12
- package/dist/api/payment-reminders-api.d.ts +16 -16
- package/dist/api/payment-reminders-api.js +12 -12
- package/dist/api/payments-api.d.ts +16 -16
- package/dist/api/payments-api.js +12 -12
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/bank-account-class.d.ts +54 -0
- package/dist/models/bank-account-class.js +15 -0
- package/dist/models/billing-profile-dto.d.ts +38 -0
- package/dist/models/billing-profile-dto.js +15 -0
- package/dist/models/billing-profile-limited-response-dto.d.ts +54 -0
- package/dist/models/billing-profile-limited-response-dto.js +15 -0
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-psp-payment-method-request-dto.d.ts +8 -0
- package/dist/models/create-psp-payment-method-request-dto.js +2 -1
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/inline-response200.d.ts +54 -0
- package/dist/models/inline-response200.js +15 -0
- package/dist/models/inline-response503.d.ts +54 -0
- package/dist/models/inline-response503.js +15 -0
- package/dist/models/list-bank-accounts-response-class.d.ts +31 -0
- package/dist/models/list-bank-accounts-response-class.js +15 -0
- package/dist/models/payment-class.d.ts +15 -2
- package/dist/models/symphony-profile-limited-response-dto.d.ts +42 -0
- package/dist/models/symphony-profile-limited-response-dto.js +15 -0
- package/dist/models/transaction-class.d.ts +54 -0
- package/dist/models/transaction-class.js +15 -0
- package/dist/models/validate-pspconfig-request-dto.d.ts +1 -0
- package/dist/models/validate-pspconfig-request-dto.js +2 -1
- package/models/bank-account-class.ts +60 -0
- package/models/billing-profile-dto.ts +44 -0
- package/models/billing-profile-limited-response-dto.ts +60 -0
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-psp-payment-method-request-dto.ts +9 -1
- package/models/index.ts +8 -0
- package/models/initiate-payment-setup-request-dto.ts +6 -0
- package/models/inline-response200.ts +48 -0
- package/models/inline-response503.ts +48 -0
- package/models/list-bank-accounts-response-class.ts +37 -0
- package/models/payment-class.ts +15 -2
- package/models/symphony-profile-limited-response-dto.ts +48 -0
- package/models/transaction-class.ts +60 -0
- package/models/validate-pspconfig-request-dto.ts +2 -1
- package/package.json +1 -1
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Emil Payment Service
|
|
6
|
+
* 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.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __extends = (this && this.__extends) || (function () {
|
|
16
|
+
var extendStatics = function (d, b) {
|
|
17
|
+
extendStatics = Object.setPrototypeOf ||
|
|
18
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
+
return extendStatics(d, b);
|
|
21
|
+
};
|
|
22
|
+
return function (d, b) {
|
|
23
|
+
if (typeof b !== "function" && b !== null)
|
|
24
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
25
|
+
extendStatics(d, b);
|
|
26
|
+
function __() { this.constructor = d; }
|
|
27
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
28
|
+
};
|
|
29
|
+
})();
|
|
30
|
+
var __assign = (this && this.__assign) || function () {
|
|
31
|
+
__assign = Object.assign || function(t) {
|
|
32
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
33
|
+
s = arguments[i];
|
|
34
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
35
|
+
t[p] = s[p];
|
|
36
|
+
}
|
|
37
|
+
return t;
|
|
38
|
+
};
|
|
39
|
+
return __assign.apply(this, arguments);
|
|
40
|
+
};
|
|
41
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
42
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
43
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
44
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
45
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
46
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
47
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
48
|
+
});
|
|
49
|
+
};
|
|
50
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
51
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
52
|
+
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
53
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
54
|
+
function step(op) {
|
|
55
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
56
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
57
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
58
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
59
|
+
switch (op[0]) {
|
|
60
|
+
case 0: case 1: t = op; break;
|
|
61
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
62
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
63
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
64
|
+
default:
|
|
65
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
66
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
67
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
68
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
69
|
+
if (t[2]) _.ops.pop();
|
|
70
|
+
_.trys.pop(); continue;
|
|
71
|
+
}
|
|
72
|
+
op = body.call(thisArg, _);
|
|
73
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
74
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
78
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
|
+
};
|
|
80
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
+
exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = void 0;
|
|
82
|
+
var axios_1 = __importDefault(require("axios"));
|
|
83
|
+
// Some imports not used depending on template conditions
|
|
84
|
+
// @ts-ignore
|
|
85
|
+
var common_1 = require("../common");
|
|
86
|
+
// @ts-ignore
|
|
87
|
+
var base_1 = require("../base");
|
|
88
|
+
// URLSearchParams not necessarily used
|
|
89
|
+
// @ts-ignore
|
|
90
|
+
var url_1 = require("url");
|
|
91
|
+
var FormData = require('form-data');
|
|
92
|
+
/**
|
|
93
|
+
* DefaultApi - axios parameter creator
|
|
94
|
+
* @export
|
|
95
|
+
*/
|
|
96
|
+
var DefaultApiAxiosParamCreator = function (configuration) {
|
|
97
|
+
var _this = this;
|
|
98
|
+
return {
|
|
99
|
+
/**
|
|
100
|
+
*
|
|
101
|
+
* @param {*} [options] Override http request option.
|
|
102
|
+
* @throws {RequiredError}
|
|
103
|
+
*/
|
|
104
|
+
check: function (options) {
|
|
105
|
+
if (options === void 0) { options = {}; }
|
|
106
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
107
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
108
|
+
return __generator(this, function (_a) {
|
|
109
|
+
localVarPath = "/paymentservice/health";
|
|
110
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
111
|
+
if (configuration) {
|
|
112
|
+
baseOptions = configuration.baseOptions;
|
|
113
|
+
baseAccessToken = configuration.accessToken;
|
|
114
|
+
}
|
|
115
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
116
|
+
localVarHeaderParameter = {};
|
|
117
|
+
localVarQueryParameter = {};
|
|
118
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
119
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
120
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
121
|
+
return [2 /*return*/, {
|
|
122
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
123
|
+
options: localVarRequestOptions,
|
|
124
|
+
}];
|
|
125
|
+
});
|
|
126
|
+
});
|
|
127
|
+
},
|
|
128
|
+
};
|
|
129
|
+
};
|
|
130
|
+
exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
|
|
131
|
+
/**
|
|
132
|
+
* DefaultApi - functional programming interface
|
|
133
|
+
* @export
|
|
134
|
+
*/
|
|
135
|
+
var DefaultApiFp = function (configuration) {
|
|
136
|
+
var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
|
|
137
|
+
return {
|
|
138
|
+
/**
|
|
139
|
+
*
|
|
140
|
+
* @param {*} [options] Override http request option.
|
|
141
|
+
* @throws {RequiredError}
|
|
142
|
+
*/
|
|
143
|
+
check: function (options) {
|
|
144
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
145
|
+
var localVarAxiosArgs;
|
|
146
|
+
return __generator(this, function (_a) {
|
|
147
|
+
switch (_a.label) {
|
|
148
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.check(options)];
|
|
149
|
+
case 1:
|
|
150
|
+
localVarAxiosArgs = _a.sent();
|
|
151
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
152
|
+
}
|
|
153
|
+
});
|
|
154
|
+
});
|
|
155
|
+
},
|
|
156
|
+
};
|
|
157
|
+
};
|
|
158
|
+
exports.DefaultApiFp = DefaultApiFp;
|
|
159
|
+
/**
|
|
160
|
+
* DefaultApi - factory interface
|
|
161
|
+
* @export
|
|
162
|
+
*/
|
|
163
|
+
var DefaultApiFactory = function (configuration, basePath, axios) {
|
|
164
|
+
var localVarFp = (0, exports.DefaultApiFp)(configuration);
|
|
165
|
+
return {
|
|
166
|
+
/**
|
|
167
|
+
*
|
|
168
|
+
* @param {*} [options] Override http request option.
|
|
169
|
+
* @throws {RequiredError}
|
|
170
|
+
*/
|
|
171
|
+
check: function (options) {
|
|
172
|
+
return localVarFp.check(options).then(function (request) { return request(axios, basePath); });
|
|
173
|
+
},
|
|
174
|
+
};
|
|
175
|
+
};
|
|
176
|
+
exports.DefaultApiFactory = DefaultApiFactory;
|
|
177
|
+
/**
|
|
178
|
+
* DefaultApi - object-oriented interface
|
|
179
|
+
* @export
|
|
180
|
+
* @class DefaultApi
|
|
181
|
+
* @extends {BaseAPI}
|
|
182
|
+
*/
|
|
183
|
+
var DefaultApi = /** @class */ (function (_super) {
|
|
184
|
+
__extends(DefaultApi, _super);
|
|
185
|
+
function DefaultApi() {
|
|
186
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
*
|
|
190
|
+
* @param {*} [options] Override http request option.
|
|
191
|
+
* @throws {RequiredError}
|
|
192
|
+
* @memberof DefaultApi
|
|
193
|
+
*/
|
|
194
|
+
DefaultApi.prototype.check = function (options) {
|
|
195
|
+
var _this = this;
|
|
196
|
+
return (0, exports.DefaultApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
197
|
+
};
|
|
198
|
+
return DefaultApi;
|
|
199
|
+
}(base_1.BaseAPI));
|
|
200
|
+
exports.DefaultApi = DefaultApi;
|
|
@@ -54,12 +54,12 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
54
54
|
* Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
55
55
|
* @summary List payment methods
|
|
56
56
|
* @param {string} [authorization] Bearer Token
|
|
57
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
58
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
57
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
58
|
+
* @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.
|
|
59
59
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
60
60
|
* @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.
|
|
61
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
62
|
-
* @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
|
|
61
|
+
* @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.
|
|
62
|
+
* @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.
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
65
65
|
*/
|
|
@@ -103,12 +103,12 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
103
103
|
* Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
104
104
|
* @summary List payment methods
|
|
105
105
|
* @param {string} [authorization] Bearer Token
|
|
106
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
107
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
106
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
107
|
+
* @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.
|
|
108
108
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
109
109
|
* @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.
|
|
110
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
111
|
-
* @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
|
|
110
|
+
* @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.
|
|
111
|
+
* @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.
|
|
112
112
|
* @param {*} [options] Override http request option.
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
@@ -152,12 +152,12 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
152
152
|
* Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
153
153
|
* @summary List payment methods
|
|
154
154
|
* @param {string} [authorization] Bearer Token
|
|
155
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
156
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
155
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
156
|
+
* @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.
|
|
157
157
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
158
158
|
* @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.
|
|
159
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
160
|
-
* @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
|
|
159
|
+
* @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.
|
|
160
|
+
* @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.
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
162
162
|
* @throws {RequiredError}
|
|
163
163
|
*/
|
|
@@ -245,13 +245,13 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
245
245
|
*/
|
|
246
246
|
readonly authorization?: string;
|
|
247
247
|
/**
|
|
248
|
-
* A limit on the number of objects to be returned.
|
|
248
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
249
249
|
* @type {any}
|
|
250
250
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
251
251
|
*/
|
|
252
252
|
readonly pageSize?: any;
|
|
253
253
|
/**
|
|
254
|
-
* A cursor for use in pagination.
|
|
254
|
+
* 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.
|
|
255
255
|
* @type {any}
|
|
256
256
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
257
257
|
*/
|
|
@@ -269,13 +269,13 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
269
269
|
*/
|
|
270
270
|
readonly search?: any;
|
|
271
271
|
/**
|
|
272
|
-
* The order parameter determines how the results should be sorted according to a specified field.
|
|
272
|
+
* 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.
|
|
273
273
|
* @type {any}
|
|
274
274
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
275
275
|
*/
|
|
276
276
|
readonly order?: any;
|
|
277
277
|
/**
|
|
278
|
-
* 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
|
|
278
|
+
* 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.
|
|
279
279
|
* @type {any}
|
|
280
280
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
281
281
|
*/
|
|
@@ -257,12 +257,12 @@ var PaymentMethodsApiAxiosParamCreator = function (configuration) {
|
|
|
257
257
|
* Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
258
258
|
* @summary List payment methods
|
|
259
259
|
* @param {string} [authorization] Bearer Token
|
|
260
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
261
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
260
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
261
|
+
* @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.
|
|
262
262
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
263
263
|
* @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.
|
|
264
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
265
|
-
* @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
|
|
264
|
+
* @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.
|
|
265
|
+
* @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.
|
|
266
266
|
* @param {*} [options] Override http request option.
|
|
267
267
|
* @throws {RequiredError}
|
|
268
268
|
*/
|
|
@@ -400,12 +400,12 @@ var PaymentMethodsApiFp = function (configuration) {
|
|
|
400
400
|
* Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
401
401
|
* @summary List payment methods
|
|
402
402
|
* @param {string} [authorization] Bearer Token
|
|
403
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
404
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
403
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
404
|
+
* @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.
|
|
405
405
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
406
406
|
* @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.
|
|
407
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
408
|
-
* @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
|
|
407
|
+
* @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.
|
|
408
|
+
* @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.
|
|
409
409
|
* @param {*} [options] Override http request option.
|
|
410
410
|
* @throws {RequiredError}
|
|
411
411
|
*/
|
|
@@ -471,12 +471,12 @@ var PaymentMethodsApiFactory = function (configuration, basePath, axios) {
|
|
|
471
471
|
* Returns a list of payment methods you’ve previously created. The payment methods are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
472
472
|
* @summary List payment methods
|
|
473
473
|
* @param {string} [authorization] Bearer Token
|
|
474
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
475
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
474
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
475
|
+
* @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.
|
|
476
476
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
477
477
|
* @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.
|
|
478
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
479
|
-
* @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
|
|
478
|
+
* @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.
|
|
479
|
+
* @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.
|
|
480
480
|
* @param {*} [options] Override http request option.
|
|
481
481
|
* @throws {RequiredError}
|
|
482
482
|
*/
|
|
@@ -52,12 +52,12 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
|
|
|
52
52
|
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
53
53
|
* @summary List payment reminders
|
|
54
54
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
55
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
56
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
55
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
56
|
+
* @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.
|
|
57
57
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
58
58
|
* @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.
|
|
59
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
60
|
-
* @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
|
|
59
|
+
* @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.
|
|
60
|
+
* @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.
|
|
61
61
|
* @param {*} [options] Override http request option.
|
|
62
62
|
* @throws {RequiredError}
|
|
63
63
|
*/
|
|
@@ -100,12 +100,12 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
|
|
|
100
100
|
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
101
101
|
* @summary List payment reminders
|
|
102
102
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
103
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
104
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
103
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
104
|
+
* @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.
|
|
105
105
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
106
106
|
* @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.
|
|
107
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
108
|
-
* @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
|
|
107
|
+
* @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.
|
|
108
|
+
* @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.
|
|
109
109
|
* @param {*} [options] Override http request option.
|
|
110
110
|
* @throws {RequiredError}
|
|
111
111
|
*/
|
|
@@ -148,12 +148,12 @@ export declare const PaymentRemindersApiFactory: (configuration?: Configuration,
|
|
|
148
148
|
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
149
149
|
* @summary List payment reminders
|
|
150
150
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
151
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
152
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
151
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
152
|
+
* @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.
|
|
153
153
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
154
154
|
* @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.
|
|
155
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
156
|
-
* @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
|
|
155
|
+
* @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.
|
|
156
|
+
* @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.
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
158
158
|
* @throws {RequiredError}
|
|
159
159
|
*/
|
|
@@ -235,13 +235,13 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
235
235
|
*/
|
|
236
236
|
readonly authorization?: string;
|
|
237
237
|
/**
|
|
238
|
-
* A limit on the number of objects to be returned.
|
|
238
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
239
239
|
* @type {any}
|
|
240
240
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
241
241
|
*/
|
|
242
242
|
readonly pageSize?: any;
|
|
243
243
|
/**
|
|
244
|
-
* A cursor for use in pagination.
|
|
244
|
+
* 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.
|
|
245
245
|
* @type {any}
|
|
246
246
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
247
247
|
*/
|
|
@@ -259,13 +259,13 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
259
259
|
*/
|
|
260
260
|
readonly search?: any;
|
|
261
261
|
/**
|
|
262
|
-
* The order parameter determines how the results should be sorted according to a specified field.
|
|
262
|
+
* 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.
|
|
263
263
|
* @type {any}
|
|
264
264
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
265
265
|
*/
|
|
266
266
|
readonly order?: any;
|
|
267
267
|
/**
|
|
268
|
-
* 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
|
|
268
|
+
* 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.
|
|
269
269
|
* @type {any}
|
|
270
270
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
271
271
|
*/
|
|
@@ -250,12 +250,12 @@ var PaymentRemindersApiAxiosParamCreator = function (configuration) {
|
|
|
250
250
|
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
251
251
|
* @summary List payment reminders
|
|
252
252
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
253
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
254
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
253
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
254
|
+
* @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.
|
|
255
255
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
256
256
|
* @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.
|
|
257
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
258
|
-
* @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
|
|
257
|
+
* @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.
|
|
258
|
+
* @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.
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
@@ -392,12 +392,12 @@ var PaymentRemindersApiFp = function (configuration) {
|
|
|
392
392
|
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
393
393
|
* @summary List payment reminders
|
|
394
394
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
395
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
396
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
395
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
396
|
+
* @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.
|
|
397
397
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
398
398
|
* @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.
|
|
399
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
400
|
-
* @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
|
|
399
|
+
* @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.
|
|
400
|
+
* @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.
|
|
401
401
|
* @param {*} [options] Override http request option.
|
|
402
402
|
* @throws {RequiredError}
|
|
403
403
|
*/
|
|
@@ -462,12 +462,12 @@ var PaymentRemindersApiFactory = function (configuration, basePath, axios) {
|
|
|
462
462
|
* Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
463
463
|
* @summary List payment reminders
|
|
464
464
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
465
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
466
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
465
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
466
|
+
* @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.
|
|
467
467
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
468
468
|
* @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.
|
|
469
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
470
|
-
* @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
|
|
469
|
+
* @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.
|
|
470
|
+
* @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.
|
|
471
471
|
* @param {*} [options] Override http request option.
|
|
472
472
|
* @throws {RequiredError}
|
|
473
473
|
*/
|
|
@@ -46,12 +46,12 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
46
46
|
* Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
47
47
|
* @summary List payments
|
|
48
48
|
* @param {string} [authorization] Bearer Token
|
|
49
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
50
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
49
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
50
|
+
* @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.
|
|
51
51
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
52
52
|
* @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.
|
|
53
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
54
|
-
* @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
|
|
53
|
+
* @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.
|
|
54
|
+
* @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.
|
|
55
55
|
* @param {*} [options] Override http request option.
|
|
56
56
|
* @throws {RequiredError}
|
|
57
57
|
*/
|
|
@@ -87,12 +87,12 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
87
87
|
* Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
88
88
|
* @summary List payments
|
|
89
89
|
* @param {string} [authorization] Bearer Token
|
|
90
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
91
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
90
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
91
|
+
* @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.
|
|
92
92
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
93
93
|
* @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.
|
|
94
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
95
|
-
* @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
|
|
94
|
+
* @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.
|
|
95
|
+
* @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.
|
|
96
96
|
* @param {*} [options] Override http request option.
|
|
97
97
|
* @throws {RequiredError}
|
|
98
98
|
*/
|
|
@@ -128,12 +128,12 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
|
|
|
128
128
|
* Returns a list of payments you’ve previously created. The payments are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
129
129
|
* @summary List payments
|
|
130
130
|
* @param {string} [authorization] Bearer Token
|
|
131
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
132
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
131
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
132
|
+
* @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.
|
|
133
133
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
134
134
|
* @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.
|
|
135
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
136
|
-
* @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
|
|
135
|
+
* @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.
|
|
136
|
+
* @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.
|
|
137
137
|
* @param {*} [options] Override http request option.
|
|
138
138
|
* @throws {RequiredError}
|
|
139
139
|
*/
|
|
@@ -208,13 +208,13 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
208
208
|
*/
|
|
209
209
|
readonly authorization?: string;
|
|
210
210
|
/**
|
|
211
|
-
* A limit on the number of objects to be returned.
|
|
211
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
212
212
|
* @type {any}
|
|
213
213
|
* @memberof PaymentsApiListPayments
|
|
214
214
|
*/
|
|
215
215
|
readonly pageSize?: any;
|
|
216
216
|
/**
|
|
217
|
-
* A cursor for use in pagination.
|
|
217
|
+
* 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.
|
|
218
218
|
* @type {any}
|
|
219
219
|
* @memberof PaymentsApiListPayments
|
|
220
220
|
*/
|
|
@@ -232,13 +232,13 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
232
232
|
*/
|
|
233
233
|
readonly search?: any;
|
|
234
234
|
/**
|
|
235
|
-
* The order parameter determines how the results should be sorted according to a specified field.
|
|
235
|
+
* 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.
|
|
236
236
|
* @type {any}
|
|
237
237
|
* @memberof PaymentsApiListPayments
|
|
238
238
|
*/
|
|
239
239
|
readonly order?: any;
|
|
240
240
|
/**
|
|
241
|
-
* 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
|
|
241
|
+
* 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.
|
|
242
242
|
* @type {any}
|
|
243
243
|
* @memberof PaymentsApiListPayments
|
|
244
244
|
*/
|