@unofficialbox/box-open-sdk 0.1.0

package/docs/managers/chunked_uploads.md

@@ -0,0 +1,88 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ChunkedUploadsManager
+
+Reach these methods through the `chunkedUploads` field on `Client`.
+
+## createFileUploadSessions
+
+`POST /files/upload_sessions`
+
+**Request body** (`application/json`): `FileUploadSessionsCreateRequest`
+
+**Returns:** `UploadSession`
+
+## createFileByIdUploadSessions
+
+`POST /files/{file_id}/upload_sessions`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `FileIdUploadSessionsCreateRequest`
+
+**Returns:** `UploadSession`
+
+## getFileUploadSession
+
+`GET /files/upload_sessions/{upload_session_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `upload_session_id` | path | `string` | yes |
+
+**Returns:** `UploadSession`
+
+## updateFileUploadSession
+
+`PUT /files/upload_sessions/{upload_session_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `upload_session_id` | path | `string` | yes |
+| `digest` | header | `string` | yes |
+| `content-range` | header | `string` | yes |
+
+**Request body** (`application/octet-stream`): `Blob`
+
+**Returns:** `UploadedPart`
+
+## deleteFileUploadSession
+
+`DELETE /files/upload_sessions/{upload_session_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `upload_session_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## listFileUploadSessionParts
+
+`GET /files/upload_sessions/{upload_session_id}/parts`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `upload_session_id` | path | `string` | yes |
+| `offset` | query | `number` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `UploadParts`
+
+Paginated — `listFileUploadSessionParts(...)` 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).
+
+## commitFileUploadSession
+
+`POST /files/upload_sessions/{upload_session_id}/commit`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `upload_session_id` | path | `string` | yes |
+| `digest` | header | `string` | yes |
+| `if-match` | header | `string` | no |
+| `if-none-match` | header | `string` | no |
+
+**Request body** (`application/json`): `FileUploadSessionCommitRequest`
+
+**Returns:** `Files`
+

package/docs/managers/classifications.md

@@ -0,0 +1,35 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ClassificationsManager
+
+Reach these methods through the `classifications` field on `Client`.
+
+## get
+
+`GET /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema`
+
+**Returns:** `ClassificationTemplate`
+
+## updateAdd
+
+`PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema`
+
+**Request body** (`application/json`): `Array<ClassificationUpdateRequest>`
+
+**Returns:** `ClassificationTemplate`
+
+## updateUpdate
+
+`PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema`
+
+**Request body** (`application/json-patch+json`): `Array<ClassificationUpdateRequest2>`
+
+**Returns:** `ClassificationTemplate`
+
+## createMetadataTemplateSchemaClassifications
+
+`POST /metadata_templates/schema`
+
+**Request body** (`application/json`): `MetadataTemplateSchemaCreateRequest`
+
+**Returns:** `ClassificationTemplate`
+

package/docs/managers/collaboration_allowlist_entries.md

@@ -0,0 +1,46 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# CollaborationAllowlistEntriesManager
+
+Reach these methods through the `collaborationAllowlistEntries` field on `Client`.
+
+## listCollaborationWhitelistEntries
+
+`GET /collaboration_whitelist_entries`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `CollaborationAllowlistEntries`
+
+Paginated — `listCollaborationWhitelistEntries(...)` 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).
+
+## createCollaborationWhitelistEntries
+
+`POST /collaboration_whitelist_entries`
+
+**Request body** (`application/json`): `CollaborationWhitelistEntriesCreateRequest`
+
+**Returns:** `CollaborationAllowlistEntry`
+
+## getCollaborationWhitelistEntry
+
+`GET /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `collaboration_whitelist_entry_id` | path | `string` | yes |
+
+**Returns:** `CollaborationAllowlistEntry`
+
+## deleteCollaborationWhitelistEntry
+
+`DELETE /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `collaboration_whitelist_entry_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/collaboration_allowlist_exempt_targets.md

@@ -0,0 +1,46 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# CollaborationAllowlistExemptTargetsManager
+
+Reach these methods through the `collaborationAllowlistExemptTargets` field on `Client`.
+
+## listCollaborationWhitelistExemptTargets
+
+`GET /collaboration_whitelist_exempt_targets`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `CollaborationAllowlistExemptTargets`
+
+Paginated — `listCollaborationWhitelistExemptTargets(...)` 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).
+
+## createCollaborationWhitelistExemptTargets
+
+`POST /collaboration_whitelist_exempt_targets`
+
+**Request body** (`application/json`): `CollaborationWhitelistExemptTargetsCreateRequest`
+
+**Returns:** `CollaborationAllowlistExemptTarget`
+
+## getCollaborationWhitelistExemptTarget
+
+`GET /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `collaboration_whitelist_exempt_target_id` | path | `string` | yes |
+
+**Returns:** `CollaborationAllowlistExemptTarget`
+
+## deleteCollaborationWhitelistExemptTarget
+
+`DELETE /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `collaboration_whitelist_exempt_target_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/collections.md

@@ -0,0 +1,44 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# CollectionsManager
+
+Reach these methods through the `collections` field on `Client`.
+
+## list
+
+`GET /collections`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+| `offset` | query | `number` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `Collections`
+
+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).
+
+## listItems
+
+`GET /collections/{collection_id}/items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `collection_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `offset` | query | `number` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ItemsOffsetPaginated`
+
+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).
+
+## get
+
+`GET /collections/{collection_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `collection_id` | path | `string` | yes |
+
+**Returns:** `Collection`
+

package/docs/managers/comments.md

@@ -0,0 +1,66 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# CommentsManager
+
+Reach these methods through the `comments` field on `Client`.
+
+## listFile
+
+`GET /files/{file_id}/comments`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `limit` | query | `number` | no |
+| `offset` | query | `number` | no |
+
+**Returns:** `Comments`
+
+Paginated — `listFile(...)` 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 /comments/{comment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `comment_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `CommentFull`
+
+## update
+
+`PUT /comments/{comment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `comment_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `CommentUpdateRequest`
+
+**Returns:** `CommentFull`
+
+## delete_
+
+`DELETE /comments/{comment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `comment_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## create
+
+`POST /comments`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `CommentCreateRequest`
+
+**Returns:** `CommentFull`
+

package/docs/managers/device_pinners.md

@@ -0,0 +1,40 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# DevicePinnersManager
+
+Reach these methods through the `devicePinners` field on `Client`.
+
+## get
+
+`GET /device_pinners/{device_pinner_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `device_pinner_id` | path | `string` | yes |
+
+**Returns:** `DevicePinner`
+
+## delete_
+
+`DELETE /device_pinners/{device_pinner_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `device_pinner_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## listEnterprise
+
+`GET /enterprises/{enterprise_id}/device_pinners`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `enterprise_id` | path | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+| `direction` | query | `OrderDirection` | no |
+
+**Returns:** `DevicePinners`
+
+Paginated — `listEnterprise(...)` 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/docgen.md

@@ -0,0 +1,50 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# DocgenManager
+
+Reach these methods through the `docgen` field on `Client`.
+
+## getJob
+
+`GET /docgen_jobs/{job_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `job_id` | path | `string` | yes |
+
+**Returns:** `DocGenJob`
+
+## listJobs
+
+`GET /docgen_jobs`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `DocGenJobsFull`
+
+Paginated — `listJobs(...)` 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).
+
+## listBatchJob
+
+`GET /docgen_batch_jobs/{batch_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `batch_id` | path | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `DocGenJobs`
+
+Paginated — `listBatchJob(...)` 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).
+
+## createBatches
+
+`POST /docgen_batches`
+
+**Request body** (`application/json`): `DocGenBatchCreateRequest`
+
+**Returns:** `DocGenBatchBase`
+

package/docs/managers/docgen_template.md

@@ -0,0 +1,75 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# DocgenTemplateManager
+
+Reach these methods through the `docgenTemplate` field on `Client`.
+
+## listDocgenTemplates
+
+`GET /docgen_templates`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `DocGenTemplates`
+
+Paginated — `listDocgenTemplates(...)` 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).
+
+## createDocgenTemplates
+
+`POST /docgen_templates`
+
+**Request body** (`application/json`): `DocGenTemplateCreateRequest`
+
+**Returns:** `DocGenTemplateBase`
+
+## getDocgenTemplate
+
+`GET /docgen_templates/{template_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `template_id` | path | `string` | yes |
+
+**Returns:** `DocGenTemplate`
+
+## deleteDocgenTemplate
+
+`DELETE /docgen_templates/{template_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `template_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## listDocgenTemplateTags
+
+`GET /docgen_templates/{template_id}/tags`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `template_id` | path | `string` | yes |
+| `template_version_id` | query | `string` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `DocGenTags`
+
+Paginated — `listDocgenTemplateTags(...)` 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).
+
+## listJob
+
+`GET /docgen_template_jobs/{template_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `template_id` | path | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `DocGenJobs`
+
+Paginated — `listJob(...)` 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/downloads.md

@@ -0,0 +1,19 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# DownloadsManager
+
+Reach these methods through the `downloads` field on `Client`.
+
+## getFileContent
+
+`GET /files/{file_id}/content`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `range` | header | `string` | no |
+| `boxapi` | header | `string` | no |
+| `version` | query | `string` | no |
+| `access_token` | query | `string` | no |
+
+**Returns:** a binary stream (`runtime.Stream`)
+

package/docs/managers/email_aliases.md

@@ -0,0 +1,38 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# EmailAliasesManager
+
+Reach these methods through the `emailAliases` field on `Client`.
+
+## listUser
+
+`GET /users/{user_id}/email_aliases`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+
+**Returns:** `EmailAliases`
+
+## createUser
+
+`POST /users/{user_id}/email_aliases`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `UserIdCreateRequest`
+
+**Returns:** `EmailAlias`
+
+## deleteUser
+
+`DELETE /users/{user_id}/email_aliases/{email_alias_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+| `email_alias_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/enterprise_configurations.md

@@ -0,0 +1,16 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# EnterpriseConfigurationsManager
+
+Reach these methods through the `enterpriseConfigurations` field on `Client`.
+
+## get
+
+`GET /enterprise_configurations/{enterprise_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `enterprise_id` | path | `string` | yes |
+| `categories` | query | `Array<string>` | yes |
+
+**Returns:** `EnterpriseConfiguration`
+

package/docs/managers/events.md

@@ -0,0 +1,26 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# EventsManager
+
+Reach these methods through the `events` field on `Client`.
+
+## list
+
+`GET /events`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `stream_type` | query | `GetStreamType` | no |
+| `stream_position` | query | `string` | no |
+| `limit` | query | `number` | no |
+| `event_type` | query | `Array<GetEventType>` | no |
+| `created_after` | query | `string` | no |
+| `created_before` | query | `string` | no |
+
+**Returns:** `Events`
+
+## options
+
+`OPTIONS /events`
+
+**Returns:** `RealtimeServers`
+

package/docs/managers/external_users.md

@@ -0,0 +1,13 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ExternalUsersManager
+
+Reach these methods through the `externalUsers` field on `Client`.
+
+## createSubmitDeleteJob
+
+`POST /external_users/submit_delete_job`
+
+**Request body** (`application/json`): `ExternalUsersSubmitDeleteJobRequest`
+
+**Returns:** `ExternalUsersSubmitDeleteJobResponse`
+

package/docs/managers/file_classifications.md

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