box-node-sdk

import { FetchOptionsInput } from './networking/fetchOptions'; import { BaseUrlsInput } from './networking/baseUrls'; import { AuthorizationManager } from './managers/authorization'; import { FilesManager } from './managers/files'; import { TrashedFilesManager } from './managers/trashedFiles'; import { AppItemAssociationsManager } from './managers/appItemAssociations'; import { DownloadsManager } from './managers/downloads'; import { UploadsManager } from './managers/uploads'; import { ChunkedUploadsManager } from './managers/chunkedUploads'; import { ListCollaborationsManager } from './managers/listCollaborations'; import { CommentsManager } from './managers/comments'; import { TasksManager } from './managers/tasks'; import { FileVersionsManager } from './managers/fileVersions'; import { FileMetadataManager } from './managers/fileMetadata'; import { FileClassificationsManager } from './managers/fileClassifications'; import { SkillsManager } from './managers/skills'; import { FileWatermarksManager } from './managers/fileWatermarks'; import { FileRequestsManager } from './managers/fileRequests'; import { FoldersManager } from './managers/folders'; import { TrashedFoldersManager } from './managers/trashedFolders'; import { FolderMetadataManager } from './managers/folderMetadata'; import { FolderClassificationsManager } from './managers/folderClassifications'; import { TrashedItemsManager } from './managers/trashedItems'; import { FolderWatermarksManager } from './managers/folderWatermarks'; import { FolderLocksManager } from './managers/folderLocks'; import { MetadataTemplatesManager } from './managers/metadataTemplates'; import { ClassificationsManager } from './managers/classifications'; import { MetadataCascadePoliciesManager } from './managers/metadataCascadePolicies'; import { SearchManager } from './managers/search'; import { UserCollaborationsManager } from './managers/userCollaborations'; import { TaskAssignmentsManager } from './managers/taskAssignments'; import { SharedLinksFilesManager } from './managers/sharedLinksFiles'; import { SharedLinksFoldersManager } from './managers/sharedLinksFolders'; import { WebLinksManager } from './managers/webLinks'; import { TrashedWebLinksManager } from './managers/trashedWebLinks'; import { SharedLinksWebLinksManager } from './managers/sharedLinksWebLinks'; import { SharedLinksAppItemsManager } from './managers/sharedLinksAppItems'; import { UsersManager } from './managers/users'; import { SessionTerminationManager } from './managers/sessionTermination'; import { AvatarsManager } from './managers/avatars'; import { TransferManager } from './managers/transfer'; import { EmailAliasesManager } from './managers/emailAliases'; import { MembershipsManager } from './managers/memberships'; import { InvitesManager } from './managers/invites'; import { GroupsManager } from './managers/groups'; import { WebhooksManager } from './managers/webhooks'; import { EventsManager } from './managers/events'; import { CollectionsManager } from './managers/collections'; import { RecentItemsManager } from './managers/recentItems'; import { RetentionPoliciesManager } from './managers/retentionPolicies'; import { RetentionPolicyAssignmentsManager } from './managers/retentionPolicyAssignments'; import { LegalHoldPoliciesManager } from './managers/legalHoldPolicies'; import { LegalHoldPolicyAssignmentsManager } from './managers/legalHoldPolicyAssignments'; import { FileVersionRetentionsManager } from './managers/fileVersionRetentions'; import { FileVersionLegalHoldsManager } from './managers/fileVersionLegalHolds'; import { ShieldInformationBarriersManager } from './managers/shieldInformationBarriers'; import { ShieldInformationBarrierReportsManager } from './managers/shieldInformationBarrierReports'; import { ShieldInformationBarrierSegmentsManager } from './managers/shieldInformationBarrierSegments'; import { ShieldInformationBarrierSegmentMembersManager } from './managers/shieldInformationBarrierSegmentMembers'; import { ShieldInformationBarrierSegmentRestrictionsManager } from './managers/shieldInformationBarrierSegmentRestrictions'; import { DevicePinnersManager } from './managers/devicePinners'; import { TermsOfServicesManager } from './managers/termsOfServices'; import { TermsOfServiceUserStatusesManager } from './managers/termsOfServiceUserStatuses'; import { CollaborationAllowlistEntriesManager } from './managers/collaborationAllowlistEntries'; import { CollaborationAllowlistExemptTargetsManager } from './managers/collaborationAllowlistExemptTargets'; import { StoragePoliciesManager } from './managers/storagePolicies'; import { StoragePolicyAssignmentsManager } from './managers/storagePolicyAssignments'; import { ZipDownloadsManager } from './managers/zipDownloads'; import { SignRequestsManager } from './managers/signRequests'; import { WorkflowsManager } from './managers/workflows'; import { SignTemplatesManager } from './managers/signTemplates'; import { IntegrationMappingsManager } from './managers/integrationMappings'; import { AiManager } from './managers/ai'; import { AiStudioManager } from './managers/aiStudio'; import { MetadataTaxonomiesManager } from './managers/metadataTaxonomies'; import { DocgenTemplateManager } from './managers/docgenTemplate'; import { DocgenManager } from './managers/docgen'; import { EnterpriseConfigurationsManager } from './managers/enterpriseConfigurations'; import { HubsManager } from './managers/hubs'; import { HubCollaborationsManager } from './managers/hubCollaborations'; import { HubItemsManager } from './managers/hubItems'; import { ShieldListsManager } from './managers/shieldLists'; import { ArchivesManager } from './managers/archives'; import { ExternalUsersManager } from './managers/externalUsers'; import { Authentication } from './networking/auth'; import { NetworkSession } from './networking/network'; import { FetchResponse } from './networking/fetchResponse'; import { ProxyConfig } from './networking/proxyConfig'; import { AgentOptions } from './internal/utils'; import { Interceptor } from './networking/interceptors'; export declare class BoxClient { readonly auth: Authentication; readonly networkSession: NetworkSession; readonly authorization: AuthorizationManager; readonly files: FilesManager; readonly trashedFiles: TrashedFilesManager; readonly appItemAssociations: AppItemAssociationsManager; readonly downloads: DownloadsManager; readonly uploads: UploadsManager; readonly chunkedUploads: ChunkedUploadsManager; readonly listCollaborations: ListCollaborationsManager; readonly comments: CommentsManager; readonly tasks: TasksManager; readonly fileVersions: FileVersionsManager; readonly fileMetadata: FileMetadataManager; readonly fileClassifications: FileClassificationsManager; readonly skills: SkillsManager; readonly fileWatermarks: FileWatermarksManager; readonly fileRequests: FileRequestsManager; readonly folders: FoldersManager; readonly trashedFolders: TrashedFoldersManager; readonly folderMetadata: FolderMetadataManager; readonly folderClassifications: FolderClassificationsManager; readonly trashedItems: TrashedItemsManager; readonly folderWatermarks: FolderWatermarksManager; readonly folderLocks: FolderLocksManager; readonly metadataTemplates: MetadataTemplatesManager; readonly classifications: ClassificationsManager; readonly metadataCascadePolicies: MetadataCascadePoliciesManager; readonly search: SearchManager; readonly userCollaborations: UserCollaborationsManager; readonly taskAssignments: TaskAssignmentsManager; readonly sharedLinksFiles: SharedLinksFilesManager; readonly sharedLinksFolders: SharedLinksFoldersManager; readonly webLinks: WebLinksManager; readonly trashedWebLinks: TrashedWebLinksManager; readonly sharedLinksWebLinks: SharedLinksWebLinksManager; readonly sharedLinksAppItems: SharedLinksAppItemsManager; readonly users: UsersManager; readonly sessionTermination: SessionTerminationManager; readonly avatars: AvatarsManager; readonly transfer: TransferManager; readonly emailAliases: EmailAliasesManager; readonly memberships: MembershipsManager; readonly invites: InvitesManager; readonly groups: GroupsManager; readonly webhooks: WebhooksManager; readonly events: EventsManager; readonly collections: CollectionsManager; readonly recentItems: RecentItemsManager; readonly retentionPolicies: RetentionPoliciesManager; readonly retentionPolicyAssignments: RetentionPolicyAssignmentsManager; readonly legalHoldPolicies: LegalHoldPoliciesManager; readonly legalHoldPolicyAssignments: LegalHoldPolicyAssignmentsManager; readonly fileVersionRetentions: FileVersionRetentionsManager; readonly fileVersionLegalHolds: FileVersionLegalHoldsManager; readonly shieldInformationBarriers: ShieldInformationBarriersManager; readonly shieldInformationBarrierReports: ShieldInformationBarrierReportsManager; readonly shieldInformationBarrierSegments: ShieldInformationBarrierSegmentsManager; readonly shieldInformationBarrierSegmentMembers: ShieldInformationBarrierSegmentMembersManager; readonly shieldInformationBarrierSegmentRestrictions: ShieldInformationBarrierSegmentRestrictionsManager; readonly devicePinners: DevicePinnersManager; readonly termsOfServices: TermsOfServicesManager; readonly termsOfServiceUserStatuses: TermsOfServiceUserStatusesManager; readonly collaborationAllowlistEntries: CollaborationAllowlistEntriesManager; readonly collaborationAllowlistExemptTargets: CollaborationAllowlistExemptTargetsManager; readonly storagePolicies: StoragePoliciesManager; readonly storagePolicyAssignments: StoragePolicyAssignmentsManager; readonly zipDownloads: ZipDownloadsManager; readonly signRequests: SignRequestsManager; readonly workflows: WorkflowsManager; readonly signTemplates: SignTemplatesManager; readonly integrationMappings: IntegrationMappingsManager; readonly ai: AiManager; readonly aiStudio: AiStudioManager; readonly metadataTaxonomies: MetadataTaxonomiesManager; readonly docgenTemplate: DocgenTemplateManager; readonly docgen: DocgenManager; readonly enterpriseConfigurations: EnterpriseConfigurationsManager; readonly hubs: HubsManager; readonly hubCollaborations: HubCollaborationsManager; readonly hubItems: HubItemsManager; readonly shieldLists: ShieldListsManager; readonly archives: ArchivesManager; readonly externalUsers: ExternalUsersManager; constructor(fields: Omit<BoxClient, 'authorization' | 'files' | 'trashedFiles' | 'appItemAssociations' | 'downloads' | 'uploads' | 'chunkedUploads' | 'listCollaborations' | 'comments' | 'tasks' | 'fileVersions' | 'fileMetadata' | 'fileClassifications' | 'skills' | 'fileWatermarks' | 'fileRequests' | 'folders' | 'trashedFolders' | 'folderMetadata' | 'folderClassifications' | 'trashedItems' | 'folderWatermarks' | 'folderLocks' | 'metadataTemplates' | 'classifications' | 'metadataCascadePolicies' | 'search' | 'userCollaborations' | 'taskAssignments' | 'sharedLinksFiles' | 'sharedLinksFolders' | 'webLinks' | 'trashedWebLinks' | 'sharedLinksWebLinks' | 'sharedLinksAppItems' | 'users' | 'sessionTermination' | 'avatars' | 'transfer' | 'emailAliases' | 'memberships' | 'invites' | 'groups' | 'webhooks' | 'events' | 'collections' | 'recentItems' | 'retentionPolicies' | 'retentionPolicyAssignments' | 'legalHoldPolicies' | 'legalHoldPolicyAssignments' | 'fileVersionRetentions' | 'fileVersionLegalHolds' | 'shieldInformationBarriers' | 'shieldInformationBarrierReports' | 'shieldInformationBarrierSegments' | 'shieldInformationBarrierSegmentMembers' | 'shieldInformationBarrierSegmentRestrictions' | 'devicePinners' | 'termsOfServices' | 'termsOfServiceUserStatuses' | 'collaborationAllowlistEntries' | 'collaborationAllowlistExemptTargets' | 'storagePolicies' | 'storagePolicyAssignments' | 'zipDownloads' | 'signRequests' | 'workflows' | 'signTemplates' | 'integrationMappings' | 'ai' | 'aiStudio' | 'metadataTaxonomies' | 'docgenTemplate' | 'docgen' | 'enterpriseConfigurations' | 'hubs' | 'hubCollaborations' | 'hubItems' | 'shieldLists' | 'archives' | 'externalUsers' | 'networkSession' | 'makeRequest' | 'withAsUserHeader' | 'withSuppressedNotifications' | 'withExtraHeaders' | 'withCustomBaseUrls' | 'withProxy' | 'withCustomAgentOptions' | 'withInterceptors'> & Partial<Pick<BoxClient, 'networkSession'>>); /** * Make a custom http request using the client authentication and network session. * @param {FetchOptionsInput} fetchOptionsInput Options to be passed to the fetch call * @returns {Promise<FetchResponse>} */ makeRequest(fetchOptionsInput: FetchOptionsInput): Promise<FetchResponse>; /** * Create a new client to impersonate user with the provided ID. All calls made with the new client will be made in context of the impersonated user, leaving the original client unmodified. * @param {string} userId ID of an user to impersonate * @returns {BoxClient} */ withAsUserHeader(userId: string): BoxClient; /** * Create a new client with suppressed notifications. Calls made with the new client will not trigger email or webhook notifications * @returns {BoxClient} */ withSuppressedNotifications(): BoxClient; /** * Create a new client with a custom set of headers that will be included in every API call * @param {{ readonly [key: string]: string; }} extraHeaders Custom set of headers that will be included in every API call * @returns {BoxClient} */ withExtraHeaders(extraHeaders?: { readonly [key: string]: string; }): BoxClient; /** * Create a new client with a custom set of base urls that will be used for every API call * @param {BaseUrlsInput} baseUrlsInput Custom set of base urls that will be used for every API call * @returns {BoxClient} */ withCustomBaseUrls(baseUrlsInput: BaseUrlsInput): BoxClient; /** * Create a new client with a custom proxy that will be used for every API call * @param {ProxyConfig} config * @returns {BoxClient} */ withProxy(config: ProxyConfig): BoxClient; /** * Create a new client with a custom set of agent options that will be used for every API call * @param {AgentOptions} agentOptions Custom set of agent options that will be used for every API call * @returns {BoxClient} */ withCustomAgentOptions(agentOptions: AgentOptions): BoxClient; /** * Create a new client with a custom set of interceptors that will be used for every API call * @param {readonly Interceptor[]} interceptors Custom set of interceptors that will be used for every API call * @returns {BoxClient} */ withInterceptors(interceptors: readonly Interceptor[]): BoxClient; } export interface BoxClientInput { readonly auth: Authentication; readonly networkSession?: NetworkSession; }