@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
package/README.md
CHANGED
|
@@ -3,7 +3,9 @@
|
|
|
3
3
|
|
|
4
4
|
# @unofficialbox/box-open-sdk
|
|
5
5
|
|
|
6
|
+
[](https://github.com/unofficialbox/box-open-ts-sdk/releases/latest)
|
|
6
7
|
[](https://www.npmjs.com/package/@unofficialbox/box-open-sdk)
|
|
8
|
+
[](LICENSE)
|
|
7
9
|
|
|
8
10
|
An **open source, community-built** Box API client for TypeScript — fully typed models
|
|
9
11
|
for the whole Box surface, one manager per API area behind a single `Client`,
|
package/dist/cjs/auth.js
CHANGED
|
@@ -43,7 +43,7 @@ function clientCredentials(config) {
|
|
|
43
43
|
client_secret: config.clientSecret,
|
|
44
44
|
box_subject_type: subject.type,
|
|
45
45
|
box_subject_id: subject.id,
|
|
46
|
-
}));
|
|
46
|
+
}, undefined, config.fetch));
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
49
|
* Build the URL to redirect a user to so they can grant access. `state` is
|
|
@@ -72,7 +72,7 @@ function refreshTokenExchange(config, tokenUrl, initialRefresh) {
|
|
|
72
72
|
refresh_token: refreshToken,
|
|
73
73
|
client_id: config.clientId,
|
|
74
74
|
client_secret: config.clientSecret,
|
|
75
|
-
});
|
|
75
|
+
}, undefined, config.fetch);
|
|
76
76
|
if (token.refreshToken) {
|
|
77
77
|
refreshToken = token.refreshToken;
|
|
78
78
|
config.onRefresh?.(token.refreshToken);
|
|
@@ -101,7 +101,7 @@ async function exchangeCode(config, code, redirectUri, signal) {
|
|
|
101
101
|
client_id: config.clientId,
|
|
102
102
|
client_secret: config.clientSecret,
|
|
103
103
|
redirect_uri: redirectUri,
|
|
104
|
-
}, signal);
|
|
104
|
+
}, signal, config.fetch);
|
|
105
105
|
if (!token.refreshToken) {
|
|
106
106
|
throw new errors_js_1.BoxApiError('authorization-code exchange returned no refresh_token');
|
|
107
107
|
}
|
package/dist/cjs/buildinfo.js
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
// Code generated by box-gantry 0.1.0 (spec
|
|
2
|
+
// Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80). DO NOT EDIT.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
4
|
exports.TARGET = exports.SPEC_FINGERPRINT = exports.ENGINE = void 0;
|
|
5
5
|
/** The box-gantry engine version that generated this SDK. */
|
|
6
6
|
exports.ENGINE = "0.1.0";
|
|
7
7
|
/** Fingerprint of the input spec set. */
|
|
8
|
-
exports.SPEC_FINGERPRINT = "
|
|
8
|
+
exports.SPEC_FINGERPRINT = "3fb3510fe12f2f80";
|
|
9
9
|
/** The target language key (FR-4). */
|
|
10
10
|
exports.TARGET = "typescript";
|
package/dist/cjs/client.js
CHANGED
|
@@ -52,6 +52,7 @@ const metadata_cascade_policies_js_1 = require("./managers/metadata_cascade_poli
|
|
|
52
52
|
const metadata_taxonomies_js_1 = require("./managers/metadata_taxonomies.js");
|
|
53
53
|
const metadata_templates_js_1 = require("./managers/metadata_templates.js");
|
|
54
54
|
const notes_js_1 = require("./managers/notes.js");
|
|
55
|
+
const query_js_1 = require("./managers/query.js");
|
|
55
56
|
const recent_items_js_1 = require("./managers/recent_items.js");
|
|
56
57
|
const retention_policies_js_1 = require("./managers/retention_policies.js");
|
|
57
58
|
const retention_policy_assignments_js_1 = require("./managers/retention_policy_assignments.js");
|
|
@@ -139,6 +140,7 @@ class Client {
|
|
|
139
140
|
metadataTaxonomies;
|
|
140
141
|
metadataTemplates;
|
|
141
142
|
notes;
|
|
143
|
+
query;
|
|
142
144
|
recentItems;
|
|
143
145
|
retentionPolicies;
|
|
144
146
|
retentionPolicyAssignments;
|
|
@@ -227,6 +229,7 @@ class Client {
|
|
|
227
229
|
this.metadataTaxonomies = new metadata_taxonomies_js_1.MetadataTaxonomiesManager(session);
|
|
228
230
|
this.metadataTemplates = new metadata_templates_js_1.MetadataTemplatesManager(session);
|
|
229
231
|
this.notes = new notes_js_1.NotesManager(session);
|
|
232
|
+
this.query = new query_js_1.QueryManager(session);
|
|
230
233
|
this.recentItems = new recent_items_js_1.RecentItemsManager(session);
|
|
231
234
|
this.retentionPolicies = new retention_policies_js_1.RetentionPoliciesManager(session);
|
|
232
235
|
this.retentionPolicyAssignments = new retention_policy_assignments_js_1.RetentionPolicyAssignmentsManager(session);
|
package/dist/cjs/jwt.js
CHANGED
|
@@ -44,10 +44,10 @@ class CollaborationAllowlistEntriesManager {
|
|
|
44
44
|
this.session = session;
|
|
45
45
|
}
|
|
46
46
|
/** Iterate every `models.schemas.CollaborationAllowlistEntry` across pages, threading the marker cursor. */
|
|
47
|
-
async *
|
|
47
|
+
async *list(opts) {
|
|
48
48
|
const options = { ...opts };
|
|
49
49
|
for (;;) {
|
|
50
|
-
const page = await this.
|
|
50
|
+
const page = await this.listPage(options);
|
|
51
51
|
const items = page.entries ?? [];
|
|
52
52
|
for (const item of items) {
|
|
53
53
|
yield item;
|
|
@@ -59,7 +59,7 @@ class CollaborationAllowlistEntriesManager {
|
|
|
59
59
|
options.marker = cursor;
|
|
60
60
|
}
|
|
61
61
|
}
|
|
62
|
-
async
|
|
62
|
+
async listPage(opts) {
|
|
63
63
|
let url = this.session.baseUrl("api");
|
|
64
64
|
url += "/collaboration_whitelist_entries";
|
|
65
65
|
let req = this.session.newRequest("GET", url);
|
|
@@ -74,7 +74,7 @@ class CollaborationAllowlistEntriesManager {
|
|
|
74
74
|
const data = runtime.responseBytes(resp);
|
|
75
75
|
return JSON.parse(new TextDecoder().decode(data));
|
|
76
76
|
}
|
|
77
|
-
async
|
|
77
|
+
async create(body) {
|
|
78
78
|
let url = this.session.baseUrl("api");
|
|
79
79
|
url += "/collaboration_whitelist_entries";
|
|
80
80
|
let req = this.session.newRequest("POST", url);
|
|
@@ -84,7 +84,7 @@ class CollaborationAllowlistEntriesManager {
|
|
|
84
84
|
const data = runtime.responseBytes(resp);
|
|
85
85
|
return JSON.parse(new TextDecoder().decode(data));
|
|
86
86
|
}
|
|
87
|
-
async
|
|
87
|
+
async get(collaborationWhitelistEntryId) {
|
|
88
88
|
let url = this.session.baseUrl("api");
|
|
89
89
|
url += "/collaboration_whitelist_entries";
|
|
90
90
|
url += '/' + (0, internal_js_1.pathEscape)(collaborationWhitelistEntryId);
|
|
@@ -93,7 +93,7 @@ class CollaborationAllowlistEntriesManager {
|
|
|
93
93
|
const data = runtime.responseBytes(resp);
|
|
94
94
|
return JSON.parse(new TextDecoder().decode(data));
|
|
95
95
|
}
|
|
96
|
-
async
|
|
96
|
+
async delete_(collaborationWhitelistEntryId) {
|
|
97
97
|
let url = this.session.baseUrl("api");
|
|
98
98
|
url += "/collaboration_whitelist_entries";
|
|
99
99
|
url += '/' + (0, internal_js_1.pathEscape)(collaborationWhitelistEntryId);
|
|
@@ -44,10 +44,10 @@ class CollaborationAllowlistExemptTargetsManager {
|
|
|
44
44
|
this.session = session;
|
|
45
45
|
}
|
|
46
46
|
/** Iterate every `models.schemas.CollaborationAllowlistExemptTarget` across pages, threading the marker cursor. */
|
|
47
|
-
async *
|
|
47
|
+
async *list(opts) {
|
|
48
48
|
const options = { ...opts };
|
|
49
49
|
for (;;) {
|
|
50
|
-
const page = await this.
|
|
50
|
+
const page = await this.listPage(options);
|
|
51
51
|
const items = page.entries ?? [];
|
|
52
52
|
for (const item of items) {
|
|
53
53
|
yield item;
|
|
@@ -59,7 +59,7 @@ class CollaborationAllowlistExemptTargetsManager {
|
|
|
59
59
|
options.marker = cursor;
|
|
60
60
|
}
|
|
61
61
|
}
|
|
62
|
-
async
|
|
62
|
+
async listPage(opts) {
|
|
63
63
|
let url = this.session.baseUrl("api");
|
|
64
64
|
url += "/collaboration_whitelist_exempt_targets";
|
|
65
65
|
let req = this.session.newRequest("GET", url);
|
|
@@ -74,7 +74,7 @@ class CollaborationAllowlistExemptTargetsManager {
|
|
|
74
74
|
const data = runtime.responseBytes(resp);
|
|
75
75
|
return JSON.parse(new TextDecoder().decode(data));
|
|
76
76
|
}
|
|
77
|
-
async
|
|
77
|
+
async create(body) {
|
|
78
78
|
let url = this.session.baseUrl("api");
|
|
79
79
|
url += "/collaboration_whitelist_exempt_targets";
|
|
80
80
|
let req = this.session.newRequest("POST", url);
|
|
@@ -84,7 +84,7 @@ class CollaborationAllowlistExemptTargetsManager {
|
|
|
84
84
|
const data = runtime.responseBytes(resp);
|
|
85
85
|
return JSON.parse(new TextDecoder().decode(data));
|
|
86
86
|
}
|
|
87
|
-
async
|
|
87
|
+
async get(collaborationWhitelistExemptTargetId) {
|
|
88
88
|
let url = this.session.baseUrl("api");
|
|
89
89
|
url += "/collaboration_whitelist_exempt_targets";
|
|
90
90
|
url += '/' + (0, internal_js_1.pathEscape)(collaborationWhitelistExemptTargetId);
|
|
@@ -93,7 +93,7 @@ class CollaborationAllowlistExemptTargetsManager {
|
|
|
93
93
|
const data = runtime.responseBytes(resp);
|
|
94
94
|
return JSON.parse(new TextDecoder().decode(data));
|
|
95
95
|
}
|
|
96
|
-
async
|
|
96
|
+
async delete_(collaborationWhitelistExemptTargetId) {
|
|
97
97
|
let url = this.session.baseUrl("api");
|
|
98
98
|
url += "/collaboration_whitelist_exempt_targets";
|
|
99
99
|
url += '/' + (0, internal_js_1.pathEscape)(collaborationWhitelistExemptTargetId);
|
|
@@ -64,6 +64,7 @@ __exportStar(require("./metadata_cascade_policies.js"), exports);
|
|
|
64
64
|
__exportStar(require("./metadata_taxonomies.js"), exports);
|
|
65
65
|
__exportStar(require("./metadata_templates.js"), exports);
|
|
66
66
|
__exportStar(require("./notes.js"), exports);
|
|
67
|
+
__exportStar(require("./query.js"), exports);
|
|
67
68
|
__exportStar(require("./recent_items.js"), exports);
|
|
68
69
|
__exportStar(require("./retention_policies.js"), exports);
|
|
69
70
|
__exportStar(require("./retention_policy_assignments.js"), exports);
|
|
@@ -107,7 +107,7 @@ class MembershipsManager {
|
|
|
107
107
|
const data = runtime.responseBytes(resp);
|
|
108
108
|
return JSON.parse(new TextDecoder().decode(data));
|
|
109
109
|
}
|
|
110
|
-
async
|
|
110
|
+
async createGroupMembership(body, opts) {
|
|
111
111
|
let url = this.session.baseUrl("api");
|
|
112
112
|
url += "/group_memberships";
|
|
113
113
|
let req = this.session.newRequest("POST", url);
|
|
@@ -121,7 +121,7 @@ class MembershipsManager {
|
|
|
121
121
|
const data = runtime.responseBytes(resp);
|
|
122
122
|
return JSON.parse(new TextDecoder().decode(data));
|
|
123
123
|
}
|
|
124
|
-
async
|
|
124
|
+
async getGroupMembership(groupMembershipId, opts) {
|
|
125
125
|
let url = this.session.baseUrl("api");
|
|
126
126
|
url += "/group_memberships";
|
|
127
127
|
url += '/' + (0, internal_js_1.pathEscape)(groupMembershipId);
|
|
@@ -134,7 +134,7 @@ class MembershipsManager {
|
|
|
134
134
|
const data = runtime.responseBytes(resp);
|
|
135
135
|
return JSON.parse(new TextDecoder().decode(data));
|
|
136
136
|
}
|
|
137
|
-
async
|
|
137
|
+
async updateGroupMembership(groupMembershipId, body, opts) {
|
|
138
138
|
let url = this.session.baseUrl("api");
|
|
139
139
|
url += "/group_memberships";
|
|
140
140
|
url += '/' + (0, internal_js_1.pathEscape)(groupMembershipId);
|
|
@@ -149,7 +149,7 @@ class MembershipsManager {
|
|
|
149
149
|
const data = runtime.responseBytes(resp);
|
|
150
150
|
return JSON.parse(new TextDecoder().decode(data));
|
|
151
151
|
}
|
|
152
|
-
async
|
|
152
|
+
async deleteGroupMembership(groupMembershipId) {
|
|
153
153
|
let url = this.session.baseUrl("api");
|
|
154
154
|
url += "/group_memberships";
|
|
155
155
|
url += '/' + (0, internal_js_1.pathEscape)(groupMembershipId);
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Code generated by box-gantry. DO NOT EDIT.
|
|
3
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
4
|
+
if (k2 === undefined) k2 = k;
|
|
5
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
6
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
7
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
8
|
+
}
|
|
9
|
+
Object.defineProperty(o, k2, desc);
|
|
10
|
+
}) : (function(o, m, k, k2) {
|
|
11
|
+
if (k2 === undefined) k2 = k;
|
|
12
|
+
o[k2] = m[k];
|
|
13
|
+
}));
|
|
14
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
15
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
16
|
+
}) : function(o, v) {
|
|
17
|
+
o["default"] = v;
|
|
18
|
+
});
|
|
19
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
20
|
+
var ownKeys = function(o) {
|
|
21
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
22
|
+
var ar = [];
|
|
23
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
24
|
+
return ar;
|
|
25
|
+
};
|
|
26
|
+
return ownKeys(o);
|
|
27
|
+
};
|
|
28
|
+
return function (mod) {
|
|
29
|
+
if (mod && mod.__esModule) return mod;
|
|
30
|
+
var result = {};
|
|
31
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
32
|
+
__setModuleDefault(result, mod);
|
|
33
|
+
return result;
|
|
34
|
+
};
|
|
35
|
+
})();
|
|
36
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
37
|
+
exports.QueryManager = void 0;
|
|
38
|
+
const runtime = __importStar(require("../runtime.js"));
|
|
39
|
+
/** Operations for the "query" API area. */
|
|
40
|
+
class QueryManager {
|
|
41
|
+
session;
|
|
42
|
+
constructor(session) {
|
|
43
|
+
this.session = session;
|
|
44
|
+
}
|
|
45
|
+
async query(body) {
|
|
46
|
+
let url = this.session.baseUrl("api");
|
|
47
|
+
url += "/query";
|
|
48
|
+
let req = this.session.newRequest("POST", url);
|
|
49
|
+
req = runtime.withHeader(req, "box-version", "2026.0");
|
|
50
|
+
const payload = new TextEncoder().encode(JSON.stringify(body));
|
|
51
|
+
req = runtime.withJsonBody(req, payload);
|
|
52
|
+
const resp = await this.session.fetch(req);
|
|
53
|
+
const data = runtime.responseBytes(resp);
|
|
54
|
+
return JSON.parse(new TextDecoder().decode(data));
|
|
55
|
+
}
|
|
56
|
+
async queryInsights(body) {
|
|
57
|
+
let url = this.session.baseUrl("api");
|
|
58
|
+
url += "/query_insights";
|
|
59
|
+
let req = this.session.newRequest("POST", url);
|
|
60
|
+
req = runtime.withHeader(req, "box-version", "2026.0");
|
|
61
|
+
const payload = new TextEncoder().encode(JSON.stringify(body));
|
|
62
|
+
req = runtime.withJsonBody(req, payload);
|
|
63
|
+
const resp = await this.session.fetch(req);
|
|
64
|
+
const data = runtime.responseBytes(resp);
|
|
65
|
+
return JSON.parse(new TextDecoder().decode(data));
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
exports.QueryManager = QueryManager;
|
package/dist/cjs/runtime.js
CHANGED
|
@@ -86,6 +86,8 @@ class Client {
|
|
|
86
86
|
auth;
|
|
87
87
|
baseUrls;
|
|
88
88
|
maxRetries;
|
|
89
|
+
fetchImpl;
|
|
90
|
+
defaultHeaders;
|
|
89
91
|
constructor(auth, options = {}) {
|
|
90
92
|
this.auth = auth;
|
|
91
93
|
const maxRetries = options.maxRetries ?? 5;
|
|
@@ -94,6 +96,8 @@ class Client {
|
|
|
94
96
|
}
|
|
95
97
|
this.maxRetries = maxRetries;
|
|
96
98
|
this.baseUrls = { ...DEFAULT_BASE_URLS, ...(options.baseUrls ?? {}) };
|
|
99
|
+
this.fetchImpl = options.fetch ?? fetch;
|
|
100
|
+
this.defaultHeaders = { ...(options.headers ?? {}) };
|
|
97
101
|
}
|
|
98
102
|
/** The configured base URL for a D-106 class, without a trailing slash. */
|
|
99
103
|
baseUrl(name) {
|
|
@@ -124,13 +128,14 @@ class Client {
|
|
|
124
128
|
let refreshed = false;
|
|
125
129
|
let lastError;
|
|
126
130
|
for (let attempt = 0; attempt <= this.maxRetries; attempt++) {
|
|
127
|
-
const headers = new Headers(
|
|
131
|
+
const headers = new Headers(this.defaultHeaders);
|
|
132
|
+
request.headers.forEach((value, name) => headers.set(name, value));
|
|
128
133
|
headers.set('Authorization', `Bearer ${token}`);
|
|
129
134
|
// `httpResponse` is the platform `Response` (via inference — the name is
|
|
130
135
|
// shadowed by this module's `Response` class, so it is never annotated).
|
|
131
136
|
let httpResponse;
|
|
132
137
|
try {
|
|
133
|
-
httpResponse = await
|
|
138
|
+
httpResponse = await this.fetchImpl(url, {
|
|
134
139
|
method: request.method,
|
|
135
140
|
headers,
|
|
136
141
|
// A `Uint8Array` is a valid `BodyInit` at runtime; the cast bridges
|
|
@@ -154,7 +159,7 @@ class Client {
|
|
|
154
159
|
const response = new Response(httpResponse.status, httpResponse.headers, bodyBytes);
|
|
155
160
|
// A single force-refresh on 401: re-acquire past the token cache so the
|
|
156
161
|
// retry doesn't just resend the same rejected token.
|
|
157
|
-
if (response.status === 401 && !refreshed) {
|
|
162
|
+
if (response.status === 401 && !refreshed && attempt < this.maxRetries) {
|
|
158
163
|
refreshed = true;
|
|
159
164
|
token = await this.auth.forceRefresh(token);
|
|
160
165
|
continue;
|
package/dist/cjs/tokens.js
CHANGED
|
@@ -72,9 +72,11 @@ exports.CachedToken = CachedToken;
|
|
|
72
72
|
* token acquisition never escapes the runtime's error contract. The optional
|
|
73
73
|
* `signal` cancels an explicit caller-initiated exchange (`exchangeCode`); the
|
|
74
74
|
* cached flows do not thread one, so a shared refresh is never bound to a single
|
|
75
|
-
* request's cancellation.
|
|
75
|
+
* request's cancellation. `fetchImpl` defaults to the global `fetch`; a caller
|
|
76
|
+
* building an `Auth` with a custom transport (matching the runtime `Client`'s
|
|
77
|
+
* own `fetch` override) passes it through so auth traffic is observable too.
|
|
76
78
|
*/
|
|
77
|
-
async function postTokenForm(tokenUrl, form, signal) {
|
|
79
|
+
async function postTokenForm(tokenUrl, form, signal, fetchImpl = fetch) {
|
|
78
80
|
// An internal deadline independent of the caller's signal, combined with it
|
|
79
81
|
// when present. It also covers the body read, since the signal aborts an
|
|
80
82
|
// in-progress `fetch` (including body streaming). `AbortSignal.timeout` owns
|
|
@@ -84,7 +86,7 @@ async function postTokenForm(tokenUrl, form, signal) {
|
|
|
84
86
|
let response;
|
|
85
87
|
let text;
|
|
86
88
|
try {
|
|
87
|
-
response = await
|
|
89
|
+
response = await fetchImpl(tokenUrl, {
|
|
88
90
|
method: 'POST',
|
|
89
91
|
headers: {
|
|
90
92
|
'Content-Type': 'application/x-www-form-urlencoded',
|
package/dist/esm/auth.js
CHANGED
|
@@ -36,7 +36,7 @@ export function clientCredentials(config) {
|
|
|
36
36
|
client_secret: config.clientSecret,
|
|
37
37
|
box_subject_type: subject.type,
|
|
38
38
|
box_subject_id: subject.id,
|
|
39
|
-
}));
|
|
39
|
+
}, undefined, config.fetch));
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
42
42
|
* Build the URL to redirect a user to so they can grant access. `state` is
|
|
@@ -65,7 +65,7 @@ function refreshTokenExchange(config, tokenUrl, initialRefresh) {
|
|
|
65
65
|
refresh_token: refreshToken,
|
|
66
66
|
client_id: config.clientId,
|
|
67
67
|
client_secret: config.clientSecret,
|
|
68
|
-
});
|
|
68
|
+
}, undefined, config.fetch);
|
|
69
69
|
if (token.refreshToken) {
|
|
70
70
|
refreshToken = token.refreshToken;
|
|
71
71
|
config.onRefresh?.(token.refreshToken);
|
|
@@ -94,7 +94,7 @@ export async function exchangeCode(config, code, redirectUri, signal) {
|
|
|
94
94
|
client_id: config.clientId,
|
|
95
95
|
client_secret: config.clientSecret,
|
|
96
96
|
redirect_uri: redirectUri,
|
|
97
|
-
}, signal);
|
|
97
|
+
}, signal, config.fetch);
|
|
98
98
|
if (!token.refreshToken) {
|
|
99
99
|
throw new BoxApiError('authorization-code exchange returned no refresh_token');
|
|
100
100
|
}
|
package/dist/esm/buildinfo.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
// Code generated by box-gantry 0.1.0 (spec
|
|
1
|
+
// Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80). DO NOT EDIT.
|
|
2
2
|
/** The box-gantry engine version that generated this SDK. */
|
|
3
3
|
export const ENGINE = "0.1.0";
|
|
4
4
|
/** Fingerprint of the input spec set. */
|
|
5
|
-
export const SPEC_FINGERPRINT = "
|
|
5
|
+
export const SPEC_FINGERPRINT = "3fb3510fe12f2f80";
|
|
6
6
|
/** The target language key (FR-4). */
|
|
7
7
|
export const TARGET = "typescript";
|
package/dist/esm/client.js
CHANGED
|
@@ -49,6 +49,7 @@ import { MetadataCascadePoliciesManager } from './managers/metadata_cascade_poli
|
|
|
49
49
|
import { MetadataTaxonomiesManager } from './managers/metadata_taxonomies.js';
|
|
50
50
|
import { MetadataTemplatesManager } from './managers/metadata_templates.js';
|
|
51
51
|
import { NotesManager } from './managers/notes.js';
|
|
52
|
+
import { QueryManager } from './managers/query.js';
|
|
52
53
|
import { RecentItemsManager } from './managers/recent_items.js';
|
|
53
54
|
import { RetentionPoliciesManager } from './managers/retention_policies.js';
|
|
54
55
|
import { RetentionPolicyAssignmentsManager } from './managers/retention_policy_assignments.js';
|
|
@@ -136,6 +137,7 @@ export class Client {
|
|
|
136
137
|
metadataTaxonomies;
|
|
137
138
|
metadataTemplates;
|
|
138
139
|
notes;
|
|
140
|
+
query;
|
|
139
141
|
recentItems;
|
|
140
142
|
retentionPolicies;
|
|
141
143
|
retentionPolicyAssignments;
|
|
@@ -224,6 +226,7 @@ export class Client {
|
|
|
224
226
|
this.metadataTaxonomies = new MetadataTaxonomiesManager(session);
|
|
225
227
|
this.metadataTemplates = new MetadataTemplatesManager(session);
|
|
226
228
|
this.notes = new NotesManager(session);
|
|
229
|
+
this.query = new QueryManager(session);
|
|
227
230
|
this.recentItems = new RecentItemsManager(session);
|
|
228
231
|
this.retentionPolicies = new RetentionPoliciesManager(session);
|
|
229
232
|
this.retentionPolicyAssignments = new RetentionPolicyAssignmentsManager(session);
|
package/dist/esm/jwt.js
CHANGED
|
@@ -8,10 +8,10 @@ export class CollaborationAllowlistEntriesManager {
|
|
|
8
8
|
this.session = session;
|
|
9
9
|
}
|
|
10
10
|
/** Iterate every `models.schemas.CollaborationAllowlistEntry` across pages, threading the marker cursor. */
|
|
11
|
-
async *
|
|
11
|
+
async *list(opts) {
|
|
12
12
|
const options = { ...opts };
|
|
13
13
|
for (;;) {
|
|
14
|
-
const page = await this.
|
|
14
|
+
const page = await this.listPage(options);
|
|
15
15
|
const items = page.entries ?? [];
|
|
16
16
|
for (const item of items) {
|
|
17
17
|
yield item;
|
|
@@ -23,7 +23,7 @@ export class CollaborationAllowlistEntriesManager {
|
|
|
23
23
|
options.marker = cursor;
|
|
24
24
|
}
|
|
25
25
|
}
|
|
26
|
-
async
|
|
26
|
+
async listPage(opts) {
|
|
27
27
|
let url = this.session.baseUrl("api");
|
|
28
28
|
url += "/collaboration_whitelist_entries";
|
|
29
29
|
let req = this.session.newRequest("GET", url);
|
|
@@ -38,7 +38,7 @@ export class CollaborationAllowlistEntriesManager {
|
|
|
38
38
|
const data = runtime.responseBytes(resp);
|
|
39
39
|
return JSON.parse(new TextDecoder().decode(data));
|
|
40
40
|
}
|
|
41
|
-
async
|
|
41
|
+
async create(body) {
|
|
42
42
|
let url = this.session.baseUrl("api");
|
|
43
43
|
url += "/collaboration_whitelist_entries";
|
|
44
44
|
let req = this.session.newRequest("POST", url);
|
|
@@ -48,7 +48,7 @@ export class CollaborationAllowlistEntriesManager {
|
|
|
48
48
|
const data = runtime.responseBytes(resp);
|
|
49
49
|
return JSON.parse(new TextDecoder().decode(data));
|
|
50
50
|
}
|
|
51
|
-
async
|
|
51
|
+
async get(collaborationWhitelistEntryId) {
|
|
52
52
|
let url = this.session.baseUrl("api");
|
|
53
53
|
url += "/collaboration_whitelist_entries";
|
|
54
54
|
url += '/' + pathEscape(collaborationWhitelistEntryId);
|
|
@@ -57,7 +57,7 @@ export class CollaborationAllowlistEntriesManager {
|
|
|
57
57
|
const data = runtime.responseBytes(resp);
|
|
58
58
|
return JSON.parse(new TextDecoder().decode(data));
|
|
59
59
|
}
|
|
60
|
-
async
|
|
60
|
+
async delete_(collaborationWhitelistEntryId) {
|
|
61
61
|
let url = this.session.baseUrl("api");
|
|
62
62
|
url += "/collaboration_whitelist_entries";
|
|
63
63
|
url += '/' + pathEscape(collaborationWhitelistEntryId);
|
|
@@ -8,10 +8,10 @@ export class CollaborationAllowlistExemptTargetsManager {
|
|
|
8
8
|
this.session = session;
|
|
9
9
|
}
|
|
10
10
|
/** Iterate every `models.schemas.CollaborationAllowlistExemptTarget` across pages, threading the marker cursor. */
|
|
11
|
-
async *
|
|
11
|
+
async *list(opts) {
|
|
12
12
|
const options = { ...opts };
|
|
13
13
|
for (;;) {
|
|
14
|
-
const page = await this.
|
|
14
|
+
const page = await this.listPage(options);
|
|
15
15
|
const items = page.entries ?? [];
|
|
16
16
|
for (const item of items) {
|
|
17
17
|
yield item;
|
|
@@ -23,7 +23,7 @@ export class CollaborationAllowlistExemptTargetsManager {
|
|
|
23
23
|
options.marker = cursor;
|
|
24
24
|
}
|
|
25
25
|
}
|
|
26
|
-
async
|
|
26
|
+
async listPage(opts) {
|
|
27
27
|
let url = this.session.baseUrl("api");
|
|
28
28
|
url += "/collaboration_whitelist_exempt_targets";
|
|
29
29
|
let req = this.session.newRequest("GET", url);
|
|
@@ -38,7 +38,7 @@ export class CollaborationAllowlistExemptTargetsManager {
|
|
|
38
38
|
const data = runtime.responseBytes(resp);
|
|
39
39
|
return JSON.parse(new TextDecoder().decode(data));
|
|
40
40
|
}
|
|
41
|
-
async
|
|
41
|
+
async create(body) {
|
|
42
42
|
let url = this.session.baseUrl("api");
|
|
43
43
|
url += "/collaboration_whitelist_exempt_targets";
|
|
44
44
|
let req = this.session.newRequest("POST", url);
|
|
@@ -48,7 +48,7 @@ export class CollaborationAllowlistExemptTargetsManager {
|
|
|
48
48
|
const data = runtime.responseBytes(resp);
|
|
49
49
|
return JSON.parse(new TextDecoder().decode(data));
|
|
50
50
|
}
|
|
51
|
-
async
|
|
51
|
+
async get(collaborationWhitelistExemptTargetId) {
|
|
52
52
|
let url = this.session.baseUrl("api");
|
|
53
53
|
url += "/collaboration_whitelist_exempt_targets";
|
|
54
54
|
url += '/' + pathEscape(collaborationWhitelistExemptTargetId);
|
|
@@ -57,7 +57,7 @@ export class CollaborationAllowlistExemptTargetsManager {
|
|
|
57
57
|
const data = runtime.responseBytes(resp);
|
|
58
58
|
return JSON.parse(new TextDecoder().decode(data));
|
|
59
59
|
}
|
|
60
|
-
async
|
|
60
|
+
async delete_(collaborationWhitelistExemptTargetId) {
|
|
61
61
|
let url = this.session.baseUrl("api");
|
|
62
62
|
url += "/collaboration_whitelist_exempt_targets";
|
|
63
63
|
url += '/' + pathEscape(collaborationWhitelistExemptTargetId);
|
|
@@ -48,6 +48,7 @@ export * from './metadata_cascade_policies.js';
|
|
|
48
48
|
export * from './metadata_taxonomies.js';
|
|
49
49
|
export * from './metadata_templates.js';
|
|
50
50
|
export * from './notes.js';
|
|
51
|
+
export * from './query.js';
|
|
51
52
|
export * from './recent_items.js';
|
|
52
53
|
export * from './retention_policies.js';
|
|
53
54
|
export * from './retention_policy_assignments.js';
|
|
@@ -71,7 +71,7 @@ export class MembershipsManager {
|
|
|
71
71
|
const data = runtime.responseBytes(resp);
|
|
72
72
|
return JSON.parse(new TextDecoder().decode(data));
|
|
73
73
|
}
|
|
74
|
-
async
|
|
74
|
+
async createGroupMembership(body, opts) {
|
|
75
75
|
let url = this.session.baseUrl("api");
|
|
76
76
|
url += "/group_memberships";
|
|
77
77
|
let req = this.session.newRequest("POST", url);
|
|
@@ -85,7 +85,7 @@ export class MembershipsManager {
|
|
|
85
85
|
const data = runtime.responseBytes(resp);
|
|
86
86
|
return JSON.parse(new TextDecoder().decode(data));
|
|
87
87
|
}
|
|
88
|
-
async
|
|
88
|
+
async getGroupMembership(groupMembershipId, opts) {
|
|
89
89
|
let url = this.session.baseUrl("api");
|
|
90
90
|
url += "/group_memberships";
|
|
91
91
|
url += '/' + pathEscape(groupMembershipId);
|
|
@@ -98,7 +98,7 @@ export class MembershipsManager {
|
|
|
98
98
|
const data = runtime.responseBytes(resp);
|
|
99
99
|
return JSON.parse(new TextDecoder().decode(data));
|
|
100
100
|
}
|
|
101
|
-
async
|
|
101
|
+
async updateGroupMembership(groupMembershipId, body, opts) {
|
|
102
102
|
let url = this.session.baseUrl("api");
|
|
103
103
|
url += "/group_memberships";
|
|
104
104
|
url += '/' + pathEscape(groupMembershipId);
|
|
@@ -113,7 +113,7 @@ export class MembershipsManager {
|
|
|
113
113
|
const data = runtime.responseBytes(resp);
|
|
114
114
|
return JSON.parse(new TextDecoder().decode(data));
|
|
115
115
|
}
|
|
116
|
-
async
|
|
116
|
+
async deleteGroupMembership(groupMembershipId) {
|
|
117
117
|
let url = this.session.baseUrl("api");
|
|
118
118
|
url += "/group_memberships";
|
|
119
119
|
url += '/' + pathEscape(groupMembershipId);
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
// Code generated by box-gantry. DO NOT EDIT.
|
|
2
|
+
import * as runtime from '../runtime.js';
|
|
3
|
+
/** Operations for the "query" API area. */
|
|
4
|
+
export class QueryManager {
|
|
5
|
+
session;
|
|
6
|
+
constructor(session) {
|
|
7
|
+
this.session = session;
|
|
8
|
+
}
|
|
9
|
+
async query(body) {
|
|
10
|
+
let url = this.session.baseUrl("api");
|
|
11
|
+
url += "/query";
|
|
12
|
+
let req = this.session.newRequest("POST", url);
|
|
13
|
+
req = runtime.withHeader(req, "box-version", "2026.0");
|
|
14
|
+
const payload = new TextEncoder().encode(JSON.stringify(body));
|
|
15
|
+
req = runtime.withJsonBody(req, payload);
|
|
16
|
+
const resp = await this.session.fetch(req);
|
|
17
|
+
const data = runtime.responseBytes(resp);
|
|
18
|
+
return JSON.parse(new TextDecoder().decode(data));
|
|
19
|
+
}
|
|
20
|
+
async queryInsights(body) {
|
|
21
|
+
let url = this.session.baseUrl("api");
|
|
22
|
+
url += "/query_insights";
|
|
23
|
+
let req = this.session.newRequest("POST", url);
|
|
24
|
+
req = runtime.withHeader(req, "box-version", "2026.0");
|
|
25
|
+
const payload = new TextEncoder().encode(JSON.stringify(body));
|
|
26
|
+
req = runtime.withJsonBody(req, payload);
|
|
27
|
+
const resp = await this.session.fetch(req);
|
|
28
|
+
const data = runtime.responseBytes(resp);
|
|
29
|
+
return JSON.parse(new TextDecoder().decode(data));
|
|
30
|
+
}
|
|
31
|
+
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
// Code generated by box-gantry 0.1.0 (spec
|
|
1
|
+
// Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
|
|
2
2
|
export {};
|