@emilgroup/tenant-sdk 1.0.0

package/dist/models/user-class.d.ts

@@ -0,0 +1,98 @@
+/**
+ * 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 { RoleClass } from './role-class';
+import { SubscriptionClass } from './subscription-class';
+/**
+ *
+ * @export
+ * @interface UserClass
+ */
+export interface UserClass {
+    /**
+     * user id
+     * @type {number}
+     * @memberof UserClass
+     */
+    'id': number;
+    /**
+     * unique user code
+     * @type {string}
+     * @memberof UserClass
+     */
+    'code': string;
+    /**
+     * email address of the user
+     * @type {string}
+     * @memberof UserClass
+     */
+    'email': string;
+    /**
+     * first name of the user
+     * @type {string}
+     * @memberof UserClass
+     */
+    'firstName': string;
+    /**
+     * first name of the user
+     * @type {string}
+     * @memberof UserClass
+     */
+    'lastName': string;
+    /**
+     * status of the of the user
+     * @type {string}
+     * @memberof UserClass
+     */
+    'status': string;
+    /**
+     * cognito sub of the user
+     * @type {string}
+     * @memberof UserClass
+     */
+    'sub': string;
+    /**
+     * tenant id
+     * @type {number}
+     * @memberof UserClass
+     */
+    'tenantId'?: number;
+    /**
+     * roles associated with the user
+     * @type {Array<RoleClass>}
+     * @memberof UserClass
+     */
+    'roles': Array<RoleClass>;
+    /**
+     * Organization ID the user belongs to
+     * @type {number}
+     * @memberof UserClass
+     */
+    'organizationId'?: number;
+    /**
+     * Subscriptions associated with the user
+     * @type {Array<SubscriptionClass>}
+     * @memberof UserClass
+     */
+    'subscriptions': Array<SubscriptionClass>;
+    /**
+     * Date created
+     * @type {string}
+     * @memberof UserClass
+     */
+    'createdAt': string;
+    /**
+     * Date updated
+     * @type {string}
+     * @memberof UserClass
+     */
+    'updatedAt': string;
+}

package/dist/models/user-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/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="Emil"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="tenant-sdk"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

package/index.ts

@@ -0,0 +1,19 @@
+/* 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.
+ */
+
+
+export { Environment, BaseAPI } from "./base";
+export * from "./api";
+export * from "./configuration";
+export * from "./models";

package/models/assign-user-roles-request-dto.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface AssignUserRolesRequestDto
+ */
+export interface AssignUserRolesRequestDto {
+    /**
+     * User id
+     * @type {number}
+     * @memberof AssignUserRolesRequestDto
+     */
+    'userId': number;
+    /**
+     * Role ids to be assigned
+     * @type {Array<number>}
+     * @memberof AssignUserRolesRequestDto
+     */
+    'roleIds': Array<number>;
+}
+

package/models/assign-user-roles-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
+ * 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 { UserClass } from './user-class';
+
+/**
+ * 
+ * @export
+ * @interface AssignUserRolesResponseClass
+ */
+export interface AssignUserRolesResponseClass {
+    /**
+     * user
+     * @type {UserClass}
+     * @memberof AssignUserRolesResponseClass
+     */
+    'user': UserClass;
+}
+

package/models/batch-delete-request-dto.ts

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface BatchDeleteRequestDto
+ */
+export interface BatchDeleteRequestDto {
+    /**
+     * Invited users ids.
+     * @type {Array<string>}
+     * @memberof BatchDeleteRequestDto
+     */
+    'ids': Array<string>;
+}
+

package/models/batch-delete-response-class.ts

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface BatchDeleteResponseClass
+ */
+export interface BatchDeleteResponseClass {
+    /**
+     * 
+     * @type {object}
+     * @memberof BatchDeleteResponseClass
+     */
+    'response': object;
+}
+

package/models/create-custom-schema-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
+ * 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 { CustomFieldDto } from './custom-field-dto';
+
+/**
+ * 
+ * @export
+ * @interface CreateCustomSchemaRequestDto
+ */
+export interface CreateCustomSchemaRequestDto {
+    /**
+     * 
+     * @type {Array<CustomFieldDto>}
+     * @memberof CreateCustomSchemaRequestDto
+     */
+    'items': Array<CustomFieldDto>;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateCustomSchemaRequestDto
+     */
+    'entity': CreateCustomSchemaRequestDtoEntityEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateCustomSchemaRequestDto
+     */
+    'productCode'?: string;
+}
+
+export const CreateCustomSchemaRequestDtoEntityEnum = {
+    Account: 'account',
+    Claim: 'claim',
+    Invoice: 'invoice',
+    Payment: 'payment',
+    Organization: 'organization'
+} as const;
+
+export type CreateCustomSchemaRequestDtoEntityEnum = typeof CreateCustomSchemaRequestDtoEntityEnum[keyof typeof CreateCustomSchemaRequestDtoEntityEnum];
+
+

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
+ * 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/models/create-data-report-request-dto.ts

@@ -0,0 +1,67 @@
+/* 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.
+ */
+
+
+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/models/create-data-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
+ * 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/models/create-permission-request-dto.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
+ * 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/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
+ * 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/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
+ * 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;
+}
+