@unofficialbox/box-open-sdk 0.1.0

package/docs/managers/metadata_cascade_policies.md

@@ -0,0 +1,60 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# MetadataCascadePoliciesManager
+
+Reach these methods through the `metadataCascadePolicies` field on `Client`.
+
+## list
+
+`GET /metadata_cascade_policies`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | query | `string` | yes |
+| `owner_enterprise_id` | query | `string` | no |
+| `marker` | query | `string` | no |
+| `offset` | query | `number` | no |
+
+**Returns:** `MetadataCascadePolicies`
+
+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 /metadata_cascade_policies`
+
+**Request body** (`application/json`): `MetadataCascadePolicyCreateRequest`
+
+**Returns:** `MetadataCascadePolicy`
+
+## get
+
+`GET /metadata_cascade_policies/{metadata_cascade_policy_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `metadata_cascade_policy_id` | path | `string` | yes |
+
+**Returns:** `MetadataCascadePolicy`
+
+## delete_
+
+`DELETE /metadata_cascade_policies/{metadata_cascade_policy_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `metadata_cascade_policy_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## apply
+
+`POST /metadata_cascade_policies/{metadata_cascade_policy_id}/apply`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `metadata_cascade_policy_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `MetadataCascadePolicyApplyRequest`
+
+**Returns:** `void`
+

package/docs/managers/metadata_taxonomies.md

@@ -0,0 +1,206 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# MetadataTaxonomiesManager
+
+Reach these methods through the `metadataTaxonomies` field on `Client`.
+
+## create
+
+`POST /metadata_taxonomies`
+
+**Request body** (`application/json`): `MetadataTaxonomyCreateRequest`
+
+**Returns:** `MetadataTaxonomy`
+
+## list
+
+`GET /metadata_taxonomies/{namespace}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `MetadataTaxonomies`
+
+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 /metadata_taxonomies/{namespace}/{taxonomy_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+
+**Returns:** `MetadataTaxonomy`
+
+## delete_
+
+`DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+
+**Returns:** `void`
+
+## update
+
+`PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+
+**Request body** (`application/json`): `MetadataTaxonomyUpdateRequest`
+
+**Returns:** `MetadataTaxonomy`
+
+## createLevels
+
+`POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+
+**Request body** (`application/json`): `Array<MetadataTaxonomyLevel>`
+
+**Returns:** `MetadataTaxonomyLevels`
+
+## updateLevel
+
+`PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+| `level_index` | path | `number` | yes |
+
+**Request body** (`application/json`): `LevelUpdateRequest`
+
+**Returns:** `MetadataTaxonomyLevel`
+
+## appendLevels
+
+`POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+
+**Request body** (`application/json`): `LevelUpdateRequest`
+
+**Returns:** `MetadataTaxonomyLevels`
+
+## trimLevels
+
+`POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+
+**Returns:** `MetadataTaxonomyLevels`
+
+## listNodes
+
+`GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+| `level` | query | `Array<number>` | no |
+| `parent` | query | `Array<string>` | no |
+| `ancestor` | query | `Array<string>` | no |
+| `query` | query | `string` | no |
+| `include-total-result-count` | query | `boolean` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `MetadataTaxonomyNodes`
+
+Paginated — `listNodes(...)` 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).
+
+## createNodes
+
+`POST /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+
+**Request body** (`application/json`): `NodesCreateRequest`
+
+**Returns:** `MetadataTaxonomyNode`
+
+## getNode
+
+`GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+| `node_id` | path | `string` | yes |
+
+**Returns:** `MetadataTaxonomyNode`
+
+## deleteNode
+
+`DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+| `node_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## updateNode
+
+`PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `taxonomy_key` | path | `string` | yes |
+| `node_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `NodeUpdateRequest`
+
+**Returns:** `MetadataTaxonomyNode`
+
+## listMetadataTemplateFieldOptions
+
+`GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `namespace` | path | `string` | yes |
+| `template_key` | path | `string` | yes |
+| `field_key` | path | `string` | yes |
+| `level` | query | `Array<number>` | no |
+| `parent` | query | `Array<string>` | no |
+| `ancestor` | query | `Array<string>` | no |
+| `query` | query | `string` | no |
+| `include-total-result-count` | query | `boolean` | no |
+| `only-selectable-options` | query | `boolean` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `MetadataTaxonomyNodes`
+
+Paginated — `listMetadataTemplateFieldOptions(...)` 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/metadata_templates.md

@@ -0,0 +1,98 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# MetadataTemplatesManager
+
+Reach these methods through the `metadataTemplates` field on `Client`.
+
+## list
+
+`GET /metadata_templates`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `metadata_instance_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `MetadataTemplates`
+
+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).
+
+## getSchema
+
+`GET /metadata_templates/{scope}/{template_key}/schema`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Returns:** `MetadataTemplate`
+
+## updateSchema
+
+`PUT /metadata_templates/{scope}/{template_key}/schema`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Request body** (`application/json-patch+json`): `Array<SchemaUpdateRequest>`
+
+**Returns:** `MetadataTemplate`
+
+## deleteSchema
+
+`DELETE /metadata_templates/{scope}/{template_key}/schema`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `scope` | path | `GetFileIdMetadataIdIdScope` | yes |
+| `template_key` | path | `string` | yes |
+
+**Returns:** `void`
+
+## get
+
+`GET /metadata_templates/{template_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `template_id` | path | `string` | yes |
+
+**Returns:** `MetadataTemplate`
+
+## listGlobal
+
+`GET /metadata_templates/global`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `MetadataTemplates`
+
+Paginated — `listGlobal(...)` 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).
+
+## listEnterprise
+
+`GET /metadata_templates/enterprise`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `MetadataTemplates`
+
+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).
+
+## createSchema
+
+`POST /metadata_templates/schema`
+
+**Request body** (`application/json`): `SchemaCreateRequest`
+
+**Returns:** `MetadataTemplate`
+

package/docs/managers/notes.md

@@ -0,0 +1,13 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# NotesManager
+
+Reach these methods through the `notes` field on `Client`.
+
+## convert
+
+`POST /notes/convert`
+
+**Request body** (`application/json`): `NotesConvertRequestBody`
+
+**Returns:** `NotesConvertResponse`
+

package/docs/managers/recent_items.md

@@ -0,0 +1,19 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# RecentItemsManager
+
+Reach these methods through the `recentItems` field on `Client`.
+
+## list
+
+`GET /recent_items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+
+**Returns:** `RecentItems`
+
+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/retention_policies.md

@@ -0,0 +1,63 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# RetentionPoliciesManager
+
+Reach these methods through the `retentionPolicies` field on `Client`.
+
+## list
+
+`GET /retention_policies`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `policy_name` | query | `string` | no |
+| `policy_type` | query | `RetentionPolicyPolicyType` | no |
+| `created_by_user_id` | query | `string` | no |
+| `fields` | query | `Array<string>` | no |
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+
+**Returns:** `RetentionPolicies`
+
+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 /retention_policies`
+
+**Request body** (`application/json`): `RetentionPolicyCreateRequest`
+
+**Returns:** `RetentionPolicy`
+
+## get
+
+`GET /retention_policies/{retention_policy_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `retention_policy_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `RetentionPolicy`
+
+## update
+
+`PUT /retention_policies/{retention_policy_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `retention_policy_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `RetentionPolicyUpdateRequest`
+
+**Returns:** `RetentionPolicy`
+
+## delete_
+
+`DELETE /retention_policies/{retention_policy_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `retention_policy_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/retention_policy_assignments.md

@@ -0,0 +1,78 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# RetentionPolicyAssignmentsManager
+
+Reach these methods through the `retentionPolicyAssignments` field on `Client`.
+
+## listRetentionPolicyAssignments
+
+`GET /retention_policies/{retention_policy_id}/assignments`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `retention_policy_id` | path | `string` | yes |
+| `type` | query | `AssignedToType` | no |
+| `fields` | query | `Array<string>` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `RetentionPolicyAssignments`
+
+Paginated — `listRetentionPolicyAssignments(...)` 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 /retention_policy_assignments`
+
+**Request body** (`application/json`): `RetentionPolicyAssignmentCreateRequest`
+
+**Returns:** `RetentionPolicyAssignment`
+
+## get
+
+`GET /retention_policy_assignments/{retention_policy_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `retention_policy_assignment_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `RetentionPolicyAssignment`
+
+## delete_
+
+`DELETE /retention_policy_assignments/{retention_policy_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `retention_policy_assignment_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## listFileUnderRetention
+
+`GET /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `retention_policy_assignment_id` | path | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `FilesUnderRetention`
+
+Paginated — `listFileUnderRetention(...)` 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).
+
+## listFileVersionUnderRetention
+
+`GET /retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `retention_policy_assignment_id` | path | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `FilesUnderRetention`
+
+Paginated — `listFileVersionUnderRetention(...)` 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/search.md

@@ -0,0 +1,43 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# SearchManager
+
+Reach these methods through the `search` field on `Client`.
+
+## createMetadataQueryExecuteRead
+
+`POST /metadata_queries/execute_read`
+
+**Request body** (`application/json`): `MetadataQuery`
+
+**Returns:** `MetadataQueryResults`
+
+## get
+
+`GET /search`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `query` | query | `string` | no |
+| `scope` | query | `GetScope` | no |
+| `file_extensions` | query | `Array<string>` | no |
+| `created_at_range` | query | `Array<string>` | no |
+| `updated_at_range` | query | `Array<string>` | no |
+| `size_range` | query | `Array<number>` | no |
+| `owner_user_ids` | query | `Array<string>` | no |
+| `recent_updater_user_ids` | query | `Array<string>` | no |
+| `ancestor_folder_ids` | query | `Array<string>` | no |
+| `content_types` | query | `Array<GetContentTypes>` | no |
+| `type` | query | `GetType` | no |
+| `trash_content` | query | `GetTrashContent` | no |
+| `mdfilters` | query | `Array<MetadataFilter>` | no |
+| `sort` | query | `GetSort` | no |
+| `direction` | query | `GetDirection` | no |
+| `limit` | query | `number` | no |
+| `include_recent_shared_links` | query | `boolean` | no |
+| `fields` | query | `Array<string>` | no |
+| `offset` | query | `number` | no |
+| `deleted_user_ids` | query | `Array<string>` | no |
+| `deleted_at_range` | query | `Array<string>` | no |
+
+**Returns:** `SearchResultsResponse`
+

package/docs/managers/session_termination.md

@@ -0,0 +1,21 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# SessionTerminationManager
+
+Reach these methods through the `sessionTermination` field on `Client`.
+
+## createUserTerminateSessions
+
+`POST /users/terminate_sessions`
+
+**Request body** (`application/json`): `UserTerminateSessionsCreateRequest`
+
+**Returns:** `SessionTerminationMessage`
+
+## createGroupTerminateSessions
+
+`POST /groups/terminate_sessions`
+
+**Request body** (`application/json`): `GroupTerminateSessionsCreateRequest`
+
+**Returns:** `SessionTerminationMessage`
+

package/docs/managers/shared_links_app_items.md

@@ -0,0 +1,15 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# SharedLinksAppItemsManager
+
+Reach these methods through the `sharedLinksAppItems` field on `Client`.
+
+## getSharedItemsAppItems
+
+`GET /shared_items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `boxapi` | header | `string` | yes |
+
+**Returns:** `AppItem`
+

package/docs/managers/shared_links_files.md

@@ -0,0 +1,67 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# SharedLinksFilesManager
+
+Reach these methods through the `sharedLinksFiles` field on `Client`.
+
+## getSharedItems
+
+`GET /shared_items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `if-none-match` | header | `string` | no |
+| `fields` | query | `Array<string>` | no |
+| `boxapi` | header | `string` | yes |
+
+**Returns:** `FileFull`
+
+## getFileGetSharedLink
+
+`GET /files/{file_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Returns:** `FileFull`
+
+## updateFileAddSharedLink
+
+`PUT /files/{file_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Request body** (`application/json`): `FileUpdateRequest2`
+
+**Returns:** `FileFull`
+
+## updateFileUpdateSharedLink
+
+`PUT /files/{file_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Request body** (`application/json`): `FileUpdateRequest2`
+
+**Returns:** `FileFull`
+
+## updateFileRemoveSharedLink
+
+`PUT /files/{file_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Request body** (`application/json`): `FileUpdateRequest3`
+
+**Returns:** `FileFull`
+