@emilgroup/payment-sdk 1.0.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 (160) hide show
  1. package/.openapi-generator/FILES +58 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +51 -0
  5. package/api/bank-accounts-api.ts +337 -0
  6. package/api/default-api.ts +120 -0
  7. package/api/payment-methods-api.ts +577 -0
  8. package/api/payment-reminders-api.ts +556 -0
  9. package/api/payment-service-providers-api.ts +161 -0
  10. package/api/payment-setup-api.ts +264 -0
  11. package/api/payments-api.ts +489 -0
  12. package/api/webhooks-api.ts +150 -0
  13. package/api.ts +41 -0
  14. package/base.ts +251 -0
  15. package/common.ts +198 -0
  16. package/configuration.ts +101 -0
  17. package/dist/api/bank-accounts-api.d.ts +197 -0
  18. package/dist/api/bank-accounts-api.js +347 -0
  19. package/dist/api/default-api.d.ts +66 -0
  20. package/dist/api/default-api.js +196 -0
  21. package/dist/api/payment-methods-api.d.ts +327 -0
  22. package/dist/api/payment-methods-api.js +547 -0
  23. package/dist/api/payment-reminders-api.d.ts +317 -0
  24. package/dist/api/payment-reminders-api.js +538 -0
  25. package/dist/api/payment-service-providers-api.d.ts +93 -0
  26. package/dist/api/payment-service-providers-api.js +220 -0
  27. package/dist/api/payment-setup-api.d.ts +146 -0
  28. package/dist/api/payment-setup-api.js +309 -0
  29. package/dist/api/payments-api.d.ts +281 -0
  30. package/dist/api/payments-api.js +461 -0
  31. package/dist/api/webhooks-api.d.ts +91 -0
  32. package/dist/api/webhooks-api.js +209 -0
  33. package/dist/api.d.ts +19 -0
  34. package/dist/api.js +37 -0
  35. package/dist/base.d.ts +74 -0
  36. package/dist/base.js +298 -0
  37. package/dist/common.d.ts +91 -0
  38. package/dist/common.js +276 -0
  39. package/dist/configuration.d.ts +83 -0
  40. package/dist/configuration.js +44 -0
  41. package/dist/index.d.ts +15 -0
  42. package/dist/index.js +36 -0
  43. package/dist/models/bank-account-class.d.ts +54 -0
  44. package/dist/models/bank-account-class.js +15 -0
  45. package/dist/models/billing-profile-dto.d.ts +38 -0
  46. package/dist/models/billing-profile-dto.js +15 -0
  47. package/dist/models/billing-profile-limited-response-dto.d.ts +54 -0
  48. package/dist/models/billing-profile-limited-response-dto.js +15 -0
  49. package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +48 -0
  50. package/dist/models/complete-braintree-payment-setup-request-dto.js +15 -0
  51. package/dist/models/complete-payment-setup-request-dto.d.ts +32 -0
  52. package/dist/models/complete-payment-setup-request-dto.js +15 -0
  53. package/dist/models/complete-payment-setup-response-class.d.ts +25 -0
  54. package/dist/models/complete-payment-setup-response-class.js +15 -0
  55. package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +60 -0
  56. package/dist/models/complete-stripe-payment-setup-request-dto.js +15 -0
  57. package/dist/models/create-bank-account-request-dto.d.ts +30 -0
  58. package/dist/models/create-bank-account-request-dto.js +15 -0
  59. package/dist/models/create-payment-method-response-class.d.ts +25 -0
  60. package/dist/models/create-payment-method-response-class.js +15 -0
  61. package/dist/models/create-payment-reminder-request-dto.d.ts +65 -0
  62. package/dist/models/create-payment-reminder-request-dto.js +26 -0
  63. package/dist/models/create-payment-request-dto.d.ts +72 -0
  64. package/dist/models/create-payment-request-dto.js +15 -0
  65. package/dist/models/create-payment-response-class.d.ts +25 -0
  66. package/dist/models/create-payment-response-class.js +15 -0
  67. package/dist/models/create-psp-payment-method-request-dto.d.ts +61 -0
  68. package/dist/models/create-psp-payment-method-request-dto.js +32 -0
  69. package/dist/models/deactivate-payment-reminder-request-dto.d.ts +30 -0
  70. package/dist/models/deactivate-payment-reminder-request-dto.js +21 -0
  71. package/dist/models/get-payment-method-response-class.d.ts +25 -0
  72. package/dist/models/get-payment-method-response-class.js +15 -0
  73. package/dist/models/get-payment-response-class.d.ts +25 -0
  74. package/dist/models/get-payment-response-class.js +15 -0
  75. package/dist/models/get-request-dto.d.ts +30 -0
  76. package/dist/models/get-request-dto.js +15 -0
  77. package/dist/models/index.d.ts +37 -0
  78. package/dist/models/index.js +53 -0
  79. package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +30 -0
  80. package/dist/models/initiate-braintree-payment-setup-request-dto.js +15 -0
  81. package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +24 -0
  82. package/dist/models/initiate-braintree-payment-setup-response-class.js +15 -0
  83. package/dist/models/initiate-payment-setup-request-dto.d.ts +44 -0
  84. package/dist/models/initiate-payment-setup-request-dto.js +15 -0
  85. package/dist/models/initiate-payment-setup-response-class.d.ts +32 -0
  86. package/dist/models/initiate-payment-setup-response-class.js +15 -0
  87. package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +30 -0
  88. package/dist/models/initiate-stripe-payment-setup-request-dto.js +15 -0
  89. package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +30 -0
  90. package/dist/models/initiate-stripe-payment-setup-response-class.js +15 -0
  91. package/dist/models/inline-response200.d.ts +54 -0
  92. package/dist/models/inline-response200.js +15 -0
  93. package/dist/models/inline-response503.d.ts +54 -0
  94. package/dist/models/inline-response503.js +15 -0
  95. package/dist/models/list-bank-accounts-response-class.d.ts +31 -0
  96. package/dist/models/list-bank-accounts-response-class.js +15 -0
  97. package/dist/models/list-payment-methods-response-class.d.ts +31 -0
  98. package/dist/models/list-payment-methods-response-class.js +15 -0
  99. package/dist/models/list-payment-reminders-response-class.d.ts +31 -0
  100. package/dist/models/list-payment-reminders-response-class.js +15 -0
  101. package/dist/models/list-payments-response-class.d.ts +31 -0
  102. package/dist/models/list-payments-response-class.js +15 -0
  103. package/dist/models/payment-class.d.ts +103 -0
  104. package/dist/models/payment-class.js +15 -0
  105. package/dist/models/payment-method-class.d.ts +60 -0
  106. package/dist/models/payment-method-class.js +15 -0
  107. package/dist/models/payment-reminder-class.d.ts +112 -0
  108. package/dist/models/payment-reminder-class.js +36 -0
  109. package/dist/models/sepa-direct-dto.d.ts +24 -0
  110. package/dist/models/sepa-direct-dto.js +15 -0
  111. package/dist/models/symphony-profile-limited-response-dto.d.ts +42 -0
  112. package/dist/models/symphony-profile-limited-response-dto.js +15 -0
  113. package/dist/models/transaction-class.d.ts +54 -0
  114. package/dist/models/transaction-class.js +15 -0
  115. package/dist/models/validate-pspconfig-request-dto.d.ts +43 -0
  116. package/dist/models/validate-pspconfig-request-dto.js +22 -0
  117. package/dist/models/validate-pspconfig-response-class.d.ts +24 -0
  118. package/dist/models/validate-pspconfig-response-class.js +15 -0
  119. package/git_push.sh +57 -0
  120. package/index.ts +19 -0
  121. package/models/bank-account-class.ts +60 -0
  122. package/models/billing-profile-dto.ts +44 -0
  123. package/models/billing-profile-limited-response-dto.ts +60 -0
  124. package/models/complete-braintree-payment-setup-request-dto.ts +54 -0
  125. package/models/complete-payment-setup-request-dto.ts +38 -0
  126. package/models/complete-payment-setup-response-class.ts +31 -0
  127. package/models/complete-stripe-payment-setup-request-dto.ts +66 -0
  128. package/models/create-bank-account-request-dto.ts +36 -0
  129. package/models/create-payment-method-response-class.ts +31 -0
  130. package/models/create-payment-reminder-request-dto.ts +74 -0
  131. package/models/create-payment-request-dto.ts +78 -0
  132. package/models/create-payment-response-class.ts +31 -0
  133. package/models/create-psp-payment-method-request-dto.ts +70 -0
  134. package/models/deactivate-payment-reminder-request-dto.ts +39 -0
  135. package/models/get-payment-method-response-class.ts +31 -0
  136. package/models/get-payment-response-class.ts +31 -0
  137. package/models/get-request-dto.ts +36 -0
  138. package/models/index.ts +37 -0
  139. package/models/initiate-braintree-payment-setup-request-dto.ts +36 -0
  140. package/models/initiate-braintree-payment-setup-response-class.ts +30 -0
  141. package/models/initiate-payment-setup-request-dto.ts +50 -0
  142. package/models/initiate-payment-setup-response-class.ts +38 -0
  143. package/models/initiate-stripe-payment-setup-request-dto.ts +36 -0
  144. package/models/initiate-stripe-payment-setup-response-class.ts +36 -0
  145. package/models/inline-response200.ts +48 -0
  146. package/models/inline-response503.ts +48 -0
  147. package/models/list-bank-accounts-response-class.ts +37 -0
  148. package/models/list-payment-methods-response-class.ts +37 -0
  149. package/models/list-payment-reminders-response-class.ts +37 -0
  150. package/models/list-payments-response-class.ts +37 -0
  151. package/models/payment-class.ts +109 -0
  152. package/models/payment-method-class.ts +66 -0
  153. package/models/payment-reminder-class.ts +122 -0
  154. package/models/sepa-direct-dto.ts +30 -0
  155. package/models/symphony-profile-limited-response-dto.ts +48 -0
  156. package/models/transaction-class.ts +60 -0
  157. package/models/validate-pspconfig-request-dto.ts +52 -0
  158. package/models/validate-pspconfig-response-class.ts +30 -0
  159. package/package.json +27 -0
  160. package/tsconfig.json +22 -0
@@ -0,0 +1,556 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil Payment Service
5
+ * 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.
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { CreatePaymentReminderRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { DeactivatePaymentReminderRequestDto } from '../models';
27
+ // @ts-ignore
28
+ import { ListPaymentRemindersResponseClass } from '../models';
29
+ /**
30
+ * PaymentRemindersApi - axios parameter creator
31
+ * @export
32
+ */
33
+ export const PaymentRemindersApiAxiosParamCreator = function (configuration?: Configuration) {
34
+ return {
35
+ /**
36
+ * This will create a payment reminder in the database.
37
+ * @summary Create the payment-reminder
38
+ * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
39
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ createPaymentReminder: async (createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
44
+ // verify required parameter 'createPaymentReminderRequestDto' is not null or undefined
45
+ assertParamExists('createPaymentReminder', 'createPaymentReminderRequestDto', createPaymentReminderRequestDto)
46
+ const localVarPath = `/paymentservice/v1/payment-reminders`;
47
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
48
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
49
+ let baseOptions;
50
+ let baseAccessToken;
51
+ if (configuration) {
52
+ baseOptions = configuration.baseOptions;
53
+ baseAccessToken = configuration.accessToken;
54
+ }
55
+
56
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
57
+ const localVarHeaderParameter = {} as any;
58
+ const localVarQueryParameter = {} as any;
59
+
60
+ // authentication bearer required
61
+ // http bearer authentication required
62
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
63
+
64
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
65
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
66
+ }
67
+
68
+
69
+
70
+ localVarHeaderParameter['Content-Type'] = 'application/json';
71
+
72
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
73
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
74
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
75
+ localVarRequestOptions.data = serializeDataIfNeeded(createPaymentReminderRequestDto, localVarRequestOptions, configuration)
76
+
77
+ return {
78
+ url: toPathString(localVarUrlObj),
79
+ options: localVarRequestOptions,
80
+ };
81
+ },
82
+ /**
83
+ * Updates the specified payment-reminder by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
84
+ * @summary Update the payment-reminder
85
+ * @param {string} code Unique identifier for the object.
86
+ * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
87
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ deactivatePaymentReminder: async (code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
92
+ // verify required parameter 'code' is not null or undefined
93
+ assertParamExists('deactivatePaymentReminder', 'code', code)
94
+ // verify required parameter 'deactivatePaymentReminderRequestDto' is not null or undefined
95
+ assertParamExists('deactivatePaymentReminder', 'deactivatePaymentReminderRequestDto', deactivatePaymentReminderRequestDto)
96
+ const localVarPath = `/paymentservice/v1/payment-reminders/{code}/deactivate`
97
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
98
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
99
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
100
+ let baseOptions;
101
+ let baseAccessToken;
102
+ if (configuration) {
103
+ baseOptions = configuration.baseOptions;
104
+ baseAccessToken = configuration.accessToken;
105
+ }
106
+
107
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
108
+ const localVarHeaderParameter = {} as any;
109
+ const localVarQueryParameter = {} as any;
110
+
111
+ // authentication bearer required
112
+ // http bearer authentication required
113
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
114
+
115
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
116
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
117
+ }
118
+
119
+
120
+
121
+ localVarHeaderParameter['Content-Type'] = 'application/json';
122
+
123
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
124
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
125
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
126
+ localVarRequestOptions.data = serializeDataIfNeeded(deactivatePaymentReminderRequestDto, localVarRequestOptions, configuration)
127
+
128
+ return {
129
+ url: toPathString(localVarUrlObj),
130
+ options: localVarRequestOptions,
131
+ };
132
+ },
133
+ /**
134
+ * 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.
135
+ * @summary Retrieve the payment reminder
136
+ * @param {string} code Unique identifier for the object.
137
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ */
141
+ getPolicy: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
142
+ // verify required parameter 'code' is not null or undefined
143
+ assertParamExists('getPolicy', 'code', code)
144
+ const localVarPath = `/paymentservice/v1/payment-reminders/{code}`
145
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
146
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
147
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
148
+ let baseOptions;
149
+ let baseAccessToken;
150
+ if (configuration) {
151
+ baseOptions = configuration.baseOptions;
152
+ baseAccessToken = configuration.accessToken;
153
+ }
154
+
155
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
156
+ const localVarHeaderParameter = {} as any;
157
+ const localVarQueryParameter = {} as any;
158
+
159
+ // authentication bearer required
160
+ // http bearer authentication required
161
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
162
+
163
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
164
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
165
+ }
166
+
167
+
168
+
169
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
170
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
171
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
172
+
173
+ return {
174
+ url: toPathString(localVarUrlObj),
175
+ options: localVarRequestOptions,
176
+ };
177
+ },
178
+ /**
179
+ * 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.
180
+ * @summary List payment reminders
181
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
182
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
183
+ * @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.
184
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
185
+ * @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.
186
+ * @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.
187
+ * @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.
188
+ * @param {*} [options] Override http request option.
189
+ * @throws {RequiredError}
190
+ */
191
+ listPaymentReminders: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
192
+ const localVarPath = `/paymentservice/v1/payment-reminders`;
193
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
194
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
195
+ let baseOptions;
196
+ let baseAccessToken;
197
+ if (configuration) {
198
+ baseOptions = configuration.baseOptions;
199
+ baseAccessToken = configuration.accessToken;
200
+ }
201
+
202
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
203
+ const localVarHeaderParameter = {} as any;
204
+ const localVarQueryParameter = {} as any;
205
+
206
+ // authentication bearer required
207
+ // http bearer authentication required
208
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
209
+
210
+ if (pageSize !== undefined) {
211
+ localVarQueryParameter['pageSize'] = pageSize;
212
+ }
213
+
214
+ if (pageToken !== undefined) {
215
+ localVarQueryParameter['pageToken'] = pageToken;
216
+ }
217
+
218
+ if (filter !== undefined) {
219
+ localVarQueryParameter['filter'] = filter;
220
+ }
221
+
222
+ if (search !== undefined) {
223
+ localVarQueryParameter['search'] = search;
224
+ }
225
+
226
+ if (order !== undefined) {
227
+ localVarQueryParameter['order'] = order;
228
+ }
229
+
230
+ if (expand !== undefined) {
231
+ localVarQueryParameter['expand'] = expand;
232
+ }
233
+
234
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
235
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
236
+ }
237
+
238
+
239
+
240
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
241
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
242
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
243
+
244
+ return {
245
+ url: toPathString(localVarUrlObj),
246
+ options: localVarRequestOptions,
247
+ };
248
+ },
249
+ }
250
+ };
251
+
252
+ /**
253
+ * PaymentRemindersApi - functional programming interface
254
+ * @export
255
+ */
256
+ export const PaymentRemindersApiFp = function(configuration?: Configuration) {
257
+ const localVarAxiosParamCreator = PaymentRemindersApiAxiosParamCreator(configuration)
258
+ return {
259
+ /**
260
+ * This will create a payment reminder in the database.
261
+ * @summary Create the payment-reminder
262
+ * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
263
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
264
+ * @param {*} [options] Override http request option.
265
+ * @throws {RequiredError}
266
+ */
267
+ async createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
268
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createPaymentReminder(createPaymentReminderRequestDto, authorization, options);
269
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
270
+ },
271
+ /**
272
+ * Updates the specified payment-reminder by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
273
+ * @summary Update the payment-reminder
274
+ * @param {string} code Unique identifier for the object.
275
+ * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
276
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
277
+ * @param {*} [options] Override http request option.
278
+ * @throws {RequiredError}
279
+ */
280
+ async deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
281
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options);
282
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
283
+ },
284
+ /**
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.
286
+ * @summary Retrieve the payment reminder
287
+ * @param {string} code Unique identifier for the object.
288
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
289
+ * @param {*} [options] Override http request option.
290
+ * @throws {RequiredError}
291
+ */
292
+ async getPolicy(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>> {
293
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPolicy(code, authorization, options);
294
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
295
+ },
296
+ /**
297
+ * 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.
298
+ * @summary List payment reminders
299
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
300
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
301
+ * @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.
302
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
303
+ * @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.
304
+ * @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.
305
+ * @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.
306
+ * @param {*} [options] Override http request option.
307
+ * @throws {RequiredError}
308
+ */
309
+ async listPaymentReminders(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPaymentRemindersResponseClass>> {
310
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, options);
311
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
312
+ },
313
+ }
314
+ };
315
+
316
+ /**
317
+ * PaymentRemindersApi - factory interface
318
+ * @export
319
+ */
320
+ export const PaymentRemindersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
321
+ const localVarFp = PaymentRemindersApiFp(configuration)
322
+ return {
323
+ /**
324
+ * This will create a payment reminder in the database.
325
+ * @summary Create the payment-reminder
326
+ * @param {CreatePaymentReminderRequestDto} createPaymentReminderRequestDto
327
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
328
+ * @param {*} [options] Override http request option.
329
+ * @throws {RequiredError}
330
+ */
331
+ createPaymentReminder(createPaymentReminderRequestDto: CreatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
332
+ return localVarFp.createPaymentReminder(createPaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
333
+ },
334
+ /**
335
+ * Updates the specified payment-reminder by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
336
+ * @summary Update the payment-reminder
337
+ * @param {string} code Unique identifier for the object.
338
+ * @param {DeactivatePaymentReminderRequestDto} deactivatePaymentReminderRequestDto
339
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
340
+ * @param {*} [options] Override http request option.
341
+ * @throws {RequiredError}
342
+ */
343
+ deactivatePaymentReminder(code: string, deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto, authorization?: string, options?: any): AxiosPromise<object> {
344
+ return localVarFp.deactivatePaymentReminder(code, deactivatePaymentReminderRequestDto, authorization, options).then((request) => request(axios, basePath));
345
+ },
346
+ /**
347
+ * 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.
348
+ * @summary Retrieve the payment reminder
349
+ * @param {string} code Unique identifier for the object.
350
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
351
+ * @param {*} [options] Override http request option.
352
+ * @throws {RequiredError}
353
+ */
354
+ getPolicy(code: string, authorization?: string, options?: any): AxiosPromise<object> {
355
+ return localVarFp.getPolicy(code, authorization, options).then((request) => request(axios, basePath));
356
+ },
357
+ /**
358
+ * 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.
359
+ * @summary List payment reminders
360
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
361
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
362
+ * @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.
363
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
364
+ * @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.
365
+ * @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.
366
+ * @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.
367
+ * @param {*} [options] Override http request option.
368
+ * @throws {RequiredError}
369
+ */
370
+ listPaymentReminders(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListPaymentRemindersResponseClass> {
371
+ return localVarFp.listPaymentReminders(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
372
+ },
373
+ };
374
+ };
375
+
376
+ /**
377
+ * Request parameters for createPaymentReminder operation in PaymentRemindersApi.
378
+ * @export
379
+ * @interface PaymentRemindersApiCreatePaymentReminderRequest
380
+ */
381
+ export interface PaymentRemindersApiCreatePaymentReminderRequest {
382
+ /**
383
+ *
384
+ * @type {CreatePaymentReminderRequestDto}
385
+ * @memberof PaymentRemindersApiCreatePaymentReminder
386
+ */
387
+ readonly createPaymentReminderRequestDto: CreatePaymentReminderRequestDto
388
+
389
+ /**
390
+ * Bearer Token: provided by the login endpoint under the name accessToken.
391
+ * @type {string}
392
+ * @memberof PaymentRemindersApiCreatePaymentReminder
393
+ */
394
+ readonly authorization?: string
395
+ }
396
+
397
+ /**
398
+ * Request parameters for deactivatePaymentReminder operation in PaymentRemindersApi.
399
+ * @export
400
+ * @interface PaymentRemindersApiDeactivatePaymentReminderRequest
401
+ */
402
+ export interface PaymentRemindersApiDeactivatePaymentReminderRequest {
403
+ /**
404
+ * Unique identifier for the object.
405
+ * @type {string}
406
+ * @memberof PaymentRemindersApiDeactivatePaymentReminder
407
+ */
408
+ readonly code: string
409
+
410
+ /**
411
+ *
412
+ * @type {DeactivatePaymentReminderRequestDto}
413
+ * @memberof PaymentRemindersApiDeactivatePaymentReminder
414
+ */
415
+ readonly deactivatePaymentReminderRequestDto: DeactivatePaymentReminderRequestDto
416
+
417
+ /**
418
+ * Bearer Token: provided by the login endpoint under the name accessToken.
419
+ * @type {string}
420
+ * @memberof PaymentRemindersApiDeactivatePaymentReminder
421
+ */
422
+ readonly authorization?: string
423
+ }
424
+
425
+ /**
426
+ * Request parameters for getPolicy operation in PaymentRemindersApi.
427
+ * @export
428
+ * @interface PaymentRemindersApiGetPolicyRequest
429
+ */
430
+ export interface PaymentRemindersApiGetPolicyRequest {
431
+ /**
432
+ * Unique identifier for the object.
433
+ * @type {string}
434
+ * @memberof PaymentRemindersApiGetPolicy
435
+ */
436
+ readonly code: string
437
+
438
+ /**
439
+ * Bearer Token: provided by the login endpoint under the name accessToken.
440
+ * @type {string}
441
+ * @memberof PaymentRemindersApiGetPolicy
442
+ */
443
+ readonly authorization?: string
444
+ }
445
+
446
+ /**
447
+ * Request parameters for listPaymentReminders operation in PaymentRemindersApi.
448
+ * @export
449
+ * @interface PaymentRemindersApiListPaymentRemindersRequest
450
+ */
451
+ export interface PaymentRemindersApiListPaymentRemindersRequest {
452
+ /**
453
+ * Bearer Token: provided by the login endpoint under the name accessToken.
454
+ * @type {string}
455
+ * @memberof PaymentRemindersApiListPaymentReminders
456
+ */
457
+ readonly authorization?: string
458
+
459
+ /**
460
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
461
+ * @type {any}
462
+ * @memberof PaymentRemindersApiListPaymentReminders
463
+ */
464
+ readonly pageSize?: any
465
+
466
+ /**
467
+ * 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.
468
+ * @type {any}
469
+ * @memberof PaymentRemindersApiListPaymentReminders
470
+ */
471
+ readonly pageToken?: any
472
+
473
+ /**
474
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
475
+ * @type {any}
476
+ * @memberof PaymentRemindersApiListPaymentReminders
477
+ */
478
+ readonly filter?: any
479
+
480
+ /**
481
+ * 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.
482
+ * @type {any}
483
+ * @memberof PaymentRemindersApiListPaymentReminders
484
+ */
485
+ readonly search?: any
486
+
487
+ /**
488
+ * 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.
489
+ * @type {any}
490
+ * @memberof PaymentRemindersApiListPaymentReminders
491
+ */
492
+ readonly order?: any
493
+
494
+ /**
495
+ * 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.
496
+ * @type {any}
497
+ * @memberof PaymentRemindersApiListPaymentReminders
498
+ */
499
+ readonly expand?: any
500
+ }
501
+
502
+ /**
503
+ * PaymentRemindersApi - object-oriented interface
504
+ * @export
505
+ * @class PaymentRemindersApi
506
+ * @extends {BaseAPI}
507
+ */
508
+ export class PaymentRemindersApi extends BaseAPI {
509
+ /**
510
+ * This will create a payment reminder in the database.
511
+ * @summary Create the payment-reminder
512
+ * @param {PaymentRemindersApiCreatePaymentReminderRequest} requestParameters Request parameters.
513
+ * @param {*} [options] Override http request option.
514
+ * @throws {RequiredError}
515
+ * @memberof PaymentRemindersApi
516
+ */
517
+ public createPaymentReminder(requestParameters: PaymentRemindersApiCreatePaymentReminderRequest, options?: AxiosRequestConfig) {
518
+ return PaymentRemindersApiFp(this.configuration).createPaymentReminder(requestParameters.createPaymentReminderRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
519
+ }
520
+
521
+ /**
522
+ * Updates the specified payment-reminder by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
523
+ * @summary Update the payment-reminder
524
+ * @param {PaymentRemindersApiDeactivatePaymentReminderRequest} requestParameters Request parameters.
525
+ * @param {*} [options] Override http request option.
526
+ * @throws {RequiredError}
527
+ * @memberof PaymentRemindersApi
528
+ */
529
+ public deactivatePaymentReminder(requestParameters: PaymentRemindersApiDeactivatePaymentReminderRequest, options?: AxiosRequestConfig) {
530
+ return PaymentRemindersApiFp(this.configuration).deactivatePaymentReminder(requestParameters.code, requestParameters.deactivatePaymentReminderRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
531
+ }
532
+
533
+ /**
534
+ * 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.
535
+ * @summary Retrieve the payment reminder
536
+ * @param {PaymentRemindersApiGetPolicyRequest} requestParameters Request parameters.
537
+ * @param {*} [options] Override http request option.
538
+ * @throws {RequiredError}
539
+ * @memberof PaymentRemindersApi
540
+ */
541
+ public getPolicy(requestParameters: PaymentRemindersApiGetPolicyRequest, options?: AxiosRequestConfig) {
542
+ return PaymentRemindersApiFp(this.configuration).getPolicy(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
543
+ }
544
+
545
+ /**
546
+ * 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.
547
+ * @summary List payment reminders
548
+ * @param {PaymentRemindersApiListPaymentRemindersRequest} requestParameters Request parameters.
549
+ * @param {*} [options] Override http request option.
550
+ * @throws {RequiredError}
551
+ * @memberof PaymentRemindersApi
552
+ */
553
+ public listPaymentReminders(requestParameters: PaymentRemindersApiListPaymentRemindersRequest = {}, options?: AxiosRequestConfig) {
554
+ return PaymentRemindersApiFp(this.configuration).listPaymentReminders(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
555
+ }
556
+ }