@unofficialbox/box-open-sdk 0.1.0

package/docs/managers/groups.md

@@ -0,0 +1,66 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# GroupsManager
+
+Reach these methods through the `groups` field on `Client`.
+
+## list
+
+`GET /groups`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `filter_term` | query | `string` | no |
+| `fields` | query | `Array<string>` | no |
+| `limit` | query | `number` | no |
+| `offset` | query | `number` | no |
+
+**Returns:** `Groups`
+
+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 /groups`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `GroupCreateRequest`
+
+**Returns:** `GroupFull`
+
+## get
+
+`GET /groups/{group_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `group_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `GroupFull`
+
+## update
+
+`PUT /groups/{group_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `group_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `GroupUpdateRequest`
+
+**Returns:** `GroupFull`
+
+## delete_
+
+`DELETE /groups/{group_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `group_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/hub_collaborations.md

@@ -0,0 +1,59 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# HubCollaborationsManager
+
+Reach these methods through the `hubCollaborations` field on `Client`.
+
+## list
+
+`GET /hub_collaborations`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `HubCollaborations`
+
+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 /hub_collaborations`
+
+**Request body** (`application/json`): `HubCollaborationCreateRequest`
+
+**Returns:** `HubCollaboration`
+
+## get
+
+`GET /hub_collaborations/{hub_collaboration_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_collaboration_id` | path | `string` | yes |
+
+**Returns:** `HubCollaboration`
+
+## update
+
+`PUT /hub_collaborations/{hub_collaboration_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_collaboration_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `HubCollaborationUpdateRequest`
+
+**Returns:** `HubCollaboration`
+
+## delete_
+
+`DELETE /hub_collaborations/{hub_collaboration_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_collaboration_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/hub_document.md

@@ -0,0 +1,34 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# HubDocumentManager
+
+Reach these methods through the `hubDocument` field on `Client`.
+
+## listPages
+
+`GET /hub_document_pages`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `HubDocumentPages`
+
+Paginated — `listPages(...)` 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).
+
+## listBlocks
+
+`GET /hub_document_blocks`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_id` | query | `string` | yes |
+| `page_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `HubDocumentBlocks`
+
+Paginated — `listBlocks(...)` 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/hub_items.md

@@ -0,0 +1,32 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# HubItemsManager
+
+Reach these methods through the `hubItems` field on `Client`.
+
+## list
+
+`GET /hub_items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_id` | query | `string` | yes |
+| `parent_id` | query | `string` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `HubItems`
+
+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).
+
+## createHubManageItems
+
+`POST /hubs/{hub_id}/manage_items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `HubItemsManageRequest`
+
+**Returns:** `HubItemsManageResponse`
+

package/docs/managers/hubs.md

@@ -0,0 +1,90 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# HubsManager
+
+Reach these methods through the `hubs` field on `Client`.
+
+## list
+
+`GET /hubs`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `query` | query | `string` | no |
+| `scope` | query | `string` | no |
+| `sort` | query | `string` | no |
+| `direction` | query | `GetDirection` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `Hubs`
+
+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 /hubs`
+
+**Request body** (`application/json`): `HubCreateRequest`
+
+**Returns:** `Hub`
+
+## listEnterprise
+
+`GET /enterprise_hubs`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `query` | query | `string` | no |
+| `sort` | query | `string` | no |
+| `direction` | query | `GetDirection` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `Hubs`
+
+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).
+
+## get
+
+`GET /hubs/{hub_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_id` | path | `string` | yes |
+
+**Returns:** `Hub`
+
+## update
+
+`PUT /hubs/{hub_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `HubUpdateRequest`
+
+**Returns:** `Hub`
+
+## delete_
+
+`DELETE /hubs/{hub_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## copy
+
+`POST /hubs/{hub_id}/copy`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `hub_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `HubCopyRequest`
+
+**Returns:** `Hub`
+

package/docs/managers/integration_mappings.md

@@ -0,0 +1,96 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# IntegrationMappingsManager
+
+Reach these methods through the `integrationMappings` field on `Client`.
+
+## listSlack
+
+`GET /integration_mappings/slack`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+| `partner_item_type` | query | `IntegrationMappingPartnerItemSlackType` | no |
+| `partner_item_id` | query | `string` | no |
+| `box_item_id` | query | `string` | no |
+| `box_item_type` | query | `FolderType` | no |
+| `is_manually_created` | query | `boolean` | no |
+
+**Returns:** `IntegrationMappings`
+
+Paginated — `listSlack(...)` 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).
+
+## createSlack
+
+`POST /integration_mappings/slack`
+
+**Request body** (`application/json`): `IntegrationMappingSlackCreateRequest`
+
+**Returns:** `IntegrationMapping`
+
+## updateSlack
+
+`PUT /integration_mappings/slack/{integration_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `integration_mapping_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `SlackUpdateRequest`
+
+**Returns:** `IntegrationMapping`
+
+## deleteSlack
+
+`DELETE /integration_mappings/slack/{integration_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `integration_mapping_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## listTeams
+
+`GET /integration_mappings/teams`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `partner_item_type` | query | `IntegrationMappingPartnerItemTeamsType` | no |
+| `partner_item_id` | query | `string` | no |
+| `box_item_id` | query | `string` | no |
+| `box_item_type` | query | `FolderType` | no |
+
+**Returns:** `IntegrationMappingsTeams`
+
+## createTeams
+
+`POST /integration_mappings/teams`
+
+**Request body** (`application/json`): `IntegrationMappingTeamsCreateRequest`
+
+**Returns:** `IntegrationMappingTeams`
+
+## updateTeam
+
+`PUT /integration_mappings/teams/{integration_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `integration_mapping_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `TeamUpdateRequest`
+
+**Returns:** `IntegrationMappingTeams`
+
+## deleteTeam
+
+`DELETE /integration_mappings/teams/{integration_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `integration_mapping_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/invites.md

@@ -0,0 +1,28 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# InvitesManager
+
+Reach these methods through the `invites` field on `Client`.
+
+## create
+
+`POST /invites`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `InviteCreateRequest`
+
+**Returns:** `Invite`
+
+## get
+
+`GET /invites/{invite_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `invite_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `Invite`
+

package/docs/managers/legal_hold_policies.md

@@ -0,0 +1,60 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# LegalHoldPoliciesManager
+
+Reach these methods through the `legalHoldPolicies` field on `Client`.
+
+## list
+
+`GET /legal_hold_policies`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `policy_name` | query | `string` | no |
+| `fields` | query | `Array<string>` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `LegalHoldPolicies`
+
+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 /legal_hold_policies`
+
+**Request body** (`application/json`): `LegalHoldPolicyCreateRequest`
+
+**Returns:** `LegalHoldPolicy`
+
+## get
+
+`GET /legal_hold_policies/{legal_hold_policy_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `legal_hold_policy_id` | path | `string` | yes |
+
+**Returns:** `LegalHoldPolicy`
+
+## update
+
+`PUT /legal_hold_policies/{legal_hold_policy_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `legal_hold_policy_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `LegalHoldPolicyUpdateRequest`
+
+**Returns:** `LegalHoldPolicy`
+
+## delete_
+
+`DELETE /legal_hold_policies/{legal_hold_policy_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `legal_hold_policy_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/legal_hold_policy_assignments.md

@@ -0,0 +1,80 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# LegalHoldPolicyAssignmentsManager
+
+Reach these methods through the `legalHoldPolicyAssignments` field on `Client`.
+
+## list
+
+`GET /legal_hold_policy_assignments`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `policy_id` | query | `string` | yes |
+| `assign_to_type` | query | `LegalHoldPolicyAssignedItemType` | no |
+| `assign_to_id` | query | `string` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `LegalHoldPolicyAssignments`
+
+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 /legal_hold_policy_assignments`
+
+**Request body** (`application/json`): `LegalHoldPolicyAssignmentCreateRequest`
+
+**Returns:** `LegalHoldPolicyAssignment`
+
+## get
+
+`GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `legal_hold_policy_assignment_id` | path | `string` | yes |
+
+**Returns:** `LegalHoldPolicyAssignment`
+
+## delete_
+
+`DELETE /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `legal_hold_policy_assignment_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## listFileOnHold
+
+`GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `legal_hold_policy_assignment_id` | path | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `FilesOnHold`
+
+Paginated — `listFileOnHold(...)` 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).
+
+## listFileVersionOnHold
+
+`GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `legal_hold_policy_assignment_id` | path | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `FileVersionsOnHold`
+
+Paginated — `listFileVersionOnHold(...)` 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/list_collaborations.md

@@ -0,0 +1,64 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ListCollaborationsManager
+
+Reach these methods through the `listCollaborations` field on `Client`.
+
+## listFileCollaborations
+
+`GET /files/{file_id}/collaborations`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+
+**Returns:** `Collaborations`
+
+Paginated — `listFileCollaborations(...)` 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).
+
+## listFolderCollaborations
+
+`GET /folders/{folder_id}/collaborations`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+
+**Returns:** `Collaborations`
+
+Paginated — `listFolderCollaborations(...)` 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).
+
+## listCollaborations
+
+`GET /collaborations`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `status` | query | `GetCollaborationsStatus` | yes |
+| `fields` | query | `Array<string>` | no |
+| `offset` | query | `number` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `CollaborationsOffsetPaginated`
+
+Paginated — `listCollaborations(...)` 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).
+
+## listGroupCollaborations
+
+`GET /groups/{group_id}/collaborations`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `group_id` | path | `string` | yes |
+| `limit` | query | `number` | no |
+| `offset` | query | `number` | no |
+
+**Returns:** `CollaborationsOffsetPaginated`
+
+Paginated — `listGroupCollaborations(...)` 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/memberships.md

@@ -0,0 +1,79 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# MembershipsManager
+
+Reach these methods through the `memberships` field on `Client`.
+
+## listUser
+
+`GET /users/{user_id}/memberships`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+| `limit` | query | `number` | no |
+| `offset` | query | `number` | no |
+
+**Returns:** `GroupMemberships`
+
+Paginated — `listUser(...)` 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).
+
+## listGroup
+
+`GET /groups/{group_id}/memberships`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `group_id` | path | `string` | yes |
+| `limit` | query | `number` | no |
+| `offset` | query | `number` | no |
+
+**Returns:** `GroupMemberships`
+
+Paginated — `listGroup(...)` 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).
+
+## createGroup
+
+`POST /group_memberships`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `GroupCreateRequest2`
+
+**Returns:** `GroupMembership`
+
+## getGroup
+
+`GET /group_memberships/{group_membership_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `group_membership_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `GroupMembership`
+
+## updateGroup
+
+`PUT /group_memberships/{group_membership_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `group_membership_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Request body** (`application/json`): `GroupUpdateRequest2`
+
+**Returns:** `GroupMembership`
+
+## deleteGroup
+
+`DELETE /group_memberships/{group_membership_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `group_membership_id` | path | `string` | yes |
+
+**Returns:** `void`
+