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

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

@@ -0,0 +1,25 @@
+import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
+import { MiniEnvironment } from './MiniEnvironment';
+import { MiniRegion } from './MiniRegion';
+import { MiniUser } from './MiniUser';
+import { StorageRegionEnum } from './StorageRegionEnum';
+
+export type DeletedInstance = {
+    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;
+    readonly deleted_at: string;
+    readonly deleted_by: MiniUser;
+};

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

@@ -0,0 +1,15 @@
+import { MiniUser } from './MiniUser';
+
+export type DeletedInstanceAssignmentGroup = {
+    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;
+    readonly owned_by: MiniUser;
+    readonly deleted_at: string;
+    readonly deleted_by: MiniUser;
+};

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

@@ -0,0 +1,18 @@
+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 owned_by: MiniUser;
+    readonly deleted_at: string;
+    readonly deleted_by: MiniUser;
+};

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

@@ -0,0 +1,13 @@
+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 owned_by: MiniUser;
+    readonly deleted_at: string;
+    readonly deleted_by: MiniUser;
+};

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

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

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

@@ -0,0 +1,13 @@
+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;
+    readonly owned_by: MiniUser;
+};

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

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

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

@@ -0,0 +1,18 @@
+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/openapi/models/EventAttendee.d.ts

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

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

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

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

@@ -0,0 +1,10 @@
+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/openapi/models/EventExternalObjectContentTypeEnum.d.ts

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

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

@@ -0,0 +1,10 @@
+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/openapi/models/EventRequest.d.ts

@@ -0,0 +1,17 @@
+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/openapi/models/EventStatusEnum.d.ts

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

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

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

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

@@ -0,0 +1,12 @@
+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/openapi/models/FavoriteCreateRequest.d.ts

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

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

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

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

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

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

@@ -0,0 +1,12 @@
+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/openapi/models/FavoriteUpdateRequest.d.ts

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

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

@@ -0,0 +1,46 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { CollaborationRoleEnum } from './CollaborationRoleEnum';
+import { DownloadTypeEnum } from './DownloadTypeEnum';
+import { FileContentTypeEnum } from './FileContentTypeEnum';
+import { FilePermission } from './FilePermission';
+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;
+    /**
+     * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
+     */
+    readonly role: CollaborationRoleEnum;
+    permissions?: FilePermission;
+    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 owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

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

@@ -0,0 +1,16 @@
+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/openapi/models/FileAnalyticsResult.d.ts

@@ -0,0 +1,9 @@
+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/openapi/models/FileContentTypeEnum.d.ts

@@ -0,0 +1,16 @@
+/**
+ * * `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/openapi/models/FileCreate.d.ts

@@ -0,0 +1,51 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { CollaborationRoleEnum } from './CollaborationRoleEnum';
+import { DownloadTypeEnum } from './DownloadTypeEnum';
+import { FileContentTypeEnum } from './FileContentTypeEnum';
+import { FilePermission } from './FilePermission';
+import { FileStatusEnum } from './FileStatusEnum';
+import { FileTypeEnum } from './FileTypeEnum';
+import { FileVersion } from './FileVersion';
+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 version: FileVersion;
+    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;
+    /**
+     * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
+     */
+    readonly role: CollaborationRoleEnum;
+    permissions?: FilePermission;
+    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 owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

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

@@ -0,0 +1,27 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { DownloadTypeEnum } from './DownloadTypeEnum';
+import { FilePermissionRequest } from './FilePermissionRequest';
+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;
+    permissions?: FilePermissionRequest;
+    metadata?: Record<string, any>;
+    app_metadata?: Record<string, any>;
+    tags?: Array<string>;
+    expires_at?: string | null;
+    instance_id: string;
+    folder_id?: string;
+    owned_by_id?: number | null;
+};

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

@@ -0,0 +1,4 @@
+export type FilePermission = {
+    can_download?: boolean;
+    can_share?: boolean;
+};

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

@@ -0,0 +1,4 @@
+export type FilePermissionRequest = {
+    can_download?: boolean;
+    can_share?: boolean;
+};

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

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

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

@@ -0,0 +1,51 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { CollaborationRoleEnum } from './CollaborationRoleEnum';
+import { DownloadTypeEnum } from './DownloadTypeEnum';
+import { FileContentTypeEnum } from './FileContentTypeEnum';
+import { FilePermission } from './FilePermission';
+import { FileStatusEnum } from './FileStatusEnum';
+import { FileTypeEnum } from './FileTypeEnum';
+import { FileVersion } from './FileVersion';
+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 version: FileVersion;
+    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;
+    /**
+     * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
+     */
+    readonly role: CollaborationRoleEnum;
+    permissions?: FilePermission;
+    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 owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

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

@@ -0,0 +1,8 @@
+import { MiniUser } from './MiniUser';
+
+export type FileRevision = {
+    readonly id: string;
+    name: string;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+};

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

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

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

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

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

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

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

@@ -0,0 +1,51 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { CollaborationRoleEnum } from './CollaborationRoleEnum';
+import { DownloadTypeEnum } from './DownloadTypeEnum';
+import { FileContentTypeEnum } from './FileContentTypeEnum';
+import { FilePermission } from './FilePermission';
+import { FileStatusEnum } from './FileStatusEnum';
+import { FileTypeEnum } from './FileTypeEnum';
+import { FileVersion } from './FileVersion';
+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 version: FileVersion;
+    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;
+    /**
+     * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
+     */
+    readonly role: CollaborationRoleEnum;
+    permissions?: FilePermission;
+    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 owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

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

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

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

@@ -0,0 +1,5 @@
+export type FileVersion = {
+    readonly id: string;
+    readonly comment: string;
+    readonly created_at: string;
+};