@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.
- package/.openapi-generator/FILES +5 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +346 -22
- package/api/bank-transaction-api.ts +12 -12
- package/api/payment-methods-api.ts +38 -145
- package/api/payment-reminders-api.ts +12 -12
- package/api/payments-api.ts +42 -45
- package/api/refunds-api.ts +4 -4
- package/api/tenant-bank-account-api.ts +20 -20
- package/dist/api/bank-accounts-api.d.ts +193 -16
- package/dist/api/bank-accounts-api.js +302 -19
- package/dist/api/bank-transaction-api.d.ts +12 -12
- package/dist/api/bank-transaction-api.js +11 -11
- package/dist/api/payment-methods-api.d.ts +29 -84
- package/dist/api/payment-methods-api.js +33 -129
- package/dist/api/payment-reminders-api.d.ts +12 -12
- package/dist/api/payment-reminders-api.js +11 -11
- package/dist/api/payments-api.d.ts +33 -33
- package/dist/api/payments-api.js +37 -39
- package/dist/api/refunds-api.d.ts +4 -4
- package/dist/api/refunds-api.js +3 -3
- package/dist/api/tenant-bank-account-api.d.ts +20 -20
- package/dist/api/tenant-bank-account-api.js +14 -14
- package/dist/models/bank-account-class.d.ts +67 -0
- package/dist/models/bank-account-class.js +15 -0
- package/dist/models/create-bank-account-request-dto.d.ts +30 -0
- package/dist/models/create-bank-account-request-dto.js +15 -0
- package/dist/models/get-bank-account-response-class.d.ts +25 -0
- package/dist/models/get-bank-account-response-class.js +15 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/dist/models/primary-bank-account-response-class.d.ts +42 -0
- package/dist/models/primary-bank-account-response-class.js +15 -0
- package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
- package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
- package/models/bank-account-class.ts +73 -0
- package/models/create-bank-account-request-dto.ts +36 -0
- package/models/get-bank-account-response-class.ts +31 -0
- package/models/index.ts +5 -0
- package/models/primary-bank-account-response-class.ts +48 -0
- package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
- package/package.json +1 -1
|
@@ -93,7 +93,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code
|
|
96
|
+
* Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
|
|
97
97
|
* @summary Retrieve the Bank Transaction
|
|
98
98
|
* @param {string} code
|
|
99
99
|
* @param {string} [authorization] Bearer Token
|
|
@@ -250,13 +250,13 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
250
250
|
});
|
|
251
251
|
},
|
|
252
252
|
/**
|
|
253
|
-
* Returns a list of bank transactions you have previously created.
|
|
253
|
+
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
254
254
|
* @summary List bank transactions
|
|
255
255
|
* @param {string} [authorization] Bearer Token
|
|
256
256
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
257
257
|
* @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.
|
|
258
258
|
* @param {any} [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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
259
|
-
* @param {any} [search]
|
|
259
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
260
260
|
* @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.
|
|
261
261
|
* @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
|
|
262
262
|
* @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.
|
|
@@ -385,7 +385,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
385
385
|
var localVarAxiosParamCreator = (0, exports.BankTransactionApiAxiosParamCreator)(configuration);
|
|
386
386
|
return {
|
|
387
387
|
/**
|
|
388
|
-
* Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code
|
|
388
|
+
* Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
|
|
389
389
|
* @summary Retrieve the Bank Transaction
|
|
390
390
|
* @param {string} code
|
|
391
391
|
* @param {string} [authorization] Bearer Token
|
|
@@ -450,13 +450,13 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
450
450
|
});
|
|
451
451
|
},
|
|
452
452
|
/**
|
|
453
|
-
* Returns a list of bank transactions you have previously created.
|
|
453
|
+
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
454
454
|
* @summary List bank transactions
|
|
455
455
|
* @param {string} [authorization] Bearer Token
|
|
456
456
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
457
457
|
* @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.
|
|
458
458
|
* @param {any} [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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
459
|
-
* @param {any} [search]
|
|
459
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
460
460
|
* @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.
|
|
461
461
|
* @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
|
|
462
462
|
* @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.
|
|
@@ -509,7 +509,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
509
509
|
var localVarFp = (0, exports.BankTransactionApiFp)(configuration);
|
|
510
510
|
return {
|
|
511
511
|
/**
|
|
512
|
-
* Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code
|
|
512
|
+
* Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
|
|
513
513
|
* @summary Retrieve the Bank Transaction
|
|
514
514
|
* @param {string} code
|
|
515
515
|
* @param {string} [authorization] Bearer Token
|
|
@@ -544,13 +544,13 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
544
544
|
return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
545
545
|
},
|
|
546
546
|
/**
|
|
547
|
-
* Returns a list of bank transactions you have previously created.
|
|
547
|
+
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
548
548
|
* @summary List bank transactions
|
|
549
549
|
* @param {string} [authorization] Bearer Token
|
|
550
550
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
551
551
|
* @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.
|
|
552
552
|
* @param {any} [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: id, code, bankAccountId, bankAccountNumber, swiftMessageReference, amount, currency, transactionReference, transactionDate, entryDate, isLinked</i>
|
|
553
|
-
* @param {any} [search]
|
|
553
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
554
554
|
* @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.
|
|
555
555
|
* @param {'bankAccount' | 'transaction'} [expand] Expand the response with additional entities
|
|
556
556
|
* @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.
|
|
@@ -587,7 +587,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
587
587
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
588
588
|
}
|
|
589
589
|
/**
|
|
590
|
-
* Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code
|
|
590
|
+
* Retrieves the details of the Bank Transaction that was previously created. Supply the unique Bank Transaction code that was returned when you created it and Emil Api will return the corresponding Bank Transaction information.
|
|
591
591
|
* @summary Retrieve the Bank Transaction
|
|
592
592
|
* @param {BankTransactionApiGetBankTransactionRequest} requestParameters Request parameters.
|
|
593
593
|
* @param {*} [options] Override http request option.
|
|
@@ -623,7 +623,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
623
623
|
return (0, exports.BankTransactionApiFp)(this.configuration).linkBankTransaction(requestParameters.code, requestParameters.linkBankTransactionRequestDtoRest, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
624
624
|
};
|
|
625
625
|
/**
|
|
626
|
-
* Returns a list of bank transactions you have previously created.
|
|
626
|
+
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
627
627
|
* @summary List bank transactions
|
|
628
628
|
* @param {BankTransactionApiListBankTransactionsRequest} requestParameters Request parameters.
|
|
629
629
|
* @param {*} [options] Override http request option.
|
|
@@ -19,41 +19,32 @@ import { RequestArgs, BaseAPI } from '../base';
|
|
|
19
19
|
export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
20
20
|
/**
|
|
21
21
|
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
22
|
-
* @summary Create the payment
|
|
22
|
+
* @summary Create the payment method
|
|
23
23
|
* @param {object} body
|
|
24
24
|
* @param {string} [authorization] Bearer Token
|
|
25
25
|
* @param {*} [options] Override http request option.
|
|
26
26
|
* @throws {RequiredError}
|
|
27
27
|
*/
|
|
28
28
|
createPaymentMethod: (body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
|
-
/**
|
|
30
|
-
* Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
|
|
31
|
-
* @summary Delete a payment method
|
|
32
|
-
* @param {number} id Unique identifier for payment method
|
|
33
|
-
* @param {string} [authorization] Bearer Token
|
|
34
|
-
* @param {*} [options] Override http request option.
|
|
35
|
-
* @throws {RequiredError}
|
|
36
|
-
*/
|
|
37
|
-
deletePaymentMethod: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
29
|
/**
|
|
39
30
|
* Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
|
|
40
|
-
* @summary Retrieve
|
|
41
|
-
* @param {string} code
|
|
31
|
+
* @summary Retrieve the payment method
|
|
32
|
+
* @param {string} code
|
|
33
|
+
* @param {string} code2 Unique identifier for the object.
|
|
42
34
|
* @param {string} expand Fields to expand response by
|
|
43
|
-
* @param {string} expand2 Fields to expand response by
|
|
44
35
|
* @param {string} [authorization] Bearer Token
|
|
45
36
|
* @param {*} [options] Override http request option.
|
|
46
37
|
* @throws {RequiredError}
|
|
47
38
|
*/
|
|
48
|
-
getPaymentMethod: (code: string,
|
|
39
|
+
getPaymentMethod: (code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
40
|
/**
|
|
50
|
-
* Returns a list of payment methods you
|
|
41
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
51
42
|
* @summary List payment methods
|
|
52
43
|
* @param {string} [authorization] Bearer Token
|
|
53
44
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
54
45
|
* @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.
|
|
55
46
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
56
|
-
* @param {any} [search]
|
|
47
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
57
48
|
* @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.
|
|
58
49
|
* @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.
|
|
59
50
|
* @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.
|
|
@@ -69,41 +60,32 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
69
60
|
export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
70
61
|
/**
|
|
71
62
|
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
72
|
-
* @summary Create the payment
|
|
63
|
+
* @summary Create the payment method
|
|
73
64
|
* @param {object} body
|
|
74
65
|
* @param {string} [authorization] Bearer Token
|
|
75
66
|
* @param {*} [options] Override http request option.
|
|
76
67
|
* @throws {RequiredError}
|
|
77
68
|
*/
|
|
78
69
|
createPaymentMethod(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
79
|
-
/**
|
|
80
|
-
* Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
|
|
81
|
-
* @summary Delete a payment method
|
|
82
|
-
* @param {number} id Unique identifier for payment method
|
|
83
|
-
* @param {string} [authorization] Bearer Token
|
|
84
|
-
* @param {*} [options] Override http request option.
|
|
85
|
-
* @throws {RequiredError}
|
|
86
|
-
*/
|
|
87
|
-
deletePaymentMethod(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
88
70
|
/**
|
|
89
71
|
* Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
|
|
90
|
-
* @summary Retrieve
|
|
91
|
-
* @param {string} code
|
|
72
|
+
* @summary Retrieve the payment method
|
|
73
|
+
* @param {string} code
|
|
74
|
+
* @param {string} code2 Unique identifier for the object.
|
|
92
75
|
* @param {string} expand Fields to expand response by
|
|
93
|
-
* @param {string} expand2 Fields to expand response by
|
|
94
76
|
* @param {string} [authorization] Bearer Token
|
|
95
77
|
* @param {*} [options] Override http request option.
|
|
96
78
|
* @throws {RequiredError}
|
|
97
79
|
*/
|
|
98
|
-
getPaymentMethod(code: string,
|
|
80
|
+
getPaymentMethod(code: string, code2: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
99
81
|
/**
|
|
100
|
-
* Returns a list of payment methods you
|
|
82
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
101
83
|
* @summary List payment methods
|
|
102
84
|
* @param {string} [authorization] Bearer Token
|
|
103
85
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
104
86
|
* @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
105
87
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
106
|
-
* @param {any} [search]
|
|
88
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
107
89
|
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
108
90
|
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
109
91
|
* @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.
|
|
@@ -119,41 +101,32 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
119
101
|
export declare const PaymentMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
120
102
|
/**
|
|
121
103
|
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
122
|
-
* @summary Create the payment
|
|
104
|
+
* @summary Create the payment method
|
|
123
105
|
* @param {object} body
|
|
124
106
|
* @param {string} [authorization] Bearer Token
|
|
125
107
|
* @param {*} [options] Override http request option.
|
|
126
108
|
* @throws {RequiredError}
|
|
127
109
|
*/
|
|
128
110
|
createPaymentMethod(body: object, authorization?: string, options?: any): AxiosPromise<void>;
|
|
129
|
-
/**
|
|
130
|
-
* Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
|
|
131
|
-
* @summary Delete a payment method
|
|
132
|
-
* @param {number} id Unique identifier for payment method
|
|
133
|
-
* @param {string} [authorization] Bearer Token
|
|
134
|
-
* @param {*} [options] Override http request option.
|
|
135
|
-
* @throws {RequiredError}
|
|
136
|
-
*/
|
|
137
|
-
deletePaymentMethod(id: number, authorization?: string, options?: any): AxiosPromise<void>;
|
|
138
111
|
/**
|
|
139
112
|
* Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
|
|
140
|
-
* @summary Retrieve
|
|
141
|
-
* @param {string} code
|
|
113
|
+
* @summary Retrieve the payment method
|
|
114
|
+
* @param {string} code
|
|
115
|
+
* @param {string} code2 Unique identifier for the object.
|
|
142
116
|
* @param {string} expand Fields to expand response by
|
|
143
|
-
* @param {string} expand2 Fields to expand response by
|
|
144
117
|
* @param {string} [authorization] Bearer Token
|
|
145
118
|
* @param {*} [options] Override http request option.
|
|
146
119
|
* @throws {RequiredError}
|
|
147
120
|
*/
|
|
148
|
-
getPaymentMethod(code: string,
|
|
121
|
+
getPaymentMethod(code: string, code2: string, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
149
122
|
/**
|
|
150
|
-
* Returns a list of payment methods you
|
|
123
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
151
124
|
* @summary List payment methods
|
|
152
125
|
* @param {string} [authorization] Bearer Token
|
|
153
126
|
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
154
127
|
* @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.
|
|
155
128
|
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
156
|
-
* @param {any} [search]
|
|
129
|
+
* @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
157
130
|
* @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.
|
|
158
131
|
* @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.
|
|
159
132
|
* @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.
|
|
@@ -181,25 +154,6 @@ export interface PaymentMethodsApiCreatePaymentMethodRequest {
|
|
|
181
154
|
*/
|
|
182
155
|
readonly authorization?: string;
|
|
183
156
|
}
|
|
184
|
-
/**
|
|
185
|
-
* Request parameters for deletePaymentMethod operation in PaymentMethodsApi.
|
|
186
|
-
* @export
|
|
187
|
-
* @interface PaymentMethodsApiDeletePaymentMethodRequest
|
|
188
|
-
*/
|
|
189
|
-
export interface PaymentMethodsApiDeletePaymentMethodRequest {
|
|
190
|
-
/**
|
|
191
|
-
* Unique identifier for payment method
|
|
192
|
-
* @type {number}
|
|
193
|
-
* @memberof PaymentMethodsApiDeletePaymentMethod
|
|
194
|
-
*/
|
|
195
|
-
readonly id: number;
|
|
196
|
-
/**
|
|
197
|
-
* Bearer Token
|
|
198
|
-
* @type {string}
|
|
199
|
-
* @memberof PaymentMethodsApiDeletePaymentMethod
|
|
200
|
-
*/
|
|
201
|
-
readonly authorization?: string;
|
|
202
|
-
}
|
|
203
157
|
/**
|
|
204
158
|
* Request parameters for getPaymentMethod operation in PaymentMethodsApi.
|
|
205
159
|
* @export
|
|
@@ -207,23 +161,23 @@ export interface PaymentMethodsApiDeletePaymentMethodRequest {
|
|
|
207
161
|
*/
|
|
208
162
|
export interface PaymentMethodsApiGetPaymentMethodRequest {
|
|
209
163
|
/**
|
|
210
|
-
*
|
|
164
|
+
*
|
|
211
165
|
* @type {string}
|
|
212
166
|
* @memberof PaymentMethodsApiGetPaymentMethod
|
|
213
167
|
*/
|
|
214
168
|
readonly code: string;
|
|
215
169
|
/**
|
|
216
|
-
*
|
|
170
|
+
* Unique identifier for the object.
|
|
217
171
|
* @type {string}
|
|
218
172
|
* @memberof PaymentMethodsApiGetPaymentMethod
|
|
219
173
|
*/
|
|
220
|
-
readonly
|
|
174
|
+
readonly code2: string;
|
|
221
175
|
/**
|
|
222
176
|
* Fields to expand response by
|
|
223
177
|
* @type {string}
|
|
224
178
|
* @memberof PaymentMethodsApiGetPaymentMethod
|
|
225
179
|
*/
|
|
226
|
-
readonly
|
|
180
|
+
readonly expand: string;
|
|
227
181
|
/**
|
|
228
182
|
* Bearer Token
|
|
229
183
|
* @type {string}
|
|
@@ -262,7 +216,7 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
262
216
|
*/
|
|
263
217
|
readonly filter?: any;
|
|
264
218
|
/**
|
|
265
|
-
*
|
|
219
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
266
220
|
* @type {any}
|
|
267
221
|
* @memberof PaymentMethodsApiListPaymentMethods
|
|
268
222
|
*/
|
|
@@ -295,25 +249,16 @@ export interface PaymentMethodsApiListPaymentMethodsRequest {
|
|
|
295
249
|
export declare class PaymentMethodsApi extends BaseAPI {
|
|
296
250
|
/**
|
|
297
251
|
* This will create payment method in the database as well as in the PSP. The newly created payment method will be set as default payment method will be used by the customer to pay or receive a refund.
|
|
298
|
-
* @summary Create the payment
|
|
252
|
+
* @summary Create the payment method
|
|
299
253
|
* @param {PaymentMethodsApiCreatePaymentMethodRequest} requestParameters Request parameters.
|
|
300
254
|
* @param {*} [options] Override http request option.
|
|
301
255
|
* @throws {RequiredError}
|
|
302
256
|
* @memberof PaymentMethodsApi
|
|
303
257
|
*/
|
|
304
258
|
createPaymentMethod(requestParameters: PaymentMethodsApiCreatePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
305
|
-
/**
|
|
306
|
-
* Permanently deletes a payment method. Supply the unique payment method id that was returned when you created the payment method and this will delete it. It will also delete it on the corresponding payment service provider.
|
|
307
|
-
* @summary Delete a payment method
|
|
308
|
-
* @param {PaymentMethodsApiDeletePaymentMethodRequest} requestParameters Request parameters.
|
|
309
|
-
* @param {*} [options] Override http request option.
|
|
310
|
-
* @throws {RequiredError}
|
|
311
|
-
* @memberof PaymentMethodsApi
|
|
312
|
-
*/
|
|
313
|
-
deletePaymentMethod(requestParameters: PaymentMethodsApiDeletePaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
314
259
|
/**
|
|
315
260
|
* Retrieves the details of a payment method that was previously created. Supply the unique payment method code that was returned when you created the payment method and Emil Api will return the corresponding payment method information.
|
|
316
|
-
* @summary Retrieve
|
|
261
|
+
* @summary Retrieve the payment method
|
|
317
262
|
* @param {PaymentMethodsApiGetPaymentMethodRequest} requestParameters Request parameters.
|
|
318
263
|
* @param {*} [options] Override http request option.
|
|
319
264
|
* @throws {RequiredError}
|
|
@@ -321,7 +266,7 @@ export declare class PaymentMethodsApi extends BaseAPI {
|
|
|
321
266
|
*/
|
|
322
267
|
getPaymentMethod(requestParameters: PaymentMethodsApiGetPaymentMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
323
268
|
/**
|
|
324
|
-
* Returns a list of payment methods you
|
|
269
|
+
* Returns a list of payment methods you have previously created. The payment methods are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
325
270
|
* @summary List payment methods
|
|
326
271
|
* @param {PaymentMethodsApiListPaymentMethodsRequest} requestParameters Request parameters.
|
|
327
272
|
* @param {*} [options] Override http request option.
|