@emilgroup/customer-sdk-node 1.3.0 → 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 +6 -0
- package/README.md +2 -2
- package/api/customers-api.ts +431 -68
- package/dist/api/customers-api.d.ts +251 -36
- package/dist/api/customers-api.js +308 -40
- 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 +6 -0
- package/dist/models/index.js +6 -0
- 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/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 +6 -0
- package/models/list-documents-response-class.ts +36 -0
- package/models/request-policy-update-request-dto.ts +48 -0
- 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 +1 -1
|
@@ -15,19 +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';
|
|
27
30
|
import { RequestPolicyUpdateResponseClass } from '../models';
|
|
28
31
|
import { ResetPasswordByCustomerRequestDto } from '../models';
|
|
29
32
|
import { RespondToAuthChallengeClass } from '../models';
|
|
30
33
|
import { RespondToAuthChallengeRequestDto } from '../models';
|
|
34
|
+
import { UpdateCustomerRequestDto } from '../models';
|
|
35
|
+
import { UpdateCustomerResponseClass } from '../models';
|
|
31
36
|
import { VerifyCustomerInviteResponseClass } from '../models';
|
|
32
37
|
/**
|
|
33
38
|
* CustomersApi - axios parameter creator
|
|
@@ -50,6 +55,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
50
55
|
* @throws {RequiredError}
|
|
51
56
|
*/
|
|
52
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>;
|
|
53
68
|
/**
|
|
54
69
|
* Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
|
|
55
70
|
* @summary Get policy details
|
|
@@ -87,6 +102,21 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
87
102
|
* @throws {RequiredError}
|
|
88
103
|
*/
|
|
89
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>;
|
|
90
120
|
/**
|
|
91
121
|
* List all the invoices of a customer
|
|
92
122
|
* @summary List invoices of a customer
|
|
@@ -131,15 +161,12 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
131
161
|
* @summary Request policy update by customer
|
|
132
162
|
* @param {string} policyCode The policy code
|
|
133
163
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
134
|
-
* @param {
|
|
135
|
-
* @param {Array<string>} policyObjects Policy objects
|
|
136
|
-
* @param {string} from Update from
|
|
137
|
-
* @param {string} [to] Update to
|
|
164
|
+
* @param {RequestPolicyUpdateRequestDto} requestPolicyUpdateRequestDto
|
|
138
165
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
139
166
|
* @param {*} [options] Override http request option.
|
|
140
167
|
* @throws {RequiredError}
|
|
141
168
|
*/
|
|
142
|
-
requestPolicyUpdate: (policyCode: string, customerCode: string,
|
|
169
|
+
requestPolicyUpdate: (policyCode: string, customerCode: string, requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
143
170
|
/**
|
|
144
171
|
* Change customer\'s password using the token provided by the reset password endpoint.
|
|
145
172
|
* @summary Change password by customer
|
|
@@ -156,6 +183,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
156
183
|
* @throws {RequiredError}
|
|
157
184
|
*/
|
|
158
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>;
|
|
159
196
|
/**
|
|
160
197
|
* Verify the invite sent to the customer via email.
|
|
161
198
|
* @summary Verify customer\'s invite token
|
|
@@ -194,6 +231,16 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
194
231
|
* @throws {RequiredError}
|
|
195
232
|
*/
|
|
196
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>>;
|
|
197
244
|
/**
|
|
198
245
|
* Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
|
|
199
246
|
* @summary Get policy details
|
|
@@ -231,6 +278,21 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
231
278
|
* @throws {RequiredError}
|
|
232
279
|
*/
|
|
233
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>>;
|
|
234
296
|
/**
|
|
235
297
|
* List all the invoices of a customer
|
|
236
298
|
* @summary List invoices of a customer
|
|
@@ -275,15 +337,12 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
275
337
|
* @summary Request policy update by customer
|
|
276
338
|
* @param {string} policyCode The policy code
|
|
277
339
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
278
|
-
* @param {
|
|
279
|
-
* @param {Array<string>} policyObjects Policy objects
|
|
280
|
-
* @param {string} from Update from
|
|
281
|
-
* @param {string} [to] Update to
|
|
340
|
+
* @param {RequestPolicyUpdateRequestDto} requestPolicyUpdateRequestDto
|
|
282
341
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
283
342
|
* @param {*} [options] Override http request option.
|
|
284
343
|
* @throws {RequiredError}
|
|
285
344
|
*/
|
|
286
|
-
requestPolicyUpdate(policyCode: string, customerCode: string,
|
|
345
|
+
requestPolicyUpdate(policyCode: string, customerCode: string, requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RequestPolicyUpdateResponseClass>>;
|
|
287
346
|
/**
|
|
288
347
|
* Change customer\'s password using the token provided by the reset password endpoint.
|
|
289
348
|
* @summary Change password by customer
|
|
@@ -300,6 +359,16 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
300
359
|
* @throws {RequiredError}
|
|
301
360
|
*/
|
|
302
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>>;
|
|
303
372
|
/**
|
|
304
373
|
* Verify the invite sent to the customer via email.
|
|
305
374
|
* @summary Verify customer\'s invite token
|
|
@@ -338,6 +407,16 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
338
407
|
* @throws {RequiredError}
|
|
339
408
|
*/
|
|
340
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>;
|
|
341
420
|
/**
|
|
342
421
|
* Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
|
|
343
422
|
* @summary Get policy details
|
|
@@ -375,6 +454,21 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
375
454
|
* @throws {RequiredError}
|
|
376
455
|
*/
|
|
377
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>;
|
|
378
472
|
/**
|
|
379
473
|
* List all the invoices of a customer
|
|
380
474
|
* @summary List invoices of a customer
|
|
@@ -419,15 +513,12 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
419
513
|
* @summary Request policy update by customer
|
|
420
514
|
* @param {string} policyCode The policy code
|
|
421
515
|
* @param {string} customerCode The customer code or \"me\" for the currently logged in customer
|
|
422
|
-
* @param {
|
|
423
|
-
* @param {Array<string>} policyObjects Policy objects
|
|
424
|
-
* @param {string} from Update from
|
|
425
|
-
* @param {string} [to] Update to
|
|
516
|
+
* @param {RequestPolicyUpdateRequestDto} requestPolicyUpdateRequestDto
|
|
426
517
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
427
518
|
* @param {*} [options] Override http request option.
|
|
428
519
|
* @throws {RequiredError}
|
|
429
520
|
*/
|
|
430
|
-
requestPolicyUpdate(policyCode: string, customerCode: string,
|
|
521
|
+
requestPolicyUpdate(policyCode: string, customerCode: string, requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto, authorization?: string, options?: any): AxiosPromise<RequestPolicyUpdateResponseClass>;
|
|
431
522
|
/**
|
|
432
523
|
* Change customer\'s password using the token provided by the reset password endpoint.
|
|
433
524
|
* @summary Change password by customer
|
|
@@ -444,6 +535,16 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
444
535
|
* @throws {RequiredError}
|
|
445
536
|
*/
|
|
446
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>;
|
|
447
548
|
/**
|
|
448
549
|
* Verify the invite sent to the customer via email.
|
|
449
550
|
* @summary Verify customer\'s invite token
|
|
@@ -487,6 +588,31 @@ export interface CustomersApiForgotPasswordRequest {
|
|
|
487
588
|
*/
|
|
488
589
|
readonly forgotPasswordRequestDto: ForgotPasswordRequestDto;
|
|
489
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
|
+
}
|
|
490
616
|
/**
|
|
491
617
|
* Request parameters for getPolicy operation in CustomersApi.
|
|
492
618
|
* @export
|
|
@@ -569,6 +695,61 @@ export interface CustomersApiInviteByTenantRequest {
|
|
|
569
695
|
*/
|
|
570
696
|
readonly authorization?: string;
|
|
571
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
|
+
}
|
|
572
753
|
/**
|
|
573
754
|
* Request parameters for listInvoices operation in CustomersApi.
|
|
574
755
|
* @export
|
|
@@ -717,29 +898,11 @@ export interface CustomersApiRequestPolicyUpdateRequest {
|
|
|
717
898
|
*/
|
|
718
899
|
readonly customerCode: string;
|
|
719
900
|
/**
|
|
720
|
-
*
|
|
721
|
-
* @type {
|
|
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}
|
|
901
|
+
*
|
|
902
|
+
* @type {RequestPolicyUpdateRequestDto}
|
|
740
903
|
* @memberof CustomersApiRequestPolicyUpdate
|
|
741
904
|
*/
|
|
742
|
-
readonly
|
|
905
|
+
readonly requestPolicyUpdateRequestDto: RequestPolicyUpdateRequestDto;
|
|
743
906
|
/**
|
|
744
907
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
745
908
|
* @type {string}
|
|
@@ -773,6 +936,31 @@ export interface CustomersApiRespondToAuthChallengeRequest {
|
|
|
773
936
|
*/
|
|
774
937
|
readonly respondToAuthChallengeRequestDto: RespondToAuthChallengeRequestDto;
|
|
775
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
|
+
}
|
|
776
964
|
/**
|
|
777
965
|
* Request parameters for verifyInvite operation in CustomersApi.
|
|
778
966
|
* @export
|
|
@@ -824,6 +1012,15 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
824
1012
|
* @memberof CustomersApi
|
|
825
1013
|
*/
|
|
826
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>>;
|
|
827
1024
|
/**
|
|
828
1025
|
* Get detailed policy that belongs to a customer; the details can be expanded using expand query parameter.
|
|
829
1026
|
* @summary Get policy details
|
|
@@ -860,6 +1057,15 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
860
1057
|
* @memberof CustomersApi
|
|
861
1058
|
*/
|
|
862
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>>;
|
|
863
1069
|
/**
|
|
864
1070
|
* List all the invoices of a customer
|
|
865
1071
|
* @summary List invoices of a customer
|
|
@@ -914,6 +1120,15 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
914
1120
|
* @memberof CustomersApi
|
|
915
1121
|
*/
|
|
916
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>>;
|
|
917
1132
|
/**
|
|
918
1133
|
* Verify the invite sent to the customer via email.
|
|
919
1134
|
* @summary Verify customer\'s invite token
|