@emilgroup/payment-sdk 1.4.1-beta.8 → 1.5.0

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 (272) hide show
  1. package/.openapi-generator/FILES +55 -5
  2. package/README.md +2 -2
  3. package/api/bank-accounts-api.ts +508 -88
  4. package/api/bank-transaction-api.ts +95 -115
  5. package/api/{default-api.ts → health-check-api.ts} +22 -18
  6. package/api/payment-methods-api.ts +83 -256
  7. package/api/payment-reminders-api.ts +71 -105
  8. package/api/payment-setup-api.ts +53 -37
  9. package/api/payments-api.ts +80 -137
  10. package/api/refunds-api.ts +78 -112
  11. package/api/tenant-bank-account-api.ts +99 -101
  12. package/api/webhooks-api.ts +17 -13
  13. package/api.ts +3 -3
  14. package/base.ts +22 -10
  15. package/common.ts +2 -2
  16. package/configuration.ts +1 -1
  17. package/dist/api/bank-accounts-api.d.ts +298 -71
  18. package/dist/api/bank-accounts-api.js +432 -62
  19. package/dist/api/bank-transaction-api.d.ts +83 -98
  20. package/dist/api/bank-transaction-api.js +63 -74
  21. package/dist/api/health-check-api.d.ts +70 -0
  22. package/dist/api/{default-api.js → health-check-api.js} +31 -27
  23. package/dist/api/payment-methods-api.d.ts +66 -162
  24. package/dist/api/payment-methods-api.js +60 -190
  25. package/dist/api/payment-reminders-api.d.ts +66 -89
  26. package/dist/api/payment-reminders-api.js +44 -62
  27. package/dist/api/payment-setup-api.d.ts +39 -27
  28. package/dist/api/payment-setup-api.js +41 -33
  29. package/dist/api/payments-api.d.ts +70 -103
  30. package/dist/api/payments-api.js +55 -85
  31. package/dist/api/refunds-api.d.ts +68 -83
  32. package/dist/api/refunds-api.js +58 -68
  33. package/dist/api/tenant-bank-account-api.d.ts +93 -88
  34. package/dist/api/tenant-bank-account-api.js +71 -63
  35. package/dist/api/webhooks-api.d.ts +17 -13
  36. package/dist/api/webhooks-api.js +15 -11
  37. package/dist/api.d.ts +2 -2
  38. package/dist/api.js +2 -2
  39. package/dist/base.d.ts +6 -3
  40. package/dist/base.js +31 -22
  41. package/dist/common.d.ts +2 -2
  42. package/dist/common.js +1 -1
  43. package/dist/configuration.d.ts +1 -1
  44. package/dist/configuration.js +1 -1
  45. package/dist/index.d.ts +1 -1
  46. package/dist/index.js +1 -1
  47. package/dist/models/bank-account-class-without-expand-properties.d.ts +84 -0
  48. package/dist/models/{bank-transaction-response-class.js → bank-account-class-without-expand-properties.js} +1 -1
  49. package/dist/models/bank-account-class.d.ts +91 -0
  50. package/dist/models/{transaction-class.js → bank-account-class.js} +1 -1
  51. package/dist/models/bank-transaction-class-without-expand-properties.d.ts +126 -0
  52. package/dist/models/{get-request-dto.js → bank-transaction-class-without-expand-properties.js} +1 -1
  53. package/dist/models/{bank-transaction-response-class.d.ts → bank-transaction-class.d.ts} +41 -29
  54. package/dist/models/{tenant-bank-account-response-class.js → bank-transaction-class.js} +1 -1
  55. package/dist/models/billing-profile-dto.d.ts +38 -0
  56. package/dist/models/billing-profile-dto.js +15 -0
  57. package/dist/models/billing-profile-limited-response-dto.d.ts +54 -0
  58. package/dist/models/billing-profile-limited-response-dto.js +15 -0
  59. package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +48 -0
  60. package/dist/models/complete-braintree-payment-setup-request-dto.js +15 -0
  61. package/dist/models/complete-payment-setup-request-dto.d.ts +32 -0
  62. package/dist/models/complete-payment-setup-request-dto.js +15 -0
  63. package/dist/models/complete-payment-setup-response-class.d.ts +25 -0
  64. package/dist/models/complete-payment-setup-response-class.js +15 -0
  65. package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +77 -0
  66. package/dist/models/complete-stripe-payment-setup-request-dto.js +32 -0
  67. package/dist/models/create-bank-account-request-dto.d.ts +42 -0
  68. package/dist/models/create-bank-account-request-dto.js +15 -0
  69. package/dist/models/create-bank-account-response-class.d.ts +25 -0
  70. package/dist/models/create-bank-account-response-class.js +15 -0
  71. package/dist/models/create-payment-method-response-class.d.ts +25 -0
  72. package/dist/models/create-payment-method-response-class.js +15 -0
  73. package/dist/models/create-payment-reminder-request-dto.d.ts +1 -1
  74. package/dist/models/create-payment-reminder-request-dto.js +1 -1
  75. package/dist/models/create-payment-reminder-response-class.d.ts +25 -0
  76. package/dist/models/create-payment-reminder-response-class.js +15 -0
  77. package/dist/models/create-payment-request-dto.d.ts +4 -4
  78. package/dist/models/create-payment-request-dto.js +1 -1
  79. package/dist/models/create-payment-response-class.d.ts +25 -0
  80. package/dist/models/create-payment-response-class.js +15 -0
  81. package/dist/models/create-psp-payment-method-request-dto.d.ts +61 -0
  82. package/dist/models/create-psp-payment-method-request-dto.js +32 -0
  83. package/dist/models/create-refund-request-dto.d.ts +1 -1
  84. package/dist/models/create-refund-request-dto.js +1 -1
  85. package/dist/models/create-refund-response-class.d.ts +1 -1
  86. package/dist/models/create-refund-response-class.js +1 -1
  87. package/dist/models/create-tenant-bank-account-request-dto.d.ts +1 -1
  88. package/dist/models/create-tenant-bank-account-request-dto.js +1 -1
  89. package/dist/models/create-tenant-bank-account-response-class.d.ts +25 -0
  90. package/dist/models/create-tenant-bank-account-response-class.js +15 -0
  91. package/dist/models/deactivate-payment-reminder-request-dto.d.ts +1 -1
  92. package/dist/models/deactivate-payment-reminder-request-dto.js +1 -1
  93. package/dist/models/deactivate-payment-reminder-response-class.d.ts +25 -0
  94. package/dist/models/deactivate-payment-reminder-response-class.js +15 -0
  95. package/dist/models/deactivated-payment-reminder-class.d.ts +102 -0
  96. package/dist/models/deactivated-payment-reminder-class.js +15 -0
  97. package/dist/models/get-bank-account-response-class.d.ts +25 -0
  98. package/dist/models/get-bank-account-response-class.js +15 -0
  99. package/dist/models/get-bank-transactions-response-class.d.ts +4 -4
  100. package/dist/models/get-bank-transactions-response-class.js +1 -1
  101. package/dist/models/get-payment-method-response-class.d.ts +25 -0
  102. package/dist/models/get-payment-method-response-class.js +15 -0
  103. package/dist/models/get-payment-reminder-response-class.d.ts +25 -0
  104. package/dist/models/get-payment-reminder-response-class.js +15 -0
  105. package/dist/models/get-payment-response-class.d.ts +25 -0
  106. package/dist/models/get-payment-response-class.js +15 -0
  107. package/dist/models/get-refund-response-class.d.ts +1 -1
  108. package/dist/models/get-refund-response-class.js +1 -1
  109. package/dist/models/get-tenant-bank-account-response-class.d.ts +5 -5
  110. package/dist/models/get-tenant-bank-account-response-class.js +1 -1
  111. package/dist/models/import-bank-transactions-response-class.d.ts +25 -0
  112. package/dist/models/import-bank-transactions-response-class.js +15 -0
  113. package/dist/models/index.d.ts +54 -4
  114. package/dist/models/index.js +54 -4
  115. package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +30 -0
  116. package/dist/models/initiate-braintree-payment-setup-request-dto.js +15 -0
  117. package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +24 -0
  118. package/dist/models/initiate-braintree-payment-setup-response-class.js +15 -0
  119. package/dist/models/initiate-payment-setup-request-dto.d.ts +44 -0
  120. package/dist/models/initiate-payment-setup-request-dto.js +15 -0
  121. package/dist/models/initiate-payment-setup-response-class.d.ts +32 -0
  122. package/dist/models/initiate-payment-setup-response-class.js +15 -0
  123. package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +30 -0
  124. package/dist/models/initiate-stripe-payment-setup-request-dto.js +15 -0
  125. package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +30 -0
  126. package/dist/models/initiate-stripe-payment-setup-response-class.js +15 -0
  127. package/dist/models/inline-response200.d.ts +1 -1
  128. package/dist/models/inline-response200.js +1 -1
  129. package/dist/models/inline-response503.d.ts +1 -1
  130. package/dist/models/inline-response503.js +1 -1
  131. package/dist/models/link-bank-transaction-request-dto-rest.d.ts +1 -1
  132. package/dist/models/link-bank-transaction-request-dto-rest.js +1 -1
  133. package/dist/models/link-bank-transactions-response-class.d.ts +25 -0
  134. package/dist/models/link-bank-transactions-response-class.js +15 -0
  135. package/dist/models/list-bank-accounts-response-class.d.ts +31 -0
  136. package/dist/models/list-bank-accounts-response-class.js +15 -0
  137. package/dist/models/list-bank-transactions-response-class.d.ts +6 -6
  138. package/dist/models/list-bank-transactions-response-class.js +1 -1
  139. package/dist/models/list-payment-methods-response-class.d.ts +31 -0
  140. package/dist/models/list-payment-methods-response-class.js +15 -0
  141. package/dist/models/list-payment-reminders-response-class.d.ts +31 -0
  142. package/dist/models/list-payment-reminders-response-class.js +15 -0
  143. package/dist/models/list-payments-response-class.d.ts +31 -0
  144. package/dist/models/list-payments-response-class.js +15 -0
  145. package/dist/models/list-refunds-response-class.d.ts +3 -3
  146. package/dist/models/list-refunds-response-class.js +1 -1
  147. package/dist/models/list-tenant-bank-account-response-class.d.ts +31 -0
  148. package/dist/models/list-tenant-bank-account-response-class.js +15 -0
  149. package/dist/models/payment-class-without-expand-properties.d.ts +108 -0
  150. package/dist/models/payment-class-without-expand-properties.js +15 -0
  151. package/dist/models/payment-class.d.ts +115 -0
  152. package/dist/models/payment-class.js +15 -0
  153. package/dist/models/payment-method-class.d.ts +78 -0
  154. package/dist/models/payment-method-class.js +15 -0
  155. package/dist/models/payment-reminder-class.d.ts +102 -0
  156. package/dist/models/payment-reminder-class.js +15 -0
  157. package/dist/models/primary-bank-account-response-class.d.ts +54 -0
  158. package/dist/models/primary-bank-account-response-class.js +15 -0
  159. package/dist/models/refund-class.d.ts +18 -4
  160. package/dist/models/refund-class.js +3 -2
  161. package/dist/models/refund-item-class.d.ts +114 -0
  162. package/dist/models/refund-item-class.js +15 -0
  163. package/dist/models/sepa-direct-dto.d.ts +24 -0
  164. package/dist/models/sepa-direct-dto.js +15 -0
  165. package/dist/models/set-primary-bank-account-request-dto-rest.d.ts +24 -0
  166. package/dist/models/set-primary-bank-account-request-dto-rest.js +15 -0
  167. package/dist/models/shared-transaction-class.d.ts +72 -0
  168. package/dist/models/shared-transaction-class.js +15 -0
  169. package/dist/models/symphony-profile-limited-response-dto.d.ts +42 -0
  170. package/dist/models/symphony-profile-limited-response-dto.js +15 -0
  171. package/dist/models/{tenant-bank-account-response-class.d.ts → tenant-bank-account-class-without-expand-properties.d.ts} +23 -11
  172. package/dist/models/tenant-bank-account-class-without-expand-properties.js +15 -0
  173. package/dist/models/tenant-bank-account-class.d.ts +85 -0
  174. package/dist/models/tenant-bank-account-class.js +15 -0
  175. package/dist/models/unlink-bank-transaction-request-dto-rest.d.ts +2 -2
  176. package/dist/models/unlink-bank-transaction-request-dto-rest.js +1 -1
  177. package/dist/models/unlink-bank-transactions-response-class.d.ts +25 -0
  178. package/dist/models/unlink-bank-transactions-response-class.js +15 -0
  179. package/dist/models/unlinked-bank-transaction-response-class.d.ts +108 -0
  180. package/dist/models/unlinked-bank-transaction-response-class.js +15 -0
  181. package/dist/models/update-bank-account-request-dto-rest.d.ts +30 -0
  182. package/dist/models/update-bank-account-request-dto-rest.js +15 -0
  183. package/dist/models/update-bank-account-request-dto.d.ts +36 -0
  184. package/dist/models/update-bank-account-request-dto.js +15 -0
  185. package/dist/models/update-bank-account-response-class.d.ts +25 -0
  186. package/dist/models/update-bank-account-response-class.js +15 -0
  187. package/dist/models/update-tenant-bank-account-response-class.d.ts +25 -0
  188. package/dist/models/update-tenant-bank-account-response-class.js +15 -0
  189. package/dist/models/update-tenant-bank-account-rest-request-dto.d.ts +1 -1
  190. package/dist/models/update-tenant-bank-account-rest-request-dto.js +1 -1
  191. package/dist/models/validate-pspconfig-request-dto.d.ts +9 -2
  192. package/dist/models/validate-pspconfig-request-dto.js +8 -1
  193. package/index.ts +1 -1
  194. package/models/bank-account-class-without-expand-properties.ts +90 -0
  195. package/models/bank-account-class.ts +97 -0
  196. package/models/bank-transaction-class-without-expand-properties.ts +132 -0
  197. package/models/{bank-transaction-response-class.ts → bank-transaction-class.ts} +41 -29
  198. package/models/billing-profile-dto.ts +44 -0
  199. package/models/billing-profile-limited-response-dto.ts +60 -0
  200. package/models/complete-braintree-payment-setup-request-dto.ts +54 -0
  201. package/models/complete-payment-setup-request-dto.ts +38 -0
  202. package/models/complete-payment-setup-response-class.ts +31 -0
  203. package/models/complete-stripe-payment-setup-request-dto.ts +86 -0
  204. package/models/create-bank-account-request-dto.ts +48 -0
  205. package/models/create-bank-account-response-class.ts +31 -0
  206. package/models/create-payment-method-response-class.ts +31 -0
  207. package/models/create-payment-reminder-request-dto.ts +1 -1
  208. package/models/create-payment-reminder-response-class.ts +31 -0
  209. package/models/create-payment-request-dto.ts +4 -4
  210. package/models/create-payment-response-class.ts +31 -0
  211. package/models/create-psp-payment-method-request-dto.ts +70 -0
  212. package/models/create-refund-request-dto.ts +1 -1
  213. package/models/create-refund-response-class.ts +1 -1
  214. package/models/create-tenant-bank-account-request-dto.ts +1 -1
  215. package/models/create-tenant-bank-account-response-class.ts +31 -0
  216. package/models/deactivate-payment-reminder-request-dto.ts +1 -1
  217. package/models/deactivate-payment-reminder-response-class.ts +31 -0
  218. package/models/deactivated-payment-reminder-class.ts +108 -0
  219. package/models/get-bank-account-response-class.ts +31 -0
  220. package/models/get-bank-transactions-response-class.ts +4 -4
  221. package/models/get-payment-method-response-class.ts +31 -0
  222. package/models/get-payment-reminder-response-class.ts +31 -0
  223. package/models/get-payment-response-class.ts +31 -0
  224. package/models/get-refund-response-class.ts +1 -1
  225. package/models/get-tenant-bank-account-response-class.ts +5 -5
  226. package/models/import-bank-transactions-response-class.ts +31 -0
  227. package/models/index.ts +54 -4
  228. package/models/initiate-braintree-payment-setup-request-dto.ts +36 -0
  229. package/models/initiate-braintree-payment-setup-response-class.ts +30 -0
  230. package/models/initiate-payment-setup-request-dto.ts +50 -0
  231. package/models/initiate-payment-setup-response-class.ts +38 -0
  232. package/models/initiate-stripe-payment-setup-request-dto.ts +36 -0
  233. package/models/initiate-stripe-payment-setup-response-class.ts +36 -0
  234. package/models/inline-response200.ts +1 -1
  235. package/models/inline-response503.ts +1 -1
  236. package/models/link-bank-transaction-request-dto-rest.ts +1 -1
  237. package/models/link-bank-transactions-response-class.ts +31 -0
  238. package/models/list-bank-accounts-response-class.ts +37 -0
  239. package/models/list-bank-transactions-response-class.ts +6 -6
  240. package/models/list-payment-methods-response-class.ts +37 -0
  241. package/models/list-payment-reminders-response-class.ts +37 -0
  242. package/models/list-payments-response-class.ts +37 -0
  243. package/models/list-refunds-response-class.ts +3 -3
  244. package/models/list-tenant-bank-account-response-class.ts +37 -0
  245. package/models/payment-class-without-expand-properties.ts +114 -0
  246. package/models/payment-class.ts +121 -0
  247. package/models/payment-method-class.ts +84 -0
  248. package/models/payment-reminder-class.ts +108 -0
  249. package/models/primary-bank-account-response-class.ts +60 -0
  250. package/models/refund-class.ts +19 -5
  251. package/models/refund-item-class.ts +120 -0
  252. package/models/sepa-direct-dto.ts +30 -0
  253. package/models/set-primary-bank-account-request-dto-rest.ts +30 -0
  254. package/models/shared-transaction-class.ts +78 -0
  255. package/models/symphony-profile-limited-response-dto.ts +48 -0
  256. package/models/{tenant-bank-account-response-class.ts → tenant-bank-account-class-without-expand-properties.ts} +23 -11
  257. package/models/tenant-bank-account-class.ts +91 -0
  258. package/models/unlink-bank-transaction-request-dto-rest.ts +2 -2
  259. package/models/unlink-bank-transactions-response-class.ts +31 -0
  260. package/models/unlinked-bank-transaction-response-class.ts +114 -0
  261. package/models/update-bank-account-request-dto-rest.ts +36 -0
  262. package/models/update-bank-account-request-dto.ts +42 -0
  263. package/models/update-bank-account-response-class.ts +31 -0
  264. package/models/update-tenant-bank-account-response-class.ts +31 -0
  265. package/models/update-tenant-bank-account-rest-request-dto.ts +1 -1
  266. package/models/validate-pspconfig-request-dto.ts +12 -2
  267. package/package.json +1 -1
  268. package/dist/api/default-api.d.ts +0 -66
  269. package/dist/models/get-request-dto.d.ts +0 -30
  270. package/dist/models/transaction-class.d.ts +0 -54
  271. package/models/get-request-dto.ts +0 -36
  272. package/models/transaction-class.ts +0 -60
@@ -1,6 +1,6 @@
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
6
  * Contact: kontakt@emil.de
@@ -13,7 +13,11 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreatePaymentReminderRequestDto } from '../models';
16
+ import { CreatePaymentReminderResponseClass } from '../models';
16
17
  import { DeactivatePaymentReminderRequestDto } from '../models';
18
+ import { DeactivatePaymentReminderResponseClass } from '../models';
19
+ import { GetPaymentReminderResponseClass } from '../models';
20
+ import { ListPaymentRemindersResponseClass } from '../models';
17
21
  /**
18
22
  * PaymentRemindersApi - axios parameter creator
19
23
  * @export
@@ -21,7 +25,7 @@ import { DeactivatePaymentReminderRequestDto } from '../models';
21
25
  export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Configuration) => {
22
26
  /**
23
27
  * This will create a payment reminder in the database.
24
- * @summary Create the payment-reminder
28
+ * @summary Create the payment reminder
25
29
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
26
30
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
27
31
  * @param {*} [options] Override http request option.
@@ -29,8 +33,8 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
29
33
  */
30
34
  createPaymentReminder: (createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
35
  /**
32
- * Deactivates the payment reminder
33
- * @summary Update the payment-reminder
36
+ * This will deactivate the payment reminder
37
+ * @summary Deactivate payment reminder
34
38
  * @param {string} code Unique identifier for the object.
35
39
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
36
40
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -39,29 +43,26 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
39
43
  */
40
44
  deactivatePaymentReminder: (code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
45
  /**
42
- * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
46
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
43
47
  * @summary Retrieve the payment reminder
44
- * @param {string} code Unique identifier for the object.
48
+ * @param {string} code
45
49
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
46
50
  * @param {*} [options] Override http request option.
47
51
  * @throws {RequiredError}
48
52
  */
49
53
  getPolicy: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
54
  /**
51
- * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
55
+ * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
52
56
  * @summary List payment reminders
53
57
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
54
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
55
- * @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.
56
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
57
- * @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.
58
- * @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.
59
- * @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.
60
- * @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.
58
+ * @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, policyCode, nextReminderDate&lt;/i&gt;
59
+ * @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, policyCode, nextReminderDate&lt;/i&gt;
60
+ * @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, updatedAt&lt;/i&gt;
61
+ * @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: &lt;i&gt;
61
62
  * @param {*} [options] Override http request option.
62
63
  * @throws {RequiredError}
63
64
  */
64
- listPaymentReminders: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
+ listPaymentReminders: (authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
66
  };
66
67
  /**
67
68
  * PaymentRemindersApi - functional programming interface
@@ -70,47 +71,44 @@ export declare const PaymentRemindersApiAxiosParamCreator: (configuration?: Conf
70
71
  export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
71
72
  /**
72
73
  * This will create a payment reminder in the database.
73
- * @summary Create the payment-reminder
74
+ * @summary Create the payment reminder
74
75
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
75
76
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
76
77
  * @param {*} [options] Override http request option.
77
78
  * @throws {RequiredError}
78
79
  */
79
- createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
80
+ createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePaymentReminderResponseClass>>;
80
81
  /**
81
- * Deactivates the payment reminder
82
- * @summary Update the payment-reminder
82
+ * This will deactivate the payment reminder
83
+ * @summary Deactivate payment reminder
83
84
  * @param {string} code Unique identifier for the object.
84
85
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
85
86
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
86
87
  * @param {*} [options] Override http request option.
87
88
  * @throws {RequiredError}
88
89
  */
89
- deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
90
+ deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeactivatePaymentReminderResponseClass>>;
90
91
  /**
91
- * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
92
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
92
93
  * @summary Retrieve the payment reminder
93
- * @param {string} code Unique identifier for the object.
94
+ * @param {string} code
94
95
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
95
96
  * @param {*} [options] Override http request option.
96
97
  * @throws {RequiredError}
97
98
  */
98
- getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
99
+ getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPaymentReminderResponseClass>>;
99
100
  /**
100
- * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
101
+ * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
101
102
  * @summary List payment reminders
102
103
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
103
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
104
- * @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.
105
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
106
- * @param {any} [search] 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.
107
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
108
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
109
- * @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.
104
+ * @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, policyCode, nextReminderDate&lt;/i&gt;
105
+ * @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, policyCode, nextReminderDate&lt;/i&gt;
106
+ * @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, updatedAt&lt;/i&gt;
107
+ * @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: &lt;i&gt;
110
108
  * @param {*} [options] Override http request option.
111
109
  * @throws {RequiredError}
112
110
  */
113
- listPaymentReminders(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>>;
111
+ listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentRemindersResponseClass>>;
114
112
  };
115
113
  /**
116
114
  * PaymentRemindersApi - factory interface
@@ -119,47 +117,44 @@ export declare const PaymentRemindersApiFp: (configuration?: Configuration) => {
119
117
  export declare const PaymentRemindersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
120
118
  /**
121
119
  * This will create a payment reminder in the database.
122
- * @summary Create the payment-reminder
120
+ * @summary Create the payment reminder
123
121
  * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
124
122
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
125
123
  * @param {*} [options] Override http request option.
126
124
  * @throws {RequiredError}
127
125
  */
128
- createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
126
+ createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePaymentReminderResponseClass>;
129
127
  /**
130
- * Deactivates the payment reminder
131
- * @summary Update the payment-reminder
128
+ * This will deactivate the payment reminder
129
+ * @summary Deactivate payment reminder
132
130
  * @param {string} code Unique identifier for the object.
133
131
  * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
134
132
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
133
  * @param {*} [options] Override http request option.
136
134
  * @throws {RequiredError}
137
135
  */
138
- deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
136
+ deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<DeactivatePaymentReminderResponseClass>;
139
137
  /**
140
- * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
138
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
141
139
  * @summary Retrieve the payment reminder
142
- * @param {string} code Unique identifier for the object.
140
+ * @param {string} code
143
141
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
144
142
  * @param {*} [options] Override http request option.
145
143
  * @throws {RequiredError}
146
144
  */
147
- getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<void>;
145
+ getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<GetPaymentReminderResponseClass>;
148
146
  /**
149
- * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
147
+ * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
150
148
  * @summary List payment reminders
151
149
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
152
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
153
- * @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.
154
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
155
- * @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.
156
- * @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.
157
- * @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.
158
- * @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.
150
+ * @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, policyCode, nextReminderDate&lt;/i&gt;
151
+ * @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, policyCode, nextReminderDate&lt;/i&gt;
152
+ * @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, updatedAt&lt;/i&gt;
153
+ * @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: &lt;i&gt;
159
154
  * @param {*} [options] Override http request option.
160
155
  * @throws {RequiredError}
161
156
  */
162
- listPaymentReminders(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<void>;
157
+ listPaymentReminders(authorization?: string, filter?: string, filters?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPaymentRemindersResponseClass>;
163
158
  };
164
159
  /**
165
160
  * Request parameters for createPaymentReminder operation in PaymentRemindersApi.
@@ -212,7 +207,7 @@ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
212
207
  */
213
208
  export interface PaymentRemindersApiGetPolicyRequest {
214
209
  /**
215
- * Unique identifier for the object.
210
+ *
216
211
  * @type {string}
217
212
  * @memberof PaymentRemindersApiGetPolicy
218
213
  */
@@ -237,47 +232,29 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
237
232
  */
238
233
  readonly authorization?: string;
239
234
  /**
240
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
241
- * @type {any}
242
- * @memberof PaymentRemindersApiListPaymentReminders
243
- */
244
- readonly pageSize?: any;
245
- /**
246
- * 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.
247
- * @type {any}
248
- * @memberof PaymentRemindersApiListPaymentReminders
249
- */
250
- readonly pageToken?: any;
251
- /**
252
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
253
- * @type {any}
254
- * @memberof PaymentRemindersApiListPaymentReminders
255
- */
256
- readonly filter?: any;
257
- /**
258
- * 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.
259
- * @type {any}
235
+ * 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, policyCode, nextReminderDate&lt;/i&gt;
236
+ * @type {string}
260
237
  * @memberof PaymentRemindersApiListPaymentReminders
261
238
  */
262
- readonly search?: any;
239
+ readonly filter?: string;
263
240
  /**
264
- * 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.
265
- * @type {any}
241
+ * 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, policyCode, nextReminderDate&lt;/i&gt;
242
+ * @type {string}
266
243
  * @memberof PaymentRemindersApiListPaymentReminders
267
244
  */
268
- readonly order?: any;
245
+ readonly filters?: string;
269
246
  /**
270
- * 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.
271
- * @type {any}
247
+ * 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, updatedAt&lt;/i&gt;
248
+ * @type {string}
272
249
  * @memberof PaymentRemindersApiListPaymentReminders
273
250
  */
274
- readonly expand?: any;
251
+ readonly order?: string;
275
252
  /**
276
- * 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.
277
- * @type {any}
253
+ * 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: &lt;i&gt;
254
+ * @type {string}
278
255
  * @memberof PaymentRemindersApiListPaymentReminders
279
256
  */
280
- readonly filters?: any;
257
+ readonly expand?: string;
281
258
  }
282
259
  /**
283
260
  * PaymentRemindersApi - object-oriented interface
@@ -288,38 +265,38 @@ export interface PaymentRemindersApiListPaymentRemindersRequest {
288
265
  export declare class PaymentRemindersApi extends BaseAPI {
289
266
  /**
290
267
  * This will create a payment reminder in the database.
291
- * @summary Create the payment-reminder
268
+ * @summary Create the payment reminder
292
269
  * @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
293
270
  * @param {*} [options] Override http request option.
294
271
  * @throws {RequiredError}
295
272
  * @memberof PaymentRemindersApi
296
273
  */
297
- createPaymentReminder(requestParameters: PaymentRemindersApiCreatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
274
+ createPaymentReminder(requestParameters: PaymentRemindersApiCreatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePaymentReminderResponseClass, any>>;
298
275
  /**
299
- * Deactivates the payment reminder
300
- * @summary Update the payment-reminder
276
+ * This will deactivate the payment reminder
277
+ * @summary Deactivate payment reminder
301
278
  * @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
302
279
  * @param {*} [options] Override http request option.
303
280
  * @throws {RequiredError}
304
281
  * @memberof PaymentRemindersApi
305
282
  */
306
- deactivatePaymentReminder(requestParameters: PaymentRemindersApiDeactivatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
283
+ deactivatePaymentReminder(requestParameters: PaymentRemindersApiDeactivatePaymentReminderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeactivatePaymentReminderResponseClass, any>>;
307
284
  /**
308
- * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
285
+ * Retrieves the details of the payment reminder that was previously created. Supply the unique payment reminder code that was returned when you created it and Emil Api will return the corresponding payment reminder information.
309
286
  * @summary Retrieve the payment reminder
310
287
  * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
311
288
  * @param {*} [options] Override http request option.
312
289
  * @throws {RequiredError}
313
290
  * @memberof PaymentRemindersApi
314
291
  */
315
- getPolicy(requestParameters: PaymentRemindersApiGetPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
292
+ getPolicy(requestParameters: PaymentRemindersApiGetPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPaymentReminderResponseClass, any>>;
316
293
  /**
317
- * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
294
+ * Returns a list of payment reminders you have previously created. The payment reminders are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
318
295
  * @summary List payment reminders
319
296
  * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
320
297
  * @param {*} [options] Override http request option.
321
298
  * @throws {RequiredError}
322
299
  * @memberof PaymentRemindersApi
323
300
  */
324
- listPaymentReminders(requestParameters?: PaymentRemindersApiListPaymentRemindersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
301
+ listPaymentReminders(requestParameters?: PaymentRemindersApiListPaymentRemindersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPaymentRemindersResponseClass, any>>;
325
302
  }