@emilgroup/payment-sdk 1.4.1-beta.30 → 1.4.1-beta.31
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 +5 -15
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +34 -38
- package/api/bank-transaction-api.ts +73 -77
- package/api/{default-api.ts → health-check-api.ts} +21 -17
- package/api/payment-methods-api.ts +52 -70
- package/api/payment-reminders-api.ts +63 -49
- package/api/payments-api.ts +52 -70
- package/api/refunds-api.ts +76 -88
- package/api/tenant-bank-account-api.ts +79 -63
- package/api/webhooks-api.ts +16 -12
- package/api.ts +2 -2
- package/dist/api/bank-accounts-api.d.ts +37 -39
- package/dist/api/bank-accounts-api.js +18 -18
- package/dist/api/bank-transaction-api.d.ts +77 -79
- package/dist/api/bank-transaction-api.js +45 -45
- package/dist/api/health-check-api.d.ts +70 -0
- package/dist/api/{default-api.js → health-check-api.js} +30 -26
- package/dist/api/payment-methods-api.d.ts +49 -58
- package/dist/api/payment-methods-api.js +32 -42
- package/dist/api/payment-reminders-api.d.ts +55 -46
- package/dist/api/payment-reminders-api.js +40 -34
- package/dist/api/payments-api.d.ts +49 -58
- package/dist/api/payments-api.js +32 -42
- package/dist/api/refunds-api.d.ts +76 -76
- package/dist/api/refunds-api.js +51 -49
- package/dist/api/tenant-bank-account-api.d.ts +71 -61
- package/dist/api/tenant-bank-account-api.js +51 -45
- package/dist/api/webhooks-api.d.ts +16 -12
- package/dist/api/webhooks-api.js +14 -10
- package/dist/api.d.ts +1 -1
- package/dist/api.js +1 -1
- package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +20 -34
- package/dist/models/create-tenant-bank-account-response-class.d.ts +4 -4
- package/dist/models/get-tenant-bank-account-response-class.d.ts +4 -4
- package/dist/models/index.d.ts +4 -14
- package/dist/models/index.js +4 -14
- package/dist/models/list-tenant-bank-account-response-class.d.ts +5 -5
- package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +10 -10
- package/dist/models/tenant-bank-account-class.d.ts +73 -0
- package/dist/models/{get-bank-account-response-class.d.ts → update-tenant-bank-account-response-class.d.ts} +7 -7
- package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +20 -34
- package/models/create-tenant-bank-account-response-class.ts +4 -4
- package/models/get-tenant-bank-account-response-class.ts +4 -4
- package/models/index.ts +4 -14
- package/models/list-tenant-bank-account-response-class.ts +5 -5
- package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +10 -10
- package/models/tenant-bank-account-class.ts +79 -0
- package/models/{create-refund-response-class.ts → update-tenant-bank-account-response-class.ts} +7 -7
- package/package.json +1 -1
- package/dist/api/default-api.d.ts +0 -66
- package/dist/models/bank-account-class.d.ts +0 -73
- package/dist/models/create-refund-response-class.d.ts +0 -25
- package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
- package/dist/models/get-bank-transactions-response-class.js +0 -15
- package/dist/models/get-refund-response-class.d.ts +0 -25
- package/dist/models/get-refund-response-class.js +0 -15
- package/dist/models/get-request-dto.d.ts +0 -30
- package/dist/models/get-request-dto.js +0 -15
- package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
- package/dist/models/list-bank-transactions-response-class.js +0 -15
- package/dist/models/list-refunds-response-class.d.ts +0 -31
- package/dist/models/list-refunds-response-class.js +0 -15
- package/dist/models/primary-bank-account-response-class.d.ts +0 -42
- package/dist/models/primary-bank-account-response-class.js +0 -15
- package/dist/models/refund-class.d.ts +0 -105
- package/dist/models/refund-class.js +0 -29
- package/dist/models/tenant-bank-account-response-class.js +0 -15
- package/dist/models/transaction-class.d.ts +0 -54
- package/dist/models/transaction-class.js +0 -15
- package/dist/models/update-bank-account-response-class.d.ts +0 -25
- package/dist/models/update-bank-account-response-class.js +0 -15
- package/models/bank-account-class.ts +0 -79
- package/models/get-bank-account-response-class.ts +0 -31
- package/models/get-bank-transactions-response-class.ts +0 -31
- package/models/get-refund-response-class.ts +0 -31
- package/models/get-request-dto.ts +0 -36
- package/models/list-bank-transactions-response-class.ts +0 -37
- package/models/list-refunds-response-class.ts +0 -37
- package/models/primary-bank-account-response-class.ts +0 -48
- package/models/refund-class.ts +0 -115
- package/models/transaction-class.ts +0 -60
- package/models/update-bank-account-response-class.ts +0 -31
- /package/dist/models/{bank-account-class.js → bank-transaction-class-without-expand-properties.js} +0 -0
- /package/dist/models/{bank-transaction-response-class.js → tenant-bank-account-class-without-expand-properties.js} +0 -0
- /package/dist/models/{create-refund-response-class.js → tenant-bank-account-class.js} +0 -0
- /package/dist/models/{get-bank-account-response-class.js → update-tenant-bank-account-response-class.js} +0 -0
package/api/refunds-api.ts
CHANGED
|
@@ -22,12 +22,6 @@ 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 { CreateRefundRequestDto } from '../models';
|
|
25
|
-
// @ts-ignore
|
|
26
|
-
import { CreateRefundResponseClass } from '../models';
|
|
27
|
-
// @ts-ignore
|
|
28
|
-
import { GetRefundResponseClass } from '../models';
|
|
29
|
-
// @ts-ignore
|
|
30
|
-
import { ListRefundsResponseClass } from '../models';
|
|
31
25
|
/**
|
|
32
26
|
* RefundsApi - axios parameter creator
|
|
33
27
|
* @export
|
|
@@ -35,7 +29,8 @@ import { ListRefundsResponseClass } from '../models';
|
|
|
35
29
|
export const RefundsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
30
|
return {
|
|
37
31
|
/**
|
|
38
|
-
*
|
|
32
|
+
* This will create a refund in the database.
|
|
33
|
+
* @summary Create the refund
|
|
39
34
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
40
35
|
* @param {string} [authorization] Bearer Token
|
|
41
36
|
* @param {*} [options] Override http request option.
|
|
@@ -81,21 +76,17 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
81
76
|
};
|
|
82
77
|
},
|
|
83
78
|
/**
|
|
84
|
-
*
|
|
85
|
-
* @
|
|
86
|
-
* @param {string}
|
|
87
|
-
* @param {string} expand Fields to expand response by
|
|
79
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
80
|
+
* @summary Retrieve the refund
|
|
81
|
+
* @param {string} code Unique identifier for the object.
|
|
88
82
|
* @param {string} [authorization] Bearer Token
|
|
83
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
89
84
|
* @param {*} [options] Override http request option.
|
|
90
85
|
* @throws {RequiredError}
|
|
91
86
|
*/
|
|
92
|
-
getRefund: async (code: string,
|
|
87
|
+
getRefund: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
88
|
// verify required parameter 'code' is not null or undefined
|
|
94
89
|
assertParamExists('getRefund', 'code', code)
|
|
95
|
-
// verify required parameter 'code2' is not null or undefined
|
|
96
|
-
assertParamExists('getRefund', 'code2', code2)
|
|
97
|
-
// verify required parameter 'expand' is not null or undefined
|
|
98
|
-
assertParamExists('getRefund', 'expand', expand)
|
|
99
90
|
const localVarPath = `/paymentservice/v1/refunds/{code}`
|
|
100
91
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
101
92
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -115,10 +106,6 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
115
106
|
// http bearer authentication required
|
|
116
107
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
117
108
|
|
|
118
|
-
if (code2 !== undefined) {
|
|
119
|
-
localVarQueryParameter['code'] = code2;
|
|
120
|
-
}
|
|
121
|
-
|
|
122
109
|
if (expand !== undefined) {
|
|
123
110
|
localVarQueryParameter['expand'] = expand;
|
|
124
111
|
}
|
|
@@ -139,19 +126,20 @@ export const RefundsApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
139
126
|
};
|
|
140
127
|
},
|
|
141
128
|
/**
|
|
142
|
-
*
|
|
129
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
130
|
+
* @summary List refunds
|
|
143
131
|
* @param {string} [authorization] Bearer Token
|
|
144
132
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
145
133
|
* @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.
|
|
146
|
-
* @param {
|
|
147
|
-
* @param {
|
|
148
|
-
* @param {
|
|
149
|
-
* @param {
|
|
150
|
-
* @param {
|
|
134
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
135
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
136
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
|
|
137
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
138
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
151
139
|
* @param {*} [options] Override http request option.
|
|
152
140
|
* @throws {RequiredError}
|
|
153
141
|
*/
|
|
154
|
-
listRefunds: async (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
142
|
+
listRefunds: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
155
143
|
const localVarPath = `/paymentservice/v1/refunds`;
|
|
156
144
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
157
145
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -224,43 +212,45 @@ export const RefundsApiFp = function(configuration?: Configuration) {
|
|
|
224
212
|
const localVarAxiosParamCreator = RefundsApiAxiosParamCreator(configuration)
|
|
225
213
|
return {
|
|
226
214
|
/**
|
|
227
|
-
*
|
|
215
|
+
* This will create a refund in the database.
|
|
216
|
+
* @summary Create the refund
|
|
228
217
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
229
218
|
* @param {string} [authorization] Bearer Token
|
|
230
219
|
* @param {*} [options] Override http request option.
|
|
231
220
|
* @throws {RequiredError}
|
|
232
221
|
*/
|
|
233
|
-
async createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
222
|
+
async createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
234
223
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createRefund(createRefundRequestDto, authorization, options);
|
|
235
224
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
236
225
|
},
|
|
237
226
|
/**
|
|
238
|
-
*
|
|
239
|
-
* @
|
|
240
|
-
* @param {string}
|
|
241
|
-
* @param {string} expand Fields to expand response by
|
|
227
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
228
|
+
* @summary Retrieve the refund
|
|
229
|
+
* @param {string} code Unique identifier for the object.
|
|
242
230
|
* @param {string} [authorization] Bearer Token
|
|
231
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
243
232
|
* @param {*} [options] Override http request option.
|
|
244
233
|
* @throws {RequiredError}
|
|
245
234
|
*/
|
|
246
|
-
async getRefund(code: string,
|
|
247
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getRefund(code,
|
|
235
|
+
async getRefund(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
236
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getRefund(code, authorization, expand, options);
|
|
248
237
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
249
238
|
},
|
|
250
239
|
/**
|
|
251
|
-
*
|
|
240
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
241
|
+
* @summary List refunds
|
|
252
242
|
* @param {string} [authorization] Bearer Token
|
|
253
243
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
254
244
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {
|
|
257
|
-
* @param {
|
|
258
|
-
* @param {
|
|
259
|
-
* @param {
|
|
245
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
246
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
247
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
|
|
248
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
249
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
260
250
|
* @param {*} [options] Override http request option.
|
|
261
251
|
* @throws {RequiredError}
|
|
262
252
|
*/
|
|
263
|
-
async listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
253
|
+
async listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
264
254
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
265
255
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
266
256
|
},
|
|
@@ -275,41 +265,43 @@ export const RefundsApiFactory = function (configuration?: Configuration, basePa
|
|
|
275
265
|
const localVarFp = RefundsApiFp(configuration)
|
|
276
266
|
return {
|
|
277
267
|
/**
|
|
278
|
-
*
|
|
268
|
+
* This will create a refund in the database.
|
|
269
|
+
* @summary Create the refund
|
|
279
270
|
* @param {CreateRefundRequestDto} createRefundRequestDto
|
|
280
271
|
* @param {string} [authorization] Bearer Token
|
|
281
272
|
* @param {*} [options] Override http request option.
|
|
282
273
|
* @throws {RequiredError}
|
|
283
274
|
*/
|
|
284
|
-
createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<
|
|
275
|
+
createRefund(createRefundRequestDto: CreateRefundRequestDto, authorization?: string, options?: any): AxiosPromise<void> {
|
|
285
276
|
return localVarFp.createRefund(createRefundRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
286
277
|
},
|
|
287
278
|
/**
|
|
288
|
-
*
|
|
289
|
-
* @
|
|
290
|
-
* @param {string}
|
|
291
|
-
* @param {string} expand Fields to expand response by
|
|
279
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
280
|
+
* @summary Retrieve the refund
|
|
281
|
+
* @param {string} code Unique identifier for the object.
|
|
292
282
|
* @param {string} [authorization] Bearer Token
|
|
283
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
293
284
|
* @param {*} [options] Override http request option.
|
|
294
285
|
* @throws {RequiredError}
|
|
295
286
|
*/
|
|
296
|
-
getRefund(code: string,
|
|
297
|
-
return localVarFp.getRefund(code,
|
|
287
|
+
getRefund(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void> {
|
|
288
|
+
return localVarFp.getRefund(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
298
289
|
},
|
|
299
290
|
/**
|
|
300
|
-
*
|
|
291
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
292
|
+
* @summary List refunds
|
|
301
293
|
* @param {string} [authorization] Bearer Token
|
|
302
294
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
303
295
|
* @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.
|
|
304
|
-
* @param {
|
|
305
|
-
* @param {
|
|
306
|
-
* @param {
|
|
307
|
-
* @param {
|
|
308
|
-
* @param {
|
|
296
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
297
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
298
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
|
|
299
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
300
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
309
301
|
* @param {*} [options] Override http request option.
|
|
310
302
|
* @throws {RequiredError}
|
|
311
303
|
*/
|
|
312
|
-
listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
304
|
+
listRefunds(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void> {
|
|
313
305
|
return localVarFp.listRefunds(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
314
306
|
},
|
|
315
307
|
};
|
|
@@ -342,33 +334,26 @@ export interface RefundsApiCreateRefundRequest {
|
|
|
342
334
|
* @interface RefundsApiGetRefundRequest
|
|
343
335
|
*/
|
|
344
336
|
export interface RefundsApiGetRefundRequest {
|
|
345
|
-
/**
|
|
346
|
-
*
|
|
347
|
-
* @type {string}
|
|
348
|
-
* @memberof RefundsApiGetRefund
|
|
349
|
-
*/
|
|
350
|
-
readonly code: string
|
|
351
|
-
|
|
352
337
|
/**
|
|
353
338
|
* Unique identifier for the object.
|
|
354
339
|
* @type {string}
|
|
355
340
|
* @memberof RefundsApiGetRefund
|
|
356
341
|
*/
|
|
357
|
-
readonly
|
|
342
|
+
readonly code: string
|
|
358
343
|
|
|
359
344
|
/**
|
|
360
|
-
*
|
|
345
|
+
* Bearer Token
|
|
361
346
|
* @type {string}
|
|
362
347
|
* @memberof RefundsApiGetRefund
|
|
363
348
|
*/
|
|
364
|
-
readonly
|
|
349
|
+
readonly authorization?: string
|
|
365
350
|
|
|
366
351
|
/**
|
|
367
|
-
*
|
|
352
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
368
353
|
* @type {string}
|
|
369
354
|
* @memberof RefundsApiGetRefund
|
|
370
355
|
*/
|
|
371
|
-
readonly
|
|
356
|
+
readonly expand?: string
|
|
372
357
|
}
|
|
373
358
|
|
|
374
359
|
/**
|
|
@@ -399,39 +384,39 @@ export interface RefundsApiListRefundsRequest {
|
|
|
399
384
|
readonly pageToken?: any
|
|
400
385
|
|
|
401
386
|
/**
|
|
402
|
-
* Filter the response by one or multiple fields.
|
|
403
|
-
* @type {
|
|
387
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
388
|
+
* @type {string}
|
|
404
389
|
* @memberof RefundsApiListRefunds
|
|
405
390
|
*/
|
|
406
|
-
readonly filter?:
|
|
391
|
+
readonly filter?: string
|
|
407
392
|
|
|
408
393
|
/**
|
|
409
|
-
*
|
|
410
|
-
* @type {
|
|
394
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, updatedAt, amount, psp, accountCode, invoiceCode, reason, status</i>
|
|
395
|
+
* @type {string}
|
|
411
396
|
* @memberof RefundsApiListRefunds
|
|
412
397
|
*/
|
|
413
|
-
readonly search?:
|
|
398
|
+
readonly search?: string
|
|
414
399
|
|
|
415
400
|
/**
|
|
416
|
-
*
|
|
417
|
-
* @type {
|
|
401
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, updatedAt, amount</i>
|
|
402
|
+
* @type {string}
|
|
418
403
|
* @memberof RefundsApiListRefunds
|
|
419
404
|
*/
|
|
420
|
-
readonly order?:
|
|
405
|
+
readonly order?: string
|
|
421
406
|
|
|
422
407
|
/**
|
|
423
|
-
*
|
|
424
|
-
* @type {
|
|
408
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: .<i>
|
|
409
|
+
* @type {string}
|
|
425
410
|
* @memberof RefundsApiListRefunds
|
|
426
411
|
*/
|
|
427
|
-
readonly expand?:
|
|
412
|
+
readonly expand?: string
|
|
428
413
|
|
|
429
414
|
/**
|
|
430
|
-
* Filters the response by one or multiple fields.
|
|
431
|
-
* @type {
|
|
415
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, id, status, reason, psp, accountCode, invoiceCode</i>
|
|
416
|
+
* @type {string}
|
|
432
417
|
* @memberof RefundsApiListRefunds
|
|
433
418
|
*/
|
|
434
|
-
readonly filters?:
|
|
419
|
+
readonly filters?: string
|
|
435
420
|
}
|
|
436
421
|
|
|
437
422
|
/**
|
|
@@ -442,7 +427,8 @@ export interface RefundsApiListRefundsRequest {
|
|
|
442
427
|
*/
|
|
443
428
|
export class RefundsApi extends BaseAPI {
|
|
444
429
|
/**
|
|
445
|
-
*
|
|
430
|
+
* This will create a refund in the database.
|
|
431
|
+
* @summary Create the refund
|
|
446
432
|
* @param {RefundsApiCreateRefundRequest} requestParameters Request parameters.
|
|
447
433
|
* @param {*} [options] Override http request option.
|
|
448
434
|
* @throws {RequiredError}
|
|
@@ -453,18 +439,20 @@ export class RefundsApi extends BaseAPI {
|
|
|
453
439
|
}
|
|
454
440
|
|
|
455
441
|
/**
|
|
456
|
-
*
|
|
442
|
+
* Retrieves the details of the refund that was previously created. Supply the unique refund code that was returned when you created it and Emil Api will return the corresponding refund information.
|
|
443
|
+
* @summary Retrieve the refund
|
|
457
444
|
* @param {RefundsApiGetRefundRequest} requestParameters Request parameters.
|
|
458
445
|
* @param {*} [options] Override http request option.
|
|
459
446
|
* @throws {RequiredError}
|
|
460
447
|
* @memberof RefundsApi
|
|
461
448
|
*/
|
|
462
449
|
public getRefund(requestParameters: RefundsApiGetRefundRequest, options?: AxiosRequestConfig) {
|
|
463
|
-
return RefundsApiFp(this.configuration).getRefund(requestParameters.code, requestParameters.
|
|
450
|
+
return RefundsApiFp(this.configuration).getRefund(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
464
451
|
}
|
|
465
452
|
|
|
466
453
|
/**
|
|
467
|
-
*
|
|
454
|
+
* Returns a list of refunds you have previously created. The refunds are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
455
|
+
* @summary List refunds
|
|
468
456
|
* @param {RefundsApiListRefundsRequest} requestParameters Request parameters.
|
|
469
457
|
* @param {*} [options] Override http request option.
|
|
470
458
|
* @throws {RequiredError}
|