@unofficialbox/box-open-sdk 0.4.4 → 0.5.0

package/docs/managers/shuttle.md

@@ -0,0 +1,687 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ShuttleManager
+
+Reach these methods through the `shuttle` field on `Client`.
+
+## listSystems
+
+`GET /shuttle_systems`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttleSystems`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listSystems()) {
+  // use item
+}
+```
+
+Paginated — `listSystems(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## createSystems
+
+`POST /shuttle_systems`
+
+**Request body** (`application/json`): `ShuttleSystemCreateRequest`
+
+**Returns:** `ShuttleSystem`
+
+**Example**
+
+```ts
+const result = await client.shuttle.createSystems({ /* … */ });
+```
+
+## getSystem
+
+`GET /shuttle_systems/{shuttle_system_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_system_id` | path | `string` | yes |
+
+**Returns:** `ShuttleSystem`
+
+**Example**
+
+```ts
+const result = await client.shuttle.getSystem("SHUTTLE_SYSTEM_ID");
+```
+
+## updateSystem
+
+`PUT /shuttle_systems/{shuttle_system_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_system_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `ShuttleSystemUpdateRequest`
+
+**Returns:** `ShuttleSystem`
+
+**Example**
+
+```ts
+const result = await client.shuttle.updateSystem("SHUTTLE_SYSTEM_ID", { /* … */ });
+```
+
+## deleteSystem
+
+`DELETE /shuttle_systems/{shuttle_system_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_system_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.deleteSystem("SHUTTLE_SYSTEM_ID");
+```
+
+## createSystemIssueRegistrationToken
+
+`POST /shuttle_systems/{shuttle_system_id}/issue_registration_token`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_system_id` | path | `string` | yes |
+
+**Returns:** `ShuttleAgentCredentials`
+
+**Example**
+
+```ts
+const result = await client.shuttle.createSystemIssueRegistrationToken("SHUTTLE_SYSTEM_ID");
+```
+
+## listJobs
+
+`GET /shuttle_jobs`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttleJobs`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listJobs()) {
+  // use item
+}
+```
+
+Paginated — `listJobs(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## createJobs
+
+`POST /shuttle_jobs`
+
+**Request body** (`application/json`): `ShuttleJobCreateRequest`
+
+**Returns:** `ShuttleJob`
+
+**Example**
+
+```ts
+const result = await client.shuttle.createJobs({ /* … */ });
+```
+
+## getJob
+
+`GET /shuttle_jobs/{shuttle_job_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_job_id` | path | `string` | yes |
+
+**Returns:** `ShuttleJob`
+
+**Example**
+
+```ts
+const result = await client.shuttle.getJob("SHUTTLE_JOB_ID");
+```
+
+## updateJob
+
+`PUT /shuttle_jobs/{shuttle_job_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_job_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `ShuttleJobUpdateRequest`
+
+**Returns:** `ShuttleJob`
+
+**Example**
+
+```ts
+const result = await client.shuttle.updateJob("SHUTTLE_JOB_ID", { /* … */ });
+```
+
+## deleteJob
+
+`DELETE /shuttle_jobs/{shuttle_job_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_job_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.deleteJob("SHUTTLE_JOB_ID");
+```
+
+## startJob
+
+`POST /shuttle_jobs/{shuttle_job_id}/start`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_job_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `ShuttleJobStartRequest`
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.startJob("SHUTTLE_JOB_ID", { /* … */ });
+```
+
+## createJobStop
+
+`POST /shuttle_jobs/{shuttle_job_id}/stop`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_job_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.createJobStop("SHUTTLE_JOB_ID");
+```
+
+## createJobPrepareMigration
+
+`POST /shuttle_jobs/{shuttle_job_id}/prepare_migration`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_job_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.createJobPrepareMigration("SHUTTLE_JOB_ID");
+```
+
+## listRuns
+
+`GET /shuttle_runs`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `job_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttleRuns`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listRuns("JOB_ID")) {
+  // use item
+}
+```
+
+Paginated — `listRuns(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## getRun
+
+`GET /shuttle_runs/{shuttle_run_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_run_id` | path | `string` | yes |
+
+**Returns:** `ShuttleRun`
+
+**Example**
+
+```ts
+const result = await client.shuttle.getRun("SHUTTLE_RUN_ID");
+```
+
+## listJobSchedules
+
+`GET /shuttle_job_schedules`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `job_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttleJobSchedules`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listJobSchedules("JOB_ID")) {
+  // use item
+}
+```
+
+Paginated — `listJobSchedules(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## createJobSchedules
+
+`POST /shuttle_job_schedules`
+
+**Request body** (`application/json`): `ShuttleJobScheduleCreateRequest`
+
+**Returns:** `ShuttleJobSchedule`
+
+**Example**
+
+```ts
+const result = await client.shuttle.createJobSchedules({ /* … */ });
+```
+
+## getJobSchedule
+
+`GET /shuttle_job_schedules/{shuttle_job_schedule_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_job_schedule_id` | path | `string` | yes |
+
+**Returns:** `ShuttleJobSchedule`
+
+**Example**
+
+```ts
+const result = await client.shuttle.getJobSchedule("SHUTTLE_JOB_SCHEDULE_ID");
+```
+
+## updateJobSchedule
+
+`PUT /shuttle_job_schedules/{shuttle_job_schedule_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_job_schedule_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `ShuttleJobScheduleUpdateRequest`
+
+**Returns:** `ShuttleJobSchedule`
+
+**Example**
+
+```ts
+const result = await client.shuttle.updateJobSchedule("SHUTTLE_JOB_SCHEDULE_ID", { /* … */ });
+```
+
+## deleteJobSchedule
+
+`DELETE /shuttle_job_schedules/{shuttle_job_schedule_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_job_schedule_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.deleteJobSchedule("SHUTTLE_JOB_SCHEDULE_ID");
+```
+
+## listPathMappings
+
+`GET /shuttle_path_mappings`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `job_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttlePathMappings`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listPathMappings("JOB_ID")) {
+  // use item
+}
+```
+
+Paginated — `listPathMappings(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## createPathMappings
+
+`POST /shuttle_path_mappings`
+
+**Request body** (`application/json`): `ShuttlePathMappingCreateRequest`
+
+**Returns:** `ShuttlePathMapping`
+
+**Example**
+
+```ts
+const result = await client.shuttle.createPathMappings({ /* … */ });
+```
+
+## getPathMapping
+
+`GET /shuttle_path_mappings/{shuttle_path_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_path_mapping_id` | path | `string` | yes |
+
+**Returns:** `ShuttlePathMapping`
+
+**Example**
+
+```ts
+const result = await client.shuttle.getPathMapping("SHUTTLE_PATH_MAPPING_ID");
+```
+
+## updatePathMapping
+
+`PUT /shuttle_path_mappings/{shuttle_path_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_path_mapping_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `ShuttlePathMappingUpdateRequest`
+
+**Returns:** `ShuttlePathMapping`
+
+**Example**
+
+```ts
+const result = await client.shuttle.updatePathMapping("SHUTTLE_PATH_MAPPING_ID", { /* … */ });
+```
+
+## deletePathMapping
+
+`DELETE /shuttle_path_mappings/{shuttle_path_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_path_mapping_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.deletePathMapping("SHUTTLE_PATH_MAPPING_ID");
+```
+
+## createPathMappingImports
+
+`POST /shuttle_path_mapping_imports`
+
+**Request body** (`application/json`): `ShuttlePathMappingImportCreateRequest`
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.createPathMappingImports({ /* … */ });
+```
+
+## createSubjectMappingImports
+
+`POST /shuttle_subject_mapping_imports`
+
+**Request body** (`application/json`): `ShuttleSubjectMappingImportCreateRequest`
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.createSubjectMappingImports({ /* … */ });
+```
+
+## listSubjectMappings
+
+`GET /shuttle_subject_mappings`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `job_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttleSubjectMappings`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listSubjectMappings("JOB_ID")) {
+  // use item
+}
+```
+
+Paginated — `listSubjectMappings(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## createSubjectMappings
+
+`POST /shuttle_subject_mappings`
+
+**Request body** (`application/json`): `ShuttleSubjectMappingCreateRequest`
+
+**Returns:** `ShuttleSubjectMapping`
+
+**Example**
+
+```ts
+const result = await client.shuttle.createSubjectMappings({ /* … */ });
+```
+
+## getSubjectMapping
+
+`GET /shuttle_subject_mappings/{shuttle_subject_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_subject_mapping_id` | path | `string` | yes |
+
+**Returns:** `ShuttleSubjectMapping`
+
+**Example**
+
+```ts
+const result = await client.shuttle.getSubjectMapping("SHUTTLE_SUBJECT_MAPPING_ID");
+```
+
+## updateSubjectMapping
+
+`PUT /shuttle_subject_mappings/{shuttle_subject_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_subject_mapping_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `ShuttleSubjectMappingUpdateRequest`
+
+**Returns:** `ShuttleSubjectMapping`
+
+**Example**
+
+```ts
+const result = await client.shuttle.updateSubjectMapping("SHUTTLE_SUBJECT_MAPPING_ID", { /* … */ });
+```
+
+## deleteSubjectMapping
+
+`DELETE /shuttle_subject_mappings/{shuttle_subject_mapping_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_subject_mapping_id` | path | `string` | yes |
+
+**Returns:** `void`
+
+**Example**
+
+```ts
+await client.shuttle.deleteSubjectMapping("SHUTTLE_SUBJECT_MAPPING_ID");
+```
+
+## listDiscoveredSubjects
+
+`GET /shuttle_discovered_subjects`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `job_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttleDiscoveredSubjects`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listDiscoveredSubjects("JOB_ID")) {
+  // use item
+}
+```
+
+Paginated — `listDiscoveredSubjects(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## listPathEntries
+
+`GET /shuttle_path_entries`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `job_id` | query | `string` | yes |
+| `side` | query | `GetPathEntriesSide` | yes |
+| `path` | query | `string` | no |
+| `path_id` | query | `string` | no |
+| `account_email` | query | `string` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttlePathEntries`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listPathEntries("JOB_ID", "...")) {
+  // use item
+}
+```
+
+Paginated — `listPathEntries(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## listMappingErrors
+
+`GET /shuttle_mapping_errors`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `job_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttleMappingErrors`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listMappingErrors("JOB_ID")) {
+  // use item
+}
+```
+
+Paginated — `listMappingErrors(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## listReports
+
+`GET /shuttle_reports`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `run_id` | query | `string` | yes |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `ShuttleReports`
+
+**Example**
+
+```ts
+for await (const item of client.shuttle.listReports("RUN_ID")) {
+  // use item
+}
+```
+
+Paginated — `listReports(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## createReports
+
+`POST /shuttle_reports`
+
+**Request body** (`application/json`): `ShuttleReportCreateRequest`
+
+**Returns:** `ShuttleReport`
+
+**Example**
+
+```ts
+const result = await client.shuttle.createReports({ /* … */ });
+```
+
+## getReport
+
+`GET /shuttle_reports/{shuttle_report_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `shuttle_report_id` | path | `string` | yes |
+
+**Returns:** `ShuttleReport`
+
+**Example**
+
+```ts
+const result = await client.shuttle.getReport("SHUTTLE_REPORT_ID");
+```
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unofficialbox/box-open-sdk",
-  "version": "0.4.4",
+  "version": "0.5.0",
   "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.",
   "keywords": ["box", "box-api", "sdk", "api-client", "typescript", "unofficial"],
   "license": "MIT",