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

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

@@ -0,0 +1,43 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface VaultGlobalSharesReport
+ */
+export interface VaultGlobalSharesReport {
+    /**
+     * the sum of all shares
+     * @type {number}
+     * @memberof VaultGlobalSharesReport
+     */
+    all_shares: number;
+    /**
+     * the number of users who shared their data
+     * @type {number}
+     * @memberof VaultGlobalSharesReport
+     */
+    share_senders: number;
+    /**
+     * the number of user who have received shares
+     * @type {number}
+     * @memberof VaultGlobalSharesReport
+     */
+    share_recipients: number;
+}
+/**
+ * Check if a given object implements the VaultGlobalSharesReport interface.
+ */
+export declare function instanceOfVaultGlobalSharesReport(value: object): boolean;
+export declare function VaultGlobalSharesReportFromJSON(json: any): VaultGlobalSharesReport;
+export declare function VaultGlobalSharesReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultGlobalSharesReport;
+export declare function VaultGlobalSharesReportToJSON(value?: VaultGlobalSharesReport | null): any;

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

@@ -0,0 +1,49 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface VaultGlobalUsersReport
+ */
+export interface VaultGlobalUsersReport {
+    /**
+     * the sum of all users
+     * @type {number}
+     * @memberof VaultGlobalUsersReport
+     */
+    all_users: number;
+    /**
+     * number of human users
+     * @type {number}
+     * @memberof VaultGlobalUsersReport
+     */
+    humans: number;
+    /**
+     * number of organization agents
+     * @type {number}
+     * @memberof VaultGlobalUsersReport
+     */
+    organization_agents: number;
+    /**
+     * number of service agents
+     * @type {number}
+     * @memberof VaultGlobalUsersReport
+     */
+    service_agents: number;
+}
+/**
+ * Check if a given object implements the VaultGlobalUsersReport interface.
+ */
+export declare function instanceOfVaultGlobalUsersReport(value: object): boolean;
+export declare function VaultGlobalUsersReportFromJSON(json: any): VaultGlobalUsersReport;
+export declare function VaultGlobalUsersReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultGlobalUsersReport;
+export declare function VaultGlobalUsersReportToJSON(value?: VaultGlobalUsersReport | null): any;

package/lib/types/models/VaultGlobalUsersReportResponse.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 { VaultGlobalUsersReport } from './VaultGlobalUsersReport';
+/**
+ *
+ * @export
+ * @interface VaultGlobalUsersReportResponse
+ */
+export interface VaultGlobalUsersReportResponse {
+    /**
+     *
+     * @type {VaultGlobalUsersReport}
+     * @memberof VaultGlobalUsersReportResponse
+     */
+    user_metrics: VaultGlobalUsersReport;
+}
+/**
+ * Check if a given object implements the VaultGlobalUsersReportResponse interface.
+ */
+export declare function instanceOfVaultGlobalUsersReportResponse(value: object): boolean;
+export declare function VaultGlobalUsersReportResponseFromJSON(json: any): VaultGlobalUsersReportResponse;
+export declare function VaultGlobalUsersReportResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultGlobalUsersReportResponse;
+export declare function VaultGlobalUsersReportResponseToJSON(value?: VaultGlobalUsersReportResponse | null): any;

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

@@ -0,0 +1,43 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface VaultImage
+ */
+export interface VaultImage {
+    /**
+     * ID of the image
+     * @type {string}
+     * @memberof VaultImage
+     */
+    id: string;
+    /**
+     * name of the image
+     * @type {string}
+     * @memberof VaultImage
+     */
+    filename: string | null;
+    /**
+     * URL to download the image
+     * @type {string}
+     * @memberof VaultImage
+     */
+    image_url: string;
+}
+/**
+ * Check if a given object implements the VaultImage interface.
+ */
+export declare function instanceOfVaultImage(value: object): boolean;
+export declare function VaultImageFromJSON(json: any): VaultImage;
+export declare function VaultImageFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultImage;
+export declare function VaultImageToJSON(value?: VaultImage | null): any;

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

@@ -0,0 +1,217 @@
+/**
+ * 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.
+ */
+/**
+ * Represents one user's intention to create a connection with another user
+ * @export
+ * @interface VaultInvitation
+ */
+export interface VaultInvitation {
+    /**
+     * Type of the connection. Currently it can be
+     * * `member` - a connection between an organization agent and a member
+     * * `service`- a connection between a service user and a user of the service
+     * * `delegate`- a connection between users where current user acts as delegate of a resource owner
+     * * `NULL` - a connection between two human users
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    connection_type: VaultInvitationConnectionTypeEnum;
+    /**
+     * Message to send along with invitation
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    message: string | null;
+    /**
+     * Timestamp when the invitation was created
+     * @type {Date}
+     * @memberof VaultInvitation
+     */
+    created_at: Date;
+    /**
+     * A unique secret string that an invitation recipient can use to accept the invitation
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    token: string;
+    /**
+     * A delegation role which defines the level of access that the delegate user has over the account. Currently it can be
+     * * `admin`
+     * * `owner`
+     * * `reader`
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    delegation_role: VaultInvitationDelegationRoleEnum;
+    /**
+     * A delegation token
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    delegation_token: string | null;
+    /**
+     * In the invitation is a membership invitation from an organisation, this field contains the ID of the organisation
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    organization_id: string | null;
+    /**
+     * In the invitation is a membership invitation from an organisation, this field contains the membership role, it can be `admin` or `owner`
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    organization_member_role: string | null;
+    /**
+     * In the invitation is from an organisation service, this field contains the ID of the service
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    service_id: string | null;
+    /**
+     * Decentralized identifier of the invitation sender
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    sender_did: string | null;
+    /**
+     * Decentralized identifier of the invitation recipient
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    recipient_did: string | null;
+    /**
+     * Timestamp when the invitation expires
+     * @type {Date}
+     * @memberof VaultInvitation
+     */
+    expire_at: Date;
+    /**
+     * Number of shares which will be created once the invitation is accepted and the connection is created
+     * @type {number}
+     * @memberof VaultInvitation
+     */
+    shares_to_be_created: number;
+    /**
+     * true if the current user is the sender of the invitation
+     * @type {boolean}
+     * @memberof VaultInvitation
+     */
+    outgoing: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    invited_user_id: string | null;
+    /**
+     * Invitation state
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    state: string;
+    /**
+     * Encrypted name of the recipient of the invitation
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    encrypted_recipient_name: string | null;
+    /**
+     * Encrypted name of the sender of the invitation
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    encrypted_sender_name: string | null;
+    /**
+     * the sender of an invitation can submit a JSON object containing data additonal data for the recipient of the invitation. All keys and values of this JSON object must be strings. The number of key/value pairs is limited to 8. Keys are limited to 32 bytes.Values are limited to 4096 bytes.
+     * @type {object}
+     * @memberof VaultInvitation
+     */
+    recipient_to_sender_data: object;
+    /**
+     * the recipient of an invitation can submit a JSON object containing data additonal data for the sender of the invitation. All keys and values of this JSON object must be strings. The number of key/value pairs is limited to 8. Keys are limited to 32 bytes. Values are limited to 4096 bytes.
+     * @type {object}
+     * @memberof VaultInvitation
+     */
+    sender_to_recipient_data: object;
+    /**
+     * Public key of the invitation sender
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    sender_public_key: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VaultInvitation
+     */
+    multistep_workflow?: boolean | null;
+    /**
+     * ID of the invitation. Only visible to the sender of the invitation.
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    id: string | null;
+    /**
+     * ID of the keypair to which the public key of the invitation sender belongs. Only visible to the sender of the invitation.
+     * @type {string}
+     * @memberof VaultInvitation
+     */
+    keypair_external_id: string | null;
+    /**
+     * Public key of the invitation sender. This field has been renamed to sender_public_key, please use sender_public_key
+     * @type {string}
+     * @memberof VaultInvitation
+     * @deprecated
+     */
+    user_public_key: string | null;
+    /**
+     * Number of shares which will be created once the invitation is accepted and the connection is created
+     * @type {object}
+     * @memberof VaultInvitation
+     * @deprecated
+     */
+    integration_data: object | null;
+    /**
+     * Unencrypted name of the invitation sender
+     * @type {string}
+     * @memberof VaultInvitation
+     * @deprecated
+     */
+    user_name: string | null;
+}
+/**
+ * @export
+ */
+export declare const VaultInvitationConnectionTypeEnum: {
+    readonly Member: "member";
+    readonly Service: "service";
+    readonly Delegate: "delegate";
+    readonly Null: "null";
+};
+export type VaultInvitationConnectionTypeEnum = typeof VaultInvitationConnectionTypeEnum[keyof typeof VaultInvitationConnectionTypeEnum];
+/**
+ * @export
+ */
+export declare const VaultInvitationDelegationRoleEnum: {
+    readonly Admin: "admin";
+    readonly Owner: "owner";
+    readonly Reader: "reader";
+    readonly Null: "null";
+};
+export type VaultInvitationDelegationRoleEnum = typeof VaultInvitationDelegationRoleEnum[keyof typeof VaultInvitationDelegationRoleEnum];
+/**
+ * Check if a given object implements the VaultInvitation interface.
+ */
+export declare function instanceOfVaultInvitation(value: object): boolean;
+export declare function VaultInvitationFromJSON(json: any): VaultInvitation;
+export declare function VaultInvitationFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultInvitation;
+export declare function VaultInvitationToJSON(value?: VaultInvitation | null): any;

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

@@ -0,0 +1,45 @@
+/**
+ * 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 { VaultConnection } from './VaultConnection';
+import type { VaultInvitation } from './VaultInvitation';
+/**
+ *
+ * @export
+ * @interface VaultInvitationAcceptedResponse
+ */
+export interface VaultInvitationAcceptedResponse {
+    /**
+     * this flag is true if the connection between these two users existed before this call
+     * @type {boolean}
+     * @memberof VaultInvitationAcceptedResponse
+     */
+    connection_existed_already: boolean;
+    /**
+     *
+     * @type {VaultInvitation}
+     * @memberof VaultInvitationAcceptedResponse
+     */
+    invitation: VaultInvitation;
+    /**
+     *
+     * @type {VaultConnection}
+     * @memberof VaultInvitationAcceptedResponse
+     */
+    connection: VaultConnection;
+}
+/**
+ * Check if a given object implements the VaultInvitationAcceptedResponse interface.
+ */
+export declare function instanceOfVaultInvitationAcceptedResponse(value: object): boolean;
+export declare function VaultInvitationAcceptedResponseFromJSON(json: any): VaultInvitationAcceptedResponse;
+export declare function VaultInvitationAcceptedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultInvitationAcceptedResponse;
+export declare function VaultInvitationAcceptedResponseToJSON(value?: VaultInvitationAcceptedResponse | null): any;

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

@@ -0,0 +1,45 @@
+/**
+ * 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 { VaultConnection } from './VaultConnection';
+import type { VaultInvitation } from './VaultInvitation';
+/**
+ *
+ * @export
+ * @interface VaultInvitationConfirmedResponse
+ */
+export interface VaultInvitationConfirmedResponse {
+    /**
+     * this flag is true if the connection between these two users existed before this call
+     * @type {boolean}
+     * @memberof VaultInvitationConfirmedResponse
+     */
+    connection_existed_already: boolean;
+    /**
+     *
+     * @type {VaultInvitation}
+     * @memberof VaultInvitationConfirmedResponse
+     */
+    invitation: VaultInvitation;
+    /**
+     *
+     * @type {VaultConnection}
+     * @memberof VaultInvitationConfirmedResponse
+     */
+    connection: VaultConnection;
+}
+/**
+ * Check if a given object implements the VaultInvitationConfirmedResponse interface.
+ */
+export declare function instanceOfVaultInvitationConfirmedResponse(value: object): boolean;
+export declare function VaultInvitationConfirmedResponseFromJSON(json: any): VaultInvitationConfirmedResponse;
+export declare function VaultInvitationConfirmedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultInvitationConfirmedResponse;
+export declare function VaultInvitationConfirmedResponseToJSON(value?: VaultInvitationConfirmedResponse | null): any;

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

@@ -0,0 +1,133 @@
+/**
+ * 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.
+ */
+/**
+ * An Item represents an instance of a Life object such as the White House, your pet dog Spot or your Estonian passport
+ * @export
+ * @interface VaultItem
+ */
+export interface VaultItem {
+    /**
+     *
+     * @type {string}
+     * @memberof VaultItem
+     */
+    id: string;
+    /**
+     * true if the item belongs to the current user, false if this item is shared with the current user
+     * @type {boolean}
+     * @memberof VaultItem
+     */
+    own: boolean;
+    /**
+     * Machine-readable string.
+     * @type {string}
+     * @memberof VaultItem
+     */
+    name: string;
+    /**
+     * String for display.
+     * @type {string}
+     * @memberof VaultItem
+     */
+    label: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultItem
+     */
+    description: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof VaultItem
+     */
+    created_at: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultItem
+     */
+    item_template_id: string;
+    /**
+     * Determines position in collection.
+     * @type {number}
+     * @memberof VaultItem
+     */
+    ordinal: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VaultItem
+     */
+    visible: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof VaultItem
+     */
+    updated_at: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultItem
+     */
+    item_template_label: string;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultItem
+     */
+    image: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof VaultItem
+     */
+    item_image: string | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof VaultItem
+     */
+    classification_node_ids: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof VaultItem
+     */
+    slot_ids: Array<string>;
+    /**
+     * ID of the original item if the current item is a shared item
+     * @type {string}
+     * @memberof VaultItem
+     */
+    original_id: string | null;
+    /**
+     * The owner of the item. Can be different from `user_id` if the item 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 VaultItem
+     */
+    owner_id: string | null;
+    /**
+     * ID of the share if the current item is a shared item
+     * @type {string}
+     * @memberof VaultItem
+     */
+    share_id: string | null;
+}
+/**
+ * Check if a given object implements the VaultItem interface.
+ */
+export declare function instanceOfVaultItem(value: object): boolean;
+export declare function VaultItemFromJSON(json: any): VaultItem;
+export declare function VaultItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultItem;
+export declare function VaultItemToJSON(value?: VaultItem | null): any;

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

@@ -0,0 +1,39 @@
+/**
+ * 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 { VaultItemReportItems } from './VaultItemReportItems';
+import type { VaultItemReportSlots } from './VaultItemReportSlots';
+/**
+ *
+ * @export
+ * @interface VaultItemReport
+ */
+export interface VaultItemReport {
+    /**
+     *
+     * @type {VaultItemReportItems}
+     * @memberof VaultItemReport
+     */
+    items: VaultItemReportItems;
+    /**
+     *
+     * @type {VaultItemReportSlots}
+     * @memberof VaultItemReport
+     */
+    slots: VaultItemReportSlots;
+}
+/**
+ * Check if a given object implements the VaultItemReport interface.
+ */
+export declare function instanceOfVaultItemReport(value: object): boolean;
+export declare function VaultItemReportFromJSON(json: any): VaultItemReport;
+export declare function VaultItemReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultItemReport;
+export declare function VaultItemReportToJSON(value?: VaultItemReport | null): any;

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

@@ -0,0 +1,43 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface VaultItemReportItems
+ */
+export interface VaultItemReportItems {
+    /**
+     * number of all items you have access to
+     * @type {number}
+     * @memberof VaultItemReportItems
+     */
+    all: number;
+    /**
+     * number of your own items
+     * @type {number}
+     * @memberof VaultItemReportItems
+     */
+    own: number;
+    /**
+     * number of items which have been shared with you
+     * @type {number}
+     * @memberof VaultItemReportItems
+     */
+    duplicate: number;
+}
+/**
+ * Check if a given object implements the VaultItemReportItems interface.
+ */
+export declare function instanceOfVaultItemReportItems(value: object): boolean;
+export declare function VaultItemReportItemsFromJSON(json: any): VaultItemReportItems;
+export declare function VaultItemReportItemsFromJSONTyped(json: any, ignoreDiscriminator: boolean): VaultItemReportItems;
+export declare function VaultItemReportItemsToJSON(value?: VaultItemReportItems | null): any;