@emilgroup/payment-sdk-node 1.23.0 → 1.23.1-beta.100

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.
Files changed (180) hide show
  1. package/.openapi-generator/FILES +34 -0
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +16 -16
  4. package/api/bank-orders-api.ts +16 -16
  5. package/api/bank-transaction-api.ts +12 -12
  6. package/api/billing-addresses-api.ts +681 -0
  7. package/api/credit-allocation-api.ts +12 -12
  8. package/api/exceeding-credits-api.ts +12 -12
  9. package/api/ibanvalidator-api.ts +169 -0
  10. package/api/payment-methods-api.ts +12 -12
  11. package/api/payment-receipts-api.ts +680 -0
  12. package/api/payment-reminders-api.ts +16 -16
  13. package/api/payment-requests-api.ts +697 -0
  14. package/api/payments-api.ts +12 -12
  15. package/api/payout-methods-api.ts +794 -0
  16. package/api/refunds-api.ts +12 -12
  17. package/api/tenant-bank-account-api.ts +16 -16
  18. package/api/webhooks-api.ts +125 -14
  19. package/api.ts +10 -0
  20. package/base.ts +1 -0
  21. package/dist/api/bank-accounts-api.d.ts +16 -16
  22. package/dist/api/bank-accounts-api.js +13 -13
  23. package/dist/api/bank-orders-api.d.ts +16 -16
  24. package/dist/api/bank-orders-api.js +14 -14
  25. package/dist/api/bank-transaction-api.d.ts +12 -12
  26. package/dist/api/bank-transaction-api.js +10 -10
  27. package/dist/api/billing-addresses-api.d.ts +384 -0
  28. package/dist/api/billing-addresses-api.js +640 -0
  29. package/dist/api/credit-allocation-api.d.ts +12 -12
  30. package/dist/api/credit-allocation-api.js +10 -10
  31. package/dist/api/exceeding-credits-api.d.ts +12 -12
  32. package/dist/api/exceeding-credits-api.js +10 -10
  33. package/dist/api/ibanvalidator-api.d.ts +97 -0
  34. package/dist/api/ibanvalidator-api.js +228 -0
  35. package/dist/api/payment-methods-api.d.ts +12 -12
  36. package/dist/api/payment-methods-api.js +10 -10
  37. package/dist/api/payment-receipts-api.d.ts +383 -0
  38. package/dist/api/payment-receipts-api.js +641 -0
  39. package/dist/api/payment-reminders-api.d.ts +16 -16
  40. package/dist/api/payment-reminders-api.js +13 -13
  41. package/dist/api/payment-requests-api.d.ts +393 -0
  42. package/dist/api/payment-requests-api.js +648 -0
  43. package/dist/api/payments-api.d.ts +12 -12
  44. package/dist/api/payments-api.js +10 -10
  45. package/dist/api/payout-methods-api.d.ts +447 -0
  46. package/dist/api/payout-methods-api.js +738 -0
  47. package/dist/api/refunds-api.d.ts +12 -12
  48. package/dist/api/refunds-api.js +10 -10
  49. package/dist/api/tenant-bank-account-api.d.ts +16 -16
  50. package/dist/api/tenant-bank-account-api.js +13 -13
  51. package/dist/api/webhooks-api.d.ts +73 -9
  52. package/dist/api/webhooks-api.js +100 -11
  53. package/dist/api.d.ts +5 -0
  54. package/dist/api.js +5 -0
  55. package/dist/base.d.ts +2 -1
  56. package/dist/base.js +1 -0
  57. package/dist/models/bank-account-class-without-expand-properties.d.ts +6 -0
  58. package/dist/models/bank-account-class.d.ts +6 -0
  59. package/dist/models/bank-data-class.d.ts +36 -0
  60. package/dist/models/bank-data-class.js +15 -0
  61. package/dist/models/bank-order-class.d.ts +3 -3
  62. package/dist/models/bank-order-entity.d.ts +3 -2
  63. package/dist/models/bank-order-entity.js +2 -1
  64. package/dist/models/billing-address-class.d.ts +108 -0
  65. package/dist/models/billing-address-class.js +15 -0
  66. package/dist/models/create-bank-order-request-dto.d.ts +4 -3
  67. package/dist/models/create-bank-order-request-dto.js +2 -1
  68. package/dist/models/create-billing-address-request-dto.d.ts +66 -0
  69. package/dist/models/create-billing-address-request-dto.js +15 -0
  70. package/dist/models/create-billing-address-response-class.d.ts +25 -0
  71. package/dist/models/create-billing-address-response-class.js +15 -0
  72. package/dist/models/create-payment-receipt-request-dto.d.ts +65 -0
  73. package/dist/models/create-payment-receipt-request-dto.js +20 -0
  74. package/dist/models/create-payment-receipt-response-class.d.ts +25 -0
  75. package/dist/models/create-payment-receipt-response-class.js +15 -0
  76. package/dist/models/create-payment-request-request-dto.d.ts +109 -0
  77. package/dist/models/create-payment-request-request-dto.js +30 -0
  78. package/dist/models/create-payment-request-response-class.d.ts +25 -0
  79. package/dist/models/create-payment-request-response-class.js +15 -0
  80. package/dist/models/create-payout-method-by-bank-account-request-dto.d.ts +36 -0
  81. package/dist/models/create-payout-method-by-bank-account-request-dto.js +15 -0
  82. package/dist/models/create-payout-method-request-dto.d.ts +66 -0
  83. package/dist/models/create-payout-method-request-dto.js +15 -0
  84. package/dist/models/create-payout-method-response-class.d.ts +25 -0
  85. package/dist/models/create-payout-method-response-class.js +15 -0
  86. package/dist/models/create-tenant-bank-account-request-dto.d.ts +17 -0
  87. package/dist/models/create-tenant-bank-account-request-dto.js +11 -1
  88. package/dist/models/get-billing-address-response-class.d.ts +25 -0
  89. package/dist/models/get-billing-address-response-class.js +15 -0
  90. package/dist/models/get-payment-receipt-response-class.d.ts +25 -0
  91. package/dist/models/get-payment-receipt-response-class.js +15 -0
  92. package/dist/models/get-payment-request-response-class.d.ts +25 -0
  93. package/dist/models/get-payment-request-response-class.js +15 -0
  94. package/dist/models/get-payout-method-response-class.d.ts +25 -0
  95. package/dist/models/get-payout-method-response-class.js +15 -0
  96. package/dist/models/index.d.ts +29 -0
  97. package/dist/models/index.js +29 -0
  98. package/dist/models/list-billing-addresses-response-class.d.ts +43 -0
  99. package/dist/models/list-billing-addresses-response-class.js +15 -0
  100. package/dist/models/list-exceeding-credits-response-class.d.ts +18 -6
  101. package/dist/models/list-payment-receipts-response-class.d.ts +43 -0
  102. package/dist/models/list-payment-receipts-response-class.js +15 -0
  103. package/dist/models/list-payment-requests-response-class.d.ts +43 -0
  104. package/dist/models/list-payment-requests-response-class.js +15 -0
  105. package/dist/models/list-payout-methods-response-class.d.ts +43 -0
  106. package/dist/models/list-payout-methods-response-class.js +15 -0
  107. package/dist/models/list-refunds-response-class.d.ts +18 -6
  108. package/dist/models/payment-receipt-class.d.ts +101 -0
  109. package/dist/models/payment-receipt-class.js +20 -0
  110. package/dist/models/payment-request-class.d.ts +155 -0
  111. package/dist/models/payment-request-class.js +38 -0
  112. package/dist/models/payout-method-class.d.ts +121 -0
  113. package/dist/models/payout-method-class.js +15 -0
  114. package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +17 -0
  115. package/dist/models/tenant-bank-account-class-without-expand-properties.js +11 -1
  116. package/dist/models/tenant-bank-account-class.d.ts +17 -0
  117. package/dist/models/tenant-bank-account-class.js +11 -1
  118. package/dist/models/tenant-bank-account-entity.d.ts +17 -0
  119. package/dist/models/tenant-bank-account-entity.js +11 -1
  120. package/dist/models/update-bank-order-request-dto.d.ts +3 -3
  121. package/dist/models/update-billing-address-request-dto.d.ts +66 -0
  122. package/dist/models/update-billing-address-request-dto.js +15 -0
  123. package/dist/models/update-billing-address-response-class.d.ts +25 -0
  124. package/dist/models/update-billing-address-response-class.js +15 -0
  125. package/dist/models/update-payment-receipt-response-class.d.ts +25 -0
  126. package/dist/models/update-payment-receipt-response-class.js +15 -0
  127. package/dist/models/update-payment-request-request-dto.d.ts +39 -0
  128. package/dist/models/update-payment-request-request-dto.js +24 -0
  129. package/dist/models/update-payment-request-response-class.d.ts +25 -0
  130. package/dist/models/update-payment-request-response-class.js +15 -0
  131. package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +17 -0
  132. package/dist/models/update-tenant-bank-account-rest-request-dto.js +11 -1
  133. package/dist/models/validate-iban-request-dto.d.ts +24 -0
  134. package/dist/models/validate-iban-request-dto.js +15 -0
  135. package/dist/models/validate-iban-response-class.d.ts +31 -0
  136. package/dist/models/validate-iban-response-class.js +15 -0
  137. package/models/bank-account-class-without-expand-properties.ts +6 -0
  138. package/models/bank-account-class.ts +6 -0
  139. package/models/bank-data-class.ts +42 -0
  140. package/models/bank-order-class.ts +3 -3
  141. package/models/bank-order-entity.ts +4 -3
  142. package/models/billing-address-class.ts +114 -0
  143. package/models/create-bank-order-request-dto.ts +5 -4
  144. package/models/create-billing-address-request-dto.ts +72 -0
  145. package/models/create-billing-address-response-class.ts +31 -0
  146. package/models/create-payment-receipt-request-dto.ts +74 -0
  147. package/models/create-payment-receipt-response-class.ts +31 -0
  148. package/models/create-payment-request-request-dto.ts +118 -0
  149. package/models/create-payment-request-response-class.ts +31 -0
  150. package/models/create-payout-method-by-bank-account-request-dto.ts +42 -0
  151. package/models/create-payout-method-request-dto.ts +72 -0
  152. package/models/create-payout-method-response-class.ts +31 -0
  153. package/models/create-tenant-bank-account-request-dto.ts +18 -0
  154. package/models/get-billing-address-response-class.ts +31 -0
  155. package/models/get-payment-receipt-response-class.ts +31 -0
  156. package/models/get-payment-request-response-class.ts +31 -0
  157. package/models/get-payout-method-response-class.ts +31 -0
  158. package/models/index.ts +29 -0
  159. package/models/list-billing-addresses-response-class.ts +49 -0
  160. package/models/list-exceeding-credits-response-class.ts +18 -6
  161. package/models/list-payment-receipts-response-class.ts +49 -0
  162. package/models/list-payment-requests-response-class.ts +49 -0
  163. package/models/list-payout-methods-response-class.ts +49 -0
  164. package/models/list-refunds-response-class.ts +18 -6
  165. package/models/payment-receipt-class.ts +110 -0
  166. package/models/payment-request-class.ts +165 -0
  167. package/models/payout-method-class.ts +127 -0
  168. package/models/tenant-bank-account-class-without-expand-properties.ts +18 -0
  169. package/models/tenant-bank-account-class.ts +18 -0
  170. package/models/tenant-bank-account-entity.ts +18 -0
  171. package/models/update-bank-order-request-dto.ts +3 -3
  172. package/models/update-billing-address-request-dto.ts +72 -0
  173. package/models/update-billing-address-response-class.ts +31 -0
  174. package/models/update-payment-receipt-response-class.ts +31 -0
  175. package/models/update-payment-request-request-dto.ts +48 -0
  176. package/models/update-payment-request-response-class.ts +31 -0
  177. package/models/update-tenant-bank-account-rest-request-dto.ts +18 -0
  178. package/models/validate-iban-request-dto.ts +30 -0
  179. package/models/validate-iban-response-class.ts +37 -0
  180. package/package.json +3 -3
@@ -0,0 +1,447 @@
1
+ /**
2
+ * Emil Payment Service
3
+ * This service directly communicates with the various Payment Service Providers (PSPs) in order to charge or refund customers. This service will automatically connect to the PSP linked in your admin configuration; meaning if you configured Stripe, it will automatically create a payment on Stripe when you create it in Emil.
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreatePayoutMethodByBankAccountRequestDto } from '../models';
16
+ import { CreatePayoutMethodRequestDto } from '../models';
17
+ import { CreatePayoutMethodResponseClass } from '../models';
18
+ import { GetPayoutMethodResponseClass } from '../models';
19
+ import { ListPayoutMethodsResponseClass } from '../models';
20
+ /**
21
+ * PayoutMethodsApi - axios parameter creator
22
+ * @export
23
+ */
24
+ export declare const PayoutMethodsApiAxiosParamCreator: (configuration?: Configuration) => {
25
+ /**
26
+ * Activates a payout method and deactivates the currently active payout method for the same partner **Required Permissions** \"payment-management.payments.update\"
27
+ * @summary Create the Payout Method Activation
28
+ * @param {string} code Unique identifier for the object.
29
+ * @param {string} [authorization] Bearer Token
30
+ * @param {*} [options] Override http request option.
31
+ * @throws {RequiredError}
32
+ */
33
+ activatePayoutMethod: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
+ /**
35
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
36
+ * @summary Create the Payout Method
37
+ * @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
38
+ * @param {string} [authorization] Bearer Token
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ createPayoutMethod: (createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
+ /**
44
+ * Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
45
+ * @summary Create the Payout Method
46
+ * @param {string} code
47
+ * @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
48
+ * @param {string} [authorization] Bearer Token
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ createPayoutMethodByBankAccount: (code: string, createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
+ /**
54
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
55
+ * @summary Delete the Payout Method
56
+ * @param {string} code Unique identifier for the object.
57
+ * @param {string} [authorization] Bearer Token
58
+ * @param {*} [options] Override http request option.
59
+ * @throws {RequiredError}
60
+ */
61
+ deletePayoutMethod: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
+ /**
63
+ * Retrieves the details of the Payout Method that was previously created. Supply the unique Payout Method code that was returned when you created it and Emil Api will return the corresponding Payout Method information. **Required Permissions** \"payment-management.payments.view\"
64
+ * @summary Retrieve the Payout Method
65
+ * @param {string} code
66
+ * @param {string} [authorization] Bearer Token
67
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: billingAddress&lt;i&gt;
68
+ * @param {*} [options] Override http request option.
69
+ * @throws {RequiredError}
70
+ */
71
+ getPayoutMethod: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
72
+ /**
73
+ * Returns a list of Payout Methods you have previously created. The Payout Methods 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\"
74
+ * @summary List Payout Methods
75
+ * @param {string} [authorization] Bearer Token
76
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
77
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
78
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
79
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode&lt;/i&gt;
80
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, isActive, createdAt, updatedAt, accountHolder&lt;/i&gt;
81
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: billingAddress&lt;i&gt;
82
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
83
+ * @param {*} [options] Override http request option.
84
+ * @throws {RequiredError}
85
+ */
86
+ listPayoutMethods: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
87
+ };
88
+ /**
89
+ * PayoutMethodsApi - functional programming interface
90
+ * @export
91
+ */
92
+ export declare const PayoutMethodsApiFp: (configuration?: Configuration) => {
93
+ /**
94
+ * Activates a payout method and deactivates the currently active payout method for the same partner **Required Permissions** \"payment-management.payments.update\"
95
+ * @summary Create the Payout Method Activation
96
+ * @param {string} code Unique identifier for the object.
97
+ * @param {string} [authorization] Bearer Token
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ activatePayoutMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
102
+ /**
103
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
104
+ * @summary Create the Payout Method
105
+ * @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
106
+ * @param {string} [authorization] Bearer Token
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ */
110
+ createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePayoutMethodResponseClass>>;
111
+ /**
112
+ * Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
113
+ * @summary Create the Payout Method
114
+ * @param {string} code
115
+ * @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
116
+ * @param {string} [authorization] Bearer Token
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ createPayoutMethodByBankAccount(code: string, createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePayoutMethodResponseClass>>;
121
+ /**
122
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
123
+ * @summary Delete the Payout Method
124
+ * @param {string} code Unique identifier for the object.
125
+ * @param {string} [authorization] Bearer Token
126
+ * @param {*} [options] Override http request option.
127
+ * @throws {RequiredError}
128
+ */
129
+ deletePayoutMethod(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
130
+ /**
131
+ * Retrieves the details of the Payout Method that was previously created. Supply the unique Payout Method code that was returned when you created it and Emil Api will return the corresponding Payout Method information. **Required Permissions** \"payment-management.payments.view\"
132
+ * @summary Retrieve the Payout Method
133
+ * @param {string} code
134
+ * @param {string} [authorization] Bearer Token
135
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: billingAddress&lt;i&gt;
136
+ * @param {*} [options] Override http request option.
137
+ * @throws {RequiredError}
138
+ */
139
+ getPayoutMethod(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayoutMethodResponseClass>>;
140
+ /**
141
+ * Returns a list of Payout Methods you have previously created. The Payout Methods 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\"
142
+ * @summary List Payout Methods
143
+ * @param {string} [authorization] Bearer Token
144
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
145
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
146
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
147
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode&lt;/i&gt;
148
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, isActive, createdAt, updatedAt, accountHolder&lt;/i&gt;
149
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: billingAddress&lt;i&gt;
150
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
151
+ * @param {*} [options] Override http request option.
152
+ * @throws {RequiredError}
153
+ */
154
+ listPayoutMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPayoutMethodsResponseClass>>;
155
+ };
156
+ /**
157
+ * PayoutMethodsApi - factory interface
158
+ * @export
159
+ */
160
+ export declare const PayoutMethodsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
161
+ /**
162
+ * Activates a payout method and deactivates the currently active payout method for the same partner **Required Permissions** \"payment-management.payments.update\"
163
+ * @summary Create the Payout Method Activation
164
+ * @param {string} code Unique identifier for the object.
165
+ * @param {string} [authorization] Bearer Token
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ activatePayoutMethod(code: string, authorization?: string, options?: any): AxiosPromise<object>;
170
+ /**
171
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
172
+ * @summary Create the Payout Method
173
+ * @param {CreatePayoutMethodRequestDto} createPayoutMethodRequestDto
174
+ * @param {string} [authorization] Bearer Token
175
+ * @param {*} [options] Override http request option.
176
+ * @throws {RequiredError}
177
+ */
178
+ createPayoutMethod(createPayoutMethodRequestDto: CreatePayoutMethodRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePayoutMethodResponseClass>;
179
+ /**
180
+ * Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
181
+ * @summary Create the Payout Method
182
+ * @param {string} code
183
+ * @param {CreatePayoutMethodByBankAccountRequestDto} createPayoutMethodByBankAccountRequestDto
184
+ * @param {string} [authorization] Bearer Token
185
+ * @param {*} [options] Override http request option.
186
+ * @throws {RequiredError}
187
+ */
188
+ createPayoutMethodByBankAccount(code: string, createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePayoutMethodResponseClass>;
189
+ /**
190
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
191
+ * @summary Delete the Payout Method
192
+ * @param {string} code Unique identifier for the object.
193
+ * @param {string} [authorization] Bearer Token
194
+ * @param {*} [options] Override http request option.
195
+ * @throws {RequiredError}
196
+ */
197
+ deletePayoutMethod(code: string, authorization?: string, options?: any): AxiosPromise<object>;
198
+ /**
199
+ * Retrieves the details of the Payout Method that was previously created. Supply the unique Payout Method code that was returned when you created it and Emil Api will return the corresponding Payout Method information. **Required Permissions** \"payment-management.payments.view\"
200
+ * @summary Retrieve the Payout Method
201
+ * @param {string} code
202
+ * @param {string} [authorization] Bearer Token
203
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: billingAddress&lt;i&gt;
204
+ * @param {*} [options] Override http request option.
205
+ * @throws {RequiredError}
206
+ */
207
+ getPayoutMethod(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPayoutMethodResponseClass>;
208
+ /**
209
+ * Returns a list of Payout Methods you have previously created. The Payout Methods 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\"
210
+ * @summary List Payout Methods
211
+ * @param {string} [authorization] Bearer Token
212
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
213
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
214
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
215
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode&lt;/i&gt;
216
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, isActive, createdAt, updatedAt, accountHolder&lt;/i&gt;
217
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: billingAddress&lt;i&gt;
218
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
219
+ * @param {*} [options] Override http request option.
220
+ * @throws {RequiredError}
221
+ */
222
+ listPayoutMethods(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPayoutMethodsResponseClass>;
223
+ };
224
+ /**
225
+ * Request parameters for activatePayoutMethod operation in PayoutMethodsApi.
226
+ * @export
227
+ * @interface PayoutMethodsApiActivatePayoutMethodRequest
228
+ */
229
+ export interface PayoutMethodsApiActivatePayoutMethodRequest {
230
+ /**
231
+ * Unique identifier for the object.
232
+ * @type {string}
233
+ * @memberof PayoutMethodsApiActivatePayoutMethod
234
+ */
235
+ readonly code: string;
236
+ /**
237
+ * Bearer Token
238
+ * @type {string}
239
+ * @memberof PayoutMethodsApiActivatePayoutMethod
240
+ */
241
+ readonly authorization?: string;
242
+ }
243
+ /**
244
+ * Request parameters for createPayoutMethod operation in PayoutMethodsApi.
245
+ * @export
246
+ * @interface PayoutMethodsApiCreatePayoutMethodRequest
247
+ */
248
+ export interface PayoutMethodsApiCreatePayoutMethodRequest {
249
+ /**
250
+ *
251
+ * @type {CreatePayoutMethodRequestDto}
252
+ * @memberof PayoutMethodsApiCreatePayoutMethod
253
+ */
254
+ readonly createPayoutMethodRequestDto: CreatePayoutMethodRequestDto;
255
+ /**
256
+ * Bearer Token
257
+ * @type {string}
258
+ * @memberof PayoutMethodsApiCreatePayoutMethod
259
+ */
260
+ readonly authorization?: string;
261
+ }
262
+ /**
263
+ * Request parameters for createPayoutMethodByBankAccount operation in PayoutMethodsApi.
264
+ * @export
265
+ * @interface PayoutMethodsApiCreatePayoutMethodByBankAccountRequest
266
+ */
267
+ export interface PayoutMethodsApiCreatePayoutMethodByBankAccountRequest {
268
+ /**
269
+ *
270
+ * @type {string}
271
+ * @memberof PayoutMethodsApiCreatePayoutMethodByBankAccount
272
+ */
273
+ readonly code: string;
274
+ /**
275
+ *
276
+ * @type {CreatePayoutMethodByBankAccountRequestDto}
277
+ * @memberof PayoutMethodsApiCreatePayoutMethodByBankAccount
278
+ */
279
+ readonly createPayoutMethodByBankAccountRequestDto: CreatePayoutMethodByBankAccountRequestDto;
280
+ /**
281
+ * Bearer Token
282
+ * @type {string}
283
+ * @memberof PayoutMethodsApiCreatePayoutMethodByBankAccount
284
+ */
285
+ readonly authorization?: string;
286
+ }
287
+ /**
288
+ * Request parameters for deletePayoutMethod operation in PayoutMethodsApi.
289
+ * @export
290
+ * @interface PayoutMethodsApiDeletePayoutMethodRequest
291
+ */
292
+ export interface PayoutMethodsApiDeletePayoutMethodRequest {
293
+ /**
294
+ * Unique identifier for the object.
295
+ * @type {string}
296
+ * @memberof PayoutMethodsApiDeletePayoutMethod
297
+ */
298
+ readonly code: string;
299
+ /**
300
+ * Bearer Token
301
+ * @type {string}
302
+ * @memberof PayoutMethodsApiDeletePayoutMethod
303
+ */
304
+ readonly authorization?: string;
305
+ }
306
+ /**
307
+ * Request parameters for getPayoutMethod operation in PayoutMethodsApi.
308
+ * @export
309
+ * @interface PayoutMethodsApiGetPayoutMethodRequest
310
+ */
311
+ export interface PayoutMethodsApiGetPayoutMethodRequest {
312
+ /**
313
+ *
314
+ * @type {string}
315
+ * @memberof PayoutMethodsApiGetPayoutMethod
316
+ */
317
+ readonly code: string;
318
+ /**
319
+ * Bearer Token
320
+ * @type {string}
321
+ * @memberof PayoutMethodsApiGetPayoutMethod
322
+ */
323
+ readonly authorization?: string;
324
+ /**
325
+ * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: billingAddress&lt;i&gt;
326
+ * @type {string}
327
+ * @memberof PayoutMethodsApiGetPayoutMethod
328
+ */
329
+ readonly expand?: string;
330
+ }
331
+ /**
332
+ * Request parameters for listPayoutMethods operation in PayoutMethodsApi.
333
+ * @export
334
+ * @interface PayoutMethodsApiListPayoutMethodsRequest
335
+ */
336
+ export interface PayoutMethodsApiListPayoutMethodsRequest {
337
+ /**
338
+ * Bearer Token
339
+ * @type {string}
340
+ * @memberof PayoutMethodsApiListPayoutMethods
341
+ */
342
+ readonly authorization?: string;
343
+ /**
344
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
345
+ * @type {number}
346
+ * @memberof PayoutMethodsApiListPayoutMethods
347
+ */
348
+ readonly pageSize?: number;
349
+ /**
350
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
351
+ * @type {string}
352
+ * @memberof PayoutMethodsApiListPayoutMethods
353
+ */
354
+ readonly pageToken?: string;
355
+ /**
356
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
357
+ * @type {string}
358
+ * @memberof PayoutMethodsApiListPayoutMethods
359
+ */
360
+ readonly filter?: string;
361
+ /**
362
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, billingAddressCode&lt;/i&gt;
363
+ * @type {string}
364
+ * @memberof PayoutMethodsApiListPayoutMethods
365
+ */
366
+ readonly search?: string;
367
+ /**
368
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, isActive, createdAt, updatedAt, accountHolder&lt;/i&gt;
369
+ * @type {string}
370
+ * @memberof PayoutMethodsApiListPayoutMethods
371
+ */
372
+ readonly order?: string;
373
+ /**
374
+ * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: billingAddress&lt;i&gt;
375
+ * @type {string}
376
+ * @memberof PayoutMethodsApiListPayoutMethods
377
+ */
378
+ readonly expand?: string;
379
+ /**
380
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, firstName, lastName, accountHolder, iban, bankName, accountCode, partnerCode, isActive, billingAddressCode&lt;/i&gt;
381
+ * @type {string}
382
+ * @memberof PayoutMethodsApiListPayoutMethods
383
+ */
384
+ readonly filters?: string;
385
+ }
386
+ /**
387
+ * PayoutMethodsApi - object-oriented interface
388
+ * @export
389
+ * @class PayoutMethodsApi
390
+ * @extends {BaseAPI}
391
+ */
392
+ export declare class PayoutMethodsApi extends BaseAPI {
393
+ /**
394
+ * Activates a payout method and deactivates the currently active payout method for the same partner **Required Permissions** \"payment-management.payments.update\"
395
+ * @summary Create the Payout Method Activation
396
+ * @param {PayoutMethodsApiActivatePayoutMethodRequest} requestParameters Request parameters.
397
+ * @param {*} [options] Override http request option.
398
+ * @throws {RequiredError}
399
+ * @memberof PayoutMethodsApi
400
+ */
401
+ activatePayoutMethod(requestParameters: PayoutMethodsApiActivatePayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
402
+ /**
403
+ * Creates a new payout method **Required Permissions** \"payment-management.payments.create\"
404
+ * @summary Create the Payout Method
405
+ * @param {PayoutMethodsApiCreatePayoutMethodRequest} requestParameters Request parameters.
406
+ * @param {*} [options] Override http request option.
407
+ * @throws {RequiredError}
408
+ * @memberof PayoutMethodsApi
409
+ */
410
+ createPayoutMethod(requestParameters: PayoutMethodsApiCreatePayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePayoutMethodResponseClass, any, {}>>;
411
+ /**
412
+ * Creates a new payout method fromm existing bank account **Required Permissions** \"payment-management.payments.create\"
413
+ * @summary Create the Payout Method
414
+ * @param {PayoutMethodsApiCreatePayoutMethodByBankAccountRequest} requestParameters Request parameters.
415
+ * @param {*} [options] Override http request option.
416
+ * @throws {RequiredError}
417
+ * @memberof PayoutMethodsApi
418
+ */
419
+ createPayoutMethodByBankAccount(requestParameters: PayoutMethodsApiCreatePayoutMethodByBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePayoutMethodResponseClass, any, {}>>;
420
+ /**
421
+ * Deletes a payout method by its code **Required Permissions** \"payment-management.payments.delete\"
422
+ * @summary Delete the Payout Method
423
+ * @param {PayoutMethodsApiDeletePayoutMethodRequest} requestParameters Request parameters.
424
+ * @param {*} [options] Override http request option.
425
+ * @throws {RequiredError}
426
+ * @memberof PayoutMethodsApi
427
+ */
428
+ deletePayoutMethod(requestParameters: PayoutMethodsApiDeletePayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
429
+ /**
430
+ * Retrieves the details of the Payout Method that was previously created. Supply the unique Payout Method code that was returned when you created it and Emil Api will return the corresponding Payout Method information. **Required Permissions** \"payment-management.payments.view\"
431
+ * @summary Retrieve the Payout Method
432
+ * @param {PayoutMethodsApiGetPayoutMethodRequest} requestParameters Request parameters.
433
+ * @param {*} [options] Override http request option.
434
+ * @throws {RequiredError}
435
+ * @memberof PayoutMethodsApi
436
+ */
437
+ getPayoutMethod(requestParameters: PayoutMethodsApiGetPayoutMethodRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPayoutMethodResponseClass, any, {}>>;
438
+ /**
439
+ * Returns a list of Payout Methods you have previously created. The Payout Methods 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\"
440
+ * @summary List Payout Methods
441
+ * @param {PayoutMethodsApiListPayoutMethodsRequest} requestParameters Request parameters.
442
+ * @param {*} [options] Override http request option.
443
+ * @throws {RequiredError}
444
+ * @memberof PayoutMethodsApi
445
+ */
446
+ listPayoutMethods(requestParameters?: PayoutMethodsApiListPayoutMethodsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPayoutMethodsResponseClass, any, {}>>;
447
+ }