@emilgroup/payment-sdk 1.4.1-beta.4 → 1.4.1-beta.40

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 (129) hide show
  1. package/.openapi-generator/FILES +15 -7
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +501 -89
  4. package/api/bank-transaction-api.ts +303 -97
  5. package/api/{default-api.ts → health-check-api.ts} +23 -19
  6. package/api/payment-methods-api.ts +62 -243
  7. package/api/payment-reminders-api.ts +58 -100
  8. package/api/payment-setup-api.ts +18 -10
  9. package/api/payments-api.ts +73 -136
  10. package/api/refunds-api.ts +436 -0
  11. package/api/tenant-bank-account-api.ts +100 -102
  12. package/api/webhooks-api.ts +18 -14
  13. package/api.ts +6 -4
  14. package/base.ts +23 -11
  15. package/common.ts +4 -4
  16. package/configuration.ts +2 -2
  17. package/dist/api/bank-accounts-api.d.ts +293 -70
  18. package/dist/api/bank-accounts-api.js +433 -63
  19. package/dist/api/bank-transaction-api.d.ts +193 -83
  20. package/dist/api/bank-transaction-api.js +253 -66
  21. package/dist/api/health-check-api.d.ts +70 -0
  22. package/dist/api/{default-api.js → health-check-api.js} +32 -28
  23. package/dist/api/payment-methods-api.d.ts +52 -152
  24. package/dist/api/payment-methods-api.js +49 -179
  25. package/dist/api/payment-reminders-api.d.ts +53 -80
  26. package/dist/api/payment-reminders-api.js +45 -63
  27. package/dist/api/payment-setup-api.d.ts +18 -10
  28. package/dist/api/payment-setup-api.js +18 -10
  29. package/dist/api/payments-api.d.ts +63 -99
  30. package/dist/api/payments-api.js +56 -86
  31. package/dist/api/refunds-api.d.ts +251 -0
  32. package/dist/api/refunds-api.js +439 -0
  33. package/dist/api/tenant-bank-account-api.d.ts +94 -89
  34. package/dist/api/tenant-bank-account-api.js +72 -64
  35. package/dist/api/webhooks-api.d.ts +18 -14
  36. package/dist/api/webhooks-api.js +16 -12
  37. package/dist/api.d.ts +4 -3
  38. package/dist/api.js +4 -3
  39. package/dist/base.d.ts +7 -4
  40. package/dist/base.js +32 -23
  41. package/dist/common.d.ts +4 -4
  42. package/dist/common.js +2 -2
  43. package/dist/configuration.d.ts +2 -2
  44. package/dist/configuration.js +2 -2
  45. package/dist/index.d.ts +2 -2
  46. package/dist/index.js +2 -2
  47. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class-without-expand-properties.d.ts} +32 -34
  48. package/dist/models/{bank-transaction-response-class.js → bank-transaction-class-without-expand-properties.js} +2 -2
  49. package/dist/models/create-bank-account-request-dto.d.ts +42 -0
  50. package/dist/models/{get-request-dto.js → create-bank-account-request-dto.js} +2 -2
  51. package/dist/models/create-payment-reminder-request-dto.d.ts +2 -2
  52. package/dist/models/create-payment-reminder-request-dto.js +2 -2
  53. package/dist/models/create-payment-request-dto.d.ts +4 -4
  54. package/dist/models/create-payment-request-dto.js +2 -2
  55. package/dist/models/create-refund-request-dto.d.ts +24 -0
  56. package/dist/models/{get-bank-transactions-response-class.js → create-refund-request-dto.js} +2 -2
  57. package/dist/models/create-tenant-bank-account-request-dto.d.ts +2 -2
  58. package/dist/models/create-tenant-bank-account-request-dto.js +2 -2
  59. package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
  60. package/dist/models/{list-bank-transactions-response-class.js → create-tenant-bank-account-response-class.js} +2 -2
  61. package/dist/models/deactivate-payment-reminder-request-dto.d.ts +2 -2
  62. package/dist/models/deactivate-payment-reminder-request-dto.js +2 -2
  63. package/dist/models/get-tenant-bank-account-response-class.d.ts +6 -6
  64. package/dist/models/get-tenant-bank-account-response-class.js +2 -2
  65. package/dist/models/index.d.ts +13 -6
  66. package/dist/models/index.js +13 -6
  67. package/dist/models/inline-response200.d.ts +2 -2
  68. package/dist/models/inline-response200.js +2 -2
  69. package/dist/models/inline-response503.d.ts +2 -2
  70. package/dist/models/inline-response503.js +2 -2
  71. package/dist/models/link-bank-transaction-request-dto-rest.d.ts +24 -0
  72. package/dist/models/link-bank-transaction-request-dto-rest.js +15 -0
  73. package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
  74. package/dist/models/list-tenant-bank-account-response-class.js +15 -0
  75. package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
  76. package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
  77. package/dist/models/tenant-bank-account-class-without-expand-properties.d.ts +78 -0
  78. package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
  79. package/dist/models/tenant-bank-account-class.d.ts +85 -0
  80. package/dist/models/tenant-bank-account-class.js +15 -0
  81. package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +24 -0
  82. package/dist/models/unlink-bank-transaction-request-dto-rest.js +15 -0
  83. package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
  84. package/dist/models/update-bank-account-request-dto-rest.js +15 -0
  85. package/dist/models/update-bank-account-request-dto.d.ts +36 -0
  86. package/dist/models/update-bank-account-request-dto.js +15 -0
  87. package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
  88. package/dist/models/update-tenant-bank-account-response-class.js +15 -0
  89. package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +2 -2
  90. package/dist/models/update-tenant-bank-account-rest-request-dto.js +2 -2
  91. package/dist/models/validate-pspconfig-request-dto.d.ts +2 -2
  92. package/dist/models/validate-pspconfig-request-dto.js +2 -2
  93. package/index.ts +2 -2
  94. package/models/{bank-transaction-response-class.ts → bank-transaction-class-without-expand-properties.ts} +32 -34
  95. package/models/create-bank-account-request-dto.ts +48 -0
  96. package/models/create-payment-reminder-request-dto.ts +2 -2
  97. package/models/create-payment-request-dto.ts +4 -4
  98. package/models/create-refund-request-dto.ts +30 -0
  99. package/models/create-tenant-bank-account-request-dto.ts +2 -2
  100. package/models/create-tenant-bank-account-response-class.ts +31 -0
  101. package/models/deactivate-payment-reminder-request-dto.ts +2 -2
  102. package/models/get-tenant-bank-account-response-class.ts +6 -6
  103. package/models/index.ts +13 -6
  104. package/models/inline-response200.ts +2 -2
  105. package/models/inline-response503.ts +2 -2
  106. package/models/link-bank-transaction-request-dto-rest.ts +30 -0
  107. package/models/list-tenant-bank-account-response-class.ts +37 -0
  108. package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
  109. package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +24 -12
  110. package/models/tenant-bank-account-class.ts +91 -0
  111. package/models/unlink-bank-transaction-request-dto-rest.ts +30 -0
  112. package/models/update-bank-account-request-dto-rest.ts +36 -0
  113. package/models/update-bank-account-request-dto.ts +42 -0
  114. package/models/update-tenant-bank-account-response-class.ts +31 -0
  115. package/models/update-tenant-bank-account-rest-request-dto.ts +2 -2
  116. package/models/validate-pspconfig-request-dto.ts +2 -2
  117. package/package.json +1 -1
  118. package/dist/api/default-api.d.ts +0 -66
  119. package/dist/models/get-bank-transactions-response-class.d.ts +0 -25
  120. package/dist/models/get-request-dto.d.ts +0 -30
  121. package/dist/models/list-bank-transactions-response-class.d.ts +0 -31
  122. package/dist/models/tenant-bank-account-response-class.d.ts +0 -66
  123. package/dist/models/tenant-bank-account-response-class.js +0 -15
  124. package/dist/models/transaction-class.d.ts +0 -54
  125. package/dist/models/transaction-class.js +0 -15
  126. package/models/get-bank-transactions-response-class.ts +0 -31
  127. package/models/get-request-dto.ts +0 -36
  128. package/models/list-bank-transactions-response-class.ts +0 -37
  129. package/models/transaction-class.ts +0 -60
@@ -1,9 +1,9 @@
1
1
  /**
2
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.
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
4
  *
5
5
  * The version of the OpenAPI document: 1.0
6
- * Contact: z
6
+ * Contact: kontakt@emil.de
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
9
  * https://openapi-generator.tech
@@ -12,35 +12,74 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateBankAccountRequestDto } from '../models';
16
+ import { SetPrimaryBankAccountRequestDtoRest } from '../models';
17
+ import { UpdateBankAccountRequestDtoRest } from '../models';
15
18
  /**
16
19
  * BankAccountsApi - axios parameter creator
17
20
  * @export
18
21
  */
19
22
  export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
20
23
  /**
21
- * Creates a bank account for a specified account.
22
- * @summary Create a bank account
23
- * @param {object} body
24
+ * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary.
25
+ * @summary Create the bank account
26
+ * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
24
27
  * @param {string} [authorization] Bearer Token
25
28
  * @param {*} [options] Override http request option.
26
29
  * @throws {RequiredError}
27
30
  */
28
- createBankAccount: (body: object, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
+ createBankAccount: (createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
29
32
  /**
30
- * Returns a list of bank accounts you’ve previously created. The bank accounts are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
33
+ * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary.
34
+ * @summary Delete the bank account
35
+ * @param {string} code Unique identifier for the object.
36
+ * @param {string} [authorization] Bearer Token
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ deleteBankAccount: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
+ /**
42
+ * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information.
43
+ * @summary Retrieve the bank account
44
+ * @param {string} code
45
+ * @param {string} [authorization] Bearer Token
46
+ * @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: primaryBankAccount&lt;i&gt;
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ getBankAccount: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51
+ /**
52
+ * Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
31
53
  * @summary List bank accounts
32
54
  * @param {string} [authorization] Bearer Token
33
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
34
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
35
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
36
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
37
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
38
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
39
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
55
+ * @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: code, id, accountCode, partnerCode&lt;/i&gt;
56
+ * @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: code, id, accountCode, partnerCode&lt;/i&gt;
57
+ * @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, createdAt&lt;/i&gt;
58
+ * @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: primaryBankAccount&lt;i&gt;
40
59
  * @param {*} [options] Override http request option.
41
60
  * @throws {RequiredError}
42
61
  */
43
- listBankAccounts: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
+ listBankAccounts: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
+ /**
64
+ * Set the primary bank account for the specified partner/account
65
+ * @summary Set primary bank account
66
+ * @param {string} code Code of the bank account to set primary
67
+ * @param {SetPrimaryBankAccountRequestDtoRest} setPrimaryBankAccountRequestDtoRest
68
+ * @param {string} [authorization] Bearer Token
69
+ * @param {*} [options] Override http request option.
70
+ * @throws {RequiredError}
71
+ */
72
+ setPrimaryBankAccount: (code: string, setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
73
+ /**
74
+ * Update a bank account by code
75
+ * @summary Update the bank account
76
+ * @param {string} code Unique identifier for the object.
77
+ * @param {UpdateBankAccountRequestDtoRest} updateBankAccountRequestDtoRest
78
+ * @param {string} [authorization] Bearer Token
79
+ * @param {*} [options] Override http request option.
80
+ * @throws {RequiredError}
81
+ */
82
+ updateBankAccount: (code: string, updateBankAccountRequestDtoRest: UpdateBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
83
  };
45
84
  /**
46
85
  * BankAccountsApi - functional programming interface
@@ -48,29 +87,65 @@ export declare const BankAccountsApiAxiosParamCreator: (configuration?: Configur
48
87
  */
49
88
  export declare const BankAccountsApiFp: (configuration?: Configuration) => {
50
89
  /**
51
- * Creates a bank account for a specified account.
52
- * @summary Create a bank account
53
- * @param {object} body
90
+ * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary.
91
+ * @summary Create the bank account
92
+ * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
54
93
  * @param {string} [authorization] Bearer Token
55
94
  * @param {*} [options] Override http request option.
56
95
  * @throws {RequiredError}
57
96
  */
58
- createBankAccount(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
97
+ createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
59
98
  /**
60
- * Returns a list of bank accounts you’ve previously created. The bank accounts are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
99
+ * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary.
100
+ * @summary Delete the bank account
101
+ * @param {string} code Unique identifier for the object.
102
+ * @param {string} [authorization] Bearer Token
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ deleteBankAccount(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
107
+ /**
108
+ * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information.
109
+ * @summary Retrieve the bank account
110
+ * @param {string} code
111
+ * @param {string} [authorization] Bearer Token
112
+ * @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: primaryBankAccount&lt;i&gt;
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ */
116
+ getBankAccount(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
117
+ /**
118
+ * Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
61
119
  * @summary List bank accounts
62
120
  * @param {string} [authorization] Bearer Token
63
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
64
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
65
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
66
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
67
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
68
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
69
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
121
+ * @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: code, id, accountCode, partnerCode&lt;/i&gt;
122
+ * @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: code, id, accountCode, partnerCode&lt;/i&gt;
123
+ * @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, createdAt&lt;/i&gt;
124
+ * @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: primaryBankAccount&lt;i&gt;
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ */
128
+ listBankAccounts(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
129
+ /**
130
+ * Set the primary bank account for the specified partner/account
131
+ * @summary Set primary bank account
132
+ * @param {string} code Code of the bank account to set primary
133
+ * @param {SetPrimaryBankAccountRequestDtoRest} setPrimaryBankAccountRequestDtoRest
134
+ * @param {string} [authorization] Bearer Token
70
135
  * @param {*} [options] Override http request option.
71
136
  * @throws {RequiredError}
72
137
  */
73
- listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
138
+ setPrimaryBankAccount(code: string, setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
139
+ /**
140
+ * Update a bank account by code
141
+ * @summary Update the bank account
142
+ * @param {string} code Unique identifier for the object.
143
+ * @param {UpdateBankAccountRequestDtoRest} updateBankAccountRequestDtoRest
144
+ * @param {string} [authorization] Bearer Token
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ updateBankAccount(code: string, updateBankAccountRequestDtoRest: UpdateBankAccountRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
74
149
  };
75
150
  /**
76
151
  * BankAccountsApi - factory interface
@@ -78,29 +153,65 @@ export declare const BankAccountsApiFp: (configuration?: Configuration) => {
78
153
  */
79
154
  export declare const BankAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
80
155
  /**
81
- * Creates a bank account for a specified account.
82
- * @summary Create a bank account
83
- * @param {object} body
156
+ * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary.
157
+ * @summary Create the bank account
158
+ * @param {CreateBankAccountRequestDto} createBankAccountRequestDto
159
+ * @param {string} [authorization] Bearer Token
160
+ * @param {*} [options] Override http request option.
161
+ * @throws {RequiredError}
162
+ */
163
+ createBankAccount(createBankAccountRequestDto: CreateBankAccountRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
164
+ /**
165
+ * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary.
166
+ * @summary Delete the bank account
167
+ * @param {string} code Unique identifier for the object.
84
168
  * @param {string} [authorization] Bearer Token
85
169
  * @param {*} [options] Override http request option.
86
170
  * @throws {RequiredError}
87
171
  */
88
- createBankAccount(body: object, authorization?: string, options?: any): AxiosPromise<void>;
172
+ deleteBankAccount(code: string, authorization?: string, options?: any): AxiosPromise<void>;
89
173
  /**
90
- * Returns a list of bank accounts you’ve previously created. The bank accounts are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
174
+ * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information.
175
+ * @summary Retrieve the bank account
176
+ * @param {string} code
177
+ * @param {string} [authorization] Bearer Token
178
+ * @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: primaryBankAccount&lt;i&gt;
179
+ * @param {*} [options] Override http request option.
180
+ * @throws {RequiredError}
181
+ */
182
+ getBankAccount(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<void>;
183
+ /**
184
+ * Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
91
185
  * @summary List bank accounts
92
186
  * @param {string} [authorization] Bearer Token
93
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
94
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
95
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
96
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
97
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
98
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
99
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
187
+ * @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: code, id, accountCode, partnerCode&lt;/i&gt;
188
+ * @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: code, id, accountCode, partnerCode&lt;/i&gt;
189
+ * @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, createdAt&lt;/i&gt;
190
+ * @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: primaryBankAccount&lt;i&gt;
100
191
  * @param {*} [options] Override http request option.
101
192
  * @throws {RequiredError}
102
193
  */
103
- listBankAccounts(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void>;
194
+ listBankAccounts(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<void>;
195
+ /**
196
+ * Set the primary bank account for the specified partner/account
197
+ * @summary Set primary bank account
198
+ * @param {string} code Code of the bank account to set primary
199
+ * @param {SetPrimaryBankAccountRequestDtoRest} setPrimaryBankAccountRequestDtoRest
200
+ * @param {string} [authorization] Bearer Token
201
+ * @param {*} [options] Override http request option.
202
+ * @throws {RequiredError}
203
+ */
204
+ setPrimaryBankAccount(code: string, setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
205
+ /**
206
+ * Update a bank account by code
207
+ * @summary Update the bank account
208
+ * @param {string} code Unique identifier for the object.
209
+ * @param {UpdateBankAccountRequestDtoRest} updateBankAccountRequestDtoRest
210
+ * @param {string} [authorization] Bearer Token
211
+ * @param {*} [options] Override http request option.
212
+ * @throws {RequiredError}
213
+ */
214
+ updateBankAccount(code: string, updateBankAccountRequestDtoRest: UpdateBankAccountRequestDtoRest, authorization?: string, options?: any): AxiosPromise<void>;
104
215
  };
105
216
  /**
106
217
  * Request parameters for createBankAccount operation in BankAccountsApi.
@@ -110,10 +221,10 @@ export declare const BankAccountsApiFactory: (configuration?: Configuration, bas
110
221
  export interface BankAccountsApiCreateBankAccountRequest {
111
222
  /**
112
223
  *
113
- * @type {object}
224
+ * @type {CreateBankAccountRequestDto}
114
225
  * @memberof BankAccountsApiCreateBankAccount
115
226
  */
116
- readonly body: object;
227
+ readonly createBankAccountRequestDto: CreateBankAccountRequestDto;
117
228
  /**
118
229
  * Bearer Token
119
230
  * @type {string}
@@ -121,6 +232,50 @@ export interface BankAccountsApiCreateBankAccountRequest {
121
232
  */
122
233
  readonly authorization?: string;
123
234
  }
235
+ /**
236
+ * Request parameters for deleteBankAccount operation in BankAccountsApi.
237
+ * @export
238
+ * @interface BankAccountsApiDeleteBankAccountRequest
239
+ */
240
+ export interface BankAccountsApiDeleteBankAccountRequest {
241
+ /**
242
+ * Unique identifier for the object.
243
+ * @type {string}
244
+ * @memberof BankAccountsApiDeleteBankAccount
245
+ */
246
+ readonly code: string;
247
+ /**
248
+ * Bearer Token
249
+ * @type {string}
250
+ * @memberof BankAccountsApiDeleteBankAccount
251
+ */
252
+ readonly authorization?: string;
253
+ }
254
+ /**
255
+ * Request parameters for getBankAccount operation in BankAccountsApi.
256
+ * @export
257
+ * @interface BankAccountsApiGetBankAccountRequest
258
+ */
259
+ export interface BankAccountsApiGetBankAccountRequest {
260
+ /**
261
+ *
262
+ * @type {string}
263
+ * @memberof BankAccountsApiGetBankAccount
264
+ */
265
+ readonly code: string;
266
+ /**
267
+ * Bearer Token
268
+ * @type {string}
269
+ * @memberof BankAccountsApiGetBankAccount
270
+ */
271
+ readonly authorization?: string;
272
+ /**
273
+ * 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: primaryBankAccount&lt;i&gt;
274
+ * @type {string}
275
+ * @memberof BankAccountsApiGetBankAccount
276
+ */
277
+ readonly expand?: string;
278
+ }
124
279
  /**
125
280
  * Request parameters for listBankAccounts operation in BankAccountsApi.
126
281
  * @export
@@ -134,47 +289,79 @@ export interface BankAccountsApiListBankAccountsRequest {
134
289
  */
135
290
  readonly authorization?: string;
136
291
  /**
137
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
138
- * @type {any}
292
+ * 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: code, id, accountCode, partnerCode&lt;/i&gt;
293
+ * @type {string}
139
294
  * @memberof BankAccountsApiListBankAccounts
140
295
  */
141
- readonly pageSize?: any;
296
+ readonly filter?: string;
142
297
  /**
143
- * 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.
144
- * @type {any}
298
+ * 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: code, id, accountCode, partnerCode&lt;/i&gt;
299
+ * @type {string}
145
300
  * @memberof BankAccountsApiListBankAccounts
146
301
  */
147
- readonly pageToken?: any;
302
+ readonly filters?: string;
148
303
  /**
149
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
150
- * @type {any}
304
+ * 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, createdAt&lt;/i&gt;
305
+ * @type {string}
151
306
  * @memberof BankAccountsApiListBankAccounts
152
307
  */
153
- readonly filter?: any;
308
+ readonly order?: string;
154
309
  /**
155
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
156
- * @type {any}
310
+ * 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: primaryBankAccount&lt;i&gt;
311
+ * @type {string}
157
312
  * @memberof BankAccountsApiListBankAccounts
158
313
  */
159
- readonly search?: any;
314
+ readonly expand?: string;
315
+ }
316
+ /**
317
+ * Request parameters for setPrimaryBankAccount operation in BankAccountsApi.
318
+ * @export
319
+ * @interface BankAccountsApiSetPrimaryBankAccountRequest
320
+ */
321
+ export interface BankAccountsApiSetPrimaryBankAccountRequest {
160
322
  /**
161
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
162
- * @type {any}
163
- * @memberof BankAccountsApiListBankAccounts
323
+ * Code of the bank account to set primary
324
+ * @type {string}
325
+ * @memberof BankAccountsApiSetPrimaryBankAccount
164
326
  */
165
- readonly order?: any;
327
+ readonly code: string;
166
328
  /**
167
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
168
- * @type {any}
169
- * @memberof BankAccountsApiListBankAccounts
329
+ *
330
+ * @type {SetPrimaryBankAccountRequestDtoRest}
331
+ * @memberof BankAccountsApiSetPrimaryBankAccount
170
332
  */
171
- readonly expand?: any;
333
+ readonly setPrimaryBankAccountRequestDtoRest: SetPrimaryBankAccountRequestDtoRest;
172
334
  /**
173
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
174
- * @type {any}
175
- * @memberof BankAccountsApiListBankAccounts
335
+ * Bearer Token
336
+ * @type {string}
337
+ * @memberof BankAccountsApiSetPrimaryBankAccount
176
338
  */
177
- readonly filters?: any;
339
+ readonly authorization?: string;
340
+ }
341
+ /**
342
+ * Request parameters for updateBankAccount operation in BankAccountsApi.
343
+ * @export
344
+ * @interface BankAccountsApiUpdateBankAccountRequest
345
+ */
346
+ export interface BankAccountsApiUpdateBankAccountRequest {
347
+ /**
348
+ * Unique identifier for the object.
349
+ * @type {string}
350
+ * @memberof BankAccountsApiUpdateBankAccount
351
+ */
352
+ readonly code: string;
353
+ /**
354
+ *
355
+ * @type {UpdateBankAccountRequestDtoRest}
356
+ * @memberof BankAccountsApiUpdateBankAccount
357
+ */
358
+ readonly updateBankAccountRequestDtoRest: UpdateBankAccountRequestDtoRest;
359
+ /**
360
+ * Bearer Token
361
+ * @type {string}
362
+ * @memberof BankAccountsApiUpdateBankAccount
363
+ */
364
+ readonly authorization?: string;
178
365
  }
179
366
  /**
180
367
  * BankAccountsApi - object-oriented interface
@@ -184,8 +371,8 @@ export interface BankAccountsApiListBankAccountsRequest {
184
371
  */
185
372
  export declare class BankAccountsApi extends BaseAPI {
186
373
  /**
187
- * Creates a bank account for a specified account.
188
- * @summary Create a bank account
374
+ * This will create a bank account for a specified partner/account. If this is the first bank account for the specified partner/account, it will be marked as primary.
375
+ * @summary Create the bank account
189
376
  * @param {BankAccountsApiCreateBankAccountRequest} requestParameters Request parameters.
190
377
  * @param {*} [options] Override http request option.
191
378
  * @throws {RequiredError}
@@ -193,7 +380,25 @@ export declare class BankAccountsApi extends BaseAPI {
193
380
  */
194
381
  createBankAccount(requestParameters: BankAccountsApiCreateBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
195
382
  /**
196
- * Returns a list of bank accounts you’ve previously created. The bank accounts are returned in sorted order, with the oldest payment appearing first. For more information about pagination, read the Pagination documentation.
383
+ * Deletes a bank account by code. If the bank account was primary, then the first available bank account for the specified partner/account will be marked as primary.
384
+ * @summary Delete the bank account
385
+ * @param {BankAccountsApiDeleteBankAccountRequest} requestParameters Request parameters.
386
+ * @param {*} [options] Override http request option.
387
+ * @throws {RequiredError}
388
+ * @memberof BankAccountsApi
389
+ */
390
+ deleteBankAccount(requestParameters: BankAccountsApiDeleteBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
391
+ /**
392
+ * Retrieves the details of the bank account that was previously created. Supply the unique bank account code that was returned when you created it and Emil Api will return the corresponding bank account information.
393
+ * @summary Retrieve the bank account
394
+ * @param {BankAccountsApiGetBankAccountRequest} requestParameters Request parameters.
395
+ * @param {*} [options] Override http request option.
396
+ * @throws {RequiredError}
397
+ * @memberof BankAccountsApi
398
+ */
399
+ getBankAccount(requestParameters: BankAccountsApiGetBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
400
+ /**
401
+ * Returns a list of bank accounts you have previously created. The bank accounts are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
197
402
  * @summary List bank accounts
198
403
  * @param {BankAccountsApiListBankAccountsRequest} requestParameters Request parameters.
199
404
  * @param {*} [options] Override http request option.
@@ -201,4 +406,22 @@ export declare class BankAccountsApi extends BaseAPI {
201
406
  * @memberof BankAccountsApi
202
407
  */
203
408
  listBankAccounts(requestParameters?: BankAccountsApiListBankAccountsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
409
+ /**
410
+ * Set the primary bank account for the specified partner/account
411
+ * @summary Set primary bank account
412
+ * @param {BankAccountsApiSetPrimaryBankAccountRequest} requestParameters Request parameters.
413
+ * @param {*} [options] Override http request option.
414
+ * @throws {RequiredError}
415
+ * @memberof BankAccountsApi
416
+ */
417
+ setPrimaryBankAccount(requestParameters: BankAccountsApiSetPrimaryBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
418
+ /**
419
+ * Update a bank account by code
420
+ * @summary Update the bank account
421
+ * @param {BankAccountsApiUpdateBankAccountRequest} requestParameters Request parameters.
422
+ * @param {*} [options] Override http request option.
423
+ * @throws {RequiredError}
424
+ * @memberof BankAccountsApi
425
+ */
426
+ updateBankAccount(requestParameters: BankAccountsApiUpdateBankAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
204
427
  }