@emilgroup/tenant-sdk 1.3.0 → 1.5.0

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

@@ -0,0 +1,31 @@
+/**
+ * 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 { DataReportFilterValueDto } from './data-report-filter-value-dto';
+/**
+ *
+ * @export
+ * @interface RunDataReportRequestDto
+ */
+export interface RunDataReportRequestDto {
+    /**
+     * Slug of the report to run
+     * @type {string}
+     * @memberof RunDataReportRequestDto
+     */
+    'reportSlug': string;
+    /**
+     * Array with the report filter values.
+     * @type {Array<DataReportFilterValueDto>}
+     * @memberof RunDataReportRequestDto
+     */
+    'filterValues': Array<DataReportFilterValueDto>;
+}

package/dist/models/run-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/run-data-report-response-class.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 RunDataReportResponseClass
+ */
+export interface RunDataReportResponseClass {
+    /**
+     * Report results as an array of objects (each row is an object).
+     * @type {Array<any>}
+     * @memberof RunDataReportResponseClass
+     */
+    'data': Array<any>;
+}

package/dist/models/run-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/update-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 UpdateDataReportRequestDto
+ */
+export interface UpdateDataReportRequestDto {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof UpdateDataReportRequestDto
+     */
+    '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 UpdateDataReportRequestDto
+     */
+    'slug': string;
+    /**
+     * Optional description of the data report.
+     * @type {string}
+     * @memberof UpdateDataReportRequestDto
+     */
+    'description'?: string;
+    /**
+     * Athena view or query to use in the FROM clause of the report query.
+     * @type {string}
+     * @memberof UpdateDataReportRequestDto
+     */
+    '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 UpdateDataReportRequestDto
+     */
+    'orderByClause'?: string;
+    /**
+     * Optional number of records to return as the report results.
+     * @type {number}
+     * @memberof UpdateDataReportRequestDto
+     */
+    'limit'?: number;
+    /**
+     * Array with the report filter values.
+     * @type {Array<DataReportFilterDto>}
+     * @memberof UpdateDataReportRequestDto
+     */
+    'filters': Array<DataReportFilterDto>;
+}

package/dist/models/update-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/update-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 UpdateDataReportResponseClass
+ */
+export interface UpdateDataReportResponseClass {
+    /**
+     * The data-report response.
+     * @type {DataReportClass}
+     * @memberof UpdateDataReportResponseClass
+     */
+    'report': DataReportClass;
+}

package/dist/models/update-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/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/data-report-class.ts

@@ -0,0 +1,85 @@
+/* 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 { 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/models/data-report-filter-class.ts

@@ -0,0 +1,78 @@
+/* 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 DataReportFilterClass
+ */
+export interface DataReportFilterClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof DataReportFilterClass
+     */
+    'id': number;
+    /**
+     * Internal unique identifier for the report this filter belongs to.
+     * @type {number}
+     * @memberof DataReportFilterClass
+     */
+    'dataReportId': number;
+    /**
+     * Name of the filter (name of the Athena view column).
+     * @type {string}
+     * @memberof DataReportFilterClass
+     */
+    'name': string;
+    /**
+     * Optional description of the data report filter.
+     * @type {string}
+     * @memberof DataReportFilterClass
+     */
+    'description': string;
+    /**
+     * Type of the filter column (int, float, datetime or string).
+     * @type {string}
+     * @memberof DataReportFilterClass
+     */
+    'type': string;
+    /**
+     * Condition the filter uses (=, in or between).
+     * @type {string}
+     * @memberof DataReportFilterClass
+     */
+    'condition': string;
+    /**
+     * Set to true if the filter is mandatory when executing the report.
+     * @type {boolean}
+     * @memberof DataReportFilterClass
+     */
+    'isMandatory': boolean;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof DataReportFilterClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof DataReportFilterClass
+     */
+    'updatedAt': string;
+}
+

package/models/data-report-filter-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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface DataReportFilterDto
+ */
+export interface DataReportFilterDto {
+    /**
+     * Name of the filter (name of the Athena view column).
+     * @type {string}
+     * @memberof DataReportFilterDto
+     */
+    'name': string;
+    /**
+     * Optional description of the data report filter.
+     * @type {string}
+     * @memberof DataReportFilterDto
+     */
+    'description'?: string;
+    /**
+     * Type of the filter column (int, float, datetime or string).
+     * @type {string}
+     * @memberof DataReportFilterDto
+     */
+    'type': string;
+    /**
+     * Condition the filter uses (=, in or between).
+     * @type {string}
+     * @memberof DataReportFilterDto
+     */
+    'condition': string;
+    /**
+     * Set to true if the filter is mandatory when executing the report.
+     * @type {boolean}
+     * @memberof DataReportFilterDto
+     */
+    'isMandatory'?: boolean;
+}
+

package/models/data-report-filter-single-value-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 DataReportFilterSingleValueDto
+ */
+export interface DataReportFilterSingleValueDto {
+    /**
+     * Integer value of the filter.
+     * @type {number}
+     * @memberof DataReportFilterSingleValueDto
+     */
+    'valueAsInt'?: number;
+    /**
+     * Float value of the filter.
+     * @type {number}
+     * @memberof DataReportFilterSingleValueDto
+     */
+    'valueAsFloat'?: number;
+    /**
+     * String value of the filter.
+     * @type {string}
+     * @memberof DataReportFilterSingleValueDto
+     */
+    'valueAsString'?: string;
+    /**
+     * String value of the filter.
+     * @type {string}
+     * @memberof DataReportFilterSingleValueDto
+     */
+    'valueAsDate'?: string;
+}
+

package/models/data-report-filter-value-dto.ts

@@ -0,0 +1,37 @@
+/* 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 { DataReportFilterSingleValueDto } from './data-report-filter-single-value-dto';
+
+/**
+ * 
+ * @export
+ * @interface DataReportFilterValueDto
+ */
+export interface DataReportFilterValueDto {
+    /**
+     * Name of the filter
+     * @type {string}
+     * @memberof DataReportFilterValueDto
+     */
+    'name': string;
+    /**
+     * Array with the values to use in the report filter condition     (a single value array for the \"equality\" filters,     a two value array for the \"between\" filter,     an array with one or more values for the \"multiselect\" filters).
+     * @type {Array<DataReportFilterSingleValueDto>}
+     * @memberof DataReportFilterValueDto
+     */
+    'values': Array<DataReportFilterSingleValueDto>;
+}
+

package/models/get-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 GetDataReportResponseClass
+ */
+export interface GetDataReportResponseClass {
+    /**
+     * The data-report response.
+     * @type {DataReportClass}
+     * @memberof GetDataReportResponseClass
+     */
+    'report': DataReportClass;
+}
+