@emilgroup/payment-sdk 1.13.1-beta.9 → 1.13.1-beta.90
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 +25 -1
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +55 -13
- package/api/bank-orders-api.ts +691 -0
- package/api/bank-transaction-api.ts +63 -52
- package/api/exceeding-credits-api.ts +349 -0
- package/api/payment-methods-api.ts +59 -17
- package/api/payment-reminders-api.ts +55 -13
- package/api/payments-api.ts +188 -21
- package/api/policy-payment-methods-api.ts +165 -0
- package/api/refunds-api.ts +45 -17
- package/api/tenant-bank-account-api.ts +45 -17
- package/api.ts +6 -0
- package/base.ts +51 -2
- package/dist/api/bank-accounts-api.d.ts +35 -8
- package/dist/api/bank-accounts-api.js +29 -11
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +642 -0
- package/dist/api/bank-transaction-api.d.ts +43 -35
- package/dist/api/bank-transaction-api.js +39 -34
- package/dist/api/exceeding-credits-api.d.ts +206 -0
- package/dist/api/exceeding-credits-api.js +352 -0
- package/dist/api/payment-methods-api.d.ts +39 -12
- package/dist/api/payment-methods-api.js +32 -14
- package/dist/api/payment-reminders-api.d.ts +35 -8
- package/dist/api/payment-reminders-api.js +29 -11
- package/dist/api/payments-api.d.ts +112 -16
- package/dist/api/payments-api.js +141 -18
- package/dist/api/policy-payment-methods-api.d.ts +97 -0
- package/dist/api/policy-payment-methods-api.js +224 -0
- package/dist/api/refunds-api.d.ts +28 -10
- package/dist/api/refunds-api.js +24 -12
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api.d.ts +3 -0
- package/dist/api.js +3 -0
- package/dist/base.d.ts +10 -1
- package/dist/base.js +46 -2
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +18 -18
- package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
- package/dist/models/bank-transaction-class.d.ts +22 -22
- package/dist/models/bank-transaction-class.js +5 -0
- package/dist/models/bank-transaction-invoice-class.d.ts +60 -0
- package/dist/models/bank-transaction-invoice-class.js +15 -0
- package/dist/models/bank-transfer-dto.d.ts +25 -0
- package/dist/models/bank-transfer-dto.js +15 -0
- package/dist/models/billing-address-dto.d.ts +54 -0
- package/dist/models/billing-address-dto.js +15 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.js +3 -1
- package/dist/models/complete-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/complete-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +7 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +2 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +3 -1
- package/dist/models/create-bank-order-request-dto.d.ts +74 -0
- package/dist/models/create-bank-order-request-dto.js +28 -0
- package/dist/models/create-bank-order-response-class.d.ts +25 -0
- package/dist/models/create-bank-order-response-class.js +15 -0
- package/dist/models/create-payment-order-dto.d.ts +48 -0
- package/dist/models/create-payment-order-dto.js +15 -0
- package/dist/models/create-payment-order-request-dto.d.ts +48 -0
- package/dist/models/create-payment-order-request-dto.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-policy-payment-method-request-dto.d.ts +30 -0
- package/dist/models/create-policy-payment-method-request-dto.js +15 -0
- package/dist/models/create-policy-payment-method-response-class.d.ts +25 -0
- package/dist/models/create-policy-payment-method-response-class.js +15 -0
- package/dist/models/create-psp-payment-method-request-dto.d.ts +22 -1
- package/dist/models/create-psp-payment-method-request-dto.js +3 -1
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/exceeding-credit-class.d.ts +116 -0
- package/dist/models/exceeding-credit-class.js +29 -0
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/get-bank-order-response-class.d.ts +25 -0
- package/dist/models/get-bank-order-response-class.js +15 -0
- package/dist/models/get-exceeding-credit-response-class.d.ts +25 -0
- package/dist/models/get-exceeding-credit-response-class.js +15 -0
- package/dist/models/index.d.ts +22 -1
- package/dist/models/index.js +22 -1
- package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +3 -2
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/{unlink-bank-transaction-request-dto-rest.d.ts → invoice-allocation-dto.d.ts} +10 -4
- package/dist/models/invoice-allocation-dto.js +15 -0
- package/dist/models/link-bank-transaction-request-dto-rest.d.ts +4 -3
- package/dist/models/list-bank-orders-response-class.d.ts +31 -0
- package/dist/models/list-bank-orders-response-class.js +15 -0
- package/dist/models/list-exceeding-credits-response-class.d.ts +31 -0
- package/dist/models/list-exceeding-credits-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
- package/dist/models/payment-class.d.ts +7 -1
- package/dist/models/payment-method-class.d.ts +6 -0
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/policy-payment-method-class.d.ts +73 -0
- package/dist/models/policy-payment-method-class.js +15 -0
- package/dist/models/refund-class.d.ts +7 -1
- package/dist/models/unlinked-bank-transaction-response-class.d.ts +18 -0
- package/dist/models/unlinked-bank-transaction-response-class.js +5 -0
- package/dist/models/update-bank-order-request-dto.d.ts +62 -0
- package/dist/models/update-bank-order-request-dto.js +23 -0
- package/dist/models/update-bank-order-response-class.d.ts +25 -0
- package/dist/models/update-bank-order-response-class.js +15 -0
- package/models/bank-order-class.ts +121 -0
- package/models/bank-transaction-class-without-expand-properties.ts +21 -18
- package/models/bank-transaction-class.ts +25 -22
- package/models/bank-transaction-invoice-class.ts +66 -0
- package/models/bank-transfer-dto.ts +31 -0
- package/models/billing-address-dto.ts +60 -0
- package/models/complete-adyen-payment-setup-request-dto.ts +3 -1
- package/models/complete-eis-payment-setup-request-dto.ts +42 -0
- package/models/complete-payment-setup-request-dto.ts +7 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +3 -1
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-order-dto.ts +54 -0
- package/models/create-payment-order-request-dto.ts +54 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-policy-payment-method-request-dto.ts +36 -0
- package/models/create-policy-payment-method-response-class.ts +31 -0
- package/models/create-psp-payment-method-request-dto.ts +23 -2
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/exceeding-credit-class.ts +125 -0
- package/models/financial-account-class.ts +120 -0
- package/models/get-bank-order-response-class.ts +31 -0
- package/models/get-exceeding-credit-response-class.ts +31 -0
- package/models/index.ts +22 -1
- package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
- package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
- package/models/initiate-eis-payment-setup-request-dto.ts +42 -0
- package/models/initiate-payment-setup-request-dto.ts +3 -2
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/{unlink-bank-transaction-request-dto-rest.ts → invoice-allocation-dto.ts} +10 -4
- package/models/link-bank-transaction-request-dto-rest.ts +4 -3
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/list-exceeding-credits-response-class.ts +37 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-method-class.ts +6 -0
- package/models/payment-reminder-class.ts +7 -1
- package/models/policy-payment-method-class.ts +79 -0
- package/models/refund-class.ts +7 -1
- package/models/unlinked-bank-transaction-response-class.ts +21 -0
- package/models/update-bank-order-request-dto.ts +71 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- /package/dist/models/{unlink-bank-transaction-request-dto-rest.js → bank-order-class.js} +0 -0
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { CreatePaymentOrderDto } from '../models';
|
|
15
16
|
import { CreatePaymentRequestDto } from '../models';
|
|
16
17
|
import { CreatePaymentResponseClass } from '../models';
|
|
17
18
|
import { GetPaymentResponseClass } from '../models';
|
|
@@ -22,15 +23,26 @@ import { ListPaymentsResponseClass } from '../models';
|
|
|
22
23
|
*/
|
|
23
24
|
export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
25
|
/**
|
|
25
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
26
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
26
27
|
* @summary Create the payment
|
|
27
28
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
28
29
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
29
30
|
* @param {string} [authorization] Bearer Token
|
|
30
31
|
* @param {*} [options] Override http request option.
|
|
32
|
+
* @deprecated
|
|
31
33
|
* @throws {RequiredError}
|
|
32
34
|
*/
|
|
33
35
|
createPayment: (idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36
|
+
/**
|
|
37
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
38
|
+
* @summary Create the payment
|
|
39
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
40
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
41
|
+
* @param {string} [authorization] Bearer Token
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
createPaymentOrder: (idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
46
|
/**
|
|
35
47
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
36
48
|
* @summary Retrieve the payment
|
|
@@ -45,14 +57,17 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
45
57
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
46
58
|
* @summary List payments
|
|
47
59
|
* @param {string} [authorization] Bearer Token
|
|
48
|
-
* @param {
|
|
49
|
-
* @param {string} [
|
|
60
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
61
|
+
* @param {string} [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.
|
|
62
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
63
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
50
64
|
* @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>
|
|
51
65
|
* @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>
|
|
66
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
52
67
|
* @param {*} [options] Override http request option.
|
|
53
68
|
* @throws {RequiredError}
|
|
54
69
|
*/
|
|
55
|
-
listPayments: (authorization?: string, filter?: string,
|
|
70
|
+
listPayments: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
71
|
};
|
|
57
72
|
/**
|
|
58
73
|
* PaymentsApi - functional programming interface
|
|
@@ -60,15 +75,26 @@ export declare const PaymentsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
60
75
|
*/
|
|
61
76
|
export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
62
77
|
/**
|
|
63
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
78
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
64
79
|
* @summary Create the payment
|
|
65
80
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
66
81
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
67
82
|
* @param {string} [authorization] Bearer Token
|
|
68
83
|
* @param {*} [options] Override http request option.
|
|
84
|
+
* @deprecated
|
|
69
85
|
* @throws {RequiredError}
|
|
70
86
|
*/
|
|
71
87
|
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
|
|
88
|
+
/**
|
|
89
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
90
|
+
* @summary Create the payment
|
|
91
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
92
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
93
|
+
* @param {string} [authorization] Bearer Token
|
|
94
|
+
* @param {*} [options] Override http request option.
|
|
95
|
+
* @throws {RequiredError}
|
|
96
|
+
*/
|
|
97
|
+
createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentResponseClass>>;
|
|
72
98
|
/**
|
|
73
99
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
74
100
|
* @summary Retrieve the payment
|
|
@@ -83,14 +109,17 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
83
109
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
84
110
|
* @summary List payments
|
|
85
111
|
* @param {string} [authorization] Bearer Token
|
|
86
|
-
* @param {
|
|
87
|
-
* @param {string} [
|
|
112
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
113
|
+
* @param {string} [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.
|
|
114
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
115
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
88
116
|
* @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>
|
|
89
117
|
* @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>
|
|
118
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
90
119
|
* @param {*} [options] Override http request option.
|
|
91
120
|
* @throws {RequiredError}
|
|
92
121
|
*/
|
|
93
|
-
listPayments(authorization?: string, filter?: string,
|
|
122
|
+
listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentsResponseClass>>;
|
|
94
123
|
};
|
|
95
124
|
/**
|
|
96
125
|
* PaymentsApi - factory interface
|
|
@@ -98,15 +127,26 @@ export declare const PaymentsApiFp: (configuration?: Configuration) => {
|
|
|
98
127
|
*/
|
|
99
128
|
export declare const PaymentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
100
129
|
/**
|
|
101
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
130
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
102
131
|
* @summary Create the payment
|
|
103
132
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
104
133
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
105
134
|
* @param {string} [authorization] Bearer Token
|
|
106
135
|
* @param {*} [options] Override http request option.
|
|
136
|
+
* @deprecated
|
|
107
137
|
* @throws {RequiredError}
|
|
108
138
|
*/
|
|
109
139
|
createPayment(idempotencyKey: string, createPaymentRequestDto: CreatePaymentRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
|
|
140
|
+
/**
|
|
141
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
142
|
+
* @summary Create the payment
|
|
143
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
144
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
145
|
+
* @param {string} [authorization] Bearer Token
|
|
146
|
+
* @param {*} [options] Override http request option.
|
|
147
|
+
* @throws {RequiredError}
|
|
148
|
+
*/
|
|
149
|
+
createPaymentOrder(idempotencyKey: string, createPaymentOrderDto: CreatePaymentOrderDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentResponseClass>;
|
|
110
150
|
/**
|
|
111
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. **Required Permissions** \"payment-management.payments.view\"
|
|
112
152
|
* @summary Retrieve the payment
|
|
@@ -121,14 +161,17 @@ export declare const PaymentsApiFactory: (configuration?: Configuration, basePat
|
|
|
121
161
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
122
162
|
* @summary List payments
|
|
123
163
|
* @param {string} [authorization] Bearer Token
|
|
124
|
-
* @param {
|
|
125
|
-
* @param {string} [
|
|
164
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
165
|
+
* @param {string} [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.
|
|
166
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
167
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
126
168
|
* @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>
|
|
127
169
|
* @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>
|
|
170
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
128
171
|
* @param {*} [options] Override http request option.
|
|
129
172
|
* @throws {RequiredError}
|
|
130
173
|
*/
|
|
131
|
-
listPayments(authorization?: string, filter?: string,
|
|
174
|
+
listPayments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPaymentsResponseClass>;
|
|
132
175
|
};
|
|
133
176
|
/**
|
|
134
177
|
* Request parameters for createPayment operation in PaymentsApi.
|
|
@@ -155,6 +198,31 @@ export interface PaymentsApiCreatePaymentRequest {
|
|
|
155
198
|
*/
|
|
156
199
|
readonly authorization?: string;
|
|
157
200
|
}
|
|
201
|
+
/**
|
|
202
|
+
* Request parameters for createPaymentOrder operation in PaymentsApi.
|
|
203
|
+
* @export
|
|
204
|
+
* @interface PaymentsApiCreatePaymentOrderRequest
|
|
205
|
+
*/
|
|
206
|
+
export interface PaymentsApiCreatePaymentOrderRequest {
|
|
207
|
+
/**
|
|
208
|
+
* Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
209
|
+
* @type {string}
|
|
210
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
211
|
+
*/
|
|
212
|
+
readonly idempotencyKey: string;
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @type {CreatePaymentOrderDto}
|
|
216
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
217
|
+
*/
|
|
218
|
+
readonly createPaymentOrderDto: CreatePaymentOrderDto;
|
|
219
|
+
/**
|
|
220
|
+
* Bearer Token
|
|
221
|
+
* @type {string}
|
|
222
|
+
* @memberof PaymentsApiCreatePaymentOrder
|
|
223
|
+
*/
|
|
224
|
+
readonly authorization?: string;
|
|
225
|
+
}
|
|
158
226
|
/**
|
|
159
227
|
* Request parameters for getPayment operation in PaymentsApi.
|
|
160
228
|
* @export
|
|
@@ -193,17 +261,29 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
193
261
|
*/
|
|
194
262
|
readonly authorization?: string;
|
|
195
263
|
/**
|
|
196
|
-
*
|
|
264
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
265
|
+
* @type {number}
|
|
266
|
+
* @memberof PaymentsApiListPayments
|
|
267
|
+
*/
|
|
268
|
+
readonly pageSize?: number;
|
|
269
|
+
/**
|
|
270
|
+
* 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.
|
|
271
|
+
* @type {string}
|
|
272
|
+
* @memberof PaymentsApiListPayments
|
|
273
|
+
*/
|
|
274
|
+
readonly pageToken?: string;
|
|
275
|
+
/**
|
|
276
|
+
* 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, productSlug, accountCode, partnerCode</i>
|
|
197
277
|
* @type {string}
|
|
198
278
|
* @memberof PaymentsApiListPayments
|
|
199
279
|
*/
|
|
200
280
|
readonly filter?: string;
|
|
201
281
|
/**
|
|
202
|
-
*
|
|
282
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
203
283
|
* @type {string}
|
|
204
284
|
* @memberof PaymentsApiListPayments
|
|
205
285
|
*/
|
|
206
|
-
readonly
|
|
286
|
+
readonly search?: string;
|
|
207
287
|
/**
|
|
208
288
|
* 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>
|
|
209
289
|
* @type {string}
|
|
@@ -216,6 +296,12 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
216
296
|
* @memberof PaymentsApiListPayments
|
|
217
297
|
*/
|
|
218
298
|
readonly expand?: string;
|
|
299
|
+
/**
|
|
300
|
+
* 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, productSlug, accountCode, partnerCode</i>
|
|
301
|
+
* @type {string}
|
|
302
|
+
* @memberof PaymentsApiListPayments
|
|
303
|
+
*/
|
|
304
|
+
readonly filters?: string;
|
|
219
305
|
}
|
|
220
306
|
/**
|
|
221
307
|
* PaymentsApi - object-oriented interface
|
|
@@ -225,14 +311,24 @@ export interface PaymentsApiListPaymentsRequest {
|
|
|
225
311
|
*/
|
|
226
312
|
export declare class PaymentsApi extends BaseAPI {
|
|
227
313
|
/**
|
|
228
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
314
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
229
315
|
* @summary Create the payment
|
|
230
316
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
231
317
|
* @param {*} [options] Override http request option.
|
|
318
|
+
* @deprecated
|
|
232
319
|
* @throws {RequiredError}
|
|
233
320
|
* @memberof PaymentsApi
|
|
234
321
|
*/
|
|
235
322
|
createPayment(requestParameters: PaymentsApiCreatePaymentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
|
|
323
|
+
/**
|
|
324
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
325
|
+
* @summary Create the payment
|
|
326
|
+
* @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
|
|
327
|
+
* @param {*} [options] Override http request option.
|
|
328
|
+
* @throws {RequiredError}
|
|
329
|
+
* @memberof PaymentsApi
|
|
330
|
+
*/
|
|
331
|
+
createPaymentOrder(requestParameters: PaymentsApiCreatePaymentOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentResponseClass, any>>;
|
|
236
332
|
/**
|
|
237
333
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
238
334
|
* @summary Retrieve the payment
|
package/dist/api/payments-api.js
CHANGED
|
@@ -93,12 +93,13 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
96
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
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
|
|
100
100
|
* @param {string} [authorization] Bearer Token
|
|
101
101
|
* @param {*} [options] Override http request option.
|
|
102
|
+
* @deprecated
|
|
102
103
|
* @throws {RequiredError}
|
|
103
104
|
*/
|
|
104
105
|
createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
|
|
@@ -147,6 +148,61 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
147
148
|
});
|
|
148
149
|
});
|
|
149
150
|
},
|
|
151
|
+
/**
|
|
152
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
153
|
+
* @summary Create the payment
|
|
154
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
155
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
156
|
+
* @param {string} [authorization] Bearer Token
|
|
157
|
+
* @param {*} [options] Override http request option.
|
|
158
|
+
* @throws {RequiredError}
|
|
159
|
+
*/
|
|
160
|
+
createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
|
|
161
|
+
if (options === void 0) { options = {}; }
|
|
162
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
163
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
164
|
+
return __generator(this, function (_a) {
|
|
165
|
+
switch (_a.label) {
|
|
166
|
+
case 0:
|
|
167
|
+
// verify required parameter 'idempotencyKey' is not null or undefined
|
|
168
|
+
(0, common_1.assertParamExists)('createPaymentOrder', 'idempotencyKey', idempotencyKey);
|
|
169
|
+
// verify required parameter 'createPaymentOrderDto' is not null or undefined
|
|
170
|
+
(0, common_1.assertParamExists)('createPaymentOrder', 'createPaymentOrderDto', createPaymentOrderDto);
|
|
171
|
+
localVarPath = "/paymentservice/v1/payments/order";
|
|
172
|
+
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
173
|
+
if (configuration) {
|
|
174
|
+
baseOptions = configuration.baseOptions;
|
|
175
|
+
baseAccessToken = configuration.accessToken;
|
|
176
|
+
}
|
|
177
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
178
|
+
localVarHeaderParameter = {};
|
|
179
|
+
localVarQueryParameter = {};
|
|
180
|
+
// authentication bearer required
|
|
181
|
+
// http bearer authentication required
|
|
182
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
183
|
+
case 1:
|
|
184
|
+
// authentication bearer required
|
|
185
|
+
// http bearer authentication required
|
|
186
|
+
_a.sent();
|
|
187
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
188
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
189
|
+
}
|
|
190
|
+
if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
191
|
+
localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
|
|
192
|
+
}
|
|
193
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
194
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
195
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
196
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
197
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPaymentOrderDto, localVarRequestOptions, configuration);
|
|
198
|
+
return [2 /*return*/, {
|
|
199
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
200
|
+
options: localVarRequestOptions,
|
|
201
|
+
}];
|
|
202
|
+
}
|
|
203
|
+
});
|
|
204
|
+
});
|
|
205
|
+
},
|
|
150
206
|
/**
|
|
151
207
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
152
208
|
* @summary Retrieve the payment
|
|
@@ -203,14 +259,17 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
203
259
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
204
260
|
* @summary List payments
|
|
205
261
|
* @param {string} [authorization] Bearer Token
|
|
206
|
-
* @param {
|
|
207
|
-
* @param {string} [
|
|
262
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
263
|
+
* @param {string} [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.
|
|
264
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
265
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
208
266
|
* @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>
|
|
209
267
|
* @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>
|
|
268
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
210
269
|
* @param {*} [options] Override http request option.
|
|
211
270
|
* @throws {RequiredError}
|
|
212
271
|
*/
|
|
213
|
-
listPayments: function (authorization, filter,
|
|
272
|
+
listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
214
273
|
if (options === void 0) { options = {}; }
|
|
215
274
|
return __awaiter(_this, void 0, void 0, function () {
|
|
216
275
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -233,11 +292,17 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
233
292
|
// authentication bearer required
|
|
234
293
|
// http bearer authentication required
|
|
235
294
|
_a.sent();
|
|
295
|
+
if (pageSize !== undefined) {
|
|
296
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
297
|
+
}
|
|
298
|
+
if (pageToken !== undefined) {
|
|
299
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
300
|
+
}
|
|
236
301
|
if (filter !== undefined) {
|
|
237
302
|
localVarQueryParameter['filter'] = filter;
|
|
238
303
|
}
|
|
239
|
-
if (
|
|
240
|
-
localVarQueryParameter['
|
|
304
|
+
if (search !== undefined) {
|
|
305
|
+
localVarQueryParameter['search'] = search;
|
|
241
306
|
}
|
|
242
307
|
if (order !== undefined) {
|
|
243
308
|
localVarQueryParameter['order'] = order;
|
|
@@ -245,6 +310,9 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
245
310
|
if (expand !== undefined) {
|
|
246
311
|
localVarQueryParameter['expand'] = expand;
|
|
247
312
|
}
|
|
313
|
+
if (filters !== undefined) {
|
|
314
|
+
localVarQueryParameter['filters'] = filters;
|
|
315
|
+
}
|
|
248
316
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
249
317
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
250
318
|
}
|
|
@@ -270,12 +338,13 @@ var PaymentsApiFp = function (configuration) {
|
|
|
270
338
|
var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
|
|
271
339
|
return {
|
|
272
340
|
/**
|
|
273
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
341
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
274
342
|
* @summary Create the payment
|
|
275
343
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
276
344
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
277
345
|
* @param {string} [authorization] Bearer Token
|
|
278
346
|
* @param {*} [options] Override http request option.
|
|
347
|
+
* @deprecated
|
|
279
348
|
* @throws {RequiredError}
|
|
280
349
|
*/
|
|
281
350
|
createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
|
|
@@ -291,6 +360,28 @@ var PaymentsApiFp = function (configuration) {
|
|
|
291
360
|
});
|
|
292
361
|
});
|
|
293
362
|
},
|
|
363
|
+
/**
|
|
364
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
365
|
+
* @summary Create the payment
|
|
366
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
367
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
368
|
+
* @param {string} [authorization] Bearer Token
|
|
369
|
+
* @param {*} [options] Override http request option.
|
|
370
|
+
* @throws {RequiredError}
|
|
371
|
+
*/
|
|
372
|
+
createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
|
|
373
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
374
|
+
var localVarAxiosArgs;
|
|
375
|
+
return __generator(this, function (_a) {
|
|
376
|
+
switch (_a.label) {
|
|
377
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options)];
|
|
378
|
+
case 1:
|
|
379
|
+
localVarAxiosArgs = _a.sent();
|
|
380
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
381
|
+
}
|
|
382
|
+
});
|
|
383
|
+
});
|
|
384
|
+
},
|
|
294
385
|
/**
|
|
295
386
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
296
387
|
* @summary Retrieve the payment
|
|
@@ -317,19 +408,22 @@ var PaymentsApiFp = function (configuration) {
|
|
|
317
408
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
318
409
|
* @summary List payments
|
|
319
410
|
* @param {string} [authorization] Bearer Token
|
|
320
|
-
* @param {
|
|
321
|
-
* @param {string} [
|
|
411
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
412
|
+
* @param {string} [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.
|
|
413
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
414
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
322
415
|
* @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>
|
|
323
416
|
* @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>
|
|
417
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
324
418
|
* @param {*} [options] Override http request option.
|
|
325
419
|
* @throws {RequiredError}
|
|
326
420
|
*/
|
|
327
|
-
listPayments: function (authorization, filter,
|
|
421
|
+
listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
328
422
|
return __awaiter(this, void 0, void 0, function () {
|
|
329
423
|
var localVarAxiosArgs;
|
|
330
424
|
return __generator(this, function (_a) {
|
|
331
425
|
switch (_a.label) {
|
|
332
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, filter,
|
|
426
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
333
427
|
case 1:
|
|
334
428
|
localVarAxiosArgs = _a.sent();
|
|
335
429
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -348,17 +442,30 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
348
442
|
var localVarFp = (0, exports.PaymentsApiFp)(configuration);
|
|
349
443
|
return {
|
|
350
444
|
/**
|
|
351
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
445
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
352
446
|
* @summary Create the payment
|
|
353
447
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
354
448
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
355
449
|
* @param {string} [authorization] Bearer Token
|
|
356
450
|
* @param {*} [options] Override http request option.
|
|
451
|
+
* @deprecated
|
|
357
452
|
* @throws {RequiredError}
|
|
358
453
|
*/
|
|
359
454
|
createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
|
|
360
455
|
return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
361
456
|
},
|
|
457
|
+
/**
|
|
458
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
459
|
+
* @summary Create the payment
|
|
460
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
461
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
462
|
+
* @param {string} [authorization] Bearer Token
|
|
463
|
+
* @param {*} [options] Override http request option.
|
|
464
|
+
* @throws {RequiredError}
|
|
465
|
+
*/
|
|
466
|
+
createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
|
|
467
|
+
return localVarFp.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
468
|
+
},
|
|
362
469
|
/**
|
|
363
470
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
364
471
|
* @summary Retrieve the payment
|
|
@@ -375,15 +482,18 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
375
482
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
376
483
|
* @summary List payments
|
|
377
484
|
* @param {string} [authorization] Bearer Token
|
|
378
|
-
* @param {
|
|
379
|
-
* @param {string} [
|
|
485
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
486
|
+
* @param {string} [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.
|
|
487
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
488
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
380
489
|
* @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>
|
|
381
490
|
* @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>
|
|
491
|
+
* @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, productSlug, accountCode, partnerCode</i>
|
|
382
492
|
* @param {*} [options] Override http request option.
|
|
383
493
|
* @throws {RequiredError}
|
|
384
494
|
*/
|
|
385
|
-
listPayments: function (authorization, filter,
|
|
386
|
-
return localVarFp.listPayments(authorization, filter,
|
|
495
|
+
listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
496
|
+
return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
387
497
|
},
|
|
388
498
|
};
|
|
389
499
|
};
|
|
@@ -400,10 +510,11 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
400
510
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
401
511
|
}
|
|
402
512
|
/**
|
|
403
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
513
|
+
* This will create a payment for a specified account. This function is idempotent. This endpoint is deprecated. Please use the create Payment Order endpoint instead. **Required Permissions** \"payment-management.payments.create\"
|
|
404
514
|
* @summary Create the payment
|
|
405
515
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
406
516
|
* @param {*} [options] Override http request option.
|
|
517
|
+
* @deprecated
|
|
407
518
|
* @throws {RequiredError}
|
|
408
519
|
* @memberof PaymentsApi
|
|
409
520
|
*/
|
|
@@ -411,6 +522,18 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
411
522
|
var _this = this;
|
|
412
523
|
return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
413
524
|
};
|
|
525
|
+
/**
|
|
526
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
527
|
+
* @summary Create the payment
|
|
528
|
+
* @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
|
|
529
|
+
* @param {*} [options] Override http request option.
|
|
530
|
+
* @throws {RequiredError}
|
|
531
|
+
* @memberof PaymentsApi
|
|
532
|
+
*/
|
|
533
|
+
PaymentsApi.prototype.createPaymentOrder = function (requestParameters, options) {
|
|
534
|
+
var _this = this;
|
|
535
|
+
return (0, exports.PaymentsApiFp)(this.configuration).createPaymentOrder(requestParameters.idempotencyKey, requestParameters.createPaymentOrderDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
536
|
+
};
|
|
414
537
|
/**
|
|
415
538
|
* 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. **Required Permissions** \"payment-management.payments.view\"
|
|
416
539
|
* @summary Retrieve the payment
|
|
@@ -434,7 +557,7 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
434
557
|
PaymentsApi.prototype.listPayments = function (requestParameters, options) {
|
|
435
558
|
var _this = this;
|
|
436
559
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
437
|
-
return (0, exports.PaymentsApiFp)(this.configuration).listPayments(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
560
|
+
return (0, exports.PaymentsApiFp)(this.configuration).listPayments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
438
561
|
};
|
|
439
562
|
return PaymentsApi;
|
|
440
563
|
}(base_1.BaseAPI));
|