@emilgroup/public-api-sdk-node 1.29.0 → 1.31.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 (33) hide show
  1. package/.openapi-generator/FILES +1 -0
  2. package/README.md +2 -2
  3. package/api/booking-funnels-api.ts +4 -4
  4. package/api/leads-api.ts +25 -12
  5. package/api/payments-setup-api.ts +21 -8
  6. package/base.ts +16 -8
  7. package/dist/api/booking-funnels-api.d.ts +4 -4
  8. package/dist/api/booking-funnels-api.js +4 -4
  9. package/dist/api/leads-api.d.ts +17 -8
  10. package/dist/api/leads-api.js +17 -12
  11. package/dist/api/payments-setup-api.d.ts +13 -4
  12. package/dist/api/payments-setup-api.js +13 -8
  13. package/dist/base.d.ts +4 -2
  14. package/dist/base.js +26 -20
  15. package/dist/models/complete-payment-setup-request-dto.d.ts +6 -0
  16. package/dist/models/create-estimated-invoice-response-class.d.ts +7 -1
  17. package/dist/models/create-lead-request-dto.d.ts +6 -11
  18. package/dist/models/index.d.ts +1 -0
  19. package/dist/models/index.js +1 -0
  20. package/dist/models/initiate-payment-setup-request-dto.d.ts +6 -0
  21. package/dist/models/link-lead-partner-request-dto.d.ts +36 -0
  22. package/dist/models/link-lead-partner-request-dto.js +15 -0
  23. package/dist/models/partner-class.d.ts +1 -1
  24. package/dist/models/update-lead-request-dto.d.ts +7 -0
  25. package/models/complete-payment-setup-request-dto.ts +6 -0
  26. package/models/create-estimated-invoice-response-class.ts +7 -1
  27. package/models/create-lead-request-dto.ts +6 -11
  28. package/models/index.ts +1 -0
  29. package/models/initiate-payment-setup-request-dto.ts +6 -0
  30. package/models/link-lead-partner-request-dto.ts +42 -0
  31. package/models/partner-class.ts +1 -1
  32. package/models/update-lead-request-dto.ts +7 -0
  33. package/package.json +1 -1
@@ -35,12 +35,13 @@ export declare const PaymentsSetupApiAxiosParamCreator: (configuration?: Configu
35
35
  /**
36
36
  * This will send the customer the public key to load the payment form and complete the payment setup.
37
37
  * @summary Get public key and psp
38
+ * @param {string} productSlug
38
39
  * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
39
40
  * @param {string} [authorization] Bearer Token
40
41
  * @param {*} [options] Override http request option.
41
42
  * @throws {RequiredError}
42
43
  */
43
- getPublicPSPConfig: (idempotencyKey?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
+ getPublicPSPConfig: (productSlug: string, idempotencyKey?: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
45
  /**
45
46
  * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
46
47
  * @summary Initiate a payment setup
@@ -70,12 +71,13 @@ export declare const PaymentsSetupApiFp: (configuration?: Configuration) => {
70
71
  /**
71
72
  * This will send the customer the public key to load the payment form and complete the payment setup.
72
73
  * @summary Get public key and psp
74
+ * @param {string} productSlug
73
75
  * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
74
76
  * @param {string} [authorization] Bearer Token
75
77
  * @param {*} [options] Override http request option.
76
78
  * @throws {RequiredError}
77
79
  */
78
- getPublicPSPConfig(idempotencyKey?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicPspSettingsResponseClass>>;
80
+ getPublicPSPConfig(productSlug: string, idempotencyKey?: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPublicPspSettingsResponseClass>>;
79
81
  /**
80
82
  * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
81
83
  * @summary Initiate a payment setup
@@ -105,12 +107,13 @@ export declare const PaymentsSetupApiFactory: (configuration?: Configuration, ba
105
107
  /**
106
108
  * This will send the customer the public key to load the payment form and complete the payment setup.
107
109
  * @summary Get public key and psp
110
+ * @param {string} productSlug
108
111
  * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
109
112
  * @param {string} [authorization] Bearer Token
110
113
  * @param {*} [options] Override http request option.
111
114
  * @throws {RequiredError}
112
115
  */
113
- getPublicPSPConfig(idempotencyKey?: string, authorization?: string, options?: any): AxiosPromise<GetPublicPspSettingsResponseClass>;
116
+ getPublicPSPConfig(productSlug: string, idempotencyKey?: string, authorization?: string, options?: any): AxiosPromise<GetPublicPspSettingsResponseClass>;
114
117
  /**
115
118
  * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
116
119
  * @summary Initiate a payment setup
@@ -153,6 +156,12 @@ export interface PaymentsSetupApiCompletePaymentSetupRequest {
153
156
  * @interface PaymentsSetupApiGetPublicPSPConfigRequest
154
157
  */
155
158
  export interface PaymentsSetupApiGetPublicPSPConfigRequest {
159
+ /**
160
+ *
161
+ * @type {string}
162
+ * @memberof PaymentsSetupApiGetPublicPSPConfig
163
+ */
164
+ readonly productSlug: string;
156
165
  /**
157
166
  * An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
158
167
  * @type {string}
@@ -215,7 +224,7 @@ export declare class PaymentsSetupApi extends BaseAPI {
215
224
  * @throws {RequiredError}
216
225
  * @memberof PaymentsSetupApi
217
226
  */
218
- getPublicPSPConfig(requestParameters?: PaymentsSetupApiGetPublicPSPConfigRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPublicPspSettingsResponseClass, any>>;
227
+ getPublicPSPConfig(requestParameters: PaymentsSetupApiGetPublicPSPConfigRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPublicPspSettingsResponseClass, any>>;
219
228
  /**
220
229
  * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
221
230
  * @summary Initiate a payment setup
@@ -152,19 +152,23 @@ var PaymentsSetupApiAxiosParamCreator = function (configuration) {
152
152
  /**
153
153
  * This will send the customer the public key to load the payment form and complete the payment setup.
154
154
  * @summary Get public key and psp
155
+ * @param {string} productSlug
155
156
  * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
156
157
  * @param {string} [authorization] Bearer Token
157
158
  * @param {*} [options] Override http request option.
158
159
  * @throws {RequiredError}
159
160
  */
160
- getPublicPSPConfig: function (idempotencyKey, authorization, options) {
161
+ getPublicPSPConfig: function (productSlug, idempotencyKey, authorization, options) {
161
162
  if (options === void 0) { options = {}; }
162
163
  return __awaiter(_this, void 0, void 0, function () {
163
164
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
164
165
  return __generator(this, function (_a) {
165
166
  switch (_a.label) {
166
167
  case 0:
167
- localVarPath = "/publicapi/v1/payment-setup/get-psp-config";
168
+ // verify required parameter 'productSlug' is not null or undefined
169
+ (0, common_1.assertParamExists)('getPublicPSPConfig', 'productSlug', productSlug);
170
+ localVarPath = "/publicapi/v1/payment-setup/get-psp-config/{productSlug}"
171
+ .replace("{".concat("productSlug", "}"), encodeURIComponent(String(productSlug)));
168
172
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
169
173
  if (configuration) {
170
174
  baseOptions = configuration.baseOptions;
@@ -285,17 +289,18 @@ var PaymentsSetupApiFp = function (configuration) {
285
289
  /**
286
290
  * This will send the customer the public key to load the payment form and complete the payment setup.
287
291
  * @summary Get public key and psp
292
+ * @param {string} productSlug
288
293
  * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
289
294
  * @param {string} [authorization] Bearer Token
290
295
  * @param {*} [options] Override http request option.
291
296
  * @throws {RequiredError}
292
297
  */
293
- getPublicPSPConfig: function (idempotencyKey, authorization, options) {
298
+ getPublicPSPConfig: function (productSlug, idempotencyKey, authorization, options) {
294
299
  return __awaiter(this, void 0, void 0, function () {
295
300
  var localVarAxiosArgs;
296
301
  return __generator(this, function (_a) {
297
302
  switch (_a.label) {
298
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPublicPSPConfig(idempotencyKey, authorization, options)];
303
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getPublicPSPConfig(productSlug, idempotencyKey, authorization, options)];
299
304
  case 1:
300
305
  localVarAxiosArgs = _a.sent();
301
306
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -350,13 +355,14 @@ var PaymentsSetupApiFactory = function (configuration, basePath, axios) {
350
355
  /**
351
356
  * This will send the customer the public key to load the payment form and complete the payment setup.
352
357
  * @summary Get public key and psp
358
+ * @param {string} productSlug
353
359
  * @param {string} [idempotencyKey] An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. How you create unique keys is up to you, but we suggest using V4 UUIDs, or another random string with enough entropy to avoid collisions. Idempotency keys can be up to 255 characters long.
354
360
  * @param {string} [authorization] Bearer Token
355
361
  * @param {*} [options] Override http request option.
356
362
  * @throws {RequiredError}
357
363
  */
358
- getPublicPSPConfig: function (idempotencyKey, authorization, options) {
359
- return localVarFp.getPublicPSPConfig(idempotencyKey, authorization, options).then(function (request) { return request(axios, basePath); });
364
+ getPublicPSPConfig: function (productSlug, idempotencyKey, authorization, options) {
365
+ return localVarFp.getPublicPSPConfig(productSlug, idempotencyKey, authorization, options).then(function (request) { return request(axios, basePath); });
360
366
  },
361
367
  /**
362
368
  * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
@@ -406,8 +412,7 @@ var PaymentsSetupApi = /** @class */ (function (_super) {
406
412
  */
407
413
  PaymentsSetupApi.prototype.getPublicPSPConfig = function (requestParameters, options) {
408
414
  var _this = this;
409
- if (requestParameters === void 0) { requestParameters = {}; }
410
- return (0, exports.PaymentsSetupApiFp)(this.configuration).getPublicPSPConfig(requestParameters.idempotencyKey, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
415
+ return (0, exports.PaymentsSetupApiFp)(this.configuration).getPublicPSPConfig(requestParameters.productSlug, requestParameters.idempotencyKey, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
411
416
  };
412
417
  /**
413
418
  * This will Initiate an account inside the payment service providers and they will generate a secret token which is allow user add its payment information.
package/dist/base.d.ts CHANGED
@@ -24,7 +24,7 @@ export declare const COLLECTION_FORMATS: {
24
24
  };
25
25
  export interface LoginClass {
26
26
  accessToken: string;
27
- permissions: Array<string>;
27
+ permissions: string;
28
28
  }
29
29
  export declare enum Environment {
30
30
  Production = "https://apiv2.emil.de",
@@ -53,14 +53,16 @@ export declare class BaseAPI {
53
53
  protected configuration: Configuration;
54
54
  private username?;
55
55
  private password?;
56
+ private permissions?;
56
57
  constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
57
58
  initialize(env?: Environment): Promise<void>;
58
59
  private loadCredentials;
59
60
  private readConfigFile;
60
61
  private readEnvVariables;
61
62
  selectEnvironment(env: Environment): void;
63
+ getPermissions(): Array<string>;
62
64
  authorize(username: string, password: string): Promise<void>;
63
- refreshTokenInternal(): Promise<string>;
65
+ refreshTokenInternal(): Promise<LoginClass>;
64
66
  private extractRefreshToken;
65
67
  getConfiguration(): Configuration;
66
68
  private attachInterceptor;
package/dist/base.js CHANGED
@@ -242,11 +242,14 @@ var BaseAPI = /** @class */ (function () {
242
242
  BaseAPI.prototype.selectEnvironment = function (env) {
243
243
  this.configuration.basePath = env;
244
244
  };
245
+ BaseAPI.prototype.getPermissions = function () {
246
+ return this.permissions.split(',');
247
+ };
245
248
  BaseAPI.prototype.authorize = function (username, password) {
246
249
  return __awaiter(this, void 0, void 0, function () {
247
- var options, response, accessToken, refreshToken;
248
- return __generator(this, function (_a) {
249
- switch (_a.label) {
250
+ var options, response, _a, accessToken, permissions, refreshToken;
251
+ return __generator(this, function (_b) {
252
+ switch (_b.label) {
250
253
  case 0:
251
254
  options = {
252
255
  method: 'POST',
@@ -260,10 +263,11 @@ var BaseAPI = /** @class */ (function () {
260
263
  };
261
264
  return [4 /*yield*/, axios_1.default.request(options)];
262
265
  case 1:
263
- response = _a.sent();
264
- accessToken = response.data.accessToken;
266
+ response = _b.sent();
267
+ _a = response.data, accessToken = _a.accessToken, permissions = _a.permissions;
265
268
  this.configuration.username = username;
266
269
  this.configuration.accessToken = "Bearer ".concat(accessToken);
270
+ this.permissions = permissions;
267
271
  refreshToken = this.extractRefreshToken(response);
268
272
  this.configuration.refreshToken = refreshToken;
269
273
  return [2 /*return*/];
@@ -273,13 +277,13 @@ var BaseAPI = /** @class */ (function () {
273
277
  };
274
278
  BaseAPI.prototype.refreshTokenInternal = function () {
275
279
  return __awaiter(this, void 0, void 0, function () {
276
- var _a, username, refreshToken, options, accessToken;
280
+ var _a, username, refreshToken, options, response;
277
281
  return __generator(this, function (_b) {
278
282
  switch (_b.label) {
279
283
  case 0:
280
284
  _a = this.configuration, username = _a.username, refreshToken = _a.refreshToken;
281
285
  if (!username || !refreshToken) {
282
- return [2 /*return*/, ''];
286
+ throw new Error('Failed to refresh token.');
283
287
  }
284
288
  options = {
285
289
  method: 'POST',
@@ -293,8 +297,8 @@ var BaseAPI = /** @class */ (function () {
293
297
  };
294
298
  return [4 /*yield*/, axios_1.default.request(options)];
295
299
  case 1:
296
- accessToken = (_b.sent()).data.accessToken;
297
- return [2 /*return*/, accessToken];
300
+ response = _b.sent();
301
+ return [2 /*return*/, response.data];
298
302
  }
299
303
  });
300
304
  });
@@ -314,26 +318,27 @@ var BaseAPI = /** @class */ (function () {
314
318
  axios.interceptors.response.use(function (res) {
315
319
  return res;
316
320
  }, function (err) { return __awaiter(_this, void 0, void 0, function () {
317
- var originalConfig, tokenString, accessToken, _error_1, tokenString, accessToken, _error_2;
318
- return __generator(this, function (_a) {
319
- switch (_a.label) {
321
+ var originalConfig, _a, tokenString, permissions, accessToken, _error_1, _b, tokenString, permissions, accessToken, _error_2;
322
+ return __generator(this, function (_c) {
323
+ switch (_c.label) {
320
324
  case 0:
321
325
  originalConfig = err.config;
322
326
  if (!err.response) return [3 /*break*/, 5];
323
327
  if (!(err.response.status === 401 && !originalConfig._retry)) return [3 /*break*/, 4];
324
328
  originalConfig._retry = true;
325
- _a.label = 1;
329
+ _c.label = 1;
326
330
  case 1:
327
- _a.trys.push([1, 3, , 4]);
331
+ _c.trys.push([1, 3, , 4]);
328
332
  return [4 /*yield*/, this.refreshTokenInternal()];
329
333
  case 2:
330
- tokenString = _a.sent();
334
+ _a = _c.sent(), tokenString = _a.accessToken, permissions = _a.permissions;
331
335
  accessToken = "Bearer ".concat(tokenString);
336
+ this.permissions = permissions;
332
337
  originalConfig.headers['Authorization'] = "Bearer ".concat(accessToken);
333
338
  this.configuration.accessToken = accessToken;
334
339
  return [2 /*return*/, axios.request(originalConfig)];
335
340
  case 3:
336
- _error_1 = _a.sent();
341
+ _error_1 = _c.sent();
337
342
  if (_error_1.response && _error_1.response.data) {
338
343
  return [2 /*return*/, Promise.reject(_error_1.response.data)];
339
344
  }
@@ -349,19 +354,20 @@ var BaseAPI = /** @class */ (function () {
349
354
  && originalConfig.headers.hasOwnProperty('Authorization')
350
355
  && _retry_count < 4)) return [3 /*break*/, 9];
351
356
  _retry_count++;
352
- _a.label = 6;
357
+ _c.label = 6;
353
358
  case 6:
354
- _a.trys.push([6, 8, , 9]);
359
+ _c.trys.push([6, 8, , 9]);
355
360
  return [4 /*yield*/, this.refreshTokenInternal()];
356
361
  case 7:
357
- tokenString = _a.sent();
362
+ _b = _c.sent(), tokenString = _b.accessToken, permissions = _b.permissions;
358
363
  accessToken = "Bearer ".concat(tokenString);
364
+ this.permissions = permissions;
359
365
  _retry = true;
360
366
  originalConfig.headers['Authorization'] = accessToken;
361
367
  this.configuration.accessToken = accessToken;
362
368
  return [2 /*return*/, axios.request(__assign({}, originalConfig))];
363
369
  case 8:
364
- _error_2 = _a.sent();
370
+ _error_2 = _c.sent();
365
371
  if (_error_2.response && _error_2.response.data) {
366
372
  return [2 /*return*/, Promise.reject(_error_2.response.data)];
367
373
  }
@@ -29,4 +29,10 @@ export interface CompletePaymentSetupRequestDto {
29
29
  * @memberof CompletePaymentSetupRequestDto
30
30
  */
31
31
  'braintree'?: CompleteBraintreePaymentSetupRequestDto;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof CompletePaymentSetupRequestDto
36
+ */
37
+ 'productSlug'?: string;
32
38
  }
@@ -18,11 +18,17 @@ import { InvoiceClass } from './invoice-class';
18
18
  */
19
19
  export interface CreateEstimatedInvoiceResponseClass {
20
20
  /**
21
- * Estimated invoice response
21
+ * The estimated invoice response based on the current policy data. This includes the calculated invoice for the specified billing period (e.g., monthly, quarterly) as defined by the policy. The invoice contains details such as gross amount, net amount, tax amount, and other invoice-related data for the specific period the invoice is generated for.
22
22
  * @type {InvoiceClass}
23
23
  * @memberof CreateEstimatedInvoiceResponseClass
24
24
  */
25
25
  'invoice'?: InvoiceClass;
26
+ /**
27
+ * The estimated yearly invoice response. This represents the invoice recalculated to a yearly format, standardizing the invoice values regardless of the billing frequency defined by the policy (e.g., monthly, quarterly, etc.). This yearly invoice gives an overview of the total cost for the entire year, including recalculated gross amount, net amount, tax amount, and other related invoice data, ensuring that all charges are displayed on a yearly basis. Note: If the original invoice is already set to a yearly billing frequency, the \'yearlyInvoice\' will be identical to the \'invoice\'.
28
+ * @type {InvoiceClass}
29
+ * @memberof CreateEstimatedInvoiceResponseClass
30
+ */
31
+ 'yearlyInvoice'?: InvoiceClass;
26
32
  /**
27
33
  * In some cases, custom premium calculation needs to be used. In that case, a custom object is returned. It can hold up any kind of information. For more information, check the general documentation.
28
34
  * @type {object}
@@ -12,6 +12,7 @@
12
12
  import { CreateAccountRequestDto } from './create-account-request-dto';
13
13
  import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
14
14
  import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
15
+ import { LinkLeadPartnerRequestDto } from './link-lead-partner-request-dto';
15
16
  import { PolicyObjectRequestDto } from './policy-object-request-dto';
16
17
  import { PremiumOverrideRequestDto } from './premium-override-request-dto';
17
18
  import { UploadedDocumentDto } from './uploaded-document-dto';
@@ -89,10 +90,10 @@ export interface CreateLeadRequestDto {
89
90
  'status'?: string;
90
91
  /**
91
92
  * 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.
92
- * @type {Array<PremiumOverrideRequestDto>}
93
+ * @type {PremiumOverrideRequestDto}
93
94
  * @memberof CreateLeadRequestDto
94
95
  */
95
- 'premiumOverride'?: Array<PremiumOverrideRequestDto>;
96
+ 'premiumOverride'?: PremiumOverrideRequestDto;
96
97
  /**
97
98
  * 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.
98
99
  * @type {CreatePaymentMethodRequestDto}
@@ -106,15 +107,9 @@ export interface CreateLeadRequestDto {
106
107
  */
107
108
  'validate'?: boolean;
108
109
  /**
109
- * An optional partner code to establish a link between a lead and a partner. It must be sent together with the partner role code. It will be validated regardless of the value of the \'validate\' flag.
110
- * @type {string}
111
- * @memberof CreateLeadRequestDto
112
- */
113
- 'partnerCode'?: string;
114
- /**
115
- * An optional partner role code to establish a link between a lead and a partner. It must be sent together with the partner code. It will be validated regardless of the value of the \'validate\' flag.
116
- * @type {string}
110
+ * Optional partner object contains necessary information to link a partner to the policy. The partner content will be validated if the \'validate\' flag is set to true.
111
+ * @type {LinkLeadPartnerRequestDto}
117
112
  * @memberof CreateLeadRequestDto
118
113
  */
119
- 'partnerRoleCode'?: string;
114
+ 'partner'?: LinkLeadPartnerRequestDto;
120
115
  }
@@ -51,6 +51,7 @@ export * from './lead-bank-account-class';
51
51
  export * from './lead-class';
52
52
  export * from './lead-policy-class';
53
53
  export * from './lead-policy-object-class';
54
+ export * from './link-lead-partner-request-dto';
54
55
  export * from './list-documents-response-class';
55
56
  export * from './list-product-documents-response-class';
56
57
  export * from './list-products-response-class';
@@ -67,6 +67,7 @@ __exportStar(require("./lead-bank-account-class"), exports);
67
67
  __exportStar(require("./lead-class"), exports);
68
68
  __exportStar(require("./lead-policy-class"), exports);
69
69
  __exportStar(require("./lead-policy-object-class"), exports);
70
+ __exportStar(require("./link-lead-partner-request-dto"), exports);
70
71
  __exportStar(require("./list-documents-response-class"), exports);
71
72
  __exportStar(require("./list-product-documents-response-class"), exports);
72
73
  __exportStar(require("./list-products-response-class"), exports);
@@ -29,4 +29,10 @@ export interface InitiatePaymentSetupRequestDto {
29
29
  * @memberof InitiatePaymentSetupRequestDto
30
30
  */
31
31
  'braintree'?: InitiateBraintreePaymentSetupRequestDto;
32
+ /**
33
+ *
34
+ * @type {string}
35
+ * @memberof InitiatePaymentSetupRequestDto
36
+ */
37
+ 'productSlug'?: string;
32
38
  }
@@ -0,0 +1,36 @@
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 LinkLeadPartnerRequestDto
16
+ */
17
+ export interface LinkLeadPartnerRequestDto {
18
+ /**
19
+ * The code of the partner with which the lead will be linked.
20
+ * @type {string}
21
+ * @memberof LinkLeadPartnerRequestDto
22
+ */
23
+ 'partnerCode': string;
24
+ /**
25
+ * The code of role that the partner will have in the established link between the lead and the partner.
26
+ * @type {string}
27
+ * @memberof LinkLeadPartnerRequestDto
28
+ */
29
+ 'partnerRoleCode': string;
30
+ /**
31
+ * The date of the start of linking with a partner.
32
+ * @type {string}
33
+ * @memberof LinkLeadPartnerRequestDto
34
+ */
35
+ 'startDate': string;
36
+ }
@@ -0,0 +1,15 @@
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 });
@@ -44,7 +44,7 @@ export interface PartnerClass {
44
44
  * @type {object}
45
45
  * @memberof PartnerClass
46
46
  */
47
- 'partner'?: object;
47
+ 'customFields'?: object;
48
48
  /**
49
49
  * The version number of the partner
50
50
  * @type {number}
@@ -12,6 +12,7 @@
12
12
  import { CreateAccountRequestDto } from './create-account-request-dto';
13
13
  import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
14
14
  import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
15
+ import { LinkLeadPartnerRequestDto } from './link-lead-partner-request-dto';
15
16
  import { PolicyObjectRequestDto } from './policy-object-request-dto';
16
17
  import { UploadedDocumentDto } from './uploaded-document-dto';
17
18
  /**
@@ -92,4 +93,10 @@ export interface UpdateLeadRequestDto {
92
93
  * @memberof UpdateLeadRequestDto
93
94
  */
94
95
  'validate'?: boolean;
96
+ /**
97
+ *
98
+ * @type {LinkLeadPartnerRequestDto}
99
+ * @memberof UpdateLeadRequestDto
100
+ */
101
+ 'partner'?: LinkLeadPartnerRequestDto;
95
102
  }
@@ -34,5 +34,11 @@ export interface CompletePaymentSetupRequestDto {
34
34
  * @memberof CompletePaymentSetupRequestDto
35
35
  */
36
36
  'braintree'?: CompleteBraintreePaymentSetupRequestDto;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof CompletePaymentSetupRequestDto
41
+ */
42
+ 'productSlug'?: string;
37
43
  }
38
44
 
@@ -23,11 +23,17 @@ import { InvoiceClass } from './invoice-class';
23
23
  */
24
24
  export interface CreateEstimatedInvoiceResponseClass {
25
25
  /**
26
- * Estimated invoice response
26
+ * The estimated invoice response based on the current policy data. This includes the calculated invoice for the specified billing period (e.g., monthly, quarterly) as defined by the policy. The invoice contains details such as gross amount, net amount, tax amount, and other invoice-related data for the specific period the invoice is generated for.
27
27
  * @type {InvoiceClass}
28
28
  * @memberof CreateEstimatedInvoiceResponseClass
29
29
  */
30
30
  'invoice'?: InvoiceClass;
31
+ /**
32
+ * The estimated yearly invoice response. This represents the invoice recalculated to a yearly format, standardizing the invoice values regardless of the billing frequency defined by the policy (e.g., monthly, quarterly, etc.). This yearly invoice gives an overview of the total cost for the entire year, including recalculated gross amount, net amount, tax amount, and other related invoice data, ensuring that all charges are displayed on a yearly basis. Note: If the original invoice is already set to a yearly billing frequency, the \'yearlyInvoice\' will be identical to the \'invoice\'.
33
+ * @type {InvoiceClass}
34
+ * @memberof CreateEstimatedInvoiceResponseClass
35
+ */
36
+ 'yearlyInvoice'?: InvoiceClass;
31
37
  /**
32
38
  * In some cases, custom premium calculation needs to be used. In that case, a custom object is returned. It can hold up any kind of information. For more information, check the general documentation.
33
39
  * @type {object}
@@ -16,6 +16,7 @@
16
16
  import { CreateAccountRequestDto } from './create-account-request-dto';
17
17
  import { CreateBankAccountRequestDto } from './create-bank-account-request-dto';
18
18
  import { CreatePaymentMethodRequestDto } from './create-payment-method-request-dto';
19
+ import { LinkLeadPartnerRequestDto } from './link-lead-partner-request-dto';
19
20
  import { PolicyObjectRequestDto } from './policy-object-request-dto';
20
21
  import { PremiumOverrideRequestDto } from './premium-override-request-dto';
21
22
  import { UploadedDocumentDto } from './uploaded-document-dto';
@@ -94,10 +95,10 @@ export interface CreateLeadRequestDto {
94
95
  'status'?: string;
95
96
  /**
96
97
  * 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.
97
- * @type {Array<PremiumOverrideRequestDto>}
98
+ * @type {PremiumOverrideRequestDto}
98
99
  * @memberof CreateLeadRequestDto
99
100
  */
100
- 'premiumOverride'?: Array<PremiumOverrideRequestDto>;
101
+ 'premiumOverride'?: PremiumOverrideRequestDto;
101
102
  /**
102
103
  * 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.
103
104
  * @type {CreatePaymentMethodRequestDto}
@@ -111,16 +112,10 @@ export interface CreateLeadRequestDto {
111
112
  */
112
113
  'validate'?: boolean;
113
114
  /**
114
- * An optional partner code to establish a link between a lead and a partner. It must be sent together with the partner role code. It will be validated regardless of the value of the \'validate\' flag.
115
- * @type {string}
116
- * @memberof CreateLeadRequestDto
117
- */
118
- 'partnerCode'?: string;
119
- /**
120
- * An optional partner role code to establish a link between a lead and a partner. It must be sent together with the partner code. It will be validated regardless of the value of the \'validate\' flag.
121
- * @type {string}
115
+ * Optional partner object contains necessary information to link a partner to the policy. The partner content will be validated if the \'validate\' flag is set to true.
116
+ * @type {LinkLeadPartnerRequestDto}
122
117
  * @memberof CreateLeadRequestDto
123
118
  */
124
- 'partnerRoleCode'?: string;
119
+ 'partner'?: LinkLeadPartnerRequestDto;
125
120
  }
126
121
 
package/models/index.ts CHANGED
@@ -51,6 +51,7 @@ export * from './lead-bank-account-class';
51
51
  export * from './lead-class';
52
52
  export * from './lead-policy-class';
53
53
  export * from './lead-policy-object-class';
54
+ export * from './link-lead-partner-request-dto';
54
55
  export * from './list-documents-response-class';
55
56
  export * from './list-product-documents-response-class';
56
57
  export * from './list-products-response-class';
@@ -34,5 +34,11 @@ export interface InitiatePaymentSetupRequestDto {
34
34
  * @memberof InitiatePaymentSetupRequestDto
35
35
  */
36
36
  'braintree'?: InitiateBraintreePaymentSetupRequestDto;
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof InitiatePaymentSetupRequestDto
41
+ */
42
+ 'productSlug'?: string;
37
43
  }
38
44
 
@@ -0,0 +1,42 @@
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
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface LinkLeadPartnerRequestDto
21
+ */
22
+ export interface LinkLeadPartnerRequestDto {
23
+ /**
24
+ * The code of the partner with which the lead will be linked.
25
+ * @type {string}
26
+ * @memberof LinkLeadPartnerRequestDto
27
+ */
28
+ 'partnerCode': string;
29
+ /**
30
+ * The code of role that the partner will have in the established link between the lead and the partner.
31
+ * @type {string}
32
+ * @memberof LinkLeadPartnerRequestDto
33
+ */
34
+ 'partnerRoleCode': string;
35
+ /**
36
+ * The date of the start of linking with a partner.
37
+ * @type {string}
38
+ * @memberof LinkLeadPartnerRequestDto
39
+ */
40
+ 'startDate': string;
41
+ }
42
+
@@ -49,7 +49,7 @@ export interface PartnerClass {
49
49
  * @type {object}
50
50
  * @memberof PartnerClass
51
51
  */
52
- 'partner'?: object;
52
+ 'customFields'?: object;
53
53
  /**
54
54
  * The version number of the partner
55
55
  * @type {number}