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

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

@@ -0,0 +1,6 @@
+import { BulkUpdateMetadataResult } from './BulkUpdateMetadataResult';
+
+export type BulkUpdateMetadata = {
+    readonly files: Array<BulkUpdateMetadataResult>;
+    readonly canvases: Array<BulkUpdateMetadataResult>;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `update` - update
+ * * `replace` - replace
+ */
+export declare enum BulkUpdateMetadataOperationEnum {
+    UPDATE = "update",
+    REPLACE = "replace"
+}

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

@@ -0,0 +1,9 @@
+import { BulkUpdateMetadataOperationEnum } from './BulkUpdateMetadataOperationEnum';
+
+export type BulkUpdateMetadataRequest = {
+    instance_id: string;
+    file_ids?: Array<string>;
+    canvas_ids?: Array<string>;
+    metadata: Record<string, any>;
+    operation?: BulkUpdateMetadataOperationEnum;
+};

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

@@ -0,0 +1,4 @@
+export type BulkUpdateMetadataResult = {
+    readonly id: string;
+    readonly metadata: Record<string, any>;
+};

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

@@ -0,0 +1,6 @@
+import { BulkUpdateTagsResult } from './BulkUpdateTagsResult';
+
+export type BulkUpdateTags = {
+    readonly files: Array<BulkUpdateTagsResult>;
+    readonly canvases: Array<BulkUpdateTagsResult>;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `add` - add
+ * * `remove` - remove
+ */
+export declare enum BulkUpdateTagsOperationEnum {
+    ADD = "add",
+    REMOVE = "remove"
+}

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

@@ -0,0 +1,9 @@
+import { BulkUpdateTagsOperationEnum } from './BulkUpdateTagsOperationEnum';
+
+export type BulkUpdateTagsRequest = {
+    instance_id: string;
+    file_ids?: Array<string>;
+    canvas_ids?: Array<string>;
+    tags: Array<string>;
+    operation?: BulkUpdateTagsOperationEnum;
+};

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

@@ -0,0 +1,4 @@
+export type BulkUpdateTagsResult = {
+    readonly id: string;
+    readonly tags: Array<string>;
+};

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

@@ -0,0 +1,29 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { Account } from './Account';
+import { MiniCanvas } from './MiniCanvas';
+import { MiniSharedLink } from './MiniSharedLink';
+import { MiniUser } from './MiniUser';
+
+export type Canvas = {
+    readonly id: string;
+    name: string;
+    is_draft?: boolean;
+    is_template?: boolean;
+    is_section?: boolean;
+    is_editable?: boolean;
+    is_default?: boolean;
+    metadata?: Record<string, any>;
+    tags?: Array<string>;
+    start_at?: string | null;
+    expires_at?: string | null;
+    access_type?: AccessTypeEnum;
+    thumbnail_url?: string | null;
+    readonly template: MiniCanvas;
+    readonly shared_link: MiniSharedLink;
+    account?: Account | null;
+    readonly owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

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

@@ -0,0 +1,36 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { Account } from './Account';
+import { CanvasSection } from './CanvasSection';
+import { MiniCanvas } from './MiniCanvas';
+import { MiniEvent } from './MiniEvent';
+import { MiniSharedLink } from './MiniSharedLink';
+import { MiniUser } from './MiniUser';
+
+export type CanvasCreate = {
+    id?: string;
+    name: string;
+    content?: Record<string, any>;
+    context?: Record<string, any>;
+    theme?: Record<string, any> | null;
+    is_draft?: boolean;
+    is_template?: boolean;
+    is_section?: boolean;
+    is_editable?: boolean;
+    is_default?: boolean;
+    metadata?: Record<string, any>;
+    tags?: Array<string>;
+    start_at?: string | null;
+    expires_at?: string | null;
+    access_type?: AccessTypeEnum;
+    thumbnail_url?: string | null;
+    readonly template: MiniCanvas;
+    readonly sections: Array<CanvasSection>;
+    readonly shared_link: MiniSharedLink;
+    account?: Account | null;
+    readonly events: Array<MiniEvent>;
+    readonly owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

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

@@ -0,0 +1,25 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { AccountRequest } from './AccountRequest';
+
+export type CanvasCreateRequest = {
+    id?: string;
+    name: string;
+    content?: Record<string, any>;
+    context?: Record<string, any>;
+    theme?: Record<string, any> | null;
+    is_draft?: boolean;
+    is_template?: boolean;
+    is_section?: boolean;
+    is_editable?: boolean;
+    is_default?: boolean;
+    metadata?: Record<string, any>;
+    tags?: Array<string>;
+    start_at?: string | null;
+    expires_at?: string | null;
+    access_type?: AccessTypeEnum;
+    thumbnail_url?: string | null;
+    instance_id: string;
+    template_id?: string | null;
+    account?: AccountRequest | null;
+    owned_by_id?: number | null;
+};

package/types/openapi/models/CanvasRecommendedFile.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 CanvasRecommendedFile = {
+    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/CanvasRecommendedFiles.d.ts

@@ -0,0 +1,5 @@
+import { CanvasRecommendedFile } from './CanvasRecommendedFile';
+
+export type CanvasRecommendedFiles = {
+    recommended_files: Array<CanvasRecommendedFile>;
+};

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

@@ -0,0 +1,36 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { Account } from './Account';
+import { CanvasSection } from './CanvasSection';
+import { MiniCanvas } from './MiniCanvas';
+import { MiniEvent } from './MiniEvent';
+import { MiniSharedLink } from './MiniSharedLink';
+import { MiniUser } from './MiniUser';
+
+export type CanvasRetrieve = {
+    readonly id: string;
+    name: string;
+    content?: Record<string, any>;
+    context?: Record<string, any>;
+    theme?: Record<string, any> | null;
+    is_draft?: boolean;
+    is_template?: boolean;
+    is_section?: boolean;
+    is_editable?: boolean;
+    is_default?: boolean;
+    metadata?: Record<string, any>;
+    tags?: Array<string>;
+    start_at?: string | null;
+    expires_at?: string | null;
+    access_type?: AccessTypeEnum;
+    thumbnail_url?: string | null;
+    readonly template: MiniCanvas;
+    readonly sections: Array<CanvasSection>;
+    readonly shared_link: MiniSharedLink;
+    account?: Account | null;
+    readonly events: Array<MiniEvent>;
+    readonly owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * Serializer used solely for defining the OpenAPI schema in extend_schema_field.
+ */
+export type CanvasSection = {
+    readonly id: string;
+    name: string;
+    content: Record<string, any>;
+    theme?: Record<string, any> | null;
+    metadata?: Record<string, any>;
+};

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

@@ -0,0 +1,36 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { Account } from './Account';
+import { CanvasSection } from './CanvasSection';
+import { MiniCanvas } from './MiniCanvas';
+import { MiniEvent } from './MiniEvent';
+import { MiniSharedLink } from './MiniSharedLink';
+import { MiniUser } from './MiniUser';
+
+export type CanvasUpdate = {
+    readonly id: string;
+    name: string;
+    content?: Record<string, any>;
+    context?: Record<string, any>;
+    theme?: Record<string, any> | null;
+    is_draft?: boolean;
+    is_template?: boolean;
+    is_section?: boolean;
+    is_editable?: boolean;
+    is_default?: boolean;
+    metadata?: Record<string, any>;
+    tags?: Array<string>;
+    start_at?: string | null;
+    expires_at?: string | null;
+    access_type?: AccessTypeEnum;
+    thumbnail_url?: string | null;
+    readonly template: MiniCanvas;
+    readonly sections: Array<CanvasSection>;
+    readonly shared_link: MiniSharedLink;
+    account?: Account | null;
+    readonly events: Array<MiniEvent>;
+    readonly owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

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

@@ -0,0 +1,22 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { AccountRequest } from './AccountRequest';
+
+export type CanvasUpdateRequest = {
+    name: string;
+    content?: Record<string, any>;
+    context?: Record<string, any>;
+    theme?: Record<string, any> | null;
+    is_draft?: boolean;
+    is_template?: boolean;
+    is_section?: boolean;
+    is_editable?: boolean;
+    is_default?: boolean;
+    metadata?: Record<string, any>;
+    tags?: Array<string>;
+    start_at?: string | null;
+    expires_at?: string | null;
+    access_type?: AccessTypeEnum;
+    thumbnail_url?: string | null;
+    account?: AccountRequest | null;
+    owned_by_id?: number | null;
+};

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

@@ -0,0 +1,16 @@
+import { CollaborationRoleEnum } from './CollaborationRoleEnum';
+import { MiniCanvas } from './MiniCanvas';
+import { MiniContentDistributionGroup } from './MiniContentDistributionGroup';
+import { MiniFile } from './MiniFile';
+import { MiniFolder } from './MiniFolder';
+import { MiniUser } from './MiniUser';
+
+export type Collaboration = {
+    readonly id: number;
+    readonly file: MiniFile;
+    readonly folder: MiniFolder;
+    readonly canvas: MiniCanvas;
+    readonly user: MiniUser;
+    readonly content_distribution_group: MiniContentDistributionGroup;
+    role?: CollaborationRoleEnum;
+};

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

@@ -0,0 +1,16 @@
+import { CollaborationRoleEnum } from './CollaborationRoleEnum';
+import { MiniCanvas } from './MiniCanvas';
+import { MiniContentDistributionGroup } from './MiniContentDistributionGroup';
+import { MiniFile } from './MiniFile';
+import { MiniFolder } from './MiniFolder';
+import { MiniUser } from './MiniUser';
+
+export type CollaborationCreate = {
+    readonly id: number;
+    readonly file: MiniFile;
+    readonly folder: MiniFolder;
+    readonly canvas: MiniCanvas;
+    readonly user: MiniUser;
+    readonly content_distribution_group: MiniContentDistributionGroup;
+    role?: CollaborationRoleEnum;
+};

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

@@ -0,0 +1,10 @@
+import { CollaborationRoleEnum } from './CollaborationRoleEnum';
+
+export type CollaborationCreateRequest = {
+    role?: CollaborationRoleEnum;
+    file_id?: string;
+    folder_id?: string;
+    canvas_id?: string;
+    user_id?: number | null;
+    content_distribution_group_id?: string | null;
+};

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

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

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

@@ -0,0 +1,4 @@
+export declare enum CollaborationRoleEnum {
+    VIEWER = "viewer",
+    EDITOR = "editor"
+}

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

@@ -0,0 +1,9 @@
+export type ConnectedService = {
+    connection_id: string;
+    type: string;
+    name: string;
+    provider: string;
+    access_token?: string;
+    user_id?: string;
+    urls?: Record<string, string>;
+};

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

@@ -0,0 +1,12 @@
+import { MiniUser } from './MiniUser';
+
+export type ContentDistributionGroup = {
+    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/ContentDistributionGroupCreate.d.ts

@@ -0,0 +1,13 @@
+import { MiniUser } from './MiniUser';
+
+export type ContentDistributionGroupCreate = {
+    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;
+};

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

@@ -0,0 +1,5 @@
+export type ContentDistributionGroupCreateRequest = {
+    name: string;
+    auto_add_new_users?: boolean;
+    instance_id: string;
+};

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,16 @@
+/**
+ * * `7` - 7 days
+ * * `30` - 30 days
+ * * `60` - 60 days
+ * * `90` - 90 days
+ * * `custom` - Custom
+ * * `none` - None
+ */
+export declare enum DefaultExpiresAtEnum {
+    _7 = "7",
+    _30 = "30",
+    _60 = "60",
+    _90 = "90",
+    CUSTOM = "custom",
+    NONE = "none"
+}

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

@@ -0,0 +1,23 @@
+import { AppOrganization } from './AppOrganization';
+import { AppTypeEnum } from './AppTypeEnum';
+import { MiniUser } from './MiniUser';
+
+export type DeletedApp = {
+    readonly id: number;
+    readonly uid: string;
+    name: string;
+    type: AppTypeEnum;
+    readonly organization: AppOrganization;
+    description?: string | null;
+    display_name?: string | null;
+    readonly latest_version: string | null;
+    logo?: string | null;
+    readonly is_published: 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/DeletedCanvas.d.ts

@@ -0,0 +1,31 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { Account } from './Account';
+import { MiniCanvas } from './MiniCanvas';
+import { MiniSharedLink } from './MiniSharedLink';
+import { MiniUser } from './MiniUser';
+
+export type DeletedCanvas = {
+    readonly id: string;
+    name: string;
+    is_draft?: boolean;
+    is_template?: boolean;
+    is_section?: boolean;
+    is_editable?: boolean;
+    is_default?: boolean;
+    metadata?: Record<string, any>;
+    tags?: Array<string>;
+    start_at?: string | null;
+    expires_at?: string | null;
+    access_type?: AccessTypeEnum;
+    thumbnail_url?: string | null;
+    readonly template: MiniCanvas;
+    readonly shared_link: MiniSharedLink;
+    account?: Account | null;
+    readonly owned_by: MiniUser;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+    readonly deleted_at: string | null;
+    deleted_by?: number | null;
+};

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

@@ -0,0 +1,15 @@
+import { MiniUser } from './MiniUser';
+
+export type DeletedContentDistributionGroup = {
+    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/DeletedEnvironment.d.ts

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

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

@@ -0,0 +1,20 @@
+import { FavoriteFile } from './FavoriteFile';
+import { MiniFolder } from './MiniFolder';
+import { MiniPage } from './MiniPage';
+import { MiniUser } from './MiniUser';
+
+export type DeletedFavorite = {
+    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;
+    readonly deleted_at: string;
+    readonly deleted_by: MiniUser;
+};

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

@@ -0,0 +1,48 @@
+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 DeletedFile = {
+    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;
+    readonly deleted_at: string;
+    readonly deleted_by: MiniUser;
+};

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

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