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

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

@@ -0,0 +1,285 @@
+/**
+ * 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 { CreateDeleteReconfigureSharesRequest, CreateDeleteReconfigureSharesServiceResponse, GetItemSharesResponse, ItemSharesUpdateResponse, ListOfReconfigureShareParams, PostItemEncryptRequest, PostItemSharesRequest, PutItemSharesRequest, ReconfigureSharesResponse, ShareIntentRequest, ShareIntentResponse, ShareIntentsResponse, SharesIncomingResponse, SharesOutgoingResponse, ShreIntentListResponse, VaultGetShareResponse, VaultItemResponse, VaultShareWithItemData, VaultSharesCreateResponse } from '../models';
+export interface IncomingSharesGetRequest {
+    nextPageAfter?: string;
+    perPage?: number;
+    order?: string;
+    ownConnectionId?: string;
+    acceptanceRequired?: string;
+    shareIds?: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface IncomingSharesIdAcceptPutRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface IncomingSharesIdGetRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface IncomingSharesIdItemGetRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface InvitationsInvitationIdShareIntentsPostRequest {
+    invitationId: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+    shareIntentRequest?: ShareIntentRequest;
+}
+export interface ItemsIdEncryptPostRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+    postItemEncryptRequest?: PostItemEncryptRequest;
+}
+export interface ItemsIdSharesGetRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface ItemsIdSharesPostRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+    postItemSharesRequest?: PostItemSharesRequest;
+}
+export interface ItemsIdSharesPutRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+    putItemSharesRequest?: PutItemSharesRequest;
+}
+export interface OutgoingSharesGetRequest {
+    nextPageAfter?: string;
+    perPage?: number;
+    order?: string;
+    ownConnectionId?: string;
+    itemIds?: Array<string>;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface OutgoingSharesIdGetRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface ShareIntentsGetRequest {
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface ShareIntentsIdDeleteRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface ShareIntentsIdGetRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface SharesIdDeleteRequest {
+    id: string;
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+}
+export interface SharesPatchRequest {
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+    createDeleteReconfigureSharesRequest?: CreateDeleteReconfigureSharesRequest;
+}
+export interface SharesPutRequest {
+    meecoDelegationId?: string;
+    meecoOrganisationId?: string;
+    listOfReconfigureShareParams?: ListOfReconfigureShareParams;
+}
+/**
+ *
+ */
+export declare class SharesApi extends runtime.BaseAPI {
+    /**
+     * Read incoming shares as the recipient.  Only share records are fetched. Shared items and slots appear in the main feed of users\'s items.   Some shares require that the recipient accepts the terms of the share. This behavior is controled by field `acceptance_required`. By default all incoming shares are fetched, but you can also specify parameter `acceptance_required=acceptance_required` in order to only read shares which require acceptance.  Other possible states are:  * `acceptance_not_required` * `accepted` * `rejected`   The `encrypted_dek` for a share slot may be null for the following reasons:  1. If the state is `acceptance_required` the `encrypted_dek` is intentionally hidden until accepted 2. If the slot has been re-encrypted via `POST /items/{id}/encrypt`, a null `encrypted_dek` means the slot is encrypted with the current user\'s DEK instead
+     * Read incoming shares
+     */
+    incomingSharesGetRaw(requestParameters: IncomingSharesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SharesIncomingResponse>>;
+    /**
+     * Read incoming shares as the recipient.  Only share records are fetched. Shared items and slots appear in the main feed of users\'s items.   Some shares require that the recipient accepts the terms of the share. This behavior is controled by field `acceptance_required`. By default all incoming shares are fetched, but you can also specify parameter `acceptance_required=acceptance_required` in order to only read shares which require acceptance.  Other possible states are:  * `acceptance_not_required` * `accepted` * `rejected`   The `encrypted_dek` for a share slot may be null for the following reasons:  1. If the state is `acceptance_required` the `encrypted_dek` is intentionally hidden until accepted 2. If the slot has been re-encrypted via `POST /items/{id}/encrypt`, a null `encrypted_dek` means the slot is encrypted with the current user\'s DEK instead
+     * Read incoming shares
+     */
+    incomingSharesGet(nextPageAfter?: string, perPage?: number, order?: string, ownConnectionId?: string, acceptanceRequired?: string, shareIds?: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SharesIncomingResponse>;
+    /**
+     * Accept share terms.  Some shares require that the recipient accepts the terms of the share. Until the terms are not accepted the share DEK is hidden.   Via this endpoint a recipient can accept terms of a share.
+     * Accept share terms
+     */
+    incomingSharesIdAcceptPutRaw(requestParameters: IncomingSharesIdAcceptPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultGetShareResponse>>;
+    /**
+     * Accept share terms.  Some shares require that the recipient accepts the terms of the share. Until the terms are not accepted the share DEK is hidden.   Via this endpoint a recipient can accept terms of a share.
+     * Accept share terms
+     */
+    incomingSharesIdAcceptPut(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultGetShareResponse>;
+    /**
+     * Read an incoming share as the recipient.  Only a share record is fetched. The item and slots created for the current user (receiver) according to this share are not served. To retrieve the share with the item and slot records created for the share recipient use `GET /incoming_shares/{id}/item`.
+     * Read an incoming share
+     */
+    incomingSharesIdGetRaw(requestParameters: IncomingSharesIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultGetShareResponse>>;
+    /**
+     * Read an incoming share as the recipient.  Only a share record is fetched. The item and slots created for the current user (receiver) according to this share are not served. To retrieve the share with the item and slot records created for the share recipient use `GET /incoming_shares/{id}/item`.
+     * Read an incoming share
+     */
+    incomingSharesIdGet(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultGetShareResponse>;
+    /**
+     * Read an incoming share together with shared item, slots, and other associated data.  One and the same item can be shared to a recipient via different shares.   This endpoint renders the shared item in both cases, whether the item has been shared via the current share or via a different share of the same item.   In case the shared item has been shared via the current share then field `item_shared_via_another_share_id` is `NULL`.  If the item has been shared via a different share field `item_shared_via_another_share_id` contains the ID of that share and the client is advised to re-run the call with this ID.
+     * Read an incoming share together with the shared item and slots
+     */
+    incomingSharesIdItemGetRaw(requestParameters: IncomingSharesIdItemGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultShareWithItemData>>;
+    /**
+     * Read an incoming share together with shared item, slots, and other associated data.  One and the same item can be shared to a recipient via different shares.   This endpoint renders the shared item in both cases, whether the item has been shared via the current share or via a different share of the same item.   In case the shared item has been shared via the current share then field `item_shared_via_another_share_id` is `NULL`.  If the item has been shared via a different share field `item_shared_via_another_share_id` contains the ID of that share and the client is advised to re-run the call with this ID.
+     * Read an incoming share together with the shared item and slots
+     */
+    incomingSharesIdItemGet(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultShareWithItemData>;
+    /**
+     * Creating share intent is part of the Single Step Connection and Sharing flow.  The Single Step Connection and Sharing flow allows to create a connection to a user and share an item in one go. The main steps of the Single Step Connection and Sharing flow are as follows: 1. The share sender creates a regular invitation with `POST /invitations` 2. The share sender creates a share intent linking it to the invitation 3. The share recipient accepts the invitation via `POST /connections`, just like any regular invitation 4. The vault creates a connection between the sender and the recipient, and creates a share  In addition to `invitation_id` the share intent contains all the data needed to create the share once the invitation is accepted:  1. `encrypted_dek` - Data encryption key for the shared data. The key is encrypted with the token PDK (see below for more details).  2. `item_id` - ID of the item that will be shared. Identical to `item_id` in `POST /items/{id}/shares` 3. `slot_id` - ID of the slot that will be shared. Present if only one slot will be shared. `NULL` if all slots of the item are to be shared. Identical to `slot_id` in `POST /items/{id}/shares` 4. `slot_values` - Encrypted slot data in the same format used in `POST /items/{id}/shares`. The data is encrypted with the share DEK. 5. `onsharing_permitted` - Sharing mode of the share.  Identical to `onsharing_permitted` in `POST /items/{id}/shares` 6. `expires_at` - Expiration date of the share.   Slot data in a regular share is initially encrypted with a dedicated share DEK.  This share DEK is encrypted with the public key of the share recipient, taken from the connection record between the two users.  In case of a share intent there is no connection yet, and no recipient public key is available yet, so there is a different workflow.  There is still a dedicated share DEK, and it is stored right in the share intent record in the encrypted form.  How exactly it is encrypted depends on which invitation workflow, simple invitation workflow or multistep invitation workflow.  In the simple invitation flow the sender generates a short passphrase, derives a DEK from this short passphrase, and uses this derived DEK to encrypt the share DEK. In the multistep invitation flow the key exchange looks as follows:  1. The sender generates a share DEK 2. The sender encrypts share data with that DEK 3. The sender encrypts the share DEK with their private DEK. At this stage no one but the sender can decrypt this share DEK 4. After the recipient accepts the invitation, the sender confirms the invitation. At this stage the connection record is created abd both public keys are available.  When confirming the invitation, the sender decrypts the share DEK with their private DEK, re-encrypts it with the public key of the recipient, and shares created from these share intents contain this version of the DEK encrypted with the public key of the recipient.
+     * Create one or more share intents
+     */
+    invitationsInvitationIdShareIntentsPostRaw(requestParameters: InvitationsInvitationIdShareIntentsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShareIntentsResponse>>;
+    /**
+     * Creating share intent is part of the Single Step Connection and Sharing flow.  The Single Step Connection and Sharing flow allows to create a connection to a user and share an item in one go. The main steps of the Single Step Connection and Sharing flow are as follows: 1. The share sender creates a regular invitation with `POST /invitations` 2. The share sender creates a share intent linking it to the invitation 3. The share recipient accepts the invitation via `POST /connections`, just like any regular invitation 4. The vault creates a connection between the sender and the recipient, and creates a share  In addition to `invitation_id` the share intent contains all the data needed to create the share once the invitation is accepted:  1. `encrypted_dek` - Data encryption key for the shared data. The key is encrypted with the token PDK (see below for more details).  2. `item_id` - ID of the item that will be shared. Identical to `item_id` in `POST /items/{id}/shares` 3. `slot_id` - ID of the slot that will be shared. Present if only one slot will be shared. `NULL` if all slots of the item are to be shared. Identical to `slot_id` in `POST /items/{id}/shares` 4. `slot_values` - Encrypted slot data in the same format used in `POST /items/{id}/shares`. The data is encrypted with the share DEK. 5. `onsharing_permitted` - Sharing mode of the share.  Identical to `onsharing_permitted` in `POST /items/{id}/shares` 6. `expires_at` - Expiration date of the share.   Slot data in a regular share is initially encrypted with a dedicated share DEK.  This share DEK is encrypted with the public key of the share recipient, taken from the connection record between the two users.  In case of a share intent there is no connection yet, and no recipient public key is available yet, so there is a different workflow.  There is still a dedicated share DEK, and it is stored right in the share intent record in the encrypted form.  How exactly it is encrypted depends on which invitation workflow, simple invitation workflow or multistep invitation workflow.  In the simple invitation flow the sender generates a short passphrase, derives a DEK from this short passphrase, and uses this derived DEK to encrypt the share DEK. In the multistep invitation flow the key exchange looks as follows:  1. The sender generates a share DEK 2. The sender encrypts share data with that DEK 3. The sender encrypts the share DEK with their private DEK. At this stage no one but the sender can decrypt this share DEK 4. After the recipient accepts the invitation, the sender confirms the invitation. At this stage the connection record is created abd both public keys are available.  When confirming the invitation, the sender decrypts the share DEK with their private DEK, re-encrypts it with the public key of the recipient, and shares created from these share intents contain this version of the DEK encrypted with the public key of the recipient.
+     * Create one or more share intents
+     */
+    invitationsInvitationIdShareIntentsPost(invitationId: string, meecoDelegationId?: string, meecoOrganisationId?: string, shareIntentRequest?: ShareIntentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShareIntentsResponse>;
+    /**
+     * Re-encrypt share data  Data in shared slots is initially encrypted with the share DEK. The share DEK is encrypted with the public key of the share recipient. When processing a share the client application is expected to decrypt the slot data as well as `encrypted_value_verification_key` and re-encrypt with them private DEK with this endpoint.
+     * Re-encrypt share data
+     */
+    itemsIdEncryptPostRaw(requestParameters: ItemsIdEncryptPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultItemResponse>>;
+    /**
+     * Re-encrypt share data  Data in shared slots is initially encrypted with the share DEK. The share DEK is encrypted with the public key of the share recipient. When processing a share the client application is expected to decrypt the slot data as well as `encrypted_value_verification_key` and re-encrypt with them private DEK with this endpoint.
+     * Re-encrypt share data
+     */
+    itemsIdEncryptPost(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, postItemEncryptRequest?: PostItemEncryptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultItemResponse>;
+    /**
+     * Updating all shares of one item is done by the item owner in one go.   A share DEK is encrypted with a public key of the recipient. In order to update shares the owner needs a public key of the recipient of each share. But some shares may be created by users different from the owner, and thus the owner might have no connection to recipients of those shares, and no access to those shares.  This problem is solved by * Putting a public key of the recipient and an identification of the keypair to which the public key belongs into each share record. * Providing a list of all public keys and share IDs for all shares of the given item via this endpoint   Getting this list is the first step in updating all shares of the item.
+     * Prepare an update of all shares of one item
+     */
+    itemsIdSharesGetRaw(requestParameters: ItemsIdSharesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetItemSharesResponse>>;
+    /**
+     * Updating all shares of one item is done by the item owner in one go.   A share DEK is encrypted with a public key of the recipient. In order to update shares the owner needs a public key of the recipient of each share. But some shares may be created by users different from the owner, and thus the owner might have no connection to recipients of those shares, and no access to those shares.  This problem is solved by * Putting a public key of the recipient and an identification of the keypair to which the public key belongs into each share record. * Providing a list of all public keys and share IDs for all shares of the given item via this endpoint   Getting this list is the first step in updating all shares of the item.
+     * Prepare an update of all shares of one item
+     */
+    itemsIdSharesGet(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetItemSharesResponse>;
+    /**
+     * Share your item with connected users.  Each share can be a share of all slots of the item, in that case `slot_id` is `NULL`, or it can be a share of just one slot. In this case `slot_id` references one of the slots of the item.  There are 3 users involved in each share:  * owner - the owner of the shared item * sender -  the user who shares data. Can be the owner or one of the recipients * recipient - the user who recieves the shared data.   Whether a non-owner may on-share a shared slot is defined in field `onsharing_permitted`.  Only the owner of the item can set `onsharing_permitted` to `true`. If `onsharing_permitted` is `false`, the recipient may on-share the item, but when that recipient creates an on-share, `onsharing_permitted` in that on-share is forced to be `false`. In other words, the depth of on-sharing in limited to 3:       OWNER ==> RECIPIENT AND SENDER ==>  RECIPIENT    Some shares require that the recipient accepts the terms of the share. Until the terms are not accepted the share DEK is hidden.   Data in slots is initially encrypted with the DEK in field `encrypted_dek`. The DEK in `encrypted_dek` is encrypted with the public key of the share recipient. When processing a share the client application is expected to decrypt the slot data and re-encrypt with the private DEK.  A public key of the recipient is needed to encrypt the share DEK. Updating all shares of the same item is performed by the owner in one go. In a situation when a share has been created by a recipient, not the owner, and there is no connection between the owner and the recipient, the owner has no access to a public key of the recipient. In order to address this problem when a share is created we also add fields `public_key` and `keypair_external_id` from the connection record between the recipient and the sender. `keypair_external_id` identifies the keypair that the public key belongs to.  When a recipient of a share on-shares the data with someone else, nothing prevents him/her to encrypt some other data instead of the original data. We need a way to enforce integrity of on-shares. We do this with help of HMAC - hash-based message authentication code obtained by running a cryptographic hash function over the data and a shared secret key.    Two fields in each slot are used for this purpose: * `encrypted_value_verification_key` - is a value verification key encrypted in the same way as the value itself: with the share DEK * `value_verification_hash` - the result of the HMAC function run on the slot value using `encrypted_value_verification_key`. `value_verification_hash` is stored as-is, unencrypted.   Only the owner of the data may send `encrypted_value_verification_key` when creating or updating the share. When other senders create a share, `encrypted_value_verification_key` must be `NULL`.  `value_verification_hash` may and should be sent by every sender, owner or not, because `value_verification_hash` must be re-encrypted with the share DEK for each share.  If the sender replaces `encrypted_value_verification_key` and/or the slot value, this will break the client-side verification against `encrypted_value_verification_key`. Field `encrypted_value` may be `NULL`. If `encrypted_value` is `NULL`, then `encrypted_value_verification_key` and `value_verification_hash` may also be `NULL`. If `encrypted_value` is present, then `encrypted_value_verification_key` and `value_verification_hash` are mandatory.
+     * Share your item with connected users
+     */
+    itemsIdSharesPostRaw(requestParameters: ItemsIdSharesPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultSharesCreateResponse>>;
+    /**
+     * Share your item with connected users.  Each share can be a share of all slots of the item, in that case `slot_id` is `NULL`, or it can be a share of just one slot. In this case `slot_id` references one of the slots of the item.  There are 3 users involved in each share:  * owner - the owner of the shared item * sender -  the user who shares data. Can be the owner or one of the recipients * recipient - the user who recieves the shared data.   Whether a non-owner may on-share a shared slot is defined in field `onsharing_permitted`.  Only the owner of the item can set `onsharing_permitted` to `true`. If `onsharing_permitted` is `false`, the recipient may on-share the item, but when that recipient creates an on-share, `onsharing_permitted` in that on-share is forced to be `false`. In other words, the depth of on-sharing in limited to 3:       OWNER ==> RECIPIENT AND SENDER ==>  RECIPIENT    Some shares require that the recipient accepts the terms of the share. Until the terms are not accepted the share DEK is hidden.   Data in slots is initially encrypted with the DEK in field `encrypted_dek`. The DEK in `encrypted_dek` is encrypted with the public key of the share recipient. When processing a share the client application is expected to decrypt the slot data and re-encrypt with the private DEK.  A public key of the recipient is needed to encrypt the share DEK. Updating all shares of the same item is performed by the owner in one go. In a situation when a share has been created by a recipient, not the owner, and there is no connection between the owner and the recipient, the owner has no access to a public key of the recipient. In order to address this problem when a share is created we also add fields `public_key` and `keypair_external_id` from the connection record between the recipient and the sender. `keypair_external_id` identifies the keypair that the public key belongs to.  When a recipient of a share on-shares the data with someone else, nothing prevents him/her to encrypt some other data instead of the original data. We need a way to enforce integrity of on-shares. We do this with help of HMAC - hash-based message authentication code obtained by running a cryptographic hash function over the data and a shared secret key.    Two fields in each slot are used for this purpose: * `encrypted_value_verification_key` - is a value verification key encrypted in the same way as the value itself: with the share DEK * `value_verification_hash` - the result of the HMAC function run on the slot value using `encrypted_value_verification_key`. `value_verification_hash` is stored as-is, unencrypted.   Only the owner of the data may send `encrypted_value_verification_key` when creating or updating the share. When other senders create a share, `encrypted_value_verification_key` must be `NULL`.  `value_verification_hash` may and should be sent by every sender, owner or not, because `value_verification_hash` must be re-encrypted with the share DEK for each share.  If the sender replaces `encrypted_value_verification_key` and/or the slot value, this will break the client-side verification against `encrypted_value_verification_key`. Field `encrypted_value` may be `NULL`. If `encrypted_value` is `NULL`, then `encrypted_value_verification_key` and `value_verification_hash` may also be `NULL`. If `encrypted_value` is present, then `encrypted_value_verification_key` and `value_verification_hash` are mandatory.
+     * Share your item with connected users
+     */
+    itemsIdSharesPost(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, postItemSharesRequest?: PostItemSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultSharesCreateResponse>;
+    /**
+     * Updating all shares of one item is done by the item owner in one go.  Before calling this endpoint the client application is expected to retrieve the list of shares IDs and public keys via `GET /items/{id}/shares`.  The POST body of this endpoint contains  * a list of share DEKs encrypted with public keys of share recipients * a list of slot values for each slot and each share, each encrypted with the DEK of the share that the slot belongs to  * Optionally: a list of completed `ClientTask` tasks  When a recipient of a share on-shares the data with someone else, nothing prevents him/her to encrypt some other data instead of the original data. We need a way to enforce integrity of on-shares. We do this with help of HMAC - hash-based message authentication code obtained by running a cryptographic hash function over the data and a shared secret key.    Two fields in each slot are used for this purpose: * `encrypted_value_verification_key` - is a value verification key encrypted in the same way as the value itself: with the share DEK * `value_verification_hash` - the result of the HMAC function run on the slot value using `encrypted_value_verification_key`. `value_verification_hash` is stored as-is, unencrypted.   Only the owner of the data may send `encrypted_value_verification_key` when creating or updating the share. When other senders create a share, `encrypted_value_verification_key` must be `NULL`.  `value_verification_hash` may and should be sent by every sender, owner or not, because `value_verification_hash` must be re-encrypted with the share DEK for each share.  If the sender replaces `encrypted_value_verification_key` and/or the slot value, this will break the client-side verification against `encrypted_value_verification_key`.  Field `encrypted_value` may be `NULL`. If `encrypted_value` is `NULL`, then `encrypted_value_verification_key` and `value_verification_hash` may also be `NULL`. If `encrypted_value` is present, then `encrypted_value_verification_key` and `value_verification_hash` are mandatory.
+     * Update all shares of one item
+     */
+    itemsIdSharesPutRaw(requestParameters: ItemsIdSharesPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemSharesUpdateResponse>>;
+    /**
+     * Updating all shares of one item is done by the item owner in one go.  Before calling this endpoint the client application is expected to retrieve the list of shares IDs and public keys via `GET /items/{id}/shares`.  The POST body of this endpoint contains  * a list of share DEKs encrypted with public keys of share recipients * a list of slot values for each slot and each share, each encrypted with the DEK of the share that the slot belongs to  * Optionally: a list of completed `ClientTask` tasks  When a recipient of a share on-shares the data with someone else, nothing prevents him/her to encrypt some other data instead of the original data. We need a way to enforce integrity of on-shares. We do this with help of HMAC - hash-based message authentication code obtained by running a cryptographic hash function over the data and a shared secret key.    Two fields in each slot are used for this purpose: * `encrypted_value_verification_key` - is a value verification key encrypted in the same way as the value itself: with the share DEK * `value_verification_hash` - the result of the HMAC function run on the slot value using `encrypted_value_verification_key`. `value_verification_hash` is stored as-is, unencrypted.   Only the owner of the data may send `encrypted_value_verification_key` when creating or updating the share. When other senders create a share, `encrypted_value_verification_key` must be `NULL`.  `value_verification_hash` may and should be sent by every sender, owner or not, because `value_verification_hash` must be re-encrypted with the share DEK for each share.  If the sender replaces `encrypted_value_verification_key` and/or the slot value, this will break the client-side verification against `encrypted_value_verification_key`.  Field `encrypted_value` may be `NULL`. If `encrypted_value` is `NULL`, then `encrypted_value_verification_key` and `value_verification_hash` may also be `NULL`. If `encrypted_value` is present, then `encrypted_value_verification_key` and `value_verification_hash` are mandatory.
+     * Update all shares of one item
+     */
+    itemsIdSharesPut(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, putItemSharesRequest?: PutItemSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemSharesUpdateResponse>;
+    /**
+     * Read outgoing shares. That is, all shares the current user has created, including on-shares.  Only share records are fetched.
+     * Read outgoing shares
+     */
+    outgoingSharesGetRaw(requestParameters: OutgoingSharesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SharesOutgoingResponse>>;
+    /**
+     * Read outgoing shares. That is, all shares the current user has created, including on-shares.  Only share records are fetched.
+     * Read outgoing shares
+     */
+    outgoingSharesGet(nextPageAfter?: string, perPage?: number, order?: string, ownConnectionId?: string, itemIds?: Array<string>, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SharesOutgoingResponse>;
+    /**
+     * Read an outgoing share as the sender.  Only a share record is fetched.
+     * Read an outgoing share
+     */
+    outgoingSharesIdGetRaw(requestParameters: OutgoingSharesIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultGetShareResponse>>;
+    /**
+     * Read an outgoing share as the sender.  Only a share record is fetched.
+     * Read an outgoing share
+     */
+    outgoingSharesIdGet(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultGetShareResponse>;
+    /**
+     * share intents the user has created
+     * View share intents the user has created
+     */
+    shareIntentsGetRaw(requestParameters: ShareIntentsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShreIntentListResponse>>;
+    /**
+     * share intents the user has created
+     * View share intents the user has created
+     */
+    shareIntentsGet(meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShreIntentListResponse>;
+    /**
+     * Delete a share intent
+     * Delete a share intent
+     */
+    shareIntentsIdDeleteRaw(requestParameters: ShareIntentsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a share intent
+     * Delete a share intent
+     */
+    shareIntentsIdDelete(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Read an share intent
+     * View a share intent
+     */
+    shareIntentsIdGetRaw(requestParameters: ShareIntentsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShareIntentResponse>>;
+    /**
+     * Read an share intent
+     * View a share intent
+     */
+    shareIntentsIdGet(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShareIntentResponse>;
+    /**
+     * Delete a share. Both the owner of the shared data and the recipient of the share may delete it.
+     * Delete a share
+     */
+    sharesIdDeleteRaw(requestParameters: SharesIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete a share. Both the owner of the shared data and the recipient of the share may delete it.
+     * Delete a share
+     */
+    sharesIdDelete(id: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * This endpoint allows to perform three operations in one go:  1. share your item with connected users. The ID of the item is in field `item_to_share_id`, and the share data is in `shares_to_create` 2. delete existing shares by submitting a list of share IDs in field `shares_to_delete` 3. change expiration and the on-sharing configuration of a list of shares (reconfiguring shares) by submitting a list of params in field `shares_to_reconfigure`  This endpoint is transactional, that is, if a 4xx response is returned and the error comes from one of these three actions (deletion of shares, reconfiguration of shares, creation of new share are), no other action will be executed. Each operation is optional. In order to skip creation of new shares set `item_to_share_id` to `NULL`.To read more about each operation please refer to the documentation of the following endpoints:  1. sharing your item with connected users: `POST /items/{id}/shares` 2. deletion of shares: `DELETE /shares/{id}` 3. reconfiguring shares: `PUT /shares`
+     * Create shares of an item, re-configure shares, delete shares
+     */
+    sharesPatchRaw(requestParameters: SharesPatchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateDeleteReconfigureSharesServiceResponse>>;
+    /**
+     * This endpoint allows to perform three operations in one go:  1. share your item with connected users. The ID of the item is in field `item_to_share_id`, and the share data is in `shares_to_create` 2. delete existing shares by submitting a list of share IDs in field `shares_to_delete` 3. change expiration and the on-sharing configuration of a list of shares (reconfiguring shares) by submitting a list of params in field `shares_to_reconfigure`  This endpoint is transactional, that is, if a 4xx response is returned and the error comes from one of these three actions (deletion of shares, reconfiguration of shares, creation of new share are), no other action will be executed. Each operation is optional. In order to skip creation of new shares set `item_to_share_id` to `NULL`.To read more about each operation please refer to the documentation of the following endpoints:  1. sharing your item with connected users: `POST /items/{id}/shares` 2. deletion of shares: `DELETE /shares/{id}` 3. reconfiguring shares: `PUT /shares`
+     * Create shares of an item, re-configure shares, delete shares
+     */
+    sharesPatch(meecoDelegationId?: string, meecoOrganisationId?: string, createDeleteReconfigureSharesRequest?: CreateDeleteReconfigureSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateDeleteReconfigureSharesServiceResponse>;
+    /**
+     * This endpoint permits changing settings of an existing share:  * `expires_at` * `onsharing_permitted`  `onsharing_permitted` can be changed by the owner of the shared item only. If it is `true`, the recipient may on-share the item, but when that recipient creates an on-share, `onsharing_permitted` in that on-share is forced to be `false`. In other words, the depth of on-sharing in limited to 3:       OWNER ==> RECIPIENT AND SENDER ==>  RECIPIENT   If the owner of the item changes `onsharing_permitted` from `true` to `false` and there are existing on-shares, those on-shares are deleted.    Changing share expiration may be done by any share sender, both the owner of the item and a recipient, but there are 2 rules:   * If the owner changes expiration to an ealier moment, expiration of all on-shares is also changed  * A recipient of a share may not change expiration of his/her on-share to a timestamp earlier than the expiration of the share that the recipient has received.
+     * Modify expiration and on-sharing of a share
+     */
+    sharesPutRaw(requestParameters: SharesPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReconfigureSharesResponse>>;
+    /**
+     * This endpoint permits changing settings of an existing share:  * `expires_at` * `onsharing_permitted`  `onsharing_permitted` can be changed by the owner of the shared item only. If it is `true`, the recipient may on-share the item, but when that recipient creates an on-share, `onsharing_permitted` in that on-share is forced to be `false`. In other words, the depth of on-sharing in limited to 3:       OWNER ==> RECIPIENT AND SENDER ==>  RECIPIENT   If the owner of the item changes `onsharing_permitted` from `true` to `false` and there are existing on-shares, those on-shares are deleted.    Changing share expiration may be done by any share sender, both the owner of the item and a recipient, but there are 2 rules:   * If the owner changes expiration to an ealier moment, expiration of all on-shares is also changed  * A recipient of a share may not change expiration of his/her on-share to a timestamp earlier than the expiration of the share that the recipient has received.
+     * Modify expiration and on-sharing of a share
+     */
+    sharesPut(meecoDelegationId?: string, meecoOrganisationId?: string, listOfReconfigureShareParams?: ListOfReconfigureShareParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReconfigureSharesResponse>;
+}

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

@@ -0,0 +1,265 @@
+/**
+ * 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, ATOMCreateOrUpdateTenantRequest, ATOMOneTenant, ATOMPaginatedAdminList, ATOMPaginatedTenantList } from '../models';
+export interface TenantsGetRequest {
+    status?: TenantsGetStatusEnum;
+    perPage?: number;
+    order?: TenantsGetOrderEnum;
+    page?: number;
+    nextPageAfter?: string;
+}
+export interface TenantsIdArchivePostRequest {
+    id: string;
+}
+export interface TenantsIdDeleteRequest {
+    id: string;
+}
+export interface TenantsIdGetRequest {
+    id: string;
+}
+export interface TenantsIdPutRequest {
+    id: string;
+    aTOMCreateOrUpdateTenantRequest: ATOMCreateOrUpdateTenantRequest;
+}
+export interface TenantsIdRestorePostRequest {
+    id: string;
+}
+export interface TenantsPostRequest {
+    aTOMCreateOrUpdateTenantRequest: ATOMCreateOrUpdateTenantRequest;
+}
+export interface TenantsTenantIdAdminsGetRequest {
+    tenantId: string;
+    status?: TenantsTenantIdAdminsGetStatusEnum;
+    perPage?: number;
+    order?: TenantsTenantIdAdminsGetOrderEnum;
+    page?: number;
+    nextPageAfter?: string;
+}
+export interface TenantsTenantIdAdminsIdArchivePostRequest {
+    tenantId: string;
+    id: string;
+}
+export interface TenantsTenantIdAdminsIdDeleteRequest {
+    tenantId: string;
+    id: string;
+}
+export interface TenantsTenantIdAdminsIdGetRequest {
+    tenantId: string;
+    id: string;
+}
+export interface TenantsTenantIdAdminsIdRestorePostRequest {
+    tenantId: string;
+    id: string;
+}
+export interface TenantsTenantIdAdminsTenantAdminIdSecurityRightsPostRequest {
+    tenantId: string;
+    tenantAdminId: string;
+    aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest;
+}
+export interface TenantsTenantIdSecurityRightsPostRequest {
+    tenantId: string;
+    aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest;
+}
+export interface TenantsTenantIdSecurityRightsSecurityRightsDeleteRequest {
+    tenantId: string;
+    securityRights: string;
+}
+/**
+ *
+ */
+export declare class TenantsApi extends runtime.BaseAPI {
+    /**
+     *   List all tenants.    In order to execute this action the current user must have security right `atom:global:view_all_tenants`.
+     * List all tenants
+     */
+    tenantsGetRaw(requestParameters: TenantsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMPaginatedTenantList>>;
+    /**
+     *   List all tenants.    In order to execute this action the current user must have security right `atom:global:view_all_tenants`.
+     * List all tenants
+     */
+    tenantsGet(status?: TenantsGetStatusEnum, perPage?: number, order?: TenantsGetOrderEnum, page?: number, nextPageAfter?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMPaginatedTenantList>;
+    /**
+     *   Archive a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.
+     * Archive a tenant
+     */
+    tenantsIdArchivePostRaw(requestParameters: TenantsIdArchivePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneTenant>>;
+    /**
+     *   Archive a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.
+     * Archive a tenant
+     */
+    tenantsIdArchivePost(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneTenant>;
+    /**
+     *   Delete a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.
+     * Delete a tenant
+     */
+    tenantsIdDeleteRaw(requestParameters: TenantsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Delete a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.
+     * Delete a tenant
+     */
+    tenantsIdDelete(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Show a tenant.    In order to execute this action the current user must have either global security right  `atom:global:view_all_tenants` or tenant security right `atom:tenant:view_tenant`.
+     * Show a tenant
+     */
+    tenantsIdGetRaw(requestParameters: TenantsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Show a tenant.    In order to execute this action the current user must have either global security right  `atom:global:view_all_tenants` or tenant security right `atom:tenant:view_tenant`.
+     * Show a tenant
+     */
+    tenantsIdGet(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Update a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.    It is possible to modify 3 fields:    * `name`   * `logo_url`   * `color`
+     * Update a tenant
+     */
+    tenantsIdPutRaw(requestParameters: TenantsIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneTenant>>;
+    /**
+     *   Update a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.    It is possible to modify 3 fields:    * `name`   * `logo_url`   * `color`
+     * Update a tenant
+     */
+    tenantsIdPut(id: string, aTOMCreateOrUpdateTenantRequest: ATOMCreateOrUpdateTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneTenant>;
+    /**
+     *   Restore a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.
+     * Restore a tenant
+     */
+    tenantsIdRestorePostRaw(requestParameters: TenantsIdRestorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneTenant>>;
+    /**
+     *   Restore a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.
+     * Restore a tenant
+     */
+    tenantsIdRestorePost(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneTenant>;
+    /**
+     *   Create a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.
+     * Create a tenant
+     */
+    tenantsPostRaw(requestParameters: TenantsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneTenant>>;
+    /**
+     *   Create a tenant.    In order to execute this action the current user must have security right `atom:global:create_tenant`.
+     * Create a tenant
+     */
+    tenantsPost(aTOMCreateOrUpdateTenantRequest: ATOMCreateOrUpdateTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneTenant>;
+    /**
+     *   List admins of a tenant.    In order to execute this action the current user must have    In order to execute this action the current user must have security right `atom:tenant:list_tenant_admins` for the tenant with the ID in parameter `tenant_id` or global security right `atom:global:add_tenant_admin`
+     * List admins of a tenant
+     */
+    tenantsTenantIdAdminsGetRaw(requestParameters: TenantsTenantIdAdminsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMPaginatedAdminList>>;
+    /**
+     *   List admins of a tenant.    In order to execute this action the current user must have    In order to execute this action the current user must have security right `atom:tenant:list_tenant_admins` for the tenant with the ID in parameter `tenant_id` or global security right `atom:global:add_tenant_admin`
+     * List admins of a tenant
+     */
+    tenantsTenantIdAdminsGet(tenantId: string, status?: TenantsTenantIdAdminsGetStatusEnum, perPage?: number, order?: TenantsTenantIdAdminsGetOrderEnum, page?: number, nextPageAfter?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMPaginatedAdminList>;
+    /**
+     *   Remove a user from admins of the given tenant, and put the admin into the registry of former admins of that tenant.    In order to execute this action the current user must have one of the following security rights:    * `atom:tenant:add_tenant_admin`   * `atom:global:add_tenant_admin`   * `atom:global:assign_tenant_sr_to_tenant_admin`   * `atom:tenant:assign_tenant_sr_to_tenant_admin`
+     * Archive a tenant admin
+     */
+    tenantsTenantIdAdminsIdArchivePostRaw(requestParameters: TenantsTenantIdAdminsIdArchivePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Remove a user from admins of the given tenant, and put the admin into the registry of former admins of that tenant.    In order to execute this action the current user must have one of the following security rights:    * `atom:tenant:add_tenant_admin`   * `atom:global:add_tenant_admin`   * `atom:global:assign_tenant_sr_to_tenant_admin`   * `atom:tenant:assign_tenant_sr_to_tenant_admin`
+     * Archive a tenant admin
+     */
+    tenantsTenantIdAdminsIdArchivePost(tenantId: string, id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Remove tenant admin privileges from a tenant admin.    In order to execute this action the current user must have one of the following security rights:    * `atom:tenant:add_tenant_admin`   * `atom:global:add_tenant_admin`   * `atom:global:assign_tenant_sr_to_tenant_admin`   * `atom:tenant:assign_tenant_sr_to_tenant_admin`
+     * Remove a user from tenant admins
+     */
+    tenantsTenantIdAdminsIdDeleteRaw(requestParameters: TenantsTenantIdAdminsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Remove tenant admin privileges from a tenant admin.    In order to execute this action the current user must have one of the following security rights:    * `atom:tenant:add_tenant_admin`   * `atom:global:add_tenant_admin`   * `atom:global:assign_tenant_sr_to_tenant_admin`   * `atom:tenant:assign_tenant_sr_to_tenant_admin`
+     * Remove a user from tenant admins
+     */
+    tenantsTenantIdAdminsIdDelete(tenantId: string, id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Show an admin of a given tenant    In order to execute this action the current user must have security right `atom:tenant:list_tenant_admins` for the tenant with the ID in parameter `tenant_id` or global security right `atom:global:add_tenant_admin`
+     * Show an admin of a given tenant
+     */
+    tenantsTenantIdAdminsIdGetRaw(requestParameters: TenantsTenantIdAdminsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMAdmin>>;
+    /**
+     *   Show an admin of a given tenant    In order to execute this action the current user must have security right `atom:tenant:list_tenant_admins` for the tenant with the ID in parameter `tenant_id` or global security right `atom:global:add_tenant_admin`
+     * Show an admin of a given tenant
+     */
+    tenantsTenantIdAdminsIdGet(tenantId: string, id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMAdmin>;
+    /**
+     *   Reinstate an archived user and make him/her a tenant admin again.    In order to execute this action the current user must have one of the following security rights:    * `atom:tenant:assign_tenant_sr_to_tenant_admin`   * `atom:global:assign_tenant_sr_to_tenant_admin`
+     * Restore an archived tenant admin
+     */
+    tenantsTenantIdAdminsIdRestorePostRaw(requestParameters: TenantsTenantIdAdminsIdRestorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMAdmin>>;
+    /**
+     *   Reinstate an archived user and make him/her a tenant admin again.    In order to execute this action the current user must have one of the following security rights:    * `atom:tenant:assign_tenant_sr_to_tenant_admin`   * `atom:global:assign_tenant_sr_to_tenant_admin`
+     * Restore an archived tenant admin
+     */
+    tenantsTenantIdAdminsIdRestorePost(tenantId: string, id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMAdmin>;
+    /**
+     *   Assign tenant 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:tenant:assign_tenant_sr_to_tenant_admin` for the tenant with the ID in parameter `tenant_id`.
+     * Assign tenant security rights to a tenant admin
+     */
+    tenantsTenantIdAdminsTenantAdminIdSecurityRightsPostRaw(requestParameters: TenantsTenantIdAdminsTenantAdminIdSecurityRightsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Assign tenant 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:tenant:assign_tenant_sr_to_tenant_admin` for the tenant with the ID in parameter `tenant_id`.
+     * Assign tenant security rights to a tenant admin
+     */
+    tenantsTenantIdAdminsTenantAdminIdSecurityRightsPost(tenantId: string, tenantAdminId: string, aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *   Add security rights to a tenant.    In order to execute this action the current user must have security right `atom:global:assign_sr_to_tenant`.
+     * Add security rights to a tenant
+     */
+    tenantsTenantIdSecurityRightsPostRaw(requestParameters: TenantsTenantIdSecurityRightsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneTenant>>;
+    /**
+     *   Add security rights to a tenant.    In order to execute this action the current user must have security right `atom:global:assign_sr_to_tenant`.
+     * Add security rights to a tenant
+     */
+    tenantsTenantIdSecurityRightsPost(tenantId: string, aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneTenant>;
+    /**
+     *   Remove security rights from a tenant.    In order to execute this action the current user must have security right `atom:global:assign_sr_to_tenant`.
+     * Remove security rights from a tenant
+     */
+    tenantsTenantIdSecurityRightsSecurityRightsDeleteRaw(requestParameters: TenantsTenantIdSecurityRightsSecurityRightsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     *   Remove security rights from a tenant.    In order to execute this action the current user must have security right `atom:global:assign_sr_to_tenant`.
+     * Remove security rights from a tenant
+     */
+    tenantsTenantIdSecurityRightsSecurityRightsDelete(tenantId: string, securityRights: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const TenantsGetStatusEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+    readonly All: "all";
+};
+export type TenantsGetStatusEnum = typeof TenantsGetStatusEnum[keyof typeof TenantsGetStatusEnum];
+/**
+ * @export
+ */
+export declare const TenantsGetOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type TenantsGetOrderEnum = typeof TenantsGetOrderEnum[keyof typeof TenantsGetOrderEnum];
+/**
+ * @export
+ */
+export declare const TenantsTenantIdAdminsGetStatusEnum: {
+    readonly Active: "active";
+    readonly Archived: "archived";
+    readonly All: "all";
+};
+export type TenantsTenantIdAdminsGetStatusEnum = typeof TenantsTenantIdAdminsGetStatusEnum[keyof typeof TenantsTenantIdAdminsGetStatusEnum];
+/**
+ * @export
+ */
+export declare const TenantsTenantIdAdminsGetOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type TenantsTenantIdAdminsGetOrderEnum = typeof TenantsTenantIdAdminsGetOrderEnum[keyof typeof TenantsTenantIdAdminsGetOrderEnum];