@emilgroup/customer-sdk-node 1.1.1 → 1.4.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.
- package/.openapi-generator/FILES +7 -0
- package/README.md +22 -5
- package/api/customers-api.ts +549 -8
- package/base.ts +150 -9
- package/dist/api/customers-api.d.ts +324 -8
- package/dist/api/customers-api.js +398 -8
- package/dist/base.d.ts +12 -3
- package/dist/base.js +192 -13
- package/dist/models/get-customer-response-class.d.ts +24 -0
- package/dist/models/get-customer-response-class.js +15 -0
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/models/initiate-auth-response-class.d.ts +4 -4
- package/dist/models/list-documents-response-class.d.ts +30 -0
- package/dist/models/list-documents-response-class.js +15 -0
- package/dist/models/request-policy-update-request-dto.d.ts +42 -0
- package/dist/models/request-policy-update-request-dto.js +15 -0
- package/dist/models/request-policy-update-response-class.d.ts +25 -0
- package/dist/models/request-policy-update-response-class.js +15 -0
- package/dist/models/respond-to-auth-challenge-class.d.ts +4 -4
- package/dist/models/update-account-request-dto.d.ts +96 -0
- package/dist/models/update-account-request-dto.js +21 -0
- package/dist/models/update-customer-request-dto.d.ts +31 -0
- package/dist/models/update-customer-request-dto.js +15 -0
- package/dist/models/update-customer-response-class.d.ts +24 -0
- package/dist/models/update-customer-response-class.js +15 -0
- package/models/get-customer-response-class.ts +30 -0
- package/models/index.ts +7 -0
- package/models/initiate-auth-response-class.ts +4 -4
- package/models/list-documents-response-class.ts +36 -0
- package/models/request-policy-update-request-dto.ts +48 -0
- package/models/request-policy-update-response-class.ts +31 -0
- package/models/respond-to-auth-challenge-class.ts +4 -4
- package/models/update-account-request-dto.ts +105 -0
- package/models/update-customer-request-dto.ts +37 -0
- package/models/update-customer-response-class.ts +30 -0
- package/package.json +4 -3
|
@@ -15,18 +15,24 @@ 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 { GetCustomerResponseClass } from '../models';
|
|
18
19
|
import { GetPolicyResponseClass } from '../models';
|
|
19
20
|
import { InitiateAuthRequestDto } from '../models';
|
|
20
21
|
import { InitiateAuthResponseClass } from '../models';
|
|
21
22
|
import { InviteByCustomerRequestDto } from '../models';
|
|
22
23
|
import { InviteByCustomerResponseClass } from '../models';
|
|
23
24
|
import { InviteByTenantResponseClass } from '../models';
|
|
25
|
+
import { ListDocumentsResponseClass } from '../models';
|
|
24
26
|
import { ListInvoicesResponseClass } from '../models';
|
|
25
27
|
import { ListPoliciesResponseClass } from '../models';
|
|
26
28
|
import { RefreshTokenDto } from '../models';
|
|
29
|
+
import { RequestPolicyUpdateRequestDto } from '../models';
|
|
30
|
+
import { RequestPolicyUpdateResponseClass } from '../models';
|
|
27
31
|
import { ResetPasswordByCustomerRequestDto } from '../models';
|
|
28
32
|
import { RespondToAuthChallengeClass } from '../models';
|
|
29
33
|
import { RespondToAuthChallengeRequestDto } from '../models';
|
|
34
|
+
import { UpdateCustomerRequestDto } from '../models';
|
|
35
|
+
import { UpdateCustomerResponseClass } from '../models';
|
|
30
36
|
import { VerifyCustomerInviteResponseClass } from '../models';
|
|
31
37
|
/**
|
|
32
38
|
* CustomersApi - axios parameter creator
|
|
@@ -49,6 +55,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
49
55
|
* @throws {RequiredError}
|
|
50
56
|
*/
|
|
51
57
|
forgotPassword: (forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
+
/**
|
|
59
|
+
* Get customer details
|
|
60
|
+
* @summary Get customer details
|
|
61
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
62
|
+
* @param {string} [expand] Fields to expand response by - [account]
|
|
63
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
64
|
+
* @param {*} [options] Override http request option.
|
|
65
|
+
* @throws {RequiredError}
|
|
66
|
+
*/
|
|
67
|
+
getCustomer: (customerCode: string, expand?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
68
|
/**
|
|
53
69
|
* Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
|
|
54
70
|
* @summary Get policy details
|
|
@@ -70,7 +86,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
70
86
|
initiateAuth: (initiateAuthRequestDto: InitiateAuthRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
71
87
|
/**
|
|
72
88
|
* 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.
|
|
73
|
-
* @summary Invite by
|
|
89
|
+
* @summary Invite a customer by self
|
|
74
90
|
* @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto
|
|
75
91
|
* @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\'s Auth login endpoint under the name accessToken
|
|
76
92
|
* @param {*} [options] Override http request option.
|
|
@@ -79,13 +95,28 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
79
95
|
inviteByCustomer: (inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
80
96
|
/**
|
|
81
97
|
* 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.
|
|
82
|
-
* @summary Invite by tenant
|
|
98
|
+
* @summary Invite a customer by tenant
|
|
83
99
|
* @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto
|
|
84
100
|
* @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\'s Auth login endpoint under the name accessToken
|
|
85
101
|
* @param {*} [options] Override http request option.
|
|
86
102
|
* @throws {RequiredError}
|
|
87
103
|
*/
|
|
88
104
|
inviteByTenant: (inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
105
|
+
/**
|
|
106
|
+
* List all the documents of a customer
|
|
107
|
+
* @summary List documents of a customer
|
|
108
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
109
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
110
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
111
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
112
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
113
|
+
* @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.
|
|
114
|
+
* @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.
|
|
115
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
116
|
+
* @param {*} [options] Override http request option.
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
*/
|
|
119
|
+
listDocuments: (customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
89
120
|
/**
|
|
90
121
|
* List all the invoices of a customer
|
|
91
122
|
* @summary List invoices of a customer
|
|
@@ -125,6 +156,17 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
125
156
|
* @throws {RequiredError}
|
|
126
157
|
*/
|
|
127
158
|
refreshToken: (refreshTokenDto: RefreshTokenDto, cookie?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
159
|
+
/**
|
|
160
|
+
* Request to update an existing policy by customer
|
|
161
|
+
* @summary Request policy update by customer
|
|
162
|
+
* @param {string} policyCode The policy code
|
|
163
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
164
|
+
* @param {RequestPolicyUpdateRequestDto} requestPolicyUpdateRequestDto
|
|
165
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
166
|
+
* @param {*} [options] Override http request option.
|
|
167
|
+
* @throws {RequiredError}
|
|
168
|
+
*/
|
|
169
|
+
requestPolicyUpdate: (policyCode: string, customerCode: string, requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
128
170
|
/**
|
|
129
171
|
* Change customer\'s password using the token provided by the reset password endpoint.
|
|
130
172
|
* @summary Change password by customer
|
|
@@ -141,6 +183,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
141
183
|
* @throws {RequiredError}
|
|
142
184
|
*/
|
|
143
185
|
respondToAuthChallenge: (respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
186
|
+
/**
|
|
187
|
+
* Update customer details like phone, email, names, addresses etc
|
|
188
|
+
* @summary Update customer details
|
|
189
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
190
|
+
* @param {UpdateCustomerRequestDto} updateCustomerRequestDto
|
|
191
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
192
|
+
* @param {*} [options] Override http request option.
|
|
193
|
+
* @throws {RequiredError}
|
|
194
|
+
*/
|
|
195
|
+
updateCustomer: (customerCode: string, updateCustomerRequestDto: UpdateCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
144
196
|
/**
|
|
145
197
|
* Verify the invite sent to the customer via email.
|
|
146
198
|
* @summary Verify customer\'s invite token
|
|
@@ -179,6 +231,16 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
179
231
|
* @throws {RequiredError}
|
|
180
232
|
*/
|
|
181
233
|
forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
234
|
+
/**
|
|
235
|
+
* Get customer details
|
|
236
|
+
* @summary Get customer details
|
|
237
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
238
|
+
* @param {string} [expand] Fields to expand response by - [account]
|
|
239
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
240
|
+
* @param {*} [options] Override http request option.
|
|
241
|
+
* @throws {RequiredError}
|
|
242
|
+
*/
|
|
243
|
+
getCustomer(customerCode: string, expand?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCustomerResponseClass>>;
|
|
182
244
|
/**
|
|
183
245
|
* Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
|
|
184
246
|
* @summary Get policy details
|
|
@@ -200,7 +262,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
200
262
|
initiateAuth(initiateAuthRequestDto: InitiateAuthRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateAuthResponseClass>>;
|
|
201
263
|
/**
|
|
202
264
|
* 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.
|
|
203
|
-
* @summary Invite by
|
|
265
|
+
* @summary Invite a customer by self
|
|
204
266
|
* @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto
|
|
205
267
|
* @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\'s Auth login endpoint under the name accessToken
|
|
206
268
|
* @param {*} [options] Override http request option.
|
|
@@ -209,13 +271,28 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
209
271
|
inviteByCustomer(inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteByCustomerResponseClass>>;
|
|
210
272
|
/**
|
|
211
273
|
* 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.
|
|
212
|
-
* @summary Invite by tenant
|
|
274
|
+
* @summary Invite a customer by tenant
|
|
213
275
|
* @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto
|
|
214
276
|
* @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\'s Auth login endpoint under the name accessToken
|
|
215
277
|
* @param {*} [options] Override http request option.
|
|
216
278
|
* @throws {RequiredError}
|
|
217
279
|
*/
|
|
218
280
|
inviteByTenant(inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InviteByTenantResponseClass>>;
|
|
281
|
+
/**
|
|
282
|
+
* List all the documents of a customer
|
|
283
|
+
* @summary List documents of a customer
|
|
284
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
285
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
286
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
287
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
288
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
289
|
+
* @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.
|
|
290
|
+
* @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.
|
|
291
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
292
|
+
* @param {*} [options] Override http request option.
|
|
293
|
+
* @throws {RequiredError}
|
|
294
|
+
*/
|
|
295
|
+
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>>;
|
|
219
296
|
/**
|
|
220
297
|
* List all the invoices of a customer
|
|
221
298
|
* @summary List invoices of a customer
|
|
@@ -255,6 +332,17 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
255
332
|
* @throws {RequiredError}
|
|
256
333
|
*/
|
|
257
334
|
refreshToken(refreshTokenDto: RefreshTokenDto, cookie?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
335
|
+
/**
|
|
336
|
+
* Request to update an existing policy by customer
|
|
337
|
+
* @summary Request policy update by customer
|
|
338
|
+
* @param {string} policyCode The policy code
|
|
339
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
340
|
+
* @param {RequestPolicyUpdateRequestDto} requestPolicyUpdateRequestDto
|
|
341
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
342
|
+
* @param {*} [options] Override http request option.
|
|
343
|
+
* @throws {RequiredError}
|
|
344
|
+
*/
|
|
345
|
+
requestPolicyUpdate(policyCode: string, customerCode: string, requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestPolicyUpdateResponseClass>>;
|
|
258
346
|
/**
|
|
259
347
|
* Change customer\'s password using the token provided by the reset password endpoint.
|
|
260
348
|
* @summary Change password by customer
|
|
@@ -271,6 +359,16 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
271
359
|
* @throws {RequiredError}
|
|
272
360
|
*/
|
|
273
361
|
respondToAuthChallenge(respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RespondToAuthChallengeClass>>;
|
|
362
|
+
/**
|
|
363
|
+
* Update customer details like phone, email, names, addresses etc
|
|
364
|
+
* @summary Update customer details
|
|
365
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
366
|
+
* @param {UpdateCustomerRequestDto} updateCustomerRequestDto
|
|
367
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
368
|
+
* @param {*} [options] Override http request option.
|
|
369
|
+
* @throws {RequiredError}
|
|
370
|
+
*/
|
|
371
|
+
updateCustomer(customerCode: string, updateCustomerRequestDto: UpdateCustomerRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCustomerResponseClass>>;
|
|
274
372
|
/**
|
|
275
373
|
* Verify the invite sent to the customer via email.
|
|
276
374
|
* @summary Verify customer\'s invite token
|
|
@@ -309,6 +407,16 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
309
407
|
* @throws {RequiredError}
|
|
310
408
|
*/
|
|
311
409
|
forgotPassword(forgotPasswordRequestDto: ForgotPasswordRequestDto, options?: any): AxiosPromise<void>;
|
|
410
|
+
/**
|
|
411
|
+
* Get customer details
|
|
412
|
+
* @summary Get customer details
|
|
413
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
414
|
+
* @param {string} [expand] Fields to expand response by - [account]
|
|
415
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
416
|
+
* @param {*} [options] Override http request option.
|
|
417
|
+
* @throws {RequiredError}
|
|
418
|
+
*/
|
|
419
|
+
getCustomer(customerCode: string, expand?: string, authorization?: string, options?: any): AxiosPromise<GetCustomerResponseClass>;
|
|
312
420
|
/**
|
|
313
421
|
* Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
|
|
314
422
|
* @summary Get policy details
|
|
@@ -330,7 +438,7 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
330
438
|
initiateAuth(initiateAuthRequestDto: InitiateAuthRequestDto, options?: any): AxiosPromise<InitiateAuthResponseClass>;
|
|
331
439
|
/**
|
|
332
440
|
* 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.
|
|
333
|
-
* @summary Invite by
|
|
441
|
+
* @summary Invite a customer by self
|
|
334
442
|
* @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto
|
|
335
443
|
* @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\'s Auth login endpoint under the name accessToken
|
|
336
444
|
* @param {*} [options] Override http request option.
|
|
@@ -339,13 +447,28 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
339
447
|
inviteByCustomer(inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: any): AxiosPromise<InviteByCustomerResponseClass>;
|
|
340
448
|
/**
|
|
341
449
|
* 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.
|
|
342
|
-
* @summary Invite by tenant
|
|
450
|
+
* @summary Invite a customer by tenant
|
|
343
451
|
* @param {InviteByCustomerRequestDto} inviteByCustomerRequestDto
|
|
344
452
|
* @param {string} [authorization] Bearer Token: provided by the Emil Insurance Suite\'s Auth login endpoint under the name accessToken
|
|
345
453
|
* @param {*} [options] Override http request option.
|
|
346
454
|
* @throws {RequiredError}
|
|
347
455
|
*/
|
|
348
456
|
inviteByTenant(inviteByCustomerRequestDto: InviteByCustomerRequestDto, authorization?: string, options?: any): AxiosPromise<InviteByTenantResponseClass>;
|
|
457
|
+
/**
|
|
458
|
+
* List all the documents of a customer
|
|
459
|
+
* @summary List documents of a customer
|
|
460
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
461
|
+
* @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
462
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
463
|
+
* @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
464
|
+
* @param {any} [search] Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
465
|
+
* @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.
|
|
466
|
+
* @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.
|
|
467
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
468
|
+
* @param {*} [options] Override http request option.
|
|
469
|
+
* @throws {RequiredError}
|
|
470
|
+
*/
|
|
471
|
+
listDocuments(customerCode: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, authorization?: string, options?: any): AxiosPromise<ListDocumentsResponseClass>;
|
|
349
472
|
/**
|
|
350
473
|
* List all the invoices of a customer
|
|
351
474
|
* @summary List invoices of a customer
|
|
@@ -385,6 +508,17 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
385
508
|
* @throws {RequiredError}
|
|
386
509
|
*/
|
|
387
510
|
refreshToken(refreshTokenDto: RefreshTokenDto, cookie?: string, options?: any): AxiosPromise<void>;
|
|
511
|
+
/**
|
|
512
|
+
* Request to update an existing policy by customer
|
|
513
|
+
* @summary Request policy update by customer
|
|
514
|
+
* @param {string} policyCode The policy code
|
|
515
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
516
|
+
* @param {RequestPolicyUpdateRequestDto} requestPolicyUpdateRequestDto
|
|
517
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
518
|
+
* @param {*} [options] Override http request option.
|
|
519
|
+
* @throws {RequiredError}
|
|
520
|
+
*/
|
|
521
|
+
requestPolicyUpdate(policyCode: string, customerCode: string, requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto, authorization?: string, options?: any): AxiosPromise<RequestPolicyUpdateResponseClass>;
|
|
388
522
|
/**
|
|
389
523
|
* Change customer\'s password using the token provided by the reset password endpoint.
|
|
390
524
|
* @summary Change password by customer
|
|
@@ -401,6 +535,16 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
401
535
|
* @throws {RequiredError}
|
|
402
536
|
*/
|
|
403
537
|
respondToAuthChallenge(respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto, options?: any): AxiosPromise<RespondToAuthChallengeClass>;
|
|
538
|
+
/**
|
|
539
|
+
* Update customer details like phone, email, names, addresses etc
|
|
540
|
+
* @summary Update customer details
|
|
541
|
+
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
542
|
+
* @param {UpdateCustomerRequestDto} updateCustomerRequestDto
|
|
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
|
+
updateCustomer(customerCode: string, updateCustomerRequestDto: UpdateCustomerRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCustomerResponseClass>;
|
|
404
548
|
/**
|
|
405
549
|
* Verify the invite sent to the customer via email.
|
|
406
550
|
* @summary Verify customer\'s invite token
|
|
@@ -444,6 +588,31 @@ export interface CustomersApiForgotPasswordRequest {
|
|
|
444
588
|
*/
|
|
445
589
|
readonly forgotPasswordRequestDto: ForgotPasswordRequestDto;
|
|
446
590
|
}
|
|
591
|
+
/**
|
|
592
|
+
* Request parameters for getCustomer operation in CustomersApi.
|
|
593
|
+
* @export
|
|
594
|
+
* @interface CustomersApiGetCustomerRequest
|
|
595
|
+
*/
|
|
596
|
+
export interface CustomersApiGetCustomerRequest {
|
|
597
|
+
/**
|
|
598
|
+
* The customer code or \"me\" for the currently logged in customer
|
|
599
|
+
* @type {string}
|
|
600
|
+
* @memberof CustomersApiGetCustomer
|
|
601
|
+
*/
|
|
602
|
+
readonly customerCode: string;
|
|
603
|
+
/**
|
|
604
|
+
* Fields to expand response by - [account]
|
|
605
|
+
* @type {string}
|
|
606
|
+
* @memberof CustomersApiGetCustomer
|
|
607
|
+
*/
|
|
608
|
+
readonly expand?: string;
|
|
609
|
+
/**
|
|
610
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
611
|
+
* @type {string}
|
|
612
|
+
* @memberof CustomersApiGetCustomer
|
|
613
|
+
*/
|
|
614
|
+
readonly authorization?: string;
|
|
615
|
+
}
|
|
447
616
|
/**
|
|
448
617
|
* Request parameters for getPolicy operation in CustomersApi.
|
|
449
618
|
* @export
|
|
@@ -526,6 +695,61 @@ export interface CustomersApiInviteByTenantRequest {
|
|
|
526
695
|
*/
|
|
527
696
|
readonly authorization?: string;
|
|
528
697
|
}
|
|
698
|
+
/**
|
|
699
|
+
* Request parameters for listDocuments operation in CustomersApi.
|
|
700
|
+
* @export
|
|
701
|
+
* @interface CustomersApiListDocumentsRequest
|
|
702
|
+
*/
|
|
703
|
+
export interface CustomersApiListDocumentsRequest {
|
|
704
|
+
/**
|
|
705
|
+
* The customer code or \"me\" for the currently logged in customer
|
|
706
|
+
* @type {string}
|
|
707
|
+
* @memberof CustomersApiListDocuments
|
|
708
|
+
*/
|
|
709
|
+
readonly customerCode: string;
|
|
710
|
+
/**
|
|
711
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
712
|
+
* @type {any}
|
|
713
|
+
* @memberof CustomersApiListDocuments
|
|
714
|
+
*/
|
|
715
|
+
readonly pageSize?: any;
|
|
716
|
+
/**
|
|
717
|
+
* 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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
718
|
+
* @type {any}
|
|
719
|
+
* @memberof CustomersApiListDocuments
|
|
720
|
+
*/
|
|
721
|
+
readonly pageToken?: any;
|
|
722
|
+
/**
|
|
723
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
724
|
+
* @type {any}
|
|
725
|
+
* @memberof CustomersApiListDocuments
|
|
726
|
+
*/
|
|
727
|
+
readonly filter?: any;
|
|
728
|
+
/**
|
|
729
|
+
* Search the list by any field. For instance, if you want to search by code add code=xxx in order to fetch the result.
|
|
730
|
+
* @type {any}
|
|
731
|
+
* @memberof CustomersApiListDocuments
|
|
732
|
+
*/
|
|
733
|
+
readonly search?: any;
|
|
734
|
+
/**
|
|
735
|
+
* 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.
|
|
736
|
+
* @type {any}
|
|
737
|
+
* @memberof CustomersApiListDocuments
|
|
738
|
+
*/
|
|
739
|
+
readonly order?: any;
|
|
740
|
+
/**
|
|
741
|
+
* 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.
|
|
742
|
+
* @type {any}
|
|
743
|
+
* @memberof CustomersApiListDocuments
|
|
744
|
+
*/
|
|
745
|
+
readonly expand?: any;
|
|
746
|
+
/**
|
|
747
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
748
|
+
* @type {string}
|
|
749
|
+
* @memberof CustomersApiListDocuments
|
|
750
|
+
*/
|
|
751
|
+
readonly authorization?: string;
|
|
752
|
+
}
|
|
529
753
|
/**
|
|
530
754
|
* Request parameters for listInvoices operation in CustomersApi.
|
|
531
755
|
* @export
|
|
@@ -655,6 +879,37 @@ export interface CustomersApiRefreshTokenRequest {
|
|
|
655
879
|
*/
|
|
656
880
|
readonly cookie?: string;
|
|
657
881
|
}
|
|
882
|
+
/**
|
|
883
|
+
* Request parameters for requestPolicyUpdate operation in CustomersApi.
|
|
884
|
+
* @export
|
|
885
|
+
* @interface CustomersApiRequestPolicyUpdateRequest
|
|
886
|
+
*/
|
|
887
|
+
export interface CustomersApiRequestPolicyUpdateRequest {
|
|
888
|
+
/**
|
|
889
|
+
* The policy code
|
|
890
|
+
* @type {string}
|
|
891
|
+
* @memberof CustomersApiRequestPolicyUpdate
|
|
892
|
+
*/
|
|
893
|
+
readonly policyCode: string;
|
|
894
|
+
/**
|
|
895
|
+
* The customer code or \"me\" for the currently logged in customer
|
|
896
|
+
* @type {string}
|
|
897
|
+
* @memberof CustomersApiRequestPolicyUpdate
|
|
898
|
+
*/
|
|
899
|
+
readonly customerCode: string;
|
|
900
|
+
/**
|
|
901
|
+
*
|
|
902
|
+
* @type {RequestPolicyUpdateRequestDto}
|
|
903
|
+
* @memberof CustomersApiRequestPolicyUpdate
|
|
904
|
+
*/
|
|
905
|
+
readonly requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto;
|
|
906
|
+
/**
|
|
907
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
908
|
+
* @type {string}
|
|
909
|
+
* @memberof CustomersApiRequestPolicyUpdate
|
|
910
|
+
*/
|
|
911
|
+
readonly authorization?: string;
|
|
912
|
+
}
|
|
658
913
|
/**
|
|
659
914
|
* Request parameters for resetPassword operation in CustomersApi.
|
|
660
915
|
* @export
|
|
@@ -681,6 +936,31 @@ export interface CustomersApiRespondToAuthChallengeRequest {
|
|
|
681
936
|
*/
|
|
682
937
|
readonly respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto;
|
|
683
938
|
}
|
|
939
|
+
/**
|
|
940
|
+
* Request parameters for updateCustomer operation in CustomersApi.
|
|
941
|
+
* @export
|
|
942
|
+
* @interface CustomersApiUpdateCustomerRequest
|
|
943
|
+
*/
|
|
944
|
+
export interface CustomersApiUpdateCustomerRequest {
|
|
945
|
+
/**
|
|
946
|
+
* The customer code or \"me\" for the currently logged in customer
|
|
947
|
+
* @type {string}
|
|
948
|
+
* @memberof CustomersApiUpdateCustomer
|
|
949
|
+
*/
|
|
950
|
+
readonly customerCode: string;
|
|
951
|
+
/**
|
|
952
|
+
*
|
|
953
|
+
* @type {UpdateCustomerRequestDto}
|
|
954
|
+
* @memberof CustomersApiUpdateCustomer
|
|
955
|
+
*/
|
|
956
|
+
readonly updateCustomerRequestDto: UpdateCustomerRequestDto;
|
|
957
|
+
/**
|
|
958
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
959
|
+
* @type {string}
|
|
960
|
+
* @memberof CustomersApiUpdateCustomer
|
|
961
|
+
*/
|
|
962
|
+
readonly authorization?: string;
|
|
963
|
+
}
|
|
684
964
|
/**
|
|
685
965
|
* Request parameters for verifyInvite operation in CustomersApi.
|
|
686
966
|
* @export
|
|
@@ -732,6 +1012,15 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
732
1012
|
* @memberof CustomersApi
|
|
733
1013
|
*/
|
|
734
1014
|
forgotPassword(requestParameters: CustomersApiForgotPasswordRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1015
|
+
/**
|
|
1016
|
+
* Get customer details
|
|
1017
|
+
* @summary Get customer details
|
|
1018
|
+
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
1019
|
+
* @param {*} [options] Override http request option.
|
|
1020
|
+
* @throws {RequiredError}
|
|
1021
|
+
* @memberof CustomersApi
|
|
1022
|
+
*/
|
|
1023
|
+
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCustomerResponseClass, any>>;
|
|
735
1024
|
/**
|
|
736
1025
|
* Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
|
|
737
1026
|
* @summary Get policy details
|
|
@@ -752,7 +1041,7 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
752
1041
|
initiateAuth(requestParameters: CustomersApiInitiateAuthRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateAuthResponseClass, any>>;
|
|
753
1042
|
/**
|
|
754
1043
|
* 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.
|
|
755
|
-
* @summary Invite by
|
|
1044
|
+
* @summary Invite a customer by self
|
|
756
1045
|
* @param {CustomersApiInviteByCustomerRequest} requestParameters Request parameters.
|
|
757
1046
|
* @param {*} [options] Override http request option.
|
|
758
1047
|
* @throws {RequiredError}
|
|
@@ -761,13 +1050,22 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
761
1050
|
inviteByCustomer(requestParameters: CustomersApiInviteByCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteByCustomerResponseClass, any>>;
|
|
762
1051
|
/**
|
|
763
1052
|
* 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.
|
|
764
|
-
* @summary Invite by tenant
|
|
1053
|
+
* @summary Invite a customer by tenant
|
|
765
1054
|
* @param {CustomersApiInviteByTenantRequest} requestParameters Request parameters.
|
|
766
1055
|
* @param {*} [options] Override http request option.
|
|
767
1056
|
* @throws {RequiredError}
|
|
768
1057
|
* @memberof CustomersApi
|
|
769
1058
|
*/
|
|
770
1059
|
inviteByTenant(requestParameters: CustomersApiInviteByTenantRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InviteByTenantResponseClass, any>>;
|
|
1060
|
+
/**
|
|
1061
|
+
* List all the documents of a customer
|
|
1062
|
+
* @summary List documents of a customer
|
|
1063
|
+
* @param {CustomersApiListDocumentsRequest} requestParameters Request parameters.
|
|
1064
|
+
* @param {*} [options] Override http request option.
|
|
1065
|
+
* @throws {RequiredError}
|
|
1066
|
+
* @memberof CustomersApi
|
|
1067
|
+
*/
|
|
1068
|
+
listDocuments(requestParameters: CustomersApiListDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocumentsResponseClass, any>>;
|
|
771
1069
|
/**
|
|
772
1070
|
* List all the invoices of a customer
|
|
773
1071
|
* @summary List invoices of a customer
|
|
@@ -795,6 +1093,15 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
795
1093
|
* @memberof CustomersApi
|
|
796
1094
|
*/
|
|
797
1095
|
refreshToken(requestParameters: CustomersApiRefreshTokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
1096
|
+
/**
|
|
1097
|
+
* Request to update an existing policy by customer
|
|
1098
|
+
* @summary Request policy update by customer
|
|
1099
|
+
* @param {CustomersApiRequestPolicyUpdateRequest} requestParameters Request parameters.
|
|
1100
|
+
* @param {*} [options] Override http request option.
|
|
1101
|
+
* @throws {RequiredError}
|
|
1102
|
+
* @memberof CustomersApi
|
|
1103
|
+
*/
|
|
1104
|
+
requestPolicyUpdate(requestParameters: CustomersApiRequestPolicyUpdateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RequestPolicyUpdateResponseClass, any>>;
|
|
798
1105
|
/**
|
|
799
1106
|
* Change customer\'s password using the token provided by the reset password endpoint.
|
|
800
1107
|
* @summary Change password by customer
|
|
@@ -813,6 +1120,15 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
813
1120
|
* @memberof CustomersApi
|
|
814
1121
|
*/
|
|
815
1122
|
respondToAuthChallenge(requestParameters: CustomersApiRespondToAuthChallengeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RespondToAuthChallengeClass, any>>;
|
|
1123
|
+
/**
|
|
1124
|
+
* Update customer details like phone, email, names, addresses etc
|
|
1125
|
+
* @summary Update customer details
|
|
1126
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
1127
|
+
* @param {*} [options] Override http request option.
|
|
1128
|
+
* @throws {RequiredError}
|
|
1129
|
+
* @memberof CustomersApi
|
|
1130
|
+
*/
|
|
1131
|
+
updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCustomerResponseClass, any>>;
|
|
816
1132
|
/**
|
|
817
1133
|
* Verify the invite sent to the customer via email.
|
|
818
1134
|
* @summary Verify customer\'s invite token
|