@unofficialbox/box-open-sdk 0.1.0

package/dist/types/runtime.d.ts

@@ -0,0 +1,85 @@
+import type { Auth } from './auth.js';
+export { BoxApiError } from './errors.js';
+export * from './auth.js';
+/** The runtime-owned HTTP request envelope, assembled by the `with*` builders
+ * before `fetch` executes it. */
+export declare class Request {
+    readonly method: string;
+    readonly url: string;
+    readonly headers: Headers;
+    readonly query: URLSearchParams;
+    /** The buffered request body, if any (buffered so retries can replay it). */
+    body?: Uint8Array;
+    constructor(method: string, url: string);
+}
+/** The runtime-owned HTTP response envelope. The body is read fully so it can be
+ * replayed as bytes or a stream, and so retries stay safe. */
+export declare class Response {
+    readonly status: number;
+    readonly headers: Headers;
+    readonly bodyBytes: Uint8Array;
+    constructor(status: number, headers: Headers, bodyBytes: Uint8Array);
+}
+/** A response/request body as bytes. The platform buffers it (the manifest's
+ * `Streaming` axis allows buffering) so a retried request can replay it. */
+export declare class Stream {
+    readonly data: Uint8Array;
+    constructor(data: Uint8Array);
+    /** An empty stream (e.g. an absent multipart file part). */
+    static empty(): Stream;
+}
+/** Options for a runtime `Client`. */
+export interface ClientOptions {
+    /** How many times a retriable failure is retried (default 5). */
+    maxRetries?: number;
+    /** Override individual base-URL classes (custom deployments). */
+    baseUrls?: Record<string, string>;
+}
+/** The runtime session: it holds the auth flow, base-URL configuration, and
+ * retry policy shared by every manager. */
+export declare class Client {
+    private readonly auth;
+    private readonly baseUrls;
+    private readonly maxRetries;
+    constructor(auth: Auth, options?: ClientOptions);
+    /** The configured base URL for a D-106 class, without a trailing slash. */
+    baseUrl(name: string): string;
+    /** A valid access token for the configured auth flow. The `signal` is
+     * accepted for contract symmetry; token acquisition is a shared refresh not
+     * bound to a single request's cancellation (mirroring the Rust runtime). */
+    accessToken(_signal?: AbortSignal): Promise<string>;
+    /** A request envelope for a method and fully built URL. */
+    newRequest(method: string, url: string): Request;
+    /** Execute the request with retries: exponential backoff + full jitter, a
+     * single force-refresh on 401, and Retry-After (as a floor) on 429/5xx.
+     *
+     * Retry policy follows idempotency: a 429 (rate-limited, never processed)
+     * retries for every method; a transport error or a 5xx may have already
+     * committed a write, so those retry only for idempotent methods
+     * (GET/HEAD/PUT/DELETE/…). The 401 refresh applies to every method. */
+    fetch(request: Request, signal?: AbortSignal): Promise<Response>;
+}
+/** Return the request with the header set. */
+export declare function withHeader(request: Request, name: string, value: string): Request;
+/** Return the request with the query parameter appended, encoded. */
+export declare function withQuery(request: Request, name: string, value: string): Request;
+/** Return the request with the serialized JSON body and content type set. */
+export declare function withJsonBody(request: Request, body: Uint8Array): Request;
+/** Return the request with an application/x-www-form-urlencoded body (the
+ * OAuth2 token endpoints). */
+export declare function withFormBody(request: Request, form: Uint8Array): Request;
+/** Return the request with a streaming body (buffered, so retries can replay
+ * it — the manifest's `Streaming` axis permits buffering). */
+export declare function withStreamBody(request: Request, body: Stream, contentType: string): Request;
+/** Return the request with a Box-style multipart body: an `attributes` JSON
+ * part plus a file part (G-7). */
+export declare function withMultipartBody(request: Request, attributes: Uint8Array, fileName: string, file: Stream): Request;
+/** Read the whole response body. */
+export declare function responseBytes(response: Response): Uint8Array;
+/** The response body as a stream, for binary downloads (FR-7.4). */
+export declare function responseStream(response: Response): Stream;
+/** A response header value, empty when absent (redirect Location, Retry-After
+ * surfacing). */
+export declare function responseHeader(response: Response, name: string): string;
+/** The response status code. */
+export declare function statusCode(response: Response): number;

package/dist/types/tokens.d.ts

@@ -0,0 +1,50 @@
+/** Box's OAuth 2.0 token endpoint, shared by every exchange flow. */
+export declare const DEFAULT_TOKEN_URL = "https://api.box.com/oauth2/token";
+/**
+ * Yields an access token for the configured auth flow. A token acquisition is
+ * not bound to any single request's cancellation — a shared refresh serves every
+ * concurrent caller — mirroring the Rust runtime, which drops the whole future
+ * rather than threading a per-request signal into token acquisition.
+ */
+export interface Auth {
+    /** A valid access token, refreshing through the cache as needed. */
+    accessToken(): Promise<string>;
+    /**
+     * Re-acquire a token after `stale` was rejected (a 401), bypassing the cache.
+     * If another caller already refreshed past `stale`, the newer token is
+     * returned without a network round-trip.
+     */
+    forceRefresh(stale: string): Promise<string>;
+}
+/** A normalized token exchange result. */
+export interface Token {
+    accessToken: string;
+    refreshToken: string;
+    ttlMs: number;
+}
+/**
+ * Caches an access token and refreshes it — via the flow-specific `refresh` —
+ * when it is missing or within the refresh margin of expiry. Concurrent callers
+ * during a refresh share one in-flight exchange (single-flight), so a token is
+ * never fetched twice at once, and the exchange is not tied to any one caller.
+ */
+export declare class CachedToken implements Auth {
+    private readonly refresh;
+    private token;
+    private expiry;
+    private inflight?;
+    constructor(refresh: () => Promise<Token>, seed?: Token);
+    accessToken(): Promise<string>;
+    forceRefresh(stale: string): Promise<string>;
+    /** Run the flow's refresh, sharing one in-flight exchange across callers. */
+    private refreshOnce;
+}
+/**
+ * POST a form-encoded grant to the token endpoint and normalize the response.
+ * A transport failure and a non-2xx body both surface as a `BoxApiError`, so
+ * token acquisition never escapes the runtime's error contract. The optional
+ * `signal` cancels an explicit caller-initiated exchange (`exchangeCode`); the
+ * cached flows do not thread one, so a shared refresh is never bound to a single
+ * request's cancellation.
+ */
+export declare function postTokenForm(tokenUrl: string, form: Record<string, string>, signal?: AbortSignal): Promise<Token>;

package/docs/README.md

@@ -0,0 +1,101 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# Box SDK reference
+
+One resource manager per Box API tag, reached through the single
+`Client` entry point.
+
+## Guides
+
+- [Authentication](auth.md)
+- [Pagination](pagination.md)
+- [Errors](errors.md)
+
+## Managers
+
+| Manager | Operations |
+|---|---|
+| [AiManager](managers/ai.md) | 5 |
+| [AiStudioManager](managers/ai_studio.md) | 5 |
+| [AppItemAssociationsManager](managers/app_item_associations.md) | 2 |
+| [ArchivesManager](managers/archives.md) | 4 |
+| [AuthorizationManager](managers/authorization.md) | 4 |
+| [AutomateWorkflowsManager](managers/automate_workflows.md) | 2 |
+| [AvatarsManager](managers/avatars.md) | 3 |
+| [ChunkedUploadsManager](managers/chunked_uploads.md) | 7 |
+| [ClassificationsManager](managers/classifications.md) | 4 |
+| [CollaborationAllowlistEntriesManager](managers/collaboration_allowlist_entries.md) | 4 |
+| [CollaborationAllowlistExemptTargetsManager](managers/collaboration_allowlist_exempt_targets.md) | 4 |
+| [CollectionsManager](managers/collections.md) | 3 |
+| [CommentsManager](managers/comments.md) | 5 |
+| [DevicePinnersManager](managers/device_pinners.md) | 3 |
+| [DocgenManager](managers/docgen.md) | 4 |
+| [DocgenTemplateManager](managers/docgen_template.md) | 6 |
+| [DownloadsManager](managers/downloads.md) | 1 |
+| [EmailAliasesManager](managers/email_aliases.md) | 3 |
+| [EnterpriseConfigurationsManager](managers/enterprise_configurations.md) | 1 |
+| [EventsManager](managers/events.md) | 2 |
+| [ExternalUsersManager](managers/external_users.md) | 1 |
+| [FileClassificationsManager](managers/file_classifications.md) | 4 |
+| [FileMetadataManager](managers/file_metadata.md) | 5 |
+| [FileRequestsManager](managers/file_requests.md) | 4 |
+| [FileVersionLegalHoldsManager](managers/file_version_legal_holds.md) | 2 |
+| [FileVersionRetentionsManager](managers/file_version_retentions.md) | 2 |
+| [FileVersionsManager](managers/file_versions.md) | 5 |
+| [FileWatermarksManager](managers/file_watermarks.md) | 3 |
+| [FilesManager](managers/files.md) | 5 |
+| [FolderClassificationsManager](managers/folder_classifications.md) | 4 |
+| [FolderLocksManager](managers/folder_locks.md) | 3 |
+| [FolderMetadataManager](managers/folder_metadata.md) | 5 |
+| [FolderWatermarksManager](managers/folder_watermarks.md) | 3 |
+| [FoldersManager](managers/folders.md) | 6 |
+| [GroupsManager](managers/groups.md) | 5 |
+| [HubCollaborationsManager](managers/hub_collaborations.md) | 5 |
+| [HubDocumentManager](managers/hub_document.md) | 2 |
+| [HubItemsManager](managers/hub_items.md) | 2 |
+| [HubsManager](managers/hubs.md) | 7 |
+| [IntegrationMappingsManager](managers/integration_mappings.md) | 8 |
+| [InvitesManager](managers/invites.md) | 2 |
+| [LegalHoldPoliciesManager](managers/legal_hold_policies.md) | 5 |
+| [LegalHoldPolicyAssignmentsManager](managers/legal_hold_policy_assignments.md) | 6 |
+| [ListCollaborationsManager](managers/list_collaborations.md) | 4 |
+| [MembershipsManager](managers/memberships.md) | 6 |
+| [MetadataCascadePoliciesManager](managers/metadata_cascade_policies.md) | 5 |
+| [MetadataTaxonomiesManager](managers/metadata_taxonomies.md) | 15 |
+| [MetadataTemplatesManager](managers/metadata_templates.md) | 8 |
+| [NotesManager](managers/notes.md) | 1 |
+| [RecentItemsManager](managers/recent_items.md) | 1 |
+| [RetentionPoliciesManager](managers/retention_policies.md) | 5 |
+| [RetentionPolicyAssignmentsManager](managers/retention_policy_assignments.md) | 6 |
+| [SearchManager](managers/search.md) | 2 |
+| [SessionTerminationManager](managers/session_termination.md) | 2 |
+| [SharedLinksAppItemsManager](managers/shared_links_app_items.md) | 1 |
+| [SharedLinksFilesManager](managers/shared_links_files.md) | 5 |
+| [SharedLinksFoldersManager](managers/shared_links_folders.md) | 5 |
+| [SharedLinksWebLinksManager](managers/shared_links_web_links.md) | 5 |
+| [ShieldInformationBarrierReportsManager](managers/shield_information_barrier_reports.md) | 3 |
+| [ShieldInformationBarrierSegmentMembersManager](managers/shield_information_barrier_segment_members.md) | 4 |
+| [ShieldInformationBarrierSegmentRestrictionsManager](managers/shield_information_barrier_segment_restrictions.md) | 4 |
+| [ShieldInformationBarrierSegmentsManager](managers/shield_information_barrier_segments.md) | 5 |
+| [ShieldInformationBarriersManager](managers/shield_information_barriers.md) | 4 |
+| [ShieldListsManager](managers/shield_lists.md) | 5 |
+| [SignRequestsManager](managers/sign_requests.md) | 5 |
+| [SignTemplatesManager](managers/sign_templates.md) | 2 |
+| [SkillsManager](managers/skills.md) | 5 |
+| [StoragePoliciesManager](managers/storage_policies.md) | 2 |
+| [StoragePolicyAssignmentsManager](managers/storage_policy_assignments.md) | 5 |
+| [TaskAssignmentsManager](managers/task_assignments.md) | 5 |
+| [TasksManager](managers/tasks.md) | 5 |
+| [TermsOfServiceUserStatusesManager](managers/terms_of_service_user_statuses.md) | 3 |
+| [TermsOfServicesManager](managers/terms_of_services.md) | 4 |
+| [TransferManager](managers/transfer.md) | 1 |
+| [TrashedFilesManager](managers/trashed_files.md) | 3 |
+| [TrashedFoldersManager](managers/trashed_folders.md) | 3 |
+| [TrashedItemsManager](managers/trashed_items.md) | 1 |
+| [TrashedWebLinksManager](managers/trashed_web_links.md) | 3 |
+| [UploadsManager](managers/uploads.md) | 3 |
+| [UserCollaborationsManager](managers/user_collaborations.md) | 4 |
+| [UsersManager](managers/users.md) | 6 |
+| [WebLinksManager](managers/web_links.md) | 4 |
+| [WebhooksManager](managers/webhooks.md) | 5 |
+| [WorkflowsManager](managers/workflows.md) | 2 |
+| [ZipDownloadsManager](managers/zip_downloads.md) | 3 |

package/docs/auth.md

@@ -0,0 +1,60 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# Authentication
+
+Build a `Client` from one of the four Box auth flows. Each flow is an `Auth`
+the runtime uses to fetch a bearer token; the network layer refreshes on a
+`401` and retries once. The flow builders live in the runtime package and are
+passed straight to `new Client(...)`.
+
+## Developer Token
+
+A fixed token from the Developer Console, for quick local testing:
+
+```ts
+import { developerToken } from 'box-gantry-runtime';
+const client = new Client(developerToken('DEVELOPER_TOKEN'));
+```
+
+## Client Credentials Grant (server auth, no key)
+
+Set exactly one subject — `enterpriseId` for the service account, or `userId`
+to act as a managed user:
+
+```ts
+import { clientCredentials } from 'box-gantry-runtime';
+const client = new Client(clientCredentials({
+clientId: 'CLIENT_ID',
+clientSecret: 'CLIENT_SECRET',
+enterpriseId: 'ENTERPRISE_ID',
+}));
+```
+
+## JWT (server auth with a signing key)
+
+Parses (and if needed decrypts) the RSA key up front, so a bad key fails
+loudly at construction. It reaches `node:crypto`, so it is a Node-only leaf
+imported from the runtime's `./jwt` entry point and returns a promise:
+
+```ts
+import { jwtAuth } from 'box-gantry-runtime/jwt';
+const auth = await jwtAuth({
+clientId: 'CLIENT_ID',
+clientSecret: 'CLIENT_SECRET',
+publicKeyId: 'PUBLIC_KEY_ID',
+privateKeyPem: privateKeyPem, // optionally encrypted; set passphrase
+enterpriseId: 'ENTERPRISE_ID',
+});
+const client = new Client(auth);
+```
+
+## OAuth 2.0 (authorization code)
+
+Redirect the user to the authorize URL, exchange the returned code, then reuse
+the rotated refresh token on later runs (persist it via `onRefresh`):
+
+```ts
+import { oauth } from 'box-gantry-runtime';
+// later runs: resume from the stored refresh token.
+const auth = oauth({ clientId: 'CLIENT_ID', clientSecret: 'CLIENT_SECRET' }, storedRefreshToken);
+const client = new Client(auth);
+```

package/docs/errors.md

@@ -0,0 +1,20 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# Errors
+
+Methods are `async` and surface failure by throwing — the return type only
+describes the success value. A thrown `BoxApiError` is either a transport
+failure or a non-2xx response after the network layer's retries (exponential
+backoff + jitter, `401` refresh, `Retry-After`). It carries the HTTP `status`
+when the failure came with a response, and the underlying `cause` for
+transport or decode failures:
+
+```ts
+import { BoxApiError } from 'box-gantry-runtime';
+try {
+await client.files.getFileById(fileId);
+} catch (err) {
+if (err instanceof BoxApiError) {
+// err.status (number | undefined), err.cause
+}
+}
+```

package/docs/managers/ai.md

@@ -0,0 +1,49 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# AiManager
+
+Reach these methods through the `ai` field on `Client`.
+
+## ask
+
+`POST /ai/ask`
+
+**Request body** (`application/json`): `AiAsk`
+
+**Returns:** `AiResponseFull`
+
+## createTextGen
+
+`POST /ai/text_gen`
+
+**Request body** (`application/json`): `AiTextGen`
+
+**Returns:** `AiResponse`
+
+## getAgentDefault
+
+`GET /ai_agent_default`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `mode` | query | `GetAgentDefaultMode` | yes |
+| `language` | query | `string` | no |
+| `model` | query | `string` | no |
+
+**Returns:** `AiAgent`
+
+## extract
+
+`POST /ai/extract`
+
+**Request body** (`application/json`): `AiExtract`
+
+**Returns:** `AiResponse`
+
+## createExtractStructured
+
+`POST /ai/extract_structured`
+
+**Request body** (`application/json`): `AiExtractStructured`
+
+**Returns:** `AiExtractStructuredResponse`
+

package/docs/managers/ai_studio.md

@@ -0,0 +1,63 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# AiStudioManager
+
+Reach these methods through the `aiStudio` field on `Client`.
+
+## listAiAgents
+
+`GET /ai_agents`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `mode` | query | `Array<string>` | no |
+| `fields` | query | `Array<string>` | no |
+| `agent_state` | query | `Array<string>` | no |
+| `include_box_default` | query | `boolean` | no |
+| `marker` | query | `string` | no |
+| `limit` | query | `number` | no |
+
+**Returns:** `AiMultipleAgentResponse`
+
+Paginated — `listAiAgents(...)` 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).
+
+## createAiAgents
+
+`POST /ai_agents`
+
+**Request body** (`application/json`): `CreateAiAgent`
+
+**Returns:** `AiSingleAgentResponseFull`
+
+## getAiAgent
+
+`GET /ai_agents/{agent_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `agent_id` | path | `string` | yes |
+| `fields` | query | `Array<string>` | no |
+
+**Returns:** `AiSingleAgentResponseFull`
+
+## updateAiAgent
+
+`PUT /ai_agents/{agent_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `agent_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `CreateAiAgent`
+
+**Returns:** `AiSingleAgentResponseFull`
+
+## deleteAiAgent
+
+`DELETE /ai_agents/{agent_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `agent_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/app_item_associations.md

@@ -0,0 +1,35 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# AppItemAssociationsManager
+
+Reach these methods through the `appItemAssociations` field on `Client`.
+
+## listFile
+
+`GET /files/{file_id}/app_item_associations`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `file_id` | path | `string` | yes |
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+| `application_type` | query | `string` | no |
+
+**Returns:** `AppItemAssociations`
+
+Paginated — `listFile(...)` 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).
+
+## listFolder
+
+`GET /folders/{folder_id}/app_item_associations`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | path | `string` | yes |
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+| `application_type` | query | `string` | no |
+
+**Returns:** `AppItemAssociations`
+
+Paginated — `listFolder(...)` 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).
+

package/docs/managers/archives.md

@@ -0,0 +1,48 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# ArchivesManager
+
+Reach these methods through the `archives` field on `Client`.
+
+## list
+
+`GET /archives`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+
+**Returns:** `Archives`
+
+Paginated — `list(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## create
+
+`POST /archives`
+
+**Request body** (`application/json`): `ArchiveCreateRequest`
+
+**Returns:** `Archive`
+
+## update
+
+`PUT /archives/{archive_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `archive_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `ArchiveUpdateRequest`
+
+**Returns:** `Archive`
+
+## delete_
+
+`DELETE /archives/{archive_id}`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `archive_id` | path | `string` | yes |
+
+**Returns:** `void`
+

package/docs/managers/authorization.md

@@ -0,0 +1,43 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# AuthorizationManager
+
+Reach these methods through the `authorization` field on `Client`.
+
+## authorize
+
+`GET /authorize`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `response_type` | query | `GetAuthorizeResponseType` | yes |
+| `client_id` | query | `string` | yes |
+| `redirect_uri` | query | `string` | no |
+| `state` | query | `string` | no |
+| `scope` | query | `string` | no |
+
+**Returns:** text (`string`)
+
+## createOauth2Token
+
+`POST /oauth2/token`
+
+**Request body** (`application/x-www-form-urlencoded`): `PostOAuth2Token`
+
+**Returns:** `AccessToken`
+
+## createOauth2TokenRefresh
+
+`POST /oauth2/token`
+
+**Request body** (`application/x-www-form-urlencoded`): `PostOAuth2TokenRefreshAccessToken`
+
+**Returns:** `AccessToken`
+
+## revokeOauth2
+
+`POST /oauth2/revoke`
+
+**Request body** (`application/x-www-form-urlencoded`): `PostOAuth2Revoke`
+
+**Returns:** `void`
+

package/docs/managers/automate_workflows.md

@@ -0,0 +1,31 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# AutomateWorkflowsManager
+
+Reach these methods through the `automateWorkflows` field on `Client`.
+
+## list
+
+`GET /automate_workflows`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `folder_id` | query | `string` | yes |
+| `limit` | query | `number` | no |
+| `marker` | query | `string` | no |
+
+**Returns:** `AutomateWorkflows`
+
+Paginated — `list(...)` is an async iterable that yields each entry across pages (`for await (const item of ...)`), threading the cursor for you. See the [pagination guide](../pagination.md).
+
+## start
+
+`POST /automate_workflows/{workflow_id}/start`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `workflow_id` | path | `string` | yes |
+
+**Request body** (`application/json`): `AutomateWorkflowStartRequest`
+
+**Returns:** `void`
+

package/docs/managers/avatars.md

@@ -0,0 +1,37 @@
+<!-- Generated by box-gantry. DO NOT EDIT. -->
+# AvatarsManager
+
+Reach these methods through the `avatars` field on `Client`.
+
+## getUserAvatar
+
+`GET /users/{user_id}/avatar`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+
+**Returns:** a binary stream (`runtime.Stream`)
+
+## createUserAvatar
+
+`POST /users/{user_id}/avatar`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+
+**Request body** (`multipart/form-data`): `UserAvatarCreateRequest`
+
+**Returns:** `UserAvatar`
+
+## deleteUserAvatar
+
+`DELETE /users/{user_id}/avatar`
+
+| Parameter | In | Type | Required |
+|---|---|---|---|
+| `user_id` | path | `string` | yes |
+
+**Returns:** `void`
+