@emilgroup/tenant-sdk-node 1.0.0-beta.0

package/models/create-custom-schema-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { CustomSchemaClass } from './custom-schema-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateCustomSchemaResponseClass
+ */
+export interface CreateCustomSchemaResponseClass {
+    /**
+     * The custom-schema response.
+     * @type {CustomSchemaClass}
+     * @memberof CreateCustomSchemaResponseClass
+     */
+    'customSchema': CustomSchemaClass;
+}
+

package/models/create-dashboard-request-dto.ts

@@ -0,0 +1,81 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreateDashboardRequestDto
+ */
+export interface CreateDashboardRequestDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDashboardRequestDto
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDashboardRequestDto
+     */
+    'providerId': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDashboardRequestDto
+     */
+    'provider': CreateDashboardRequestDtoProviderEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDashboardRequestDto
+     */
+    'category': CreateDashboardRequestDtoCategoryEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDashboardRequestDto
+     */
+    'description': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDashboardRequestDto
+     */
+    'product': CreateDashboardRequestDtoProductEnum;
+}
+
+export const CreateDashboardRequestDtoProviderEnum = {
+    QuickSight: 'quick-sight'
+} as const;
+
+export type CreateDashboardRequestDtoProviderEnum = typeof CreateDashboardRequestDtoProviderEnum[keyof typeof CreateDashboardRequestDtoProviderEnum];
+export const CreateDashboardRequestDtoCategoryEnum = {
+    Management: 'management',
+    PremiumBenchmarking: 'premium-benchmarking'
+} as const;
+
+export type CreateDashboardRequestDtoCategoryEnum = typeof CreateDashboardRequestDtoCategoryEnum[keyof typeof CreateDashboardRequestDtoCategoryEnum];
+export const CreateDashboardRequestDtoProductEnum = {
+    Car: 'car',
+    Homeowner: 'homeowner',
+    Household: 'household',
+    PrivateLiability: 'privateLiability'
+} as const;
+
+export type CreateDashboardRequestDtoProductEnum = typeof CreateDashboardRequestDtoProductEnum[keyof typeof CreateDashboardRequestDtoProductEnum];
+
+

package/models/create-dashboard-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { DashboardClass } from './dashboard-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateDashboardResponseClass
+ */
+export interface CreateDashboardResponseClass {
+    /**
+     * Dashboard
+     * @type {DashboardClass}
+     * @memberof CreateDashboardResponseClass
+     */
+    'dashboard': DashboardClass;
+}
+

package/models/create-permission-request-dto.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreatePermissionRequestDto
+ */
+export interface CreatePermissionRequestDto {
+    /**
+     * Permission\'s module
+     * @type {string}
+     * @memberof CreatePermissionRequestDto
+     */
+    'module': string;
+    /**
+     * Permission\'s entity or target
+     * @type {string}
+     * @memberof CreatePermissionRequestDto
+     */
+    'entity': string;
+    /**
+     * permission\'s action [read, write, delete etc]
+     * @type {string}
+     * @memberof CreatePermissionRequestDto
+     */
+    'action': string;
+    /**
+     * permission\'s category or header
+     * @type {string}
+     * @memberof CreatePermissionRequestDto
+     */
+    'category'?: string;
+    /**
+     * scope of the permission, true for only self targets
+     * @type {boolean}
+     * @memberof CreatePermissionRequestDto
+     */
+    'isScoped'?: boolean;
+}
+

package/models/create-permission-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { PermissionClass } from './permission-class';
+
+/**
+ * 
+ * @export
+ * @interface CreatePermissionResponseClass
+ */
+export interface CreatePermissionResponseClass {
+    /**
+     * permission
+     * @type {PermissionClass}
+     * @memberof CreatePermissionResponseClass
+     */
+    'permission': PermissionClass;
+}
+

package/models/create-report-request-dto.ts

@@ -0,0 +1,58 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreateReportRequestDto
+ */
+export interface CreateReportRequestDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportRequestDto
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportRequestDto
+     */
+    'slug': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportRequestDto
+     */
+    'description': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportRequestDto
+     */
+    'product': CreateReportRequestDtoProductEnum;
+}
+
+export const CreateReportRequestDtoProductEnum = {
+    Car: 'car',
+    Homeowner: 'homeowner',
+    Household: 'household',
+    PrivateLiability: 'privateLiability'
+} as const;
+
+export type CreateReportRequestDtoProductEnum = typeof CreateReportRequestDtoProductEnum[keyof typeof CreateReportRequestDtoProductEnum];
+
+

package/models/create-report-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { ReportClass } from './report-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateReportResponseClass
+ */
+export interface CreateReportResponseClass {
+    /**
+     * Report
+     * @type {ReportClass}
+     * @memberof CreateReportResponseClass
+     */
+    'report': ReportClass;
+}
+

package/models/create-role-request-dto.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreateRoleRequestDto
+ */
+export interface CreateRoleRequestDto {
+    /**
+     * Role\'s label
+     * @type {string}
+     * @memberof CreateRoleRequestDto
+     */
+    'label': string;
+    /**
+     * Short description of the role
+     * @type {string}
+     * @memberof CreateRoleRequestDto
+     */
+    'description': string;
+    /**
+     * Permission ids for the role
+     * @type {Array<string>}
+     * @memberof CreateRoleRequestDto
+     */
+    'permissionIds': Array<string>;
+}
+

package/models/create-role-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { RoleClass } from './role-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateRoleResponseClass
+ */
+export interface CreateRoleResponseClass {
+    /**
+     * role
+     * @type {RoleClass}
+     * @memberof CreateRoleResponseClass
+     */
+    'role': RoleClass;
+}
+

package/models/create-scenario-analysis-request-dto.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { ConditionDto } from './condition-dto';
+
+/**
+ * 
+ * @export
+ * @interface CreateScenarioAnalysisRequestDto
+ */
+export interface CreateScenarioAnalysisRequestDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateScenarioAnalysisRequestDto
+     */
+    'insuranceStartDate': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateScenarioAnalysisRequestDto
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateScenarioAnalysisRequestDto
+     */
+    'dashboardName': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateScenarioAnalysisRequestDto
+     */
+    'week': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateScenarioAnalysisRequestDto
+     */
+    'year': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateScenarioAnalysisRequestDto
+     */
+    'day': number;
+    /**
+     * 
+     * @type {Array<ConditionDto>}
+     * @memberof CreateScenarioAnalysisRequestDto
+     */
+    'conditions': Array<ConditionDto>;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateScenarioAnalysisRequestDto
+     */
+    'productType'?: CreateScenarioAnalysisRequestDtoProductTypeEnum;
+}
+
+export const CreateScenarioAnalysisRequestDtoProductTypeEnum = {
+    Car: 'car',
+    Homeowner: 'homeowner',
+    Household: 'household',
+    PrivateLiability: 'privateLiability'
+} as const;
+
+export type CreateScenarioAnalysisRequestDtoProductTypeEnum = typeof CreateScenarioAnalysisRequestDtoProductTypeEnum[keyof typeof CreateScenarioAnalysisRequestDtoProductTypeEnum];
+
+

package/models/create-scenario-analysis-response-class.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { ScenarioAnalysisClass } from './scenario-analysis-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateScenarioAnalysisResponseClass
+ */
+export interface CreateScenarioAnalysisResponseClass {
+    /**
+     * Scenario analysis response
+     * @type {ScenarioAnalysisClass}
+     * @memberof CreateScenarioAnalysisResponseClass
+     */
+    'scenarioAnalysis': ScenarioAnalysisClass;
+}
+

package/models/create-tenant-request-dto.ts

@@ -0,0 +1,62 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { DBConfigDto } from './dbconfig-dto';
+import { TenantAdminUserDto } from './tenant-admin-user-dto';
+
+/**
+ * 
+ * @export
+ * @interface CreateTenantRequestDto
+ */
+export interface CreateTenantRequestDto {
+    /**
+     * Tenant\'s name
+     * @type {string}
+     * @memberof CreateTenantRequestDto
+     */
+    'name': string;
+    /**
+     * Experimental - An id representing the tenant\'s tier
+     * @type {number}
+     * @memberof CreateTenantRequestDto
+     */
+    'tierId': number;
+    /**
+     * The Tenant\'s admin user account
+     * @type {TenantAdminUserDto}
+     * @memberof CreateTenantRequestDto
+     */
+    'adminUser': TenantAdminUserDto;
+    /**
+     * Description of tenants dedicated database. If omitted, the default pooled database will be used
+     * @type {DBConfigDto}
+     * @memberof CreateTenantRequestDto
+     */
+    'dbConfig'?: DBConfigDto;
+    /**
+     * Initial tenant settings like roles, tenant configurations about payment etc
+     * @type {object}
+     * @memberof CreateTenantRequestDto
+     */
+    'initialConfig'?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateTenantRequestDto
+     */
+    'slug'?: string;
+}
+

package/models/create-tenant-response-class.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreateTenantResponseClass
+ */
+export interface CreateTenantResponseClass {
+    /**
+     * Tenant\'s id
+     * @type {number}
+     * @memberof CreateTenantResponseClass
+     */
+    'id': number;
+    /**
+     * Tenant\'s name
+     * @type {string}
+     * @memberof CreateTenantResponseClass
+     */
+    'name': string;
+    /**
+     * A fixed string used to easily identify the tenant
+     * @type {string}
+     * @memberof CreateTenantResponseClass
+     */
+    'slug': string;
+    /**
+     * Experimental - An id representing the tenant\'s tier
+     * @type {number}
+     * @memberof CreateTenantResponseClass
+     */
+    'tierId': number;
+}
+

package/models/custom-field-dto.ts

@@ -0,0 +1,77 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CustomFieldDto
+ */
+export interface CustomFieldDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomFieldDto
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomFieldDto
+     */
+    'type': CustomFieldDtoTypeEnum;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CustomFieldDto
+     */
+    'isRequired': boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof CustomFieldDto
+     */
+    'minimum'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CustomFieldDto
+     */
+    'maximum'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CustomFieldDto
+     */
+    'minLength'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CustomFieldDto
+     */
+    'maxLength'?: number;
+}
+
+export const CustomFieldDtoTypeEnum = {
+    String: 'string',
+    Number: 'number',
+    Boolean: 'boolean',
+    Date: 'date',
+    Email: 'email'
+} as const;
+
+export type CustomFieldDtoTypeEnum = typeof CustomFieldDtoTypeEnum[keyof typeof CustomFieldDtoTypeEnum];
+
+