@unofficialbox/box-open-sdk 0.1.0

package/docs/managers/shared_links_folders.md

@@ -0,0 +1,67 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# SharedLinksFoldersManager
+
+Reach these methods through the `sharedLinksFolders` field on `Client`.
+
+## getSharedItemsFolders
+
+`GET /shared_items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `if-none-match` | header | `string` | no |
+| `fields` | query | `Array<string>` | no |
+| `boxapi` | header | `string` | yes |
+
+**Returns:** `FolderFull`
+
+## getFolderGetSharedLink
+
+`GET /folders/{folder_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Returns:** `FolderFull`
+
+## updateFolderAddSharedLink
+
+`PUT /folders/{folder_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Request body** (`application/json`): `FileUpdateRequest2`
+
+**Returns:** `FolderFull`
+
+## updateFolderUpdateSharedLink
+
+`PUT /folders/{folder_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Request body** (`application/json`): `FolderUpdateRequest2`
+
+**Returns:** `FolderFull`
+
+## updateFolderRemoveSharedLink
+
+`PUT /folders/{folder_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Request body** (`application/json`): `FileUpdateRequest3`
+
+**Returns:** `FolderFull`
+

package/docs/managers/shared_links_web_links.md

@@ -0,0 +1,67 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# SharedLinksWebLinksManager
+
+Reach these methods through the `sharedLinksWebLinks` field on `Client`.
+
+## getSharedItemsWebLinks
+
+`GET /shared_items`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `if-none-match` | header | `string` | no |
+| `fields` | query | `Array<string>` | no |
+| `boxapi` | header | `string` | yes |
+
+**Returns:** `WebLink`
+
+## getWebLinkGetSharedLink
+
+`GET /web_links/{web_link_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Returns:** `WebLink`
+
+## updateWebLinkAddSharedLink
+
+`PUT /web_links/{web_link_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Request body** (`application/json`): `FileUpdateRequest2`
+
+**Returns:** `WebLink`
+
+## updateWebLinkUpdateSharedLink
+
+`PUT /web_links/{web_link_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Request body** (`application/json`): `FileUpdateRequest2`
+
+**Returns:** `WebLink`
+
+## updateWebLinkRemoveSharedLink
+
+`PUT /web_links/{web_link_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `web_link_id` | path | `string` | yes |
+| `fields` | query | `string` | yes |
+
+**Request body** (`application/json`): `FileUpdateRequest3`
+
+**Returns:** `WebLink`
+

package/docs/managers/shield_information_barrier_reports.md

@@ -0,0 +1,37 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ShieldInformationBarrierReportsManager
+
+Reach these methods through the `shieldInformationBarrierReports` field on `Client`.
+
+## list
+
+`GET /shield_information_barrier_reports`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShieldInformationBarrierReports`
+
+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 /shield_information_barrier_reports`
+
+**Request body** (`application/json`): `ShieldInformationBarrierReference`
+
+**Returns:** `ShieldInformationBarrierReport`
+
+## get
+
+`GET /shield_information_barrier_reports/{shield_information_barrier_report_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_report_id` | path | `string` | yes |
+
+**Returns:** `ShieldInformationBarrierReport`
+

package/docs/managers/shield_information_barrier_segment_members.md

@@ -0,0 +1,47 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ShieldInformationBarrierSegmentMembersManager
+
+Reach these methods through the `shieldInformationBarrierSegmentMembers` field on `Client`.
+
+## get
+
+`GET /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_segment_member_id` | path | `string` | yes |
+
+**Returns:** `ShieldInformationBarrierSegmentMember`
+
+## delete_
+
+`DELETE /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_segment_member_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## list
+
+`GET /shield_information_barrier_segment_members`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_segment_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShieldInformationBarrierSegmentMembers`
+
+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 /shield_information_barrier_segment_members`
+
+**Request body** (`application/json`): `ShieldInformationBarrierSegmentMemberCreateRequest`
+
+**Returns:** `ShieldInformationBarrierSegmentMember`
+

package/docs/managers/shield_information_barrier_segment_restrictions.md

@@ -0,0 +1,47 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ShieldInformationBarrierSegmentRestrictionsManager
+
+Reach these methods through the `shieldInformationBarrierSegmentRestrictions` field on `Client`.
+
+## get
+
+`GET /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_segment_restriction_id` | path | `string` | yes |
+
+**Returns:** `ShieldInformationBarrierSegmentRestriction`
+
+## delete_
+
+`DELETE /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_segment_restriction_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## list
+
+`GET /shield_information_barrier_segment_restrictions`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_segment_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShieldInformationBarrierSegmentRestrictions`
+
+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 /shield_information_barrier_segment_restrictions`
+
+**Request body** (`application/json`): `ShieldInformationBarrierSegmentRestrictionCreateRequest`
+
+**Returns:** `ShieldInformationBarrierSegmentRestriction`
+

package/docs/managers/shield_information_barrier_segments.md

@@ -0,0 +1,59 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ShieldInformationBarrierSegmentsManager
+
+Reach these methods through the `shieldInformationBarrierSegments` field on `Client`.
+
+## get
+
+`GET /shield_information_barrier_segments/{shield_information_barrier_segment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_segment_id` | path | `string` | yes |
+
+**Returns:** `ShieldInformationBarrierSegment`
+
+## update
+
+`PUT /shield_information_barrier_segments/{shield_information_barrier_segment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_segment_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `ShieldInformationBarrierSegmentUpdateRequest`
+
+**Returns:** `ShieldInformationBarrierSegment`
+
+## delete_
+
+`DELETE /shield_information_barrier_segments/{shield_information_barrier_segment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_segment_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## list
+
+`GET /shield_information_barrier_segments`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShieldInformationBarrierSegments`
+
+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 /shield_information_barrier_segments`
+
+**Request body** (`application/json`): `ShieldInformationBarrierSegmentCreateRequest`
+
+**Returns:** `ShieldInformationBarrierSegment`
+

package/docs/managers/shield_information_barriers.md

@@ -0,0 +1,44 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ShieldInformationBarriersManager
+
+Reach these methods through the `shieldInformationBarriers` field on `Client`.
+
+## get
+
+`GET /shield_information_barriers/{shield_information_barrier_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_information_barrier_id` | path | `string` | yes |
+
+**Returns:** `ShieldInformationBarrier`
+
+## createChangeStatus
+
+`POST /shield_information_barriers/change_status`
+
+**Request body** (`application/json`): `ChangeStatusCreateRequest`
+
+**Returns:** `ShieldInformationBarrier`
+
+## list
+
+`GET /shield_information_barriers`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShieldInformationBarriers`
+
+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 /shield_information_barriers`
+
+**Request body** (`application/json`): `ShieldInformationBarrierCreateRequest`
+
+**Returns:** `ShieldInformationBarrier`
+

package/docs/managers/shield_lists.md

@@ -0,0 +1,51 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ShieldListsManager
+
+Reach these methods through the `shieldLists` field on `Client`.
+
+## list
+
+`GET /shield_lists`
+
+**Returns:** `ShieldLists`
+
+## create
+
+`POST /shield_lists`
+
+**Request body** (`application/json`): `ShieldListsCreate`
+
+**Returns:** `ShieldList`
+
+## get
+
+`GET /shield_lists/{shield_list_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_list_id` | path | `string` | yes |
+
+**Returns:** `ShieldList`
+
+## update
+
+`PUT /shield_lists/{shield_list_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_list_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `ShieldListsUpdate`
+
+**Returns:** `ShieldList`
+
+## delete_
+
+`DELETE /shield_lists/{shield_list_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shield_list_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/sign_requests.md

@@ -0,0 +1,60 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# SignRequestsManager
+
+Reach these methods through the `signRequests` field on `Client`.
+
+## cancel
+
+`POST /sign_requests/{sign_request_id}/cancel`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `sign_request_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `SignRequestCancelRequest`
+
+**Returns:** `SignRequest`
+
+## resend
+
+`POST /sign_requests/{sign_request_id}/resend`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `sign_request_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## get
+
+`GET /sign_requests/{sign_request_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `sign_request_id` | path | `string` | yes |
+
+**Returns:** `SignRequest`
+
+## list
+
+`GET /sign_requests`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+| `senders` | query | `Array<string>` | no |
+| `shared_requests` | query | `boolean` | no |
+
+**Returns:** `SignRequests`
+
+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 /sign_requests`
+
+**Request body** (`application/json`): `SignRequestCreateRequest`
+
+**Returns:** `SignRequest`
+

package/docs/managers/sign_templates.md

@@ -0,0 +1,28 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# SignTemplatesManager
+
+Reach these methods through the `signTemplates` field on `Client`.
+
+## list
+
+`GET /sign_templates`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `SignTemplates`
+
+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 /sign_templates/{template_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `template_id` | path | `string` | yes |
+
+**Returns:** `SignTemplate`
+

package/docs/managers/skills.md

@@ -0,0 +1,61 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# SkillsManager
+
+Reach these methods through the `skills` field on `Client`.
+
+## get
+
+`GET /files/{file_id}/metadata/global/boxSkillsCards`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Returns:** `SkillCardsMetadata`
+
+## update
+
+`PUT /files/{file_id}/metadata/global/boxSkillsCards`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Request body** (`application/json-patch+json`): `Array<SkillUpdateRequest>`
+
+**Returns:** `SkillCardsMetadata`
+
+## create
+
+`POST /files/{file_id}/metadata/global/boxSkillsCards`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `SkillCreateRequest`
+
+**Returns:** `SkillCardsMetadata`
+
+## delete_
+
+`DELETE /files/{file_id}/metadata/global/boxSkillsCards`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+## updateSkillInvocation
+
+`PUT /skill_invocations/{skill_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `skill_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `SkillInvocationUpdateRequest`
+
+**Returns:** `void`
+

package/docs/managers/storage_policies.md

@@ -0,0 +1,29 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# StoragePoliciesManager
+
+Reach these methods through the `storagePolicies` field on `Client`.
+
+## list
+
+`GET /storage_policies`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `fields` | query | `Array<string>` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `StoragePolicies`
+
+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 /storage_policies/{storage_policy_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `storage_policy_id` | path | `string` | yes |
+
+**Returns:** `StoragePolicy`
+

package/docs/managers/storage_policy_assignments.md

@@ -0,0 +1,59 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# StoragePolicyAssignmentsManager
+
+Reach these methods through the `storagePolicyAssignments` field on `Client`.
+
+## list
+
+`GET /storage_policy_assignments`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `resolved_for_type` | query | `GetResolvedForType` | yes |
+| `resolved_for_id` | query | `string` | yes |
+
+**Returns:** `StoragePolicyAssignments`
+
+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 /storage_policy_assignments`
+
+**Request body** (`application/json`): `StoragePolicyAssignmentCreateRequest`
+
+**Returns:** `StoragePolicyAssignment`
+
+## get
+
+`GET /storage_policy_assignments/{storage_policy_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `storage_policy_assignment_id` | path | `string` | yes |
+
+**Returns:** `StoragePolicyAssignment`
+
+## update
+
+`PUT /storage_policy_assignments/{storage_policy_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `storage_policy_assignment_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `StoragePolicyAssignmentUpdateRequest`
+
+**Returns:** `StoragePolicyAssignment`
+
+## delete_
+
+`DELETE /storage_policy_assignments/{storage_policy_assignment_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `storage_policy_assignment_id` | path | `string` | yes |
+
+**Returns:** `void`
+