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

package/lib/types/models/VaultShare.d.ts

@@ -0,0 +1,145 @@
+/**
+ * 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.
+ */
+/**
+ * A share of data between users.
+ *
+ * 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.
+ *
+ * A 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.
+ *
+ *
+ * A share can expire according to the date in field `expires_at`.
+ *
+ * Some shares require that the recipient accepts the terms of the share. Until the terms are not accepted the share DEK is hidden.
+ *
+ *
+ * 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.
+ *
+ * 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.
+ * @export
+ * @interface VaultShare
+ */
+export interface VaultShare {
+    /**
+     *
+     * @type {string}
+     * @memberof VaultShare
+     */
+    id: string;
+    /**
+     * ID of the owner of the shared data. In case of an on-share, if the recipient of the share is not connected to the owner of the share, `owner_id` is `NULL`
+     * @type {string}
+     * @memberof VaultShare
+     */
+    owner_id: string | null;
+    /**
+     * ID of the sender of the share
+     * @type {string}
+     * @memberof VaultShare
+     */
+    sender_id: string;
+    /**
+     * ID of the recipient of the share
+     * @type {string}
+     * @memberof VaultShare
+     */
+    recipient_id: string;
+    /**
+     * Can be one of the four values:
+     *  * `acceptance_not_required`
+     *  * `acceptance_required`
+     *  * `accepted`
+     *  * `rejected`
+     *
+     * If `acceptance_required` equals `acceptance_required` then the share DEK is hidden from the recipient until he/she accepts the terms
+     * @type {string}
+     * @memberof VaultShare
+     */
+    acceptance_required: VaultShareAcceptanceRequiredEnum;
+    /**
+     * This is the ID of the original shared item which belongs to the owner of the share and the item.It can never be read directly via this ID by share recipients. Each share recipients gets a duplicate record of this item with the same data encrypted for the recipient.
+     * @type {string}
+     * @memberof VaultShare
+     */
+    item_id: string;
+    /**
+     * ID of the shared slot. Present if only one slot is shared. `NULL` if all slots of the item are shared
+     * @type {string}
+     * @memberof VaultShare
+     */
+    slot_id: string | null;
+    /**
+     * Public key of the recipient copied from the connection record between the recipient and the sender
+     * @type {string}
+     * @memberof VaultShare
+     */
+    public_key: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VaultShare
+     */
+    onsharing_permitted: boolean;
+    /**
+     * Identification of the keypair to which the public key belongs
+     * @type {string}
+     * @memberof VaultShare
+     */
+    keypair_external_id: string | null;
+    /**
+     * Data encryption key for the shared data. The key is encrypted by the public key of the recipient
+     * @type {string}
+     * @memberof VaultShare
+     */
+    encrypted_dek: string | null;
+    /**
+     * Terms of the share
+     * @type {string}
+     * @memberof VaultShare
+     */
+    terms: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof VaultShare
+     */
+    created_at: Date | null;
+    /**
+     * Expiration date of the share
+     * @type {Date}
+     * @memberof VaultShare
+     */
+    expires_at: Date | null;
+}
+/**
+ * @export
+ */
+export declare const VaultShareAcceptanceRequiredEnum: {
+    readonly AcceptanceNotRequired: "acceptance_not_required";
+    readonly AcceptanceRequired: "acceptance_required";
+    readonly Accepted: "accepted";
+    readonly Rejected: "rejected";
+};
+export type VaultShareAcceptanceRequiredEnum = typeof VaultShareAcceptanceRequiredEnum[keyof typeof VaultShareAcceptanceRequiredEnum];
+/**
+ * Check if a given object implements the VaultShare interface.
+ */
+export declare function instanceOfVaultShare(value: object): boolean;
+export declare function VaultShareFromJSON(json: any): VaultShare;
+export declare function VaultShareFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultShare;
+export declare function VaultShareToJSON(value?: VaultShare | null): any;

package/lib/types/models/VaultShareIntent.d.ts

@@ -0,0 +1,116 @@
+/**
+ * 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 type { VaultEncryptedSlotValue } from './VaultEncryptedSlotValue';
+/**
+ *
+ * @export
+ * @interface VaultShareIntent
+ */
+export interface VaultShareIntent {
+    /**
+     *
+     * @type {string}
+     * @memberof VaultShareIntent
+     */
+    id: string;
+    /**
+     * This is the ID of the original shared item which belongs to the owner of the share and the item.It can never be read directly via this ID by share recipients. Each share recipients gets a duplicate record of this item with the same data encrypted for the recipient.
+     * @type {string}
+     * @memberof VaultShareIntent
+     */
+    item_id: string;
+    /**
+     * shows whether the item to be shared has been deleted since the share intent was created
+     * @type {boolean}
+     * @memberof VaultShareIntent
+     */
+    item_still_exists: boolean;
+    /**
+     * ID of the shared slot. Present if only one slot is to be shared. `NULL` if all slots of the item are shared
+     * @type {string}
+     * @memberof VaultShareIntent
+     */
+    slot_id: string | null;
+    /**
+     *
+     * @type {Array<VaultEncryptedSlotValue>}
+     * @memberof VaultShareIntent
+     */
+    slot_values: Array<VaultEncryptedSlotValue>;
+    /**
+     * shows whether the slot to be shared has been deleted since the share intent was created
+     * @type {boolean}
+     * @memberof VaultShareIntent
+     */
+    slot_still_exists: boolean;
+    /**
+     * Share DEK encrypted using Cryppo encryption with derived key
+     * @type {string}
+     * @memberof VaultShareIntent
+     */
+    encrypted_dek: string;
+    /**
+     * Expiration date of the share to be created
+     * @type {Date}
+     * @memberof VaultShareIntent
+     */
+    expires_at: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VaultShareIntent
+     */
+    onsharing_permitted: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof VaultShareIntent
+     */
+    created_at: Date;
+    /**
+     * ID the linked invitation
+     * @type {string}
+     * @memberof VaultShareIntent
+     */
+    invitation_id: string;
+    /**
+     * Sharing terms
+     * @type {string}
+     * @memberof VaultShareIntent
+     */
+    terms: string | null;
+    /**
+     * Can be one of the two values:
+     *  * `acceptance_not_required`
+     *  * `acceptance_required`
+     * @type {string}
+     * @memberof VaultShareIntent
+     */
+    acceptance_required: VaultShareIntentAcceptanceRequiredEnum;
+}
+/**
+ * @export
+ */
+export declare const VaultShareIntentAcceptanceRequiredEnum: {
+    readonly AcceptanceNotRequired: "acceptance_not_required";
+    readonly AcceptanceRequired: "acceptance_required";
+    readonly Accepted: "accepted";
+    readonly Rejected: "rejected";
+};
+export type VaultShareIntentAcceptanceRequiredEnum = typeof VaultShareIntentAcceptanceRequiredEnum[keyof typeof VaultShareIntentAcceptanceRequiredEnum];
+/**
+ * Check if a given object implements the VaultShareIntent interface.
+ */
+export declare function instanceOfVaultShareIntent(value: object): boolean;
+export declare function VaultShareIntentFromJSON(json: any): VaultShareIntent;
+export declare function VaultShareIntentFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultShareIntent;
+export declare function VaultShareIntentToJSON(value?: VaultShareIntent | null): any;

package/lib/types/models/VaultShareWithItemData.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 type { VaultAttachment } from './VaultAttachment';
+import type { VaultClassificationNode } from './VaultClassificationNode';
+import type { VaultItem } from './VaultItem';
+import type { VaultShare } from './VaultShare';
+import type { VaultSlot } from './VaultSlot';
+import type { VaultThumbnail } from './VaultThumbnail';
+/**
+ *
+ * @export
+ * @interface VaultShareWithItemData
+ */
+export interface VaultShareWithItemData {
+    /**
+     *
+     * @type {VaultShare}
+     * @memberof VaultShareWithItemData
+     */
+    share: VaultShare;
+    /**
+     * If this field is `NULL` it means that the rendered item has been created via the currently displayed share. If `item_shared_via_another_share_id` is not `NULL`, it means that the rendered item has been created via a different share, and the ID if the share is in `item_shared_via_another_share_id`. The client is advised to re-run the call with this ID.
+     * @type {string}
+     * @memberof VaultShareWithItemData
+     */
+    item_shared_via_another_share_id?: string | null;
+    /**
+     *
+     * @type {Array<VaultAttachment>}
+     * @memberof VaultShareWithItemData
+     */
+    attachments: Array<VaultAttachment>;
+    /**
+     *
+     * @type {Array<VaultClassificationNode>}
+     * @memberof VaultShareWithItemData
+     */
+    classification_nodes: Array<VaultClassificationNode>;
+    /**
+     *
+     * @type {VaultItem}
+     * @memberof VaultShareWithItemData
+     */
+    item: VaultItem;
+    /**
+     *
+     * @type {Array<VaultSlot>}
+     * @memberof VaultShareWithItemData
+     */
+    slots: Array<VaultSlot>;
+    /**
+     *
+     * @type {Array<VaultThumbnail>}
+     * @memberof VaultShareWithItemData
+     */
+    thumbnails: Array<VaultThumbnail>;
+}
+/**
+ * Check if a given object implements the VaultShareWithItemData interface.
+ */
+export declare function instanceOfVaultShareWithItemData(value: object): boolean;
+export declare function VaultShareWithItemDataFromJSON(json: any): VaultShareWithItemData;
+export declare function VaultShareWithItemDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultShareWithItemData;
+export declare function VaultShareWithItemDataToJSON(value?: VaultShareWithItemData | null): any;

package/lib/types/models/VaultSharesCreateResponse.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 type { VaultShare } from './VaultShare';
+/**
+ *
+ * @export
+ * @interface VaultSharesCreateResponse
+ */
+export interface VaultSharesCreateResponse {
+    /**
+     *
+     * @type {Array<VaultShare>}
+     * @memberof VaultSharesCreateResponse
+     */
+    shares: Array<VaultShare>;
+}
+/**
+ * Check if a given object implements the VaultSharesCreateResponse interface.
+ */
+export declare function instanceOfVaultSharesCreateResponse(value: object): boolean;
+export declare function VaultSharesCreateResponseFromJSON(json: any): VaultSharesCreateResponse;
+export declare function VaultSharesCreateResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultSharesCreateResponse;
+export declare function VaultSharesCreateResponseToJSON(value?: VaultSharesCreateResponse | null): any;

package/lib/types/models/VaultSlot.d.ts

@@ -0,0 +1,177 @@
+/**
+ * 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.
+ */
+/**
+ * Slot instances provide a dynamic way to add arbitrary attributes to Item instances.
+ *             This ability to add attributes dynamically to Item instances enables extensibility within the information model.
+ *             A Slot is composed of a name, a label, a SlotType and a value. The value is an object whose type is determined by the SlotType.
+ * @export
+ * @interface VaultSlot
+ */
+export interface VaultSlot {
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    id: string;
+    /**
+     * true if the slot belongs to the current user, false if this slot is shared with the current user
+     * @type {boolean}
+     * @memberof VaultSlot
+     */
+    own: boolean;
+    /**
+     * If the slot is shared with the current user, `share_id` points to the share record
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    share_id: string | null;
+    /**
+     * Machine-readable string.
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    description: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof VaultSlot
+     */
+    ordinal: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VaultSlot
+     */
+    visible: boolean;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof VaultSlot
+     */
+    classification_node_ids: Array<string>;
+    /**
+     * `attachment_id` is an ID of an attachment record if the slot has an attachment. This ID can be used to retrieve the attachment. When a slot is shared, `attachment_id` changes, too. In other words, two attachments having different `attachment_id`'s can point to the same file. Also see `attachment_uid`.
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    attachment_id: string | null;
+    /**
+     * `attachments_folder_id` is an ID of an object describing collective properties of a remote host directory.
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    attachments_folder_id?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    item_id: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VaultSlot
+     */
+    required: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof VaultSlot
+     */
+    updated_at: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof VaultSlot
+     */
+    created_at: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    slot_type_name: VaultSlotSlotTypeNameEnum;
+    /**
+     * creator of record, can be user or system
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    creator: string | null;
+    /**
+     * If field `own` is `true`, this value is encrypted with the default DEK of the user (`private_dek_external_id`). If field `own` is `false`, this is a shared slot, `share_id` points to the corresponding share,and the value is encrypted with the encryption space referenced from the share object
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    encrypted_value: string | null;
+    /**
+     * value verification key encrypted with the share DEK.  Used to ensure on-share integrity.
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    encrypted_value_verification_key: string | null;
+    /**
+     * the result of the HMAC function run on the slot value using `encrypted_value_verification_key`. Used to ensure on-share integrity.
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    value_verification_hash: string | null;
+    /**
+     * String for display.
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    label: string;
+    /**
+     * ID of the original slot if the current slot is a shared slot
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    original_id: string | null;
+    /**
+     * The owner of the slot. Can be different from `user_id` if the slot is shared. In case of an on-share, if the recipient of the share is not connected to the owner of the share, `owner_id` is `NULL`
+     * @type {string}
+     * @memberof VaultSlot
+     */
+    owner_id: string | null;
+}
+/**
+ * @export
+ */
+export declare const VaultSlotSlotTypeNameEnum: {
+    readonly KeyValue: "key_value";
+    readonly Bool: "bool";
+    readonly Date: "date";
+    readonly Datetime: "datetime";
+    readonly Image: "image";
+    readonly Url: "url";
+    readonly PhoneNumber: "phone_number";
+    readonly Email: "email";
+    readonly Password: "password";
+    readonly Attachment: "attachment";
+    readonly AttachmentsFolder: "attachments_folder";
+    readonly ClassificationNode: "classification_node";
+};
+export type VaultSlotSlotTypeNameEnum = typeof VaultSlotSlotTypeNameEnum[keyof typeof VaultSlotSlotTypeNameEnum];
+/**
+ * Check if a given object implements the VaultSlot interface.
+ */
+export declare function instanceOfVaultSlot(value: object): boolean;
+export declare function VaultSlotFromJSON(json: any): VaultSlot;
+export declare function VaultSlotFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultSlot;
+export declare function VaultSlotToJSON(value?: VaultSlot | null): any;

package/lib/types/models/VaultSlotAttributesInItemCreation.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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 type { VaultClassificationNodeAttributes } from './VaultClassificationNodeAttributes';
+/**
+ *
+ * @export
+ * @interface VaultSlotAttributesInItemCreation
+ */
+export interface VaultSlotAttributesInItemCreation {
+    /**
+     * Machine-readable string.
+     * @type {string}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    description?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    ordinal?: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    visible?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    template_slot_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    attachments_folder_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    attachment_id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    slot_type_name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    encrypted_value?: string | null;
+    /**
+     * String for display
+     * @type {string}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    label?: string;
+    /**
+     *
+     * @type {Array<VaultClassificationNodeAttributes>}
+     * @memberof VaultSlotAttributesInItemCreation
+     */
+    classification_nodes_attributes?: Array<VaultClassificationNodeAttributes>;
+}
+/**
+ * Check if a given object implements the VaultSlotAttributesInItemCreation interface.
+ */
+export declare function instanceOfVaultSlotAttributesInItemCreation(value: object): boolean;
+export declare function VaultSlotAttributesInItemCreationFromJSON(json: any): VaultSlotAttributesInItemCreation;
+export declare function VaultSlotAttributesInItemCreationFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultSlotAttributesInItemCreation;
+export declare function VaultSlotAttributesInItemCreationToJSON(value?: VaultSlotAttributesInItemCreation | null): any;

package/lib/types/models/VaultSlotResponse.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 type { VaultSlot } from './VaultSlot';
+/**
+ *
+ * @export
+ * @interface VaultSlotResponse
+ */
+export interface VaultSlotResponse {
+    /**
+     *
+     * @type {VaultSlot}
+     * @memberof VaultSlotResponse
+     */
+    slot: VaultSlot;
+}
+/**
+ * Check if a given object implements the VaultSlotResponse interface.
+ */
+export declare function instanceOfVaultSlotResponse(value: object): boolean;
+export declare function VaultSlotResponseFromJSON(json: any): VaultSlotResponse;
+export declare function VaultSlotResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultSlotResponse;
+export declare function VaultSlotResponseToJSON(value?: VaultSlotResponse | null): any;