@unofficialbox/box-open-sdk 0.4.0 → 0.4.2

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;
+}

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

@@ -0,0 +1,71 @@
+import type { FieldsOptions, MetadataTemplateType } from '../schemas.js';
+export interface MetadataTemplate {
+    id: string;
+    type: MetadataTemplateType;
+    scope?: string;
+    templateKey?: string;
+    displayName?: string;
+    hidden?: boolean;
+    fields?: Array<MetadataTemplateFields>;
+    copyInstanceOnItemCopy?: boolean;
+}
+export interface MetadataTemplates {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<MetadataTemplate>;
+}
+export type MetadataTemplateFieldsType = "string" | "float" | "date" | "enum" | "multiSelect" | "taxonomy" | "integer" | (string & {});
+export interface MetadataTemplateFieldsOptions {
+    key: string;
+    id?: string;
+}
+export interface FieldsOptionsRules {
+    multiSelect?: boolean;
+    selectableLevels?: Array<number>;
+}
+export interface MetadataTemplateFields {
+    type: MetadataTemplateFieldsType;
+    key: string;
+    displayName: string;
+    description?: string;
+    hidden?: boolean;
+    options?: Array<MetadataTemplateFieldsOptions>;
+    taxonomyKey?: string;
+    taxonomyId?: string;
+    namespace?: string;
+    optionsRules?: FieldsOptionsRules;
+    id?: string;
+}
+export type PutIdSchemaOp = "editTemplate" | "addField" | "reorderFields" | "addEnumOption" | "reorderEnumOptions" | "reorderMultiSelectOptions" | "addMultiSelectOption" | "editField" | "removeField" | "editEnumOption" | "removeEnumOption" | "editMultiSelectOption" | "removeMultiSelectOption" | (string & {});
+export interface UpdateSchemaRequest {
+    op: PutIdSchemaOp;
+    data?: Record<string, unknown>;
+    fieldKey?: string;
+    fieldKeys?: Array<string>;
+    enumOptionKey?: string;
+    enumOptionKeys?: Array<string>;
+    multiSelectOptionKey?: string;
+    multiSelectOptionKeys?: Array<string>;
+}
+export type CreateSchemaRequestFieldsType = "string" | "float" | "date" | "enum" | "multiSelect" | "taxonomy" | (string & {});
+export interface PostSchemaFields {
+    type: CreateSchemaRequestFieldsType;
+    key: string;
+    displayName: string;
+    description?: string;
+    hidden?: boolean;
+    options?: Array<FieldsOptions>;
+    taxonomyKey?: string;
+    taxonomyId?: string;
+    namespace?: string;
+    optionsRules?: FieldsOptionsRules;
+}
+export interface CreateSchemaRequest {
+    scope: string;
+    templateKey?: string;
+    displayName: string;
+    hidden?: boolean;
+    fields?: Array<PostSchemaFields>;
+    copyInstanceOnItemCopy?: boolean;
+}

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

@@ -0,0 +1,13 @@
+import type { FolderReference } from '../schemas.js';
+export interface NotesConvertRequestBody {
+    content: string;
+    content_format: NotesConvertRequestBodyContentFormat;
+    parent: FolderReference;
+    name: string;
+}
+export interface NotesConvertResponse {
+    type: NotesConvertResponseType;
+    id: string;
+}
+export type NotesConvertRequestBodyContentFormat = "markdown" | (string & {});
+export type NotesConvertResponseType = "file" | (string & {});

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

@@ -0,0 +1,62 @@
+export interface QueryAncestorReference {
+    id: string;
+    type: string;
+}
+export interface QueryInsightEntry {
+    key: Array<string>;
+    type: QueryInsightEntryType;
+    metrics: Record<string, QueryInsightMetricResult>;
+}
+export interface QueryInsightMetricResult {
+    type: string;
+    values: Record<string, number>;
+}
+export interface QueryInsights {
+    insights: Array<QueryInsightEntry>;
+}
+export interface QueryInsightsGroupBy {
+    field: string;
+    bucket_limit?: number;
+}
+export interface QueryInsightsMetricDefinition {
+    type: QueryInsightsMetricDefinitionType;
+    field: string;
+}
+export interface QueryInsightsRequestBody {
+    query: QueryInsightsRequestBodyQuery;
+    metrics: Record<string, QueryInsightsMetricDefinition>;
+}
+export interface QueryOrderBy {
+    field_key: string;
+    direction: QueryOrderByDirection;
+}
+export interface QueryRequestBody {
+    query: QueryRequestBodyQuery;
+    order_by?: Array<QueryOrderBy>;
+    limit?: number;
+    fields?: Array<string>;
+    marker?: string;
+}
+export type QueryResultEntry = {
+    id: string;
+    type: string;
+} & Record<string, unknown>;
+export interface QueryResults {
+    entries: Array<QueryResultEntry>;
+    next_marker: string | null;
+    limit: number;
+}
+export type QueryInsightEntryType = "group" | "overall" | "other" | (string & {});
+export type QueryInsightsMetricDefinitionType = "sum" | "avg" | "min" | "max" | "count" | (string & {});
+export interface QueryInsightsRequestBodyQuery {
+    predicate: string;
+    params?: Record<string, unknown>;
+    ancestors?: Array<QueryAncestorReference>;
+    group_by?: Array<QueryInsightsGroupBy>;
+}
+export type QueryOrderByDirection = "asc" | "desc" | (string & {});
+export interface QueryRequestBodyQuery {
+    predicate: string;
+    params?: Record<string, unknown>;
+    ancestors?: Array<QueryAncestorReference>;
+}

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

@@ -0,0 +1,25 @@
+import type { FileFull, FolderFull, WebLink } from '../schemas.js';
+export interface RecentItem {
+    type?: string;
+    item?: RecentItemResource;
+    interaction_type?: RecentItemInteractionType;
+    interacted_at?: string;
+    interaction_shared_link?: string;
+}
+export type RecentItemResource = (FileFull & {
+    type: "file";
+}) | (FolderFull & {
+    type: "folder";
+}) | (WebLink & {
+    type: "web_link";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface RecentItems {
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+    entries?: Array<RecentItem>;
+}
+export type RecentItemInteractionType = "item_preview" | "item_upload" | "item_comment" | "item_open" | "item_modify" | (string & {});