@unofficialbox/box-open-sdk 0.3.1 → 0.4.1

package/dist/types/models/schemas/files.d.ts

@@ -0,0 +1,27 @@
+import type { AttributesParent, CommentItem, LockType, PutIdParent, PutIdSharedLink } from '../schemas.js';
+export interface PutIdLock {
+    access?: LockType;
+    expires_at?: string;
+    is_download_prevented?: boolean;
+}
+export type PermissionsCanDownload = "open" | "company" | (string & {});
+export interface PutIdPermissions {
+    can_download?: PermissionsCanDownload;
+}
+export interface UpdateFileRequest {
+    name?: string;
+    description?: string;
+    parent?: PutIdParent;
+    shared_link?: PutIdSharedLink | null;
+    lock?: PutIdLock | null;
+    disposition_at?: string;
+    permissions?: PutIdPermissions;
+    collections?: Array<CommentItem> | null;
+    tags?: Array<string>;
+}
+export interface CopyFileRequest {
+    name?: string;
+    version?: string;
+    parent: AttributesParent;
+}
+export type GetIdThumbnailIdExtension = "png" | "jpg" | (string & {});

package/dist/types/models/schemas/folder_locks.d.ts

@@ -0,0 +1,27 @@
+import type { FolderMini, UserBase } from '../schemas.js';
+export interface FolderLock {
+    folder?: FolderMini;
+    id?: string;
+    type?: string;
+    created_by?: UserBase;
+    created_at?: string;
+    locked_operations?: FolderLockLockedOperations;
+    lock_type?: string;
+}
+export interface FolderLocks {
+    entries?: Array<FolderLock>;
+    limit?: string;
+    next_marker?: string | null;
+}
+export interface FolderLockLockedOperations {
+    move: boolean;
+    delete: boolean;
+}
+export interface PostFolder {
+    type: string;
+    id: string;
+}
+export interface CreateFolderLockRequest {
+    locked_operations?: FolderLockLockedOperations;
+    folder: PostFolder;
+}

package/dist/types/models/schemas/folders.d.ts

@@ -0,0 +1,28 @@
+import type { AttributesParent, CommentItem, FolderFullSyncState, FolderUploadEmailAccess, PutIdParent, PutIdSharedLink } from '../schemas.js';
+export type GetIdSort = "id" | "name" | "date" | "size" | (string & {});
+export interface PutIdFolderUploadEmail {
+    access?: FolderUploadEmailAccess;
+}
+export interface UpdateFolderRequest {
+    name?: string;
+    description?: string;
+    sync_state?: FolderFullSyncState;
+    can_non_owners_invite?: boolean;
+    parent?: PutIdParent;
+    shared_link?: PutIdSharedLink;
+    folder_upload_email?: PutIdFolderUploadEmail | null;
+    tags?: Array<string>;
+    is_collaboration_restricted_to_enterprise?: boolean;
+    collections?: Array<CommentItem> | null;
+    can_non_owners_view_collaborators?: boolean;
+}
+export interface CreateFolderRequest {
+    name: string;
+    parent: AttributesParent;
+    folder_upload_email?: PutIdFolderUploadEmail;
+    sync_state?: FolderFullSyncState;
+}
+export interface CopyFolderRequest {
+    name?: string;
+    parent: AttributesParent;
+}

package/dist/types/models/schemas/groups.d.ts

@@ -0,0 +1,42 @@
+import type { CollectionsOrder, GroupGroupType, GroupType } from '../schemas.js';
+export interface GroupFull {
+    id: string;
+    type: GroupType;
+    name?: string;
+    group_type?: GroupGroupType;
+    created_at?: string;
+    modified_at?: string;
+    provenance?: string;
+    external_sync_identifier?: string;
+    description?: string;
+    invitability_level?: GroupFullInvitabilityLevel;
+    member_viewability_level?: GroupFullInvitabilityLevel;
+    permissions?: GroupFullPermissions;
+}
+export interface Groups {
+    total_count?: number;
+    limit?: number;
+    offset?: number;
+    order?: Array<CollectionsOrder>;
+    entries?: Array<GroupFull>;
+}
+export type GroupFullInvitabilityLevel = "admins_only" | "admins_and_members" | "all_managed_users" | (string & {});
+export interface GroupFullPermissions {
+    can_invite_as_collaborator?: boolean;
+}
+export interface CreateGroupRequest {
+    name: string;
+    provenance?: string;
+    external_sync_identifier?: string;
+    description?: string;
+    invitability_level?: GroupFullInvitabilityLevel;
+    member_viewability_level?: GroupFullInvitabilityLevel;
+}
+export interface UpdateGroupRequest {
+    name?: string;
+    provenance?: string;
+    external_sync_identifier?: string;
+    description?: string;
+    invitability_level?: GroupFullInvitabilityLevel;
+    member_viewability_level?: GroupFullInvitabilityLevel;
+}

package/dist/types/models/schemas/hub_collaborations.d.ts

@@ -0,0 +1,57 @@
+import type { AcceptanceRequirementsStatusStrongPasswordRequirement, AcceptanceRequirementsStatusTermsOfServiceRequirement, AcceptanceRequirementsStatusTwoFactorAuthenticationRequirement, GroupMini, HubCollaborationUserType, HubType } from '../schemas.js';
+export interface HubBase {
+    id: string;
+    type: HubType;
+}
+export type HubAccessGrantee = (HubCollaborationUser & {
+    type: "user";
+}) | (GroupMini & {
+    type: "group";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface HubCollaboration {
+    id: string;
+    type: HubCollaborationType;
+    hub?: HubBase;
+    accessible_by?: HubAccessGrantee;
+    role?: string;
+    status?: HubCollaborationStatus;
+    acceptance_requirements_status?: HubCollaborationAcceptanceRequirementsStatus;
+}
+export interface HubCollaborationCreateRequest {
+    hub: HubCollaborationCreateRequestHub;
+    accessible_by: HubCollaborationCreateRequestAccessibleBy;
+    role: string;
+}
+export interface HubCollaborations {
+    entries?: Array<HubCollaboration>;
+    limit?: number;
+    next_marker?: string | null;
+}
+export interface HubCollaborationUpdateRequest {
+    role?: string;
+}
+export interface HubCollaborationUser {
+    id: string;
+    type: HubCollaborationUserType;
+    name?: string;
+    login?: string;
+}
+export type HubCollaborationType = "hub_collaboration" | (string & {});
+export type HubCollaborationStatus = "accepted" | "pending" | "rejected" | (string & {});
+export interface HubCollaborationAcceptanceRequirementsStatus {
+    terms_of_service_requirement?: AcceptanceRequirementsStatusTermsOfServiceRequirement;
+    strong_password_requirement?: AcceptanceRequirementsStatusStrongPasswordRequirement;
+    two_factor_authentication_requirement?: AcceptanceRequirementsStatusTwoFactorAuthenticationRequirement;
+}
+export interface HubCollaborationCreateRequestHub {
+    type: HubType;
+    id: string;
+}
+export interface HubCollaborationCreateRequestAccessibleBy {
+    type: string;
+    id?: string;
+    login?: string;
+}

package/dist/types/models/schemas/hub_document.d.ts

@@ -0,0 +1,67 @@
+export interface HubCalloutBoxTextBlock {
+    id: string;
+    parent_id?: string | null;
+    type: HubCalloutBoxTextBlockType;
+    fragment: string;
+}
+export interface HubDividerBlock {
+    id: string;
+    parent_id?: string | null;
+    type: HubDividerBlockType;
+}
+export type HubDocumentBlockEntry = (HubParagraphTextBlock & {
+    type: "paragraph";
+}) | (HubSectionTitleTextBlock & {
+    type: "section_title";
+}) | (HubCalloutBoxTextBlock & {
+    type: "callout_box";
+}) | (HubItemListBlock & {
+    type: "item_list";
+}) | (HubDividerBlock & {
+    type: "divider";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface HubDocumentBlocks {
+    entries: Array<HubDocumentBlockEntry>;
+    type: HubDocumentBlocksType;
+    limit?: number;
+    next_marker?: string | null;
+}
+export interface HubDocumentPage {
+    id: string;
+    type: string;
+    parent_id?: string | null;
+    title_fragment: string;
+}
+export interface HubDocumentPages {
+    entries: Array<HubDocumentPage>;
+    type: HubDocumentPagesType;
+    limit?: number;
+    next_marker?: string | null;
+}
+export interface HubItemListBlock {
+    id: string;
+    parent_id?: string | null;
+    type: HubItemListBlockType;
+}
+export interface HubParagraphTextBlock {
+    id: string;
+    parent_id?: string | null;
+    type: HubParagraphTextBlockType;
+    fragment: string;
+}
+export interface HubSectionTitleTextBlock {
+    id: string;
+    parent_id?: string | null;
+    type: HubSectionTitleTextBlockType;
+    fragment: string;
+}
+export type HubCalloutBoxTextBlockType = "callout_box" | (string & {});
+export type HubDividerBlockType = "divider" | (string & {});
+export type HubDocumentBlocksType = "document_blocks" | (string & {});
+export type HubDocumentPagesType = "document_pages" | (string & {});
+export type HubItemListBlockType = "item_list" | (string & {});
+export type HubParagraphTextBlockType = "paragraph" | (string & {});
+export type HubSectionTitleTextBlockType = "section_title" | (string & {});

package/dist/types/models/schemas/hub_items.d.ts

@@ -0,0 +1,46 @@
+import type { FileReference, FolderReference } from '../schemas.js';
+export interface HubItem {
+    id: string;
+    type: HubItemType;
+    name: string;
+}
+export interface HubItemOperation {
+    action: HubItemOperationAction;
+    item: HubItemReference;
+    parent_id?: string;
+}
+export interface HubItemOperationResult {
+    action?: string;
+    item?: HubItemReference;
+    parent_id?: string;
+    status?: number;
+    error?: string;
+}
+export type HubItemReference = (FileReference & {
+    type: "file";
+}) | (FolderReference & {
+    type: "folder";
+}) | (WeblinkReference & {
+    type: "web_link";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface HubItems {
+    entries?: Array<HubItem>;
+    limit?: number;
+    next_marker?: string | null;
+}
+export interface HubItemsManageRequest {
+    operations?: Array<HubItemOperation>;
+}
+export interface HubItemsManageResponse {
+    operations: Array<HubItemOperationResult>;
+}
+export interface WeblinkReference {
+    type: WeblinkReferenceType;
+    id: string;
+}
+export type HubItemType = "file" | "folder" | "web_link" | (string & {});
+export type HubItemOperationAction = "add" | "remove" | (string & {});
+export type WeblinkReferenceType = "web_link" | (string & {});

package/dist/types/models/schemas/hubs.d.ts

@@ -0,0 +1,43 @@
+import type { HubType, UserMini } from '../schemas.js';
+export interface Hub {
+    id: string;
+    type: HubType;
+    title?: string;
+    description?: string;
+    created_at?: string;
+    updated_at?: string;
+    created_by?: UserMini;
+    updated_by?: UserMini;
+    view_count?: number;
+    is_ai_enabled?: boolean;
+    is_collaboration_restricted_to_enterprise?: boolean;
+    can_non_owners_invite?: boolean;
+    can_shared_link_be_created?: boolean;
+    can_public_shared_link_be_created?: boolean;
+    copy_hub_access?: HubCopyHubAccess;
+}
+export interface HubCopyRequest {
+    title?: string;
+    description?: string;
+    include_items?: boolean;
+}
+export interface HubCreateRequest {
+    title: string;
+    description?: string;
+}
+export interface Hubs {
+    entries?: Array<Hub>;
+    limit?: number;
+    next_marker?: string | null;
+}
+export interface HubUpdateRequest {
+    title?: string;
+    description?: string;
+    is_ai_enabled?: boolean;
+    is_collaboration_restricted_to_enterprise?: boolean;
+    can_non_owners_invite?: boolean;
+    can_shared_link_be_created?: boolean;
+    can_public_shared_link_be_created?: boolean;
+    copy_hub_access?: HubCopyHubAccess;
+}
+export type HubCopyHubAccess = "all" | "company" | "none" | (string & {});

package/dist/types/models/schemas/integration_mappings.d.ts

@@ -0,0 +1,83 @@
+import type { FolderMini, FolderReference, FolderType, VariableValueType } from '../schemas.js';
+export interface IntegrationMapping {
+    id: string;
+    type: IntegrationMappingType;
+    integration_type?: IntegrationMappingIntegrationType;
+    is_manually_created?: boolean;
+    options?: IntegrationMappingSlackOptions;
+    created_by?: UserIntegrationMappings;
+    modified_by?: UserIntegrationMappings;
+    partner_item: IntegrationMappingPartnerItemSlack;
+    box_item: FolderMini;
+    created_at?: string;
+    modified_at?: string;
+}
+export interface IntegrationMappingBoxItemSlack {
+    type: FolderType;
+    id: string;
+}
+export interface IntegrationMappingPartnerItemSlack {
+    type: IntegrationMappingPartnerItemSlackType;
+    id: string;
+    slack_workspace_id?: string | null;
+    slack_org_id?: string | null;
+}
+export interface IntegrationMappingPartnerItemTeams {
+    type: IntegrationMappingPartnerItemTeamsType;
+    id: string;
+    tenant_id: string;
+}
+export interface IntegrationMappingPartnerItemTeamsCreateRequest {
+    type: IntegrationMappingPartnerItemTeamsType;
+    id: string;
+    tenant_id: string;
+    team_id: string;
+}
+export interface IntegrationMappings {
+    limit?: number;
+    next_marker?: string | null;
+    entries?: Array<IntegrationMapping>;
+}
+export interface IntegrationMappingSlackCreateRequest {
+    partner_item: IntegrationMappingPartnerItemSlack;
+    box_item: IntegrationMappingBoxItemSlack;
+    options?: IntegrationMappingSlackOptions;
+}
+export interface IntegrationMappingSlackOptions {
+    is_access_management_disabled?: boolean;
+}
+export interface IntegrationMappingsTeams {
+    entries?: Array<IntegrationMappingTeams>;
+}
+export interface IntegrationMappingTeams {
+    id: string;
+    type: IntegrationMappingType;
+    integration_type?: IntegrationMappingTeamsIntegrationType;
+    is_overridden_by_manual_mapping?: boolean;
+    partner_item: IntegrationMappingPartnerItemTeams;
+    box_item: FolderReference;
+    created_at?: string;
+    modified_at?: string;
+}
+export interface IntegrationMappingTeamsCreateRequest {
+    partner_item: IntegrationMappingPartnerItemTeamsCreateRequest;
+    box_item: FolderReference;
+}
+export interface UserIntegrationMappings {
+    id: string;
+    type: VariableValueType;
+    name?: string;
+    login?: string;
+}
+export type IntegrationMappingType = "integration_mapping" | (string & {});
+export type IntegrationMappingIntegrationType = "slack" | (string & {});
+export type IntegrationMappingPartnerItemSlackType = "channel" | (string & {});
+export type IntegrationMappingPartnerItemTeamsType = "channel" | "team" | (string & {});
+export type IntegrationMappingTeamsIntegrationType = "teams" | (string & {});
+export interface UpdateSlackRequest {
+    box_item?: IntegrationMappingBoxItemSlack;
+    options?: IntegrationMappingSlackOptions;
+}
+export interface UpdateTeamRequest {
+    box_item?: FolderReference;
+}

package/dist/types/models/schemas/invites.d.ts

@@ -0,0 +1,19 @@
+import type { AttributesParent, CollaborationAllowlistEntryEnterprise, UserMini } from '../schemas.js';
+export interface Invite {
+    id: string;
+    type: InviteType;
+    invited_to?: CollaborationAllowlistEntryEnterprise;
+    actionable_by?: UserMini;
+    invited_by?: UserMini;
+    status?: string;
+    created_at?: string;
+    modified_at?: string;
+}
+export type InviteType = "invite" | (string & {});
+export interface PostActionableBy {
+    login?: string;
+}
+export interface CreateInviteRequest {
+    enterprise: AttributesParent;
+    actionable_by: PostActionableBy;
+}

package/dist/types/models/schemas/legal_hold_policies.d.ts

@@ -0,0 +1,43 @@
+import type { LegalHoldPolicyType, UserMini } from '../schemas.js';
+export interface LegalHoldPolicies {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<LegalHoldPolicy>;
+}
+export interface LegalHoldPolicy {
+    id: string;
+    type: LegalHoldPolicyType;
+    policy_name?: string;
+    description?: string;
+    status?: LegalHoldPolicyStatus;
+    assignment_counts?: LegalHoldPolicyAssignmentCounts;
+    created_by?: UserMini;
+    created_at?: string;
+    modified_at?: string;
+    deleted_at?: string;
+    filter_started_at?: string;
+    filter_ended_at?: string;
+    release_notes?: string;
+}
+export type LegalHoldPolicyStatus = "active" | "applying" | "releasing" | "released" | (string & {});
+export interface LegalHoldPolicyAssignmentCounts {
+    user?: number;
+    folder?: number;
+    file?: number;
+    file_version?: number;
+    ownership?: number;
+    interactions?: number;
+}
+export interface CreateLegalHoldPolicyRequest {
+    policy_name: string;
+    description?: string;
+    filter_started_at?: string;
+    filter_ended_at?: string;
+    is_ongoing?: boolean;
+}
+export interface UpdateLegalHoldPolicyRequest {
+    policy_name?: string;
+    description?: string;
+    release_notes?: string;
+}

package/dist/types/models/schemas/legal_hold_policy_assignments.d.ts

@@ -0,0 +1,43 @@
+import type { FileMini, FileVersionType, LegalHoldPolicyAssignedItemType, LegalHoldPolicyAssignment, UserMini } from '../schemas.js';
+export interface FilesOnHold {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<FileMini>;
+}
+export interface FileVersion {
+    id: string;
+    type: FileVersionType;
+    sha1?: string;
+    name?: string;
+    size?: number;
+    created_at?: string;
+    modified_at?: string;
+    modified_by?: UserMini;
+    trashed_at?: string | null;
+    trashed_by?: UserMini;
+    restored_at?: string | null;
+    restored_by?: UserMini;
+    purged_at?: string | null;
+    uploader_display_name?: string;
+}
+export interface FileVersionsOnHold {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<FileVersion>;
+}
+export interface LegalHoldPolicyAssignments {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<LegalHoldPolicyAssignment>;
+}
+export interface CreateLegalHoldPolicyAssignmentRequestAssignTo {
+    type: LegalHoldPolicyAssignedItemType;
+    id: string;
+}
+export interface CreateLegalHoldPolicyAssignmentRequest {
+    policy_id: string;
+    assign_to: CreateLegalHoldPolicyAssignmentRequestAssignTo;
+}

package/dist/types/models/schemas/list_collaborations.d.ts

@@ -0,0 +1,14 @@
+import type { Collaboration } from '../schemas.js';
+export interface Collaborations {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<Collaboration>;
+}
+export interface CollaborationsOffsetPaginated {
+    total_count?: number;
+    limit?: number;
+    offset?: number;
+    entries?: Array<Collaboration>;
+}
+export type GetCollaborationsStatus = "pending" | (string & {});

package/dist/types/models/schemas/memberships.d.ts

@@ -0,0 +1,29 @@
+import type { AttributesParent, CollectionsOrder, GroupMini, UserMini } from '../schemas.js';
+export interface GroupMembership {
+    id?: string;
+    type?: GroupMembershipType;
+    user?: UserMini;
+    group?: GroupMini;
+    role?: GroupMembershipRole;
+    created_at?: string;
+    modified_at?: string;
+}
+export interface GroupMemberships {
+    total_count?: number;
+    limit?: number;
+    offset?: number;
+    order?: Array<CollectionsOrder>;
+    entries?: Array<GroupMembership>;
+}
+export type GroupMembershipType = "group_membership" | (string & {});
+export type GroupMembershipRole = "member" | "admin" | (string & {});
+export interface CreateGroupMembershipRequest {
+    user: AttributesParent;
+    group: AttributesParent;
+    role?: GroupMembershipRole;
+    configurable_permissions?: Record<string, boolean> | null;
+}
+export interface UpdateGroupMembershipRequest {
+    role?: GroupMembershipRole;
+    configurable_permissions?: Record<string, boolean> | null;
+}

package/dist/types/models/schemas/metadata_cascade_policies.d.ts

@@ -0,0 +1,29 @@
+import type { EnterpriseType, GetFileIdMetadataIdScope, MetadataCascadePolicyParent } from '../schemas.js';
+export interface MetadataCascadePolicies {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<MetadataCascadePolicy>;
+}
+export interface MetadataCascadePolicy {
+    id: string;
+    type: MetadataCascadePolicyType;
+    owner_enterprise?: MetadataCascadePolicyOwnerEnterprise;
+    parent?: MetadataCascadePolicyParent;
+    scope?: string;
+    templateKey?: string;
+}
+export type MetadataCascadePolicyType = "metadata_cascade_policy" | (string & {});
+export interface MetadataCascadePolicyOwnerEnterprise {
+    type?: EnterpriseType;
+    id?: string;
+}
+export interface CreateMetadataCascadePolicyRequest {
+    folder_id: string;
+    scope: GetFileIdMetadataIdScope;
+    templateKey: string;
+}
+export type PostIdApplyConflictResolution = "none" | "overwrite" | (string & {});
+export interface ApplyMetadataCascadePolicyRequest {
+    conflict_resolution: PostIdApplyConflictResolution;
+}

package/dist/types/models/schemas/metadata_taxonomies.d.ts

@@ -0,0 +1,60 @@
+export interface MetadataTaxonomies {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<MetadataTaxonomy>;
+}
+export interface MetadataTaxonomy {
+    id: string;
+    key?: string;
+    displayName: string;
+    namespace: string;
+    levels?: Array<MetadataTaxonomyLevel>;
+}
+export interface MetadataTaxonomyAncestor {
+    id?: string;
+    displayName?: string;
+    level?: number;
+}
+export interface MetadataTaxonomyLevel {
+    displayName?: string;
+    description?: string;
+    level?: number;
+}
+export interface MetadataTaxonomyLevels {
+    entries?: Array<MetadataTaxonomyLevel>;
+}
+export interface MetadataTaxonomyNode {
+    id: string;
+    displayName: string;
+    level: number;
+    parentId?: string;
+    nodePath?: Array<string>;
+    ancestors?: Array<MetadataTaxonomyAncestor>;
+}
+export interface MetadataTaxonomyNodes {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<MetadataTaxonomyNode>;
+}
+export interface CreateMetadataTaxonomyRequest {
+    key?: string;
+    displayName: string;
+    namespace: string;
+}
+export interface UpdateMetadataTaxonomyRequest {
+    displayName: string;
+}
+export interface UpdateLevelRequest {
+    displayName: string;
+    description?: string;
+}
+export interface CreateNodesRequest {
+    displayName: string;
+    level: number;
+    parentId?: string;
+}
+export interface UpdateNodeRequest {
+    displayName?: string;
+}