@unofficialbox/box-open-sdk 0.4.4 → 0.6.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.
Files changed (206) hide show
  1. package/README.md +13 -0
  2. package/dist/cjs/buildinfo.js +2 -2
  3. package/dist/cjs/client.js +10 -3
  4. package/dist/cjs/errors.js +47 -0
  5. package/dist/cjs/managers/chunked_uploads.js +13 -0
  6. package/dist/cjs/managers/document_split.js +100 -0
  7. package/dist/cjs/managers/index.js +2 -0
  8. package/dist/cjs/managers/shuttle.js +679 -0
  9. package/dist/cjs/models/schemas/ai.js +1 -1
  10. package/dist/cjs/models/schemas/ai_studio.js +1 -1
  11. package/dist/cjs/models/schemas/app_item_associations.js +1 -1
  12. package/dist/cjs/models/schemas/archives.js +1 -1
  13. package/dist/cjs/models/schemas/authorization.js +1 -1
  14. package/dist/cjs/models/schemas/automate_workflows.js +1 -1
  15. package/dist/cjs/models/schemas/avatars.js +1 -1
  16. package/dist/cjs/models/schemas/chunked_uploads.js +1 -1
  17. package/dist/cjs/models/schemas/classifications.js +1 -1
  18. package/dist/cjs/models/schemas/collaboration_allowlist_entries.js +1 -1
  19. package/dist/cjs/models/schemas/collaboration_allowlist_exempt_targets.js +1 -1
  20. package/dist/cjs/models/schemas/collections.js +1 -1
  21. package/dist/cjs/models/schemas/comments.js +1 -1
  22. package/dist/cjs/models/schemas/device_pinners.js +1 -1
  23. package/dist/cjs/models/schemas/docgen.js +1 -1
  24. package/dist/cjs/models/schemas/docgen_template.js +1 -1
  25. package/dist/cjs/models/schemas/document_split.js +3 -0
  26. package/dist/cjs/models/schemas/email_aliases.js +1 -1
  27. package/dist/cjs/models/schemas/enterprise_configurations.js +1 -1
  28. package/dist/cjs/models/schemas/events.js +1 -1
  29. package/dist/cjs/models/schemas/external_users.js +1 -1
  30. package/dist/cjs/models/schemas/file_requests.js +1 -1
  31. package/dist/cjs/models/schemas/file_version_legal_holds.js +1 -1
  32. package/dist/cjs/models/schemas/file_version_retentions.js +1 -1
  33. package/dist/cjs/models/schemas/file_versions.js +1 -1
  34. package/dist/cjs/models/schemas/files.js +1 -1
  35. package/dist/cjs/models/schemas/folder_locks.js +1 -1
  36. package/dist/cjs/models/schemas/folders.js +1 -1
  37. package/dist/cjs/models/schemas/groups.js +1 -1
  38. package/dist/cjs/models/schemas/hub_collaborations.js +1 -1
  39. package/dist/cjs/models/schemas/hub_document.js +1 -1
  40. package/dist/cjs/models/schemas/hub_items.js +1 -1
  41. package/dist/cjs/models/schemas/hubs.js +1 -1
  42. package/dist/cjs/models/schemas/integration_mappings.js +1 -1
  43. package/dist/cjs/models/schemas/invites.js +1 -1
  44. package/dist/cjs/models/schemas/legal_hold_policies.js +1 -1
  45. package/dist/cjs/models/schemas/legal_hold_policy_assignments.js +1 -1
  46. package/dist/cjs/models/schemas/list_collaborations.js +1 -1
  47. package/dist/cjs/models/schemas/memberships.js +1 -1
  48. package/dist/cjs/models/schemas/metadata_cascade_policies.js +1 -1
  49. package/dist/cjs/models/schemas/metadata_taxonomies.js +1 -1
  50. package/dist/cjs/models/schemas/metadata_templates.js +1 -1
  51. package/dist/cjs/models/schemas/notes.js +1 -1
  52. package/dist/cjs/models/schemas/query.js +1 -1
  53. package/dist/cjs/models/schemas/recent_items.js +1 -1
  54. package/dist/cjs/models/schemas/retention_policies.js +1 -1
  55. package/dist/cjs/models/schemas/retention_policy_assignments.js +1 -1
  56. package/dist/cjs/models/schemas/search.js +1 -1
  57. package/dist/cjs/models/schemas/session_termination.js +1 -1
  58. package/dist/cjs/models/schemas/shared_links_folders.js +1 -1
  59. package/dist/cjs/models/schemas/shield_information_barrier_reports.js +1 -1
  60. package/dist/cjs/models/schemas/shield_information_barrier_segment_members.js +1 -1
  61. package/dist/cjs/models/schemas/shield_information_barrier_segment_restrictions.js +1 -1
  62. package/dist/cjs/models/schemas/shield_information_barrier_segments.js +1 -1
  63. package/dist/cjs/models/schemas/shield_information_barriers.js +1 -1
  64. package/dist/cjs/models/schemas/shield_lists.js +1 -1
  65. package/dist/cjs/models/schemas/shuttle.js +3 -0
  66. package/dist/cjs/models/schemas/sign_requests.js +1 -1
  67. package/dist/cjs/models/schemas/sign_templates.js +1 -1
  68. package/dist/cjs/models/schemas/skills.js +1 -1
  69. package/dist/cjs/models/schemas/storage_policies.js +1 -1
  70. package/dist/cjs/models/schemas/storage_policy_assignments.js +1 -1
  71. package/dist/cjs/models/schemas/task_assignments.js +1 -1
  72. package/dist/cjs/models/schemas/tasks.js +1 -1
  73. package/dist/cjs/models/schemas/terms_of_service_user_statuses.js +1 -1
  74. package/dist/cjs/models/schemas/terms_of_services.js +1 -1
  75. package/dist/cjs/models/schemas/transfer.js +1 -1
  76. package/dist/cjs/models/schemas/trashed_files.js +1 -1
  77. package/dist/cjs/models/schemas/trashed_folders.js +1 -1
  78. package/dist/cjs/models/schemas/trashed_items.js +1 -1
  79. package/dist/cjs/models/schemas/trashed_web_links.js +1 -1
  80. package/dist/cjs/models/schemas/uploads.js +1 -1
  81. package/dist/cjs/models/schemas/user_collaborations.js +1 -1
  82. package/dist/cjs/models/schemas/users.js +1 -1
  83. package/dist/cjs/models/schemas/web_links.js +1 -1
  84. package/dist/cjs/models/schemas/webhooks.js +1 -1
  85. package/dist/cjs/models/schemas/workflows.js +1 -1
  86. package/dist/cjs/models/schemas/zip_downloads.js +1 -1
  87. package/dist/cjs/models/schemas.js +3 -1
  88. package/dist/cjs/runtime.js +3 -0
  89. package/dist/esm/buildinfo.js +2 -2
  90. package/dist/esm/client.js +10 -3
  91. package/dist/esm/errors.js +46 -0
  92. package/dist/esm/managers/chunked_uploads.js +13 -0
  93. package/dist/esm/managers/document_split.js +63 -0
  94. package/dist/esm/managers/index.js +2 -0
  95. package/dist/esm/managers/shuttle.js +642 -0
  96. package/dist/esm/models/schemas/ai.js +1 -1
  97. package/dist/esm/models/schemas/ai_studio.js +1 -1
  98. package/dist/esm/models/schemas/app_item_associations.js +1 -1
  99. package/dist/esm/models/schemas/archives.js +1 -1
  100. package/dist/esm/models/schemas/authorization.js +1 -1
  101. package/dist/esm/models/schemas/automate_workflows.js +1 -1
  102. package/dist/esm/models/schemas/avatars.js +1 -1
  103. package/dist/esm/models/schemas/chunked_uploads.js +1 -1
  104. package/dist/esm/models/schemas/classifications.js +1 -1
  105. package/dist/esm/models/schemas/collaboration_allowlist_entries.js +1 -1
  106. package/dist/esm/models/schemas/collaboration_allowlist_exempt_targets.js +1 -1
  107. package/dist/esm/models/schemas/collections.js +1 -1
  108. package/dist/esm/models/schemas/comments.js +1 -1
  109. package/dist/esm/models/schemas/device_pinners.js +1 -1
  110. package/dist/esm/models/schemas/docgen.js +1 -1
  111. package/dist/esm/models/schemas/docgen_template.js +1 -1
  112. package/dist/esm/models/schemas/document_split.js +2 -0
  113. package/dist/esm/models/schemas/email_aliases.js +1 -1
  114. package/dist/esm/models/schemas/enterprise_configurations.js +1 -1
  115. package/dist/esm/models/schemas/events.js +1 -1
  116. package/dist/esm/models/schemas/external_users.js +1 -1
  117. package/dist/esm/models/schemas/file_requests.js +1 -1
  118. package/dist/esm/models/schemas/file_version_legal_holds.js +1 -1
  119. package/dist/esm/models/schemas/file_version_retentions.js +1 -1
  120. package/dist/esm/models/schemas/file_versions.js +1 -1
  121. package/dist/esm/models/schemas/files.js +1 -1
  122. package/dist/esm/models/schemas/folder_locks.js +1 -1
  123. package/dist/esm/models/schemas/folders.js +1 -1
  124. package/dist/esm/models/schemas/groups.js +1 -1
  125. package/dist/esm/models/schemas/hub_collaborations.js +1 -1
  126. package/dist/esm/models/schemas/hub_document.js +1 -1
  127. package/dist/esm/models/schemas/hub_items.js +1 -1
  128. package/dist/esm/models/schemas/hubs.js +1 -1
  129. package/dist/esm/models/schemas/integration_mappings.js +1 -1
  130. package/dist/esm/models/schemas/invites.js +1 -1
  131. package/dist/esm/models/schemas/legal_hold_policies.js +1 -1
  132. package/dist/esm/models/schemas/legal_hold_policy_assignments.js +1 -1
  133. package/dist/esm/models/schemas/list_collaborations.js +1 -1
  134. package/dist/esm/models/schemas/memberships.js +1 -1
  135. package/dist/esm/models/schemas/metadata_cascade_policies.js +1 -1
  136. package/dist/esm/models/schemas/metadata_taxonomies.js +1 -1
  137. package/dist/esm/models/schemas/metadata_templates.js +1 -1
  138. package/dist/esm/models/schemas/notes.js +1 -1
  139. package/dist/esm/models/schemas/query.js +1 -1
  140. package/dist/esm/models/schemas/recent_items.js +1 -1
  141. package/dist/esm/models/schemas/retention_policies.js +1 -1
  142. package/dist/esm/models/schemas/retention_policy_assignments.js +1 -1
  143. package/dist/esm/models/schemas/search.js +1 -1
  144. package/dist/esm/models/schemas/session_termination.js +1 -1
  145. package/dist/esm/models/schemas/shared_links_folders.js +1 -1
  146. package/dist/esm/models/schemas/shield_information_barrier_reports.js +1 -1
  147. package/dist/esm/models/schemas/shield_information_barrier_segment_members.js +1 -1
  148. package/dist/esm/models/schemas/shield_information_barrier_segment_restrictions.js +1 -1
  149. package/dist/esm/models/schemas/shield_information_barrier_segments.js +1 -1
  150. package/dist/esm/models/schemas/shield_information_barriers.js +1 -1
  151. package/dist/esm/models/schemas/shield_lists.js +1 -1
  152. package/dist/esm/models/schemas/shuttle.js +2 -0
  153. package/dist/esm/models/schemas/sign_requests.js +1 -1
  154. package/dist/esm/models/schemas/sign_templates.js +1 -1
  155. package/dist/esm/models/schemas/skills.js +1 -1
  156. package/dist/esm/models/schemas/storage_policies.js +1 -1
  157. package/dist/esm/models/schemas/storage_policy_assignments.js +1 -1
  158. package/dist/esm/models/schemas/task_assignments.js +1 -1
  159. package/dist/esm/models/schemas/tasks.js +1 -1
  160. package/dist/esm/models/schemas/terms_of_service_user_statuses.js +1 -1
  161. package/dist/esm/models/schemas/terms_of_services.js +1 -1
  162. package/dist/esm/models/schemas/transfer.js +1 -1
  163. package/dist/esm/models/schemas/trashed_files.js +1 -1
  164. package/dist/esm/models/schemas/trashed_folders.js +1 -1
  165. package/dist/esm/models/schemas/trashed_items.js +1 -1
  166. package/dist/esm/models/schemas/trashed_web_links.js +1 -1
  167. package/dist/esm/models/schemas/uploads.js +1 -1
  168. package/dist/esm/models/schemas/user_collaborations.js +1 -1
  169. package/dist/esm/models/schemas/users.js +1 -1
  170. package/dist/esm/models/schemas/web_links.js +1 -1
  171. package/dist/esm/models/schemas/webhooks.js +1 -1
  172. package/dist/esm/models/schemas/workflows.js +1 -1
  173. package/dist/esm/models/schemas/zip_downloads.js +1 -1
  174. package/dist/esm/models/schemas.js +3 -1
  175. package/dist/esm/runtime.js +4 -1
  176. package/dist/types/buildinfo.d.ts +1 -1
  177. package/dist/types/client.d.ts +8 -3
  178. package/dist/types/errors.d.ts +21 -0
  179. package/dist/types/managers/chunked_uploads.d.ts +1 -0
  180. package/dist/types/managers/document_split.d.ts +17 -0
  181. package/dist/types/managers/index.d.ts +2 -0
  182. package/dist/types/managers/retention_policies.d.ts +1 -1
  183. package/dist/types/managers/shuttle.d.ts +119 -0
  184. package/dist/types/models/schemas/archives.d.ts +2 -2
  185. package/dist/types/models/schemas/automate_workflows.d.ts +2 -2
  186. package/dist/types/models/schemas/chunked_uploads.d.ts +21 -0
  187. package/dist/types/models/schemas/docgen.d.ts +2 -0
  188. package/dist/types/models/schemas/document_split.d.ts +92 -0
  189. package/dist/types/models/schemas/events.d.ts +51 -3
  190. package/dist/types/models/schemas/groups.d.ts +2 -2
  191. package/dist/types/models/schemas/notes.d.ts +1 -1
  192. package/dist/types/models/schemas/retention_policies.d.ts +3 -3
  193. package/dist/types/models/schemas/shared_links_folders.d.ts +2 -1
  194. package/dist/types/models/schemas/shield_information_barrier_reports.d.ts +2 -2
  195. package/dist/types/models/schemas/shuttle.d.ts +436 -0
  196. package/dist/types/models/schemas/skills.d.ts +2 -2
  197. package/dist/types/models/schemas/web_links.d.ts +2 -1
  198. package/dist/types/models/schemas/workflows.d.ts +2 -2
  199. package/dist/types/models/schemas.d.ts +51 -61
  200. package/docs/README.md +3 -1
  201. package/docs/errors.md +5 -4
  202. package/docs/managers/chunked_uploads.md +18 -0
  203. package/docs/managers/document_split.md +56 -0
  204. package/docs/managers/retention_policies.md +1 -1
  205. package/docs/managers/shuttle.md +687 -0
  206. package/package.json +1 -1
@@ -0,0 +1,642 @@
1
+ // Code generated by box-gantry. DO NOT EDIT.
2
+ import * as runtime from '../runtime.js';
3
+ import { pathEscape } from '../internal.js';
4
+ /** Operations for the "shuttle" API area. */
5
+ export class ShuttleManager {
6
+ session;
7
+ constructor(session) {
8
+ this.session = session;
9
+ }
10
+ /** Iterate every `models.schemas.ShuttleSystem` across pages, threading the marker cursor. */
11
+ async *listSystems(opts) {
12
+ const options = { ...opts };
13
+ for (;;) {
14
+ const page = await this.listSystemsPage(options);
15
+ const items = page.entries ?? [];
16
+ for (const item of items) {
17
+ yield item;
18
+ }
19
+ const cursor = page.next_marker;
20
+ if (cursor === undefined || cursor === null || cursor === '') {
21
+ return;
22
+ }
23
+ options.marker = cursor;
24
+ }
25
+ }
26
+ async listSystemsPage(opts) {
27
+ let url = this.session.baseUrl("api");
28
+ url += "/shuttle_systems";
29
+ let req = this.session.newRequest("GET", url);
30
+ const options = opts ?? {};
31
+ if (options.marker !== undefined) {
32
+ req = runtime.withQuery(req, "marker", options.marker);
33
+ }
34
+ if (options.limit !== undefined) {
35
+ req = runtime.withQuery(req, "limit", String(options.limit));
36
+ }
37
+ req = runtime.withHeader(req, "box-version", "2026.0");
38
+ const resp = await this.session.fetch(req);
39
+ const data = runtime.responseBytes(resp);
40
+ return JSON.parse(new TextDecoder().decode(data));
41
+ }
42
+ async createSystems(body) {
43
+ let url = this.session.baseUrl("api");
44
+ url += "/shuttle_systems";
45
+ let req = this.session.newRequest("POST", url);
46
+ req = runtime.withHeader(req, "box-version", "2026.0");
47
+ const payload = new TextEncoder().encode(JSON.stringify(body));
48
+ req = runtime.withJsonBody(req, payload);
49
+ const resp = await this.session.fetch(req);
50
+ const data = runtime.responseBytes(resp);
51
+ return JSON.parse(new TextDecoder().decode(data));
52
+ }
53
+ async getSystem(shuttleSystemId) {
54
+ let url = this.session.baseUrl("api");
55
+ url += "/shuttle_systems";
56
+ url += '/' + pathEscape(shuttleSystemId);
57
+ let req = this.session.newRequest("GET", url);
58
+ req = runtime.withHeader(req, "box-version", "2026.0");
59
+ const resp = await this.session.fetch(req);
60
+ const data = runtime.responseBytes(resp);
61
+ return JSON.parse(new TextDecoder().decode(data));
62
+ }
63
+ async updateSystem(shuttleSystemId, body) {
64
+ let url = this.session.baseUrl("api");
65
+ url += "/shuttle_systems";
66
+ url += '/' + pathEscape(shuttleSystemId);
67
+ let req = this.session.newRequest("PUT", url);
68
+ req = runtime.withHeader(req, "box-version", "2026.0");
69
+ const payload = new TextEncoder().encode(JSON.stringify(body));
70
+ req = runtime.withJsonBody(req, payload);
71
+ const resp = await this.session.fetch(req);
72
+ const data = runtime.responseBytes(resp);
73
+ return JSON.parse(new TextDecoder().decode(data));
74
+ }
75
+ async deleteSystem(shuttleSystemId) {
76
+ let url = this.session.baseUrl("api");
77
+ url += "/shuttle_systems";
78
+ url += '/' + pathEscape(shuttleSystemId);
79
+ let req = this.session.newRequest("DELETE", url);
80
+ req = runtime.withHeader(req, "box-version", "2026.0");
81
+ await this.session.fetch(req);
82
+ }
83
+ async createSystemIssueRegistrationToken(shuttleSystemId) {
84
+ let url = this.session.baseUrl("api");
85
+ url += "/shuttle_systems";
86
+ url += '/' + pathEscape(shuttleSystemId);
87
+ url += "/issue_registration_token";
88
+ let req = this.session.newRequest("POST", url);
89
+ req = runtime.withHeader(req, "box-version", "2026.0");
90
+ const resp = await this.session.fetch(req);
91
+ const data = runtime.responseBytes(resp);
92
+ return JSON.parse(new TextDecoder().decode(data));
93
+ }
94
+ /** Iterate every `models.schemas.ShuttleJob` across pages, threading the marker cursor. */
95
+ async *listJobs(opts) {
96
+ const options = { ...opts };
97
+ for (;;) {
98
+ const page = await this.listJobsPage(options);
99
+ const items = page.entries ?? [];
100
+ for (const item of items) {
101
+ yield item;
102
+ }
103
+ const cursor = page.next_marker;
104
+ if (cursor === undefined || cursor === null || cursor === '') {
105
+ return;
106
+ }
107
+ options.marker = cursor;
108
+ }
109
+ }
110
+ async listJobsPage(opts) {
111
+ let url = this.session.baseUrl("api");
112
+ url += "/shuttle_jobs";
113
+ let req = this.session.newRequest("GET", url);
114
+ const options = opts ?? {};
115
+ if (options.marker !== undefined) {
116
+ req = runtime.withQuery(req, "marker", options.marker);
117
+ }
118
+ if (options.limit !== undefined) {
119
+ req = runtime.withQuery(req, "limit", String(options.limit));
120
+ }
121
+ req = runtime.withHeader(req, "box-version", "2026.0");
122
+ const resp = await this.session.fetch(req);
123
+ const data = runtime.responseBytes(resp);
124
+ return JSON.parse(new TextDecoder().decode(data));
125
+ }
126
+ async createJobs(body) {
127
+ let url = this.session.baseUrl("api");
128
+ url += "/shuttle_jobs";
129
+ let req = this.session.newRequest("POST", url);
130
+ req = runtime.withHeader(req, "box-version", "2026.0");
131
+ const payload = new TextEncoder().encode(JSON.stringify(body));
132
+ req = runtime.withJsonBody(req, payload);
133
+ const resp = await this.session.fetch(req);
134
+ const data = runtime.responseBytes(resp);
135
+ return JSON.parse(new TextDecoder().decode(data));
136
+ }
137
+ async getJob(shuttleJobId) {
138
+ let url = this.session.baseUrl("api");
139
+ url += "/shuttle_jobs";
140
+ url += '/' + pathEscape(shuttleJobId);
141
+ let req = this.session.newRequest("GET", url);
142
+ req = runtime.withHeader(req, "box-version", "2026.0");
143
+ const resp = await this.session.fetch(req);
144
+ const data = runtime.responseBytes(resp);
145
+ return JSON.parse(new TextDecoder().decode(data));
146
+ }
147
+ async updateJob(shuttleJobId, body) {
148
+ let url = this.session.baseUrl("api");
149
+ url += "/shuttle_jobs";
150
+ url += '/' + pathEscape(shuttleJobId);
151
+ let req = this.session.newRequest("PUT", url);
152
+ req = runtime.withHeader(req, "box-version", "2026.0");
153
+ const payload = new TextEncoder().encode(JSON.stringify(body));
154
+ req = runtime.withJsonBody(req, payload);
155
+ const resp = await this.session.fetch(req);
156
+ const data = runtime.responseBytes(resp);
157
+ return JSON.parse(new TextDecoder().decode(data));
158
+ }
159
+ async deleteJob(shuttleJobId) {
160
+ let url = this.session.baseUrl("api");
161
+ url += "/shuttle_jobs";
162
+ url += '/' + pathEscape(shuttleJobId);
163
+ let req = this.session.newRequest("DELETE", url);
164
+ req = runtime.withHeader(req, "box-version", "2026.0");
165
+ await this.session.fetch(req);
166
+ }
167
+ async startJob(shuttleJobId, body) {
168
+ let url = this.session.baseUrl("api");
169
+ url += "/shuttle_jobs";
170
+ url += '/' + pathEscape(shuttleJobId);
171
+ url += "/start";
172
+ let req = this.session.newRequest("POST", url);
173
+ req = runtime.withHeader(req, "box-version", "2026.0");
174
+ const payload = new TextEncoder().encode(JSON.stringify(body));
175
+ req = runtime.withJsonBody(req, payload);
176
+ await this.session.fetch(req);
177
+ }
178
+ async createJobStop(shuttleJobId) {
179
+ let url = this.session.baseUrl("api");
180
+ url += "/shuttle_jobs";
181
+ url += '/' + pathEscape(shuttleJobId);
182
+ url += "/stop";
183
+ let req = this.session.newRequest("POST", url);
184
+ req = runtime.withHeader(req, "box-version", "2026.0");
185
+ await this.session.fetch(req);
186
+ }
187
+ async createJobPrepareMigration(shuttleJobId) {
188
+ let url = this.session.baseUrl("api");
189
+ url += "/shuttle_jobs";
190
+ url += '/' + pathEscape(shuttleJobId);
191
+ url += "/prepare_migration";
192
+ let req = this.session.newRequest("POST", url);
193
+ req = runtime.withHeader(req, "box-version", "2026.0");
194
+ await this.session.fetch(req);
195
+ }
196
+ /** Iterate every `models.schemas.ShuttleRun` across pages, threading the marker cursor. */
197
+ async *listRuns(jobId, opts) {
198
+ const options = { ...opts };
199
+ for (;;) {
200
+ const page = await this.listRunsPage(jobId, options);
201
+ const items = page.entries ?? [];
202
+ for (const item of items) {
203
+ yield item;
204
+ }
205
+ const cursor = page.next_marker;
206
+ if (cursor === undefined || cursor === null || cursor === '') {
207
+ return;
208
+ }
209
+ options.marker = cursor;
210
+ }
211
+ }
212
+ async listRunsPage(jobId, opts) {
213
+ let url = this.session.baseUrl("api");
214
+ url += "/shuttle_runs";
215
+ let req = this.session.newRequest("GET", url);
216
+ req = runtime.withQuery(req, "job_id", jobId);
217
+ const options = opts ?? {};
218
+ if (options.marker !== undefined) {
219
+ req = runtime.withQuery(req, "marker", options.marker);
220
+ }
221
+ if (options.limit !== undefined) {
222
+ req = runtime.withQuery(req, "limit", String(options.limit));
223
+ }
224
+ req = runtime.withHeader(req, "box-version", "2026.0");
225
+ const resp = await this.session.fetch(req);
226
+ const data = runtime.responseBytes(resp);
227
+ return JSON.parse(new TextDecoder().decode(data));
228
+ }
229
+ async getRun(shuttleRunId) {
230
+ let url = this.session.baseUrl("api");
231
+ url += "/shuttle_runs";
232
+ url += '/' + pathEscape(shuttleRunId);
233
+ let req = this.session.newRequest("GET", url);
234
+ req = runtime.withHeader(req, "box-version", "2026.0");
235
+ const resp = await this.session.fetch(req);
236
+ const data = runtime.responseBytes(resp);
237
+ return JSON.parse(new TextDecoder().decode(data));
238
+ }
239
+ /** Iterate every `models.schemas.ShuttleJobSchedule` across pages, threading the marker cursor. */
240
+ async *listJobSchedules(jobId, opts) {
241
+ const options = { ...opts };
242
+ for (;;) {
243
+ const page = await this.listJobSchedulesPage(jobId, options);
244
+ const items = page.entries ?? [];
245
+ for (const item of items) {
246
+ yield item;
247
+ }
248
+ const cursor = page.next_marker;
249
+ if (cursor === undefined || cursor === null || cursor === '') {
250
+ return;
251
+ }
252
+ options.marker = cursor;
253
+ }
254
+ }
255
+ async listJobSchedulesPage(jobId, opts) {
256
+ let url = this.session.baseUrl("api");
257
+ url += "/shuttle_job_schedules";
258
+ let req = this.session.newRequest("GET", url);
259
+ req = runtime.withQuery(req, "job_id", jobId);
260
+ const options = opts ?? {};
261
+ if (options.marker !== undefined) {
262
+ req = runtime.withQuery(req, "marker", options.marker);
263
+ }
264
+ if (options.limit !== undefined) {
265
+ req = runtime.withQuery(req, "limit", String(options.limit));
266
+ }
267
+ req = runtime.withHeader(req, "box-version", "2026.0");
268
+ const resp = await this.session.fetch(req);
269
+ const data = runtime.responseBytes(resp);
270
+ return JSON.parse(new TextDecoder().decode(data));
271
+ }
272
+ async createJobSchedules(body) {
273
+ let url = this.session.baseUrl("api");
274
+ url += "/shuttle_job_schedules";
275
+ let req = this.session.newRequest("POST", url);
276
+ req = runtime.withHeader(req, "box-version", "2026.0");
277
+ const payload = new TextEncoder().encode(JSON.stringify(body));
278
+ req = runtime.withJsonBody(req, payload);
279
+ const resp = await this.session.fetch(req);
280
+ const data = runtime.responseBytes(resp);
281
+ return JSON.parse(new TextDecoder().decode(data));
282
+ }
283
+ async getJobSchedule(shuttleJobScheduleId) {
284
+ let url = this.session.baseUrl("api");
285
+ url += "/shuttle_job_schedules";
286
+ url += '/' + pathEscape(shuttleJobScheduleId);
287
+ let req = this.session.newRequest("GET", url);
288
+ req = runtime.withHeader(req, "box-version", "2026.0");
289
+ const resp = await this.session.fetch(req);
290
+ const data = runtime.responseBytes(resp);
291
+ return JSON.parse(new TextDecoder().decode(data));
292
+ }
293
+ async updateJobSchedule(shuttleJobScheduleId, body) {
294
+ let url = this.session.baseUrl("api");
295
+ url += "/shuttle_job_schedules";
296
+ url += '/' + pathEscape(shuttleJobScheduleId);
297
+ let req = this.session.newRequest("PUT", url);
298
+ req = runtime.withHeader(req, "box-version", "2026.0");
299
+ const payload = new TextEncoder().encode(JSON.stringify(body));
300
+ req = runtime.withJsonBody(req, payload);
301
+ const resp = await this.session.fetch(req);
302
+ const data = runtime.responseBytes(resp);
303
+ return JSON.parse(new TextDecoder().decode(data));
304
+ }
305
+ async deleteJobSchedule(shuttleJobScheduleId) {
306
+ let url = this.session.baseUrl("api");
307
+ url += "/shuttle_job_schedules";
308
+ url += '/' + pathEscape(shuttleJobScheduleId);
309
+ let req = this.session.newRequest("DELETE", url);
310
+ req = runtime.withHeader(req, "box-version", "2026.0");
311
+ await this.session.fetch(req);
312
+ }
313
+ /** Iterate every `models.schemas.ShuttlePathMapping` across pages, threading the marker cursor. */
314
+ async *listPathMappings(jobId, opts) {
315
+ const options = { ...opts };
316
+ for (;;) {
317
+ const page = await this.listPathMappingsPage(jobId, options);
318
+ const items = page.entries ?? [];
319
+ for (const item of items) {
320
+ yield item;
321
+ }
322
+ const cursor = page.next_marker;
323
+ if (cursor === undefined || cursor === null || cursor === '') {
324
+ return;
325
+ }
326
+ options.marker = cursor;
327
+ }
328
+ }
329
+ async listPathMappingsPage(jobId, opts) {
330
+ let url = this.session.baseUrl("api");
331
+ url += "/shuttle_path_mappings";
332
+ let req = this.session.newRequest("GET", url);
333
+ req = runtime.withQuery(req, "job_id", jobId);
334
+ const options = opts ?? {};
335
+ if (options.marker !== undefined) {
336
+ req = runtime.withQuery(req, "marker", options.marker);
337
+ }
338
+ if (options.limit !== undefined) {
339
+ req = runtime.withQuery(req, "limit", String(options.limit));
340
+ }
341
+ req = runtime.withHeader(req, "box-version", "2026.0");
342
+ const resp = await this.session.fetch(req);
343
+ const data = runtime.responseBytes(resp);
344
+ return JSON.parse(new TextDecoder().decode(data));
345
+ }
346
+ async createPathMappings(body) {
347
+ let url = this.session.baseUrl("api");
348
+ url += "/shuttle_path_mappings";
349
+ let req = this.session.newRequest("POST", url);
350
+ req = runtime.withHeader(req, "box-version", "2026.0");
351
+ const payload = new TextEncoder().encode(JSON.stringify(body));
352
+ req = runtime.withJsonBody(req, payload);
353
+ const resp = await this.session.fetch(req);
354
+ const data = runtime.responseBytes(resp);
355
+ return JSON.parse(new TextDecoder().decode(data));
356
+ }
357
+ async getPathMapping(shuttlePathMappingId) {
358
+ let url = this.session.baseUrl("api");
359
+ url += "/shuttle_path_mappings";
360
+ url += '/' + pathEscape(shuttlePathMappingId);
361
+ let req = this.session.newRequest("GET", url);
362
+ req = runtime.withHeader(req, "box-version", "2026.0");
363
+ const resp = await this.session.fetch(req);
364
+ const data = runtime.responseBytes(resp);
365
+ return JSON.parse(new TextDecoder().decode(data));
366
+ }
367
+ async updatePathMapping(shuttlePathMappingId, body) {
368
+ let url = this.session.baseUrl("api");
369
+ url += "/shuttle_path_mappings";
370
+ url += '/' + pathEscape(shuttlePathMappingId);
371
+ let req = this.session.newRequest("PUT", url);
372
+ req = runtime.withHeader(req, "box-version", "2026.0");
373
+ const payload = new TextEncoder().encode(JSON.stringify(body));
374
+ req = runtime.withJsonBody(req, payload);
375
+ const resp = await this.session.fetch(req);
376
+ const data = runtime.responseBytes(resp);
377
+ return JSON.parse(new TextDecoder().decode(data));
378
+ }
379
+ async deletePathMapping(shuttlePathMappingId) {
380
+ let url = this.session.baseUrl("api");
381
+ url += "/shuttle_path_mappings";
382
+ url += '/' + pathEscape(shuttlePathMappingId);
383
+ let req = this.session.newRequest("DELETE", url);
384
+ req = runtime.withHeader(req, "box-version", "2026.0");
385
+ await this.session.fetch(req);
386
+ }
387
+ async createPathMappingImports(body) {
388
+ let url = this.session.baseUrl("api");
389
+ url += "/shuttle_path_mapping_imports";
390
+ let req = this.session.newRequest("POST", url);
391
+ req = runtime.withHeader(req, "box-version", "2026.0");
392
+ const payload = new TextEncoder().encode(JSON.stringify(body));
393
+ req = runtime.withJsonBody(req, payload);
394
+ await this.session.fetch(req);
395
+ }
396
+ async createSubjectMappingImports(body) {
397
+ let url = this.session.baseUrl("api");
398
+ url += "/shuttle_subject_mapping_imports";
399
+ let req = this.session.newRequest("POST", url);
400
+ req = runtime.withHeader(req, "box-version", "2026.0");
401
+ const payload = new TextEncoder().encode(JSON.stringify(body));
402
+ req = runtime.withJsonBody(req, payload);
403
+ await this.session.fetch(req);
404
+ }
405
+ /** Iterate every `models.schemas.ShuttleSubjectMapping` across pages, threading the marker cursor. */
406
+ async *listSubjectMappings(jobId, opts) {
407
+ const options = { ...opts };
408
+ for (;;) {
409
+ const page = await this.listSubjectMappingsPage(jobId, options);
410
+ const items = page.entries ?? [];
411
+ for (const item of items) {
412
+ yield item;
413
+ }
414
+ const cursor = page.next_marker;
415
+ if (cursor === undefined || cursor === null || cursor === '') {
416
+ return;
417
+ }
418
+ options.marker = cursor;
419
+ }
420
+ }
421
+ async listSubjectMappingsPage(jobId, opts) {
422
+ let url = this.session.baseUrl("api");
423
+ url += "/shuttle_subject_mappings";
424
+ let req = this.session.newRequest("GET", url);
425
+ req = runtime.withQuery(req, "job_id", jobId);
426
+ const options = opts ?? {};
427
+ if (options.marker !== undefined) {
428
+ req = runtime.withQuery(req, "marker", options.marker);
429
+ }
430
+ if (options.limit !== undefined) {
431
+ req = runtime.withQuery(req, "limit", String(options.limit));
432
+ }
433
+ req = runtime.withHeader(req, "box-version", "2026.0");
434
+ const resp = await this.session.fetch(req);
435
+ const data = runtime.responseBytes(resp);
436
+ return JSON.parse(new TextDecoder().decode(data));
437
+ }
438
+ async createSubjectMappings(body) {
439
+ let url = this.session.baseUrl("api");
440
+ url += "/shuttle_subject_mappings";
441
+ let req = this.session.newRequest("POST", url);
442
+ req = runtime.withHeader(req, "box-version", "2026.0");
443
+ const payload = new TextEncoder().encode(JSON.stringify(body));
444
+ req = runtime.withJsonBody(req, payload);
445
+ const resp = await this.session.fetch(req);
446
+ const data = runtime.responseBytes(resp);
447
+ return JSON.parse(new TextDecoder().decode(data));
448
+ }
449
+ async getSubjectMapping(shuttleSubjectMappingId) {
450
+ let url = this.session.baseUrl("api");
451
+ url += "/shuttle_subject_mappings";
452
+ url += '/' + pathEscape(shuttleSubjectMappingId);
453
+ let req = this.session.newRequest("GET", url);
454
+ req = runtime.withHeader(req, "box-version", "2026.0");
455
+ const resp = await this.session.fetch(req);
456
+ const data = runtime.responseBytes(resp);
457
+ return JSON.parse(new TextDecoder().decode(data));
458
+ }
459
+ async updateSubjectMapping(shuttleSubjectMappingId, body) {
460
+ let url = this.session.baseUrl("api");
461
+ url += "/shuttle_subject_mappings";
462
+ url += '/' + pathEscape(shuttleSubjectMappingId);
463
+ let req = this.session.newRequest("PUT", url);
464
+ req = runtime.withHeader(req, "box-version", "2026.0");
465
+ const payload = new TextEncoder().encode(JSON.stringify(body));
466
+ req = runtime.withJsonBody(req, payload);
467
+ const resp = await this.session.fetch(req);
468
+ const data = runtime.responseBytes(resp);
469
+ return JSON.parse(new TextDecoder().decode(data));
470
+ }
471
+ async deleteSubjectMapping(shuttleSubjectMappingId) {
472
+ let url = this.session.baseUrl("api");
473
+ url += "/shuttle_subject_mappings";
474
+ url += '/' + pathEscape(shuttleSubjectMappingId);
475
+ let req = this.session.newRequest("DELETE", url);
476
+ req = runtime.withHeader(req, "box-version", "2026.0");
477
+ await this.session.fetch(req);
478
+ }
479
+ /** Iterate every `models.schemas.ShuttleDiscoveredSubject` across pages, threading the marker cursor. */
480
+ async *listDiscoveredSubjects(jobId, opts) {
481
+ const options = { ...opts };
482
+ for (;;) {
483
+ const page = await this.listDiscoveredSubjectsPage(jobId, options);
484
+ const items = page.entries ?? [];
485
+ for (const item of items) {
486
+ yield item;
487
+ }
488
+ const cursor = page.next_marker;
489
+ if (cursor === undefined || cursor === null || cursor === '') {
490
+ return;
491
+ }
492
+ options.marker = cursor;
493
+ }
494
+ }
495
+ async listDiscoveredSubjectsPage(jobId, opts) {
496
+ let url = this.session.baseUrl("api");
497
+ url += "/shuttle_discovered_subjects";
498
+ let req = this.session.newRequest("GET", url);
499
+ req = runtime.withQuery(req, "job_id", jobId);
500
+ const options = opts ?? {};
501
+ if (options.marker !== undefined) {
502
+ req = runtime.withQuery(req, "marker", options.marker);
503
+ }
504
+ if (options.limit !== undefined) {
505
+ req = runtime.withQuery(req, "limit", String(options.limit));
506
+ }
507
+ req = runtime.withHeader(req, "box-version", "2026.0");
508
+ const resp = await this.session.fetch(req);
509
+ const data = runtime.responseBytes(resp);
510
+ return JSON.parse(new TextDecoder().decode(data));
511
+ }
512
+ /** Iterate every `models.schemas.ShuttlePathEntry` across pages, threading the marker cursor. */
513
+ async *listPathEntries(jobId, side, opts) {
514
+ const options = { ...opts };
515
+ for (;;) {
516
+ const page = await this.listPathEntriesPage(jobId, side, options);
517
+ const items = page.entries ?? [];
518
+ for (const item of items) {
519
+ yield item;
520
+ }
521
+ const cursor = page.next_marker;
522
+ if (cursor === undefined || cursor === null || cursor === '') {
523
+ return;
524
+ }
525
+ options.marker = cursor;
526
+ }
527
+ }
528
+ async listPathEntriesPage(jobId, side, opts) {
529
+ let url = this.session.baseUrl("api");
530
+ url += "/shuttle_path_entries";
531
+ let req = this.session.newRequest("GET", url);
532
+ req = runtime.withQuery(req, "job_id", jobId);
533
+ req = runtime.withQuery(req, "side", side);
534
+ const options = opts ?? {};
535
+ if (options.path !== undefined) {
536
+ req = runtime.withQuery(req, "path", options.path);
537
+ }
538
+ if (options.path_id !== undefined) {
539
+ req = runtime.withQuery(req, "path_id", options.path_id);
540
+ }
541
+ if (options.account_email !== undefined) {
542
+ req = runtime.withQuery(req, "account_email", options.account_email);
543
+ }
544
+ if (options.marker !== undefined) {
545
+ req = runtime.withQuery(req, "marker", options.marker);
546
+ }
547
+ if (options.limit !== undefined) {
548
+ req = runtime.withQuery(req, "limit", String(options.limit));
549
+ }
550
+ req = runtime.withHeader(req, "box-version", "2026.0");
551
+ const resp = await this.session.fetch(req);
552
+ const data = runtime.responseBytes(resp);
553
+ return JSON.parse(new TextDecoder().decode(data));
554
+ }
555
+ /** Iterate every `models.schemas.ShuttleMappingError` across pages, threading the marker cursor. */
556
+ async *listMappingErrors(jobId, opts) {
557
+ const options = { ...opts };
558
+ for (;;) {
559
+ const page = await this.listMappingErrorsPage(jobId, options);
560
+ const items = page.entries ?? [];
561
+ for (const item of items) {
562
+ yield item;
563
+ }
564
+ const cursor = page.next_marker;
565
+ if (cursor === undefined || cursor === null || cursor === '') {
566
+ return;
567
+ }
568
+ options.marker = cursor;
569
+ }
570
+ }
571
+ async listMappingErrorsPage(jobId, opts) {
572
+ let url = this.session.baseUrl("api");
573
+ url += "/shuttle_mapping_errors";
574
+ let req = this.session.newRequest("GET", url);
575
+ req = runtime.withQuery(req, "job_id", jobId);
576
+ const options = opts ?? {};
577
+ if (options.marker !== undefined) {
578
+ req = runtime.withQuery(req, "marker", options.marker);
579
+ }
580
+ if (options.limit !== undefined) {
581
+ req = runtime.withQuery(req, "limit", String(options.limit));
582
+ }
583
+ req = runtime.withHeader(req, "box-version", "2026.0");
584
+ const resp = await this.session.fetch(req);
585
+ const data = runtime.responseBytes(resp);
586
+ return JSON.parse(new TextDecoder().decode(data));
587
+ }
588
+ /** Iterate every `models.schemas.ShuttleReport` across pages, threading the marker cursor. */
589
+ async *listReports(runId, opts) {
590
+ const options = { ...opts };
591
+ for (;;) {
592
+ const page = await this.listReportsPage(runId, options);
593
+ const items = page.entries ?? [];
594
+ for (const item of items) {
595
+ yield item;
596
+ }
597
+ const cursor = page.next_marker;
598
+ if (cursor === undefined || cursor === null || cursor === '') {
599
+ return;
600
+ }
601
+ options.marker = cursor;
602
+ }
603
+ }
604
+ async listReportsPage(runId, opts) {
605
+ let url = this.session.baseUrl("api");
606
+ url += "/shuttle_reports";
607
+ let req = this.session.newRequest("GET", url);
608
+ req = runtime.withQuery(req, "run_id", runId);
609
+ const options = opts ?? {};
610
+ if (options.marker !== undefined) {
611
+ req = runtime.withQuery(req, "marker", options.marker);
612
+ }
613
+ if (options.limit !== undefined) {
614
+ req = runtime.withQuery(req, "limit", String(options.limit));
615
+ }
616
+ req = runtime.withHeader(req, "box-version", "2026.0");
617
+ const resp = await this.session.fetch(req);
618
+ const data = runtime.responseBytes(resp);
619
+ return JSON.parse(new TextDecoder().decode(data));
620
+ }
621
+ async createReports(body) {
622
+ let url = this.session.baseUrl("api");
623
+ url += "/shuttle_reports";
624
+ let req = this.session.newRequest("POST", url);
625
+ req = runtime.withHeader(req, "box-version", "2026.0");
626
+ const payload = new TextEncoder().encode(JSON.stringify(body));
627
+ req = runtime.withJsonBody(req, payload);
628
+ const resp = await this.session.fetch(req);
629
+ const data = runtime.responseBytes(resp);
630
+ return JSON.parse(new TextDecoder().decode(data));
631
+ }
632
+ async getReport(shuttleReportId) {
633
+ let url = this.session.baseUrl("api");
634
+ url += "/shuttle_reports";
635
+ url += '/' + pathEscape(shuttleReportId);
636
+ let req = this.session.newRequest("GET", url);
637
+ req = runtime.withHeader(req, "box-version", "2026.0");
638
+ const resp = await this.session.fetch(req);
639
+ const data = runtime.responseBytes(resp);
640
+ return JSON.parse(new TextDecoder().decode(data));
641
+ }
642
+ }
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};
@@ -1,2 +1,2 @@
1
- // Code generated by box-gantry 0.1.0 (spec 3fb3510fe12f2f80) for Box API 2024.0. DO NOT EDIT.
1
+ // Code generated by box-gantry 0.1.0 (spec 3283827dcf199770) for Box API 2024.0. DO NOT EDIT.
2
2
  export {};