@emilgroup/payment-sdk-node 1.3.0 → 1.4.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 +3 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +174 -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/dist/api/bank-accounts-api.d.ts +101 -0
- package/dist/api/bank-accounts-api.js +123 -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/models/bank-account-class.d.ts +54 -0
- package/dist/models/bank-account-class.js +15 -0
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -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/transaction-class.d.ts +54 -0
- package/dist/models/transaction-class.js +15 -0
- package/models/bank-account-class.ts +60 -0
- package/models/create-payment-request-dto.ts +7 -1
- package/models/index.ts +3 -0
- package/models/list-bank-accounts-response-class.ts +37 -0
- package/models/payment-class.ts +15 -2
- package/models/transaction-class.ts +60 -0
- package/package.json +2 -2
package/.openapi-generator/FILES
CHANGED
|
@@ -15,6 +15,7 @@ common.ts
|
|
|
15
15
|
configuration.ts
|
|
16
16
|
git_push.sh
|
|
17
17
|
index.ts
|
|
18
|
+
models/bank-account-class.ts
|
|
18
19
|
models/complete-braintree-payment-setup-request-dto.ts
|
|
19
20
|
models/complete-payment-setup-request-dto.ts
|
|
20
21
|
models/complete-payment-setup-response-class.ts
|
|
@@ -36,6 +37,7 @@ models/initiate-payment-setup-request-dto.ts
|
|
|
36
37
|
models/initiate-payment-setup-response-class.ts
|
|
37
38
|
models/initiate-stripe-payment-setup-request-dto.ts
|
|
38
39
|
models/initiate-stripe-payment-setup-response-class.ts
|
|
40
|
+
models/list-bank-accounts-response-class.ts
|
|
39
41
|
models/list-payment-methods-response-class.ts
|
|
40
42
|
models/list-payment-reminders-response-class.ts
|
|
41
43
|
models/list-payments-response-class.ts
|
|
@@ -43,6 +45,7 @@ models/payment-class.ts
|
|
|
43
45
|
models/payment-method-class.ts
|
|
44
46
|
models/payment-reminder-class.ts
|
|
45
47
|
models/sepa-direct-dto.ts
|
|
48
|
+
models/transaction-class.ts
|
|
46
49
|
models/validate-pspconfig-request-dto.ts
|
|
47
50
|
models/validate-pspconfig-response-class.ts
|
|
48
51
|
package.json
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/payment-sdk-node@1.
|
|
20
|
+
npm install @emilgroup/payment-sdk-node@1.4.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/payment-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/payment-sdk-node@1.4.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PaymentsApi`.
|
package/api/bank-accounts-api.ts
CHANGED
|
@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
24
|
import { CreateBankAccountRequestDto } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { ListBankAccountsResponseClass } from '../models';
|
|
25
27
|
// URLSearchParams not necessarily used
|
|
26
28
|
// @ts-ignore
|
|
27
29
|
import { URL, URLSearchParams } from 'url';
|
|
@@ -74,6 +76,77 @@ export const BankAccountsApiAxiosParamCreator = function (configuration?: Config
|
|
|
74
76
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
75
77
|
localVarRequestOptions.data = serializeDataIfNeeded(createBankAccountRequestDto, localVarRequestOptions, configuration)
|
|
76
78
|
|
|
79
|
+
return {
|
|
80
|
+
url: toPathString(localVarUrlObj),
|
|
81
|
+
options: localVarRequestOptions,
|
|
82
|
+
};
|
|
83
|
+
},
|
|
84
|
+
/**
|
|
85
|
+
* Returns a list of bank accounts you’ve previously created. The bank accounts are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
86
|
+
* @summary List bank accounts
|
|
87
|
+
* @param {string} [authorization] Bearer Token
|
|
88
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
89
|
+
* @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.
|
|
90
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
91
|
+
* @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.
|
|
92
|
+
* @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.
|
|
93
|
+
* @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.
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
listBankAccounts: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
98
|
+
const localVarPath = `/paymentservice/v1/bank-accounts`;
|
|
99
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
100
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
101
|
+
let baseOptions;
|
|
102
|
+
let baseAccessToken;
|
|
103
|
+
if (configuration) {
|
|
104
|
+
baseOptions = configuration.baseOptions;
|
|
105
|
+
baseAccessToken = configuration.accessToken;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
109
|
+
const localVarHeaderParameter = {} as any;
|
|
110
|
+
const localVarQueryParameter = {} as any;
|
|
111
|
+
|
|
112
|
+
// authentication bearer required
|
|
113
|
+
// http bearer authentication required
|
|
114
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
115
|
+
|
|
116
|
+
if (pageSize !== undefined) {
|
|
117
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
if (pageToken !== undefined) {
|
|
121
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
if (filter !== undefined) {
|
|
125
|
+
localVarQueryParameter['filter'] = filter;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
if (search !== undefined) {
|
|
129
|
+
localVarQueryParameter['search'] = search;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
if (order !== undefined) {
|
|
133
|
+
localVarQueryParameter['order'] = order;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
if (expand !== undefined) {
|
|
137
|
+
localVarQueryParameter['expand'] = expand;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
141
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
147
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
148
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
149
|
+
|
|
77
150
|
return {
|
|
78
151
|
url: toPathString(localVarUrlObj),
|
|
79
152
|
options: localVarRequestOptions,
|
|
@@ -101,6 +174,23 @@ export const BankAccountsApiFp = function(configuration?: Configuration) {
|
|
|
101
174
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createBankAccount(createBankAccountRequestDto, authorization, options);
|
|
102
175
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
103
176
|
},
|
|
177
|
+
/**
|
|
178
|
+
* Returns a list of bank accounts you’ve previously created. The bank accounts are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
179
|
+
* @summary List bank accounts
|
|
180
|
+
* @param {string} [authorization] Bearer Token
|
|
181
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
182
|
+
* @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.
|
|
183
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
184
|
+
* @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.
|
|
185
|
+
* @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.
|
|
186
|
+
* @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.
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
async listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankAccountsResponseClass>> {
|
|
191
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
192
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
193
|
+
},
|
|
104
194
|
}
|
|
105
195
|
};
|
|
106
196
|
|
|
@@ -122,6 +212,22 @@ export const BankAccountsApiFactory = function (configuration?: Configuration, b
|
|
|
122
212
|
createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
|
|
123
213
|
return localVarFp.createBankAccount(createBankAccountRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
124
214
|
},
|
|
215
|
+
/**
|
|
216
|
+
* Returns a list of bank accounts you’ve previously created. The bank accounts are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
217
|
+
* @summary List bank accounts
|
|
218
|
+
* @param {string} [authorization] Bearer Token
|
|
219
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
220
|
+
* @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.
|
|
221
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
222
|
+
* @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.
|
|
223
|
+
* @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.
|
|
224
|
+
* @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.
|
|
225
|
+
* @param {*} [options] Override http request option.
|
|
226
|
+
* @throws {RequiredError}
|
|
227
|
+
*/
|
|
228
|
+
listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListBankAccountsResponseClass> {
|
|
229
|
+
return localVarFp.listBankAccounts(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
230
|
+
},
|
|
125
231
|
};
|
|
126
232
|
};
|
|
127
233
|
|
|
@@ -146,6 +252,62 @@ export interface BankAccountsApiCreateBankAccountRequest {
|
|
|
146
252
|
readonly authorization?: string
|
|
147
253
|
}
|
|
148
254
|
|
|
255
|
+
/**
|
|
256
|
+
* Request parameters for listBankAccounts operation in BankAccountsApi.
|
|
257
|
+
* @export
|
|
258
|
+
* @interface BankAccountsApiListBankAccountsRequest
|
|
259
|
+
*/
|
|
260
|
+
export interface BankAccountsApiListBankAccountsRequest {
|
|
261
|
+
/**
|
|
262
|
+
* Bearer Token
|
|
263
|
+
* @type {string}
|
|
264
|
+
* @memberof BankAccountsApiListBankAccounts
|
|
265
|
+
*/
|
|
266
|
+
readonly authorization?: string
|
|
267
|
+
|
|
268
|
+
/**
|
|
269
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
270
|
+
* @type {any}
|
|
271
|
+
* @memberof BankAccountsApiListBankAccounts
|
|
272
|
+
*/
|
|
273
|
+
readonly pageSize?: any
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* 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.
|
|
277
|
+
* @type {any}
|
|
278
|
+
* @memberof BankAccountsApiListBankAccounts
|
|
279
|
+
*/
|
|
280
|
+
readonly pageToken?: any
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
284
|
+
* @type {any}
|
|
285
|
+
* @memberof BankAccountsApiListBankAccounts
|
|
286
|
+
*/
|
|
287
|
+
readonly filter?: any
|
|
288
|
+
|
|
289
|
+
/**
|
|
290
|
+
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
291
|
+
* @type {any}
|
|
292
|
+
* @memberof BankAccountsApiListBankAccounts
|
|
293
|
+
*/
|
|
294
|
+
readonly search?: any
|
|
295
|
+
|
|
296
|
+
/**
|
|
297
|
+
* 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.
|
|
298
|
+
* @type {any}
|
|
299
|
+
* @memberof BankAccountsApiListBankAccounts
|
|
300
|
+
*/
|
|
301
|
+
readonly order?: any
|
|
302
|
+
|
|
303
|
+
/**
|
|
304
|
+
* 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.
|
|
305
|
+
* @type {any}
|
|
306
|
+
* @memberof BankAccountsApiListBankAccounts
|
|
307
|
+
*/
|
|
308
|
+
readonly expand?: any
|
|
309
|
+
}
|
|
310
|
+
|
|
149
311
|
/**
|
|
150
312
|
* BankAccountsApi - object-oriented interface
|
|
151
313
|
* @export
|
|
@@ -164,4 +326,16 @@ export class BankAccountsApi extends BaseAPI {
|
|
|
164
326
|
public createBankAccount(requestParameters: BankAccountsApiCreateBankAccountRequest, options?: AxiosRequestConfig) {
|
|
165
327
|
return BankAccountsApiFp(this.configuration).createBankAccount(requestParameters.createBankAccountRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
166
328
|
}
|
|
329
|
+
|
|
330
|
+
/**
|
|
331
|
+
* Returns a list of bank accounts you’ve previously created. The bank accounts are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
|
|
332
|
+
* @summary List bank accounts
|
|
333
|
+
* @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
|
|
334
|
+
* @param {*} [options] Override http request option.
|
|
335
|
+
* @throws {RequiredError}
|
|
336
|
+
* @memberof BankAccountsApi
|
|
337
|
+
*/
|
|
338
|
+
public listBankAccounts(requestParameters: BankAccountsApiListBankAccountsRequest = {}, options?: AxiosRequestConfig) {
|
|
339
|
+
return BankAccountsApiFp(this.configuration).listBankAccounts(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
340
|
+
}
|
|
167
341
|
}
|
|
@@ -195,12 +195,12 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
195
195
|
* 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.
|
|
196
196
|
* @summary List payment methods
|
|
197
197
|
* @param {string} [authorization] Bearer Token
|
|
198
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
199
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
198
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
199
|
+
* @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.
|
|
200
200
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
201
201
|
* @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.
|
|
202
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
203
|
-
* @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
|
|
202
|
+
* @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.
|
|
203
|
+
* @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.
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
@@ -314,12 +314,12 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
314
314
|
* 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.
|
|
315
315
|
* @summary List payment methods
|
|
316
316
|
* @param {string} [authorization] Bearer Token
|
|
317
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
318
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
317
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
318
|
+
* @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.
|
|
319
319
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
320
320
|
* @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.
|
|
321
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
322
|
-
* @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
|
|
321
|
+
* @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.
|
|
322
|
+
* @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.
|
|
323
323
|
* @param {*} [options] Override http request option.
|
|
324
324
|
* @throws {RequiredError}
|
|
325
325
|
*/
|
|
@@ -376,12 +376,12 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
376
376
|
* 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.
|
|
377
377
|
* @summary List payment methods
|
|
378
378
|
* @param {string} [authorization] Bearer Token
|
|
379
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
380
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
379
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
380
|
+
* @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.
|
|
381
381
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
382
382
|
* @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.
|
|
383
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
384
|
-
* @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
|
|
383
|
+
* @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.
|
|
384
|
+
* @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.
|
|
385
385
|
* @param {*} [options] Override http request option.
|
|
386
386
|
* @throws {RequiredError}
|
|
387
387
|
*/
|
|
@@ -482,14 +482,14 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
482
482
|
readonly authorization?: string
|
|
483
483
|
|
|
484
484
|
/**
|
|
485
|
-
* A limit on the number of objects to be returned.
|
|
485
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
486
486
|
* @type {any}
|
|
487
487
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
488
488
|
*/
|
|
489
489
|
readonly pageSize?: any
|
|
490
490
|
|
|
491
491
|
/**
|
|
492
|
-
* A cursor for use in pagination.
|
|
492
|
+
* 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.
|
|
493
493
|
* @type {any}
|
|
494
494
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
495
495
|
*/
|
|
@@ -510,14 +510,14 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
510
510
|
readonly search?: any
|
|
511
511
|
|
|
512
512
|
/**
|
|
513
|
-
* The order parameter determines how the results should be sorted according to a specified field.
|
|
513
|
+
* 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.
|
|
514
514
|
* @type {any}
|
|
515
515
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
516
516
|
*/
|
|
517
517
|
readonly order?: any
|
|
518
518
|
|
|
519
519
|
/**
|
|
520
|
-
* 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
|
|
520
|
+
* 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.
|
|
521
521
|
* @type {any}
|
|
522
522
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
523
523
|
*/
|
|
@@ -183,12 +183,12 @@ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Co
|
|
|
183
183
|
* 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.
|
|
184
184
|
* @summary List payment reminders
|
|
185
185
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
186
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
187
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
186
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
187
|
+
* @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.
|
|
188
188
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
189
189
|
* @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.
|
|
190
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
191
|
-
* @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
|
|
190
|
+
* @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.
|
|
191
|
+
* @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.
|
|
192
192
|
* @param {*} [options] Override http request option.
|
|
193
193
|
* @throws {RequiredError}
|
|
194
194
|
*/
|
|
@@ -301,12 +301,12 @@ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
|
|
|
301
301
|
* 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.
|
|
302
302
|
* @summary List payment reminders
|
|
303
303
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
304
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
305
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
304
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
305
|
+
* @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.
|
|
306
306
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
307
307
|
* @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.
|
|
308
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
309
|
-
* @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
|
|
308
|
+
* @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.
|
|
309
|
+
* @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.
|
|
310
310
|
* @param {*} [options] Override http request option.
|
|
311
311
|
* @throws {RequiredError}
|
|
312
312
|
*/
|
|
@@ -362,12 +362,12 @@ export const PaymentRemindersApiFactory = function (configuration?: Configuratio
|
|
|
362
362
|
* 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.
|
|
363
363
|
* @summary List payment reminders
|
|
364
364
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
365
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
366
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
365
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
366
|
+
* @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.
|
|
367
367
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
368
368
|
* @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.
|
|
369
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
370
|
-
* @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
|
|
369
|
+
* @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.
|
|
370
|
+
* @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.
|
|
371
371
|
* @param {*} [options] Override http request option.
|
|
372
372
|
* @throws {RequiredError}
|
|
373
373
|
*/
|
|
@@ -461,14 +461,14 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
461
461
|
readonly authorization?: string
|
|
462
462
|
|
|
463
463
|
/**
|
|
464
|
-
* A limit on the number of objects to be returned.
|
|
464
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
465
465
|
* @type {any}
|
|
466
466
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
467
467
|
*/
|
|
468
468
|
readonly pageSize?: any
|
|
469
469
|
|
|
470
470
|
/**
|
|
471
|
-
* A cursor for use in pagination.
|
|
471
|
+
* 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.
|
|
472
472
|
* @type {any}
|
|
473
473
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
474
474
|
*/
|
|
@@ -489,14 +489,14 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
|
|
|
489
489
|
readonly search?: any
|
|
490
490
|
|
|
491
491
|
/**
|
|
492
|
-
* The order parameter determines how the results should be sorted according to a specified field.
|
|
492
|
+
* 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.
|
|
493
493
|
* @type {any}
|
|
494
494
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
495
495
|
*/
|
|
496
496
|
readonly order?: any
|
|
497
497
|
|
|
498
498
|
/**
|
|
499
|
-
* 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
|
|
499
|
+
* 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.
|
|
500
500
|
* @type {any}
|
|
501
501
|
* @memberof PaymentRemindersApiListPaymentReminders
|
|
502
502
|
*/
|
package/api/payments-api.ts
CHANGED
|
@@ -152,12 +152,12 @@ export const PaymentsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
152
152
|
* 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.
|
|
153
153
|
* @summary List payments
|
|
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
|
*/
|
|
@@ -260,12 +260,12 @@ export const PaymentsApiFp = function(configuration?: Configuration) {
|
|
|
260
260
|
* 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.
|
|
261
261
|
* @summary List payments
|
|
262
262
|
* @param {string} [authorization] Bearer Token
|
|
263
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
264
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
263
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
264
|
+
* @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.
|
|
265
265
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
266
266
|
* @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.
|
|
267
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
268
|
-
* @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
|
|
267
|
+
* @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.
|
|
268
|
+
* @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.
|
|
269
269
|
* @param {*} [options] Override http request option.
|
|
270
270
|
* @throws {RequiredError}
|
|
271
271
|
*/
|
|
@@ -312,12 +312,12 @@ export const PaymentsApiFactory = function (configuration?: Configuration, baseP
|
|
|
312
312
|
* 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.
|
|
313
313
|
* @summary List payments
|
|
314
314
|
* @param {string} [authorization] Bearer Token
|
|
315
|
-
* @param {any} [pageSize] A limit on the number of objects to be returned.
|
|
316
|
-
* @param {any} [pageToken] A cursor for use in pagination.
|
|
315
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
316
|
+
* @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.
|
|
317
317
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
318
318
|
* @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.
|
|
319
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.
|
|
320
|
-
* @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
|
|
319
|
+
* @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.
|
|
320
|
+
* @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.
|
|
321
321
|
* @param {*} [options] Override http request option.
|
|
322
322
|
* @throws {RequiredError}
|
|
323
323
|
*/
|
|
@@ -404,14 +404,14 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
404
404
|
readonly authorization?: string
|
|
405
405
|
|
|
406
406
|
/**
|
|
407
|
-
* A limit on the number of objects to be returned.
|
|
407
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
408
408
|
* @type {any}
|
|
409
409
|
* @memberof PaymentsApiListPayments
|
|
410
410
|
*/
|
|
411
411
|
readonly pageSize?: any
|
|
412
412
|
|
|
413
413
|
/**
|
|
414
|
-
* A cursor for use in pagination.
|
|
414
|
+
* 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.
|
|
415
415
|
* @type {any}
|
|
416
416
|
* @memberof PaymentsApiListPayments
|
|
417
417
|
*/
|
|
@@ -432,14 +432,14 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
432
432
|
readonly search?: any
|
|
433
433
|
|
|
434
434
|
/**
|
|
435
|
-
* The order parameter determines how the results should be sorted according to a specified field.
|
|
435
|
+
* 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.
|
|
436
436
|
* @type {any}
|
|
437
437
|
* @memberof PaymentsApiListPayments
|
|
438
438
|
*/
|
|
439
439
|
readonly order?: any
|
|
440
440
|
|
|
441
441
|
/**
|
|
442
|
-
* 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
|
|
442
|
+
* 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.
|
|
443
443
|
* @type {any}
|
|
444
444
|
* @memberof PaymentsApiListPayments
|
|
445
445
|
*/
|