@unofficialbox/box-open-sdk 0.1.0

package/docs/managers/file_metadata.md

@@ -0,0 +1,69 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FileMetadataManager
+
+Reach these methods through the `fileMetadata` field on `Client`.
+
+## listFileMetadata
+
+`GET /files/{file_id}/metadata`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `view` | query | `string` | no |
+
+**Returns:** `Metadatas`
+
+## getFileMetadata
+
+`GET /files/{file_id}/metadata/{scope}/{template_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+| `view` | query | `string` | no |
+
+**Returns:** `MetadataFull`
+
+## updateFileMetadata
+
+`PUT /files/{file_id}/metadata/{scope}/{template_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Request body** (`application/json-patch+json`): `Array<FileMetadataUpdateRequest>`
+
+**Returns:** `MetadataFull`
+
+## createFileMetadata
+
+`POST /files/{file_id}/metadata/{scope}/{template_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Request body** (`application/json`): `Record<string, unknown>`
+
+**Returns:** `MetadataFull`
+
+## deleteFileMetadata
+
+`DELETE /files/{file_id}/metadata/{scope}/{template_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/file_requests.md

@@ -0,0 +1,50 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FileRequestsManager
+
+Reach these methods through the `fileRequests` field on `Client`.
+
+## get
+
+`GET /file_requests/{file_request_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_request_id` | path | `string` | yes |
+
+**Returns:** `FileRequest`
+
+## update
+
+`PUT /file_requests/{file_request_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_request_id` | path | `string` | yes |
+| `if-match` | header | `string` | no |
+
+**Request body** (`application/json`): `FileRequestUpdateRequest`
+
+**Returns:** `FileRequest`
+
+## delete_
+
+`DELETE /file_requests/{file_request_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_request_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## copy
+
+`POST /file_requests/{file_request_id}/copy`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_request_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `FileRequestCopyRequest`
+
+**Returns:** `FileRequest`
+

package/docs/managers/file_version_legal_holds.md

@@ -0,0 +1,29 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FileVersionLegalHoldsManager
+
+Reach these methods through the `fileVersionLegalHolds` field on `Client`.
+
+## get
+
+`GET /file_version_legal_holds/{file_version_legal_hold_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_version_legal_hold_id` | path | `string` | yes |
+
+**Returns:** `FileVersionLegalHold`
+
+## list
+
+`GET /file_version_legal_holds`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `policy_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `FileVersionLegalHolds`
+
+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).
+

package/docs/managers/file_version_retentions.md

@@ -0,0 +1,34 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FileVersionRetentionsManager
+
+Reach these methods through the `fileVersionRetentions` field on `Client`.
+
+## list
+
+`GET /file_version_retentions`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | query | `string` | no |
+| `file_version_id` | query | `string` | no |
+| `policy_id` | query | `string` | no |
+| `disposition_action` | query | `RetentionPolicyDispositionAction` | no |
+| `disposition_before` | query | `string` | no |
+| `disposition_after` | query | `string` | no |
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+
+**Returns:** `FileVersionRetentions`
+
+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).
+
+## get
+
+`GET /file_version_retentions/{file_version_retention_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_version_retention_id` | path | `string` | yes |
+
+**Returns:** `FileVersionRetention`
+

package/docs/managers/file_versions.md

@@ -0,0 +1,70 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FileVersionsManager
+
+Reach these methods through the `fileVersions` field on `Client`.
+
+## listFileVersions
+
+`GET /files/{file_id}/versions`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `limit` | query | `number` | no |
+| `offset` | query | `number` | no |
+
+**Returns:** `FileVersions`
+
+Paginated — `listFileVersions(...)` 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).
+
+## getFileVersion
+
+`GET /files/{file_id}/versions/{file_version_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `file_version_id` | path | `string` | yes |
+
+**Returns:** `FileVersionFull`
+
+## updateFileVersion
+
+`PUT /files/{file_id}/versions/{file_version_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `file_version_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `FileVersionUpdateRequest`
+
+**Returns:** `FileVersionFull`
+
+## deleteFileVersion
+
+`DELETE /files/{file_id}/versions/{file_version_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `file_version_id` | path | `string` | yes |
+| `if-match` | header | `string` | no |
+
+**Returns:** `void`
+
+## createFileVersionCurrent
+
+`POST /files/{file_id}/versions/current`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `FileVersionCurrentCreateRequest`
+
+**Returns:** `FileVersionFull`
+

package/docs/managers/file_watermarks.md

@@ -0,0 +1,37 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FileWatermarksManager
+
+Reach these methods through the `fileWatermarks` field on `Client`.
+
+## getFileWatermark
+
+`GET /files/{file_id}/watermark`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Returns:** `Watermark`
+
+## updateFileWatermark
+
+`PUT /files/{file_id}/watermark`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `FileWatermarkUpdateRequest`
+
+**Returns:** `Watermark`
+
+## deleteFileWatermark
+
+`DELETE /files/{file_id}/watermark`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/files.md

@@ -0,0 +1,72 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FilesManager
+
+Reach these methods through the `files` field on `Client`.
+
+## get
+
+`GET /files/{file_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `if-none-match` | header | `string` | no |
+| `boxapi` | header | `string` | no |
+| `x-rep-hints` | header | `string` | no |
+
+**Returns:** `FileFull`
+
+## update
+
+`PUT /files/{file_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `if-match` | header | `string` | no |
+
+**Request body** (`application/json`): `FileUpdateRequest`
+
+**Returns:** `FileFull`
+
+## delete_
+
+`DELETE /files/{file_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `if-match` | header | `string` | no |
+
+**Returns:** `void`
+
+## copy
+
+`POST /files/{file_id}/copy`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `FileCopyRequest`
+
+**Returns:** `FileFull`
+
+## getThumbnail
+
+`GET /files/{file_id}/thumbnail.{extension}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `extension` | path | `GetIdThumbnailIdExtension` | yes |
+| `min_height` | query | `number` | no |
+| `min_width` | query | `number` | no |
+| `max_height` | query | `number` | no |
+| `max_width` | query | `number` | no |
+
+**Returns:** a binary stream (`runtime.Stream`)
+

package/docs/managers/folder_classifications.md

@@ -0,0 +1,49 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FolderClassificationsManager
+
+Reach these methods through the `folderClassifications` field on `Client`.
+
+## get
+
+`GET /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+
+**Returns:** `Classification`
+
+## update
+
+`PUT /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+
+**Request body** (`application/json-patch+json`): `Array<FileClassificationUpdateRequest>`
+
+**Returns:** `Classification`
+
+## create
+
+`POST /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `FileClassificationCreateRequest`
+
+**Returns:** `Classification`
+
+## delete_
+
+`DELETE /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/folder_locks.md

@@ -0,0 +1,33 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FolderLocksManager
+
+Reach these methods through the `folderLocks` field on `Client`.
+
+## list
+
+`GET /folder_locks`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | query | `string` | yes |
+
+**Returns:** `FolderLocks`
+
+## create
+
+`POST /folder_locks`
+
+**Request body** (`application/json`): `FolderLockCreateRequest`
+
+**Returns:** `FolderLock`
+
+## delete_
+
+`DELETE /folder_locks/{folder_lock_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_lock_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/folder_metadata.md

@@ -0,0 +1,68 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FolderMetadataManager
+
+Reach these methods through the `folderMetadata` field on `Client`.
+
+## listFolderMetadata
+
+`GET /folders/{folder_id}/metadata`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `view` | query | `string` | no |
+
+**Returns:** `Metadatas`
+
+## getFolderMetadata
+
+`GET /folders/{folder_id}/metadata/{scope}/{template_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Returns:** `MetadataFull`
+
+## updateFolderMetadata
+
+`PUT /folders/{folder_id}/metadata/{scope}/{template_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Request body** (`application/json-patch+json`): `Array<FileMetadataUpdateRequest>`
+
+**Returns:** `MetadataFull`
+
+## createFolderMetadata
+
+`POST /folders/{folder_id}/metadata/{scope}/{template_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Request body** (`application/json`): `Record<string, unknown>`
+
+**Returns:** `MetadataFull`
+
+## deleteFolderMetadata
+
+`DELETE /folders/{folder_id}/metadata/{scope}/{template_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/folder_watermarks.md

@@ -0,0 +1,37 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FolderWatermarksManager
+
+Reach these methods through the `folderWatermarks` field on `Client`.
+
+## getFolderWatermark
+
+`GET /folders/{folder_id}/watermark`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+
+**Returns:** `Watermark`
+
+## updateFolderWatermark
+
+`PUT /folders/{folder_id}/watermark`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `FileWatermarkUpdateRequest`
+
+**Returns:** `Watermark`
+
+## deleteFolderWatermark
+
+`DELETE /folders/{folder_id}/watermark`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/folders.md

@@ -0,0 +1,93 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# FoldersManager
+
+Reach these methods through the `folders` field on `Client`.
+
+## get
+
+`GET /folders/{folder_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `if-none-match` | header | `string` | no |
+| `boxapi` | header | `string` | no |
+| `sort` | query | `GetIdSort` | no |
+| `direction` | query | `OrderDirection` | no |
+| `offset` | query | `number` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `FolderFull`
+
+## update
+
+`PUT /folders/{folder_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `if-match` | header | `string` | no |
+
+**Request body** (`application/json`): `FolderUpdateRequest`
+
+**Returns:** `FolderFull`
+
+## delete_
+
+`DELETE /folders/{folder_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `if-match` | header | `string` | no |
+| `recursive` | query | `boolean` | no |
+
+**Returns:** `void`
+
+## listItems
+
+`GET /folders/{folder_id}/items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `usemarker` | query | `boolean` | no |
+| `marker` | query | `string` | no |
+| `offset` | query | `number` | no |
+| `limit` | query | `number` | no |
+| `boxapi` | header | `string` | no |
+| `sort` | query | `GetIdSort` | no |
+| `direction` | query | `OrderDirection` | no |
+
+**Returns:** `Items`
+
+Paginated — `listItems(...)` 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 /folders`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `FolderCreateRequest`
+
+**Returns:** `FolderFull`
+
+## copy
+
+`POST /folders/{folder_id}/copy`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `FolderCopyRequest`
+
+**Returns:** `FolderFull`
+