@unofficialbox/box-open-sdk 0.4.3 → 0.5.0

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

@@ -0,0 +1,436 @@
+import type { UserBase } from '../schemas.js';
+export interface ShuttleAgentCredentials {
+    registration_token: string;
+    expires_at: string;
+}
+export interface ShuttleDiscoveredSubject {
+    id: string;
+    type: ShuttleDiscoveredSubjectType;
+    job_id: string;
+    revision: number;
+    source: ShuttleSubject;
+    suggested_target?: ShuttleTargetSubject | null;
+}
+export interface ShuttleDiscoveredSubjects {
+    entries: Array<ShuttleDiscoveredSubject>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export interface ShuttleJob {
+    id: string;
+    type: ShuttleJobType;
+    name: string;
+    comment?: string | null;
+    job_type: ShuttleJobJobType;
+    state: string;
+    mapping_state: string;
+    source_system: ShuttleJobSourceSystem;
+    account_mapping?: ShuttleJobAccountMapping;
+    tags?: Array<string>;
+    settings?: ShuttleJobSettings;
+}
+export interface ShuttleJobCreateRequest {
+    name: string;
+    job_type: ShuttleJobJobType;
+    source_system_id: string;
+    comment?: string;
+    tags?: Array<string>;
+    account_mapping?: ShuttleJobCreateRequestAccountMapping;
+    settings?: ShuttleJobSettings;
+}
+export type ShuttleJobPermissionConflictStrategy = "preserve_structure_restrict_sharing" | "preserve_structure_expand_sharing" | "preserve_sharing_modify_structure" | "warn_permissions_conflicts" | (string & {});
+export interface ShuttleJobs {
+    entries: Array<ShuttleJob>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export interface ShuttleJobSchedule {
+    id: string;
+    type: ShuttleJobScheduleType;
+    job_id: string;
+    state: ShuttleJobScheduleState;
+    run_mode: ShuttleJobScheduleRunMode;
+    description?: string | null;
+    last_attempt_at?: string | null;
+    trigger: ShuttleJobScheduleTrigger;
+}
+export interface ShuttleJobScheduleCreateRequest {
+    job_id: string;
+    run_mode: ShuttleJobScheduleRunMode;
+    state?: ShuttleJobScheduleState;
+    description?: string | null;
+    trigger: ShuttleJobScheduleTrigger;
+}
+export interface ShuttleJobSchedules {
+    entries: Array<ShuttleJobSchedule>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export type ShuttleJobScheduleTrigger = (ShuttleJobScheduleTriggerByTime & {
+    type: "by_time";
+}) | (ShuttleJobScheduleTriggerByJob & {
+    type: "by_job";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface ShuttleJobScheduleTriggerByJob {
+    type: ShuttleJobScheduleTriggerByJobType;
+    triggered_by_job_id: string;
+    last_run_condition: ShuttleJobScheduleTriggerByJobLastRunCondition;
+}
+export interface ShuttleJobScheduleTriggerByTime {
+    type: ShuttleJobScheduleTriggerByTimeType;
+    start_at: string;
+    time_zone: string;
+    repeat: ShuttleJobScheduleTriggerByTimeRepeat;
+}
+export interface ShuttleJobScheduleUpdateRequest {
+    state?: ShuttleJobScheduleState;
+    run_mode?: ShuttleJobScheduleRunMode;
+    description?: string | null;
+    trigger?: ShuttleJobScheduleTrigger;
+}
+export interface ShuttleJobStartRequest {
+    mode?: ShuttleJobStartRequestMode;
+}
+export interface ShuttleJobUpdateRequest {
+    name?: string;
+    comment?: string | null;
+    tags?: Array<string>;
+    account_mapping?: ShuttleJobCreateRequestAccountMapping;
+    settings?: ShuttleJobSettings;
+}
+export interface ShuttleMappingError {
+    id: string;
+    type: ShuttleMappingErrorType;
+    job_id: string;
+    revision: number;
+    category: string;
+    path: string;
+    messages: Array<string>;
+}
+export interface ShuttleMappingErrors {
+    entries: Array<ShuttleMappingError>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export interface ShuttlePathEntries {
+    entries: Array<ShuttlePathEntry>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export interface ShuttlePathEntry {
+    id: string;
+    type: ShuttlePathEntryType;
+    name: string;
+    path: string;
+    path_id?: string | null;
+    parent_path?: string | null;
+    scope: ShuttlePathEntryScope;
+    is_directory: boolean;
+    can_map: boolean;
+}
+export interface ShuttlePathEntryAccountScope {
+    type: ShuttlePathEntryAccountScopeType;
+    id?: string | null;
+    email?: string | null;
+    name?: string | null;
+}
+export type ShuttlePathEntryScope = (ShuttlePathEntryAccountScope & {
+    type: "account";
+}) | (ShuttlePathEntrySharedSpaceScope & {
+    type: "shared_space";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface ShuttlePathEntrySharedSpaceScope {
+    type: ShuttlePathEntrySharedSpaceScopeType;
+    space?: string | null;
+}
+export interface ShuttlePathMapping {
+    id: string;
+    type: ShuttlePathMappingType;
+    job_id: string;
+    is_path_skipped: boolean;
+    source: ShuttlePathMappingLocation;
+    target?: ShuttlePathMappingLocation | null;
+}
+export interface ShuttlePathMappingAccount {
+    id?: string | null;
+    email?: string | null;
+    name?: string | null;
+}
+export interface ShuttlePathMappingAccountInput {
+    id?: string;
+    email?: string;
+}
+export interface ShuttlePathMappingAccountLocation {
+    type: ShuttlePathEntryAccountScopeType;
+    path: string;
+    path_id?: string | null;
+    account?: ShuttlePathMappingAccount;
+    is_directory?: boolean | null;
+}
+export interface ShuttlePathMappingAccountLocationInput {
+    type: ShuttlePathEntryAccountScopeType;
+    path: string;
+    path_id?: string;
+    account: ShuttlePathMappingAccountInput;
+    is_directory?: boolean;
+}
+export interface ShuttlePathMappingAccountLocationTargetInput {
+    type: ShuttlePathEntryAccountScopeType;
+    path: string;
+    path_id?: string;
+    account: ShuttlePathMappingAccountInput;
+}
+export interface ShuttlePathMappingCreateRequest {
+    job_id: string;
+    is_path_skipped?: boolean;
+    source: ShuttlePathMappingLocationInput;
+    target?: ShuttlePathMappingTargetLocationInput | null;
+}
+export interface ShuttlePathMappingImportCreateRequest {
+    job_id: string;
+    file_id: string;
+}
+export type ShuttlePathMappingLocation = (ShuttlePathMappingAccountLocation & {
+    type: "account";
+}) | (ShuttlePathMappingSharedSpaceLocation & {
+    type: "shared_space";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export type ShuttlePathMappingLocationInput = (ShuttlePathMappingAccountLocationInput & {
+    type: "account";
+}) | (ShuttlePathMappingSharedSpaceLocationInput & {
+    type: "shared_space";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface ShuttlePathMappings {
+    entries: Array<ShuttlePathMapping>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export interface ShuttlePathMappingSharedSpaceLocation {
+    type: ShuttlePathEntrySharedSpaceScopeType;
+    space?: string | null;
+    path: string;
+    path_id?: string | null;
+    is_directory?: boolean | null;
+}
+export interface ShuttlePathMappingSharedSpaceLocationInput {
+    type: ShuttlePathEntrySharedSpaceScopeType;
+    space?: string;
+    path: string;
+    path_id?: string;
+    is_directory?: boolean;
+}
+export interface ShuttlePathMappingSharedSpaceLocationTargetInput {
+    type: ShuttlePathEntrySharedSpaceScopeType;
+    space?: string;
+    path: string;
+    path_id?: string;
+}
+export type ShuttlePathMappingTargetLocationInput = (ShuttlePathMappingAccountLocationTargetInput & {
+    type: "account";
+}) | (ShuttlePathMappingSharedSpaceLocationTargetInput & {
+    type: "shared_space";
+}) | {
+    type: string;
+    [key: string]: unknown;
+};
+export interface ShuttlePathMappingUpdateRequest {
+    is_path_skipped?: boolean;
+    source?: ShuttlePathMappingLocationInput;
+    target?: ShuttlePathMappingTargetLocationInput | null;
+}
+export interface ShuttleReport {
+    id: string;
+    type: ShuttleReportType;
+    run_id: string;
+    status: string;
+    format: ShuttleReportFormat;
+    sections?: Array<string>;
+    users_scope?: ShuttleReportUsersScope;
+    output: ShuttleReportOutput | null;
+    created_at?: string;
+    completed_at: string | null;
+}
+export interface ShuttleReportCreateRequest {
+    run_id: string;
+    format: ShuttleReportFormat;
+    sections: Array<string>;
+    users_scope?: ShuttleReportUsersScope;
+}
+export interface ShuttleReportOutput {
+    id: string;
+    type: ShuttleReportOutputType;
+}
+export interface ShuttleReports {
+    entries: Array<ShuttleReport>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export interface ShuttleRun {
+    id: string;
+    type: ShuttleRunType;
+    job_id: string;
+    run_mode: string;
+    state: string;
+    started_at?: string;
+    ended_at?: string | null;
+    duration_seconds?: number | null;
+    stats?: ShuttleRunStats;
+    created_by?: UserBase | null;
+    available_report_sections?: Array<string>;
+}
+export interface ShuttleRuns {
+    entries: Array<ShuttleRun>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export interface ShuttleSubject {
+    type: ShuttleSubjectType;
+    id?: string | null;
+    email?: string | null;
+    name?: string | null;
+    roles?: Array<ShuttleSubjectRole> | null;
+}
+export interface ShuttleSubjectMapping {
+    id: string;
+    type: ShuttleSubjectMappingType;
+    job_id: string;
+    discovered_subject_id?: string | null;
+    revision?: number | null;
+    is_subject_skipped: boolean;
+    source: ShuttleSubject;
+    target?: ShuttleTargetSubject | null;
+}
+export interface ShuttleSubjectMappingCreateRequest {
+    job_id: string;
+    discovered_subject_id: string;
+    revision?: number;
+    is_subject_skipped?: boolean;
+    target?: ShuttleTargetSubjectInput | null;
+}
+export interface ShuttleSubjectMappingImportCreateRequest {
+    job_id: string;
+    file_id: string;
+}
+export interface ShuttleSubjectMappings {
+    entries: Array<ShuttleSubjectMapping>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export interface ShuttleSubjectMappingUpdateRequest {
+    is_subject_skipped?: boolean;
+    target?: ShuttleTargetSubjectInput | null;
+}
+export type ShuttleSubjectRole = "owner" | "creator" | "updater" | "namespace_account" | "sharee" | "account_holder" | "unknown" | (string & {});
+export interface ShuttleSystem {
+    id: string;
+    type: SourceSystemType;
+    name: string;
+    system_type: string;
+    label?: string;
+    state: ShuttleSystemState;
+}
+export interface ShuttleSystemCreateRequest {
+    name: string;
+    system_type: ShuttleSystemCreateRequestSystemType;
+}
+export interface ShuttleSystems {
+    entries: Array<ShuttleSystem>;
+    limit?: number;
+    next_marker?: string | null;
+    prev_marker?: string | null;
+}
+export interface ShuttleSystemUpdateRequest {
+    name?: string;
+}
+export interface ShuttleTargetSubject {
+    type: ShuttleSubjectType;
+    id?: string | null;
+    email?: string | null;
+    name?: string | null;
+}
+export interface ShuttleTargetSubjectInput {
+    type: ShuttleSubjectType;
+    id: string;
+}
+export type ShuttleDiscoveredSubjectType = "shuttle_discovered_subject" | (string & {});
+export type ShuttleJobType = "shuttle_job" | (string & {});
+export type ShuttleJobJobType = "transfer" | "analysis" | (string & {});
+export type SourceSystemType = "shuttle_system" | (string & {});
+export interface ShuttleJobSourceSystem {
+    type: SourceSystemType;
+    id: string;
+    name: string;
+}
+export interface ShuttleJobAccountMapping {
+    is_enabled: boolean;
+    permission_conflict_strategy?: ShuttleJobPermissionConflictStrategy | null;
+    are_external_shares_mapped?: boolean;
+    are_permissions_mapped?: boolean;
+}
+export interface ShuttleJobSettings {
+    bandwidth_limit_bytes_per_sec?: number | null;
+    are_deletions_mirrored?: boolean;
+    are_file_versions_synced?: boolean;
+    max_file_versions?: number | null;
+    is_overwrite_enabled?: boolean;
+    are_completed_mappings_skipped_on_rerun?: boolean;
+    is_content_scanning_enabled?: boolean;
+    include_shared_source_folders?: boolean;
+    include_shared_destination_folders?: boolean;
+}
+export interface ShuttleJobCreateRequestAccountMapping {
+    is_enabled?: boolean;
+    permission_conflict_strategy?: ShuttleJobPermissionConflictStrategy | null;
+    are_external_shares_mapped?: boolean;
+    are_permissions_mapped?: boolean;
+}
+export type ShuttleJobScheduleType = "shuttle_job_schedule" | (string & {});
+export type ShuttleJobScheduleState = "enabled" | "paused" | (string & {});
+export type ShuttleJobScheduleRunMode = "transfer" | "simulation" | "analysis" | (string & {});
+export type ShuttleJobScheduleTriggerByJobType = "by_job" | (string & {});
+export type ShuttleJobScheduleTriggerByJobLastRunCondition = "always" | "on_success" | "on_finish" | (string & {});
+export type ShuttleJobScheduleTriggerByTimeType = "by_time" | (string & {});
+export type ShuttleJobScheduleTriggerByTimeRepeat = "none" | "daily" | "weekly" | "weekdays" | "weekends" | (string & {});
+export type ShuttleJobStartRequestMode = "transfer" | "simulation" | "scan" | "analysis" | (string & {});
+export type ShuttleMappingErrorType = "shuttle_mapping_error" | (string & {});
+export type ShuttlePathEntryType = "shuttle_path_entry" | (string & {});
+export type ShuttlePathEntryAccountScopeType = "account" | (string & {});
+export type ShuttlePathEntrySharedSpaceScopeType = "shared_space" | (string & {});
+export type ShuttlePathMappingType = "shuttle_path_mapping" | (string & {});
+export type ShuttleReportType = "shuttle_report" | (string & {});
+export type ShuttleReportFormat = "xlsx" | "csv" | (string & {});
+export type ShuttleReportUsersScope = "migrated" | "all" | (string & {});
+export type ShuttleReportOutputType = "file" | "folder" | (string & {});
+export type ShuttleRunType = "shuttle_run" | (string & {});
+export interface ShuttleRunStats {
+    bytes_sent?: number;
+    files_sent?: number;
+    folders_created?: number;
+    is_estimated?: boolean;
+}
+export type ShuttleSubjectType = "user" | "group" | (string & {});
+export type ShuttleSubjectMappingType = "shuttle_subject_mapping" | (string & {});
+export type ShuttleSystemState = "connected" | "disconnected" | "unknown" | (string & {});
+export type ShuttleSystemCreateRequestSystemType = "windows" | (string & {});
+export type GetPathEntriesSide = "source" | "target" | (string & {});

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

@@ -2,7 +2,7 @@ import type { FileVersionType, PutOp, PutSkillInvocationIdFile } from '../schema
 export interface KeywordSkillCard {
     created_at?: string;
     type: KeywordSkillCardType;
-    skill_card_type: KeywordSkillCardType2;
+    skill_card_type: KeywordSkillCardSkillCardType;
     skill_card_title?: KeywordSkillCardTitle;
     skill: KeywordSkillCardSkill;
     invocation: KeywordSkillCardInvocation;
@@ -50,7 +50,7 @@ export interface TranscriptSkillCard {
     entries: Array<TranscriptSkillCardEntries>;
 }
 export type KeywordSkillCardType = "skill_card" | (string & {});
-export type KeywordSkillCardType2 = "keyword" | (string & {});
+export type KeywordSkillCardSkillCardType = "keyword" | (string & {});
 export interface KeywordSkillCardTitle {
     code?: string;
     message: string;

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

@@ -1,4 +1,4 @@
-import type { AttributesParent, PutIdParent, SharedLinkAccess } from '../schemas.js';
+import type { AttributesParent, PutIdParent, SharedLinkAccess, SharedLinkOtpWritable } from '../schemas.js';
 export interface CreateWebLinkRequest {
     url: string;
     parent: AttributesParent;
@@ -10,6 +10,7 @@ export interface UpdateWebLinkRequestSharedLink {
     password?: string | null;
     vanity_name?: string;
     unshared_at?: string;
+    one_time_passcode?: SharedLinkOtpWritable;
 }
 export interface UpdateWebLinkRequest {
     url?: string;

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

@@ -1,7 +1,7 @@
 import type { CollaboratorVariableValue, FileFullAllowedInviteeRoles, MetadataCascadePolicyParent, PutSkillInvocationIdFile, UserBase } from '../schemas.js';
 export interface CollaboratorVariable {
     type: CollaboratorVariableType;
-    variable_type: CollaboratorVariableType2;
+    variable_type: CollaboratorVariableVariableType;
     variable_value: Array<CollaboratorVariableValue>;
 }
 export interface CompletionRuleVariable {
@@ -37,7 +37,7 @@ export interface Workflows {
     entries?: Array<Workflow>;
 }
 export type CollaboratorVariableType = "variable" | (string & {});
-export type CollaboratorVariableType2 = "user_list" | (string & {});
+export type CollaboratorVariableVariableType = "user_list" | (string & {});
 export type CompletionRuleVariableType = "task_completion_rule" | (string & {});
 export type CompletionRuleVariableValue = "all_assignees" | "any_assignees" | (string & {});
 export type RoleVariableType = "collaborator_role" | (string & {});