@emilgroup/public-api-sdk-node 1.14.0 → 1.16.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 (48) hide show
  1. package/.openapi-generator/FILES +5 -0
  2. package/README.md +2 -2
  3. package/api/default-api.ts +124 -0
  4. package/api/documents-api.ts +107 -0
  5. package/api.ts +2 -0
  6. package/dist/api/default-api.d.ts +66 -0
  7. package/dist/api/default-api.js +200 -0
  8. package/dist/api/documents-api.d.ts +57 -0
  9. package/dist/api/documents-api.js +93 -0
  10. package/dist/api.d.ts +1 -0
  11. package/dist/api.js +1 -0
  12. package/dist/models/create-account-request-dto.d.ts +24 -24
  13. package/dist/models/create-document-request-dto.d.ts +8 -0
  14. package/dist/models/create-document-request-dto.js +9 -1
  15. package/dist/models/create-lead-request-dto.d.ts +20 -14
  16. package/dist/models/create-presigned-post-request-dto.d.ts +128 -0
  17. package/dist/models/create-presigned-post-request-dto.js +52 -0
  18. package/dist/models/create-presigned-post-response-class.d.ts +30 -0
  19. package/dist/models/create-presigned-post-response-class.js +15 -0
  20. package/dist/models/document-class.d.ts +8 -0
  21. package/dist/models/document-class.js +9 -1
  22. package/dist/models/index.d.ts +4 -0
  23. package/dist/models/index.js +4 -0
  24. package/dist/models/inline-response200.d.ts +54 -0
  25. package/dist/models/inline-response200.js +15 -0
  26. package/dist/models/inline-response503.d.ts +54 -0
  27. package/dist/models/inline-response503.js +15 -0
  28. package/dist/models/lead-policy-object-class.d.ts +8 -2
  29. package/dist/models/policy-object-request-dto.d.ts +11 -5
  30. package/dist/models/product-class.d.ts +6 -0
  31. package/dist/models/product-document-class.d.ts +8 -0
  32. package/dist/models/product-document-class.js +9 -1
  33. package/dist/models/update-lead-request-dto.d.ts +20 -14
  34. package/models/create-account-request-dto.ts +24 -24
  35. package/models/create-document-request-dto.ts +9 -1
  36. package/models/create-lead-request-dto.ts +20 -14
  37. package/models/create-presigned-post-request-dto.ts +138 -0
  38. package/models/create-presigned-post-response-class.ts +36 -0
  39. package/models/document-class.ts +9 -1
  40. package/models/index.ts +4 -0
  41. package/models/inline-response200.ts +48 -0
  42. package/models/inline-response503.ts +48 -0
  43. package/models/lead-policy-object-class.ts +8 -2
  44. package/models/policy-object-request-dto.ts +11 -5
  45. package/models/product-class.ts +6 -0
  46. package/models/product-document-class.ts +9 -1
  47. package/models/update-lead-request-dto.ts +20 -14
  48. package/package.json +2 -2
@@ -13,6 +13,8 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateDocumentRequestDto } from '../models';
16
+ import { CreatePresignedPostRequestDto } from '../models';
17
+ import { CreatePresignedPostResponseClass } from '../models';
16
18
  import { GetProductDocumentDownloadUrlResponseClass } from '../models';
17
19
  import { ListDocumentsResponseClass } from '../models';
18
20
  import { ListProductDocumentsResponseClass } from '../models';
@@ -77,6 +79,15 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
77
79
  * @throws {RequiredError}
78
80
  */
79
81
  listProductDocuments: (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
82
+ /**
83
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
84
+ * @summary Upload documents using pre-signed URL
85
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
86
+ * @param {string} [authorization] Bearer Token
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ preSignedPost: (createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
91
  };
81
92
  /**
82
93
  * DocumentsApi - functional programming interface
@@ -139,6 +150,15 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
139
150
  * @throws {RequiredError}
140
151
  */
141
152
  listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
153
+ /**
154
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
155
+ * @summary Upload documents using pre-signed URL
156
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
157
+ * @param {string} [authorization] Bearer Token
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ preSignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
142
162
  };
143
163
  /**
144
164
  * DocumentsApi - factory interface
@@ -201,6 +221,15 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
201
221
  * @throws {RequiredError}
202
222
  */
203
223
  listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
224
+ /**
225
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
226
+ * @summary Upload documents using pre-signed URL
227
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
228
+ * @param {string} [authorization] Bearer Token
229
+ * @param {*} [options] Override http request option.
230
+ * @throws {RequiredError}
231
+ */
232
+ preSignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
204
233
  };
205
234
  /**
206
235
  * Request parameters for createTemporaryDocument operation in DocumentsApi.
@@ -363,6 +392,25 @@ export interface DocumentsApiListProductDocumentsRequest {
363
392
  */
364
393
  readonly expand?: any;
365
394
  }
395
+ /**
396
+ * Request parameters for preSignedPost operation in DocumentsApi.
397
+ * @export
398
+ * @interface DocumentsApiPreSignedPostRequest
399
+ */
400
+ export interface DocumentsApiPreSignedPostRequest {
401
+ /**
402
+ *
403
+ * @type {CreatePresignedPostRequestDto}
404
+ * @memberof DocumentsApiPreSignedPost
405
+ */
406
+ readonly createPresignedPostRequestDto: CreatePresignedPostRequestDto;
407
+ /**
408
+ * Bearer Token
409
+ * @type {string}
410
+ * @memberof DocumentsApiPreSignedPost
411
+ */
412
+ readonly authorization?: string;
413
+ }
366
414
  /**
367
415
  * DocumentsApi - object-oriented interface
368
416
  * @export
@@ -415,4 +463,13 @@ export declare class DocumentsApi extends BaseAPI {
415
463
  * @memberof DocumentsApi
416
464
  */
417
465
  listProductDocuments(requestParameters: DocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
466
+ /**
467
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
468
+ * @summary Upload documents using pre-signed URL
469
+ * @param {DocumentsApiPreSignedPostRequest} requestParameters Request parameters.
470
+ * @param {*} [options] Override http request option.
471
+ * @throws {RequiredError}
472
+ * @memberof DocumentsApi
473
+ */
474
+ preSignedPost(requestParameters: DocumentsApiPreSignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
418
475
  }
@@ -383,6 +383,55 @@ var DocumentsApiAxiosParamCreator = function (configuration) {
383
383
  });
384
384
  });
385
385
  },
386
+ /**
387
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
388
+ * @summary Upload documents using pre-signed URL
389
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
390
+ * @param {string} [authorization] Bearer Token
391
+ * @param {*} [options] Override http request option.
392
+ * @throws {RequiredError}
393
+ */
394
+ preSignedPost: function (createPresignedPostRequestDto, authorization, options) {
395
+ if (options === void 0) { options = {}; }
396
+ return __awaiter(_this, void 0, void 0, function () {
397
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
398
+ return __generator(this, function (_a) {
399
+ switch (_a.label) {
400
+ case 0:
401
+ // verify required parameter 'createPresignedPostRequestDto' is not null or undefined
402
+ (0, common_1.assertParamExists)('preSignedPost', 'createPresignedPostRequestDto', createPresignedPostRequestDto);
403
+ localVarPath = "/publicapi/v1/documents/pre-signed-post";
404
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
405
+ if (configuration) {
406
+ baseOptions = configuration.baseOptions;
407
+ baseAccessToken = configuration.accessToken;
408
+ }
409
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
410
+ localVarHeaderParameter = {};
411
+ localVarQueryParameter = {};
412
+ // authentication bearer required
413
+ // http bearer authentication required
414
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
415
+ case 1:
416
+ // authentication bearer required
417
+ // http bearer authentication required
418
+ _a.sent();
419
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
420
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
421
+ }
422
+ localVarHeaderParameter['Content-Type'] = 'application/json';
423
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
424
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
425
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
426
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createPresignedPostRequestDto, localVarRequestOptions, configuration);
427
+ return [2 /*return*/, {
428
+ url: (0, common_1.toPathString)(localVarUrlObj),
429
+ options: localVarRequestOptions,
430
+ }];
431
+ }
432
+ });
433
+ });
434
+ },
386
435
  };
387
436
  };
388
437
  exports.DocumentsApiAxiosParamCreator = DocumentsApiAxiosParamCreator;
@@ -509,6 +558,27 @@ var DocumentsApiFp = function (configuration) {
509
558
  });
510
559
  });
511
560
  },
561
+ /**
562
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
563
+ * @summary Upload documents using pre-signed URL
564
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
565
+ * @param {string} [authorization] Bearer Token
566
+ * @param {*} [options] Override http request option.
567
+ * @throws {RequiredError}
568
+ */
569
+ preSignedPost: function (createPresignedPostRequestDto, authorization, options) {
570
+ return __awaiter(this, void 0, void 0, function () {
571
+ var localVarAxiosArgs;
572
+ return __generator(this, function (_a) {
573
+ switch (_a.label) {
574
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.preSignedPost(createPresignedPostRequestDto, authorization, options)];
575
+ case 1:
576
+ localVarAxiosArgs = _a.sent();
577
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
578
+ }
579
+ });
580
+ });
581
+ },
512
582
  };
513
583
  };
514
584
  exports.DocumentsApiFp = DocumentsApiFp;
@@ -585,6 +655,17 @@ var DocumentsApiFactory = function (configuration, basePath, axios) {
585
655
  listProductDocuments: function (productCode, authorization, pageSize, pageToken, filter, search, order, expand, options) {
586
656
  return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
587
657
  },
658
+ /**
659
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
660
+ * @summary Upload documents using pre-signed URL
661
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
662
+ * @param {string} [authorization] Bearer Token
663
+ * @param {*} [options] Override http request option.
664
+ * @throws {RequiredError}
665
+ */
666
+ preSignedPost: function (createPresignedPostRequestDto, authorization, options) {
667
+ return localVarFp.preSignedPost(createPresignedPostRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
668
+ },
588
669
  };
589
670
  };
590
671
  exports.DocumentsApiFactory = DocumentsApiFactory;
@@ -659,6 +740,18 @@ var DocumentsApi = /** @class */ (function (_super) {
659
740
  var _this = this;
660
741
  return (0, exports.DocumentsApiFp)(this.configuration).listProductDocuments(requestParameters.productCode, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
661
742
  };
743
+ /**
744
+ * This will create a URL that allows user upload its documents in Database.The URL can expire between 5 minutes and 7 days.
745
+ * @summary Upload documents using pre-signed URL
746
+ * @param {DocumentsApiPreSignedPostRequest} requestParameters Request parameters.
747
+ * @param {*} [options] Override http request option.
748
+ * @throws {RequiredError}
749
+ * @memberof DocumentsApi
750
+ */
751
+ DocumentsApi.prototype.preSignedPost = function (requestParameters, options) {
752
+ var _this = this;
753
+ return (0, exports.DocumentsApiFp)(this.configuration).preSignedPost(requestParameters.createPresignedPostRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
754
+ };
662
755
  return DocumentsApi;
663
756
  }(base_1.BaseAPI));
664
757
  exports.DocumentsApi = DocumentsApi;
package/dist/api.d.ts CHANGED
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  export * from './api/address-completions-validations-api';
13
+ export * from './api/default-api';
13
14
  export * from './api/documents-api';
14
15
  export * from './api/leads-api';
15
16
  export * from './api/notifications-api';
package/dist/api.js CHANGED
@@ -28,6 +28,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
28
28
  };
29
29
  Object.defineProperty(exports, "__esModule", { value: true });
30
30
  __exportStar(require("./api/address-completions-validations-api"), exports);
31
+ __exportStar(require("./api/default-api"), exports);
31
32
  __exportStar(require("./api/documents-api"), exports);
32
33
  __exportStar(require("./api/leads-api"), exports);
33
34
  __exportStar(require("./api/notifications-api"), exports);
@@ -16,91 +16,91 @@
16
16
  */
17
17
  export interface CreateAccountRequestDto {
18
18
  /**
19
- * Customer honorific title
19
+ * Optional field to enter the honorific title you want to be called.
20
20
  * @type {string}
21
21
  * @memberof CreateAccountRequestDto
22
22
  */
23
23
  'title'?: CreateAccountRequestDtoTitleEnum;
24
24
  /**
25
- * Customer first name
25
+ * The account\'s holder first name. The account\'s first name will be validated if the \'validate\' flag is set to true.
26
26
  * @type {string}
27
27
  * @memberof CreateAccountRequestDto
28
28
  */
29
- 'firstName': string;
29
+ 'firstName'?: string;
30
30
  /**
31
- * Customer last name
31
+ * The account\'s holder first name. The account\'s first name will be validated if the \'validate\' flag is set to true.
32
32
  * @type {string}
33
33
  * @memberof CreateAccountRequestDto
34
34
  */
35
- 'lastName': string;
35
+ 'lastName'?: string;
36
36
  /**
37
- * Customer email
37
+ * The account\'s holder email address. It is displayed alongside the account in your dashboard and can be useful for searching and tracking. The account\'s email address will be validated if the \'validate\' flag is set to true.
38
38
  * @type {string}
39
39
  * @memberof CreateAccountRequestDto
40
40
  */
41
- 'email': string;
41
+ 'email'?: string;
42
42
  /**
43
- * Customer gender
43
+ * The account\'s holder gender. The account\'s gender will be validated if the \'validate\' flag is set to true.
44
44
  * @type {string}
45
45
  * @memberof CreateAccountRequestDto
46
46
  */
47
- 'gender': CreateAccountRequestDtoGenderEnum;
47
+ 'gender'?: CreateAccountRequestDtoGenderEnum;
48
48
  /**
49
- * Customer street
49
+ * The account\'s holder street name. The account\'s street name will be validated if the \'validate\' flag is set to true.
50
50
  * @type {string}
51
51
  * @memberof CreateAccountRequestDto
52
52
  */
53
- 'street': string;
53
+ 'street'?: string;
54
54
  /**
55
- * Customer zip code
55
+ * The account\'s holder ZIP or postal code. The account\'s ZIP or postal code will be validated if the \'validate\' flag is set to true.
56
56
  * @type {string}
57
57
  * @memberof CreateAccountRequestDto
58
58
  */
59
- 'zipCode': string;
59
+ 'zipCode'?: string;
60
60
  /**
61
- * Customer city
61
+ * The account\'s holder city, district, suburb, town, or village. The account\'s city will be validated if the \'validate\' flag is set to true.
62
62
  * @type {string}
63
63
  * @memberof CreateAccountRequestDto
64
64
  */
65
- 'city': string;
65
+ 'city'?: string;
66
66
  /**
67
- * Customer house number
67
+ * The account\'s holder house number. The account\'s house number will be validated if the \'validate\' flag is set to true.
68
68
  * @type {string}
69
69
  * @memberof CreateAccountRequestDto
70
70
  */
71
- 'houseNumber': string;
71
+ 'houseNumber'?: string;
72
72
  /**
73
- * Customer birth date (Required for account of type person).
73
+ * The account\'s holder date of birth (Required for account of type person). The account\'s date of birth will be validated if the \'validate\' flag is set to true.
74
74
  * @type {string}
75
75
  * @memberof CreateAccountRequestDto
76
76
  */
77
77
  'birthDate'?: string;
78
78
  /**
79
- * Customer phone number
79
+ * The account\'s holder phone number. The account\'s phone number will be validated if the \'validate\' flag is set to true.
80
80
  * @type {string}
81
81
  * @memberof CreateAccountRequestDto
82
82
  */
83
- 'phone': string;
83
+ 'phone'?: string;
84
84
  /**
85
- * Optional field to enter the type of the account.
85
+ * The account\'s type. Default value is person
86
86
  * @type {string}
87
87
  * @memberof CreateAccountRequestDto
88
88
  */
89
89
  'type'?: CreateAccountRequestDtoTypeEnum;
90
90
  /**
91
- * Customer company name (Required for account of type org).
91
+ * The account\'s company name (Required for account of type org). The account\'s company name will be validated if the \'validate\' flag is set to true.
92
92
  * @type {string}
93
93
  * @memberof CreateAccountRequestDto
94
94
  */
95
95
  'companyName'?: string;
96
96
  /**
97
- * Account number
97
+ * Account number.
98
98
  * @type {string}
99
99
  * @memberof CreateAccountRequestDto
100
100
  */
101
101
  'accountNumber'?: string;
102
102
  /**
103
- * Custom fields could be included additional required/optional fields that the account would need for specific cases.
103
+ * Optional custom fields for account. It could be included additional required/optional fields that the account would need for specific cases.
104
104
  * @type {object}
105
105
  * @memberof CreateAccountRequestDto
106
106
  */
@@ -103,5 +103,13 @@ export declare const CreateDocumentRequestDtoContentTypeEnum: {
103
103
  readonly Html: "html";
104
104
  readonly Json: "json";
105
105
  readonly Xml: "xml";
106
+ readonly Txt: "txt";
107
+ readonly Zip: "zip";
108
+ readonly Tar: "tar";
109
+ readonly Rar: "rar";
110
+ readonly Mp4: "MP4";
111
+ readonly Mov: "MOV";
112
+ readonly Wmv: "WMV";
113
+ readonly Avi: "AVI";
106
114
  };
107
115
  export type CreateDocumentRequestDtoContentTypeEnum = typeof CreateDocumentRequestDtoContentTypeEnum[keyof typeof CreateDocumentRequestDtoContentTypeEnum];
@@ -27,5 +27,13 @@ exports.CreateDocumentRequestDtoContentTypeEnum = {
27
27
  Docx: 'docx',
28
28
  Html: 'html',
29
29
  Json: 'json',
30
- Xml: 'xml'
30
+ Xml: 'xml',
31
+ Txt: 'txt',
32
+ Zip: 'zip',
33
+ Tar: 'tar',
34
+ Rar: 'rar',
35
+ Mp4: 'MP4',
36
+ Mov: 'MOV',
37
+ Wmv: 'WMV',
38
+ Avi: 'AVI'
31
39
  };
@@ -22,13 +22,13 @@ import { UploadedDocumentDto } from './uploaded-document-dto';
22
22
  */
23
23
  export interface CreateLeadRequestDto {
24
24
  /**
25
- * Unique identifier for the object.
25
+ * The lead code is used in cases where the lead has been initiated before the lead creation.
26
26
  * @type {string}
27
27
  * @memberof CreateLeadRequestDto
28
28
  */
29
29
  'code'?: string;
30
30
  /**
31
- * Unique identifier referencing the product version.
31
+ * The product version id of the product version to be used for the lead. The product version id will be validated if the \'validate\' flag is set to true.
32
32
  * @type {number}
33
33
  * @memberof CreateLeadRequestDto
34
34
  */
@@ -40,57 +40,63 @@ export interface CreateLeadRequestDto {
40
40
  */
41
41
  'productCode': string;
42
42
  /**
43
- * Account. The create lead request should either contain accountCode or account.
43
+ * Account object. The create lead request should either contain accountCode or account. The account content will be validated if the \'validate\' flag is set to true. an empty object is required if \'validate flag is set to false.
44
44
  * @type {CreateAccountRequestDto}
45
45
  * @memberof CreateLeadRequestDto
46
46
  */
47
47
  'account'?: CreateAccountRequestDto;
48
48
  /**
49
- * Account code. The create lead request should either contain accountCode or account.
49
+ * The account code is used in cases where the account has been created before the lead. The create lead request should include either the \'accountCode\' or \'account\'. The account code will be validated if the \'validate\' flag is set to true.
50
50
  * @type {string}
51
51
  * @memberof CreateLeadRequestDto
52
52
  */
53
53
  'accountCode'?: string;
54
54
  /**
55
- *
55
+ * The policy objects contains necessary information to create a policy. The Policy objects array will be validated if the \'validate\' flag is set to true
56
56
  * @type {Array<PolicyObjectRequestDto>}
57
57
  * @memberof CreateLeadRequestDto
58
58
  */
59
- 'policyObjects': Array<PolicyObjectRequestDto>;
59
+ 'policyObjects'?: Array<PolicyObjectRequestDto>;
60
60
  /**
61
- * Bank account details.
61
+ * Bank account details, to be used for direct debit payments, the created bank account will be attached to the lead for later use, such as paying claims. The bank account content will be validated if the \'validate\' flag is set to true.
62
62
  * @type {CreateBankAccountRequestDto}
63
63
  * @memberof CreateLeadRequestDto
64
64
  */
65
65
  'bankAccount'?: CreateBankAccountRequestDto;
66
66
  /**
67
- * Custom data.
67
+ * Optional custom data for the lead. This field is useful for edge cases where the lead requires additional data for the risk carrier, such as creating an application in the risk carrier platform or performing a premium calculation. The custom data should include three main entities: \'data\', \'provider\', and \'productCode\'. The \'data\' entity contains information used in the risk carrier platform, the \'provider\' field contains the name of the provider (usually the risk carrier\'s name), the provider must be supported in EMIL, The \'productCode\' field contains the product code in EMIL
68
68
  * @type {object}
69
69
  * @memberof CreateLeadRequestDto
70
70
  */
71
71
  'customData'?: object;
72
72
  /**
73
- * Codes for documents to be uploaded.
73
+ * Used to pass pre-uploaded documents to the lead. By providing the codes of the uploaded documents, they will be attached to the lead. The uploaded document content will be validated if the \'validate\' flag is set to true.
74
74
  * @type {UploadedDocumentDto}
75
75
  * @memberof CreateLeadRequestDto
76
76
  */
77
77
  'uploadedDocument'?: UploadedDocumentDto;
78
78
  /**
79
- * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
79
+ * Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
80
80
  * @type {string}
81
81
  * @memberof CreateLeadRequestDto
82
82
  */
83
83
  'status'?: string;
84
84
  /**
85
- * Premium Override.
86
- * @type {PremiumOverrideRequestDto}
85
+ * Premium Override is utilized to override the premium calculation. The premium formulas will be disregarded when this object is present. The premium override content will be validated if the \'validate\' flag is set to true.
86
+ * @type {Array<PremiumOverrideRequestDto>}
87
87
  * @memberof CreateLeadRequestDto
88
88
  */
89
- 'premiumOverride'?: PremiumOverrideRequestDto;
89
+ 'premiumOverride'?: Array<PremiumOverrideRequestDto>;
90
90
  /**
91
- * Payment Method.
91
+ * Payment method, used to for payment method support, such as SEPA, invoice, etc. The payment method content will be validated if the \'validate\' flag is set to true.
92
92
  * @type {CreatePaymentMethodRequestDto}
93
93
  * @memberof CreateLeadRequestDto
94
94
  */
95
95
  'paymentMethod'?: CreatePaymentMethodRequestDto;
96
+ /**
97
+ * The validation indicator, with a default value of true, serves as a toggle. When set to false, it allows the bypassing of validation—a useful option for saving leads for later processing. This feature provides flexibility by enabling users to choose whether to enforce validation checks during the current stage or defer them for a subsequent time.
98
+ * @type {boolean}
99
+ * @memberof CreateLeadRequestDto
100
+ */
101
+ 'validate'?: boolean;
96
102
  }
@@ -0,0 +1,128 @@
1
+ /**
2
+ * Emil PublicAPI
3
+ * The Emil Public API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface CreatePresignedPostRequestDto
16
+ */
17
+ export interface CreatePresignedPostRequestDto {
18
+ /**
19
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
20
+ * @type {string}
21
+ * @memberof CreatePresignedPostRequestDto
22
+ */
23
+ 'templateSlug': string;
24
+ /**
25
+ * Document entity type.
26
+ * @type {string}
27
+ * @memberof CreatePresignedPostRequestDto
28
+ */
29
+ 'entityType': string;
30
+ /**
31
+ * Unique identifier referencing the entity.
32
+ * @type {number}
33
+ * @memberof CreatePresignedPostRequestDto
34
+ */
35
+ 'entityId'?: number;
36
+ /**
37
+ * Description of the document. Usually a short summary about the context in which the document is being used.
38
+ * @type {string}
39
+ * @memberof CreatePresignedPostRequestDto
40
+ */
41
+ 'description': string;
42
+ /**
43
+ * Unique identifier of the policy that this object belongs to.
44
+ * @type {string}
45
+ * @memberof CreatePresignedPostRequestDto
46
+ */
47
+ 'policyCode'?: string;
48
+ /**
49
+ * Unique identifier of the account that this object belongs to.
50
+ * @type {string}
51
+ * @memberof CreatePresignedPostRequestDto
52
+ */
53
+ 'accountCode'?: string;
54
+ /**
55
+ * Unique identifier of the lead that this object belongs to.
56
+ * @type {string}
57
+ * @memberof CreatePresignedPostRequestDto
58
+ */
59
+ 'leadCode'?: string;
60
+ /**
61
+ * Identifier of the service that requested the creation of this document.
62
+ * @type {string}
63
+ * @memberof CreatePresignedPostRequestDto
64
+ */
65
+ 'requester': CreatePresignedPostRequestDtoRequesterEnum;
66
+ /**
67
+ * Extension of the file.
68
+ * @type {string}
69
+ * @memberof CreatePresignedPostRequestDto
70
+ */
71
+ 'contentType': CreatePresignedPostRequestDtoContentTypeEnum;
72
+ /**
73
+ * Content type of the file.
74
+ * @type {string}
75
+ * @memberof CreatePresignedPostRequestDto
76
+ */
77
+ 'isoContentType': string;
78
+ /**
79
+ * Name of the file the end user will see when he downloads it.
80
+ * @type {string}
81
+ * @memberof CreatePresignedPostRequestDto
82
+ */
83
+ 'filename': string;
84
+ /**
85
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
86
+ * @type {string}
87
+ * @memberof CreatePresignedPostRequestDto
88
+ */
89
+ 'productSlug'?: string;
90
+ }
91
+ export declare const CreatePresignedPostRequestDtoRequesterEnum: {
92
+ readonly Accountservice: "accountservice";
93
+ readonly Insuranceservice: "insuranceservice";
94
+ readonly Billingservice: "billingservice";
95
+ readonly Tenantservice: "tenantservice";
96
+ readonly BookingFunnel: "bookingFunnel";
97
+ readonly Publicapi: "publicapi";
98
+ readonly Admin: "admin";
99
+ readonly Claimservice: "claimservice";
100
+ readonly Customerservice: "customerservice";
101
+ readonly Notificationservice: "notificationservice";
102
+ readonly Paymentservice: "paymentservice";
103
+ readonly Processmanager: "processmanager";
104
+ readonly Gdvservice: "gdvservice";
105
+ readonly Documentservice: "documentservice";
106
+ };
107
+ export type CreatePresignedPostRequestDtoRequesterEnum = typeof CreatePresignedPostRequestDtoRequesterEnum[keyof typeof CreatePresignedPostRequestDtoRequesterEnum];
108
+ export declare const CreatePresignedPostRequestDtoContentTypeEnum: {
109
+ readonly Pdf: "pdf";
110
+ readonly Jpg: "jpg";
111
+ readonly Png: "png";
112
+ readonly Gz: "gz";
113
+ readonly Csv: "csv";
114
+ readonly Doc: "doc";
115
+ readonly Docx: "docx";
116
+ readonly Html: "html";
117
+ readonly Json: "json";
118
+ readonly Xml: "xml";
119
+ readonly Txt: "txt";
120
+ readonly Zip: "zip";
121
+ readonly Tar: "tar";
122
+ readonly Rar: "rar";
123
+ readonly Mp4: "MP4";
124
+ readonly Mov: "MOV";
125
+ readonly Wmv: "WMV";
126
+ readonly Avi: "AVI";
127
+ };
128
+ export type CreatePresignedPostRequestDtoContentTypeEnum = typeof CreatePresignedPostRequestDtoContentTypeEnum[keyof typeof CreatePresignedPostRequestDtoContentTypeEnum];
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Emil PublicAPI
6
+ * The Emil Public API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreatePresignedPostRequestDtoContentTypeEnum = exports.CreatePresignedPostRequestDtoRequesterEnum = void 0;
17
+ exports.CreatePresignedPostRequestDtoRequesterEnum = {
18
+ Accountservice: 'accountservice',
19
+ Insuranceservice: 'insuranceservice',
20
+ Billingservice: 'billingservice',
21
+ Tenantservice: 'tenantservice',
22
+ BookingFunnel: 'bookingFunnel',
23
+ Publicapi: 'publicapi',
24
+ Admin: 'admin',
25
+ Claimservice: 'claimservice',
26
+ Customerservice: 'customerservice',
27
+ Notificationservice: 'notificationservice',
28
+ Paymentservice: 'paymentservice',
29
+ Processmanager: 'processmanager',
30
+ Gdvservice: 'gdvservice',
31
+ Documentservice: 'documentservice'
32
+ };
33
+ exports.CreatePresignedPostRequestDtoContentTypeEnum = {
34
+ Pdf: 'pdf',
35
+ Jpg: 'jpg',
36
+ Png: 'png',
37
+ Gz: 'gz',
38
+ Csv: 'csv',
39
+ Doc: 'doc',
40
+ Docx: 'docx',
41
+ Html: 'html',
42
+ Json: 'json',
43
+ Xml: 'xml',
44
+ Txt: 'txt',
45
+ Zip: 'zip',
46
+ Tar: 'tar',
47
+ Rar: 'rar',
48
+ Mp4: 'MP4',
49
+ Mov: 'MOV',
50
+ Wmv: 'WMV',
51
+ Avi: 'AVI'
52
+ };