@emilgroup/tenant-sdk 1.0.0

package/dist/models/create-custom-schema-request-dto.js

@@ -0,0 +1,23 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateCustomSchemaRequestDtoEntityEnum = void 0;
+exports.CreateCustomSchemaRequestDtoEntityEnum = {
+    Account: 'account',
+    Claim: 'claim',
+    Invoice: 'invoice',
+    Payment: 'payment',
+    Organization: 'organization'
+};

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

@@ -0,0 +1,25 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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/dist/models/create-custom-schema-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-data-report-request-dto.d.ts

@@ -0,0 +1,61 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DataReportFilterDto } from './data-report-filter-dto';
+/**
+ *
+ * @export
+ * @interface CreateDataReportRequestDto
+ */
+export interface CreateDataReportRequestDto {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CreateDataReportRequestDto
+     */
+    'code': string;
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof CreateDataReportRequestDto
+     */
+    'slug': string;
+    /**
+     * Optional description of the data report.
+     * @type {string}
+     * @memberof CreateDataReportRequestDto
+     */
+    'description'?: string;
+    /**
+     * Athena view or query to use in the FROM clause of the report query.
+     * @type {string}
+     * @memberof CreateDataReportRequestDto
+     */
+    'fromClause': string;
+    /**
+     * Optional list of columns to sort the query results by (to use in the ORDER BY clause of the report query).
+     * @type {string}
+     * @memberof CreateDataReportRequestDto
+     */
+    'orderByClause'?: string;
+    /**
+     * Optional number of records to return as the report results.
+     * @type {number}
+     * @memberof CreateDataReportRequestDto
+     */
+    'limit'?: number;
+    /**
+     * Array with the report filter values.
+     * @type {Array<DataReportFilterDto>}
+     * @memberof CreateDataReportRequestDto
+     */
+    'filters': Array<DataReportFilterDto>;
+}

package/dist/models/create-data-report-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/create-data-report-response-class.d.ts

@@ -0,0 +1,25 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DataReportClass } from './data-report-class';
+/**
+ *
+ * @export
+ * @interface CreateDataReportResponseClass
+ */
+export interface CreateDataReportResponseClass {
+    /**
+     * The data-report response.
+     * @type {DataReportClass}
+     * @memberof CreateDataReportResponseClass
+     */
+    'report': DataReportClass;
+}

package/dist/models/create-data-report-response-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,42 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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;
+}

package/dist/models/create-permission-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,36 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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/dist/models/create-role-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,56 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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/dist/models/create-tenant-request-dto.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/custom-field-dto.d.ts

@@ -0,0 +1,68 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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 declare const CustomFieldDtoTypeEnum: {
+    readonly String: "string";
+    readonly Number: "number";
+    readonly Boolean: "boolean";
+    readonly Date: "date";
+    readonly Email: "email";
+};
+export type CustomFieldDtoTypeEnum = typeof CustomFieldDtoTypeEnum[keyof typeof CustomFieldDtoTypeEnum];

package/dist/models/custom-field-dto.js

@@ -0,0 +1,23 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldDtoTypeEnum = void 0;
+exports.CustomFieldDtoTypeEnum = {
+    String: 'string',
+    Number: 'number',
+    Boolean: 'boolean',
+    Date: 'date',
+    Email: 'email'
+};

package/dist/models/custom-schema-class.d.ts

@@ -0,0 +1,66 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * 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 CustomSchemaClass
+ */
+export interface CustomSchemaClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof CustomSchemaClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CustomSchemaClass
+     */
+    'code': string;
+    /**
+     * Optional field for a product specification custom fields
+     * @type {string}
+     * @memberof CustomSchemaClass
+     */
+    'productCode': string;
+    /**
+     * The fields that schema created from
+     * @type {object}
+     * @memberof CustomSchemaClass
+     */
+    'fields': object;
+    /**
+     * The json schema generated from fields
+     * @type {object}
+     * @memberof CustomSchemaClass
+     */
+    'jsonSchema': object;
+    /**
+     * The entity that this schema related to
+     * @type {string}
+     * @memberof CustomSchemaClass
+     */
+    'entity': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof CustomSchemaClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof CustomSchemaClass
+     */
+    'updatedAt': string;
+}

package/dist/models/custom-schema-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/data-report-class.d.ts

@@ -0,0 +1,79 @@
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { DataReportFilterClass } from './data-report-filter-class';
+/**
+ *
+ * @export
+ * @interface DataReportClass
+ */
+export interface DataReportClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof DataReportClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof DataReportClass
+     */
+    'code': string;
+    /**
+     * A slug is a human-readable, unique identifier, used to identify a resource      instead of a less human-readable identifier like an id.
+     * @type {string}
+     * @memberof DataReportClass
+     */
+    'slug': string;
+    /**
+     * Optional description of the data report.
+     * @type {string}
+     * @memberof DataReportClass
+     */
+    'description': string;
+    /**
+     * Athena view or query to use in the FROM clause of the report query.
+     * @type {string}
+     * @memberof DataReportClass
+     */
+    'fromClause': string;
+    /**
+     * Optional list of columns to sort the query results by (to use in the ORDER BY clause of the report query).
+     * @type {string}
+     * @memberof DataReportClass
+     */
+    'orderByClause': string;
+    /**
+     * Optional number of records to return as the report results.
+     * @type {number}
+     * @memberof DataReportClass
+     */
+    'limit': number;
+    /**
+     * List of the report filters.
+     * @type {Array<DataReportFilterClass>}
+     * @memberof DataReportClass
+     */
+    'filters': Array<DataReportFilterClass>;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof DataReportClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof DataReportClass
+     */
+    'updatedAt': string;
+}

package/dist/models/data-report-class.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });