@musallam/storage-and-collaboration-client
    Preparing search index...

    Namespace StorageAndCollaborationClient

    Interfaces

    AssetRolesResponse
    BaseAsset
    BaseDirectRoleEntry
    BaseJobStatus
    BasePatchRoleEntry
    CommonNonProjectPermissions
    CommonPermissions
    ContainerOnlyPermissions
    CopyRequest
    ErrorResponse
    FileDownloadOKResponse
    MoveRequest
    OperationOptions
    PaginatedAssets
    PaginatedProjects
    Pagination
    PatchAssetRolesRequest
    PatchAssetRolesResponse
    PendingRoleEntry

    Type Aliases

    AccessErrorFolderCreateResponseResponse
    AccessErrorProjectCreateResponseResponse
    AccessErrorResponseResponse
    Ancestors
    Asset
    AssetId
    AssetName
    AssetsFilterParameter
    AssetsSortByParameter
    AssetTypeEnums
    Autorename
    BaseAssetState
    ContentTypeChangeNotAllowedResponseResponse
    CopyFilePathParameters
    CopyFileResult
    CopyOperationOptions
    CopyOperationOptionsAllOf
    CreateFolderResult
    CreateProjectResult
    CursorParameter
    Date
    DeleteFileParams
    DeleteFilePathParameters
    DeleteFileResult
    DeleteFolderParams
    DeleteFolderPathParameters
    DeleteFolderResult
    DeleteProjectParams
    DeleteProjectPathParameters
    DeleteProjectResult
    DirectRoleEntry
    DownloadFileParams
    DownloadFilePathParameters
    DownloadFileResult
    ErrorCodeEnums
    FailedJobStatus
    FailedJobStatusAllOf
    FailedJobStatusStatus
    FailedPatchRoleEntry
    FailedPatchRoleEntryAllOf
    FailedPatchRoleEntryStatus
    FileAsset
    FileAssetAllOf
    FileAssetAssetType
    FileCopyAcceptedResponseResponse
    FileCopyRequestBody
    FileCopySucceededJobStatus
    FileCopySucceededJobStatusAllOf
    FileCopySucceededJobStatusJobType
    FileDownloadAcceptedResponseResponse
    FileDownloadOKResponseResponse
    FileDownloadSucceededJobStatus
    FileDownloadSucceededJobStatusAllOf
    FileDownloadSucceededJobStatusJobType
    FileMoveAcceptedResponseResponse
    FileMoveRequestBody
    FileMoveSucceededJobStatus
    FileMoveSucceededJobStatusAllOf
    FileMoveSucceededJobStatusJobType
    FilePermissionResponseResponse
    FilePermissions
    FileRenameRequestBody
    FileReplaceInitRequestBody
    FileSize
    FileUploadFinalizeRequestBody
    FileUploadFinalizeResponseResponse
    FileUploadInitRequestBody
    FileUploadInitResponseResponse
    FileUploadInitResponseResponseTransferLinksItem
    FileUploadSucceededJobStatus
    FileUploadSucceededJobStatusAllOf
    FileUploadSucceededJobStatusJobType
    FinalizeBlockBasedFileReplacementPathParameters
    FinalizeBlockBasedFileReplacementResult
    FinalizeBlockBasedFileUploadResult
    FolderAsset
    FolderAssetAllOf
    FolderAssetAssetType
    FolderCopyPartiallySucceededJobStatus
    FolderCopyPartiallySucceededJobStatusAllOf
    FolderCopyPartiallySucceededJobStatusAllOfErrorsItem
    FolderCopyPartiallySucceededJobStatusAllOfErrorsItemAllOf
    FolderCopyPartiallySucceededJobStatusAllOfErrorsItemAllOfAsset
    FolderCopyPartiallySucceededJobStatusJobType
    FolderCopySucceededJobStatus
    FolderCopySucceededJobStatusAllOf
    FolderCopySucceededJobStatusJobType
    FolderCreateRequestBody
    FolderMoveSucceededJobStatus
    FolderMoveSucceededJobStatusAllOf
    FolderMoveSucceededJobStatusJobType
    FolderPermissionResponseResponse
    FolderPermissions
    FolderRenameRequestBody
    GetAssetRolesResponseResponse
    GetFileEffectivePermissionPathParameters
    GetFileEffectivePermissionResult
    GetFileImageRenditionParams
    GetFileImageRenditionPathParameters
    GetFileImageRenditionResult
    GetFilePathParameters
    GetFilePermissionsPathParameters
    GetFilePermissionsResult
    GetFileResult
    GetFileRolesPathParameters
    GetFileRolesResult
    GetFolderChildrenParams
    GetFolderChildrenPathParameters
    GetFolderChildrenResult
    GetFolderEffectivePermissionPathParameters
    GetFolderEffectivePermissionResult
    GetFolderPathParameters
    GetFolderResult
    GetJobStatusPathParameters
    GetJobStatusResult
    GetProjectChildrenParams
    GetProjectChildrenPathParameters
    GetProjectChildrenResult
    GetProjectEffectivePermissionPathParameters
    GetProjectEffectivePermissionResult
    GetProjectPathParameters
    GetProjectPermissionsPathParameters
    GetProjectPermissionsResult
    GetProjectResult
    GetProjectRolesPathParameters
    GetProjectRolesResult
    GetProjectsParams
    GetProjectsResult
    GroupDirectRoleEntry
    GroupDirectRoleEntryAllOf
    GroupDirectRoleEntryType
    InitBlockBasedFileReplacementPathParameters
    InitBlockBasedFileReplacementResult
    InitBlockBasedFileUploadResult
    InvalidContentTypeResponseResponse
    InvalidOperationResponseResponse
    InvalidRequestPagedResponseResponse
    InvalidRequestResponseResponse
    JobId
    JobStatus
    JobStatusEnums
    JobTypeEnums
    LimitParameter
    MatchedEtagResponseResponse
    MediaTypeParameter
    MoveFilePathParameters
    MoveFileResult
    MoveOperationOptions
    MoveOperationOptionsAllOf
    NotAcceptableResponseResponse
    PaginatedAssetsResponseResponse
    PaginatedProjectsResponseResponse
    PartiallySucceededJobStatus
    PartiallySucceededJobStatusStatus
    PatchAssetRolesBody
    PatchAssetRolesRequestDirect
    PatchAssetRolesRequestDirectAdditionsItem
    PatchAssetRolesRequestDirectDeletionsItem
    PatchAssetRolesRequestDirectUpdatesItem
    PatchAssetRolesResponseDirect
    PatchAssetRolesResponseResponse
    PatchFilePermissionsPathParameters
    PatchFilePermissionsResult
    PatchFileRolesPathParameters
    PatchFileRolesResult
    PatchProjectPermissionsPathParameters
    PatchProjectPermissionsResult
    PatchProjectRolesPathParameters
    PatchProjectRolesResult
    PatchRoleResultEntry
    Path
    PendingPatchRoleEntry
    PendingPatchRoleEntryAllOf
    PendingPatchRoleEntryStatus
    PermanentParameter
    PreconditionFailedResponseResponse
    PredefinedGroupsDirectRoleEntry
    PredefinedGroupsDirectRoleEntryAllOf
    PredefinedGroupsDirectRoleEntryType
    PrincipalId
    PrincipalTypeEnums
    ProjectAsset
    ProjectAssetAllOf
    ProjectAssetAssetType
    ProjectCreateRequestBody
    ProjectPackagePartiallySucceededJobStatus
    ProjectPackagePartiallySucceededJobStatusAllOf
    ProjectPackagePartiallySucceededJobStatusJobType
    ProjectPackageSucceededJobStatus
    ProjectPackageSucceededJobStatusAllOf
    ProjectPackageSucceededJobStatusJobType
    ProjectPermissionResponseResponse
    ProjectPermissions
    ProjectPermissionsAllOf
    ProjectRenameRequestBody
    ProjectsFilterParameter
    ProjectsSortByParameter
    RateLimitResponseResponse
    RenameFilePathParameters
    RenameFileResult
    RenameFolderPathParameters
    RenameFolderResult
    RenameProjectPathParameters
    RenameProjectResult
    RequestId
    RequestIdParameter
    ResourceNotFoundResponseResponse
    RestoreFilePathParameters
    RestoreFileResult
    RestoreFolderPathParameters
    RestoreFolderResult
    RestoreProjectPathParameters
    RestoreProjectResult
    RoleEnums
    RunningJobStatus
    RunningJobStatusAllOf
    RunningJobStatusStatus
    RuntimeErrorResponseResponse
    SizeParameter
    StorageQuotaExceededResponseResponse
    SucceededJobStatus
    SucceededJobStatusStatus
    SuccessfulPatchRoleEntry
    SuccessfulPatchRoleEntryAllOf
    SuccessfulPatchRoleEntryStatus
    UnauthorizedResponseResponse
    UnprocessableEntityResponseResponse
    Url
    UrlTTLParameter
    UserDirectRoleEntry
    UserDirectRoleEntryAllOf
    UserDirectRoleEntryType

    Variables

    AssetTypeEnums
    BaseAssetState
    ErrorCodeEnums
    FailedJobStatusStatus
    FailedPatchRoleEntryStatus
    FileAssetAssetType
    FileCopySucceededJobStatusJobType
    FileDownloadSucceededJobStatusJobType
    FileMoveSucceededJobStatusJobType
    FileUploadSucceededJobStatusJobType
    FolderAssetAssetType
    FolderCopyPartiallySucceededJobStatusJobType
    FolderCopySucceededJobStatusJobType
    FolderMoveSucceededJobStatusJobType
    GroupDirectRoleEntryType
    JobStatusEnums
    JobTypeEnums
    PartiallySucceededJobStatusStatus
    PendingPatchRoleEntryStatus
    PredefinedGroupsDirectRoleEntryType
    PrincipalTypeEnums
    ProjectAssetAssetType
    ProjectPackagePartiallySucceededJobStatusJobType
    ProjectPackageSucceededJobStatusJobType
    RoleEnums
    RunningJobStatusStatus
    SucceededJobStatusStatus
    SuccessfulPatchRoleEntryStatus
    UserDirectRoleEntryType

    Functions

    copyFile

    Copies a file to a new location.

    createFolder

    Create a new folder.

    createProject

    Create a new project.

    deleteFile

    Delete file by ID

    deleteFolder

    Delete folder by ID

    deleteProject

    Delete project by ID

    downloadFile

    Range Based Download of a file through a Pre-signed URL

    finalizeBlockBasedFileReplacement

    Finalize a block based file replacement job

    finalizeBlockBasedFileUpload

    Finalize a block based file upload job

    getFile

    Get a file by ID

    getFileEffectivePermission

    Get User's Effective Permissions for a File

    getFileImageRendition

    Get an image rendition of a file by ID

    getFilePermissions

    Get All roles for a File

    getFileRoles

    Get All roles for a File

    getFolder

    Get a folder by ID

    getFolderChildren

    Get Paginated List of Children of a Folder

    getFolderEffectivePermission

    Get User's Effective Permissions for a Folder

    getJobStatus

    Get the status of an asynchronous job

    getProject

    Get a project by ID

    getProjectChildren

    Get Paginated List of Children of a Project

    getProjectEffectivePermission

    Get User's Effective Permissions for a Project

    getProjectPermissions

    Get All roles for a Project

    getProjectRoles

    Get All roles for a Project

    getProjects

    Get Paginated List of Projects

    initBlockBasedFileReplacement

    Initialize a block based file replacement job

    initBlockBasedFileUpload

    Initialize a block based file upload job

    moveFile

    Move a file to a new location.

    patchFilePermissions

    Patch Roles for a File

    patchFileRoles

    Patch Roles for a File

    patchProjectPermissions

    Patch Roles for a Project

    patchProjectRoles

    Patch Roles for a Project

    renameFile

    Rename a file.

    renameFolder

    Rename a folder.

    renameProject

    Rename a project.

    restoreFile

    Restore a soft-deleted file.

    restoreFolder

    Restore a soft-deleted folder.

    restoreProject

    Restore a soft-deleted project.