@pitcher/js-api 1.22.0-alpha.1 → 1.22.0-alpha.2

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

@@ -1,17 +0,0 @@
-import { MetadataTemplateSection } from './MetadataTemplateSection';
-import { MiniFile } from './MiniFile';
-import { MiniInstance } from './MiniInstance';
-import { MiniUser } from './MiniUser';
-
-export type DeletedMetadataTemplate = {
-    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 deleted_at: string;
-    readonly deleted_by: MiniUser;
-};

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

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

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

@@ -1,10 +0,0 @@
-/**
- * * `automatic` - Automatic
- * * `mandatory` - Mandatory
- * * `ondemand` - On Demand
- */
-export declare enum DownloadTypeEnum {
-    AUTOMATIC = "automatic",
-    MANDATORY = "mandatory",
-    ONDEMAND = "ondemand"
-}

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

@@ -1,12 +0,0 @@
-import { MiniUser } from './MiniUser';
-
-export type Environment = {
-    readonly id: number;
-    name: string;
-    next_environment_ids?: Array<number>;
-    color?: string | null;
-    readonly created_at: string;
-    readonly created_by: MiniUser;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-};

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

@@ -1,5 +0,0 @@
-export type EnvironmentRequest = {
-    name: string;
-    next_environment_ids?: Array<number>;
-    color?: string | null;
-};

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

@@ -1,18 +0,0 @@
-import { EventAttendee } from './EventAttendee';
-import { EventExternalObject } from './EventExternalObject';
-import { EventStatusEnum } from './EventStatusEnum';
-import { MiniCanvas } from './MiniCanvas';
-
-export type Event = {
-    id?: string;
-    status?: EventStatusEnum;
-    start_at: string;
-    end_at: string;
-    readonly canvas: MiniCanvas;
-    external_objects?: Array<EventExternalObject>;
-    location?: string;
-    subject?: string;
-    description?: string;
-    metadata?: any;
-    attendees?: Array<EventAttendee>;
-};

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

@@ -1,5 +0,0 @@
-export type EventAttendee = {
-    email: string;
-    full_name?: string;
-    title?: string;
-};

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

@@ -1,5 +0,0 @@
-export type EventAttendeeRequest = {
-    email: string;
-    full_name?: string;
-    title?: string;
-};

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

@@ -1,10 +0,0 @@
-import { EventExternalObjectContentTypeEnum } from './EventExternalObjectContentTypeEnum';
-
-export type EventExternalObject = {
-    content_type?: EventExternalObjectContentTypeEnum;
-    connection_id: string;
-    external_content_type?: string;
-    external_object_id: string;
-    name?: string;
-    description?: string;
-};

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

@@ -1,12 +0,0 @@
-/**
- * * `event` - Event
- * * `opportunity` - Opportunity
- * * `account` - Account
- * * `other` - Other
- */
-export declare enum EventExternalObjectContentTypeEnum {
-    EVENT = "event",
-    OPPORTUNITY = "opportunity",
-    ACCOUNT = "account",
-    OTHER = "other"
-}

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

@@ -1,10 +0,0 @@
-import { EventExternalObjectContentTypeEnum } from './EventExternalObjectContentTypeEnum';
-
-export type EventExternalObjectRequest = {
-    content_type?: EventExternalObjectContentTypeEnum;
-    connection_id: string;
-    external_content_type?: string;
-    external_object_id: string;
-    name?: string;
-    description?: string;
-};

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

@@ -1,17 +0,0 @@
-import { EventAttendeeRequest } from './EventAttendeeRequest';
-import { EventExternalObjectRequest } from './EventExternalObjectRequest';
-import { EventStatusEnum } from './EventStatusEnum';
-
-export type EventRequest = {
-    id?: string;
-    status?: EventStatusEnum;
-    start_at: string;
-    end_at: string;
-    canvas_id?: string;
-    external_objects?: Array<EventExternalObjectRequest>;
-    location?: string;
-    subject?: string;
-    description?: string;
-    metadata?: any;
-    attendees?: Array<EventAttendeeRequest>;
-};

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

@@ -1,10 +0,0 @@
-/**
- * * `planned` - Planned
- * * `executed` - Executed
- * * `canceled` - Canceled
- */
-export declare enum EventStatusEnum {
-    PLANNED = "planned",
-    EXECUTED = "executed",
-    CANCELED = "canceled"
-}

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

@@ -1,17 +0,0 @@
-import { FavoriteFile } from './FavoriteFile';
-import { MiniFolder } from './MiniFolder';
-import { MiniPage } from './MiniPage';
-import { MiniUser } from './MiniUser';
-
-export type Favorite = {
-    readonly id: string;
-    readonly name: string;
-    readonly thumbnail_url: string;
-    readonly file: FavoriteFile | null;
-    readonly page: MiniPage | null;
-    readonly folder: MiniFolder | null;
-    readonly created_at: string;
-    readonly created_by: MiniUser;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-};

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

@@ -1,12 +0,0 @@
-import { FavoriteFile } from './FavoriteFile';
-import { MiniFolder } from './MiniFolder';
-import { MiniPage } from './MiniPage';
-
-export type FavoriteCreate = {
-    id?: string;
-    name?: string;
-    readonly thumbnail_url: string;
-    readonly file: FavoriteFile | null;
-    readonly page: MiniPage | null;
-    readonly folder: MiniFolder | null;
-};

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

@@ -1,7 +0,0 @@
-export type FavoriteCreateRequest = {
-    id?: string;
-    name?: string;
-    file_id?: string;
-    page_index?: number;
-    folder_id?: string;
-};

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

@@ -1,6 +0,0 @@
-export type FavoriteFile = {
-    readonly id: string;
-    name: string;
-    readonly content_type: string | null;
-    readonly tags: Array<string>;
-};

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

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

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

@@ -1,12 +0,0 @@
-import { FavoriteFile } from './FavoriteFile';
-import { MiniFolder } from './MiniFolder';
-import { MiniPage } from './MiniPage';
-
-export type FavoriteUpdate = {
-    readonly id: string;
-    name?: string;
-    readonly thumbnail_url: string;
-    readonly file: FavoriteFile | null;
-    readonly page: MiniPage | null;
-    readonly folder: MiniFolder | null;
-};

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

@@ -1,6 +0,0 @@
-export type FavoriteUpdateRequest = {
-    name?: string;
-    file_id?: string;
-    page_index?: number;
-    folder_id?: string;
-};

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

@@ -1,40 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { CollaborationRoleEnum } from './CollaborationRoleEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-import { FileContentTypeEnum } from './FileContentTypeEnum';
-import { FileStatusEnum } from './FileStatusEnum';
-import { FileTypeEnum } from './FileTypeEnum';
-import { MiniSharedLink } from './MiniSharedLink';
-import { MiniUser } from './MiniUser';
-
-export type File = {
-    readonly id: string;
-    readonly global_id: string;
-    name?: string;
-    readonly type: FileTypeEnum;
-    readonly size: number | null;
-    readonly status: FileStatusEnum;
-    readonly content_type: FileContentTypeEnum;
-    readonly content_extension: string | null;
-    readonly content_length: number | null;
-    readonly content_url: string | null;
-    readonly original_extension: string | null;
-    readonly thumbnail_url: string | null;
-    download_type?: DownloadTypeEnum;
-    readonly zip_size: number | null;
-    readonly zip_url: string | null;
-    access_type?: AccessTypeEnum;
-    readonly role: CollaborationRoleEnum;
-    metadata?: Record<string, any>;
-    app_metadata?: Record<string, any>;
-    tags?: Array<string>;
-    readonly published_at: string | null;
-    expires_at?: string | null;
-    readonly instance_id: string;
-    folder_id?: string;
-    readonly shared_link: MiniSharedLink;
-    readonly created_at: string;
-    readonly created_by: MiniUser;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-};

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

@@ -1,16 +0,0 @@
-import { FileAnalyticsResult } from './FileAnalyticsResult';
-import { MostActiveUser } from './MostActiveUser';
-
-export type FileAnalytics = {
-    readonly results: Array<FileAnalyticsResult>;
-    readonly total_views_current_period: number;
-    readonly views_change_percentage: number;
-    readonly total_user_visits_current_period: number;
-    readonly user_visits_change_percentage: number;
-    readonly total_downloads_current_period: number;
-    readonly downloads_change_percentage: number;
-    readonly most_popular_page: string;
-    readonly average_page_duration: number;
-    readonly average_file_duration: number;
-    readonly most_active_users: Array<MostActiveUser>;
-};

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

@@ -1,9 +0,0 @@
-export type FileAnalyticsResult = {
-    readonly date: string;
-    readonly views_previous_period: number;
-    readonly views_current_period: number;
-    readonly user_visits_previous_period: number;
-    readonly user_visits_current_period: number;
-    readonly downloads_previous_period: number;
-    readonly downloads_current_period: number;
-};

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

@@ -1,16 +0,0 @@
-/**
- * * `ar` - AR
- * * `font` - Font
- * * `image` - Image
- * * `pdf` - PDF
- * * `video` - Video
- * * `web` - Web
- */
-export declare enum FileContentTypeEnum {
-    AR = "ar",
-    FONT = "font",
-    IMAGE = "image",
-    PDF = "pdf",
-    VIDEO = "video",
-    WEB = "web"
-}

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

@@ -1,43 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { CollaborationRoleEnum } from './CollaborationRoleEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-import { FileContentTypeEnum } from './FileContentTypeEnum';
-import { FileStatusEnum } from './FileStatusEnum';
-import { FileTypeEnum } from './FileTypeEnum';
-import { MiniSharedLink } from './MiniSharedLink';
-import { MiniUser } from './MiniUser';
-
-export type FileCreate = {
-    readonly id: string;
-    readonly global_id: string;
-    name?: string;
-    type?: FileTypeEnum;
-    readonly size: number | null;
-    readonly status: FileStatusEnum;
-    readonly content_type: FileContentTypeEnum;
-    readonly content_extension: string | null;
-    readonly content_length: number | null;
-    readonly content_url: string | null;
-    readonly content_thumbnails: Array<string>;
-    readonly original_extension: string | null;
-    readonly thumbnail_url: string | null;
-    download_type?: DownloadTypeEnum;
-    readonly zip_size: number | null;
-    readonly zip_url: string | null;
-    access_type?: AccessTypeEnum;
-    readonly role: CollaborationRoleEnum;
-    readonly pspdfkit_server_url: string | null;
-    readonly pspdfkit_auth_payload: Record<string, any> | null;
-    metadata?: Record<string, any>;
-    app_metadata?: Record<string, any>;
-    tags?: Array<string>;
-    readonly published_at: string | null;
-    expires_at?: string | null;
-    instance_id: string;
-    folder_id?: string;
-    readonly shared_link: MiniSharedLink;
-    readonly created_at: string;
-    readonly created_by: MiniUser;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-};

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

@@ -1,24 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-import { FileTypeEnum } from './FileTypeEnum';
-
-export type FileCreateRequest = {
-    name?: string;
-    type?: FileTypeEnum;
-    /**
-     * Deprecated: Please use the 'type' field instead. This field is maintained for backward compatibility and may be removed in future releases.
-     */
-    is_asset?: boolean;
-    content?: Blob;
-    content_upload_id?: string;
-    thumbnail?: Blob;
-    thumbnail_upload_id?: string;
-    download_type?: DownloadTypeEnum;
-    access_type?: AccessTypeEnum;
-    metadata?: Record<string, any>;
-    app_metadata?: Record<string, any>;
-    tags?: Array<string>;
-    expires_at?: string | null;
-    instance_id: string;
-    folder_id?: string;
-};

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

@@ -1,13 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-
-export type FileRequest = {
-    name?: string;
-    download_type?: DownloadTypeEnum;
-    access_type?: AccessTypeEnum;
-    metadata?: Record<string, any>;
-    app_metadata?: Record<string, any>;
-    tags?: Array<string>;
-    expires_at?: string | null;
-    folder_id?: string;
-};

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

@@ -1,43 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { CollaborationRoleEnum } from './CollaborationRoleEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-import { FileContentTypeEnum } from './FileContentTypeEnum';
-import { FileStatusEnum } from './FileStatusEnum';
-import { FileTypeEnum } from './FileTypeEnum';
-import { MiniSharedLink } from './MiniSharedLink';
-import { MiniUser } from './MiniUser';
-
-export type FileRetrieve = {
-    readonly id: string;
-    readonly global_id: string;
-    name?: string;
-    readonly type: FileTypeEnum;
-    readonly size: number | null;
-    readonly status: FileStatusEnum;
-    readonly content_type: FileContentTypeEnum;
-    readonly content_extension: string | null;
-    readonly content_length: number | null;
-    readonly content_url: string | null;
-    readonly content_thumbnails: Array<string>;
-    readonly original_extension: string | null;
-    readonly thumbnail_url: string | null;
-    download_type?: DownloadTypeEnum;
-    readonly zip_size: number | null;
-    readonly zip_url: string | null;
-    access_type?: AccessTypeEnum;
-    readonly role: CollaborationRoleEnum;
-    readonly pspdfkit_server_url: string | null;
-    readonly pspdfkit_auth_payload: Record<string, any> | null;
-    metadata?: Record<string, any>;
-    app_metadata?: Record<string, any>;
-    tags?: Array<string>;
-    readonly published_at: string | null;
-    expires_at?: string | null;
-    readonly instance_id: string;
-    folder_id?: string;
-    readonly shared_link: MiniSharedLink;
-    readonly created_at: string;
-    readonly created_by: MiniUser;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-};

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

@@ -1,8 +0,0 @@
-/**
- * * `pending` - Pending
- * * `viewable` - Viewable
- */
-export declare enum FileStatusEnum {
-    PENDING = "pending",
-    VIEWABLE = "viewable"
-}

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

@@ -1,10 +0,0 @@
-/**
- * * `app` - App
- * * `asset` - Asset
- * * `content` - Content
- */
-export declare enum FileTypeEnum {
-    APP = "app",
-    ASSET = "asset",
-    CONTENT = "content"
-}

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

@@ -1,43 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { CollaborationRoleEnum } from './CollaborationRoleEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-import { FileContentTypeEnum } from './FileContentTypeEnum';
-import { FileStatusEnum } from './FileStatusEnum';
-import { FileTypeEnum } from './FileTypeEnum';
-import { MiniSharedLink } from './MiniSharedLink';
-import { MiniUser } from './MiniUser';
-
-export type FileUpdate = {
-    readonly id: string;
-    readonly global_id: string;
-    name?: string;
-    readonly type: FileTypeEnum;
-    readonly size: number | null;
-    readonly status: FileStatusEnum;
-    readonly content_type: FileContentTypeEnum;
-    readonly content_extension: string | null;
-    readonly content_length: number | null;
-    readonly content_url: string | null;
-    readonly content_thumbnails: Array<string>;
-    readonly original_extension: string | null;
-    readonly thumbnail_url: string | null;
-    download_type?: DownloadTypeEnum;
-    readonly zip_size: number | null;
-    readonly zip_url: string | null;
-    access_type?: AccessTypeEnum;
-    readonly role: CollaborationRoleEnum;
-    readonly pspdfkit_server_url: string | null;
-    readonly pspdfkit_auth_payload: Record<string, any> | null;
-    metadata?: Record<string, any>;
-    app_metadata?: Record<string, any>;
-    tags?: Array<string>;
-    readonly published_at: string | null;
-    expires_at?: string | null;
-    readonly instance_id: string;
-    folder_id?: string;
-    readonly shared_link: MiniSharedLink;
-    readonly created_at: string;
-    readonly created_by: MiniUser;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-};

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

@@ -1,17 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-
-export type FileUpdateRequest = {
-    name?: string;
-    content?: Blob;
-    content_upload_id?: string;
-    thumbnail?: Blob;
-    thumbnail_upload_id?: string;
-    download_type?: DownloadTypeEnum;
-    access_type?: AccessTypeEnum;
-    metadata?: Record<string, any>;
-    app_metadata?: Record<string, any>;
-    tags?: Array<string>;
-    expires_at?: string | null;
-    folder_id?: string;
-};

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

@@ -1,15 +0,0 @@
-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 created_at: string;
-    readonly created_by: MiniUser;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-};

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

@@ -1,31 +0,0 @@
-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 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/types/openapi/models/FolderCreateRequest.d.ts

@@ -1,18 +0,0 @@
-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;
-};

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

@@ -1,14 +0,0 @@
-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 modified_at: string;
-};

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

@@ -1,6 +0,0 @@
-export type FolderFolder = {
-    readonly id: string;
-    name: string;
-    readonly files_count: number;
-    readonly folders_count: number;
-};

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

@@ -1,24 +0,0 @@
-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 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;
-};