@emilgroup/public-api-sdk 1.13.0 → 1.14.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.
@@ -4,6 +4,7 @@
4
4
  README.md
5
5
  api.ts
6
6
  api/address-completions-validations-api.ts
7
+ api/default-api.ts
7
8
  api/documents-api.ts
8
9
  api/leads-api.ts
9
10
  api/notifications-api.ts
@@ -50,6 +51,8 @@ models/initiate-payment-setup-request-dto.ts
50
51
  models/initiate-payment-setup-response-class.ts
51
52
  models/initiate-stripe-payment-setup-request-dto.ts
52
53
  models/initiate-stripe-payment-setup-response-class.ts
54
+ models/inline-response200.ts
55
+ models/inline-response503.ts
53
56
  models/insured-object-class.ts
54
57
  models/insured-object-type-class.ts
55
58
  models/invoice-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/public-api-sdk@1.13.0 --save
20
+ npm install @emilgroup/public-api-sdk@1.14.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/public-api-sdk@1.13.0
24
+ yarn add @emilgroup/public-api-sdk@1.14.0
25
25
  ```
26
26
 
27
27
  And then you can import `PublicApi`.
@@ -0,0 +1,120 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Emil PublicAPI
5
+ * The Emil Public API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { InlineResponse200 } from '../models';
25
+ // @ts-ignore
26
+ import { InlineResponse503 } from '../models';
27
+ /**
28
+ * DefaultApi - axios parameter creator
29
+ * @export
30
+ */
31
+ export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ *
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
39
+ const localVarPath = `/publicapi/health`;
40
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
41
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
42
+ let baseOptions;
43
+ let baseAccessToken;
44
+ if (configuration) {
45
+ baseOptions = configuration.baseOptions;
46
+ baseAccessToken = configuration.accessToken;
47
+ }
48
+
49
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
50
+ const localVarHeaderParameter = {} as any;
51
+ const localVarQueryParameter = {} as any;
52
+
53
+
54
+
55
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
56
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
57
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
58
+
59
+ return {
60
+ url: toPathString(localVarUrlObj),
61
+ options: localVarRequestOptions,
62
+ };
63
+ },
64
+ }
65
+ };
66
+
67
+ /**
68
+ * DefaultApi - functional programming interface
69
+ * @export
70
+ */
71
+ export const DefaultApiFp = function(configuration?: Configuration) {
72
+ const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
73
+ return {
74
+ /**
75
+ *
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ async check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>> {
80
+ const localVarAxiosArgs = await localVarAxiosParamCreator.check(options);
81
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
82
+ },
83
+ }
84
+ };
85
+
86
+ /**
87
+ * DefaultApi - factory interface
88
+ * @export
89
+ */
90
+ export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
91
+ const localVarFp = DefaultApiFp(configuration)
92
+ return {
93
+ /**
94
+ *
95
+ * @param {*} [options] Override http request option.
96
+ * @throws {RequiredError}
97
+ */
98
+ check(options?: any): AxiosPromise<InlineResponse200> {
99
+ return localVarFp.check(options).then((request) => request(axios, basePath));
100
+ },
101
+ };
102
+ };
103
+
104
+ /**
105
+ * DefaultApi - object-oriented interface
106
+ * @export
107
+ * @class DefaultApi
108
+ * @extends {BaseAPI}
109
+ */
110
+ export class DefaultApi extends BaseAPI {
111
+ /**
112
+ *
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ * @memberof DefaultApi
116
+ */
117
+ public check(options?: AxiosRequestConfig) {
118
+ return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
119
+ }
120
+ }
package/api.ts CHANGED
@@ -21,6 +21,7 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
23
  import { AddressCompletionsValidationsApi } from './api';
24
+ import { DefaultApi } from './api';
24
25
  import { DocumentsApi } from './api';
25
26
  import { LeadsApi } from './api';
26
27
  import { NotificationsApi } from './api';
@@ -29,6 +30,7 @@ import { ProductsApi } from './api';
29
30
 
30
31
 
31
32
  export * from './api/address-completions-validations-api';
33
+ export * from './api/default-api';
32
34
  export * from './api/documents-api';
33
35
  export * from './api/leads-api';
34
36
  export * from './api/notifications-api';
@@ -0,0 +1,66 @@
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
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { InlineResponse200 } from '../models';
16
+ /**
17
+ * DefaultApi - axios parameter creator
18
+ * @export
19
+ */
20
+ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
22
+ *
23
+ * @param {*} [options] Override http request option.
24
+ * @throws {RequiredError}
25
+ */
26
+ check: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
27
+ };
28
+ /**
29
+ * DefaultApi - functional programming interface
30
+ * @export
31
+ */
32
+ export declare const DefaultApiFp: (configuration?: Configuration) => {
33
+ /**
34
+ *
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>>;
39
+ };
40
+ /**
41
+ * DefaultApi - factory interface
42
+ * @export
43
+ */
44
+ export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
45
+ /**
46
+ *
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ check(options?: any): AxiosPromise<InlineResponse200>;
51
+ };
52
+ /**
53
+ * DefaultApi - object-oriented interface
54
+ * @export
55
+ * @class DefaultApi
56
+ * @extends {BaseAPI}
57
+ */
58
+ export declare class DefaultApi extends BaseAPI {
59
+ /**
60
+ *
61
+ * @param {*} [options] Override http request option.
62
+ * @throws {RequiredError}
63
+ * @memberof DefaultApi
64
+ */
65
+ check(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineResponse200, any>>;
66
+ }
@@ -0,0 +1,196 @@
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
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = function (d, b) {
17
+ extendStatics = Object.setPrototypeOf ||
18
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
+ return extendStatics(d, b);
21
+ };
22
+ return function (d, b) {
23
+ if (typeof b !== "function" && b !== null)
24
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
+ extendStatics(d, b);
26
+ function __() { this.constructor = d; }
27
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
+ };
29
+ })();
30
+ var __assign = (this && this.__assign) || function () {
31
+ __assign = Object.assign || function(t) {
32
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
33
+ s = arguments[i];
34
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
+ t[p] = s[p];
36
+ }
37
+ return t;
38
+ };
39
+ return __assign.apply(this, arguments);
40
+ };
41
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
+ return new (P || (P = Promise))(function (resolve, reject) {
44
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
45
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
46
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
47
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
48
+ });
49
+ };
50
+ var __generator = (this && this.__generator) || function (thisArg, body) {
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
+ function verb(n) { return function (v) { return step([n, v]); }; }
54
+ function step(op) {
55
+ if (f) throw new TypeError("Generator is already executing.");
56
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
58
+ if (y = 0, t) op = [op[0] & 2, t.value];
59
+ switch (op[0]) {
60
+ case 0: case 1: t = op; break;
61
+ case 4: _.label++; return { value: op[1], done: false };
62
+ case 5: _.label++; y = op[1]; op = [0]; continue;
63
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
+ default:
65
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
+ if (t[2]) _.ops.pop();
70
+ _.trys.pop(); continue;
71
+ }
72
+ op = body.call(thisArg, _);
73
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
+ }
76
+ };
77
+ var __importDefault = (this && this.__importDefault) || function (mod) {
78
+ return (mod && mod.__esModule) ? mod : { "default": mod };
79
+ };
80
+ Object.defineProperty(exports, "__esModule", { value: true });
81
+ exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = void 0;
82
+ var axios_1 = __importDefault(require("axios"));
83
+ // Some imports not used depending on template conditions
84
+ // @ts-ignore
85
+ var common_1 = require("../common");
86
+ // @ts-ignore
87
+ var base_1 = require("../base");
88
+ /**
89
+ * DefaultApi - axios parameter creator
90
+ * @export
91
+ */
92
+ var DefaultApiAxiosParamCreator = function (configuration) {
93
+ var _this = this;
94
+ return {
95
+ /**
96
+ *
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ check: function (options) {
101
+ if (options === void 0) { options = {}; }
102
+ return __awaiter(_this, void 0, void 0, function () {
103
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
104
+ return __generator(this, function (_a) {
105
+ localVarPath = "/publicapi/health";
106
+ localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
107
+ if (configuration) {
108
+ baseOptions = configuration.baseOptions;
109
+ baseAccessToken = configuration.accessToken;
110
+ }
111
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
112
+ localVarHeaderParameter = {};
113
+ localVarQueryParameter = {};
114
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
115
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
116
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
117
+ return [2 /*return*/, {
118
+ url: (0, common_1.toPathString)(localVarUrlObj),
119
+ options: localVarRequestOptions,
120
+ }];
121
+ });
122
+ });
123
+ },
124
+ };
125
+ };
126
+ exports.DefaultApiAxiosParamCreator = DefaultApiAxiosParamCreator;
127
+ /**
128
+ * DefaultApi - functional programming interface
129
+ * @export
130
+ */
131
+ var DefaultApiFp = function (configuration) {
132
+ var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
133
+ return {
134
+ /**
135
+ *
136
+ * @param {*} [options] Override http request option.
137
+ * @throws {RequiredError}
138
+ */
139
+ check: function (options) {
140
+ return __awaiter(this, void 0, void 0, function () {
141
+ var localVarAxiosArgs;
142
+ return __generator(this, function (_a) {
143
+ switch (_a.label) {
144
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.check(options)];
145
+ case 1:
146
+ localVarAxiosArgs = _a.sent();
147
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
148
+ }
149
+ });
150
+ });
151
+ },
152
+ };
153
+ };
154
+ exports.DefaultApiFp = DefaultApiFp;
155
+ /**
156
+ * DefaultApi - factory interface
157
+ * @export
158
+ */
159
+ var DefaultApiFactory = function (configuration, basePath, axios) {
160
+ var localVarFp = (0, exports.DefaultApiFp)(configuration);
161
+ return {
162
+ /**
163
+ *
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ */
167
+ check: function (options) {
168
+ return localVarFp.check(options).then(function (request) { return request(axios, basePath); });
169
+ },
170
+ };
171
+ };
172
+ exports.DefaultApiFactory = DefaultApiFactory;
173
+ /**
174
+ * DefaultApi - object-oriented interface
175
+ * @export
176
+ * @class DefaultApi
177
+ * @extends {BaseAPI}
178
+ */
179
+ var DefaultApi = /** @class */ (function (_super) {
180
+ __extends(DefaultApi, _super);
181
+ function DefaultApi() {
182
+ return _super !== null && _super.apply(this, arguments) || this;
183
+ }
184
+ /**
185
+ *
186
+ * @param {*} [options] Override http request option.
187
+ * @throws {RequiredError}
188
+ * @memberof DefaultApi
189
+ */
190
+ DefaultApi.prototype.check = function (options) {
191
+ var _this = this;
192
+ return (0, exports.DefaultApiFp)(this.configuration).check(options).then(function (request) { return request(_this.axios, _this.basePath); });
193
+ };
194
+ return DefaultApi;
195
+ }(base_1.BaseAPI));
196
+ exports.DefaultApi = DefaultApi;
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
  */
@@ -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
  }
@@ -33,6 +33,8 @@ export * from './initiate-payment-setup-request-dto';
33
33
  export * from './initiate-payment-setup-response-class';
34
34
  export * from './initiate-stripe-payment-setup-request-dto';
35
35
  export * from './initiate-stripe-payment-setup-response-class';
36
+ export * from './inline-response200';
37
+ export * from './inline-response503';
36
38
  export * from './insured-object-class';
37
39
  export * from './insured-object-type-class';
38
40
  export * from './invoice-class';