@unofficialbox/box-open-sdk 0.1.0

package/docs/managers/task_assignments.md

@@ -0,0 +1,55 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# TaskAssignmentsManager
+
+Reach these methods through the `taskAssignments` field on `Client`.
+
+## listTaskAssignments
+
+`GET /tasks/{task_id}/assignments`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `task_id` | path | `string` | yes |
+
+**Returns:** `TaskAssignments`
+
+## create
+
+`POST /task_assignments`
+
+**Request body** (`application/json`): `TaskAssignmentCreateRequest`
+
+**Returns:** `TaskAssignment`
+
+## get
+
+`GET /task_assignments/{task_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `task_assignment_id` | path | `string` | yes |
+
+**Returns:** `TaskAssignment`
+
+## update
+
+`PUT /task_assignments/{task_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `task_assignment_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `TaskAssignmentUpdateRequest`
+
+**Returns:** `TaskAssignment`
+
+## delete_
+
+`DELETE /task_assignments/{task_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `task_assignment_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/tasks.md

@@ -0,0 +1,55 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# TasksManager
+
+Reach these methods through the `tasks` field on `Client`.
+
+## listFile
+
+`GET /files/{file_id}/tasks`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Returns:** `Tasks`
+
+## create
+
+`POST /tasks`
+
+**Request body** (`application/json`): `TaskCreateRequest`
+
+**Returns:** `Task`
+
+## get
+
+`GET /tasks/{task_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `task_id` | path | `string` | yes |
+
+**Returns:** `Task`
+
+## update
+
+`PUT /tasks/{task_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `task_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `TaskUpdateRequest`
+
+**Returns:** `Task`
+
+## delete_
+
+`DELETE /tasks/{task_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `task_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/terms_of_service_user_statuses.md

@@ -0,0 +1,36 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# TermsOfServiceUserStatusesManager
+
+Reach these methods through the `termsOfServiceUserStatuses` field on `Client`.
+
+## list
+
+`GET /terms_of_service_user_statuses`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `tos_id` | query | `string` | yes |
+| `user_id` | query | `string` | no |
+
+**Returns:** `TermsOfServiceUserStatuses`
+
+## create
+
+`POST /terms_of_service_user_statuses`
+
+**Request body** (`application/json`): `TermsOfServiceUserStatuseCreateRequest`
+
+**Returns:** `TermsOfServiceUserStatus`
+
+## update
+
+`PUT /terms_of_service_user_statuses/{terms_of_service_user_status_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `terms_of_service_user_status_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `TermsOfServiceUserStatuseUpdateRequest`
+
+**Returns:** `TermsOfServiceUserStatus`
+

package/docs/managers/terms_of_services.md

@@ -0,0 +1,45 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# TermsOfServicesManager
+
+Reach these methods through the `termsOfServices` field on `Client`.
+
+## list
+
+`GET /terms_of_services`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `tos_type` | query | `GetTosType` | no |
+
+**Returns:** `TermsOfServices`
+
+## create
+
+`POST /terms_of_services`
+
+**Request body** (`application/json`): `TermsOfServiceCreateRequest`
+
+**Returns:** `TermsOfService`
+
+## get
+
+`GET /terms_of_services/{terms_of_service_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `terms_of_service_id` | path | `string` | yes |
+
+**Returns:** `TermsOfService`
+
+## update
+
+`PUT /terms_of_services/{terms_of_service_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `terms_of_service_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `TermsOfServiceUpdateRequest`
+
+**Returns:** `TermsOfService`
+

package/docs/managers/transfer.md

@@ -0,0 +1,19 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# TransferManager
+
+Reach these methods through the `transfer` field on `Client`.
+
+## updateUserFolder0
+
+`PUT /users/{user_id}/folders/0`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `notify` | query | `boolean` | no |
+
+**Request body** (`application/json`): `UserFolder0UpdateRequest`
+
+**Returns:** `FolderFull`
+

package/docs/managers/trashed_files.md

@@ -0,0 +1,39 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# TrashedFilesManager
+
+Reach these methods through the `trashedFiles` field on `Client`.
+
+## createFile
+
+`POST /files/{file_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `FileCreateRequest`
+
+**Returns:** `TrashFileRestored`
+
+## getFileTrash
+
+`GET /files/{file_id}/trash`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `TrashFile`
+
+## deleteFileTrash
+
+`DELETE /files/{file_id}/trash`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/trashed_folders.md

@@ -0,0 +1,39 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# TrashedFoldersManager
+
+Reach these methods through the `trashedFolders` field on `Client`.
+
+## createFolder
+
+`POST /folders/{folder_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `FileCreateRequest`
+
+**Returns:** `TrashFolderRestored`
+
+## getFolderTrash
+
+`GET /folders/{folder_id}/trash`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `TrashFolder`
+
+## deleteFolderTrash
+
+`DELETE /folders/{folder_id}/trash`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/trashed_items.md

@@ -0,0 +1,23 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# TrashedItemsManager
+
+Reach these methods through the `trashedItems` field on `Client`.
+
+## listFolderTrashItems
+
+`GET /folders/trash/items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+| `limit` | query | `number` | no |
+| `offset` | query | `number` | no |
+| `usemarker` | query | `boolean` | no |
+| `marker` | query | `string` | no |
+| `direction` | query | `OrderDirection` | no |
+| `sort` | query | `GetFolderTrashItemsSort` | no |
+
+**Returns:** `Items`
+
+Paginated — `listFolderTrashItems(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+

package/docs/managers/trashed_web_links.md

@@ -0,0 +1,39 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# TrashedWebLinksManager
+
+Reach these methods through the `trashedWebLinks` field on `Client`.
+
+## createWebLink
+
+`POST /web_links/{web_link_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `FileCreateRequest`
+
+**Returns:** `TrashWebLinkRestored`
+
+## getWebLinkTrash
+
+`GET /web_links/{web_link_id}/trash`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `TrashWebLink`
+
+## deleteWebLinkTrash
+
+`DELETE /web_links/{web_link_id}/trash`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/uploads.md

@@ -0,0 +1,41 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# UploadsManager
+
+Reach these methods through the `uploads` field on `Client`.
+
+## createFileContent
+
+`POST /files/{file_id}/content`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `if-match` | header | `string` | no |
+| `fields` | query | `Array<string>` | no |
+| `content-md5` | header | `string` | no |
+
+**Request body** (`multipart/form-data`): `FileIdContentCreateRequest`
+
+**Returns:** `Files`
+
+## createFileContent2
+
+`POST /files/content`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+| `content-md5` | header | `string` | no |
+
+**Request body** (`multipart/form-data`): `FileContentCreateRequest`
+
+**Returns:** `Files`
+
+## optionFileContent
+
+`OPTIONS /files/content`
+
+**Request body** (`application/json`): `OptionFileContentRequest`
+
+**Returns:** `UploadUrl`
+

package/docs/managers/user_collaborations.md

@@ -0,0 +1,51 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# UserCollaborationsManager
+
+Reach these methods through the `userCollaborations` field on `Client`.
+
+## getCollaboration
+
+`GET /collaborations/{collaboration_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `collaboration_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `Collaboration`
+
+## updateCollaboration
+
+`PUT /collaborations/{collaboration_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `collaboration_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `CollaborationUpdateRequest`
+
+**Returns:** `Collaboration`
+
+## deleteCollaboration
+
+`DELETE /collaborations/{collaboration_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `collaboration_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## createCollaborations
+
+`POST /collaborations`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+| `notify` | query | `boolean` | no |
+
+**Request body** (`application/json`): `CollaborationsCreateRequest`
+
+**Returns:** `Collaboration`
+

package/docs/managers/users.md

@@ -0,0 +1,82 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# UsersManager
+
+Reach these methods through the `users` field on `Client`.
+
+## list
+
+`GET /users`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `filter_term` | query | `string` | no |
+| `user_type` | query | `GetUserType` | no |
+| `external_app_user_id` | query | `string` | no |
+| `fields` | query | `Array<string>` | no |
+| `offset` | query | `number` | no |
+| `limit` | query | `number` | no |
+| `usemarker` | query | `boolean` | no |
+| `marker` | query | `string` | no |
+
+**Returns:** `Users`
+
+Paginated — `list(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## create
+
+`POST /users`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `UserCreateRequest`
+
+**Returns:** `UserFull`
+
+## getMe
+
+`GET /users/me`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `UserFull`
+
+## get
+
+`GET /users/{user_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `UserFull`
+
+## update
+
+`PUT /users/{user_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `UserUpdateRequest`
+
+**Returns:** `UserFull`
+
+## delete_
+
+`DELETE /users/{user_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+| `notify` | query | `boolean` | no |
+| `force` | query | `boolean` | no |
+
+**Returns:** `void`
+

package/docs/managers/web_links.md

@@ -0,0 +1,46 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# WebLinksManager
+
+Reach these methods through the `webLinks` field on `Client`.
+
+## create
+
+`POST /web_links`
+
+**Request body** (`application/json`): `WebLinkCreateRequest`
+
+**Returns:** `WebLink`
+
+## get
+
+`GET /web_links/{web_link_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+| `boxapi` | header | `string` | no |
+
+**Returns:** `WebLink`
+
+## update
+
+`PUT /web_links/{web_link_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `WebLinkUpdateRequest`
+
+**Returns:** `WebLink`
+
+## delete_
+
+`DELETE /web_links/{web_link_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/webhooks.md

@@ -0,0 +1,58 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# WebhooksManager
+
+Reach these methods through the `webhooks` field on `Client`.
+
+## list
+
+`GET /webhooks`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `Webhooks`
+
+Paginated — `list(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## create
+
+`POST /webhooks`
+
+**Request body** (`application/json`): `WebhookCreateRequest`
+
+**Returns:** `Webhook`
+
+## get
+
+`GET /webhooks/{webhook_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `webhook_id` | path | `string` | yes |
+
+**Returns:** `Webhook`
+
+## update
+
+`PUT /webhooks/{webhook_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `webhook_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `WebhookUpdateRequest`
+
+**Returns:** `Webhook`
+
+## delete_
+
+`DELETE /webhooks/{webhook_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `webhook_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/workflows.md

@@ -0,0 +1,32 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# WorkflowsManager
+
+Reach these methods through the `workflows` field on `Client`.
+
+## list
+
+`GET /workflows`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | query | `string` | yes |
+| `trigger_type` | query | `string` | no |
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+
+**Returns:** `Workflows`
+
+Paginated — `list(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## start
+
+`POST /workflows/{workflow_id}/start`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `workflow_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `WorkflowStartRequest`
+
+**Returns:** `void`
+

package/docs/managers/zip_downloads.md

@@ -0,0 +1,33 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ZipDownloadsManager
+
+Reach these methods through the `zipDownloads` field on `Client`.
+
+## create
+
+`POST /zip_downloads`
+
+**Request body** (`application/json`): `ZipDownloadRequest`
+
+**Returns:** `ZipDownload`
+
+## getContent
+
+`GET /zip_downloads/{zip_download_id}/content`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `zip_download_id` | path | `string` | yes |
+
+**Returns:** a binary stream (`runtime.Stream`)
+
+## getStatus
+
+`GET /zip_downloads/{zip_download_id}/status`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `zip_download_id` | path | `string` | yes |
+
+**Returns:** `ZipDownloadStatus`
+