@meeco/svx-api-sdk 1.0.0-develop.20230810153330.3fa2721

package/lib/types/apis/MetricsApi.d.ts

@@ -0,0 +1,64 @@
+/**
+ * SVX API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.12.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 * as runtime from '../runtime';
+import type { VaultItemReportResponse, VaultUserAttachmentsReportResponse, VaultUserConnectionsReportResponse } from '../models';
+export interface MetricsAttachmentsGetRequest {
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface MetricsConnectionsGetRequest {
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface MetricsItemsGetRequest {
+    templateIds?: string;
+    classificationSchemeName?: string;
+    classificationNodeName?: string;
+    classificationNodeNames?: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+/**
+ *
+ */
+export declare class MetricsApi extends runtime.BaseAPI {
+    /**
+     * Obtain the report on the size of attachments created by the current user, and the size of attachments linked to slots owned by the user as well as slots shared with the user.   The unit is bytes.  One and the same attachment or a folder can be linked to multiple slots. One such case is share duplicate slots. With this report it is possible to count only unique attachments and folders, as well as count references to the same attachment/folder as if they were separate files. See model <code>UserAttachmentsReport</code> for details.  The report takes into account the following: * attachments * all files in folders  The report currently *does not* take into account the following:  * encryption artifact files of attachments * thumbnails of attachments * images attached to slots
+     * Obtain the report on the size of attachments and slots
+     */
+    metricsAttachmentsGetRaw(requestParameters: MetricsAttachmentsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultUserAttachmentsReportResponse>>;
+    /**
+     * Obtain the report on the size of attachments created by the current user, and the size of attachments linked to slots owned by the user as well as slots shared with the user.   The unit is bytes.  One and the same attachment or a folder can be linked to multiple slots. One such case is share duplicate slots. With this report it is possible to count only unique attachments and folders, as well as count references to the same attachment/folder as if they were separate files. See model <code>UserAttachmentsReport</code> for details.  The report takes into account the following: * attachments * all files in folders  The report currently *does not* take into account the following:  * encryption artifact files of attachments * thumbnails of attachments * images attached to slots
+     * Obtain the report on the size of attachments and slots
+     */
+    metricsAttachmentsGet(meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultUserAttachmentsReportResponse>;
+    /**
+     * Obtain connection report for the currently authenticated user.
+     * Obtain connection report
+     */
+    metricsConnectionsGetRaw(requestParameters: MetricsConnectionsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultUserConnectionsReportResponse>>;
+    /**
+     * Obtain connection report for the currently authenticated user.
+     * Obtain connection report
+     */
+    metricsConnectionsGet(meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultUserConnectionsReportResponse>;
+    /**
+     * Obtain a report on currently authenticated user\'s items and slots
+     * Obtain a report on user\'s items and slots
+     */
+    metricsItemsGetRaw(requestParameters: MetricsItemsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultItemReportResponse>>;
+    /**
+     * Obtain a report on currently authenticated user\'s items and slots
+     * Obtain a report on user\'s items and slots
+     */
+    metricsItemsGet(templateIds?: string, classificationSchemeName?: string, classificationNodeName?: string, classificationNodeNames?: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultItemReportResponse>;
+}

package/lib/types/apis/OrganisationsApi.d.ts

@@ -0,0 +1,354 @@
+/**
+ * SVX API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.12.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 * as runtime from '../runtime';
+import type { ATOMAdmin, ATOMAssignSecurityRightsRequest, ATOMCreateOrUpdateOrgRequest, ATOMOneOrg, ATOMOrgList, ATOMPaginatedAdminList, ATOMPaginatedOrgList, ATOMSecurityRights, ApplicationsGet200Response, ApplicationsIdGet200Response, ApplicationsIdPutRequest, ApplicationsPost201Response, ApplicationsPostRequest } from '../models';
+export interface ApplicationsGetRequest {
+    meecoOrganisationId: string;
+}
+export interface ApplicationsIdDeleteRequest {
+    id: string;
+    meecoOrganisationId: string;
+}
+export interface ApplicationsIdGetRequest {
+    id: string;
+    meecoOrganisationId: string;
+}
+export interface ApplicationsIdPutOperationRequest {
+    id: string;
+    meecoOrganisationId: string;
+    applicationsIdPutRequest?: ApplicationsIdPutRequest;
+}
+export interface ApplicationsPostOperationRequest {
+    meecoOrganisationId: string;
+    applicationsPostRequest?: ApplicationsPostRequest;
+}
+export interface OrgsIdArchivePostRequest {
+    id: string;
+}
+export interface OrgsIdDeleteRequest {
+    id: string;
+}
+export interface OrgsIdGetRequest {
+    id: string;
+}
+export interface OrgsIdPutRequest {
+    id: string;
+    aTOMCreateOrUpdateOrgRequest: ATOMCreateOrUpdateOrgRequest;
+}
+export interface OrgsIdRestorePostRequest {
+    id: string;
+}
+export interface OrgsOrgIdAdminsGetRequest {
+    orgId: string;
+    status?: OrgsOrgIdAdminsGetStatusEnum;
+    perPage?: number;
+    page?: number;
+    order?: OrgsOrgIdAdminsGetOrderEnum;
+    nextPageAfter?: string;
+}
+export interface OrgsOrgIdAdminsIdArchivePostRequest {
+    orgId: string;
+    id: string;
+}
+export interface OrgsOrgIdAdminsIdDeleteRequest {
+    orgId: string;
+    id: string;
+}
+export interface OrgsOrgIdAdminsIdGetRequest {
+    orgId: string;
+    id: string;
+}
+export interface OrgsOrgIdAdminsIdRestorePostRequest {
+    orgId: string;
+    id: string;
+}
+export interface OrgsOrgIdAdminsOrgAdminIdSecurityRightsGetRequest {
+    orgId: string;
+    orgAdminId: string;
+}
+export interface OrgsOrgIdAdminsOrgAdminIdSecurityRightsPostRequest {
+    orgId: string;
+    orgAdminId: string;
+    aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest;
+}
+export interface OrgsOrgIdSecurityRightsPostRequest {
+    orgId: string;
+    aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest;
+}
+export interface OrgsOrgIdSecurityRightsSecurityRightsDeleteRequest {
+    orgId: string;
+    securityRights: string;
+}
+export interface TenantsTenantIdOrgsGetRequest {
+    tenantId: string;
+    status?: TenantsTenantIdOrgsGetStatusEnum;
+    perPage?: number;
+    order?: TenantsTenantIdOrgsGetOrderEnum;
+    page?: number;
+    nextPageAfter?: string;
+}
+export interface TenantsTenantIdOrgsPostRequest {
+    tenantId: string;
+    aTOMCreateOrUpdateOrgRequest: ATOMCreateOrUpdateOrgRequest;
+}
+export interface VisibleOrgsGetRequest {
+    tenantId?: string;
+}
+/**
+ *
+ */
+export declare class OrganisationsApi extends runtime.BaseAPI {
+    /**
+     * Load all application agents
+     */
+    applicationsGetRaw(requestParameters: ApplicationsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationsGet200Response>>;
+    /**
+     * Load all application agents
+     */
+    applicationsGet(meecoOrganisationId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationsGet200Response>;
+    /**
+     * Delete application agent
+     */
+    applicationsIdDeleteRaw(requestParameters: ApplicationsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete application agent
+     */
+    applicationsIdDelete(id: string, meecoOrganisationId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get application agent information
+     */
+    applicationsIdGetRaw(requestParameters: ApplicationsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationsIdGet200Response>>;
+    /**
+     * Get application agent information
+     */
+    applicationsIdGet(id: string, meecoOrganisationId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationsIdGet200Response>;
+    /**
+     * Update application agent
+     */
+    applicationsIdPutRaw(requestParameters: ApplicationsIdPutOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationsPost201Response>>;
+    /**
+     * Update application agent
+     */
+    applicationsIdPut(id: string, meecoOrganisationId: string, applicationsIdPutRequest?: ApplicationsIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationsPost201Response>;
+    /**
+     * Create application agent
+     */
+    applicationsPostRaw(requestParameters: ApplicationsPostOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ApplicationsPost201Response>>;
+    /**
+     * Create application agent
+     */
+    applicationsPost(meecoOrganisationId: string, applicationsPostRequest?: ApplicationsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationsPost201Response>;
+    /**
+     *   Archive an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
+     * Archive an organisation
+     */
+    orgsIdArchivePostRaw(requestParameters: OrgsIdArchivePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
+    /**
+     *   Archive an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
+     * Archive an organisation
+     */
+    orgsIdArchivePost(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
+    /**
+     *   Delete an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
+     * Delete an organisation
+     */
+    orgsIdDeleteRaw(requestParameters: OrgsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Delete an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
+     * Delete an organisation
+     */
+    orgsIdDelete(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Show an organisation.    In order to execute this action the current user must have    * global security `atom:global:view_all_orgs` or   * security right `atom:tenant:view_tenant_orgs` for the tenant   * security right `atom:org:view_org` for the org with the ID in parameter `org_id`
+     * View an organisation
+     */
+    orgsIdGetRaw(requestParameters: OrgsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
+    /**
+     *   Show an organisation.    In order to execute this action the current user must have    * global security `atom:global:view_all_orgs` or   * security right `atom:tenant:view_tenant_orgs` for the tenant   * security right `atom:org:view_org` for the org with the ID in parameter `org_id`
+     * View an organisation
+     */
+    orgsIdGet(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
+    /**
+     *   Update an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.
+     * Update an organisation
+     */
+    orgsIdPutRaw(requestParameters: OrgsIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
+    /**
+     *   Update an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.
+     * Update an organisation
+     */
+    orgsIdPut(id: string, aTOMCreateOrUpdateOrgRequest: ATOMCreateOrUpdateOrgRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
+    /**
+     *   Restore an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
+     * Restore an organisation
+     */
+    orgsIdRestorePostRaw(requestParameters: OrgsIdRestorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
+    /**
+     *   Restore an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
+     * Restore an organisation
+     */
+    orgsIdRestorePost(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
+    /**
+     *   List admins of an organisation.    It is also possible to request a list of archived admins of the organisation, that is, users who used to have organisation security rights for the given organisation, but do not have them now.    In order to execute this action the current user must have     * security right `atom:org:list_org_admins` for the organisation with the ID in parameter `org_id` or    * security right `atom:tenant:list_admins_of_all_orgs_of_tenant` for the parent tenant of the organisation `org_id` or    * global security right `atom:global:list_admins_of_all_orgs
+     * List admins of an organisation
+     */
+    orgsOrgIdAdminsGetRaw(requestParameters: OrgsOrgIdAdminsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMPaginatedAdminList>>;
+    /**
+     *   List admins of an organisation.    It is also possible to request a list of archived admins of the organisation, that is, users who used to have organisation security rights for the given organisation, but do not have them now.    In order to execute this action the current user must have     * security right `atom:org:list_org_admins` for the organisation with the ID in parameter `org_id` or    * security right `atom:tenant:list_admins_of_all_orgs_of_tenant` for the parent tenant of the organisation `org_id` or    * global security right `atom:global:list_admins_of_all_orgs
+     * List admins of an organisation
+     */
+    orgsOrgIdAdminsGet(orgId: string, status?: OrgsOrgIdAdminsGetStatusEnum, perPage?: number, page?: number, order?: OrgsOrgIdAdminsGetOrderEnum, nextPageAfter?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMPaginatedAdminList>;
+    /**
+     * Remove a user from admins of the given organisation, and put the admin into the registry of former admins of that organisation.  In order to execute this action the current user must one of the following security rights:  * `atom:org:add_org_admin` * `atom:global:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:org:assign_org_sr_to_user`
+     * Archive an organisation admin
+     */
+    orgsOrgIdAdminsIdArchivePostRaw(requestParameters: OrgsOrgIdAdminsIdArchivePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove a user from admins of the given organisation, and put the admin into the registry of former admins of that organisation.  In order to execute this action the current user must one of the following security rights:  * `atom:org:add_org_admin` * `atom:global:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:org:assign_org_sr_to_user`
+     * Archive an organisation admin
+     */
+    orgsOrgIdAdminsIdArchivePost(orgId: string, id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Remove a user from organisation admins.  In order to execute this action the current user must one of the following security rights:  * `atom:org:add_org_admin` * `atom:global:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:org:assign_org_sr_to_user`
+     * Remove a user from organisation admins
+     */
+    orgsOrgIdAdminsIdDeleteRaw(requestParameters: OrgsOrgIdAdminsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove a user from organisation admins.  In order to execute this action the current user must one of the following security rights:  * `atom:org:add_org_admin` * `atom:global:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:org:assign_org_sr_to_user`
+     * Remove a user from organisation admins
+     */
+    orgsOrgIdAdminsIdDelete(orgId: string, id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Show an admin of a given organisation.    In order to execute this action the current user must have     * security right `atom:org:list_org_admins` for the organisation with the ID in parameter `org_id` or    * security right `atom:tenant:list_admins_of_all_orgs_of_tenant` for the parent tenant of the organisation `org_id` or    * global security right `atom:global:list_admins_of_all_orgs
+     * Show an admin of a given organisation
+     */
+    orgsOrgIdAdminsIdGetRaw(requestParameters: OrgsOrgIdAdminsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMAdmin>>;
+    /**
+     *   Show an admin of a given organisation.    In order to execute this action the current user must have     * security right `atom:org:list_org_admins` for the organisation with the ID in parameter `org_id` or    * security right `atom:tenant:list_admins_of_all_orgs_of_tenant` for the parent tenant of the organisation `org_id` or    * global security right `atom:global:list_admins_of_all_orgs
+     * Show an admin of a given organisation
+     */
+    orgsOrgIdAdminsIdGet(orgId: string, id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMAdmin>;
+    /**
+     * Reinstate an archived user and make him/her a org admin again.  In order to execute this action the current user must one of the following security rights:  * `atom:org:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:global:assign_org_sr_to_user`
+     * Restore an archived organisation admin
+     */
+    orgsOrgIdAdminsIdRestorePostRaw(requestParameters: OrgsOrgIdAdminsIdRestorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMAdmin>>;
+    /**
+     * Reinstate an archived user and make him/her a org admin again.  In order to execute this action the current user must one of the following security rights:  * `atom:org:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:global:assign_org_sr_to_user`
+     * Restore an archived organisation admin
+     */
+    orgsOrgIdAdminsIdRestorePost(orgId: string, id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMAdmin>;
+    /**
+     *   List organisation security rights of a organisation admin.    In order to execute this action the current user must have security right `atom:org:list_org_admin_sr` for the organisation with the ID in parameter `org_id` or `atom:tenant:list_org_admin_sr` for the tenant that the organisation belongs to, or global security right `atom:global:list_admin_sr_of_any_admin`\"
+     * List security rights of an organisation admin
+     */
+    orgsOrgIdAdminsOrgAdminIdSecurityRightsGetRaw(requestParameters: OrgsOrgIdAdminsOrgAdminIdSecurityRightsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMSecurityRights>>;
+    /**
+     *   List organisation security rights of a organisation admin.    In order to execute this action the current user must have security right `atom:org:list_org_admin_sr` for the organisation with the ID in parameter `org_id` or `atom:tenant:list_org_admin_sr` for the tenant that the organisation belongs to, or global security right `atom:global:list_admin_sr_of_any_admin`\"
+     * List security rights of an organisation admin
+     */
+    orgsOrgIdAdminsOrgAdminIdSecurityRightsGet(orgId: string, orgAdminId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMSecurityRights>;
+    /**
+     *   Assign organisation security rights to an organisation admin.    The endpoint can process security rights of 2 categories:    * `for_org = true` and `for_tenant = false`   * `for_org = true` and `for_tenant = true`, in this case the security right will be assigned to the tenant which organisation belongs to    In order to execute this action the current user must have one of the following security rights:    * security right `atom:org:assign_org_sr_to_user` for the organisation with the ID in parameter `org_id`   * security right `atom:tenant:assign_org_sr_to_user` for the tenant that the organisation belongs to   * global security right `atom:global:assign_org_sr_to_user`\"
+     * Assign organisation security rights to an organisation admin
+     */
+    orgsOrgIdAdminsOrgAdminIdSecurityRightsPostRaw(requestParameters: OrgsOrgIdAdminsOrgAdminIdSecurityRightsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Assign organisation security rights to an organisation admin.    The endpoint can process security rights of 2 categories:    * `for_org = true` and `for_tenant = false`   * `for_org = true` and `for_tenant = true`, in this case the security right will be assigned to the tenant which organisation belongs to    In order to execute this action the current user must have one of the following security rights:    * security right `atom:org:assign_org_sr_to_user` for the organisation with the ID in parameter `org_id`   * security right `atom:tenant:assign_org_sr_to_user` for the tenant that the organisation belongs to   * global security right `atom:global:assign_org_sr_to_user`\"
+     * Assign organisation security rights to an organisation admin
+     */
+    orgsOrgIdAdminsOrgAdminIdSecurityRightsPost(orgId: string, orgAdminId: string, aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Add security rights to an organisation.    In order to execute this action the current user must have security right `atom:tenant:assign_sr_to_org` for the tenant which the organisation belongs to.
+     * Add security rights to an organisation
+     */
+    orgsOrgIdSecurityRightsPostRaw(requestParameters: OrgsOrgIdSecurityRightsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
+    /**
+     *   Add security rights to an organisation.    In order to execute this action the current user must have security right `atom:tenant:assign_sr_to_org` for the tenant which the organisation belongs to.
+     * Add security rights to an organisation
+     */
+    orgsOrgIdSecurityRightsPost(orgId: string, aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
+    /**
+     *   Remove security rights from an organisation.    In order to execute this action the current user must have security right `atom:tenant:assign_sr_to_org` for the tenant which the organisation belongs to.
+     * Remove security rights from an organisation
+     */
+    orgsOrgIdSecurityRightsSecurityRightsDeleteRaw(requestParameters: OrgsOrgIdSecurityRightsSecurityRightsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Remove security rights from an organisation.    In order to execute this action the current user must have security right `atom:tenant:assign_sr_to_org` for the tenant which the organisation belongs to.
+     * Remove security rights from an organisation
+     */
+    orgsOrgIdSecurityRightsSecurityRightsDelete(orgId: string, securityRights: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   List organisations in a tenant.    In order to execute this action the current user must have global security `atom:global:view_all_orgs` or security right `atom:tenant:view_tenant_orgs` for the tenant with the ID in parameter `tenant_id`.
+     * List organisation in a tenant
+     */
+    tenantsTenantIdOrgsGetRaw(requestParameters: TenantsTenantIdOrgsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMPaginatedOrgList>>;
+    /**
+     *   List organisations in a tenant.    In order to execute this action the current user must have global security `atom:global:view_all_orgs` or security right `atom:tenant:view_tenant_orgs` for the tenant with the ID in parameter `tenant_id`.
+     * List organisation in a tenant
+     */
+    tenantsTenantIdOrgsGet(tenantId: string, status?: TenantsTenantIdOrgsGetStatusEnum, perPage?: number, order?: TenantsTenantIdOrgsGetOrderEnum, page?: number, nextPageAfter?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMPaginatedOrgList>;
+    /**
+     *   Create an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.
+     * Create an organisation
+     */
+    tenantsTenantIdOrgsPostRaw(requestParameters: TenantsTenantIdOrgsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
+    /**
+     *   Create an organisation.    In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.
+     * Create an organisation
+     */
+    tenantsTenantIdOrgsPost(tenantId: string, aTOMCreateOrUpdateOrgRequest: ATOMCreateOrUpdateOrgRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
+    /**
+     *   Show a list of organisations which the current user can see. These are the following organisations:    * If the current user has global security right `atom:global:view_all_tenants`, all organisations are shown   * Organisations of all tenants for which the current user has tenant security right `atom:tenant:view_tenant_orgs`   * Organisations for which current user is an admin and has security right `atom:org:view_org`    Can take optional parameter `tenant_id` which will restrict the list of organisations to one tenant only.
+     * Show a list of organisations which current user can see.
+     */
+    visibleOrgsGetRaw(requestParameters: VisibleOrgsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOrgList>>;
+    /**
+     *   Show a list of organisations which the current user can see. These are the following organisations:    * If the current user has global security right `atom:global:view_all_tenants`, all organisations are shown   * Organisations of all tenants for which the current user has tenant security right `atom:tenant:view_tenant_orgs`   * Organisations for which current user is an admin and has security right `atom:org:view_org`    Can take optional parameter `tenant_id` which will restrict the list of organisations to one tenant only.
+     * Show a list of organisations which current user can see.
+     */
+    visibleOrgsGet(tenantId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOrgList>;
+}
+/**
+ * @export
+ */
+export declare const OrgsOrgIdAdminsGetStatusEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+    readonly All: "all";
+};
+export type OrgsOrgIdAdminsGetStatusEnum = typeof OrgsOrgIdAdminsGetStatusEnum[keyof typeof OrgsOrgIdAdminsGetStatusEnum];
+/**
+ * @export
+ */
+export declare const OrgsOrgIdAdminsGetOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type OrgsOrgIdAdminsGetOrderEnum = typeof OrgsOrgIdAdminsGetOrderEnum[keyof typeof OrgsOrgIdAdminsGetOrderEnum];
+/**
+ * @export
+ */
+export declare const TenantsTenantIdOrgsGetStatusEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+    readonly All: "all";
+};
+export type TenantsTenantIdOrgsGetStatusEnum = typeof TenantsTenantIdOrgsGetStatusEnum[keyof typeof TenantsTenantIdOrgsGetStatusEnum];
+/**
+ * @export
+ */
+export declare const TenantsTenantIdOrgsGetOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type TenantsTenantIdOrgsGetOrderEnum = typeof TenantsTenantIdOrgsGetOrderEnum[keyof typeof TenantsTenantIdOrgsGetOrderEnum];

package/lib/types/apis/SecurityRightsApi.d.ts

@@ -0,0 +1,155 @@
+/**
+ * SVX API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.12.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 * as runtime from '../runtime';
+import type { ATOMAdmin, ATOMAssignSecurityRightsRequest, ATOMPaginatedAdminList, ATOMSecurityRightsOfUser, ATOMSecurityRightsRegistry } from '../models';
+export interface GlobalAdminsAdminIdSecurityRightsPostRequest {
+    adminId: string;
+    aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest;
+}
+export interface GlobalAdminsAdminIdSecurityRightsSecurityRightsDeleteRequest {
+    adminId: string;
+    securityRights: string;
+}
+export interface GlobalAdminsGetRequest {
+    status?: GlobalAdminsGetStatusEnum;
+    perPage?: number;
+    order?: GlobalAdminsGetOrderEnum;
+    page?: number;
+    nextPageAfter?: string;
+}
+export interface GlobalAdminsIdArchivePostRequest {
+    id: string;
+}
+export interface GlobalAdminsIdDeleteRequest {
+    id: string;
+}
+export interface GlobalAdminsIdGetRequest {
+    id: string;
+}
+export interface GlobalAdminsIdRestorePostRequest {
+    id: string;
+}
+export interface SecurityRightsRegistryGetRequest {
+    withInactive?: boolean;
+}
+/**
+ *
+ */
+export declare class SecurityRightsApi extends runtime.BaseAPI {
+    /**
+     *   Assign global security rights to a user.    The user we are assigning security rights to does not need to be known by ATOM.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Assign global security rights to a user
+     */
+    globalAdminsAdminIdSecurityRightsPostRaw(requestParameters: GlobalAdminsAdminIdSecurityRightsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Assign global security rights to a user.    The user we are assigning security rights to does not need to be known by ATOM.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Assign global security rights to a user
+     */
+    globalAdminsAdminIdSecurityRightsPost(adminId: string, aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Remove global security rights from a user.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Remove global security rights from a user
+     */
+    globalAdminsAdminIdSecurityRightsSecurityRightsDeleteRaw(requestParameters: GlobalAdminsAdminIdSecurityRightsSecurityRightsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Remove global security rights from a user.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Remove global security rights from a user
+     */
+    globalAdminsAdminIdSecurityRightsSecurityRightsDelete(adminId: string, securityRights: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   List all users with global security rights.    It is also possible to request a list of archived global admins, that is, users who used to have global security rights, but do not have them now.    In order to execute this action the current user must have \"security right `atom:global:assign_global_sr_to_user`.
+     * List all users with global security rights
+     */
+    globalAdminsGetRaw(requestParameters: GlobalAdminsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMPaginatedAdminList>>;
+    /**
+     *   List all users with global security rights.    It is also possible to request a list of archived global admins, that is, users who used to have global security rights, but do not have them now.    In order to execute this action the current user must have \"security right `atom:global:assign_global_sr_to_user`.
+     * List all users with global security rights
+     */
+    globalAdminsGet(status?: GlobalAdminsGetStatusEnum, perPage?: number, order?: GlobalAdminsGetOrderEnum, page?: number, nextPageAfter?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMPaginatedAdminList>;
+    /**
+     *   Remove a user from global admins, and put the admin into the registry of former global admins.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Archive a global admin
+     */
+    globalAdminsIdArchivePostRaw(requestParameters: GlobalAdminsIdArchivePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Remove a user from global admins, and put the admin into the registry of former global admins.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Archive a global admin
+     */
+    globalAdminsIdArchivePost(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Remove a user from global admins, that is, remove all global security rights from a user.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Remove a user from global admins
+     */
+    globalAdminsIdDeleteRaw(requestParameters: GlobalAdminsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Remove a user from global admins, that is, remove all global security rights from a user.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Remove a user from global admins
+     */
+    globalAdminsIdDelete(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Show a user with global security rights    In order to execute this action the current user must have \"security right `atom:global:assign_global_sr_to_user`.
+     * Show a user with global security rights
+     */
+    globalAdminsIdGetRaw(requestParameters: GlobalAdminsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMAdmin>>;
+    /**
+     *   Show a user with global security rights    In order to execute this action the current user must have \"security right `atom:global:assign_global_sr_to_user`.
+     * Show a user with global security rights
+     */
+    globalAdminsIdGet(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMAdmin>;
+    /**
+     *   Reinstate an archived user and make him/her a global admin again.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Restore an archived global admin
+     */
+    globalAdminsIdRestorePostRaw(requestParameters: GlobalAdminsIdRestorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMAdmin>>;
+    /**
+     *   Reinstate an archived user and make him/her a global admin again.    In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
+     * Restore an archived global admin
+     */
+    globalAdminsIdRestorePost(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMAdmin>;
+    /**
+     * Show all security rights of the current user for all active tenants and organizations
+     * All security rights of the current user
+     */
+    securityRightsGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMSecurityRightsOfUser>>;
+    /**
+     * Show all security rights of the current user for all active tenants and organizations
+     * All security rights of the current user
+     */
+    securityRightsGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMSecurityRightsOfUser>;
+    /**
+     * Show all security rights known to ATOM
+     * Show all security rights known to ATOM
+     */
+    securityRightsRegistryGetRaw(requestParameters: SecurityRightsRegistryGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMSecurityRightsRegistry>>;
+    /**
+     * Show all security rights known to ATOM
+     * Show all security rights known to ATOM
+     */
+    securityRightsRegistryGet(withInactive?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMSecurityRightsRegistry>;
+}
+/**
+ * @export
+ */
+export declare const GlobalAdminsGetStatusEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+    readonly All: "all";
+};
+export type GlobalAdminsGetStatusEnum = typeof GlobalAdminsGetStatusEnum[keyof typeof GlobalAdminsGetStatusEnum];
+/**
+ * @export
+ */
+export declare const GlobalAdminsGetOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type GlobalAdminsGetOrderEnum = typeof GlobalAdminsGetOrderEnum[keyof typeof GlobalAdminsGetOrderEnum];