@pitcher/js-api 1.19.0 → 1.20.0-beta.14

package/types/openapi/models/Folder.d.ts

@@ -0,0 +1,16 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { MiniUser } from './MiniUser';
+
+export type Folder = {
+    readonly id: string;
+    name: string;
+    readonly instance_id: string;
+    access_type?: AccessTypeEnum;
+    readonly materialized_path: string;
+    readonly depth: number;
+    readonly owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

package/types/openapi/models/FolderCreate.d.ts

@@ -0,0 +1,32 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderFile } from './FolderFile';
+import { FolderFolder } from './FolderFolder';
+import { MiniUser } from './MiniUser';
+
+/**
+ * Serializer class for creating folder records.
+ * Available fields for creating a folder:
+ * - id
+ * - name
+ * - parent_folder_id
+ * - instance_id
+ */
+export type FolderCreate = {
+    id?: string;
+    name: string;
+    access_type?: AccessTypeEnum;
+    readonly materialized_path: string;
+    readonly depth: number;
+    readonly owned_by: MiniUser;
+    readonly files: Array<FolderFile>;
+    readonly files_count: number;
+    readonly file_thumbnail_urls: Array<string>;
+    readonly thumbnail_url: string | null;
+    readonly folders: Array<FolderFolder>;
+    readonly folders_count: number;
+    readonly path: Array<FolderFolder>;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

package/types/openapi/models/FolderCreateRequest.d.ts

@@ -0,0 +1,19 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+
+/**
+ * Serializer class for creating folder records.
+ * Available fields for creating a folder:
+ * - id
+ * - name
+ * - parent_folder_id
+ * - instance_id
+ */
+export type FolderCreateRequest = {
+    id?: string;
+    name: string;
+    instance_id: string;
+    access_type?: AccessTypeEnum;
+    parent_folder_id?: string;
+    thumbnail_id?: string;
+    owned_by_id?: number | null;
+};

package/types/openapi/models/FolderFile.d.ts

@@ -0,0 +1,15 @@
+import { FileContentTypeEnum } from './FileContentTypeEnum';
+import { FileStatusEnum } from './FileStatusEnum';
+import { MiniUser } from './MiniUser';
+
+export type FolderFile = {
+    readonly id: string;
+    readonly name: string;
+    readonly status: FileStatusEnum;
+    readonly content_type: FileContentTypeEnum;
+    readonly thumbnail_url: string;
+    readonly tags: Array<string>;
+    readonly created_by: MiniUser;
+    readonly owned_by: MiniUser;
+    readonly modified_at: string;
+};

package/types/openapi/models/FolderFolder.d.ts

@@ -0,0 +1,8 @@
+export type FolderFolder = {
+    readonly id: string;
+    name: string;
+    readonly files_count: number;
+    readonly folders_count: number;
+    readonly thumbnail_url: string | null;
+    readonly file_thumbnail_urls: Array<string>;
+};

package/types/openapi/models/FolderRetrieve.d.ts

@@ -0,0 +1,25 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderFile } from './FolderFile';
+import { FolderFolder } from './FolderFolder';
+import { MiniUser } from './MiniUser';
+
+export type FolderRetrieve = {
+    readonly id: string;
+    name: string;
+    readonly instance_id: string;
+    access_type?: AccessTypeEnum;
+    readonly materialized_path: string;
+    readonly depth: number;
+    readonly owned_by: MiniUser;
+    readonly files: Array<FolderFile>;
+    readonly files_count: number;
+    readonly file_thumbnail_urls: Array<string>;
+    readonly thumbnail_url: string | null;
+    readonly folders: Array<FolderFolder>;
+    readonly folders_count: number;
+    readonly path: Array<FolderFolder>;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

package/types/openapi/models/FolderUpdate.d.ts

@@ -0,0 +1,32 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderFile } from './FolderFile';
+import { FolderFolder } from './FolderFolder';
+import { MiniUser } from './MiniUser';
+
+/**
+ * Serializer class for updating folder records.
+ * Available fields to update:
+ * - name
+ * - access_type
+ * - parent_folder_id
+ */
+export type FolderUpdate = {
+    readonly id: string;
+    name: string;
+    readonly instance_id: string;
+    access_type?: AccessTypeEnum;
+    readonly materialized_path: string;
+    readonly depth: number;
+    readonly owned_by: MiniUser;
+    readonly files: Array<FolderFile>;
+    readonly files_count: number;
+    readonly file_thumbnail_urls: Array<string>;
+    readonly thumbnail_url: string | null;
+    readonly folders: Array<FolderFolder>;
+    readonly folders_count: number;
+    readonly path: Array<FolderFolder>;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

package/types/openapi/models/FolderUpdateRequest.d.ts

@@ -0,0 +1,16 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+
+/**
+ * Serializer class for updating folder records.
+ * Available fields to update:
+ * - name
+ * - access_type
+ * - parent_folder_id
+ */
+export type FolderUpdateRequest = {
+    name: string;
+    access_type?: AccessTypeEnum;
+    parent_folder_id?: string;
+    thumbnail_id?: string;
+    owned_by_id?: number | null;
+};

package/types/openapi/models/Instance.d.ts

@@ -0,0 +1,23 @@
+import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
+import { MiniEnvironment } from './MiniEnvironment';
+import { MiniRegion } from './MiniRegion';
+import { MiniUser } from './MiniUser';
+import { StorageRegionEnum } from './StorageRegionEnum';
+
+export type Instance = {
+    readonly id: string;
+    name: string;
+    color?: string | null;
+    logo?: string | null;
+    readonly last_login: string;
+    storage_region?: StorageRegionEnum;
+    readonly environment: MiniEnvironment;
+    readonly region: MiniRegion;
+    readonly role: InstanceMembershipRoleEnum;
+    settings?: Record<string, any> | null;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+    readonly owned_by: MiniUser;
+};

package/types/openapi/models/InstanceAnalytics.d.ts

@@ -0,0 +1,18 @@
+import { InstanceAnalyticsChangePercentages } from './InstanceAnalyticsChangePercentages';
+import { InstanceAnalyticsCurrentPeriod } from './InstanceAnalyticsCurrentPeriod';
+import { InstanceAnalyticsFileActivity } from './InstanceAnalyticsFileActivity';
+import { InstanceAnalyticsLoginResult } from './InstanceAnalyticsLoginResult';
+
+export type InstanceAnalytics = {
+    readonly current_period: InstanceAnalyticsCurrentPeriod;
+    readonly percentages: InstanceAnalyticsChangePercentages;
+    readonly files_results: Array<InstanceAnalyticsFileActivity>;
+    readonly logins_results: Array<InstanceAnalyticsLoginResult>;
+    /**
+     * Total storage in bytes
+     */
+    readonly total_storage: number;
+    readonly total_files: number;
+    readonly total_apps: number;
+    readonly total_users: number;
+};

package/types/openapi/models/InstanceAnalyticsChangePercentages.d.ts

@@ -0,0 +1,5 @@
+export type InstanceAnalyticsChangePercentages = {
+    readonly inactive_users_change: number;
+    readonly logins_change: number;
+    readonly views_change: number;
+};

package/types/openapi/models/InstanceAnalyticsCurrentPeriod.d.ts

@@ -0,0 +1,13 @@
+import { InstanceAnalyticsFile } from './InstanceAnalyticsFile';
+import { InstanceAnalyticsInactiveUsers } from './InstanceAnalyticsInactiveUsers';
+
+export type InstanceAnalyticsCurrentPeriod = {
+    readonly inactive_users: Array<InstanceAnalyticsInactiveUsers>;
+    readonly never_downloaded_files: Array<InstanceAnalyticsFile>;
+    readonly never_opened_files: Array<InstanceAnalyticsFile>;
+    readonly total_inactive_users: number;
+    readonly total_logins: number;
+    readonly total_never_downloaded_files: number;
+    readonly total_never_opened_files: number;
+    readonly total_views: number;
+};

package/types/openapi/models/InstanceAnalyticsFile.d.ts

@@ -0,0 +1,5 @@
+export type InstanceAnalyticsFile = {
+    readonly id: string;
+    name: string;
+    readonly thumbnail_url: string;
+};

package/types/openapi/models/InstanceAnalyticsFileActivity.d.ts

@@ -0,0 +1,5 @@
+export type InstanceAnalyticsFileActivity = {
+    readonly date: string;
+    readonly views_current_period: number;
+    readonly views_previous_period: number;
+};

package/types/openapi/models/InstanceAnalyticsFileRequest.d.ts

@@ -0,0 +1,3 @@
+export type InstanceAnalyticsFileRequest = {
+    name: string;
+};

package/types/openapi/models/InstanceAnalyticsInactiveUsers.d.ts

@@ -0,0 +1,5 @@
+export type InstanceAnalyticsInactiveUsers = {
+    id: number;
+    name: string;
+    readonly last_login: string;
+};

package/types/openapi/models/InstanceAnalyticsInactiveUsersRequest.d.ts

@@ -0,0 +1,4 @@
+export type InstanceAnalyticsInactiveUsersRequest = {
+    id: number;
+    name: string;
+};

package/types/openapi/models/InstanceAnalyticsLoginResult.d.ts

@@ -0,0 +1,5 @@
+export type InstanceAnalyticsLoginResult = {
+    readonly date: string;
+    readonly logins_current_period: number;
+    readonly logins_previous_period: number;
+};

package/types/openapi/models/InstanceAssignmentGroup.d.ts

@@ -0,0 +1,12 @@
+import { MiniUser } from './MiniUser';
+
+export type InstanceAssignmentGroup = {
+    readonly id: string;
+    name: string;
+    readonly size: number;
+    auto_add_new_users?: boolean;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

package/types/openapi/models/InstanceAssignmentGroupMembership.d.ts

@@ -0,0 +1,8 @@
+import { InstanceAssignmentGroup } from './InstanceAssignmentGroup';
+import { MiniUser } from './MiniUser';
+
+export type InstanceAssignmentGroupMembership = {
+    readonly id: string;
+    readonly instance_assignment_group: InstanceAssignmentGroup;
+    readonly user: MiniUser;
+};

package/types/openapi/models/InstanceAssignmentGroupMembershipCreate.d.ts

@@ -0,0 +1,8 @@
+import { InstanceAssignmentGroup } from './InstanceAssignmentGroup';
+import { MiniUser } from './MiniUser';
+
+export type InstanceAssignmentGroupMembershipCreate = {
+    readonly id: string;
+    readonly instance_assignment_group: InstanceAssignmentGroup;
+    readonly user: MiniUser;
+};

package/types/openapi/models/InstanceAssignmentGroupMembershipCreateRequest.d.ts

@@ -0,0 +1,4 @@
+export type InstanceAssignmentGroupMembershipCreateRequest = {
+    instance_assignment_group_id: string;
+    user_id: number;
+};

package/types/openapi/models/InstanceAssignmentGroupRequest.d.ts

@@ -0,0 +1,4 @@
+export type InstanceAssignmentGroupRequest = {
+    name: string;
+    auto_add_new_users?: boolean;
+};

package/types/openapi/models/InstanceMembership.d.ts

@@ -0,0 +1,12 @@
+import { InstanceMembershipGroup } from './InstanceMembershipGroup';
+import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
+import { InstanceMembershipUser } from './InstanceMembershipUser';
+import { MiniInstance } from './MiniInstance';
+
+export type InstanceMembership = {
+    readonly id: number;
+    readonly instance: MiniInstance;
+    readonly user: InstanceMembershipUser;
+    readonly instance_assignment_group: InstanceMembershipGroup;
+    role?: InstanceMembershipRoleEnum;
+};

package/types/openapi/models/InstanceMembershipCreate.d.ts

@@ -0,0 +1,12 @@
+import { InstanceMembershipGroup } from './InstanceMembershipGroup';
+import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
+import { InstanceMembershipUser } from './InstanceMembershipUser';
+import { MiniInstance } from './MiniInstance';
+
+export type InstanceMembershipCreate = {
+    readonly id: number;
+    readonly instance: MiniInstance;
+    readonly user: InstanceMembershipUser;
+    readonly instance_assignment_group: InstanceMembershipGroup;
+    role?: InstanceMembershipRoleEnum;
+};

package/types/openapi/models/InstanceMembershipCreateRequest.d.ts

@@ -0,0 +1,8 @@
+import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
+
+export type InstanceMembershipCreateRequest = {
+    role?: InstanceMembershipRoleEnum;
+    instance_id: string;
+    user_id?: number | null;
+    instance_assignment_group_id?: string | null;
+};

package/types/openapi/models/InstanceMembershipGroup.d.ts

@@ -0,0 +1,11 @@
+import { MiniUser } from './MiniUser';
+
+export type InstanceMembershipGroup = {
+    readonly id: string;
+    name: string;
+    readonly size: number;
+    readonly created_by: MiniUser;
+    readonly created_at: string;
+    readonly modified_by: MiniUser;
+    readonly modified_at: string;
+};

package/types/openapi/models/InstanceMembershipGroupRequest.d.ts

@@ -0,0 +1,3 @@
+export type InstanceMembershipGroupRequest = {
+    name: string;
+};

package/types/openapi/models/InstanceMembershipRequest.d.ts

@@ -0,0 +1,5 @@
+import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
+
+export type InstanceMembershipRequest = {
+    role?: InstanceMembershipRoleEnum;
+};

package/types/openapi/models/InstanceMembershipRoleEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * * `admin` - Admin
+ * * `member` - Member
+ */
+export declare enum InstanceMembershipRoleEnum {
+    ADMIN = "admin",
+    MEMBER = "member"
+}

package/types/openapi/models/InstanceMembershipUser.d.ts

@@ -0,0 +1,10 @@
+import { InstanceMembershipUserStatusEnum } from './InstanceMembershipUserStatusEnum';
+
+export type InstanceMembershipUser = {
+    readonly id: number;
+    readonly name: string;
+    email?: string;
+    readonly status: InstanceMembershipUserStatusEnum;
+    readonly instance_last_login: string;
+    picture: string;
+};

package/types/openapi/models/InstanceMembershipUserRequest.d.ts

@@ -0,0 +1,4 @@
+export type InstanceMembershipUserRequest = {
+    email?: string;
+    picture: string;
+};

package/types/openapi/models/InstanceMembershipUserStatusEnum.d.ts

@@ -0,0 +1,6 @@
+export declare enum InstanceMembershipUserStatusEnum {
+    ACTIVE = "active",
+    DEACTIVE = "deactive",
+    INVITATION_PENDING = "invitation_pending",
+    INVITATION_EXPIRED = "invitation_expired"
+}

package/types/openapi/models/InstanceRequest.d.ts

@@ -0,0 +1,11 @@
+import { StorageRegionEnum } from './StorageRegionEnum';
+
+export type InstanceRequest = {
+    name: string;
+    color?: string | null;
+    logo?: Blob | null;
+    storage_region?: StorageRegionEnum;
+    environment_id: number;
+    region_id: number;
+    settings?: Record<string, any> | null;
+};

package/types/openapi/models/InstanceUpdate.d.ts

@@ -0,0 +1,19 @@
+import { MiniEnvironment } from './MiniEnvironment';
+import { MiniRegion } from './MiniRegion';
+import { MiniUser } from './MiniUser';
+
+export type InstanceUpdate = {
+    readonly id: string;
+    name: string;
+    color?: string | null;
+    logo?: string | null;
+    readonly last_login: string;
+    readonly environment: MiniEnvironment;
+    readonly region: MiniRegion;
+    settings?: Record<string, any> | null;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+    readonly owned_by: MiniUser;
+};

package/types/openapi/models/InstanceUpdateRequest.d.ts

@@ -0,0 +1,8 @@
+export type InstanceUpdateRequest = {
+    name: string;
+    color?: string | null;
+    logo?: Blob | null;
+    environment_id: number;
+    region_id: number;
+    settings?: Record<string, any> | null;
+};

package/types/openapi/models/Invitation.d.ts

@@ -0,0 +1,11 @@
+import { InvitationStatusEnum } from './InvitationStatusEnum';
+
+export type Invitation = {
+    readonly id: string;
+    readonly inviter: string;
+    invitee: string;
+    readonly url: string;
+    readonly created_at: string;
+    readonly expires_at: string;
+    readonly status: InvitationStatusEnum;
+};

package/types/openapi/models/InvitationRequest.d.ts

@@ -0,0 +1,3 @@
+export type InvitationRequest = {
+    invitee: string;
+};

package/types/openapi/models/InvitationStatusEnum.d.ts

@@ -0,0 +1,4 @@
+export declare enum InvitationStatusEnum {
+    PENDING = "pending",
+    EXPIRED = "expired"
+}

package/types/openapi/models/LanguageEnum.d.ts

@@ -0,0 +1,12 @@
+/**
+ * * `en` - English
+ * * `de` - Deutsch
+ * * `pl` - Polski
+ * * `tr` - Türkçe
+ */
+export declare enum LanguageEnum {
+    EN = "en",
+    DE = "de",
+    PL = "pl",
+    TR = "tr"
+}

package/types/openapi/models/MetadataTemplate.d.ts

@@ -0,0 +1,16 @@
+import { MetadataTemplateSection } from './MetadataTemplateSection';
+import { MiniFile } from './MiniFile';
+import { MiniInstance } from './MiniInstance';
+import { MiniUser } from './MiniUser';
+
+export type MetadataTemplate = {
+    readonly id: string;
+    readonly instance: MiniInstance;
+    readonly file: MiniFile;
+    sections?: Array<MetadataTemplateSection>;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+    readonly owned_by: MiniUser;
+};

package/types/openapi/models/MetadataTemplateField.d.ts

@@ -0,0 +1,14 @@
+import { MetadataTemplateFieldTypeEnum } from './MetadataTemplateFieldTypeEnum';
+import { MetadataTemplateOption } from './MetadataTemplateOption';
+
+export type MetadataTemplateField = {
+    type: MetadataTemplateFieldTypeEnum;
+    name: string;
+    label: string;
+    help_text?: string;
+    is_required?: boolean;
+    is_filterable?: boolean;
+    is_sortable?: boolean;
+    is_visible_in_lists?: boolean;
+    options?: Array<MetadataTemplateOption>;
+};

package/types/openapi/models/MetadataTemplateFieldRequest.d.ts

@@ -0,0 +1,14 @@
+import { MetadataTemplateFieldTypeEnum } from './MetadataTemplateFieldTypeEnum';
+import { MetadataTemplateOptionRequest } from './MetadataTemplateOptionRequest';
+
+export type MetadataTemplateFieldRequest = {
+    type: MetadataTemplateFieldTypeEnum;
+    name: string;
+    label: string;
+    help_text?: string;
+    is_required?: boolean;
+    is_filterable?: boolean;
+    is_sortable?: boolean;
+    is_visible_in_lists?: boolean;
+    options?: Array<MetadataTemplateOptionRequest>;
+};

package/types/openapi/models/MetadataTemplateFieldTypeEnum.d.ts

@@ -0,0 +1,16 @@
+/**
+ * * `text` - Text
+ * * `number` - Number
+ * * `date` - Date
+ * * `select` - Dropdown - Single Select
+ * * `multi-select` - Dropdown - Multiple Select
+ * * `checkbox` - Checkbox
+ */
+export declare enum MetadataTemplateFieldTypeEnum {
+    TEXT = "text",
+    NUMBER = "number",
+    DATE = "date",
+    SELECT = "select",
+    MULTI_SELECT = "multi-select",
+    CHECKBOX = "checkbox"
+}

package/types/openapi/models/MetadataTemplateOption.d.ts

@@ -0,0 +1,4 @@
+export type MetadataTemplateOption = {
+    label: string;
+    value: string;
+};

package/types/openapi/models/MetadataTemplateOptionRequest.d.ts

@@ -0,0 +1,4 @@
+export type MetadataTemplateOptionRequest = {
+    label: string;
+    value: string;
+};

package/types/openapi/models/MetadataTemplateRequest.d.ts

@@ -0,0 +1,7 @@
+import { MetadataTemplateSectionRequest } from './MetadataTemplateSectionRequest';
+
+export type MetadataTemplateRequest = {
+    instance_id?: string;
+    file_id?: string;
+    sections?: Array<MetadataTemplateSectionRequest>;
+};

package/types/openapi/models/MetadataTemplateSection.d.ts

@@ -0,0 +1,6 @@
+import { MetadataTemplateField } from './MetadataTemplateField';
+
+export type MetadataTemplateSection = {
+    label: string;
+    fields: Array<MetadataTemplateField>;
+};

package/types/openapi/models/MetadataTemplateSectionRequest.d.ts

@@ -0,0 +1,6 @@
+import { MetadataTemplateFieldRequest } from './MetadataTemplateFieldRequest';
+
+export type MetadataTemplateSectionRequest = {
+    label: string;
+    fields: Array<MetadataTemplateFieldRequest>;
+};

package/types/openapi/models/MiniCanvas.d.ts

@@ -0,0 +1,4 @@
+export type MiniCanvas = {
+    readonly id: string;
+    name: string;
+};

package/types/openapi/models/MiniCanvasRequest.d.ts

@@ -0,0 +1,3 @@
+export type MiniCanvasRequest = {
+    name: string;
+};

package/types/openapi/models/MiniContentDistributionGroup.d.ts

@@ -0,0 +1,5 @@
+export type MiniContentDistributionGroup = {
+    readonly id: string;
+    name: string;
+    readonly size: number;
+};

package/types/openapi/models/MiniContentDistributionGroupRequest.d.ts

@@ -0,0 +1,3 @@
+export type MiniContentDistributionGroupRequest = {
+    name: string;
+};

package/types/openapi/models/MiniEnvironment.d.ts

@@ -0,0 +1,5 @@
+export type MiniEnvironment = {
+    readonly id: number;
+    name: string;
+    color?: string | null;
+};

package/types/openapi/models/MiniEnvironmentRequest.d.ts

@@ -0,0 +1,4 @@
+export type MiniEnvironmentRequest = {
+    name: string;
+    color?: string | null;
+};

package/types/openapi/models/MiniEvent.d.ts

@@ -0,0 +1,5 @@
+export type MiniEvent = {
+    readonly id: string;
+    start_at: string;
+    subject: string;
+};