@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
|
@@ -19,7 +19,7 @@ import { CreatePaymentRequestDto } from '../models';
|
|
|
19
19
|
*/
|
|
20
20
|
export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
23
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
|
|
@@ -31,29 +31,28 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
31
31
|
/**
|
|
32
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
33
|
* @summary Retrieve the payment
|
|
34
|
-
* @param {string} code
|
|
35
|
-
* @param {string} code2 Unique identifier for the object.
|
|
36
|
-
* @param {string} expand Fields to expand response by
|
|
34
|
+
* @param {string} code Unique identifier for the object.
|
|
37
35
|
* @param {string} [authorization] Bearer Token
|
|
36
|
+
* @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: transactions.<i>
|
|
38
37
|
* @param {*} [options] Override http request option.
|
|
39
38
|
* @throws {RequiredError}
|
|
40
39
|
*/
|
|
41
|
-
getPayment: (code: string,
|
|
40
|
+
getPayment: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
41
|
/**
|
|
43
|
-
* Returns a list of payments you have previously created.
|
|
42
|
+
* 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
43
|
* @summary List payments
|
|
45
44
|
* @param {string} [authorization] Bearer Token
|
|
46
45
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
47
46
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
48
|
-
* @param {
|
|
47
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
49
48
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
50
|
-
* @param {
|
|
51
|
-
* @param {
|
|
52
|
-
* @param {
|
|
49
|
+
* @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, code, amount</i>
|
|
50
|
+
* @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: transactions.<i>
|
|
51
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
53
52
|
* @param {*} [options] Override http request option.
|
|
54
53
|
* @throws {RequiredError}
|
|
55
54
|
*/
|
|
56
|
-
listPayments: (authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
55
|
+
listPayments: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
56
|
};
|
|
58
57
|
/**
|
|
59
58
|
* PaymentsApi - functional programming interface
|
|
@@ -61,7 +60,7 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
61
60
|
*/
|
|
62
61
|
export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
63
62
|
/**
|
|
64
|
-
*
|
|
63
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
65
64
|
* @summary Create the payment
|
|
66
65
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
67
66
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
@@ -73,29 +72,28 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
73
72
|
/**
|
|
74
73
|
* 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
74
|
* @summary Retrieve the payment
|
|
76
|
-
* @param {string} code
|
|
77
|
-
* @param {string} code2 Unique identifier for the object.
|
|
78
|
-
* @param {string} expand Fields to expand response by
|
|
75
|
+
* @param {string} code Unique identifier for the object.
|
|
79
76
|
* @param {string} [authorization] Bearer Token
|
|
77
|
+
* @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: transactions.<i>
|
|
80
78
|
* @param {*} [options] Override http request option.
|
|
81
79
|
* @throws {RequiredError}
|
|
82
80
|
*/
|
|
83
|
-
getPayment(code: string,
|
|
81
|
+
getPayment(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
84
82
|
/**
|
|
85
|
-
* Returns a list of payments you have previously created.
|
|
83
|
+
* 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
84
|
* @summary List payments
|
|
87
85
|
* @param {string} [authorization] Bearer Token
|
|
88
86
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
89
87
|
* @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 {
|
|
88
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
91
89
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
92
|
-
* @param {
|
|
93
|
-
* @param {
|
|
94
|
-
* @param {
|
|
90
|
+
* @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, code, amount</i>
|
|
91
|
+
* @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: transactions.<i>
|
|
92
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
95
93
|
* @param {*} [options] Override http request option.
|
|
96
94
|
* @throws {RequiredError}
|
|
97
95
|
*/
|
|
98
|
-
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
96
|
+
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
99
97
|
};
|
|
100
98
|
/**
|
|
101
99
|
* PaymentsApi - factory interface
|
|
@@ -103,7 +101,7 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
103
101
|
*/
|
|
104
102
|
export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
105
103
|
/**
|
|
106
|
-
*
|
|
104
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
107
105
|
* @summary Create the payment
|
|
108
106
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
109
107
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
@@ -115,29 +113,28 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
|
|
|
115
113
|
/**
|
|
116
114
|
* 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
115
|
* @summary Retrieve the payment
|
|
118
|
-
* @param {string} code
|
|
119
|
-
* @param {string} code2 Unique identifier for the object.
|
|
120
|
-
* @param {string} expand Fields to expand response by
|
|
116
|
+
* @param {string} code Unique identifier for the object.
|
|
121
117
|
* @param {string} [authorization] Bearer Token
|
|
118
|
+
* @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: transactions.<i>
|
|
122
119
|
* @param {*} [options] Override http request option.
|
|
123
120
|
* @throws {RequiredError}
|
|
124
121
|
*/
|
|
125
|
-
getPayment(code: string,
|
|
122
|
+
getPayment(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
|
|
126
123
|
/**
|
|
127
|
-
* Returns a list of payments you have previously created.
|
|
124
|
+
* 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
125
|
* @summary List payments
|
|
129
126
|
* @param {string} [authorization] Bearer Token
|
|
130
127
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
131
128
|
* @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.
|
|
132
|
-
* @param {
|
|
129
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
133
130
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
134
|
-
* @param {
|
|
135
|
-
* @param {
|
|
136
|
-
* @param {
|
|
131
|
+
* @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, code, amount</i>
|
|
132
|
+
* @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: transactions.<i>
|
|
133
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
137
134
|
* @param {*} [options] Override http request option.
|
|
138
135
|
* @throws {RequiredError}
|
|
139
136
|
*/
|
|
140
|
-
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?:
|
|
137
|
+
listPayments(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<void>;
|
|
141
138
|
};
|
|
142
139
|
/**
|
|
143
140
|
* Request parameters for createPayment operation in PaymentsApi.
|
|
@@ -170,30 +167,24 @@ export interface PaymentsApiCreatePaymentRequest {
|
|
|
170
167
|
* @interface PaymentsApiGetPaymentRequest
|
|
171
168
|
*/
|
|
172
169
|
export interface PaymentsApiGetPaymentRequest {
|
|
173
|
-
/**
|
|
174
|
-
*
|
|
175
|
-
* @type {string}
|
|
176
|
-
* @memberof PaymentsApiGetPayment
|
|
177
|
-
*/
|
|
178
|
-
readonly code: string;
|
|
179
170
|
/**
|
|
180
171
|
* Unique identifier for the object.
|
|
181
172
|
* @type {string}
|
|
182
173
|
* @memberof PaymentsApiGetPayment
|
|
183
174
|
*/
|
|
184
|
-
readonly
|
|
175
|
+
readonly code: string;
|
|
185
176
|
/**
|
|
186
|
-
*
|
|
177
|
+
* Bearer Token
|
|
187
178
|
* @type {string}
|
|
188
179
|
* @memberof PaymentsApiGetPayment
|
|
189
180
|
*/
|
|
190
|
-
readonly
|
|
181
|
+
readonly authorization?: string;
|
|
191
182
|
/**
|
|
192
|
-
*
|
|
183
|
+
* 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: transactions.<i>
|
|
193
184
|
* @type {string}
|
|
194
185
|
* @memberof PaymentsApiGetPayment
|
|
195
186
|
*/
|
|
196
|
-
readonly
|
|
187
|
+
readonly expand?: string;
|
|
197
188
|
}
|
|
198
189
|
/**
|
|
199
190
|
* Request parameters for listPayments operation in PaymentsApi.
|
|
@@ -220,11 +211,11 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
220
211
|
*/
|
|
221
212
|
readonly pageToken?: any;
|
|
222
213
|
/**
|
|
223
|
-
* Filter the response by one or multiple fields.
|
|
224
|
-
* @type {
|
|
214
|
+
* 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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
215
|
+
* @type {string}
|
|
225
216
|
* @memberof PaymentsApiListPayments
|
|
226
217
|
*/
|
|
227
|
-
readonly filter?:
|
|
218
|
+
readonly filter?: string;
|
|
228
219
|
/**
|
|
229
220
|
* To search the list by any field, pass search=xxx to fetch the result.
|
|
230
221
|
* @type {any}
|
|
@@ -232,23 +223,23 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
232
223
|
*/
|
|
233
224
|
readonly search?: any;
|
|
234
225
|
/**
|
|
235
|
-
*
|
|
236
|
-
* @type {
|
|
226
|
+
* 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, code, amount</i>
|
|
227
|
+
* @type {string}
|
|
237
228
|
* @memberof PaymentsApiListPayments
|
|
238
229
|
*/
|
|
239
|
-
readonly order?:
|
|
230
|
+
readonly order?: string;
|
|
240
231
|
/**
|
|
241
|
-
*
|
|
242
|
-
* @type {
|
|
232
|
+
* 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: transactions.<i>
|
|
233
|
+
* @type {string}
|
|
243
234
|
* @memberof PaymentsApiListPayments
|
|
244
235
|
*/
|
|
245
|
-
readonly expand?:
|
|
236
|
+
readonly expand?: string;
|
|
246
237
|
/**
|
|
247
|
-
* Filters the response by one or multiple fields.
|
|
248
|
-
* @type {
|
|
238
|
+
* 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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
239
|
+
* @type {string}
|
|
249
240
|
* @memberof PaymentsApiListPayments
|
|
250
241
|
*/
|
|
251
|
-
readonly filters?:
|
|
242
|
+
readonly filters?: string;
|
|
252
243
|
}
|
|
253
244
|
/**
|
|
254
245
|
* PaymentsApi - object-oriented interface
|
|
@@ -258,7 +249,7 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
258
249
|
*/
|
|
259
250
|
export declare class PaymentsApi extends BaseAPI {
|
|
260
251
|
/**
|
|
261
|
-
*
|
|
252
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
262
253
|
* @summary Create the payment
|
|
263
254
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
264
255
|
* @param {*} [options] Override http request option.
|
|
@@ -276,7 +267,7 @@ export declare class PaymentsApi extends BaseAPI {
|
|
|
276
267
|
*/
|
|
277
268
|
getPayment(requestParameters: PaymentsApiGetPaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
278
269
|
/**
|
|
279
|
-
* Returns a list of payments you have previously created.
|
|
270
|
+
* 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
271
|
* @summary List payments
|
|
281
272
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
282
273
|
* @param {*} [options] Override http request option.
|
package/dist/api/payments-api.js
CHANGED
|
@@ -93,7 +93,7 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
*
|
|
96
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
97
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
|
|
@@ -150,14 +150,13 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
150
150
|
/**
|
|
151
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
152
|
* @summary Retrieve the payment
|
|
153
|
-
* @param {string} code
|
|
154
|
-
* @param {string} code2 Unique identifier for the object.
|
|
155
|
-
* @param {string} expand Fields to expand response by
|
|
153
|
+
* @param {string} code Unique identifier for the object.
|
|
156
154
|
* @param {string} [authorization] Bearer Token
|
|
155
|
+
* @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: transactions.<i>
|
|
157
156
|
* @param {*} [options] Override http request option.
|
|
158
157
|
* @throws {RequiredError}
|
|
159
158
|
*/
|
|
160
|
-
getPayment: function (code,
|
|
159
|
+
getPayment: function (code, authorization, expand, options) {
|
|
161
160
|
if (options === void 0) { options = {}; }
|
|
162
161
|
return __awaiter(_this, void 0, void 0, function () {
|
|
163
162
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -166,10 +165,6 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
166
165
|
case 0:
|
|
167
166
|
// verify required parameter 'code' is not null or undefined
|
|
168
167
|
(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);
|
|
171
|
-
// verify required parameter 'expand' is not null or undefined
|
|
172
|
-
(0, common_1.assertParamExists)('getPayment', 'expand', expand);
|
|
173
168
|
localVarPath = "/paymentservice/v1/payments/{code}"
|
|
174
169
|
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
175
170
|
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -187,9 +182,6 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
187
182
|
// authentication bearer required
|
|
188
183
|
// http bearer authentication required
|
|
189
184
|
_a.sent();
|
|
190
|
-
if (code2 !== undefined) {
|
|
191
|
-
localVarQueryParameter['code'] = code2;
|
|
192
|
-
}
|
|
193
185
|
if (expand !== undefined) {
|
|
194
186
|
localVarQueryParameter['expand'] = expand;
|
|
195
187
|
}
|
|
@@ -208,16 +200,16 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
208
200
|
});
|
|
209
201
|
},
|
|
210
202
|
/**
|
|
211
|
-
* Returns a list of payments you have previously created.
|
|
203
|
+
* 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.
|
|
212
204
|
* @summary List payments
|
|
213
205
|
* @param {string} [authorization] Bearer Token
|
|
214
206
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
215
207
|
* @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.
|
|
216
|
-
* @param {
|
|
208
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
217
209
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
218
|
-
* @param {
|
|
219
|
-
* @param {
|
|
220
|
-
* @param {
|
|
210
|
+
* @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, code, amount</i>
|
|
211
|
+
* @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: transactions.<i>
|
|
212
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
221
213
|
* @param {*} [options] Override http request option.
|
|
222
214
|
* @throws {RequiredError}
|
|
223
215
|
*/
|
|
@@ -290,7 +282,7 @@ var PaymentsApiFp = function (configuration) {
|
|
|
290
282
|
var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
|
|
291
283
|
return {
|
|
292
284
|
/**
|
|
293
|
-
*
|
|
285
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
294
286
|
* @summary Create the payment
|
|
295
287
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
296
288
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
@@ -314,19 +306,18 @@ var PaymentsApiFp = function (configuration) {
|
|
|
314
306
|
/**
|
|
315
307
|
* 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
308
|
* @summary Retrieve the payment
|
|
317
|
-
* @param {string} code
|
|
318
|
-
* @param {string} code2 Unique identifier for the object.
|
|
319
|
-
* @param {string} expand Fields to expand response by
|
|
309
|
+
* @param {string} code Unique identifier for the object.
|
|
320
310
|
* @param {string} [authorization] Bearer Token
|
|
311
|
+
* @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: transactions.<i>
|
|
321
312
|
* @param {*} [options] Override http request option.
|
|
322
313
|
* @throws {RequiredError}
|
|
323
314
|
*/
|
|
324
|
-
getPayment: function (code,
|
|
315
|
+
getPayment: function (code, authorization, expand, options) {
|
|
325
316
|
return __awaiter(this, void 0, void 0, function () {
|
|
326
317
|
var localVarAxiosArgs;
|
|
327
318
|
return __generator(this, function (_a) {
|
|
328
319
|
switch (_a.label) {
|
|
329
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPayment(code,
|
|
320
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPayment(code, authorization, expand, options)];
|
|
330
321
|
case 1:
|
|
331
322
|
localVarAxiosArgs = _a.sent();
|
|
332
323
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -335,16 +326,16 @@ var PaymentsApiFp = function (configuration) {
|
|
|
335
326
|
});
|
|
336
327
|
},
|
|
337
328
|
/**
|
|
338
|
-
* Returns a list of payments you have previously created.
|
|
329
|
+
* 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.
|
|
339
330
|
* @summary List payments
|
|
340
331
|
* @param {string} [authorization] Bearer Token
|
|
341
332
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
342
333
|
* @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.
|
|
343
|
-
* @param {
|
|
334
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
344
335
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
345
|
-
* @param {
|
|
346
|
-
* @param {
|
|
347
|
-
* @param {
|
|
336
|
+
* @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, code, amount</i>
|
|
337
|
+
* @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: transactions.<i>
|
|
338
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
348
339
|
* @param {*} [options] Override http request option.
|
|
349
340
|
* @throws {RequiredError}
|
|
350
341
|
*/
|
|
@@ -372,7 +363,7 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
372
363
|
var localVarFp = (0, exports.PaymentsApiFp)(configuration);
|
|
373
364
|
return {
|
|
374
365
|
/**
|
|
375
|
-
*
|
|
366
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
376
367
|
* @summary Create the payment
|
|
377
368
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
378
369
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
@@ -386,27 +377,26 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
386
377
|
/**
|
|
387
378
|
* 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
379
|
* @summary Retrieve the payment
|
|
389
|
-
* @param {string} code
|
|
390
|
-
* @param {string} code2 Unique identifier for the object.
|
|
391
|
-
* @param {string} expand Fields to expand response by
|
|
380
|
+
* @param {string} code Unique identifier for the object.
|
|
392
381
|
* @param {string} [authorization] Bearer Token
|
|
382
|
+
* @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: transactions.<i>
|
|
393
383
|
* @param {*} [options] Override http request option.
|
|
394
384
|
* @throws {RequiredError}
|
|
395
385
|
*/
|
|
396
|
-
getPayment: function (code,
|
|
397
|
-
return localVarFp.getPayment(code,
|
|
386
|
+
getPayment: function (code, authorization, expand, options) {
|
|
387
|
+
return localVarFp.getPayment(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
398
388
|
},
|
|
399
389
|
/**
|
|
400
|
-
* Returns a list of payments you have previously created.
|
|
390
|
+
* 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.
|
|
401
391
|
* @summary List payments
|
|
402
392
|
* @param {string} [authorization] Bearer Token
|
|
403
393
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
404
394
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
405
|
-
* @param {
|
|
395
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
406
396
|
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
407
|
-
* @param {
|
|
408
|
-
* @param {
|
|
409
|
-
* @param {
|
|
397
|
+
* @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, code, amount</i>
|
|
398
|
+
* @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: transactions.<i>
|
|
399
|
+
* @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, pspCustomerId, psp, type, amount, receivedDate, referenceNumber</i>
|
|
410
400
|
* @param {*} [options] Override http request option.
|
|
411
401
|
* @throws {RequiredError}
|
|
412
402
|
*/
|
|
@@ -428,7 +418,7 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
428
418
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
429
419
|
}
|
|
430
420
|
/**
|
|
431
|
-
*
|
|
421
|
+
* This will create a payment for a specified account. This function is idempotent.
|
|
432
422
|
* @summary Create the payment
|
|
433
423
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
434
424
|
* @param {*} [options] Override http request option.
|
|
@@ -449,10 +439,10 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
449
439
|
*/
|
|
450
440
|
PaymentsApi.prototype.getPayment = function (requestParameters, options) {
|
|
451
441
|
var _this = this;
|
|
452
|
-
return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.
|
|
442
|
+
return (0, exports.PaymentsApiFp)(this.configuration).getPayment(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
453
443
|
};
|
|
454
444
|
/**
|
|
455
|
-
* Returns a list of payments you have previously created.
|
|
445
|
+
* 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.
|
|
456
446
|
* @summary List payments
|
|
457
447
|
* @param {PaymentsApiListPaymentsRequest} requestParameters Request parameters.
|
|
458
448
|
* @param {*} [options] Override http request option.
|