@emilgroup/tenant-sdk-node 1.34.1-beta.21 → 1.34.1-beta.22

package/dist/models/user-group-member-class.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 UserGroupMemberClass
+ */
+export interface UserGroupMemberClass {
+    /**
+     * Code of the user who is a member.
+     * @type {string}
+     * @memberof UserGroupMemberClass
+     */
+    'userCode': string;
+    /**
+     * Display name of the user (first + last). Snapshot at member-add time; not kept in sync with subsequent user-profile edits.
+     * @type {string}
+     * @memberof UserGroupMemberClass
+     */
+    'name'?: string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof UserGroupMemberClass
+     */
+    'createdAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof UserGroupMemberClass
+     */
+    'createdBy': string;
+}

package/dist/models/user-group-member-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/add-users-to-group-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 AddUsersToGroupRequestDto
+ */
+export interface AddUsersToGroupRequestDto {
+    /**
+     * User codes to add as members. Idempotent per user. Max 50 per call.
+     * @type {Array<string>}
+     * @memberof AddUsersToGroupRequestDto
+     */
+    'userCodes': Array<string>;
+}
+

package/models/add-users-to-group-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 { UserGroupMemberClass } from './user-group-member-class';
+
+/**
+ * 
+ * @export
+ * @interface AddUsersToGroupResponseClass
+ */
+export interface AddUsersToGroupResponseClass {
+    /**
+     * Members added by the request (full resulting set).
+     * @type {Array<UserGroupMemberClass>}
+     * @memberof AddUsersToGroupResponseClass
+     */
+    'items': Array<UserGroupMemberClass>;
+}
+

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

@@ -0,0 +1,121 @@
+/* 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 { ReportScheduleParameterDto } from './report-schedule-parameter-dto';
+
+/**
+ * 
+ * @export
+ * @interface CreateReportScheduleRequestDto
+ */
+export interface CreateReportScheduleRequestDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'description'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'reportCode': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'reportName': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'exportFormat': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'reportSheet'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'skipHeaderRow': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'frequency': string;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'periods': Array<number>;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'executionTime': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'adminUrl': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'emailRecipients': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'emailSubject'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'emailTemplateSlug': string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'isActive': boolean;
+    /**
+     * 
+     * @type {Array<ReportScheduleParameterDto>}
+     * @memberof CreateReportScheduleRequestDto
+     */
+    'parameters': Array<ReportScheduleParameterDto>;
+}
+

package/models/create-report-schedule-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 { ReportScheduleClass } from './report-schedule-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateReportScheduleResponseClass
+ */
+export interface CreateReportScheduleResponseClass {
+    /**
+     * The report-schedule response.
+     * @type {ReportScheduleClass}
+     * @memberof CreateReportScheduleResponseClass
+     */
+    'reportSchedule': ReportScheduleClass;
+}
+

package/models/create-user-group-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 CreateUserGroupRequestDto
+ */
+export interface CreateUserGroupRequestDto {
+    /**
+     * Human-readable, renameable identifier for the user group. Unique per tenant. Must match /^[a-z0-9-]+$/.
+     * @type {string}
+     * @memberof CreateUserGroupRequestDto
+     */
+    'slug': string;
+    /**
+     * Display name for the user group.
+     * @type {string}
+     * @memberof CreateUserGroupRequestDto
+     */
+    'name': string;
+    /**
+     * Optional free-text description.
+     * @type {string}
+     * @memberof CreateUserGroupRequestDto
+     */
+    'description'?: string;
+}
+

package/models/create-user-group-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 { UserGroupClass } from './user-group-class';
+
+/**
+ * 
+ * @export
+ * @interface CreateUserGroupResponseClass
+ */
+export interface CreateUserGroupResponseClass {
+    /**
+     * The created user group.
+     * @type {UserGroupClass}
+     * @memberof CreateUserGroupResponseClass
+     */
+    'userGroup': UserGroupClass;
+}
+

package/models/dashboard-metadata-class.ts

@@ -0,0 +1,49 @@
+/* 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 { QuickSightAnalysisParameterClass } from './quick-sight-analysis-parameter-class';
+
+/**
+ * 
+ * @export
+ * @interface DashboardMetadataClass
+ */
+export interface DashboardMetadataClass {
+    /**
+     * QuickSight analysis display name
+     * @type {string}
+     * @memberof DashboardMetadataClass
+     */
+    'name': string;
+    /**
+     * QuickSight analysis identifier
+     * @type {string}
+     * @memberof DashboardMetadataClass
+     */
+    'quicksightAnalysisId': string;
+    /**
+     * Sheet names defined on the analysis
+     * @type {Array<string>}
+     * @memberof DashboardMetadataClass
+     */
+    'sheets': Array<string>;
+    /**
+     * Analysis parameters exposed for embedding or filtering
+     * @type {Array<QuickSightAnalysisParameterClass>}
+     * @memberof DashboardMetadataClass
+     */
+    'parameters': Array<QuickSightAnalysisParameterClass>;
+}
+

package/models/get-dashboard-metadata-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 { DashboardMetadataClass } from './dashboard-metadata-class';
+
+/**
+ * 
+ * @export
+ * @interface GetDashboardMetadataResponseClass
+ */
+export interface GetDashboardMetadataResponseClass {
+    /**
+     * QuickSight dashboard analysis metadata when available
+     * @type {DashboardMetadataClass}
+     * @memberof GetDashboardMetadataResponseClass
+     */
+    'metadata'?: DashboardMetadataClass;
+}
+

package/models/get-report-schedule-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 { ReportScheduleClass } from './report-schedule-class';
+
+/**
+ * 
+ * @export
+ * @interface GetReportScheduleResponseClass
+ */
+export interface GetReportScheduleResponseClass {
+    /**
+     * The report-schedule response.
+     * @type {ReportScheduleClass}
+     * @memberof GetReportScheduleResponseClass
+     */
+    'reportSchedule': ReportScheduleClass;
+}
+

package/models/get-user-group-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 { UserGroupClass } from './user-group-class';
+
+/**
+ * 
+ * @export
+ * @interface GetUserGroupResponseClass
+ */
+export interface GetUserGroupResponseClass {
+    /**
+     * The user group.
+     * @type {UserGroupClass}
+     * @memberof GetUserGroupResponseClass
+     */
+    'userGroup': UserGroupClass;
+}
+

package/models/index.ts

@@ -1,3 +1,5 @@
+export * from './add-users-to-group-request-dto';
+export * from './add-users-to-group-response-class';
 export * from './assign-user-roles-request-dto';
 export * from './assign-user-roles-response-class';
 export * from './batch-delete-request-dto';
@@ -14,13 +16,18 @@ export * from './create-data-report-request-dto';
 export * from './create-data-report-response-class';
 export * from './create-organization-migration-request-dto';
 export * from './create-organization-migration-response-class';
+export * from './create-report-schedule-request-dto';
+export * from './create-report-schedule-response-class';
 export * from './create-resources-migration-request-dto';
 export * from './create-tenant-request-dto';
+export * from './create-user-group-request-dto';
+export * from './create-user-group-response-class';
 export * from './custom-field-dto';
 export * from './custom-schema-class';
 export * from './dbconfig-dto';
 export * from './dashboard-class';
 export * from './dashboard-group-class';
+export * from './dashboard-metadata-class';
 export * from './data-report-class';
 export * from './data-report-filter-class';
 export * from './data-report-filter-dto';
@@ -35,12 +42,15 @@ export * from './enable-users-response-class';
 export * from './format-tenant-settings-class';
 export * from './get-custom-schema-response-class';
 export * from './get-dashboard-group-response-class';
+export * from './get-dashboard-metadata-response-class';
 export * from './get-dashboard-response-class';
 export * from './get-data-report-response-class';
 export * from './get-embedded-url-response-class';
 export * from './get-organization-migration-response-class';
 export * from './get-organization-response-class';
+export * from './get-report-schedule-response-class';
 export * from './get-settings-response-class';
+export * from './get-user-group-response-class';
 export * from './get-user-response-class';
 export * from './initial-tenant-config-class';
 export * from './inline-response200';
@@ -61,7 +71,11 @@ export * from './list-invites-response-class';
 export * from './list-org-invitations-response-class';
 export * from './list-organization-migrations-response-class';
 export * from './list-organizations-response-class';
+export * from './list-report-schedule-logs-response-class';
+export * from './list-report-schedules-response-class';
 export * from './list-roles-response-class';
+export * from './list-user-group-members-response-class';
+export * from './list-user-groups-response-class';
 export * from './list-users-response-class';
 export * from './org-invitation-class';
 export * from './org-invitation-response-class';
@@ -69,7 +83,14 @@ export * from './organization-class';
 export * from './organization-migration-class';
 export * from './permission-class';
 export * from './publish-dashboard-request-dto';
+export * from './quick-sight-analysis-parameter-class';
 export * from './re-invite-org-request-dto';
+export * from './remove-users-from-group-request-dto';
+export * from './report-schedule-class';
+export * from './report-schedule-log-class';
+export * from './report-schedule-parameter-class';
+export * from './report-schedule-parameter-dto';
+export * from './report-schedule-parameter-value-class';
 export * from './revert-analysis-request-dto';
 export * from './revert-organization-migration-request-dto';
 export * from './revert-organization-migration-response-class';
@@ -93,4 +114,10 @@ export * from './update-data-report-request-dto';
 export * from './update-data-report-response-class';
 export * from './update-organization-request-dto-rest';
 export * from './update-organization-response-class';
+export * from './update-report-schedule-request-dto';
+export * from './update-report-schedule-response-class';
+export * from './update-user-group-request-dto';
+export * from './update-user-group-response-class';
 export * from './user-class';
+export * from './user-group-class';
+export * from './user-group-member-class';

package/models/list-report-schedule-logs-response-class.ts

@@ -0,0 +1,49 @@
+/* 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 { ReportScheduleLogClass } from './report-schedule-log-class';
+
+/**
+ * 
+ * @export
+ * @interface ListReportScheduleLogsResponseClass
+ */
+export interface ListReportScheduleLogsResponseClass {
+    /**
+     * The list of report-schedule-logs.
+     * @type {Array<ReportScheduleLogClass>}
+     * @memberof ListReportScheduleLogsResponseClass
+     */
+    'items': Array<ReportScheduleLogClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListReportScheduleLogsResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Page size used for this result set
+     * @type {number}
+     * @memberof ListReportScheduleLogsResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * Total matching items for this query
+     * @type {number}
+     * @memberof ListReportScheduleLogsResponseClass
+     */
+    'totalItems': number;
+}
+

package/models/list-report-schedules-response-class.ts

@@ -0,0 +1,49 @@
+/* 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 { ReportScheduleClass } from './report-schedule-class';
+
+/**
+ * 
+ * @export
+ * @interface ListReportSchedulesResponseClass
+ */
+export interface ListReportSchedulesResponseClass {
+    /**
+     * The list of report-schedules.
+     * @type {Array<ReportScheduleClass>}
+     * @memberof ListReportSchedulesResponseClass
+     */
+    'items': Array<ReportScheduleClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListReportSchedulesResponseClass
+     */
+    'nextPageToken': string;
+    /**
+     * Page size used for this result set
+     * @type {number}
+     * @memberof ListReportSchedulesResponseClass
+     */
+    'itemsPerPage': number;
+    /**
+     * Total matching items for this query
+     * @type {number}
+     * @memberof ListReportSchedulesResponseClass
+     */
+    'totalItems': number;
+}
+