@emilgroup/payment-sdk 1.4.1-beta.15 → 1.4.1-beta.17

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.
Files changed (42) hide show
  1. package/.openapi-generator/FILES +5 -0
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +346 -22
  4. package/api/bank-transaction-api.ts +12 -12
  5. package/api/payment-methods-api.ts +38 -145
  6. package/api/payment-reminders-api.ts +12 -12
  7. package/api/payments-api.ts +42 -45
  8. package/api/refunds-api.ts +4 -4
  9. package/api/tenant-bank-account-api.ts +20 -20
  10. package/dist/api/bank-accounts-api.d.ts +193 -16
  11. package/dist/api/bank-accounts-api.js +302 -19
  12. package/dist/api/bank-transaction-api.d.ts +12 -12
  13. package/dist/api/bank-transaction-api.js +11 -11
  14. package/dist/api/payment-methods-api.d.ts +29 -84
  15. package/dist/api/payment-methods-api.js +33 -129
  16. package/dist/api/payment-reminders-api.d.ts +12 -12
  17. package/dist/api/payment-reminders-api.js +11 -11
  18. package/dist/api/payments-api.d.ts +33 -33
  19. package/dist/api/payments-api.js +37 -39
  20. package/dist/api/refunds-api.d.ts +4 -4
  21. package/dist/api/refunds-api.js +3 -3
  22. package/dist/api/tenant-bank-account-api.d.ts +20 -20
  23. package/dist/api/tenant-bank-account-api.js +14 -14
  24. package/dist/models/bank-account-class.d.ts +67 -0
  25. package/dist/models/bank-account-class.js +15 -0
  26. package/dist/models/create-bank-account-request-dto.d.ts +30 -0
  27. package/dist/models/create-bank-account-request-dto.js +15 -0
  28. package/dist/models/get-bank-account-response-class.d.ts +25 -0
  29. package/dist/models/get-bank-account-response-class.js +15 -0
  30. package/dist/models/index.d.ts +5 -0
  31. package/dist/models/index.js +5 -0
  32. package/dist/models/primary-bank-account-response-class.d.ts +42 -0
  33. package/dist/models/primary-bank-account-response-class.js +15 -0
  34. package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
  35. package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
  36. package/models/bank-account-class.ts +73 -0
  37. package/models/create-bank-account-request-dto.ts +36 -0
  38. package/models/get-bank-account-response-class.ts +31 -0
  39. package/models/index.ts +5 -0
  40. package/models/primary-bank-account-response-class.ts +48 -0
  41. package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
  42. package/package.json +1 -1
@@ -20,7 +20,7 @@ import { CreatePaymentRequestDto } from '../models';
20
20
  export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
22
  * Creates a payment for a specified account. This function is idempotent.
23
- * @summary Create a payment
23
+ * @summary Create the payment
24
24
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
25
25
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
26
26
  * @param {string} [authorization] Bearer Token
@@ -29,24 +29,24 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
29
29
  */
30
30
  createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
31
  /**
32
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
33
- * @summary Retrieve a payment
34
- * @param {string} code Unique identifier for the object.
32
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
33
+ * @summary Retrieve the payment
34
+ * @param {string} code
35
+ * @param {string} code2 Unique identifier for the object.
35
36
  * @param {string} expand Fields to expand response by
36
- * @param {string} expand2 Fields to expand response by
37
37
  * @param {string} [authorization] Bearer Token
38
38
  * @param {*} [options] Override http request option.
39
39
  * @throws {RequiredError}
40
40
  */
41
- getPayment: (code: string, expand: string, expand2: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
+ getPayment: (code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
42
  /**
43
- * 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.
43
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
44
44
  * @summary List payments
45
45
  * @param {string} [authorization] Bearer Token
46
46
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
47
47
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
48
48
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
49
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
49
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
50
50
  * @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.
51
51
  * @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.
52
52
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -62,7 +62,7 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
62
62
  export declare const PaymentsApiFp: (configuration?: Configuration) => {
63
63
  /**
64
64
  * Creates a payment for a specified account. This function is idempotent.
65
- * @summary Create a payment
65
+ * @summary Create the payment
66
66
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
67
67
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
68
68
  * @param {string} [authorization] Bearer Token
@@ -71,24 +71,24 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
71
71
  */
72
72
  createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
73
73
  /**
74
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
75
- * @summary Retrieve a payment
76
- * @param {string} code Unique identifier for the object.
74
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
75
+ * @summary Retrieve the payment
76
+ * @param {string} code
77
+ * @param {string} code2 Unique identifier for the object.
77
78
  * @param {string} expand Fields to expand response by
78
- * @param {string} expand2 Fields to expand response by
79
79
  * @param {string} [authorization] Bearer Token
80
80
  * @param {*} [options] Override http request option.
81
81
  * @throws {RequiredError}
82
82
  */
83
- getPayment(code: string, expand: string, expand2: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
83
+ getPayment(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
84
84
  /**
85
- * 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.
85
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
86
86
  * @summary List payments
87
87
  * @param {string} [authorization] Bearer Token
88
88
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
89
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
90
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&#x3D;xxx in order to fetch the result.
91
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
92
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
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
94
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -104,7 +104,7 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
104
104
  export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
105
105
  /**
106
106
  * Creates a payment for a specified account. This function is idempotent.
107
- * @summary Create a payment
107
+ * @summary Create the payment
108
108
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
109
109
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
110
110
  * @param {string} [authorization] Bearer Token
@@ -113,24 +113,24 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
113
113
  */
114
114
  createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
115
115
  /**
116
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
117
- * @summary Retrieve a payment
118
- * @param {string} code Unique identifier for the object.
116
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
117
+ * @summary Retrieve the payment
118
+ * @param {string} code
119
+ * @param {string} code2 Unique identifier for the object.
119
120
  * @param {string} expand Fields to expand response by
120
- * @param {string} expand2 Fields to expand response by
121
121
  * @param {string} [authorization] Bearer Token
122
122
  * @param {*} [options] Override http request option.
123
123
  * @throws {RequiredError}
124
124
  */
125
- getPayment(code: string, expand: string, expand2: string, authorization?: string, options?: any): AxiosPromise<void>;
125
+ getPayment(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
126
126
  /**
127
- * 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.
127
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
128
128
  * @summary List payments
129
129
  * @param {string} [authorization] Bearer Token
130
130
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
131
131
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
132
132
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
133
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
133
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
134
134
  * @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.
135
135
  * @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.
136
136
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -171,23 +171,23 @@ export interface PaymentsApiCreatePaymentRequest {
171
171
  */
172
172
  export interface PaymentsApiGetPaymentRequest {
173
173
  /**
174
- * Unique identifier for the object.
174
+ *
175
175
  * @type {string}
176
176
  * @memberof PaymentsApiGetPayment
177
177
  */
178
178
  readonly code: string;
179
179
  /**
180
- * Fields to expand response by
180
+ * Unique identifier for the object.
181
181
  * @type {string}
182
182
  * @memberof PaymentsApiGetPayment
183
183
  */
184
- readonly expand: string;
184
+ readonly code2: string;
185
185
  /**
186
186
  * Fields to expand response by
187
187
  * @type {string}
188
188
  * @memberof PaymentsApiGetPayment
189
189
  */
190
- readonly expand2: string;
190
+ readonly expand: string;
191
191
  /**
192
192
  * Bearer Token
193
193
  * @type {string}
@@ -226,7 +226,7 @@ export interface PaymentsApiListPaymentsRequest {
226
226
  */
227
227
  readonly filter?: any;
228
228
  /**
229
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
229
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
230
230
  * @type {any}
231
231
  * @memberof PaymentsApiListPayments
232
232
  */
@@ -259,7 +259,7 @@ export interface PaymentsApiListPaymentsRequest {
259
259
  export declare class PaymentsApi extends BaseAPI {
260
260
  /**
261
261
  * Creates a payment for a specified account. This function is idempotent.
262
- * @summary Create a payment
262
+ * @summary Create the payment
263
263
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
264
264
  * @param {*} [options] Override http request option.
265
265
  * @throws {RequiredError}
@@ -267,8 +267,8 @@ export declare class PaymentsApi extends BaseAPI {
267
267
  */
268
268
  createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
269
269
  /**
270
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
271
- * @summary Retrieve a payment
270
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
271
+ * @summary Retrieve the payment
272
272
  * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
273
273
  * @param {*} [options] Override http request option.
274
274
  * @throws {RequiredError}
@@ -276,7 +276,7 @@ export declare class PaymentsApi extends BaseAPI {
276
276
  */
277
277
  getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
278
278
  /**
279
- * 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.
279
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
280
280
  * @summary List payments
281
281
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
282
282
  * @param {*} [options] Override http request option.
@@ -94,7 +94,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
94
94
  return {
95
95
  /**
96
96
  * Creates a payment for a specified account. This function is idempotent.
97
- * @summary Create a payment
97
+ * @summary Create the payment
98
98
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
99
99
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
100
100
  * @param {string} [authorization] Bearer Token
@@ -148,16 +148,16 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
148
148
  });
149
149
  },
150
150
  /**
151
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
152
- * @summary Retrieve a payment
153
- * @param {string} code Unique identifier for the object.
151
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
152
+ * @summary Retrieve the payment
153
+ * @param {string} code
154
+ * @param {string} code2 Unique identifier for the object.
154
155
  * @param {string} expand Fields to expand response by
155
- * @param {string} expand2 Fields to expand response by
156
156
  * @param {string} [authorization] Bearer Token
157
157
  * @param {*} [options] Override http request option.
158
158
  * @throws {RequiredError}
159
159
  */
160
- getPayment: function (code, expand, expand2, authorization, options) {
160
+ getPayment: function (code, code2, expand, authorization, options) {
161
161
  if (options === void 0) { options = {}; }
162
162
  return __awaiter(_this, void 0, void 0, function () {
163
163
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -166,11 +166,12 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
166
166
  case 0:
167
167
  // verify required parameter 'code' is not null or undefined
168
168
  (0, common_1.assertParamExists)('getPayment', 'code', code);
169
+ // verify required parameter 'code2' is not null or undefined
170
+ (0, common_1.assertParamExists)('getPayment', 'code2', code2);
169
171
  // verify required parameter 'expand' is not null or undefined
170
172
  (0, common_1.assertParamExists)('getPayment', 'expand', expand);
171
- // verify required parameter 'expand2' is not null or undefined
172
- (0, common_1.assertParamExists)('getPayment', 'expand2', expand2);
173
- localVarPath = "/paymentservice/v1/payments/{code}";
173
+ localVarPath = "/paymentservice/v1/payments/{code}"
174
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
174
175
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
175
176
  if (configuration) {
176
177
  baseOptions = configuration.baseOptions;
@@ -186,15 +187,12 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
186
187
  // authentication bearer required
187
188
  // http bearer authentication required
188
189
  _a.sent();
189
- if (code !== undefined) {
190
- localVarQueryParameter['code'] = code;
190
+ if (code2 !== undefined) {
191
+ localVarQueryParameter['code'] = code2;
191
192
  }
192
193
  if (expand !== undefined) {
193
194
  localVarQueryParameter['expand'] = expand;
194
195
  }
195
- if (expand2 !== undefined) {
196
- localVarQueryParameter['expand'] = expand2;
197
- }
198
196
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
199
197
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
200
198
  }
@@ -210,13 +208,13 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
210
208
  });
211
209
  },
212
210
  /**
213
- * 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.
211
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
214
212
  * @summary List payments
215
213
  * @param {string} [authorization] Bearer Token
216
214
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
217
215
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
218
216
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
219
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
217
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
220
218
  * @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.
221
219
  * @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.
222
220
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -293,7 +291,7 @@ var PaymentsApiFp = function (configuration) {
293
291
  return {
294
292
  /**
295
293
  * Creates a payment for a specified account. This function is idempotent.
296
- * @summary Create a payment
294
+ * @summary Create the payment
297
295
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
298
296
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
299
297
  * @param {string} [authorization] Bearer Token
@@ -314,21 +312,21 @@ var PaymentsApiFp = function (configuration) {
314
312
  });
315
313
  },
316
314
  /**
317
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
318
- * @summary Retrieve a payment
319
- * @param {string} code Unique identifier for the object.
315
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
316
+ * @summary Retrieve the payment
317
+ * @param {string} code
318
+ * @param {string} code2 Unique identifier for the object.
320
319
  * @param {string} expand Fields to expand response by
321
- * @param {string} expand2 Fields to expand response by
322
320
  * @param {string} [authorization] Bearer Token
323
321
  * @param {*} [options] Override http request option.
324
322
  * @throws {RequiredError}
325
323
  */
326
- getPayment: function (code, expand, expand2, authorization, options) {
324
+ getPayment: function (code, code2, expand, authorization, options) {
327
325
  return __awaiter(this, void 0, void 0, function () {
328
326
  var localVarAxiosArgs;
329
327
  return __generator(this, function (_a) {
330
328
  switch (_a.label) {
331
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPayment(code, expand, expand2, authorization, options)];
329
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPayment(code, code2, expand, authorization, options)];
332
330
  case 1:
333
331
  localVarAxiosArgs = _a.sent();
334
332
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -337,13 +335,13 @@ var PaymentsApiFp = function (configuration) {
337
335
  });
338
336
  },
339
337
  /**
340
- * 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.
338
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
341
339
  * @summary List payments
342
340
  * @param {string} [authorization] Bearer Token
343
341
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
344
342
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
345
343
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
346
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
344
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
347
345
  * @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.
348
346
  * @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.
349
347
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -375,7 +373,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
375
373
  return {
376
374
  /**
377
375
  * Creates a payment for a specified account. This function is idempotent.
378
- * @summary Create a payment
376
+ * @summary Create the payment
379
377
  * @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
380
378
  * @param {CreatePaymentRequestDto} createPaymentRequestDto
381
379
  * @param {string} [authorization] Bearer Token
@@ -386,26 +384,26 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
386
384
  return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
387
385
  },
388
386
  /**
389
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
390
- * @summary Retrieve a payment
391
- * @param {string} code Unique identifier for the object.
387
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
388
+ * @summary Retrieve the payment
389
+ * @param {string} code
390
+ * @param {string} code2 Unique identifier for the object.
392
391
  * @param {string} expand Fields to expand response by
393
- * @param {string} expand2 Fields to expand response by
394
392
  * @param {string} [authorization] Bearer Token
395
393
  * @param {*} [options] Override http request option.
396
394
  * @throws {RequiredError}
397
395
  */
398
- getPayment: function (code, expand, expand2, authorization, options) {
399
- return localVarFp.getPayment(code, expand, expand2, authorization, options).then(function (request) { return request(axios, basePath); });
396
+ getPayment: function (code, code2, expand, authorization, options) {
397
+ return localVarFp.getPayment(code, code2, expand, authorization, options).then(function (request) { return request(axios, basePath); });
400
398
  },
401
399
  /**
402
- * 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.
400
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
403
401
  * @summary List payments
404
402
  * @param {string} [authorization] Bearer Token
405
403
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
406
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
407
405
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
408
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
406
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
409
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.
410
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.
411
409
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -431,7 +429,7 @@ var PaymentsApi = /** @class */ (function (_super) {
431
429
  }
432
430
  /**
433
431
  * Creates a payment for a specified account. This function is idempotent.
434
- * @summary Create a payment
432
+ * @summary Create the payment
435
433
  * @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
436
434
  * @param {*} [options] Override http request option.
437
435
  * @throws {RequiredError}
@@ -442,8 +440,8 @@ var PaymentsApi = /** @class */ (function (_super) {
442
440
  return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
443
441
  };
444
442
  /**
445
- * Retrieves the details of a payment that was previously created. Supply the unique payment code that was returned when you created the payment and Emil Api will return the corresponding payment information.
446
- * @summary Retrieve a payment
443
+ * Retrieves the details of the payment that was previously created. Supply the unique payment code that was returned when you created it and Emil Api will return the corresponding payment information.
444
+ * @summary Retrieve the payment
447
445
  * @param {PaymentsApiGetPaymentRequest} requestParameters Request parameters.
448
446
  * @param {*} [options] Override http request option.
449
447
  * @throws {RequiredError}
@@ -451,10 +449,10 @@ var PaymentsApi = /** @class */ (function (_super) {
451
449
  */
452
450
  PaymentsApi.prototype.getPayment = function (requestParameters, options) {
453
451
  var _this = this;
454
- return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.expand, requestParameters.expand2, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
452
+ return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.code2, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
455
453
  };
456
454
  /**
457
- * 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.
455
+ * Returns a list of payments you have previously created. The payments are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
458
456
  * @summary List payments
459
457
  * @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
460
458
  * @param {*} [options] Override http request option.
@@ -45,7 +45,7 @@ export declare const RefundsApiAxiosParamCreator: (configuration?: Configuration
45
45
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
46
46
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
47
47
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
48
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
48
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
49
49
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
50
50
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
51
51
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -83,7 +83,7 @@ export declare const RefundsApiFp: (configuration?: Configuration) => {
83
83
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
84
84
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
85
85
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
86
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
86
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
87
87
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
88
88
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
89
89
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -121,7 +121,7 @@ export declare const RefundsApiFactory: (configuration?: Configuration, basePath
121
121
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
122
122
  * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
123
123
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
124
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
124
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
125
125
  * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
126
126
  * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
127
127
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -211,7 +211,7 @@ export interface RefundsApiListRefundsRequest {
211
211
  */
212
212
  readonly filter?: any;
213
213
  /**
214
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
214
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
215
215
  * @type {any}
216
216
  * @memberof RefundsApiListRefunds
217
217
  */
@@ -205,7 +205,7 @@ var RefundsApiAxiosParamCreator = function (configuration) {
205
205
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
206
206
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
207
207
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
208
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
208
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
209
209
  * @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.
210
210
  * @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.
211
211
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -328,7 +328,7 @@ var RefundsApiFp = function (configuration) {
328
328
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
329
329
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
330
330
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
331
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
331
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
332
332
  * @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.
333
333
  * @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.
334
334
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
@@ -386,7 +386,7 @@ var RefundsApiFactory = function (configuration, basePath, axios) {
386
386
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
387
387
  * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
388
388
  * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
389
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
389
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
390
390
  * @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.
391
391
  * @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.
392
392
  * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.