@emilgroup/payment-sdk-node 1.21.1-beta.9 → 1.21.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 +695 -0
- package/api/bank-transaction-api.ts +63 -52
- package/api/exceeding-credits-api.ts +353 -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 +169 -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 +45 -3
- 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 +646 -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 +356 -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 +228 -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 +11 -2
- package/dist/base.js +42 -3
- 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
|
@@ -97,12 +97,13 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
100
|
+
* 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\"
|
|
101
101
|
* @summary Create the payment
|
|
102
102
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
103
103
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
104
104
|
* @param {string} [authorization] Bearer Token
|
|
105
105
|
* @param {*} [options] Override http request option.
|
|
106
|
+
* @deprecated
|
|
106
107
|
* @throws {RequiredError}
|
|
107
108
|
*/
|
|
108
109
|
createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
|
|
@@ -151,6 +152,61 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
151
152
|
});
|
|
152
153
|
});
|
|
153
154
|
},
|
|
155
|
+
/**
|
|
156
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
157
|
+
* @summary Create the payment
|
|
158
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
159
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
160
|
+
* @param {string} [authorization] Bearer Token
|
|
161
|
+
* @param {*} [options] Override http request option.
|
|
162
|
+
* @throws {RequiredError}
|
|
163
|
+
*/
|
|
164
|
+
createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
|
|
165
|
+
if (options === void 0) { options = {}; }
|
|
166
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
167
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
168
|
+
return __generator(this, function (_a) {
|
|
169
|
+
switch (_a.label) {
|
|
170
|
+
case 0:
|
|
171
|
+
// verify required parameter 'idempotencyKey' is not null or undefined
|
|
172
|
+
(0, common_1.assertParamExists)('createPaymentOrder', 'idempotencyKey', idempotencyKey);
|
|
173
|
+
// verify required parameter 'createPaymentOrderDto' is not null or undefined
|
|
174
|
+
(0, common_1.assertParamExists)('createPaymentOrder', 'createPaymentOrderDto', createPaymentOrderDto);
|
|
175
|
+
localVarPath = "/paymentservice/v1/payments/order";
|
|
176
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
177
|
+
if (configuration) {
|
|
178
|
+
baseOptions = configuration.baseOptions;
|
|
179
|
+
baseAccessToken = configuration.accessToken;
|
|
180
|
+
}
|
|
181
|
+
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
|
|
182
|
+
localVarHeaderParameter = {};
|
|
183
|
+
localVarQueryParameter = {};
|
|
184
|
+
// authentication bearer required
|
|
185
|
+
// http bearer authentication required
|
|
186
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
187
|
+
case 1:
|
|
188
|
+
// authentication bearer required
|
|
189
|
+
// http bearer authentication required
|
|
190
|
+
_a.sent();
|
|
191
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
192
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
193
|
+
}
|
|
194
|
+
if (idempotencyKey !== undefined && idempotencyKey !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
195
|
+
localVarHeaderParameter['Idempotency-Key'] = String(idempotencyKey ? idempotencyKey : baseAccessToken);
|
|
196
|
+
}
|
|
197
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
198
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
199
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
200
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
201
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPaymentOrderDto, localVarRequestOptions, configuration);
|
|
202
|
+
return [2 /*return*/, {
|
|
203
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
204
|
+
options: localVarRequestOptions,
|
|
205
|
+
}];
|
|
206
|
+
}
|
|
207
|
+
});
|
|
208
|
+
});
|
|
209
|
+
},
|
|
154
210
|
/**
|
|
155
211
|
* 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\"
|
|
156
212
|
* @summary Retrieve the payment
|
|
@@ -207,14 +263,17 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
207
263
|
* 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\"
|
|
208
264
|
* @summary List payments
|
|
209
265
|
* @param {string} [authorization] Bearer Token
|
|
210
|
-
* @param {
|
|
211
|
-
* @param {string} [
|
|
266
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
267
|
+
* @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.
|
|
268
|
+
* @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>
|
|
269
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
212
270
|
* @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>
|
|
213
271
|
* @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>
|
|
272
|
+
* @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>
|
|
214
273
|
* @param {*} [options] Override http request option.
|
|
215
274
|
* @throws {RequiredError}
|
|
216
275
|
*/
|
|
217
|
-
listPayments: function (authorization, filter,
|
|
276
|
+
listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
218
277
|
if (options === void 0) { options = {}; }
|
|
219
278
|
return __awaiter(_this, void 0, void 0, function () {
|
|
220
279
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -237,11 +296,17 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
237
296
|
// authentication bearer required
|
|
238
297
|
// http bearer authentication required
|
|
239
298
|
_a.sent();
|
|
299
|
+
if (pageSize !== undefined) {
|
|
300
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
301
|
+
}
|
|
302
|
+
if (pageToken !== undefined) {
|
|
303
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
304
|
+
}
|
|
240
305
|
if (filter !== undefined) {
|
|
241
306
|
localVarQueryParameter['filter'] = filter;
|
|
242
307
|
}
|
|
243
|
-
if (
|
|
244
|
-
localVarQueryParameter['
|
|
308
|
+
if (search !== undefined) {
|
|
309
|
+
localVarQueryParameter['search'] = search;
|
|
245
310
|
}
|
|
246
311
|
if (order !== undefined) {
|
|
247
312
|
localVarQueryParameter['order'] = order;
|
|
@@ -249,6 +314,9 @@ var PaymentsApiAxiosParamCreator = function (configuration) {
|
|
|
249
314
|
if (expand !== undefined) {
|
|
250
315
|
localVarQueryParameter['expand'] = expand;
|
|
251
316
|
}
|
|
317
|
+
if (filters !== undefined) {
|
|
318
|
+
localVarQueryParameter['filters'] = filters;
|
|
319
|
+
}
|
|
252
320
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
253
321
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
254
322
|
}
|
|
@@ -274,12 +342,13 @@ var PaymentsApiFp = function (configuration) {
|
|
|
274
342
|
var localVarAxiosParamCreator = (0, exports.PaymentsApiAxiosParamCreator)(configuration);
|
|
275
343
|
return {
|
|
276
344
|
/**
|
|
277
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
345
|
+
* 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\"
|
|
278
346
|
* @summary Create the payment
|
|
279
347
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
280
348
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
281
349
|
* @param {string} [authorization] Bearer Token
|
|
282
350
|
* @param {*} [options] Override http request option.
|
|
351
|
+
* @deprecated
|
|
283
352
|
* @throws {RequiredError}
|
|
284
353
|
*/
|
|
285
354
|
createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
|
|
@@ -295,6 +364,28 @@ var PaymentsApiFp = function (configuration) {
|
|
|
295
364
|
});
|
|
296
365
|
});
|
|
297
366
|
},
|
|
367
|
+
/**
|
|
368
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
369
|
+
* @summary Create the payment
|
|
370
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
371
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
372
|
+
* @param {string} [authorization] Bearer Token
|
|
373
|
+
* @param {*} [options] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
|
|
377
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
378
|
+
var localVarAxiosArgs;
|
|
379
|
+
return __generator(this, function (_a) {
|
|
380
|
+
switch (_a.label) {
|
|
381
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options)];
|
|
382
|
+
case 1:
|
|
383
|
+
localVarAxiosArgs = _a.sent();
|
|
384
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
385
|
+
}
|
|
386
|
+
});
|
|
387
|
+
});
|
|
388
|
+
},
|
|
298
389
|
/**
|
|
299
390
|
* 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\"
|
|
300
391
|
* @summary Retrieve the payment
|
|
@@ -321,19 +412,22 @@ var PaymentsApiFp = function (configuration) {
|
|
|
321
412
|
* 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\"
|
|
322
413
|
* @summary List payments
|
|
323
414
|
* @param {string} [authorization] Bearer Token
|
|
324
|
-
* @param {
|
|
325
|
-
* @param {string} [
|
|
415
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
416
|
+
* @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.
|
|
417
|
+
* @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>
|
|
418
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
326
419
|
* @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>
|
|
327
420
|
* @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>
|
|
421
|
+
* @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>
|
|
328
422
|
* @param {*} [options] Override http request option.
|
|
329
423
|
* @throws {RequiredError}
|
|
330
424
|
*/
|
|
331
|
-
listPayments: function (authorization, filter,
|
|
425
|
+
listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
332
426
|
return __awaiter(this, void 0, void 0, function () {
|
|
333
427
|
var localVarAxiosArgs;
|
|
334
428
|
return __generator(this, function (_a) {
|
|
335
429
|
switch (_a.label) {
|
|
336
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, filter,
|
|
430
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
337
431
|
case 1:
|
|
338
432
|
localVarAxiosArgs = _a.sent();
|
|
339
433
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -352,17 +446,30 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
352
446
|
var localVarFp = (0, exports.PaymentsApiFp)(configuration);
|
|
353
447
|
return {
|
|
354
448
|
/**
|
|
355
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
449
|
+
* 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\"
|
|
356
450
|
* @summary Create the payment
|
|
357
451
|
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
358
452
|
* @param {CreatePaymentRequestDto} createPaymentRequestDto
|
|
359
453
|
* @param {string} [authorization] Bearer Token
|
|
360
454
|
* @param {*} [options] Override http request option.
|
|
455
|
+
* @deprecated
|
|
361
456
|
* @throws {RequiredError}
|
|
362
457
|
*/
|
|
363
458
|
createPayment: function (idempotencyKey, createPaymentRequestDto, authorization, options) {
|
|
364
459
|
return localVarFp.createPayment(idempotencyKey, createPaymentRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
365
460
|
},
|
|
461
|
+
/**
|
|
462
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
463
|
+
* @summary Create the payment
|
|
464
|
+
* @param {string} idempotencyKey Idempotency Key used to make the request idempotent. The key should be unique. Usually, a generated v4 UUID is enough.
|
|
465
|
+
* @param {CreatePaymentOrderDto} createPaymentOrderDto
|
|
466
|
+
* @param {string} [authorization] Bearer Token
|
|
467
|
+
* @param {*} [options] Override http request option.
|
|
468
|
+
* @throws {RequiredError}
|
|
469
|
+
*/
|
|
470
|
+
createPaymentOrder: function (idempotencyKey, createPaymentOrderDto, authorization, options) {
|
|
471
|
+
return localVarFp.createPaymentOrder(idempotencyKey, createPaymentOrderDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
472
|
+
},
|
|
366
473
|
/**
|
|
367
474
|
* 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\"
|
|
368
475
|
* @summary Retrieve the payment
|
|
@@ -379,15 +486,18 @@ var PaymentsApiFactory = function (configuration, basePath, axios) {
|
|
|
379
486
|
* 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\"
|
|
380
487
|
* @summary List payments
|
|
381
488
|
* @param {string} [authorization] Bearer Token
|
|
382
|
-
* @param {
|
|
383
|
-
* @param {string} [
|
|
489
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
490
|
+
* @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.
|
|
491
|
+
* @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>
|
|
492
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
384
493
|
* @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>
|
|
385
494
|
* @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>
|
|
495
|
+
* @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>
|
|
386
496
|
* @param {*} [options] Override http request option.
|
|
387
497
|
* @throws {RequiredError}
|
|
388
498
|
*/
|
|
389
|
-
listPayments: function (authorization, filter,
|
|
390
|
-
return localVarFp.listPayments(authorization, filter,
|
|
499
|
+
listPayments: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
500
|
+
return localVarFp.listPayments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
391
501
|
},
|
|
392
502
|
};
|
|
393
503
|
};
|
|
@@ -404,10 +514,11 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
404
514
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
405
515
|
}
|
|
406
516
|
/**
|
|
407
|
-
* This will create a payment for a specified account. This function is idempotent. **Required Permissions** \"payment-management.payments.create\"
|
|
517
|
+
* 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\"
|
|
408
518
|
* @summary Create the payment
|
|
409
519
|
* @param {PaymentsApiCreatePaymentRequest} requestParameters Request parameters.
|
|
410
520
|
* @param {*} [options] Override http request option.
|
|
521
|
+
* @deprecated
|
|
411
522
|
* @throws {RequiredError}
|
|
412
523
|
* @memberof PaymentsApi
|
|
413
524
|
*/
|
|
@@ -415,6 +526,18 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
415
526
|
var _this = this;
|
|
416
527
|
return (0, exports.PaymentsApiFp)(this.configuration).createPayment(requestParameters.idempotencyKey, requestParameters.createPaymentRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
417
528
|
};
|
|
529
|
+
/**
|
|
530
|
+
* This will create a payment order for a specified invoice. **Required Permissions** \"payment-management.payments.create\"
|
|
531
|
+
* @summary Create the payment
|
|
532
|
+
* @param {PaymentsApiCreatePaymentOrderRequest} requestParameters Request parameters.
|
|
533
|
+
* @param {*} [options] Override http request option.
|
|
534
|
+
* @throws {RequiredError}
|
|
535
|
+
* @memberof PaymentsApi
|
|
536
|
+
*/
|
|
537
|
+
PaymentsApi.prototype.createPaymentOrder = function (requestParameters, options) {
|
|
538
|
+
var _this = this;
|
|
539
|
+
return (0, exports.PaymentsApiFp)(this.configuration).createPaymentOrder(requestParameters.idempotencyKey, requestParameters.createPaymentOrderDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
540
|
+
};
|
|
418
541
|
/**
|
|
419
542
|
* 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\"
|
|
420
543
|
* @summary Retrieve the payment
|
|
@@ -438,7 +561,7 @@ var PaymentsApi = /** @class */ (function (_super) {
|
|
|
438
561
|
PaymentsApi.prototype.listPayments = function (requestParameters, options) {
|
|
439
562
|
var _this = this;
|
|
440
563
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
441
|
-
return (0, exports.PaymentsApiFp)(this.configuration).listPayments(requestParameters.authorization, requestParameters.filter, requestParameters.
|
|
564
|
+
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); });
|
|
442
565
|
};
|
|
443
566
|
return PaymentsApi;
|
|
444
567
|
}(base_1.BaseAPI));
|