@emilgroup/customer-sdk 1.56.1-beta.13 → 1.56.1-beta.15

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.
@@ -1,1529 +0,0 @@
1
- /**
2
- * EMIL CustomerService
3
- * The EMIL CustomerService API description
4
- *
5
- * The version of the OpenAPI document: 1.0
6
- * Contact: kontakt@emil.de
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
- import { Configuration } from '../configuration';
14
- import { RequestArgs, BaseAPI } from '../base';
15
- import { ChangeCustomerEmailRequestDto } from '../models';
16
- import { ChangePasswordRequestDto } from '../models';
17
- import { ChangePasswordResponseClass } from '../models';
18
- import { CompletePaymentSetupPspRequest } from '../models';
19
- import { CompletePaymentSetupResponseClass } from '../models';
20
- import { CreateCustomerRequestDto } from '../models';
21
- import { CreateCustomerResponseClass } from '../models';
22
- import { CreatePresignedPostResponseClass } from '../models';
23
- import { ForgotPasswordRequestDto } from '../models';
24
- import { GetCustomerDocumentDownloadUrlRequestDto } from '../models';
25
- import { GetCustomerDocumentDownloadUrlResponseClass } from '../models';
26
- import { GetCustomerResponseClass } from '../models';
27
- import { InitiateAuthRequestDto } from '../models';
28
- import { InitiateAuthResponseClass } from '../models';
29
- import { InitiatePaymentSetupRequestDto } from '../models';
30
- import { InitiatePaymentSetupResponseClass } from '../models';
31
- import { InviteByCustomerRequestDto } from '../models';
32
- import { InviteByCustomerResponseClass } from '../models';
33
- import { InviteByTenantRequestDto } from '../models';
34
- import { InviteByTenantResponseClass } from '../models';
35
- import { ListDocumentsResponseClass } from '../models';
36
- import { ListInvoicesResponseClass } from '../models';
37
- import { RefreshTokenDto } from '../models';
38
- import { RequestChangeEmailByCustomerRequestDto } from '../models';
39
- import { RequestChangeEmailByCustomerResponseClass } from '../models';
40
- import { ResetPasswordByCustomerRequestDto } from '../models';
41
- import { RespondToAuthChallengeClass } from '../models';
42
- import { RespondToAuthChallengeRequestDto } from '../models';
43
- import { UpdateCustomerRequestDto } from '../models';
44
- import { UpdateCustomerResponseClass } from '../models';
45
- import { UploadAccountDocumentsRequestDto } from '../models';
46
- import { VerifyChangeEmailTokenRequestDto } from '../models';
47
- import { VerifyChangeEmailTokenResponseClass } from '../models';
48
- import { VerifyCustomerInviteResponseClass } from '../models';
49
- import { VerifyResetPasswordTokenResponseClass } from '../models';
50
- /**
51
- * CustomerControllerRestApi - axios parameter creator
52
- * @export
53
- */
54
- export declare const CustomerControllerRestApiAxiosParamCreator: (configuration?: Configuration) => {
55
- /**
56
- * Change customer\'s email using the token provided by the request email change endpoint.
57
- * @summary Change customer email
58
- * @param {ChangeCustomerEmailRequestDto} changeCustomerEmailRequestDto
59
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
60
- * @param {*} [options] Override http request option.
61
- * @throws {RequiredError}
62
- */
63
- changeCustomerEmail: (changeCustomerEmailRequestDto: ChangeCustomerEmailRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
- /**
65
- * Change the customer password. Please use forgot-password endpoint if current password is lost.
66
- * @summary Change customer password
67
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
68
- * @param {ChangePasswordRequestDto} changePasswordRequestDto
69
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
70
- * @param {*} [options] Override http request option.
71
- * @throws {RequiredError}
72
- */
73
- changePassword: (customerCode: string, changePasswordRequestDto: ChangePasswordRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
- /**
75
- * Request to complete a payment change by customer.
76
- * @summary Request payment setup complete
77
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
78
- * @param {CompletePaymentSetupPspRequest} completePaymentSetupPspRequest
79
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
80
- * @param {*} [options] Override http request option.
81
- * @throws {RequiredError}
82
- */
83
- completePaymentSetup: (customerCode: string, completePaymentSetupPspRequest: CompletePaymentSetupPspRequest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
84
- /**
85
- * Register a customer using the invite token sent to customer\'s email address. Customer can set a new password for his account created during booking a policy.
86
- * @summary Register a customer after invite
87
- * @param {CreateCustomerRequestDto} createCustomerRequestDto
88
- * @param {*} [options] Override http request option.
89
- * @throws {RequiredError}
90
- */
91
- createCustomer: (createCustomerRequestDto: CreateCustomerRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
92
- /**
93
- * Send a customer a reset-password token via email.
94
- * @summary Forgot password by customer
95
- * @param {ForgotPasswordRequestDto} forgotPasswordRequestDto
96
- * @param {*} [options] Override http request option.
97
- * @throws {RequiredError}
98
- */
99
- forgotPassword: (forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
100
- /**
101
- * Get customer details.
102
- * @summary Get customer details
103
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
104
- * @param {string} [expand] Fields to expand response by - [account]
105
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
106
- * @param {*} [options] Override http request option.
107
- * @throws {RequiredError}
108
- */
109
- getCustomer: (customerCode: string, expand?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
110
- /**
111
- * Get a presigned download url for document.
112
- * @summary Get a download url for document
113
- * @param {string} documentCode The document code.
114
- * @param {string} customerCode
115
- * @param {GetCustomerDocumentDownloadUrlRequestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
116
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
117
- * @param {*} [options] Override http request option.
118
- * @throws {RequiredError}
119
- */
120
- getCustomerDocumentDownloadUrl: (documentCode: string, customerCode: string, contentDisposition?: GetCustomerDocumentDownloadUrlRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
121
- /**
122
- * Start auth process to get new access token, refresh token after successful login.
123
- * @summary Initiate auth by customer
124
- * @param {InitiateAuthRequestDto} initiateAuthRequestDto
125
- * @param {*} [options] Override http request option.
126
- * @throws {RequiredError}
127
- */
128
- initiateAuth: (initiateAuthRequestDto: InitiateAuthRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
129
- /**
130
- * Request to initiate a payment change by customer.
131
- * @summary Request payment setup initiation
132
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
133
- * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
134
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
- * @param {*} [options] Override http request option.
136
- * @throws {RequiredError}
137
- */
138
- initiatePaymentSetup: (customerCode: string, initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
139
- /**
140
- * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
141
- * @summary Invite a customer by self
142
- * @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto
143
- * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken.
144
- * @param {*} [options] Override http request option.
145
- * @throws {RequiredError}
146
- */
147
- inviteByCustomer: (inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
148
- /**
149
- * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported. **Required Permissions** \"customer-management.customers.create\"
150
- * @summary Invite a customer by tenant
151
- * @param {InviteByTenantRequestDto} inviteByTenantRequestDto
152
- * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken.
153
- * @param {*} [options] Override http request option.
154
- * @throws {RequiredError}
155
- */
156
- inviteByTenant: (inviteByTenantRequestDto: InviteByTenantRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
157
- /**
158
- * Get customer list.
159
- * @summary Get customers list
160
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
161
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
162
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
163
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
164
- * @param {string} [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.
165
- * @param {string} [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.
166
- * @param {string} [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.
167
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
168
- * @param {*} [options] Override http request option.
169
- * @throws {RequiredError}
170
- */
171
- listCustomers: (pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
172
- /**
173
- * List all the documents of a customer.
174
- * @summary List documents of a customer
175
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
176
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
177
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
178
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
179
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
180
- * @param {string} [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.
181
- * @param {string} [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.
182
- * @param {string} [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.
183
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
184
- * @param {*} [options] Override http request option.
185
- * @throws {RequiredError}
186
- */
187
- listDocuments: (customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
188
- /**
189
- * List all the invoices of a customer.
190
- * @summary List invoices of a customer
191
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
192
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
193
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
194
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
195
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
196
- * @param {string} [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.
197
- * @param {string} [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.
198
- * @param {string} [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.
199
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
200
- * @param {*} [options] Override http request option.
201
- * @throws {RequiredError}
202
- */
203
- listInvoices: (customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
204
- /**
205
- * Get new access token, new refresh token.
206
- * @summary Refresh token by customer
207
- * @param {RefreshTokenDto} refreshTokenDto
208
- * @param {string} [cookie] HTTP only cookie that was sent during login.
209
- * @param {*} [options] Override http request option.
210
- * @throws {RequiredError}
211
- */
212
- refreshToken: (refreshTokenDto: RefreshTokenDto, cookie?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
213
- /**
214
- * Request a token to change the email address for the customer.
215
- * @summary Request customer email change
216
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
217
- * @param {RequestChangeEmailByCustomerRequestDto} requestChangeEmailByCustomerRequestDto
218
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
219
- * @param {*} [options] Override http request option.
220
- * @throws {RequiredError}
221
- */
222
- requestChangeEmailByCustomer: (customerCode: string, requestChangeEmailByCustomerRequestDto: RequestChangeEmailByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
223
- /**
224
- * Change customer\'s password using the token provided by the reset password endpoint.
225
- * @summary Change password by customer
226
- * @param {ResetPasswordByCustomerRequestDto} resetPasswordByCustomerRequestDto
227
- * @param {*} [options] Override http request option.
228
- * @throws {RequiredError}
229
- */
230
- resetPassword: (resetPasswordByCustomerRequestDto: ResetPasswordByCustomerRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
231
- /**
232
- * Respond to the auth challenge by customer to get new access token, refresh token after successful login.
233
- * @summary Respond to auth challenge
234
- * @param {RespondToAuthChallengeRequestDto} respondToAuthChallengeRequestDto
235
- * @param {*} [options] Override http request option.
236
- * @throws {RequiredError}
237
- */
238
- respondToAuthChallenge: (respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
239
- /**
240
- * Update customer details like phone, names, addresses etc. To change email, please use Request customer email change endpoint instead.
241
- * @summary Update customer details
242
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
243
- * @param {UpdateCustomerRequestDto} updateCustomerRequestDto
244
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
245
- * @param {*} [options] Override http request option.
246
- * @throws {RequiredError}
247
- */
248
- updateCustomer: (customerCode: string, updateCustomerRequestDto: UpdateCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
249
- /**
250
- * API to upload and attach documents to an account.
251
- * @summary Upload account documents
252
- * @param {string} customerCode
253
- * @param {UploadAccountDocumentsRequestDto} uploadAccountDocumentsRequestDto
254
- * @param {*} [options] Override http request option.
255
- * @throws {RequiredError}
256
- */
257
- uploadAccountDocuments: (customerCode: string, uploadAccountDocumentsRequestDto: UploadAccountDocumentsRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
258
- /**
259
- * Verify the change email token that is sent by calling the request change email endpoint.
260
- * @summary Verify the change email token
261
- * @param {VerifyChangeEmailTokenRequestDto} verifyChangeEmailTokenRequestDto
262
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
263
- * @param {*} [options] Override http request option.
264
- * @throws {RequiredError}
265
- */
266
- verifyChangeEmailToken: (verifyChangeEmailTokenRequestDto: VerifyChangeEmailTokenRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
267
- /**
268
- * Verify the invite sent to the customer via email.
269
- * @summary Verify customer\'s invite token
270
- * @param {string} inviteToken Invite token sent to the customer
271
- * @param {*} [options] Override http request option.
272
- * @throws {RequiredError}
273
- */
274
- verifyInvite: (inviteToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
275
- /**
276
- * Verify the reset password token that is sent by calling the \'forgot password\' endpoint.
277
- * @summary Verify a reset password token
278
- * @param {string} resetToken reset password token
279
- * @param {*} [options] Override http request option.
280
- * @throws {RequiredError}
281
- */
282
- verifyResetPasswordToken: (resetToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
283
- };
284
- /**
285
- * CustomerControllerRestApi - functional programming interface
286
- * @export
287
- */
288
- export declare const CustomerControllerRestApiFp: (configuration?: Configuration) => {
289
- /**
290
- * Change customer\'s email using the token provided by the request email change endpoint.
291
- * @summary Change customer email
292
- * @param {ChangeCustomerEmailRequestDto} changeCustomerEmailRequestDto
293
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
294
- * @param {*} [options] Override http request option.
295
- * @throws {RequiredError}
296
- */
297
- changeCustomerEmail(changeCustomerEmailRequestDto: ChangeCustomerEmailRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerResponseClass>>;
298
- /**
299
- * Change the customer password. Please use forgot-password endpoint if current password is lost.
300
- * @summary Change customer password
301
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
302
- * @param {ChangePasswordRequestDto} changePasswordRequestDto
303
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
304
- * @param {*} [options] Override http request option.
305
- * @throws {RequiredError}
306
- */
307
- changePassword(customerCode: string, changePasswordRequestDto: ChangePasswordRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangePasswordResponseClass>>;
308
- /**
309
- * Request to complete a payment change by customer.
310
- * @summary Request payment setup complete
311
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
312
- * @param {CompletePaymentSetupPspRequest} completePaymentSetupPspRequest
313
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
314
- * @param {*} [options] Override http request option.
315
- * @throws {RequiredError}
316
- */
317
- completePaymentSetup(customerCode: string, completePaymentSetupPspRequest: CompletePaymentSetupPspRequest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompletePaymentSetupResponseClass>>;
318
- /**
319
- * Register a customer using the invite token sent to customer\'s email address. Customer can set a new password for his account created during booking a policy.
320
- * @summary Register a customer after invite
321
- * @param {CreateCustomerRequestDto} createCustomerRequestDto
322
- * @param {*} [options] Override http request option.
323
- * @throws {RequiredError}
324
- */
325
- createCustomer(createCustomerRequestDto: CreateCustomerRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCustomerResponseClass>>;
326
- /**
327
- * Send a customer a reset-password token via email.
328
- * @summary Forgot password by customer
329
- * @param {ForgotPasswordRequestDto} forgotPasswordRequestDto
330
- * @param {*} [options] Override http request option.
331
- * @throws {RequiredError}
332
- */
333
- forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
334
- /**
335
- * Get customer details.
336
- * @summary Get customer details
337
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
338
- * @param {string} [expand] Fields to expand response by - [account]
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
- getCustomer(customerCode: string, expand?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerResponseClass>>;
344
- /**
345
- * Get a presigned download url for document.
346
- * @summary Get a download url for document
347
- * @param {string} documentCode The document code.
348
- * @param {string} customerCode
349
- * @param {GetCustomerDocumentDownloadUrlRequestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
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
- getCustomerDocumentDownloadUrl(documentCode: string, customerCode: string, contentDisposition?: GetCustomerDocumentDownloadUrlRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerDocumentDownloadUrlResponseClass>>;
355
- /**
356
- * Start auth process to get new access token, refresh token after successful login.
357
- * @summary Initiate auth by customer
358
- * @param {InitiateAuthRequestDto} initiateAuthRequestDto
359
- * @param {*} [options] Override http request option.
360
- * @throws {RequiredError}
361
- */
362
- initiateAuth(initiateAuthRequestDto: InitiateAuthRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateAuthResponseClass>>;
363
- /**
364
- * Request to initiate a payment change by customer.
365
- * @summary Request payment setup initiation
366
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
367
- * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
368
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
369
- * @param {*} [options] Override http request option.
370
- * @throws {RequiredError}
371
- */
372
- initiatePaymentSetup(customerCode: string, initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiatePaymentSetupResponseClass>>;
373
- /**
374
- * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
375
- * @summary Invite a customer by self
376
- * @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto
377
- * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken.
378
- * @param {*} [options] Override http request option.
379
- * @throws {RequiredError}
380
- */
381
- inviteByCustomer(inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteByCustomerResponseClass>>;
382
- /**
383
- * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported. **Required Permissions** \"customer-management.customers.create\"
384
- * @summary Invite a customer by tenant
385
- * @param {InviteByTenantRequestDto} inviteByTenantRequestDto
386
- * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken.
387
- * @param {*} [options] Override http request option.
388
- * @throws {RequiredError}
389
- */
390
- inviteByTenant(inviteByTenantRequestDto: InviteByTenantRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteByTenantResponseClass>>;
391
- /**
392
- * Get customer list.
393
- * @summary Get customers list
394
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
395
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
396
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
397
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
398
- * @param {string} [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.
399
- * @param {string} [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.
400
- * @param {string} [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.
401
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
402
- * @param {*} [options] Override http request option.
403
- * @throws {RequiredError}
404
- */
405
- listCustomers(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
406
- /**
407
- * List all the documents of a customer.
408
- * @summary List documents of a customer
409
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
410
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
411
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
412
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
413
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
414
- * @param {string} [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.
415
- * @param {string} [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.
416
- * @param {string} [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.
417
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
418
- * @param {*} [options] Override http request option.
419
- * @throws {RequiredError}
420
- */
421
- listDocuments(customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
422
- /**
423
- * List all the invoices of a customer.
424
- * @summary List invoices of a customer
425
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
426
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
427
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
428
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
429
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
430
- * @param {string} [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.
431
- * @param {string} [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.
432
- * @param {string} [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.
433
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
434
- * @param {*} [options] Override http request option.
435
- * @throws {RequiredError}
436
- */
437
- listInvoices(customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListInvoicesResponseClass>>;
438
- /**
439
- * Get new access token, new refresh token.
440
- * @summary Refresh token by customer
441
- * @param {RefreshTokenDto} refreshTokenDto
442
- * @param {string} [cookie] HTTP only cookie that was sent during login.
443
- * @param {*} [options] Override http request option.
444
- * @throws {RequiredError}
445
- */
446
- refreshToken(refreshTokenDto: RefreshTokenDto, cookie?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
447
- /**
448
- * Request a token to change the email address for the customer.
449
- * @summary Request customer email change
450
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
451
- * @param {RequestChangeEmailByCustomerRequestDto} requestChangeEmailByCustomerRequestDto
452
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
453
- * @param {*} [options] Override http request option.
454
- * @throws {RequiredError}
455
- */
456
- requestChangeEmailByCustomer(customerCode: string, requestChangeEmailByCustomerRequestDto: RequestChangeEmailByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestChangeEmailByCustomerResponseClass>>;
457
- /**
458
- * Change customer\'s password using the token provided by the reset password endpoint.
459
- * @summary Change password by customer
460
- * @param {ResetPasswordByCustomerRequestDto} resetPasswordByCustomerRequestDto
461
- * @param {*} [options] Override http request option.
462
- * @throws {RequiredError}
463
- */
464
- resetPassword(resetPasswordByCustomerRequestDto: ResetPasswordByCustomerRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
465
- /**
466
- * Respond to the auth challenge by customer to get new access token, refresh token after successful login.
467
- * @summary Respond to auth challenge
468
- * @param {RespondToAuthChallengeRequestDto} respondToAuthChallengeRequestDto
469
- * @param {*} [options] Override http request option.
470
- * @throws {RequiredError}
471
- */
472
- respondToAuthChallenge(respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RespondToAuthChallengeClass>>;
473
- /**
474
- * Update customer details like phone, names, addresses etc. To change email, please use Request customer email change endpoint instead.
475
- * @summary Update customer details
476
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
477
- * @param {UpdateCustomerRequestDto} updateCustomerRequestDto
478
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
479
- * @param {*} [options] Override http request option.
480
- * @throws {RequiredError}
481
- */
482
- updateCustomer(customerCode: string, updateCustomerRequestDto: UpdateCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerResponseClass>>;
483
- /**
484
- * API to upload and attach documents to an account.
485
- * @summary Upload account documents
486
- * @param {string} customerCode
487
- * @param {UploadAccountDocumentsRequestDto} uploadAccountDocumentsRequestDto
488
- * @param {*} [options] Override http request option.
489
- * @throws {RequiredError}
490
- */
491
- uploadAccountDocuments(customerCode: string, uploadAccountDocumentsRequestDto: UploadAccountDocumentsRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
492
- /**
493
- * Verify the change email token that is sent by calling the request change email endpoint.
494
- * @summary Verify the change email token
495
- * @param {VerifyChangeEmailTokenRequestDto} verifyChangeEmailTokenRequestDto
496
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
497
- * @param {*} [options] Override http request option.
498
- * @throws {RequiredError}
499
- */
500
- verifyChangeEmailToken(verifyChangeEmailTokenRequestDto: VerifyChangeEmailTokenRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyChangeEmailTokenResponseClass>>;
501
- /**
502
- * Verify the invite sent to the customer via email.
503
- * @summary Verify customer\'s invite token
504
- * @param {string} inviteToken Invite token sent to the customer
505
- * @param {*} [options] Override http request option.
506
- * @throws {RequiredError}
507
- */
508
- verifyInvite(inviteToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyCustomerInviteResponseClass>>;
509
- /**
510
- * Verify the reset password token that is sent by calling the \'forgot password\' endpoint.
511
- * @summary Verify a reset password token
512
- * @param {string} resetToken reset password token
513
- * @param {*} [options] Override http request option.
514
- * @throws {RequiredError}
515
- */
516
- verifyResetPasswordToken(resetToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyResetPasswordTokenResponseClass>>;
517
- };
518
- /**
519
- * CustomerControllerRestApi - factory interface
520
- * @export
521
- */
522
- export declare const CustomerControllerRestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
523
- /**
524
- * Change customer\'s email using the token provided by the request email change endpoint.
525
- * @summary Change customer email
526
- * @param {ChangeCustomerEmailRequestDto} changeCustomerEmailRequestDto
527
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
528
- * @param {*} [options] Override http request option.
529
- * @throws {RequiredError}
530
- */
531
- changeCustomerEmail(changeCustomerEmailRequestDto: ChangeCustomerEmailRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCustomerResponseClass>;
532
- /**
533
- * Change the customer password. Please use forgot-password endpoint if current password is lost.
534
- * @summary Change customer password
535
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
536
- * @param {ChangePasswordRequestDto} changePasswordRequestDto
537
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
538
- * @param {*} [options] Override http request option.
539
- * @throws {RequiredError}
540
- */
541
- changePassword(customerCode: string, changePasswordRequestDto: ChangePasswordRequestDto, authorization?: string, options?: any): AxiosPromise<ChangePasswordResponseClass>;
542
- /**
543
- * Request to complete a payment change by customer.
544
- * @summary Request payment setup complete
545
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
546
- * @param {CompletePaymentSetupPspRequest} completePaymentSetupPspRequest
547
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
548
- * @param {*} [options] Override http request option.
549
- * @throws {RequiredError}
550
- */
551
- completePaymentSetup(customerCode: string, completePaymentSetupPspRequest: CompletePaymentSetupPspRequest, authorization?: string, options?: any): AxiosPromise<CompletePaymentSetupResponseClass>;
552
- /**
553
- * Register a customer using the invite token sent to customer\'s email address. Customer can set a new password for his account created during booking a policy.
554
- * @summary Register a customer after invite
555
- * @param {CreateCustomerRequestDto} createCustomerRequestDto
556
- * @param {*} [options] Override http request option.
557
- * @throws {RequiredError}
558
- */
559
- createCustomer(createCustomerRequestDto: CreateCustomerRequestDto, options?: any): AxiosPromise<CreateCustomerResponseClass>;
560
- /**
561
- * Send a customer a reset-password token via email.
562
- * @summary Forgot password by customer
563
- * @param {ForgotPasswordRequestDto} forgotPasswordRequestDto
564
- * @param {*} [options] Override http request option.
565
- * @throws {RequiredError}
566
- */
567
- forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: any): AxiosPromise<void>;
568
- /**
569
- * Get customer details.
570
- * @summary Get customer details
571
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
572
- * @param {string} [expand] Fields to expand response by - [account]
573
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
574
- * @param {*} [options] Override http request option.
575
- * @throws {RequiredError}
576
- */
577
- getCustomer(customerCode: string, expand?: string, authorization?: string, options?: any): AxiosPromise<GetCustomerResponseClass>;
578
- /**
579
- * Get a presigned download url for document.
580
- * @summary Get a download url for document
581
- * @param {string} documentCode The document code.
582
- * @param {string} customerCode
583
- * @param {GetCustomerDocumentDownloadUrlRequestDto} [contentDisposition] Content disposition override. Default will be depending on the document type.
584
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
585
- * @param {*} [options] Override http request option.
586
- * @throws {RequiredError}
587
- */
588
- getCustomerDocumentDownloadUrl(documentCode: string, customerCode: string, contentDisposition?: GetCustomerDocumentDownloadUrlRequestDto, authorization?: string, options?: any): AxiosPromise<GetCustomerDocumentDownloadUrlResponseClass>;
589
- /**
590
- * Start auth process to get new access token, refresh token after successful login.
591
- * @summary Initiate auth by customer
592
- * @param {InitiateAuthRequestDto} initiateAuthRequestDto
593
- * @param {*} [options] Override http request option.
594
- * @throws {RequiredError}
595
- */
596
- initiateAuth(initiateAuthRequestDto: InitiateAuthRequestDto, options?: any): AxiosPromise<InitiateAuthResponseClass>;
597
- /**
598
- * Request to initiate a payment change by customer.
599
- * @summary Request payment setup initiation
600
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
601
- * @param {InitiatePaymentSetupRequestDto} initiatePaymentSetupRequestDto
602
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
603
- * @param {*} [options] Override http request option.
604
- * @throws {RequiredError}
605
- */
606
- initiatePaymentSetup(customerCode: string, initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto, authorization?: string, options?: any): AxiosPromise<InitiatePaymentSetupResponseClass>;
607
- /**
608
- * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
609
- * @summary Invite a customer by self
610
- * @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto
611
- * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken.
612
- * @param {*} [options] Override http request option.
613
- * @throws {RequiredError}
614
- */
615
- inviteByCustomer(inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: any): AxiosPromise<InviteByCustomerResponseClass>;
616
- /**
617
- * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported. **Required Permissions** \"customer-management.customers.create\"
618
- * @summary Invite a customer by tenant
619
- * @param {InviteByTenantRequestDto} inviteByTenantRequestDto
620
- * @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken.
621
- * @param {*} [options] Override http request option.
622
- * @throws {RequiredError}
623
- */
624
- inviteByTenant(inviteByTenantRequestDto: InviteByTenantRequestDto, authorization?: string, options?: any): AxiosPromise<InviteByTenantResponseClass>;
625
- /**
626
- * Get customer list.
627
- * @summary Get customers list
628
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
629
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
630
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
631
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
632
- * @param {string} [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.
633
- * @param {string} [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.
634
- * @param {string} [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.
635
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
636
- * @param {*} [options] Override http request option.
637
- * @throws {RequiredError}
638
- */
639
- listCustomers(pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: any): AxiosPromise<object>;
640
- /**
641
- * List all the documents of a customer.
642
- * @summary List documents of a customer
643
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
644
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
645
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
646
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
647
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
648
- * @param {string} [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.
649
- * @param {string} [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.
650
- * @param {string} [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.
651
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
652
- * @param {*} [options] Override http request option.
653
- * @throws {RequiredError}
654
- */
655
- listDocuments(customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
656
- /**
657
- * List all the invoices of a customer.
658
- * @summary List invoices of a customer
659
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
660
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
661
- * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
662
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
663
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
664
- * @param {string} [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.
665
- * @param {string} [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.
666
- * @param {string} [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.
667
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
668
- * @param {*} [options] Override http request option.
669
- * @throws {RequiredError}
670
- */
671
- listInvoices(customerCode: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, authorization?: string, options?: any): AxiosPromise<ListInvoicesResponseClass>;
672
- /**
673
- * Get new access token, new refresh token.
674
- * @summary Refresh token by customer
675
- * @param {RefreshTokenDto} refreshTokenDto
676
- * @param {string} [cookie] HTTP only cookie that was sent during login.
677
- * @param {*} [options] Override http request option.
678
- * @throws {RequiredError}
679
- */
680
- refreshToken(refreshTokenDto: RefreshTokenDto, cookie?: string, options?: any): AxiosPromise<void>;
681
- /**
682
- * Request a token to change the email address for the customer.
683
- * @summary Request customer email change
684
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
685
- * @param {RequestChangeEmailByCustomerRequestDto} requestChangeEmailByCustomerRequestDto
686
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
687
- * @param {*} [options] Override http request option.
688
- * @throws {RequiredError}
689
- */
690
- requestChangeEmailByCustomer(customerCode: string, requestChangeEmailByCustomerRequestDto: RequestChangeEmailByCustomerRequestDto, authorization?: string, options?: any): AxiosPromise<RequestChangeEmailByCustomerResponseClass>;
691
- /**
692
- * Change customer\'s password using the token provided by the reset password endpoint.
693
- * @summary Change password by customer
694
- * @param {ResetPasswordByCustomerRequestDto} resetPasswordByCustomerRequestDto
695
- * @param {*} [options] Override http request option.
696
- * @throws {RequiredError}
697
- */
698
- resetPassword(resetPasswordByCustomerRequestDto: ResetPasswordByCustomerRequestDto, options?: any): AxiosPromise<void>;
699
- /**
700
- * Respond to the auth challenge by customer to get new access token, refresh token after successful login.
701
- * @summary Respond to auth challenge
702
- * @param {RespondToAuthChallengeRequestDto} respondToAuthChallengeRequestDto
703
- * @param {*} [options] Override http request option.
704
- * @throws {RequiredError}
705
- */
706
- respondToAuthChallenge(respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto, options?: any): AxiosPromise<RespondToAuthChallengeClass>;
707
- /**
708
- * Update customer details like phone, names, addresses etc. To change email, please use Request customer email change endpoint instead.
709
- * @summary Update customer details
710
- * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer.
711
- * @param {UpdateCustomerRequestDto} updateCustomerRequestDto
712
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
713
- * @param {*} [options] Override http request option.
714
- * @throws {RequiredError}
715
- */
716
- updateCustomer(customerCode: string, updateCustomerRequestDto: UpdateCustomerRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCustomerResponseClass>;
717
- /**
718
- * API to upload and attach documents to an account.
719
- * @summary Upload account documents
720
- * @param {string} customerCode
721
- * @param {UploadAccountDocumentsRequestDto} uploadAccountDocumentsRequestDto
722
- * @param {*} [options] Override http request option.
723
- * @throws {RequiredError}
724
- */
725
- uploadAccountDocuments(customerCode: string, uploadAccountDocumentsRequestDto: UploadAccountDocumentsRequestDto, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
726
- /**
727
- * Verify the change email token that is sent by calling the request change email endpoint.
728
- * @summary Verify the change email token
729
- * @param {VerifyChangeEmailTokenRequestDto} verifyChangeEmailTokenRequestDto
730
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
731
- * @param {*} [options] Override http request option.
732
- * @throws {RequiredError}
733
- */
734
- verifyChangeEmailToken(verifyChangeEmailTokenRequestDto: VerifyChangeEmailTokenRequestDto, authorization?: string, options?: any): AxiosPromise<VerifyChangeEmailTokenResponseClass>;
735
- /**
736
- * Verify the invite sent to the customer via email.
737
- * @summary Verify customer\'s invite token
738
- * @param {string} inviteToken Invite token sent to the customer
739
- * @param {*} [options] Override http request option.
740
- * @throws {RequiredError}
741
- */
742
- verifyInvite(inviteToken: string, options?: any): AxiosPromise<VerifyCustomerInviteResponseClass>;
743
- /**
744
- * Verify the reset password token that is sent by calling the \'forgot password\' endpoint.
745
- * @summary Verify a reset password token
746
- * @param {string} resetToken reset password token
747
- * @param {*} [options] Override http request option.
748
- * @throws {RequiredError}
749
- */
750
- verifyResetPasswordToken(resetToken: string, options?: any): AxiosPromise<VerifyResetPasswordTokenResponseClass>;
751
- };
752
- /**
753
- * Request parameters for changeCustomerEmail operation in CustomerControllerRestApi.
754
- * @export
755
- * @interface CustomerControllerRestApiChangeCustomerEmailRequest
756
- */
757
- export interface CustomerControllerRestApiChangeCustomerEmailRequest {
758
- /**
759
- *
760
- * @type {ChangeCustomerEmailRequestDto}
761
- * @memberof CustomerControllerRestApiChangeCustomerEmail
762
- */
763
- readonly changeCustomerEmailRequestDto: ChangeCustomerEmailRequestDto;
764
- /**
765
- * Bearer Token: provided by the login endpoint under the name accessToken.
766
- * @type {string}
767
- * @memberof CustomerControllerRestApiChangeCustomerEmail
768
- */
769
- readonly authorization?: string;
770
- }
771
- /**
772
- * Request parameters for changePassword operation in CustomerControllerRestApi.
773
- * @export
774
- * @interface CustomerControllerRestApiChangePasswordRequest
775
- */
776
- export interface CustomerControllerRestApiChangePasswordRequest {
777
- /**
778
- * The customer code or \&quot;me\&quot; for the currently logged in customer.
779
- * @type {string}
780
- * @memberof CustomerControllerRestApiChangePassword
781
- */
782
- readonly customerCode: string;
783
- /**
784
- *
785
- * @type {ChangePasswordRequestDto}
786
- * @memberof CustomerControllerRestApiChangePassword
787
- */
788
- readonly changePasswordRequestDto: ChangePasswordRequestDto;
789
- /**
790
- * Bearer Token: provided by the login endpoint under the name accessToken.
791
- * @type {string}
792
- * @memberof CustomerControllerRestApiChangePassword
793
- */
794
- readonly authorization?: string;
795
- }
796
- /**
797
- * Request parameters for completePaymentSetup operation in CustomerControllerRestApi.
798
- * @export
799
- * @interface CustomerControllerRestApiCompletePaymentSetupRequest
800
- */
801
- export interface CustomerControllerRestApiCompletePaymentSetupRequest {
802
- /**
803
- * The customer code or \&quot;me\&quot; for the currently logged in customer.
804
- * @type {string}
805
- * @memberof CustomerControllerRestApiCompletePaymentSetup
806
- */
807
- readonly customerCode: string;
808
- /**
809
- *
810
- * @type {CompletePaymentSetupPspRequest}
811
- * @memberof CustomerControllerRestApiCompletePaymentSetup
812
- */
813
- readonly completePaymentSetupPspRequest: CompletePaymentSetupPspRequest;
814
- /**
815
- * Bearer Token: provided by the login endpoint under the name accessToken.
816
- * @type {string}
817
- * @memberof CustomerControllerRestApiCompletePaymentSetup
818
- */
819
- readonly authorization?: string;
820
- }
821
- /**
822
- * Request parameters for createCustomer operation in CustomerControllerRestApi.
823
- * @export
824
- * @interface CustomerControllerRestApiCreateCustomerRequest
825
- */
826
- export interface CustomerControllerRestApiCreateCustomerRequest {
827
- /**
828
- *
829
- * @type {CreateCustomerRequestDto}
830
- * @memberof CustomerControllerRestApiCreateCustomer
831
- */
832
- readonly createCustomerRequestDto: CreateCustomerRequestDto;
833
- }
834
- /**
835
- * Request parameters for forgotPassword operation in CustomerControllerRestApi.
836
- * @export
837
- * @interface CustomerControllerRestApiForgotPasswordRequest
838
- */
839
- export interface CustomerControllerRestApiForgotPasswordRequest {
840
- /**
841
- *
842
- * @type {ForgotPasswordRequestDto}
843
- * @memberof CustomerControllerRestApiForgotPassword
844
- */
845
- readonly forgotPasswordRequestDto: ForgotPasswordRequestDto;
846
- }
847
- /**
848
- * Request parameters for getCustomer operation in CustomerControllerRestApi.
849
- * @export
850
- * @interface CustomerControllerRestApiGetCustomerRequest
851
- */
852
- export interface CustomerControllerRestApiGetCustomerRequest {
853
- /**
854
- * The customer code or \&quot;me\&quot; for the currently logged in customer.
855
- * @type {string}
856
- * @memberof CustomerControllerRestApiGetCustomer
857
- */
858
- readonly customerCode: string;
859
- /**
860
- * Fields to expand response by - [account]
861
- * @type {string}
862
- * @memberof CustomerControllerRestApiGetCustomer
863
- */
864
- readonly expand?: string;
865
- /**
866
- * Bearer Token: provided by the login endpoint under the name accessToken.
867
- * @type {string}
868
- * @memberof CustomerControllerRestApiGetCustomer
869
- */
870
- readonly authorization?: string;
871
- }
872
- /**
873
- * Request parameters for getCustomerDocumentDownloadUrl operation in CustomerControllerRestApi.
874
- * @export
875
- * @interface CustomerControllerRestApiGetCustomerDocumentDownloadUrlRequest
876
- */
877
- export interface CustomerControllerRestApiGetCustomerDocumentDownloadUrlRequest {
878
- /**
879
- * The document code.
880
- * @type {string}
881
- * @memberof CustomerControllerRestApiGetCustomerDocumentDownloadUrl
882
- */
883
- readonly documentCode: string;
884
- /**
885
- *
886
- * @type {string}
887
- * @memberof CustomerControllerRestApiGetCustomerDocumentDownloadUrl
888
- */
889
- readonly customerCode: string;
890
- /**
891
- * Content disposition override. Default will be depending on the document type.
892
- * @type {GetCustomerDocumentDownloadUrlRequestDto}
893
- * @memberof CustomerControllerRestApiGetCustomerDocumentDownloadUrl
894
- */
895
- readonly contentDisposition?: GetCustomerDocumentDownloadUrlRequestDto;
896
- /**
897
- * Bearer Token: provided by the login endpoint under the name accessToken.
898
- * @type {string}
899
- * @memberof CustomerControllerRestApiGetCustomerDocumentDownloadUrl
900
- */
901
- readonly authorization?: string;
902
- }
903
- /**
904
- * Request parameters for initiateAuth operation in CustomerControllerRestApi.
905
- * @export
906
- * @interface CustomerControllerRestApiInitiateAuthRequest
907
- */
908
- export interface CustomerControllerRestApiInitiateAuthRequest {
909
- /**
910
- *
911
- * @type {InitiateAuthRequestDto}
912
- * @memberof CustomerControllerRestApiInitiateAuth
913
- */
914
- readonly initiateAuthRequestDto: InitiateAuthRequestDto;
915
- }
916
- /**
917
- * Request parameters for initiatePaymentSetup operation in CustomerControllerRestApi.
918
- * @export
919
- * @interface CustomerControllerRestApiInitiatePaymentSetupRequest
920
- */
921
- export interface CustomerControllerRestApiInitiatePaymentSetupRequest {
922
- /**
923
- * The customer code or \&quot;me\&quot; for the currently logged in customer.
924
- * @type {string}
925
- * @memberof CustomerControllerRestApiInitiatePaymentSetup
926
- */
927
- readonly customerCode: string;
928
- /**
929
- *
930
- * @type {InitiatePaymentSetupRequestDto}
931
- * @memberof CustomerControllerRestApiInitiatePaymentSetup
932
- */
933
- readonly initiatePaymentSetupRequestDto: InitiatePaymentSetupRequestDto;
934
- /**
935
- * Bearer Token: provided by the login endpoint under the name accessToken.
936
- * @type {string}
937
- * @memberof CustomerControllerRestApiInitiatePaymentSetup
938
- */
939
- readonly authorization?: string;
940
- }
941
- /**
942
- * Request parameters for inviteByCustomer operation in CustomerControllerRestApi.
943
- * @export
944
- * @interface CustomerControllerRestApiInviteByCustomerRequest
945
- */
946
- export interface CustomerControllerRestApiInviteByCustomerRequest {
947
- /**
948
- *
949
- * @type {InviteByCustomerRequestDto}
950
- * @memberof CustomerControllerRestApiInviteByCustomer
951
- */
952
- readonly inviteByCustomerRequestDto: InviteByCustomerRequestDto;
953
- /**
954
- * Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken.
955
- * @type {string}
956
- * @memberof CustomerControllerRestApiInviteByCustomer
957
- */
958
- readonly authorization?: string;
959
- }
960
- /**
961
- * Request parameters for inviteByTenant operation in CustomerControllerRestApi.
962
- * @export
963
- * @interface CustomerControllerRestApiInviteByTenantRequest
964
- */
965
- export interface CustomerControllerRestApiInviteByTenantRequest {
966
- /**
967
- *
968
- * @type {InviteByTenantRequestDto}
969
- * @memberof CustomerControllerRestApiInviteByTenant
970
- */
971
- readonly inviteByTenantRequestDto: InviteByTenantRequestDto;
972
- /**
973
- * Bearer Token: provided by the Emil Insurance Suite\&#39;s Auth login endpoint under the name accessToken.
974
- * @type {string}
975
- * @memberof CustomerControllerRestApiInviteByTenant
976
- */
977
- readonly authorization?: string;
978
- }
979
- /**
980
- * Request parameters for listCustomers operation in CustomerControllerRestApi.
981
- * @export
982
- * @interface CustomerControllerRestApiListCustomersRequest
983
- */
984
- export interface CustomerControllerRestApiListCustomersRequest {
985
- /**
986
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
987
- * @type {number}
988
- * @memberof CustomerControllerRestApiListCustomers
989
- */
990
- readonly pageSize?: number;
991
- /**
992
- * 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.
993
- * @type {string}
994
- * @memberof CustomerControllerRestApiListCustomers
995
- */
996
- readonly pageToken?: string;
997
- /**
998
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
999
- * @type {string}
1000
- * @memberof CustomerControllerRestApiListCustomers
1001
- */
1002
- readonly filter?: string;
1003
- /**
1004
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1005
- * @type {string}
1006
- * @memberof CustomerControllerRestApiListCustomers
1007
- */
1008
- readonly search?: string;
1009
- /**
1010
- * 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.
1011
- * @type {string}
1012
- * @memberof CustomerControllerRestApiListCustomers
1013
- */
1014
- readonly order?: string;
1015
- /**
1016
- * 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.
1017
- * @type {string}
1018
- * @memberof CustomerControllerRestApiListCustomers
1019
- */
1020
- readonly expand?: string;
1021
- /**
1022
- * 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.
1023
- * @type {string}
1024
- * @memberof CustomerControllerRestApiListCustomers
1025
- */
1026
- readonly filters?: string;
1027
- /**
1028
- * Bearer Token: provided by the login endpoint under the name accessToken.
1029
- * @type {string}
1030
- * @memberof CustomerControllerRestApiListCustomers
1031
- */
1032
- readonly authorization?: string;
1033
- }
1034
- /**
1035
- * Request parameters for listDocuments operation in CustomerControllerRestApi.
1036
- * @export
1037
- * @interface CustomerControllerRestApiListDocumentsRequest
1038
- */
1039
- export interface CustomerControllerRestApiListDocumentsRequest {
1040
- /**
1041
- * The customer code or \&quot;me\&quot; for the currently logged in customer.
1042
- * @type {string}
1043
- * @memberof CustomerControllerRestApiListDocuments
1044
- */
1045
- readonly customerCode: string;
1046
- /**
1047
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1048
- * @type {number}
1049
- * @memberof CustomerControllerRestApiListDocuments
1050
- */
1051
- readonly pageSize?: number;
1052
- /**
1053
- * 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.
1054
- * @type {string}
1055
- * @memberof CustomerControllerRestApiListDocuments
1056
- */
1057
- readonly pageToken?: string;
1058
- /**
1059
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
1060
- * @type {string}
1061
- * @memberof CustomerControllerRestApiListDocuments
1062
- */
1063
- readonly filter?: string;
1064
- /**
1065
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1066
- * @type {string}
1067
- * @memberof CustomerControllerRestApiListDocuments
1068
- */
1069
- readonly search?: string;
1070
- /**
1071
- * 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.
1072
- * @type {string}
1073
- * @memberof CustomerControllerRestApiListDocuments
1074
- */
1075
- readonly order?: string;
1076
- /**
1077
- * 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.
1078
- * @type {string}
1079
- * @memberof CustomerControllerRestApiListDocuments
1080
- */
1081
- readonly expand?: string;
1082
- /**
1083
- * 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.
1084
- * @type {string}
1085
- * @memberof CustomerControllerRestApiListDocuments
1086
- */
1087
- readonly filters?: string;
1088
- /**
1089
- * Bearer Token: provided by the login endpoint under the name accessToken.
1090
- * @type {string}
1091
- * @memberof CustomerControllerRestApiListDocuments
1092
- */
1093
- readonly authorization?: string;
1094
- }
1095
- /**
1096
- * Request parameters for listInvoices operation in CustomerControllerRestApi.
1097
- * @export
1098
- * @interface CustomerControllerRestApiListInvoicesRequest
1099
- */
1100
- export interface CustomerControllerRestApiListInvoicesRequest {
1101
- /**
1102
- * The customer code or \&quot;me\&quot; for the currently logged in customer.
1103
- * @type {string}
1104
- * @memberof CustomerControllerRestApiListInvoices
1105
- */
1106
- readonly customerCode: string;
1107
- /**
1108
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
1109
- * @type {number}
1110
- * @memberof CustomerControllerRestApiListInvoices
1111
- */
1112
- readonly pageSize?: number;
1113
- /**
1114
- * 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.
1115
- * @type {string}
1116
- * @memberof CustomerControllerRestApiListInvoices
1117
- */
1118
- readonly pageToken?: string;
1119
- /**
1120
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
1121
- * @type {string}
1122
- * @memberof CustomerControllerRestApiListInvoices
1123
- */
1124
- readonly filter?: string;
1125
- /**
1126
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1127
- * @type {string}
1128
- * @memberof CustomerControllerRestApiListInvoices
1129
- */
1130
- readonly search?: string;
1131
- /**
1132
- * 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.
1133
- * @type {string}
1134
- * @memberof CustomerControllerRestApiListInvoices
1135
- */
1136
- readonly order?: string;
1137
- /**
1138
- * 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.
1139
- * @type {string}
1140
- * @memberof CustomerControllerRestApiListInvoices
1141
- */
1142
- readonly expand?: string;
1143
- /**
1144
- * 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.
1145
- * @type {string}
1146
- * @memberof CustomerControllerRestApiListInvoices
1147
- */
1148
- readonly filters?: string;
1149
- /**
1150
- * Bearer Token: provided by the login endpoint under the name accessToken.
1151
- * @type {string}
1152
- * @memberof CustomerControllerRestApiListInvoices
1153
- */
1154
- readonly authorization?: string;
1155
- }
1156
- /**
1157
- * Request parameters for refreshToken operation in CustomerControllerRestApi.
1158
- * @export
1159
- * @interface CustomerControllerRestApiRefreshTokenRequest
1160
- */
1161
- export interface CustomerControllerRestApiRefreshTokenRequest {
1162
- /**
1163
- *
1164
- * @type {RefreshTokenDto}
1165
- * @memberof CustomerControllerRestApiRefreshToken
1166
- */
1167
- readonly refreshTokenDto: RefreshTokenDto;
1168
- /**
1169
- * HTTP only cookie that was sent during login.
1170
- * @type {string}
1171
- * @memberof CustomerControllerRestApiRefreshToken
1172
- */
1173
- readonly cookie?: string;
1174
- }
1175
- /**
1176
- * Request parameters for requestChangeEmailByCustomer operation in CustomerControllerRestApi.
1177
- * @export
1178
- * @interface CustomerControllerRestApiRequestChangeEmailByCustomerRequest
1179
- */
1180
- export interface CustomerControllerRestApiRequestChangeEmailByCustomerRequest {
1181
- /**
1182
- * The customer code or \&quot;me\&quot; for the currently logged in customer.
1183
- * @type {string}
1184
- * @memberof CustomerControllerRestApiRequestChangeEmailByCustomer
1185
- */
1186
- readonly customerCode: string;
1187
- /**
1188
- *
1189
- * @type {RequestChangeEmailByCustomerRequestDto}
1190
- * @memberof CustomerControllerRestApiRequestChangeEmailByCustomer
1191
- */
1192
- readonly requestChangeEmailByCustomerRequestDto: RequestChangeEmailByCustomerRequestDto;
1193
- /**
1194
- * Bearer Token: provided by the login endpoint under the name accessToken.
1195
- * @type {string}
1196
- * @memberof CustomerControllerRestApiRequestChangeEmailByCustomer
1197
- */
1198
- readonly authorization?: string;
1199
- }
1200
- /**
1201
- * Request parameters for resetPassword operation in CustomerControllerRestApi.
1202
- * @export
1203
- * @interface CustomerControllerRestApiResetPasswordRequest
1204
- */
1205
- export interface CustomerControllerRestApiResetPasswordRequest {
1206
- /**
1207
- *
1208
- * @type {ResetPasswordByCustomerRequestDto}
1209
- * @memberof CustomerControllerRestApiResetPassword
1210
- */
1211
- readonly resetPasswordByCustomerRequestDto: ResetPasswordByCustomerRequestDto;
1212
- }
1213
- /**
1214
- * Request parameters for respondToAuthChallenge operation in CustomerControllerRestApi.
1215
- * @export
1216
- * @interface CustomerControllerRestApiRespondToAuthChallengeRequest
1217
- */
1218
- export interface CustomerControllerRestApiRespondToAuthChallengeRequest {
1219
- /**
1220
- *
1221
- * @type {RespondToAuthChallengeRequestDto}
1222
- * @memberof CustomerControllerRestApiRespondToAuthChallenge
1223
- */
1224
- readonly respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto;
1225
- }
1226
- /**
1227
- * Request parameters for updateCustomer operation in CustomerControllerRestApi.
1228
- * @export
1229
- * @interface CustomerControllerRestApiUpdateCustomerRequest
1230
- */
1231
- export interface CustomerControllerRestApiUpdateCustomerRequest {
1232
- /**
1233
- * The customer code or \&quot;me\&quot; for the currently logged in customer.
1234
- * @type {string}
1235
- * @memberof CustomerControllerRestApiUpdateCustomer
1236
- */
1237
- readonly customerCode: string;
1238
- /**
1239
- *
1240
- * @type {UpdateCustomerRequestDto}
1241
- * @memberof CustomerControllerRestApiUpdateCustomer
1242
- */
1243
- readonly updateCustomerRequestDto: UpdateCustomerRequestDto;
1244
- /**
1245
- * Bearer Token: provided by the login endpoint under the name accessToken.
1246
- * @type {string}
1247
- * @memberof CustomerControllerRestApiUpdateCustomer
1248
- */
1249
- readonly authorization?: string;
1250
- }
1251
- /**
1252
- * Request parameters for uploadAccountDocuments operation in CustomerControllerRestApi.
1253
- * @export
1254
- * @interface CustomerControllerRestApiUploadAccountDocumentsRequest
1255
- */
1256
- export interface CustomerControllerRestApiUploadAccountDocumentsRequest {
1257
- /**
1258
- *
1259
- * @type {string}
1260
- * @memberof CustomerControllerRestApiUploadAccountDocuments
1261
- */
1262
- readonly customerCode: string;
1263
- /**
1264
- *
1265
- * @type {UploadAccountDocumentsRequestDto}
1266
- * @memberof CustomerControllerRestApiUploadAccountDocuments
1267
- */
1268
- readonly uploadAccountDocumentsRequestDto: UploadAccountDocumentsRequestDto;
1269
- }
1270
- /**
1271
- * Request parameters for verifyChangeEmailToken operation in CustomerControllerRestApi.
1272
- * @export
1273
- * @interface CustomerControllerRestApiVerifyChangeEmailTokenRequest
1274
- */
1275
- export interface CustomerControllerRestApiVerifyChangeEmailTokenRequest {
1276
- /**
1277
- *
1278
- * @type {VerifyChangeEmailTokenRequestDto}
1279
- * @memberof CustomerControllerRestApiVerifyChangeEmailToken
1280
- */
1281
- readonly verifyChangeEmailTokenRequestDto: VerifyChangeEmailTokenRequestDto;
1282
- /**
1283
- * Bearer Token: provided by the login endpoint under the name accessToken.
1284
- * @type {string}
1285
- * @memberof CustomerControllerRestApiVerifyChangeEmailToken
1286
- */
1287
- readonly authorization?: string;
1288
- }
1289
- /**
1290
- * Request parameters for verifyInvite operation in CustomerControllerRestApi.
1291
- * @export
1292
- * @interface CustomerControllerRestApiVerifyInviteRequest
1293
- */
1294
- export interface CustomerControllerRestApiVerifyInviteRequest {
1295
- /**
1296
- * Invite token sent to the customer
1297
- * @type {string}
1298
- * @memberof CustomerControllerRestApiVerifyInvite
1299
- */
1300
- readonly inviteToken: string;
1301
- }
1302
- /**
1303
- * Request parameters for verifyResetPasswordToken operation in CustomerControllerRestApi.
1304
- * @export
1305
- * @interface CustomerControllerRestApiVerifyResetPasswordTokenRequest
1306
- */
1307
- export interface CustomerControllerRestApiVerifyResetPasswordTokenRequest {
1308
- /**
1309
- * reset password token
1310
- * @type {string}
1311
- * @memberof CustomerControllerRestApiVerifyResetPasswordToken
1312
- */
1313
- readonly resetToken: string;
1314
- }
1315
- /**
1316
- * CustomerControllerRestApi - object-oriented interface
1317
- * @export
1318
- * @class CustomerControllerRestApi
1319
- * @extends {BaseAPI}
1320
- */
1321
- export declare class CustomerControllerRestApi extends BaseAPI {
1322
- /**
1323
- * Change customer\'s email using the token provided by the request email change endpoint.
1324
- * @summary Change customer email
1325
- * @param {CustomerControllerRestApiChangeCustomerEmailRequest} requestParameters Request parameters.
1326
- * @param {*} [options] Override http request option.
1327
- * @throws {RequiredError}
1328
- * @memberof CustomerControllerRestApi
1329
- */
1330
- changeCustomerEmail(requestParameters: CustomerControllerRestApiChangeCustomerEmailRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerResponseClass, any, {}>>;
1331
- /**
1332
- * Change the customer password. Please use forgot-password endpoint if current password is lost.
1333
- * @summary Change customer password
1334
- * @param {CustomerControllerRestApiChangePasswordRequest} requestParameters Request parameters.
1335
- * @param {*} [options] Override http request option.
1336
- * @throws {RequiredError}
1337
- * @memberof CustomerControllerRestApi
1338
- */
1339
- changePassword(requestParameters: CustomerControllerRestApiChangePasswordRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangePasswordResponseClass, any, {}>>;
1340
- /**
1341
- * Request to complete a payment change by customer.
1342
- * @summary Request payment setup complete
1343
- * @param {CustomerControllerRestApiCompletePaymentSetupRequest} requestParameters Request parameters.
1344
- * @param {*} [options] Override http request option.
1345
- * @throws {RequiredError}
1346
- * @memberof CustomerControllerRestApi
1347
- */
1348
- completePaymentSetup(requestParameters: CustomerControllerRestApiCompletePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompletePaymentSetupResponseClass, any, {}>>;
1349
- /**
1350
- * Register a customer using the invite token sent to customer\'s email address. Customer can set a new password for his account created during booking a policy.
1351
- * @summary Register a customer after invite
1352
- * @param {CustomerControllerRestApiCreateCustomerRequest} requestParameters Request parameters.
1353
- * @param {*} [options] Override http request option.
1354
- * @throws {RequiredError}
1355
- * @memberof CustomerControllerRestApi
1356
- */
1357
- createCustomer(requestParameters: CustomerControllerRestApiCreateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCustomerResponseClass, any, {}>>;
1358
- /**
1359
- * Send a customer a reset-password token via email.
1360
- * @summary Forgot password by customer
1361
- * @param {CustomerControllerRestApiForgotPasswordRequest} requestParameters Request parameters.
1362
- * @param {*} [options] Override http request option.
1363
- * @throws {RequiredError}
1364
- * @memberof CustomerControllerRestApi
1365
- */
1366
- forgotPassword(requestParameters: CustomerControllerRestApiForgotPasswordRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1367
- /**
1368
- * Get customer details.
1369
- * @summary Get customer details
1370
- * @param {CustomerControllerRestApiGetCustomerRequest} requestParameters Request parameters.
1371
- * @param {*} [options] Override http request option.
1372
- * @throws {RequiredError}
1373
- * @memberof CustomerControllerRestApi
1374
- */
1375
- getCustomer(requestParameters: CustomerControllerRestApiGetCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerResponseClass, any, {}>>;
1376
- /**
1377
- * Get a presigned download url for document.
1378
- * @summary Get a download url for document
1379
- * @param {CustomerControllerRestApiGetCustomerDocumentDownloadUrlRequest} requestParameters Request parameters.
1380
- * @param {*} [options] Override http request option.
1381
- * @throws {RequiredError}
1382
- * @memberof CustomerControllerRestApi
1383
- */
1384
- getCustomerDocumentDownloadUrl(requestParameters: CustomerControllerRestApiGetCustomerDocumentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerDocumentDownloadUrlResponseClass, any, {}>>;
1385
- /**
1386
- * Start auth process to get new access token, refresh token after successful login.
1387
- * @summary Initiate auth by customer
1388
- * @param {CustomerControllerRestApiInitiateAuthRequest} requestParameters Request parameters.
1389
- * @param {*} [options] Override http request option.
1390
- * @throws {RequiredError}
1391
- * @memberof CustomerControllerRestApi
1392
- */
1393
- initiateAuth(requestParameters: CustomerControllerRestApiInitiateAuthRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateAuthResponseClass, any, {}>>;
1394
- /**
1395
- * Request to initiate a payment change by customer.
1396
- * @summary Request payment setup initiation
1397
- * @param {CustomerControllerRestApiInitiatePaymentSetupRequest} requestParameters Request parameters.
1398
- * @param {*} [options] Override http request option.
1399
- * @throws {RequiredError}
1400
- * @memberof CustomerControllerRestApi
1401
- */
1402
- initiatePaymentSetup(requestParameters: CustomerControllerRestApiInitiatePaymentSetupRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiatePaymentSetupResponseClass, any, {}>>;
1403
- /**
1404
- * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported.
1405
- * @summary Invite a customer by self
1406
- * @param {CustomerControllerRestApiInviteByCustomerRequest} requestParameters Request parameters.
1407
- * @param {*} [options] Override http request option.
1408
- * @throws {RequiredError}
1409
- * @memberof CustomerControllerRestApi
1410
- */
1411
- inviteByCustomer(requestParameters: CustomerControllerRestApiInviteByCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteByCustomerResponseClass, any, {}>>;
1412
- /**
1413
- * Send a customer an invite via email to register. An account should have been created before inviting the customer. To invite users without accounts and policies is not yet supported. **Required Permissions** \"customer-management.customers.create\"
1414
- * @summary Invite a customer by tenant
1415
- * @param {CustomerControllerRestApiInviteByTenantRequest} requestParameters Request parameters.
1416
- * @param {*} [options] Override http request option.
1417
- * @throws {RequiredError}
1418
- * @memberof CustomerControllerRestApi
1419
- */
1420
- inviteByTenant(requestParameters: CustomerControllerRestApiInviteByTenantRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteByTenantResponseClass, any, {}>>;
1421
- /**
1422
- * Get customer list.
1423
- * @summary Get customers list
1424
- * @param {CustomerControllerRestApiListCustomersRequest} requestParameters Request parameters.
1425
- * @param {*} [options] Override http request option.
1426
- * @throws {RequiredError}
1427
- * @memberof CustomerControllerRestApi
1428
- */
1429
- listCustomers(requestParameters?: CustomerControllerRestApiListCustomersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
1430
- /**
1431
- * List all the documents of a customer.
1432
- * @summary List documents of a customer
1433
- * @param {CustomerControllerRestApiListDocumentsRequest} requestParameters Request parameters.
1434
- * @param {*} [options] Override http request option.
1435
- * @throws {RequiredError}
1436
- * @memberof CustomerControllerRestApi
1437
- */
1438
- listDocuments(requestParameters: CustomerControllerRestApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any, {}>>;
1439
- /**
1440
- * List all the invoices of a customer.
1441
- * @summary List invoices of a customer
1442
- * @param {CustomerControllerRestApiListInvoicesRequest} requestParameters Request parameters.
1443
- * @param {*} [options] Override http request option.
1444
- * @throws {RequiredError}
1445
- * @memberof CustomerControllerRestApi
1446
- */
1447
- listInvoices(requestParameters: CustomerControllerRestApiListInvoicesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListInvoicesResponseClass, any, {}>>;
1448
- /**
1449
- * Get new access token, new refresh token.
1450
- * @summary Refresh token by customer
1451
- * @param {CustomerControllerRestApiRefreshTokenRequest} requestParameters Request parameters.
1452
- * @param {*} [options] Override http request option.
1453
- * @throws {RequiredError}
1454
- * @memberof CustomerControllerRestApi
1455
- */
1456
- refreshToken(requestParameters: CustomerControllerRestApiRefreshTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1457
- /**
1458
- * Request a token to change the email address for the customer.
1459
- * @summary Request customer email change
1460
- * @param {CustomerControllerRestApiRequestChangeEmailByCustomerRequest} requestParameters Request parameters.
1461
- * @param {*} [options] Override http request option.
1462
- * @throws {RequiredError}
1463
- * @memberof CustomerControllerRestApi
1464
- */
1465
- requestChangeEmailByCustomer(requestParameters: CustomerControllerRestApiRequestChangeEmailByCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RequestChangeEmailByCustomerResponseClass, any, {}>>;
1466
- /**
1467
- * Change customer\'s password using the token provided by the reset password endpoint.
1468
- * @summary Change password by customer
1469
- * @param {CustomerControllerRestApiResetPasswordRequest} requestParameters Request parameters.
1470
- * @param {*} [options] Override http request option.
1471
- * @throws {RequiredError}
1472
- * @memberof CustomerControllerRestApi
1473
- */
1474
- resetPassword(requestParameters: CustomerControllerRestApiResetPasswordRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
1475
- /**
1476
- * Respond to the auth challenge by customer to get new access token, refresh token after successful login.
1477
- * @summary Respond to auth challenge
1478
- * @param {CustomerControllerRestApiRespondToAuthChallengeRequest} requestParameters Request parameters.
1479
- * @param {*} [options] Override http request option.
1480
- * @throws {RequiredError}
1481
- * @memberof CustomerControllerRestApi
1482
- */
1483
- respondToAuthChallenge(requestParameters: CustomerControllerRestApiRespondToAuthChallengeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RespondToAuthChallengeClass, any, {}>>;
1484
- /**
1485
- * Update customer details like phone, names, addresses etc. To change email, please use Request customer email change endpoint instead.
1486
- * @summary Update customer details
1487
- * @param {CustomerControllerRestApiUpdateCustomerRequest} requestParameters Request parameters.
1488
- * @param {*} [options] Override http request option.
1489
- * @throws {RequiredError}
1490
- * @memberof CustomerControllerRestApi
1491
- */
1492
- updateCustomer(requestParameters: CustomerControllerRestApiUpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerResponseClass, any, {}>>;
1493
- /**
1494
- * API to upload and attach documents to an account.
1495
- * @summary Upload account documents
1496
- * @param {CustomerControllerRestApiUploadAccountDocumentsRequest} requestParameters Request parameters.
1497
- * @param {*} [options] Override http request option.
1498
- * @throws {RequiredError}
1499
- * @memberof CustomerControllerRestApi
1500
- */
1501
- uploadAccountDocuments(requestParameters: CustomerControllerRestApiUploadAccountDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any, {}>>;
1502
- /**
1503
- * Verify the change email token that is sent by calling the request change email endpoint.
1504
- * @summary Verify the change email token
1505
- * @param {CustomerControllerRestApiVerifyChangeEmailTokenRequest} requestParameters Request parameters.
1506
- * @param {*} [options] Override http request option.
1507
- * @throws {RequiredError}
1508
- * @memberof CustomerControllerRestApi
1509
- */
1510
- verifyChangeEmailToken(requestParameters: CustomerControllerRestApiVerifyChangeEmailTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifyChangeEmailTokenResponseClass, any, {}>>;
1511
- /**
1512
- * Verify the invite sent to the customer via email.
1513
- * @summary Verify customer\'s invite token
1514
- * @param {CustomerControllerRestApiVerifyInviteRequest} requestParameters Request parameters.
1515
- * @param {*} [options] Override http request option.
1516
- * @throws {RequiredError}
1517
- * @memberof CustomerControllerRestApi
1518
- */
1519
- verifyInvite(requestParameters: CustomerControllerRestApiVerifyInviteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifyCustomerInviteResponseClass, any, {}>>;
1520
- /**
1521
- * Verify the reset password token that is sent by calling the \'forgot password\' endpoint.
1522
- * @summary Verify a reset password token
1523
- * @param {CustomerControllerRestApiVerifyResetPasswordTokenRequest} requestParameters Request parameters.
1524
- * @param {*} [options] Override http request option.
1525
- * @throws {RequiredError}
1526
- * @memberof CustomerControllerRestApi
1527
- */
1528
- verifyResetPasswordToken(requestParameters: CustomerControllerRestApiVerifyResetPasswordTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifyResetPasswordTokenResponseClass, any, {}>>;
1529
- }