@unofficialbox/box-open-sdk 0.3.1 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/cjs/auth.js +3 -3
- package/dist/cjs/buildinfo.js +2 -2
- package/dist/cjs/client.js +3 -0
- package/dist/cjs/jwt.js +1 -1
- package/dist/cjs/managers/collaboration_allowlist_entries.js +6 -6
- package/dist/cjs/managers/collaboration_allowlist_exempt_targets.js +6 -6
- package/dist/cjs/managers/index.js +1 -0
- package/dist/cjs/managers/memberships.js +4 -4
- package/dist/cjs/managers/query.js +68 -0
- package/dist/cjs/models/schemas.js +1 -1
- package/dist/cjs/runtime.js +8 -3
- package/dist/cjs/tokens.js +5 -3
- package/dist/esm/auth.js +3 -3
- package/dist/esm/buildinfo.js +2 -2
- package/dist/esm/client.js +3 -0
- package/dist/esm/jwt.js +1 -1
- package/dist/esm/managers/collaboration_allowlist_entries.js +6 -6
- package/dist/esm/managers/collaboration_allowlist_exempt_targets.js +6 -6
- package/dist/esm/managers/index.js +1 -0
- package/dist/esm/managers/memberships.js +4 -4
- package/dist/esm/managers/query.js +31 -0
- package/dist/esm/models/schemas.js +1 -1
- package/dist/esm/runtime.js +8 -3
- package/dist/esm/tokens.js +5 -3
- package/dist/types/auth.d.ts +8 -0
- package/dist/types/buildinfo.d.ts +1 -1
- package/dist/types/client.d.ts +2 -0
- package/dist/types/jwt.d.ts +4 -0
- package/dist/types/managers/archives.d.ts +2 -2
- package/dist/types/managers/avatars.d.ts +1 -1
- package/dist/types/managers/chunked_uploads.d.ts +3 -3
- package/dist/types/managers/classifications.d.ts +3 -3
- package/dist/types/managers/collaboration_allowlist_entries.d.ts +7 -7
- package/dist/types/managers/collaboration_allowlist_exempt_targets.d.ts +7 -7
- package/dist/types/managers/comments.d.ts +2 -2
- package/dist/types/managers/email_aliases.d.ts +1 -1
- package/dist/types/managers/file_classifications.d.ts +2 -2
- package/dist/types/managers/file_metadata.d.ts +4 -4
- package/dist/types/managers/file_versions.d.ts +2 -2
- package/dist/types/managers/file_watermarks.d.ts +1 -1
- package/dist/types/managers/files.d.ts +2 -2
- package/dist/types/managers/folder_classifications.d.ts +2 -2
- package/dist/types/managers/folder_locks.d.ts +1 -1
- package/dist/types/managers/folder_metadata.d.ts +4 -4
- package/dist/types/managers/folder_watermarks.d.ts +1 -1
- package/dist/types/managers/folders.d.ts +3 -3
- package/dist/types/managers/groups.d.ts +2 -2
- package/dist/types/managers/index.d.ts +1 -0
- package/dist/types/managers/integration_mappings.d.ts +2 -2
- package/dist/types/managers/invites.d.ts +1 -1
- package/dist/types/managers/legal_hold_policies.d.ts +2 -2
- package/dist/types/managers/legal_hold_policy_assignments.d.ts +1 -1
- package/dist/types/managers/memberships.d.ts +10 -10
- package/dist/types/managers/metadata_cascade_policies.d.ts +2 -2
- package/dist/types/managers/metadata_taxonomies.d.ts +6 -6
- package/dist/types/managers/metadata_templates.d.ts +4 -4
- package/dist/types/managers/query.d.ts +9 -0
- package/dist/types/managers/retention_policies.d.ts +2 -2
- package/dist/types/managers/retention_policy_assignments.d.ts +1 -1
- package/dist/types/managers/session_termination.d.ts +2 -2
- package/dist/types/managers/shared_links_files.d.ts +3 -3
- package/dist/types/managers/shared_links_folders.d.ts +3 -3
- package/dist/types/managers/shared_links_web_links.d.ts +3 -3
- package/dist/types/managers/shield_information_barrier_segment_members.d.ts +1 -1
- package/dist/types/managers/shield_information_barrier_segment_restrictions.d.ts +1 -1
- package/dist/types/managers/shield_information_barrier_segments.d.ts +2 -2
- package/dist/types/managers/shield_information_barriers.d.ts +2 -2
- package/dist/types/managers/skills.d.ts +3 -3
- package/dist/types/managers/storage_policy_assignments.d.ts +2 -2
- package/dist/types/managers/task_assignments.d.ts +2 -2
- package/dist/types/managers/tasks.d.ts +2 -2
- package/dist/types/managers/terms_of_service_user_statuses.d.ts +2 -2
- package/dist/types/managers/terms_of_services.d.ts +2 -2
- package/dist/types/managers/transfer.d.ts +1 -1
- package/dist/types/managers/trashed_files.d.ts +1 -1
- package/dist/types/managers/trashed_folders.d.ts +1 -1
- package/dist/types/managers/trashed_web_links.d.ts +1 -1
- package/dist/types/managers/uploads.d.ts +2 -2
- package/dist/types/managers/user_collaborations.d.ts +2 -2
- package/dist/types/managers/users.d.ts +2 -2
- package/dist/types/managers/web_links.d.ts +2 -2
- package/dist/types/managers/webhooks.d.ts +2 -2
- package/dist/types/managers/workflows.d.ts +1 -1
- package/dist/types/models/schemas.d.ts +204 -141
- package/dist/types/runtime.d.ts +10 -0
- package/dist/types/tokens.d.ts +4 -2
- package/docs/README.md +1 -0
- package/docs/managers/archives.md +2 -2
- package/docs/managers/avatars.md +1 -1
- package/docs/managers/chunked_uploads.md +3 -3
- package/docs/managers/classifications.md +3 -3
- package/docs/managers/collaboration_allowlist_entries.md +10 -10
- package/docs/managers/collaboration_allowlist_exempt_targets.md +10 -10
- package/docs/managers/comments.md +2 -2
- package/docs/managers/email_aliases.md +1 -1
- package/docs/managers/file_classifications.md +2 -2
- package/docs/managers/file_metadata.md +5 -5
- package/docs/managers/file_versions.md +2 -2
- package/docs/managers/file_watermarks.md +1 -1
- package/docs/managers/files.md +2 -2
- package/docs/managers/folder_classifications.md +2 -2
- package/docs/managers/folder_locks.md +1 -1
- package/docs/managers/folder_metadata.md +5 -5
- package/docs/managers/folder_watermarks.md +1 -1
- package/docs/managers/folders.md +3 -3
- package/docs/managers/groups.md +2 -2
- package/docs/managers/integration_mappings.md +2 -2
- package/docs/managers/invites.md +1 -1
- package/docs/managers/legal_hold_policies.md +2 -2
- package/docs/managers/legal_hold_policy_assignments.md +1 -1
- package/docs/managers/memberships.md +10 -10
- package/docs/managers/metadata_cascade_policies.md +2 -2
- package/docs/managers/metadata_taxonomies.md +6 -6
- package/docs/managers/metadata_templates.md +5 -5
- package/docs/managers/query.md +33 -0
- package/docs/managers/retention_policies.md +2 -2
- package/docs/managers/retention_policy_assignments.md +1 -1
- package/docs/managers/session_termination.md +2 -2
- package/docs/managers/shared_links_files.md +3 -3
- package/docs/managers/shared_links_folders.md +3 -3
- package/docs/managers/shared_links_web_links.md +3 -3
- package/docs/managers/shield_information_barrier_segment_members.md +1 -1
- package/docs/managers/shield_information_barrier_segment_restrictions.md +1 -1
- package/docs/managers/shield_information_barrier_segments.md +2 -2
- package/docs/managers/shield_information_barriers.md +2 -2
- package/docs/managers/skills.md +3 -3
- package/docs/managers/storage_policy_assignments.md +2 -2
- package/docs/managers/task_assignments.md +2 -2
- package/docs/managers/tasks.md +2 -2
- package/docs/managers/terms_of_service_user_statuses.md +2 -2
- package/docs/managers/terms_of_services.md +2 -2
- package/docs/managers/transfer.md +1 -1
- package/docs/managers/trashed_files.md +1 -1
- package/docs/managers/trashed_folders.md +1 -1
- package/docs/managers/trashed_web_links.md +1 -1
- package/docs/managers/uploads.md +2 -2
- package/docs/managers/user_collaborations.md +2 -2
- package/docs/managers/users.md +2 -2
- package/docs/managers/web_links.md +2 -2
- package/docs/managers/webhooks.md +2 -2
- package/docs/managers/workflows.md +1 -1
- package/package.json +1 -1
|
@@ -30,7 +30,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
30
30
|
|
|
31
31
|
`POST /metadata_cascade_policies`
|
|
32
32
|
|
|
33
|
-
**Request body** (`application/json`): `
|
|
33
|
+
**Request body** (`application/json`): `CreateMetadataCascadePolicyRequest`
|
|
34
34
|
|
|
35
35
|
**Returns:** `MetadataCascadePolicy`
|
|
36
36
|
|
|
@@ -80,7 +80,7 @@ await client.metadataCascadePolicies.delete_("METADATA_CASCADE_POLICY_ID");
|
|
|
80
80
|
|---|---|---|---|
|
|
81
81
|
| `metadata_cascade_policy_id` | path | `string` | yes |
|
|
82
82
|
|
|
83
|
-
**Request body** (`application/json`): `
|
|
83
|
+
**Request body** (`application/json`): `ApplyMetadataCascadePolicyRequest`
|
|
84
84
|
|
|
85
85
|
**Returns:** `void`
|
|
86
86
|
|
|
@@ -7,7 +7,7 @@ Reach these methods through the `metadataTaxonomies` field on `Client`.
|
|
|
7
7
|
|
|
8
8
|
`POST /metadata_taxonomies`
|
|
9
9
|
|
|
10
|
-
**Request body** (`application/json`): `
|
|
10
|
+
**Request body** (`application/json`): `CreateMetadataTaxonomyRequest`
|
|
11
11
|
|
|
12
12
|
**Returns:** `MetadataTaxonomy`
|
|
13
13
|
|
|
@@ -82,7 +82,7 @@ await client.metadataTaxonomies.delete_("NAMESPACE", "TAXONOMY_KEY");
|
|
|
82
82
|
| `namespace` | path | `string` | yes |
|
|
83
83
|
| `taxonomy_key` | path | `string` | yes |
|
|
84
84
|
|
|
85
|
-
**Request body** (`application/json`): `
|
|
85
|
+
**Request body** (`application/json`): `UpdateMetadataTaxonomyRequest`
|
|
86
86
|
|
|
87
87
|
**Returns:** `MetadataTaxonomy`
|
|
88
88
|
|
|
@@ -121,7 +121,7 @@ const result = await client.metadataTaxonomies.createLevels("NAMESPACE", "TAXONO
|
|
|
121
121
|
| `taxonomy_key` | path | `string` | yes |
|
|
122
122
|
| `level_index` | path | `number` | yes |
|
|
123
123
|
|
|
124
|
-
**Request body** (`application/json`): `
|
|
124
|
+
**Request body** (`application/json`): `UpdateLevelRequest`
|
|
125
125
|
|
|
126
126
|
**Returns:** `MetadataTaxonomyLevel`
|
|
127
127
|
|
|
@@ -140,7 +140,7 @@ const result = await client.metadataTaxonomies.updateLevel("NAMESPACE", "TAXONOM
|
|
|
140
140
|
| `namespace` | path | `string` | yes |
|
|
141
141
|
| `taxonomy_key` | path | `string` | yes |
|
|
142
142
|
|
|
143
|
-
**Request body** (`application/json`): `
|
|
143
|
+
**Request body** (`application/json`): `UpdateLevelRequest`
|
|
144
144
|
|
|
145
145
|
**Returns:** `MetadataTaxonomyLevels`
|
|
146
146
|
|
|
@@ -204,7 +204,7 @@ Paginated — `listNodes(...)` is an async iterable that yields each entry acros
|
|
|
204
204
|
| `namespace` | path | `string` | yes |
|
|
205
205
|
| `taxonomy_key` | path | `string` | yes |
|
|
206
206
|
|
|
207
|
-
**Request body** (`application/json`): `
|
|
207
|
+
**Request body** (`application/json`): `CreateNodesRequest`
|
|
208
208
|
|
|
209
209
|
**Returns:** `MetadataTaxonomyNode`
|
|
210
210
|
|
|
@@ -260,7 +260,7 @@ await client.metadataTaxonomies.deleteNode("NAMESPACE", "TAXONOMY_KEY", "NODE_ID
|
|
|
260
260
|
| `taxonomy_key` | path | `string` | yes |
|
|
261
261
|
| `node_id` | path | `string` | yes |
|
|
262
262
|
|
|
263
|
-
**Request body** (`application/json`): `
|
|
263
|
+
**Request body** (`application/json`): `UpdateNodeRequest`
|
|
264
264
|
|
|
265
265
|
**Returns:** `MetadataTaxonomyNode`
|
|
266
266
|
|
|
@@ -31,7 +31,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
31
31
|
|
|
32
32
|
| Parameter | In | Type | Required |
|
|
33
33
|
|---|---|---|---|
|
|
34
|
-
| `scope` | path | `
|
|
34
|
+
| `scope` | path | `GetFileIdMetadataIdScope` | yes |
|
|
35
35
|
| `template_key` | path | `string` | yes |
|
|
36
36
|
|
|
37
37
|
**Returns:** `MetadataTemplate`
|
|
@@ -48,10 +48,10 @@ const result = await client.metadataTemplates.getSchema("...", "TEMPLATE_KEY");
|
|
|
48
48
|
|
|
49
49
|
| Parameter | In | Type | Required |
|
|
50
50
|
|---|---|---|---|
|
|
51
|
-
| `scope` | path | `
|
|
51
|
+
| `scope` | path | `GetFileIdMetadataIdScope` | yes |
|
|
52
52
|
| `template_key` | path | `string` | yes |
|
|
53
53
|
|
|
54
|
-
**Request body** (`application/json-patch+json`): `Array<
|
|
54
|
+
**Request body** (`application/json-patch+json`): `Array<UpdateSchemaRequest>`
|
|
55
55
|
|
|
56
56
|
**Returns:** `MetadataTemplate`
|
|
57
57
|
|
|
@@ -67,7 +67,7 @@ const result = await client.metadataTemplates.updateSchema("...", "TEMPLATE_KEY"
|
|
|
67
67
|
|
|
68
68
|
| Parameter | In | Type | Required |
|
|
69
69
|
|---|---|---|---|
|
|
70
|
-
| `scope` | path | `
|
|
70
|
+
| `scope` | path | `GetFileIdMetadataIdScope` | yes |
|
|
71
71
|
| `template_key` | path | `string` | yes |
|
|
72
72
|
|
|
73
73
|
**Returns:** `void`
|
|
@@ -140,7 +140,7 @@ Paginated — `listEnterprise(...)` is an async iterable that yields each entry
|
|
|
140
140
|
|
|
141
141
|
`POST /metadata_templates/schema`
|
|
142
142
|
|
|
143
|
-
**Request body** (`application/json`): `
|
|
143
|
+
**Request body** (`application/json`): `CreateSchemaRequest`
|
|
144
144
|
|
|
145
145
|
**Returns:** `MetadataTemplate`
|
|
146
146
|
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
<!-- Generated by box-gantry. DO NOT EDIT. -->
|
|
2
|
+
# QueryManager
|
|
3
|
+
|
|
4
|
+
Reach these methods through the `query` field on `Client`.
|
|
5
|
+
|
|
6
|
+
## query
|
|
7
|
+
|
|
8
|
+
`POST /query`
|
|
9
|
+
|
|
10
|
+
**Request body** (`application/json`): `QueryRequestBody`
|
|
11
|
+
|
|
12
|
+
**Returns:** `QueryResults`
|
|
13
|
+
|
|
14
|
+
**Example**
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
const result = await client.query.query({ /* … */ });
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## queryInsights
|
|
21
|
+
|
|
22
|
+
`POST /query_insights`
|
|
23
|
+
|
|
24
|
+
**Request body** (`application/json`): `QueryInsightsRequestBody`
|
|
25
|
+
|
|
26
|
+
**Returns:** `QueryInsights`
|
|
27
|
+
|
|
28
|
+
**Example**
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
const result = await client.query.queryInsights({ /* … */ });
|
|
32
|
+
```
|
|
33
|
+
|
|
@@ -32,7 +32,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
32
32
|
|
|
33
33
|
`POST /retention_policies`
|
|
34
34
|
|
|
35
|
-
**Request body** (`application/json`): `
|
|
35
|
+
**Request body** (`application/json`): `CreateRetentionPolicyRequest`
|
|
36
36
|
|
|
37
37
|
**Returns:** `RetentionPolicy`
|
|
38
38
|
|
|
@@ -67,7 +67,7 @@ const result = await client.retentionPolicies.get("RETENTION_POLICY_ID");
|
|
|
67
67
|
|---|---|---|---|
|
|
68
68
|
| `retention_policy_id` | path | `string` | yes |
|
|
69
69
|
|
|
70
|
-
**Request body** (`application/json`): `
|
|
70
|
+
**Request body** (`application/json`): `UpdateRetentionPolicyRequest`
|
|
71
71
|
|
|
72
72
|
**Returns:** `RetentionPolicy`
|
|
73
73
|
|
|
@@ -31,7 +31,7 @@ Paginated — `listRetentionPolicyAssignments(...)` is an async iterable that yi
|
|
|
31
31
|
|
|
32
32
|
`POST /retention_policy_assignments`
|
|
33
33
|
|
|
34
|
-
**Request body** (`application/json`): `
|
|
34
|
+
**Request body** (`application/json`): `CreateRetentionPolicyAssignmentRequest`
|
|
35
35
|
|
|
36
36
|
**Returns:** `RetentionPolicyAssignment`
|
|
37
37
|
|
|
@@ -7,7 +7,7 @@ Reach these methods through the `sessionTermination` field on `Client`.
|
|
|
7
7
|
|
|
8
8
|
`POST /users/terminate_sessions`
|
|
9
9
|
|
|
10
|
-
**Request body** (`application/json`): `
|
|
10
|
+
**Request body** (`application/json`): `CreateUserTerminateSessionsRequest`
|
|
11
11
|
|
|
12
12
|
**Returns:** `SessionTerminationMessage`
|
|
13
13
|
|
|
@@ -21,7 +21,7 @@ const result = await client.sessionTermination.createUserTerminateSessions({ /*
|
|
|
21
21
|
|
|
22
22
|
`POST /groups/terminate_sessions`
|
|
23
23
|
|
|
24
|
-
**Request body** (`application/json`): `
|
|
24
|
+
**Request body** (`application/json`): `CreateGroupTerminateSessionsRequest`
|
|
25
25
|
|
|
26
26
|
**Returns:** `SessionTerminationMessage`
|
|
27
27
|
|
|
@@ -47,7 +47,7 @@ const result = await client.sharedLinksFiles.getFileGetSharedLink("FILE_ID", "FI
|
|
|
47
47
|
| `file_id` | path | `string` | yes |
|
|
48
48
|
| `fields` | query | `string` | yes |
|
|
49
49
|
|
|
50
|
-
**Request body** (`application/json`): `
|
|
50
|
+
**Request body** (`application/json`): `UpdateFileAddSharedLinkRequest`
|
|
51
51
|
|
|
52
52
|
**Returns:** `FileFull`
|
|
53
53
|
|
|
@@ -66,7 +66,7 @@ const result = await client.sharedLinksFiles.updateFileAddSharedLink("FILE_ID",
|
|
|
66
66
|
| `file_id` | path | `string` | yes |
|
|
67
67
|
| `fields` | query | `string` | yes |
|
|
68
68
|
|
|
69
|
-
**Request body** (`application/json`): `
|
|
69
|
+
**Request body** (`application/json`): `UpdateFileAddSharedLinkRequest`
|
|
70
70
|
|
|
71
71
|
**Returns:** `FileFull`
|
|
72
72
|
|
|
@@ -85,7 +85,7 @@ const result = await client.sharedLinksFiles.updateFileUpdateSharedLink("FILE_ID
|
|
|
85
85
|
| `file_id` | path | `string` | yes |
|
|
86
86
|
| `fields` | query | `string` | yes |
|
|
87
87
|
|
|
88
|
-
**Request body** (`application/json`): `
|
|
88
|
+
**Request body** (`application/json`): `UpdateFileRemoveSharedLinkRequest`
|
|
89
89
|
|
|
90
90
|
**Returns:** `FileFull`
|
|
91
91
|
|
|
@@ -47,7 +47,7 @@ const result = await client.sharedLinksFolders.getFolderGetSharedLink("FOLDER_ID
|
|
|
47
47
|
| `folder_id` | path | `string` | yes |
|
|
48
48
|
| `fields` | query | `string` | yes |
|
|
49
49
|
|
|
50
|
-
**Request body** (`application/json`): `
|
|
50
|
+
**Request body** (`application/json`): `UpdateFileAddSharedLinkRequest`
|
|
51
51
|
|
|
52
52
|
**Returns:** `FolderFull`
|
|
53
53
|
|
|
@@ -66,7 +66,7 @@ const result = await client.sharedLinksFolders.updateFolderAddSharedLink("FOLDER
|
|
|
66
66
|
| `folder_id` | path | `string` | yes |
|
|
67
67
|
| `fields` | query | `string` | yes |
|
|
68
68
|
|
|
69
|
-
**Request body** (`application/json`): `
|
|
69
|
+
**Request body** (`application/json`): `UpdateFolderUpdateSharedLinkRequest`
|
|
70
70
|
|
|
71
71
|
**Returns:** `FolderFull`
|
|
72
72
|
|
|
@@ -85,7 +85,7 @@ const result = await client.sharedLinksFolders.updateFolderUpdateSharedLink("FOL
|
|
|
85
85
|
| `folder_id` | path | `string` | yes |
|
|
86
86
|
| `fields` | query | `string` | yes |
|
|
87
87
|
|
|
88
|
-
**Request body** (`application/json`): `
|
|
88
|
+
**Request body** (`application/json`): `UpdateFileRemoveSharedLinkRequest`
|
|
89
89
|
|
|
90
90
|
**Returns:** `FolderFull`
|
|
91
91
|
|
|
@@ -47,7 +47,7 @@ const result = await client.sharedLinksWebLinks.getWebLinkGetSharedLink("WEB_LIN
|
|
|
47
47
|
| `web_link_id` | path | `string` | yes |
|
|
48
48
|
| `fields` | query | `string` | yes |
|
|
49
49
|
|
|
50
|
-
**Request body** (`application/json`): `
|
|
50
|
+
**Request body** (`application/json`): `UpdateFileAddSharedLinkRequest`
|
|
51
51
|
|
|
52
52
|
**Returns:** `WebLink`
|
|
53
53
|
|
|
@@ -66,7 +66,7 @@ const result = await client.sharedLinksWebLinks.updateWebLinkAddSharedLink("WEB_
|
|
|
66
66
|
| `web_link_id` | path | `string` | yes |
|
|
67
67
|
| `fields` | query | `string` | yes |
|
|
68
68
|
|
|
69
|
-
**Request body** (`application/json`): `
|
|
69
|
+
**Request body** (`application/json`): `UpdateFileAddSharedLinkRequest`
|
|
70
70
|
|
|
71
71
|
**Returns:** `WebLink`
|
|
72
72
|
|
|
@@ -85,7 +85,7 @@ const result = await client.sharedLinksWebLinks.updateWebLinkUpdateSharedLink("W
|
|
|
85
85
|
| `web_link_id` | path | `string` | yes |
|
|
86
86
|
| `fields` | query | `string` | yes |
|
|
87
87
|
|
|
88
|
-
**Request body** (`application/json`): `
|
|
88
|
+
**Request body** (`application/json`): `UpdateFileRemoveSharedLinkRequest`
|
|
89
89
|
|
|
90
90
|
**Returns:** `WebLink`
|
|
91
91
|
|
|
@@ -61,7 +61,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
61
61
|
|
|
62
62
|
`POST /shield_information_barrier_segment_members`
|
|
63
63
|
|
|
64
|
-
**Request body** (`application/json`): `
|
|
64
|
+
**Request body** (`application/json`): `CreateShieldInformationBarrierSegmentMemberRequest`
|
|
65
65
|
|
|
66
66
|
**Returns:** `ShieldInformationBarrierSegmentMember`
|
|
67
67
|
|
|
@@ -61,7 +61,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
61
61
|
|
|
62
62
|
`POST /shield_information_barrier_segment_restrictions`
|
|
63
63
|
|
|
64
|
-
**Request body** (`application/json`): `
|
|
64
|
+
**Request body** (`application/json`): `CreateShieldInformationBarrierSegmentRestrictionRequest`
|
|
65
65
|
|
|
66
66
|
**Returns:** `ShieldInformationBarrierSegmentRestriction`
|
|
67
67
|
|
|
@@ -27,7 +27,7 @@ const result = await client.shieldInformationBarrierSegments.get("SHIELD_INFORMA
|
|
|
27
27
|
|---|---|---|---|
|
|
28
28
|
| `shield_information_barrier_segment_id` | path | `string` | yes |
|
|
29
29
|
|
|
30
|
-
**Request body** (`application/json`): `
|
|
30
|
+
**Request body** (`application/json`): `UpdateShieldInformationBarrierSegmentRequest`
|
|
31
31
|
|
|
32
32
|
**Returns:** `ShieldInformationBarrierSegment`
|
|
33
33
|
|
|
@@ -79,7 +79,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
79
79
|
|
|
80
80
|
`POST /shield_information_barrier_segments`
|
|
81
81
|
|
|
82
|
-
**Request body** (`application/json`): `
|
|
82
|
+
**Request body** (`application/json`): `CreateShieldInformationBarrierSegmentRequest`
|
|
83
83
|
|
|
84
84
|
**Returns:** `ShieldInformationBarrierSegment`
|
|
85
85
|
|
|
@@ -23,7 +23,7 @@ const result = await client.shieldInformationBarriers.get("SHIELD_INFORMATION_BA
|
|
|
23
23
|
|
|
24
24
|
`POST /shield_information_barriers/change_status`
|
|
25
25
|
|
|
26
|
-
**Request body** (`application/json`): `
|
|
26
|
+
**Request body** (`application/json`): `CreateChangeStatusRequest`
|
|
27
27
|
|
|
28
28
|
**Returns:** `ShieldInformationBarrier`
|
|
29
29
|
|
|
@@ -58,7 +58,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
58
58
|
|
|
59
59
|
`POST /shield_information_barriers`
|
|
60
60
|
|
|
61
|
-
**Request body** (`application/json`): `
|
|
61
|
+
**Request body** (`application/json`): `CreateShieldInformationBarrierRequest`
|
|
62
62
|
|
|
63
63
|
**Returns:** `ShieldInformationBarrier`
|
|
64
64
|
|
package/docs/managers/skills.md
CHANGED
|
@@ -27,7 +27,7 @@ const result = await client.skills.get("FILE_ID");
|
|
|
27
27
|
|---|---|---|---|
|
|
28
28
|
| `file_id` | path | `string` | yes |
|
|
29
29
|
|
|
30
|
-
**Request body** (`application/json-patch+json`): `Array<
|
|
30
|
+
**Request body** (`application/json-patch+json`): `Array<UpdateSkillRequest>`
|
|
31
31
|
|
|
32
32
|
**Returns:** `SkillCardsMetadata`
|
|
33
33
|
|
|
@@ -45,7 +45,7 @@ const result = await client.skills.update("FILE_ID", []);
|
|
|
45
45
|
|---|---|---|---|
|
|
46
46
|
| `file_id` | path | `string` | yes |
|
|
47
47
|
|
|
48
|
-
**Request body** (`application/json`): `
|
|
48
|
+
**Request body** (`application/json`): `CreateSkillRequest`
|
|
49
49
|
|
|
50
50
|
**Returns:** `SkillCardsMetadata`
|
|
51
51
|
|
|
@@ -79,7 +79,7 @@ await client.skills.delete_("FILE_ID");
|
|
|
79
79
|
|---|---|---|---|
|
|
80
80
|
| `skill_id` | path | `string` | yes |
|
|
81
81
|
|
|
82
|
-
**Request body** (`application/json`): `
|
|
82
|
+
**Request body** (`application/json`): `UpdateSkillInvocationRequest`
|
|
83
83
|
|
|
84
84
|
**Returns:** `void`
|
|
85
85
|
|
|
@@ -29,7 +29,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
29
29
|
|
|
30
30
|
`POST /storage_policy_assignments`
|
|
31
31
|
|
|
32
|
-
**Request body** (`application/json`): `
|
|
32
|
+
**Request body** (`application/json`): `CreateStoragePolicyAssignmentRequest`
|
|
33
33
|
|
|
34
34
|
**Returns:** `StoragePolicyAssignment`
|
|
35
35
|
|
|
@@ -63,7 +63,7 @@ const result = await client.storagePolicyAssignments.get("STORAGE_POLICY_ASSIGNM
|
|
|
63
63
|
|---|---|---|---|
|
|
64
64
|
| `storage_policy_assignment_id` | path | `string` | yes |
|
|
65
65
|
|
|
66
|
-
**Request body** (`application/json`): `
|
|
66
|
+
**Request body** (`application/json`): `UpdateStoragePolicyAssignmentRequest`
|
|
67
67
|
|
|
68
68
|
**Returns:** `StoragePolicyAssignment`
|
|
69
69
|
|
|
@@ -23,7 +23,7 @@ const result = await client.taskAssignments.listTaskAssignments("TASK_ID");
|
|
|
23
23
|
|
|
24
24
|
`POST /task_assignments`
|
|
25
25
|
|
|
26
|
-
**Request body** (`application/json`): `
|
|
26
|
+
**Request body** (`application/json`): `CreateTaskAssignmentRequest`
|
|
27
27
|
|
|
28
28
|
**Returns:** `TaskAssignment`
|
|
29
29
|
|
|
@@ -57,7 +57,7 @@ const result = await client.taskAssignments.get("TASK_ASSIGNMENT_ID");
|
|
|
57
57
|
|---|---|---|---|
|
|
58
58
|
| `task_assignment_id` | path | `string` | yes |
|
|
59
59
|
|
|
60
|
-
**Request body** (`application/json`): `
|
|
60
|
+
**Request body** (`application/json`): `UpdateTaskAssignmentRequest`
|
|
61
61
|
|
|
62
62
|
**Returns:** `TaskAssignment`
|
|
63
63
|
|
package/docs/managers/tasks.md
CHANGED
|
@@ -23,7 +23,7 @@ const result = await client.tasks.listFile("FILE_ID");
|
|
|
23
23
|
|
|
24
24
|
`POST /tasks`
|
|
25
25
|
|
|
26
|
-
**Request body** (`application/json`): `
|
|
26
|
+
**Request body** (`application/json`): `CreateTaskRequest`
|
|
27
27
|
|
|
28
28
|
**Returns:** `Task`
|
|
29
29
|
|
|
@@ -57,7 +57,7 @@ const result = await client.tasks.get("TASK_ID");
|
|
|
57
57
|
|---|---|---|---|
|
|
58
58
|
| `task_id` | path | `string` | yes |
|
|
59
59
|
|
|
60
|
-
**Request body** (`application/json`): `
|
|
60
|
+
**Request body** (`application/json`): `UpdateTaskRequest`
|
|
61
61
|
|
|
62
62
|
**Returns:** `Task`
|
|
63
63
|
|
|
@@ -24,7 +24,7 @@ const result = await client.termsOfServiceUserStatuses.list("TOS_ID");
|
|
|
24
24
|
|
|
25
25
|
`POST /terms_of_service_user_statuses`
|
|
26
26
|
|
|
27
|
-
**Request body** (`application/json`): `
|
|
27
|
+
**Request body** (`application/json`): `CreateTermsOfServiceUserStatusRequest`
|
|
28
28
|
|
|
29
29
|
**Returns:** `TermsOfServiceUserStatus`
|
|
30
30
|
|
|
@@ -42,7 +42,7 @@ const result = await client.termsOfServiceUserStatuses.create({ /* … */ });
|
|
|
42
42
|
|---|---|---|---|
|
|
43
43
|
| `terms_of_service_user_status_id` | path | `string` | yes |
|
|
44
44
|
|
|
45
|
-
**Request body** (`application/json`): `
|
|
45
|
+
**Request body** (`application/json`): `UpdateTermsOfServiceUserStatusRequest`
|
|
46
46
|
|
|
47
47
|
**Returns:** `TermsOfServiceUserStatus`
|
|
48
48
|
|
|
@@ -23,7 +23,7 @@ const result = await client.termsOfServices.list();
|
|
|
23
23
|
|
|
24
24
|
`POST /terms_of_services`
|
|
25
25
|
|
|
26
|
-
**Request body** (`application/json`): `
|
|
26
|
+
**Request body** (`application/json`): `CreateTermsOfServiceRequest`
|
|
27
27
|
|
|
28
28
|
**Returns:** `TermsOfService`
|
|
29
29
|
|
|
@@ -57,7 +57,7 @@ const result = await client.termsOfServices.get("TERMS_OF_SERVICE_ID");
|
|
|
57
57
|
|---|---|---|---|
|
|
58
58
|
| `terms_of_service_id` | path | `string` | yes |
|
|
59
59
|
|
|
60
|
-
**Request body** (`application/json`): `
|
|
60
|
+
**Request body** (`application/json`): `UpdateTermsOfServiceRequest`
|
|
61
61
|
|
|
62
62
|
**Returns:** `TermsOfService`
|
|
63
63
|
|
|
@@ -13,7 +13,7 @@ Reach these methods through the `transfer` field on `Client`.
|
|
|
13
13
|
| `fields` | query | `Array<string>` | no |
|
|
14
14
|
| `notify` | query | `boolean` | no |
|
|
15
15
|
|
|
16
|
-
**Request body** (`application/json`): `
|
|
16
|
+
**Request body** (`application/json`): `TransferFoldersRequest`
|
|
17
17
|
|
|
18
18
|
**Returns:** `FolderFull`
|
|
19
19
|
|
|
@@ -12,7 +12,7 @@ Reach these methods through the `trashedFiles` field on `Client`.
|
|
|
12
12
|
| `file_id` | path | `string` | yes |
|
|
13
13
|
| `fields` | query | `Array<string>` | no |
|
|
14
14
|
|
|
15
|
-
**Request body** (`application/json`): `
|
|
15
|
+
**Request body** (`application/json`): `CreateFileRequest`
|
|
16
16
|
|
|
17
17
|
**Returns:** `TrashFileRestored`
|
|
18
18
|
|
|
@@ -12,7 +12,7 @@ Reach these methods through the `trashedFolders` field on `Client`.
|
|
|
12
12
|
| `folder_id` | path | `string` | yes |
|
|
13
13
|
| `fields` | query | `Array<string>` | no |
|
|
14
14
|
|
|
15
|
-
**Request body** (`application/json`): `
|
|
15
|
+
**Request body** (`application/json`): `CreateFileRequest`
|
|
16
16
|
|
|
17
17
|
**Returns:** `TrashFolderRestored`
|
|
18
18
|
|
|
@@ -12,7 +12,7 @@ Reach these methods through the `trashedWebLinks` field on `Client`.
|
|
|
12
12
|
| `web_link_id` | path | `string` | yes |
|
|
13
13
|
| `fields` | query | `Array<string>` | no |
|
|
14
14
|
|
|
15
|
-
**Request body** (`application/json`): `
|
|
15
|
+
**Request body** (`application/json`): `CreateFileRequest`
|
|
16
16
|
|
|
17
17
|
**Returns:** `TrashWebLinkRestored`
|
|
18
18
|
|
package/docs/managers/uploads.md
CHANGED
|
@@ -14,7 +14,7 @@ Reach these methods through the `uploads` field on `Client`.
|
|
|
14
14
|
| `fields` | query | `Array<string>` | no |
|
|
15
15
|
| `content-md5` | header | `string` | no |
|
|
16
16
|
|
|
17
|
-
**Request body** (`multipart/form-data`): `
|
|
17
|
+
**Request body** (`multipart/form-data`): `CreateFileIdContentRequest`
|
|
18
18
|
|
|
19
19
|
**Returns:** `Files`
|
|
20
20
|
|
|
@@ -33,7 +33,7 @@ const result = await client.uploads.uploadFileVersion("FILE_ID", { /* … */ });
|
|
|
33
33
|
| `fields` | query | `Array<string>` | no |
|
|
34
34
|
| `content-md5` | header | `string` | no |
|
|
35
35
|
|
|
36
|
-
**Request body** (`multipart/form-data`): `
|
|
36
|
+
**Request body** (`multipart/form-data`): `CreateFileContentRequest`
|
|
37
37
|
|
|
38
38
|
**Returns:** `Files`
|
|
39
39
|
|
|
@@ -28,7 +28,7 @@ const result = await client.userCollaborations.getCollaboration("COLLABORATION_I
|
|
|
28
28
|
|---|---|---|---|
|
|
29
29
|
| `collaboration_id` | path | `string` | yes |
|
|
30
30
|
|
|
31
|
-
**Request body** (`application/json`): `
|
|
31
|
+
**Request body** (`application/json`): `UpdateCollaborationRequest`
|
|
32
32
|
|
|
33
33
|
**Returns:** `Collaboration`
|
|
34
34
|
|
|
@@ -63,7 +63,7 @@ await client.userCollaborations.deleteCollaboration("COLLABORATION_ID");
|
|
|
63
63
|
| `fields` | query | `Array<string>` | no |
|
|
64
64
|
| `notify` | query | `boolean` | no |
|
|
65
65
|
|
|
66
|
-
**Request body** (`application/json`): `
|
|
66
|
+
**Request body** (`application/json`): `CreateCollaborationsRequest`
|
|
67
67
|
|
|
68
68
|
**Returns:** `Collaboration`
|
|
69
69
|
|
package/docs/managers/users.md
CHANGED
|
@@ -38,7 +38,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
38
38
|
|---|---|---|---|
|
|
39
39
|
| `fields` | query | `Array<string>` | no |
|
|
40
40
|
|
|
41
|
-
**Request body** (`application/json`): `
|
|
41
|
+
**Request body** (`application/json`): `CreateUserRequest`
|
|
42
42
|
|
|
43
43
|
**Returns:** `UserFull`
|
|
44
44
|
|
|
@@ -90,7 +90,7 @@ const result = await client.users.get("USER_ID");
|
|
|
90
90
|
| `user_id` | path | `string` | yes |
|
|
91
91
|
| `fields` | query | `Array<string>` | no |
|
|
92
92
|
|
|
93
|
-
**Request body** (`application/json`): `
|
|
93
|
+
**Request body** (`application/json`): `UpdateUserRequest`
|
|
94
94
|
|
|
95
95
|
**Returns:** `UserFull`
|
|
96
96
|
|
|
@@ -7,7 +7,7 @@ Reach these methods through the `webLinks` field on `Client`.
|
|
|
7
7
|
|
|
8
8
|
`POST /web_links`
|
|
9
9
|
|
|
10
|
-
**Request body** (`application/json`): `
|
|
10
|
+
**Request body** (`application/json`): `CreateWebLinkRequest`
|
|
11
11
|
|
|
12
12
|
**Returns:** `WebLink`
|
|
13
13
|
|
|
@@ -42,7 +42,7 @@ const result = await client.webLinks.get("WEB_LINK_ID");
|
|
|
42
42
|
|---|---|---|---|
|
|
43
43
|
| `web_link_id` | path | `string` | yes |
|
|
44
44
|
|
|
45
|
-
**Request body** (`application/json`): `
|
|
45
|
+
**Request body** (`application/json`): `UpdateWebLinkRequest`
|
|
46
46
|
|
|
47
47
|
**Returns:** `WebLink`
|
|
48
48
|
|
|
@@ -28,7 +28,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
28
28
|
|
|
29
29
|
`POST /webhooks`
|
|
30
30
|
|
|
31
|
-
**Request body** (`application/json`): `
|
|
31
|
+
**Request body** (`application/json`): `CreateWebhookRequest`
|
|
32
32
|
|
|
33
33
|
**Returns:** `Webhook`
|
|
34
34
|
|
|
@@ -62,7 +62,7 @@ const result = await client.webhooks.get("WEBHOOK_ID");
|
|
|
62
62
|
|---|---|---|---|
|
|
63
63
|
| `webhook_id` | path | `string` | yes |
|
|
64
64
|
|
|
65
|
-
**Request body** (`application/json`): `
|
|
65
|
+
**Request body** (`application/json`): `UpdateWebhookRequest`
|
|
66
66
|
|
|
67
67
|
**Returns:** `Webhook`
|
|
68
68
|
|
|
@@ -34,7 +34,7 @@ Paginated — `list(...)` is an async iterable that yields each entry across pag
|
|
|
34
34
|
|---|---|---|---|
|
|
35
35
|
| `workflow_id` | path | `string` | yes |
|
|
36
36
|
|
|
37
|
-
**Request body** (`application/json`): `
|
|
37
|
+
**Request body** (`application/json`): `StartWorkflowRequest`
|
|
38
38
|
|
|
39
39
|
**Returns:** `void`
|
|
40
40
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@unofficialbox/box-open-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Box API client for TypeScript (open source, community, punk rock) — typed models, async managers, and a fetch runtime with retry, backoff, and token refresh.",
|
|
5
5
|
"keywords": ["box", "box-api", "sdk", "api-client", "typescript", "unofficial"],
|
|
6
6
|
"license": "MIT",
|