@emilgroup/customer-sdk-node 1.3.0 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/.openapi-generator/FILES +15 -1
  2. package/README.md +2 -2
  3. package/api/customers-api.ts +798 -82
  4. package/base.ts +56 -13
  5. package/dist/api/customers-api.d.ts +456 -36
  6. package/dist/api/customers-api.js +579 -40
  7. package/dist/base.d.ts +1 -0
  8. package/dist/base.js +46 -8
  9. package/dist/models/account-class.d.ts +132 -0
  10. package/dist/models/account-class.js +15 -0
  11. package/dist/models/create-customer-request-dto.d.ts +0 -7
  12. package/dist/models/create-customer-response-class.d.ts +3 -2
  13. package/dist/models/customer-class.d.ts +67 -0
  14. package/dist/models/customer-class.js +15 -0
  15. package/dist/models/customer-document-class.d.ts +99 -0
  16. package/dist/models/customer-document-class.js +36 -0
  17. package/dist/models/get-customer-document-download-url-response-class.d.ts +24 -0
  18. package/dist/models/get-customer-document-download-url-response-class.js +15 -0
  19. package/dist/models/get-customer-response-class.d.ts +25 -0
  20. package/dist/models/get-customer-response-class.js +15 -0
  21. package/dist/models/index.d.ts +15 -1
  22. package/dist/models/index.js +15 -1
  23. package/dist/models/invoice-class.d.ts +135 -0
  24. package/dist/models/invoice-class.js +28 -0
  25. package/dist/models/list-documents-response-class.d.ts +31 -0
  26. package/dist/models/list-documents-response-class.js +15 -0
  27. package/dist/models/list-invoices-response-class.d.ts +3 -2
  28. package/dist/models/request-policy-update-request-dto.d.ts +42 -0
  29. package/dist/models/request-policy-update-request-dto.js +15 -0
  30. package/dist/models/reset-password-by-customer-request-dto.d.ts +1 -1
  31. package/dist/models/shared-invoice-item-class.d.ts +102 -0
  32. package/dist/models/shared-invoice-item-class.js +15 -0
  33. package/dist/models/terminate-customer-policy-request-dto.d.ts +24 -0
  34. package/dist/models/terminate-customer-policy-request-dto.js +15 -0
  35. package/dist/models/terminate-customer-policy-response-class.d.ts +25 -0
  36. package/dist/models/terminate-customer-policy-response-class.js +15 -0
  37. package/dist/models/{create-account-request-dto.d.ts → update-account-request-dto.d.ts} +26 -32
  38. package/dist/models/{create-account-request-dto.js → update-account-request-dto.js} +2 -2
  39. package/dist/models/update-customer-request-dto.d.ts +31 -0
  40. package/dist/models/update-customer-request-dto.js +15 -0
  41. package/dist/models/update-customer-response-class.d.ts +25 -0
  42. package/dist/models/update-customer-response-class.js +15 -0
  43. package/dist/models/withdraw-customer-policy-response-class.d.ts +25 -0
  44. package/dist/models/withdraw-customer-policy-response-class.js +15 -0
  45. package/models/account-class.ts +138 -0
  46. package/models/create-customer-request-dto.ts +0 -7
  47. package/models/create-customer-response-class.ts +3 -2
  48. package/models/customer-class.ts +73 -0
  49. package/models/customer-document-class.ts +108 -0
  50. package/models/get-customer-document-download-url-response-class.ts +30 -0
  51. package/models/get-customer-response-class.ts +31 -0
  52. package/models/index.ts +15 -1
  53. package/models/invoice-class.ts +145 -0
  54. package/models/list-documents-response-class.ts +37 -0
  55. package/models/list-invoices-response-class.ts +3 -2
  56. package/models/request-policy-update-request-dto.ts +48 -0
  57. package/models/reset-password-by-customer-request-dto.ts +1 -1
  58. package/models/shared-invoice-item-class.ts +108 -0
  59. package/models/terminate-customer-policy-request-dto.ts +30 -0
  60. package/models/terminate-customer-policy-response-class.ts +31 -0
  61. package/models/{create-account-request-dto.ts → update-account-request-dto.ts} +26 -32
  62. package/models/update-customer-request-dto.ts +37 -0
  63. package/models/update-customer-response-class.ts +31 -0
  64. package/models/withdraw-customer-policy-response-class.ts +31 -0
  65. package/package.json +1 -1
@@ -15,20 +15,29 @@ import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateCustomerRequestDto } from '../models';
16
16
  import { CreateCustomerResponseClass } from '../models';
17
17
  import { ForgotPasswordRequestDto } from '../models';
18
+ import { GetCustomerDocumentDownloadUrlResponseClass } from '../models';
19
+ import { GetCustomerResponseClass } from '../models';
18
20
  import { GetPolicyResponseClass } from '../models';
19
21
  import { InitiateAuthRequestDto } from '../models';
20
22
  import { InitiateAuthResponseClass } from '../models';
21
23
  import { InviteByCustomerRequestDto } from '../models';
22
24
  import { InviteByCustomerResponseClass } from '../models';
23
25
  import { InviteByTenantResponseClass } from '../models';
26
+ import { ListDocumentsResponseClass } from '../models';
24
27
  import { ListInvoicesResponseClass } from '../models';
25
28
  import { ListPoliciesResponseClass } from '../models';
26
29
  import { RefreshTokenDto } from '../models';
30
+ import { RequestPolicyUpdateRequestDto } from '../models';
27
31
  import { RequestPolicyUpdateResponseClass } from '../models';
28
32
  import { ResetPasswordByCustomerRequestDto } from '../models';
29
33
  import { RespondToAuthChallengeClass } from '../models';
30
34
  import { RespondToAuthChallengeRequestDto } from '../models';
35
+ import { TerminateCustomerPolicyRequestDto } from '../models';
36
+ import { TerminateCustomerPolicyResponseClass } from '../models';
37
+ import { UpdateCustomerRequestDto } from '../models';
38
+ import { UpdateCustomerResponseClass } from '../models';
31
39
  import { VerifyCustomerInviteResponseClass } from '../models';
40
+ import { WithdrawCustomerPolicyResponseClass } from '../models';
32
41
  /**
33
42
  * CustomersApi - axios parameter creator
34
43
  * @export
@@ -50,6 +59,26 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
50
59
  * @throws {RequiredError}
51
60
  */
52
61
  forgotPassword: (forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
62
+ /**
63
+ * Get customer details
64
+ * @summary Get customer details
65
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
66
+ * @param {string} [expand] Fields to expand response by - [account]
67
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
68
+ * @param {*} [options] Override http request option.
69
+ * @throws {RequiredError}
70
+ */
71
+ getCustomer: (customerCode: string, expand?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
72
+ /**
73
+ * Get a presigned download url for document
74
+ * @summary Get a presigned download url for document
75
+ * @param {string} documentCode The document code
76
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
77
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ getCustomerDocumentDownloadUrl: (documentCode: string, customerCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
82
  /**
54
83
  * Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
55
84
  * @summary Get policy details
@@ -87,6 +116,21 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
87
116
  * @throws {RequiredError}
88
117
  */
89
118
  inviteByTenant: (inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
119
+ /**
120
+ * List all the documents of a customer
121
+ * @summary List documents of a customer
122
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
123
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
124
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
125
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
126
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
127
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
128
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
129
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
130
+ * @param {*} [options] Override http request option.
131
+ * @throws {RequiredError}
132
+ */
133
+ listDocuments: (customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
90
134
  /**
91
135
  * List all the invoices of a customer
92
136
  * @summary List invoices of a customer
@@ -131,15 +175,12 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
131
175
  * @summary Request policy update by customer
132
176
  * @param {string} policyCode The policy code
133
177
  * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
134
- * @param {string} code Policy code
135
- * @param {Array<string>} policyObjects Policy objects
136
- * @param {string} from Update from
137
- * @param {string} [to] Update to
178
+ * @param {RequestPolicyUpdateRequestDto} requestPolicyUpdateRequestDto
138
179
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
139
180
  * @param {*} [options] Override http request option.
140
181
  * @throws {RequiredError}
141
182
  */
142
- requestPolicyUpdate: (policyCode: string, customerCode: string, code: string, policyObjects: Array<string>, from: string, to?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
183
+ requestPolicyUpdate: (policyCode: string, customerCode: string, requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
143
184
  /**
144
185
  * Change customer\'s password using the token provided by the reset password endpoint.
145
186
  * @summary Change password by customer
@@ -156,6 +197,27 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
156
197
  * @throws {RequiredError}
157
198
  */
158
199
  respondToAuthChallenge: (respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
200
+ /**
201
+ * Request to terminate an existing policy by customer
202
+ * @summary Terminate a policy by customer
203
+ * @param {string} policyCode The policy code
204
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
205
+ * @param {TerminateCustomerPolicyRequestDto} terminateCustomerPolicyRequestDto
206
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
207
+ * @param {*} [options] Override http request option.
208
+ * @throws {RequiredError}
209
+ */
210
+ terminateCustomerPolicy: (policyCode: string, customerCode: string, terminateCustomerPolicyRequestDto: TerminateCustomerPolicyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
211
+ /**
212
+ * Update customer details like phone, email, names, addresses etc
213
+ * @summary Update customer details
214
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
215
+ * @param {UpdateCustomerRequestDto} updateCustomerRequestDto
216
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
217
+ * @param {*} [options] Override http request option.
218
+ * @throws {RequiredError}
219
+ */
220
+ updateCustomer: (customerCode: string, updateCustomerRequestDto: UpdateCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
159
221
  /**
160
222
  * Verify the invite sent to the customer via email.
161
223
  * @summary Verify customer\'s invite token
@@ -172,6 +234,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
172
234
  * @throws {RequiredError}
173
235
  */
174
236
  verifyResetPasswordToken: (resetToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
237
+ /**
238
+ * Withdraw policy by customer
239
+ * @summary Withdraw policy by customer
240
+ * @param {string} policyCode The policy code
241
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
242
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ */
246
+ withdrawCustomerPolicy: (policyCode: string, customerCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
175
247
  };
176
248
  /**
177
249
  * CustomersApi - functional programming interface
@@ -194,6 +266,26 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
194
266
  * @throws {RequiredError}
195
267
  */
196
268
  forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
269
+ /**
270
+ * Get customer details
271
+ * @summary Get customer details
272
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
273
+ * @param {string} [expand] Fields to expand response by - [account]
274
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
275
+ * @param {*} [options] Override http request option.
276
+ * @throws {RequiredError}
277
+ */
278
+ getCustomer(customerCode: string, expand?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerResponseClass>>;
279
+ /**
280
+ * Get a presigned download url for document
281
+ * @summary Get a presigned download url for document
282
+ * @param {string} documentCode The document code
283
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
284
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
285
+ * @param {*} [options] Override http request option.
286
+ * @throws {RequiredError}
287
+ */
288
+ getCustomerDocumentDownloadUrl(documentCode: string, customerCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerDocumentDownloadUrlResponseClass>>;
197
289
  /**
198
290
  * Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
199
291
  * @summary Get policy details
@@ -231,6 +323,21 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
231
323
  * @throws {RequiredError}
232
324
  */
233
325
  inviteByTenant(inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteByTenantResponseClass>>;
326
+ /**
327
+ * List all the documents of a customer
328
+ * @summary List documents of a customer
329
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
330
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
331
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
332
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
333
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
334
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
335
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
336
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
337
+ * @param {*} [options] Override http request option.
338
+ * @throws {RequiredError}
339
+ */
340
+ listDocuments(customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>>;
234
341
  /**
235
342
  * List all the invoices of a customer
236
343
  * @summary List invoices of a customer
@@ -275,15 +382,12 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
275
382
  * @summary Request policy update by customer
276
383
  * @param {string} policyCode The policy code
277
384
  * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
278
- * @param {string} code Policy code
279
- * @param {Array<string>} policyObjects Policy objects
280
- * @param {string} from Update from
281
- * @param {string} [to] Update to
385
+ * @param {RequestPolicyUpdateRequestDto} requestPolicyUpdateRequestDto
282
386
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
283
387
  * @param {*} [options] Override http request option.
284
388
  * @throws {RequiredError}
285
389
  */
286
- requestPolicyUpdate(policyCode: string, customerCode: string, code: string, policyObjects: Array<string>, from: string, to?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestPolicyUpdateResponseClass>>;
390
+ requestPolicyUpdate(policyCode: string, customerCode: string, requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestPolicyUpdateResponseClass>>;
287
391
  /**
288
392
  * Change customer\'s password using the token provided by the reset password endpoint.
289
393
  * @summary Change password by customer
@@ -300,6 +404,27 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
300
404
  * @throws {RequiredError}
301
405
  */
302
406
  respondToAuthChallenge(respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RespondToAuthChallengeClass>>;
407
+ /**
408
+ * Request to terminate an existing policy by customer
409
+ * @summary Terminate a policy by customer
410
+ * @param {string} policyCode The policy code
411
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
412
+ * @param {TerminateCustomerPolicyRequestDto} terminateCustomerPolicyRequestDto
413
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
414
+ * @param {*} [options] Override http request option.
415
+ * @throws {RequiredError}
416
+ */
417
+ terminateCustomerPolicy(policyCode: string, customerCode: string, terminateCustomerPolicyRequestDto: TerminateCustomerPolicyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TerminateCustomerPolicyResponseClass>>;
418
+ /**
419
+ * Update customer details like phone, email, names, addresses etc
420
+ * @summary Update customer details
421
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
422
+ * @param {UpdateCustomerRequestDto} updateCustomerRequestDto
423
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
424
+ * @param {*} [options] Override http request option.
425
+ * @throws {RequiredError}
426
+ */
427
+ updateCustomer(customerCode: string, updateCustomerRequestDto: UpdateCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerResponseClass>>;
303
428
  /**
304
429
  * Verify the invite sent to the customer via email.
305
430
  * @summary Verify customer\'s invite token
@@ -316,6 +441,16 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
316
441
  * @throws {RequiredError}
317
442
  */
318
443
  verifyResetPasswordToken(resetToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
444
+ /**
445
+ * Withdraw policy by customer
446
+ * @summary Withdraw policy by customer
447
+ * @param {string} policyCode The policy code
448
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
449
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
450
+ * @param {*} [options] Override http request option.
451
+ * @throws {RequiredError}
452
+ */
453
+ withdrawCustomerPolicy(policyCode: string, customerCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WithdrawCustomerPolicyResponseClass>>;
319
454
  };
320
455
  /**
321
456
  * CustomersApi - factory interface
@@ -338,6 +473,26 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
338
473
  * @throws {RequiredError}
339
474
  */
340
475
  forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: any): AxiosPromise<void>;
476
+ /**
477
+ * Get customer details
478
+ * @summary Get customer details
479
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
480
+ * @param {string} [expand] Fields to expand response by - [account]
481
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
482
+ * @param {*} [options] Override http request option.
483
+ * @throws {RequiredError}
484
+ */
485
+ getCustomer(customerCode: string, expand?: string, authorization?: string, options?: any): AxiosPromise<GetCustomerResponseClass>;
486
+ /**
487
+ * Get a presigned download url for document
488
+ * @summary Get a presigned download url for document
489
+ * @param {string} documentCode The document code
490
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
491
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
492
+ * @param {*} [options] Override http request option.
493
+ * @throws {RequiredError}
494
+ */
495
+ getCustomerDocumentDownloadUrl(documentCode: string, customerCode: string, authorization?: string, options?: any): AxiosPromise<GetCustomerDocumentDownloadUrlResponseClass>;
341
496
  /**
342
497
  * Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
343
498
  * @summary Get policy details
@@ -375,6 +530,21 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
375
530
  * @throws {RequiredError}
376
531
  */
377
532
  inviteByTenant(inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: any): AxiosPromise<InviteByTenantResponseClass>;
533
+ /**
534
+ * List all the documents of a customer
535
+ * @summary List documents of a customer
536
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
537
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
538
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
539
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
540
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
541
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
542
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
543
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
544
+ * @param {*} [options] Override http request option.
545
+ * @throws {RequiredError}
546
+ */
547
+ listDocuments(customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, authorization?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
378
548
  /**
379
549
  * List all the invoices of a customer
380
550
  * @summary List invoices of a customer
@@ -419,15 +589,12 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
419
589
  * @summary Request policy update by customer
420
590
  * @param {string} policyCode The policy code
421
591
  * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
422
- * @param {string} code Policy code
423
- * @param {Array<string>} policyObjects Policy objects
424
- * @param {string} from Update from
425
- * @param {string} [to] Update to
592
+ * @param {RequestPolicyUpdateRequestDto} requestPolicyUpdateRequestDto
426
593
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
427
594
  * @param {*} [options] Override http request option.
428
595
  * @throws {RequiredError}
429
596
  */
430
- requestPolicyUpdate(policyCode: string, customerCode: string, code: string, policyObjects: Array<string>, from: string, to?: string, authorization?: string, options?: any): AxiosPromise<RequestPolicyUpdateResponseClass>;
597
+ requestPolicyUpdate(policyCode: string, customerCode: string, requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto, authorization?: string, options?: any): AxiosPromise<RequestPolicyUpdateResponseClass>;
431
598
  /**
432
599
  * Change customer\'s password using the token provided by the reset password endpoint.
433
600
  * @summary Change password by customer
@@ -444,6 +611,27 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
444
611
  * @throws {RequiredError}
445
612
  */
446
613
  respondToAuthChallenge(respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto, options?: any): AxiosPromise<RespondToAuthChallengeClass>;
614
+ /**
615
+ * Request to terminate an existing policy by customer
616
+ * @summary Terminate a policy by customer
617
+ * @param {string} policyCode The policy code
618
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
619
+ * @param {TerminateCustomerPolicyRequestDto} terminateCustomerPolicyRequestDto
620
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
621
+ * @param {*} [options] Override http request option.
622
+ * @throws {RequiredError}
623
+ */
624
+ terminateCustomerPolicy(policyCode: string, customerCode: string, terminateCustomerPolicyRequestDto: TerminateCustomerPolicyRequestDto, authorization?: string, options?: any): AxiosPromise<TerminateCustomerPolicyResponseClass>;
625
+ /**
626
+ * Update customer details like phone, email, names, addresses etc
627
+ * @summary Update customer details
628
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
629
+ * @param {UpdateCustomerRequestDto} updateCustomerRequestDto
630
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
631
+ * @param {*} [options] Override http request option.
632
+ * @throws {RequiredError}
633
+ */
634
+ updateCustomer(customerCode: string, updateCustomerRequestDto: UpdateCustomerRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCustomerResponseClass>;
447
635
  /**
448
636
  * Verify the invite sent to the customer via email.
449
637
  * @summary Verify customer\'s invite token
@@ -460,6 +648,16 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
460
648
  * @throws {RequiredError}
461
649
  */
462
650
  verifyResetPasswordToken(resetToken: string, options?: any): AxiosPromise<void>;
651
+ /**
652
+ * Withdraw policy by customer
653
+ * @summary Withdraw policy by customer
654
+ * @param {string} policyCode The policy code
655
+ * @param {string} customerCode The customer code or \&quot;me\&quot; for the currently logged in customer
656
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
657
+ * @param {*} [options] Override http request option.
658
+ * @throws {RequiredError}
659
+ */
660
+ withdrawCustomerPolicy(policyCode: string, customerCode: string, authorization?: string, options?: any): AxiosPromise<WithdrawCustomerPolicyResponseClass>;
463
661
  };
464
662
  /**
465
663
  * Request parameters for createCustomer operation in CustomersApi.
@@ -487,6 +685,56 @@ export interface CustomersApiForgotPasswordRequest {
487
685
  */
488
686
  readonly forgotPasswordRequestDto: ForgotPasswordRequestDto;
489
687
  }
688
+ /**
689
+ * Request parameters for getCustomer operation in CustomersApi.
690
+ * @export
691
+ * @interface CustomersApiGetCustomerRequest
692
+ */
693
+ export interface CustomersApiGetCustomerRequest {
694
+ /**
695
+ * The customer code or \&quot;me\&quot; for the currently logged in customer
696
+ * @type {string}
697
+ * @memberof CustomersApiGetCustomer
698
+ */
699
+ readonly customerCode: string;
700
+ /**
701
+ * Fields to expand response by - [account]
702
+ * @type {string}
703
+ * @memberof CustomersApiGetCustomer
704
+ */
705
+ readonly expand?: string;
706
+ /**
707
+ * Bearer Token: provided by the login endpoint under the name accessToken.
708
+ * @type {string}
709
+ * @memberof CustomersApiGetCustomer
710
+ */
711
+ readonly authorization?: string;
712
+ }
713
+ /**
714
+ * Request parameters for getCustomerDocumentDownloadUrl operation in CustomersApi.
715
+ * @export
716
+ * @interface CustomersApiGetCustomerDocumentDownloadUrlRequest
717
+ */
718
+ export interface CustomersApiGetCustomerDocumentDownloadUrlRequest {
719
+ /**
720
+ * The document code
721
+ * @type {string}
722
+ * @memberof CustomersApiGetCustomerDocumentDownloadUrl
723
+ */
724
+ readonly documentCode: string;
725
+ /**
726
+ * The customer code or \&quot;me\&quot; for the currently logged in customer
727
+ * @type {string}
728
+ * @memberof CustomersApiGetCustomerDocumentDownloadUrl
729
+ */
730
+ readonly customerCode: string;
731
+ /**
732
+ * Bearer Token: provided by the login endpoint under the name accessToken.
733
+ * @type {string}
734
+ * @memberof CustomersApiGetCustomerDocumentDownloadUrl
735
+ */
736
+ readonly authorization?: string;
737
+ }
490
738
  /**
491
739
  * Request parameters for getPolicy operation in CustomersApi.
492
740
  * @export
@@ -569,6 +817,61 @@ export interface CustomersApiInviteByTenantRequest {
569
817
  */
570
818
  readonly authorization?: string;
571
819
  }
820
+ /**
821
+ * Request parameters for listDocuments operation in CustomersApi.
822
+ * @export
823
+ * @interface CustomersApiListDocumentsRequest
824
+ */
825
+ export interface CustomersApiListDocumentsRequest {
826
+ /**
827
+ * The customer code or \&quot;me\&quot; for the currently logged in customer
828
+ * @type {string}
829
+ * @memberof CustomersApiListDocuments
830
+ */
831
+ readonly customerCode: string;
832
+ /**
833
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
834
+ * @type {any}
835
+ * @memberof CustomersApiListDocuments
836
+ */
837
+ readonly pageSize?: any;
838
+ /**
839
+ * 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.
840
+ * @type {any}
841
+ * @memberof CustomersApiListDocuments
842
+ */
843
+ readonly pageToken?: any;
844
+ /**
845
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
846
+ * @type {any}
847
+ * @memberof CustomersApiListDocuments
848
+ */
849
+ readonly filter?: any;
850
+ /**
851
+ * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
852
+ * @type {any}
853
+ * @memberof CustomersApiListDocuments
854
+ */
855
+ readonly search?: any;
856
+ /**
857
+ * 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.
858
+ * @type {any}
859
+ * @memberof CustomersApiListDocuments
860
+ */
861
+ readonly order?: any;
862
+ /**
863
+ * 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.
864
+ * @type {any}
865
+ * @memberof CustomersApiListDocuments
866
+ */
867
+ readonly expand?: any;
868
+ /**
869
+ * Bearer Token: provided by the login endpoint under the name accessToken.
870
+ * @type {string}
871
+ * @memberof CustomersApiListDocuments
872
+ */
873
+ readonly authorization?: string;
874
+ }
572
875
  /**
573
876
  * Request parameters for listInvoices operation in CustomersApi.
574
877
  * @export
@@ -717,29 +1020,11 @@ export interface CustomersApiRequestPolicyUpdateRequest {
717
1020
  */
718
1021
  readonly customerCode: string;
719
1022
  /**
720
- * Policy code
721
- * @type {string}
722
- * @memberof CustomersApiRequestPolicyUpdate
723
- */
724
- readonly code: string;
725
- /**
726
- * Policy objects
727
- * @type {Array<string>}
728
- * @memberof CustomersApiRequestPolicyUpdate
729
- */
730
- readonly policyObjects: Array<string>;
731
- /**
732
- * Update from
733
- * @type {string}
734
- * @memberof CustomersApiRequestPolicyUpdate
735
- */
736
- readonly from: string;
737
- /**
738
- * Update to
739
- * @type {string}
1023
+ *
1024
+ * @type {RequestPolicyUpdateRequestDto}
740
1025
  * @memberof CustomersApiRequestPolicyUpdate
741
1026
  */
742
- readonly to?: string;
1027
+ readonly requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto;
743
1028
  /**
744
1029
  * Bearer Token: provided by the login endpoint under the name accessToken.
745
1030
  * @type {string}
@@ -773,6 +1058,62 @@ export interface CustomersApiRespondToAuthChallengeRequest {
773
1058
  */
774
1059
  readonly respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto;
775
1060
  }
1061
+ /**
1062
+ * Request parameters for terminateCustomerPolicy operation in CustomersApi.
1063
+ * @export
1064
+ * @interface CustomersApiTerminateCustomerPolicyRequest
1065
+ */
1066
+ export interface CustomersApiTerminateCustomerPolicyRequest {
1067
+ /**
1068
+ * The policy code
1069
+ * @type {string}
1070
+ * @memberof CustomersApiTerminateCustomerPolicy
1071
+ */
1072
+ readonly policyCode: string;
1073
+ /**
1074
+ * The customer code or \&quot;me\&quot; for the currently logged in customer
1075
+ * @type {string}
1076
+ * @memberof CustomersApiTerminateCustomerPolicy
1077
+ */
1078
+ readonly customerCode: string;
1079
+ /**
1080
+ *
1081
+ * @type {TerminateCustomerPolicyRequestDto}
1082
+ * @memberof CustomersApiTerminateCustomerPolicy
1083
+ */
1084
+ readonly terminateCustomerPolicyRequestDto: TerminateCustomerPolicyRequestDto;
1085
+ /**
1086
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1087
+ * @type {string}
1088
+ * @memberof CustomersApiTerminateCustomerPolicy
1089
+ */
1090
+ readonly authorization?: string;
1091
+ }
1092
+ /**
1093
+ * Request parameters for updateCustomer operation in CustomersApi.
1094
+ * @export
1095
+ * @interface CustomersApiUpdateCustomerRequest
1096
+ */
1097
+ export interface CustomersApiUpdateCustomerRequest {
1098
+ /**
1099
+ * The customer code or \&quot;me\&quot; for the currently logged in customer
1100
+ * @type {string}
1101
+ * @memberof CustomersApiUpdateCustomer
1102
+ */
1103
+ readonly customerCode: string;
1104
+ /**
1105
+ *
1106
+ * @type {UpdateCustomerRequestDto}
1107
+ * @memberof CustomersApiUpdateCustomer
1108
+ */
1109
+ readonly updateCustomerRequestDto: UpdateCustomerRequestDto;
1110
+ /**
1111
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1112
+ * @type {string}
1113
+ * @memberof CustomersApiUpdateCustomer
1114
+ */
1115
+ readonly authorization?: string;
1116
+ }
776
1117
  /**
777
1118
  * Request parameters for verifyInvite operation in CustomersApi.
778
1119
  * @export
@@ -799,6 +1140,31 @@ export interface CustomersApiVerifyResetPasswordTokenRequest {
799
1140
  */
800
1141
  readonly resetToken: string;
801
1142
  }
1143
+ /**
1144
+ * Request parameters for withdrawCustomerPolicy operation in CustomersApi.
1145
+ * @export
1146
+ * @interface CustomersApiWithdrawCustomerPolicyRequest
1147
+ */
1148
+ export interface CustomersApiWithdrawCustomerPolicyRequest {
1149
+ /**
1150
+ * The policy code
1151
+ * @type {string}
1152
+ * @memberof CustomersApiWithdrawCustomerPolicy
1153
+ */
1154
+ readonly policyCode: string;
1155
+ /**
1156
+ * The customer code or \&quot;me\&quot; for the currently logged in customer
1157
+ * @type {string}
1158
+ * @memberof CustomersApiWithdrawCustomerPolicy
1159
+ */
1160
+ readonly customerCode: string;
1161
+ /**
1162
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1163
+ * @type {string}
1164
+ * @memberof CustomersApiWithdrawCustomerPolicy
1165
+ */
1166
+ readonly authorization?: string;
1167
+ }
802
1168
  /**
803
1169
  * CustomersApi - object-oriented interface
804
1170
  * @export
@@ -824,6 +1190,24 @@ export declare class CustomersApi extends BaseAPI {
824
1190
  * @memberof CustomersApi
825
1191
  */
826
1192
  forgotPassword(requestParameters: CustomersApiForgotPasswordRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1193
+ /**
1194
+ * Get customer details
1195
+ * @summary Get customer details
1196
+ * @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
1197
+ * @param {*} [options] Override http request option.
1198
+ * @throws {RequiredError}
1199
+ * @memberof CustomersApi
1200
+ */
1201
+ getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerResponseClass, any>>;
1202
+ /**
1203
+ * Get a presigned download url for document
1204
+ * @summary Get a presigned download url for document
1205
+ * @param {CustomersApiGetCustomerDocumentDownloadUrlRequest} requestParameters Request parameters.
1206
+ * @param {*} [options] Override http request option.
1207
+ * @throws {RequiredError}
1208
+ * @memberof CustomersApi
1209
+ */
1210
+ getCustomerDocumentDownloadUrl(requestParameters: CustomersApiGetCustomerDocumentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerDocumentDownloadUrlResponseClass, any>>;
827
1211
  /**
828
1212
  * Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
829
1213
  * @summary Get policy details
@@ -860,6 +1244,15 @@ export declare class CustomersApi extends BaseAPI {
860
1244
  * @memberof CustomersApi
861
1245
  */
862
1246
  inviteByTenant(requestParameters: CustomersApiInviteByTenantRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteByTenantResponseClass, any>>;
1247
+ /**
1248
+ * List all the documents of a customer
1249
+ * @summary List documents of a customer
1250
+ * @param {CustomersApiListDocumentsRequest} requestParameters Request parameters.
1251
+ * @param {*} [options] Override http request option.
1252
+ * @throws {RequiredError}
1253
+ * @memberof CustomersApi
1254
+ */
1255
+ listDocuments(requestParameters: CustomersApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
863
1256
  /**
864
1257
  * List all the invoices of a customer
865
1258
  * @summary List invoices of a customer
@@ -914,6 +1307,24 @@ export declare class CustomersApi extends BaseAPI {
914
1307
  * @memberof CustomersApi
915
1308
  */
916
1309
  respondToAuthChallenge(requestParameters: CustomersApiRespondToAuthChallengeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RespondToAuthChallengeClass, any>>;
1310
+ /**
1311
+ * Request to terminate an existing policy by customer
1312
+ * @summary Terminate a policy by customer
1313
+ * @param {CustomersApiTerminateCustomerPolicyRequest} requestParameters Request parameters.
1314
+ * @param {*} [options] Override http request option.
1315
+ * @throws {RequiredError}
1316
+ * @memberof CustomersApi
1317
+ */
1318
+ terminateCustomerPolicy(requestParameters: CustomersApiTerminateCustomerPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminateCustomerPolicyResponseClass, any>>;
1319
+ /**
1320
+ * Update customer details like phone, email, names, addresses etc
1321
+ * @summary Update customer details
1322
+ * @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
1323
+ * @param {*} [options] Override http request option.
1324
+ * @throws {RequiredError}
1325
+ * @memberof CustomersApi
1326
+ */
1327
+ updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerResponseClass, any>>;
917
1328
  /**
918
1329
  * Verify the invite sent to the customer via email.
919
1330
  * @summary Verify customer\'s invite token
@@ -932,4 +1343,13 @@ export declare class CustomersApi extends BaseAPI {
932
1343
  * @memberof CustomersApi
933
1344
  */
934
1345
  verifyResetPasswordToken(requestParameters: CustomersApiVerifyResetPasswordTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
1346
+ /**
1347
+ * Withdraw policy by customer
1348
+ * @summary Withdraw policy by customer
1349
+ * @param {CustomersApiWithdrawCustomerPolicyRequest} requestParameters Request parameters.
1350
+ * @param {*} [options] Override http request option.
1351
+ * @throws {RequiredError}
1352
+ * @memberof CustomersApi
1353
+ */
1354
+ withdrawCustomerPolicy(requestParameters: CustomersApiWithdrawCustomerPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WithdrawCustomerPolicyResponseClass, any>>;
935
1355
  }