@blazingagents/sdk 0.20.0 → 0.21.0

package/dist/resources/merchant-connection.js

@@ -4,18 +4,32 @@ import { requestJson } from "../http.js";
  * `client.merchantConnection` — get/create/update/retire over
  * `/v1/merchant-connection`. One connection per tenant; `credential` is
  * write-only and never returned.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export function createMerchantConnectionResource(config) {
     return {
+        /**
+         * Retrieves merchant connection.
+         */
         async get({ abortSignal } = {}) {
             return await requestJson(config, "/v1/merchant-connection", { signal: abortSignal }, merchantConnectionResponseSchema);
         },
+        /**
+         * Creates merchant connection.
+         */
         async create({ abortSignal, ...body }) {
             return await requestJson(config, "/v1/merchant-connection", { json: body, method: "POST", signal: abortSignal }, merchantConnectionResponseSchema);
         },
+        /**
+         * Updates merchant connection.
+         */
         async update({ abortSignal, ...body }) {
             return await requestJson(config, "/v1/merchant-connection", { json: body, method: "PATCH", signal: abortSignal }, merchantConnectionResponseSchema);
         },
+        /**
+         * Retires merchant connection.
+         */
         async retire({ abortSignal } = {}) {
             await requestJson(config, "/v1/merchant-connection", {
                 method: "DELETE",

package/dist/resources/merchant-usage-events.d.ts

@@ -3,5 +3,7 @@ import type { HttpConfig, MerchantUsageEventsResource } from "../types.ts";
  * `client.merchantUsageEvents` — the immutable usage-event ledger over
  * `/v1/merchant-usage-events`, plus the delivery-health `summary` aggregate
  * and the per-event operator actions `retry`/`release`/`discard`.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export declare function createMerchantUsageEventsResource(config: HttpConfig): MerchantUsageEventsResource;

package/dist/resources/merchant-usage-events.js

@@ -4,24 +4,44 @@ import { requestJson } from "../http.js";
  * `client.merchantUsageEvents` — the immutable usage-event ledger over
  * `/v1/merchant-usage-events`, plus the delivery-health `summary` aggregate
  * and the per-event operator actions `retry`/`release`/`discard`.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export function createMerchantUsageEventsResource(config) {
     return {
+        /**
+         * Lists one page of merchant usage events.
+         */
         async list({ abortSignal, ...query } = {}) {
             return await requestJson(config, "/v1/merchant-usage-events", { query, signal: abortSignal }, merchantUsageEventsResponseSchema);
         },
+        /**
+         * Retrieves merchant usage events.
+         */
         async get({ eventId, abortSignal }) {
             return await requestJson(config, `/v1/merchant-usage-events/${encodeURIComponent(eventId)}`, { signal: abortSignal }, merchantUsageEventResponseSchema);
         },
+        /**
+         * Retrieves merchant usage delivery totals for the selected day range.
+         */
         async summary({ abortSignal, ...query } = {}) {
             return await requestJson(config, "/v1/merchant-usage-events/summary", { query, signal: abortSignal }, merchantUsageSummaryResponseSchema);
         },
+        /**
+         * Retries delivery of merchant usage events.
+         */
         async retry({ eventId, abortSignal }) {
             return await requestJson(config, `/v1/merchant-usage-events/${encodeURIComponent(eventId)}/retry`, { method: "POST", signal: abortSignal }, merchantUsageEventResponseSchema);
         },
+        /**
+         * Releases merchant usage events.
+         */
         async release({ eventId, abortSignal }) {
             return await requestJson(config, `/v1/merchant-usage-events/${encodeURIComponent(eventId)}/release`, { method: "POST", signal: abortSignal }, merchantUsageEventResponseSchema);
         },
+        /**
+         * Discards merchant usage events.
+         */
         async discard({ eventId, abortSignal }) {
             return await requestJson(config, `/v1/merchant-usage-events/${encodeURIComponent(eventId)}/discard`, { method: "POST", signal: abortSignal }, merchantUsageEventResponseSchema);
         },

package/dist/resources/prompts.d.ts

@@ -1,2 +1,7 @@
 import type { HttpConfig, PromptsResource } from "../types.ts";
+/**
+ * Builds the Prompts operations using the shared HTTP configuration.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
+ */
 export declare function createPromptsResource(config: HttpConfig): PromptsResource;

package/dist/resources/prompts.js

@@ -1,7 +1,15 @@
 import { promptResponseSchema, promptsResponseSchema, } from "../contracts/entities/prompts.js";
 import { requestJson } from "../http.js";
+/**
+ * Builds the Prompts operations using the shared HTTP configuration.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
+ */
 export function createPromptsResource(config) {
     return {
+        /**
+         * Creates prompts.
+         */
         async create({ abortSignal, ...body }) {
             return await requestJson(config, "/v1/prompts", {
                 json: body,
@@ -9,15 +17,24 @@ export function createPromptsResource(config) {
                 method: "POST",
             }, promptResponseSchema);
         },
+        /**
+         * Lists one page of prompts.
+         */
         async list({ userId, agentId, cursor, limit, abortSignal } = {}) {
             return await requestJson(config, "/v1/prompts", {
                 signal: abortSignal,
                 query: { userId, agentId, cursor, limit },
             }, promptsResponseSchema);
         },
+        /**
+         * Retrieves prompts.
+         */
         async get({ promptId, abortSignal }) {
             return await requestJson(config, `/v1/prompts/${promptId}`, { signal: abortSignal }, promptResponseSchema);
         },
+        /**
+         * Updates prompts.
+         */
         async update({ promptId, abortSignal, ...body }) {
             return await requestJson(config, `/v1/prompts/${promptId}`, {
                 json: body,
@@ -25,6 +42,9 @@ export function createPromptsResource(config) {
                 method: "PATCH",
             }, promptResponseSchema);
         },
+        /**
+         * Deletes prompts.
+         */
         async delete({ promptId, abortSignal }) {
             await requestJson(config, `/v1/prompts/${promptId}`, {
                 method: "DELETE",

package/dist/resources/providers.d.ts

@@ -1,5 +1,7 @@
 import type { HttpConfig, ProvidersResource } from "../types.ts";
 /**
  * `client.providers` — CRUD and cost-free model discovery.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export declare function createProvidersResource(config: HttpConfig): ProvidersResource;

package/dist/resources/providers.js

@@ -2,9 +2,14 @@ import { providerModelsResponseSchema, providerResponseSchema, providersResponse
 import { requestJson } from "../http.js";
 /**
  * `client.providers` — CRUD and cost-free model discovery.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export function createProvidersResource(config) {
     return {
+        /**
+         * Creates providers.
+         */
         async create({ abortSignal, ...body }) {
             return await requestJson(config, "/v1/providers", {
                 json: body,
@@ -12,18 +17,33 @@ export function createProvidersResource(config) {
                 method: "POST",
             }, providerResponseSchema);
         },
+        /**
+         * Lists one page of providers.
+         */
         async list({ abortSignal } = {}) {
             return await requestJson(config, "/v1/providers", { signal: abortSignal }, providersResponseSchema);
         },
+        /**
+         * Retrieves providers.
+         */
         async get({ providerId, abortSignal }) {
             return await requestJson(config, `/v1/providers/${providerId}`, { signal: abortSignal }, providerResponseSchema);
         },
+        /**
+         * Lists models exposed by the Provider.
+         */
         async listModels({ providerId, abortSignal }) {
             return await requestJson(config, `/v1/providers/${providerId}/models`, { signal: abortSignal }, providerModelsResponseSchema);
         },
+        /**
+         * Retrieves supported thinking levels for a Provider model.
+         */
         async getThinkingLevels({ providerId, model, abortSignal }) {
             return await requestJson(config, `/v1/providers/${providerId}/thinking-levels`, { signal: abortSignal, query: { model } }, thinkingLevelsResponseSchema);
         },
+        /**
+         * Updates providers.
+         */
         async update({ providerId, abortSignal, ...body }) {
             return await requestJson(config, `/v1/providers/${providerId}`, {
                 json: body,
@@ -31,6 +51,9 @@ export function createProvidersResource(config) {
                 method: "PATCH",
             }, providerResponseSchema);
         },
+        /**
+         * Deletes providers.
+         */
         async delete({ providerId, abortSignal, ...options }) {
             await requestJson(config, `/v1/providers/${providerId}`, {
                 method: "DELETE",

package/dist/resources/sessions.d.ts

@@ -4,5 +4,7 @@ import type { HttpConfig, SessionsResource } from "../types.ts";
  * `/v1/agents/:agentId/sessions`. Pagination is manual: the SDK returns
  * the page as-is (`{ data, nextCursor }` verbatim); the caller passes
  * `nextCursor` back as `cursor` on the next call.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export declare function createSessionsResource(config: HttpConfig): SessionsResource;

package/dist/resources/sessions.js

@@ -7,15 +7,26 @@ import { requestJson } from "../http.js";
  * `/v1/agents/:agentId/sessions`. Pagination is manual: the SDK returns
  * the page as-is (`{ data, nextCursor }` verbatim); the caller passes
  * `nextCursor` back as `cursor` on the next call.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export function createSessionsResource(config) {
     return {
+        /**
+         * Submits a Session input. Reuse the request ID and payload after an uncertain acknowledgement.
+         */
         async submitInput({ agentId, sessionId, abortSignal, ...body }) {
             return await requestJson(config, `/v1/agents/${agentIdSchema.parse(agentId)}/sessions/${sessionIdSchema.parse(sessionId)}/inputs`, { method: "POST", json: body, signal: abortSignal }, sessionInputResponseSchema);
         },
+        /**
+         * Lists input receipts. Poll the first page to observe state changes.
+         */
         async inputs({ agentId, sessionId, abortSignal, ...query }) {
             return await requestJson(config, `/v1/agents/${agentIdSchema.parse(agentId)}/sessions/${sessionIdSchema.parse(sessionId)}/inputs`, { query, signal: abortSignal }, sessionInputsResponseSchema);
         },
+        /**
+         * Records cancellation for the named Turn without waiting for settlement.
+         */
         async stop({ agentId, sessionId, turnId, abortSignal }) {
             return await requestJson(config, `/v1/agents/${agentIdSchema.parse(agentId)}/sessions/${sessionIdSchema.parse(sessionId)}/stop`, {
                 method: "POST",
@@ -23,9 +34,26 @@ export function createSessionsResource(config) {
                 signal: abortSignal,
             }, stopSessionResponseSchema);
         },
+        /**
+         * Forks a Session at a message. Reuse the idempotency key after an uncertain acknowledgement.
+         */
+        async fork({ agentId, sessionId, messageId, idempotencyKey, abortSignal }) {
+            return await requestJson(config, `/v1/agents/${agentIdSchema.parse(agentId)}/sessions/${sessionIdSchema.parse(sessionId)}/fork`, {
+                method: "POST",
+                json: { messageId },
+                headers: { "Idempotency-Key": idempotencyKey },
+                signal: abortSignal,
+            }, sessionResponseSchema);
+        },
+        /**
+         * Retrieves sessions.
+         */
         async get({ agentId, sessionId, abortSignal }) {
             return await requestJson(config, `/v1/agents/${agentId}/sessions/${sessionId}`, { signal: abortSignal }, sessionResponseSchema);
         },
+        /**
+         * Lists one page of sessions.
+         */
         async list({ agentId, ...options }) {
             return await requestJson(config, `/v1/agents/${agentId}/sessions`, {
                 signal: options.abortSignal,
@@ -37,6 +65,9 @@ export function createSessionsResource(config) {
                 },
             }, sessionsListResponseSchema);
         },
+        /**
+         * Lists recently updated Sessions, optionally limited to one per Agent.
+         */
         async listLatest(options = {}) {
             return await requestJson(config, "/v1/sessions/latest", {
                 signal: options.abortSignal,
@@ -51,6 +82,9 @@ export function createSessionsResource(config) {
                 },
             }, latestSessionsListResponseSchema);
         },
+        /**
+         * Lists one page of Session messages.
+         */
         async messages({ agentId, sessionId, ...options }) {
             return await requestJson(config, `/v1/agents/${agentId}/sessions/${sessionId}/messages`, {
                 signal: options.abortSignal,
@@ -61,9 +95,15 @@ export function createSessionsResource(config) {
                 },
             }, sessionMessagesResponseSchema);
         },
+        /**
+         * Retrieves the pending Tool approval round.
+         */
         async toolApprovals({ agentId, sessionId, abortSignal }) {
             return await requestJson(config, `/v1/agents/${agentId}/sessions/${sessionId}/tool-approvals`, { signal: abortSignal }, toolApprovalsResponseSchema);
         },
+        /**
+         * Deletes sessions.
+         */
         async delete({ agentId, sessionId, deleteArtifacts, abortSignal }) {
             await requestJson(config, `/v1/agents/${agentId}/sessions/${sessionId}`, { method: "DELETE", query: { deleteArtifacts }, signal: abortSignal });
         },

package/dist/resources/skills.d.ts

@@ -1,2 +1,7 @@
 import type { AgentSkillsResource, HttpConfig } from "../types.ts";
+/**
+ * Builds the Agent Skills operations using the shared HTTP configuration.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
+ */
 export declare function createAgentSkillsResource(config: HttpConfig, agentId: string): AgentSkillsResource;

package/dist/resources/skills.js

@@ -1,28 +1,54 @@
 import { skillCopyResultsSchema, skillDetailSchema, skillsListResponseSchema, } from "../contracts/entities/skills.js";
 import { isRequestAborted, requestAbortedError, requestJson, requestStream, } from "../http.js";
+/**
+ * Builds a Skill file URL with encoded Agent, Skill, and file path values.
+ */
 function fileUrl(agentId, input) {
     return `/v1/agents/${encodeURIComponent(agentId)}/skills/${encodeURIComponent(input.skillId)}/files?path=${encodeURIComponent(input.path)}`;
 }
+/**
+ * Builds the Agent Skills operations using the shared HTTP configuration.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
+ */
 export function createAgentSkillsResource(config, agentId) {
     return {
+        /**
+         * Copies skills.
+         */
         async copy({ skillId, to, abortSignal }) {
             return await requestJson(config, `/v1/agents/${encodeURIComponent(agentId)}/skills/${encodeURIComponent(skillId)}/copies`, { json: to, method: "POST", signal: abortSignal }, skillCopyResultsSchema);
         },
+        /**
+         * Creates skills.
+         */
         async create({ abortSignal, ...body }) {
             return await requestJson(config, `/v1/agents/${encodeURIComponent(agentId)}/skills`, { json: body, method: "POST", signal: abortSignal }, skillDetailSchema);
         },
+        /**
+         * Deletes skills.
+         */
         async delete({ skillId, abortSignal }) {
             await requestJson(config, `/v1/agents/${encodeURIComponent(agentId)}/skills/${encodeURIComponent(skillId)}`, { method: "DELETE", signal: abortSignal });
         },
+        /**
+         * Deletes a Skill file.
+         */
         async deleteFile({ abortSignal, ...input }) {
             return await requestJson(config, fileUrl(agentId, input), {
                 method: "DELETE",
                 signal: abortSignal,
             }, skillDetailSchema);
         },
+        /**
+         * Retrieves skills.
+         */
         async get({ skillId, abortSignal }) {
             return await requestJson(config, `/v1/agents/${encodeURIComponent(agentId)}/skills/${encodeURIComponent(skillId)}`, { signal: abortSignal }, skillDetailSchema);
         },
+        /**
+         * Reads Skill file bytes.
+         */
         async getFile({ abortSignal, ...input }) {
             const response = await requestStream(config, fileUrl(agentId, input), {
                 signal: abortSignal,
@@ -37,9 +63,15 @@ export function createAgentSkillsResource(config, agentId) {
                 throw cause;
             }
         },
+        /**
+         * Lists one page of skills.
+         */
         async list({ cursor, limit, abortSignal } = {}) {
             return await requestJson(config, `/v1/agents/${encodeURIComponent(agentId)}/skills`, { signal: abortSignal, query: { cursor, limit } }, skillsListResponseSchema);
         },
+        /**
+         * Replaces a Skill file with the supplied content.
+         */
         async putFile({ content, abortSignal, ...input }) {
             return await requestJson(config, fileUrl(agentId, input), {
                 body: content,
@@ -47,6 +79,9 @@ export function createAgentSkillsResource(config, agentId) {
                 signal: abortSignal,
             }, skillDetailSchema);
         },
+        /**
+         * Uploads a Skill archive as multipart form data.
+         */
         async upload({ source, abortSignal }) {
             const form = new FormData();
             form.set("type", source.type);

package/dist/resources/tasks.d.ts

@@ -3,5 +3,7 @@ import type { HttpConfig, TasksResource } from "../types.ts";
  * `client.tasks` — CRUD + runs over `/v1/tasks`. Runs are listed/get/
  * canceled/transcripted via `/v1/tasks/:taskId/runs/...`. All lists are
  * keyset-cursored.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export declare function createTasksResource(config: HttpConfig): TasksResource;

package/dist/resources/tasks.js

@@ -4,9 +4,14 @@ import { requestJson } from "../http.js";
  * `client.tasks` — CRUD + runs over `/v1/tasks`. Runs are listed/get/
  * canceled/transcripted via `/v1/tasks/:taskId/runs/...`. All lists are
  * keyset-cursored.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export function createTasksResource(config) {
     return {
+        /**
+         * Creates tasks.
+         */
         async create({ abortSignal, ...body }) {
             return await requestJson(config, "/v1/tasks", {
                 json: body,
@@ -14,6 +19,9 @@ export function createTasksResource(config) {
                 method: "POST",
             }, createTaskResponseSchema);
         },
+        /**
+         * Lists one page of tasks.
+         */
         async list(options = {}) {
             return await requestJson(config, "/v1/tasks", {
                 signal: options.abortSignal,
@@ -26,9 +34,15 @@ export function createTasksResource(config) {
                 },
             }, tasksListResponseSchema);
         },
+        /**
+         * Retrieves tasks.
+         */
         async get({ taskId, abortSignal }) {
             return await requestJson(config, `/v1/tasks/${taskId}`, { signal: abortSignal }, taskResponseSchema);
         },
+        /**
+         * Updates tasks.
+         */
         async update({ taskId, abortSignal, ...body }) {
             return await requestJson(config, `/v1/tasks/${taskId}`, {
                 json: body,
@@ -36,24 +50,39 @@ export function createTasksResource(config) {
                 method: "PATCH",
             }, taskResponseSchema);
         },
+        /**
+         * Deletes tasks.
+         */
         async delete({ taskId, abortSignal }) {
             await requestJson(config, `/v1/tasks/${taskId}`, {
                 method: "DELETE",
                 signal: abortSignal,
             });
         },
+        /**
+         * Creates a Task run.
+         */
         async createRun({ taskId, abortSignal, ...body }) {
             return await requestJson(config, `/v1/tasks/${taskId}/runs`, { json: body, method: "POST", signal: abortSignal }, createTaskRunResponseSchema);
         },
+        /**
+         * Lists one page of Task runs.
+         */
         async listRuns({ taskId, ...options }) {
             return await requestJson(config, `/v1/tasks/${taskId}/runs`, {
                 signal: options.abortSignal,
                 query: { cursor: options.cursor, limit: options.limit },
             }, taskRunsListResponseSchema);
         },
+        /**
+         * Retrieves a Task run.
+         */
         async getRun({ taskId, runId, abortSignal }) {
             return await requestJson(config, `/v1/tasks/${taskId}/runs/${runId}`, { signal: abortSignal }, taskRunResponseSchema);
         },
+        /**
+         * Lists one page of Task run messages.
+         */
         async runMessages({ taskId, runId, ...options }) {
             return await requestJson(config, `/v1/tasks/${taskId}/runs/${runId}/messages`, {
                 signal: options.abortSignal,
@@ -64,6 +93,9 @@ export function createTasksResource(config) {
                 },
             }, taskRunMessagesResponseSchema);
         },
+        /**
+         * Requests cancellation of a Task run.
+         */
         async cancelRun({ taskId, runId, abortSignal }) {
             await requestJson(config, `/v1/tasks/${taskId}/runs/${runId}/cancel`, { method: "POST", signal: abortSignal });
         },

package/dist/resources/tenant.d.ts

@@ -2,5 +2,7 @@ import type { HttpConfig, TenantResource } from "../types.ts";
 /**
  * `client.tenant` — get/patch over `/v1/tenant` (the tenant's self-set
  * quota row). `quota: null` means unlimited (no row).
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export declare function createTenantResource(config: HttpConfig): TenantResource;

package/dist/resources/tenant.js

@@ -3,12 +3,20 @@ import { requestJson } from "../http.js";
 /**
  * `client.tenant` — get/patch over `/v1/tenant` (the tenant's self-set
  * quota row). `quota: null` means unlimited (no row).
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export function createTenantResource(config) {
     return {
+        /**
+         * Retrieves tenant.
+         */
         async get({ abortSignal } = {}) {
             return await requestJson(config, "/v1/tenant", { signal: abortSignal }, tenantSettingsResponseSchema);
         },
+        /**
+         * Updates tenant.
+         */
         async patch({ abortSignal, ...body }) {
             return await requestJson(config, "/v1/tenant", {
                 json: body,

package/dist/resources/usage.d.ts

@@ -3,5 +3,7 @@ import type { HttpConfig, UsageResource } from "../types.ts";
  * `client.usage` — get over `/v1/usage` (tenant-wide) and
  * `/v1/agents/:agentId/usage` (per-agent). The query shape is the core
  * `usageQuerySchema`; the SDK passes it through as query params.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export declare function createUsageResource(config: HttpConfig): UsageResource;

package/dist/resources/usage.js

@@ -4,9 +4,14 @@ import { requestJson } from "../http.js";
  * `client.usage` — get over `/v1/usage` (tenant-wide) and
  * `/v1/agents/:agentId/usage` (per-agent). The query shape is the core
  * `usageQuerySchema`; the SDK passes it through as query params.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
  */
 export function createUsageResource(config) {
     return {
+        /**
+         * Retrieves usage grouped by Session.
+         */
         async sessions({ abortSignal, ...input }) {
             const body = sessionUsageQuerySchema.parse(input);
             return await requestJson(config, "/v1/usage/sessions", {
@@ -15,15 +20,24 @@ export function createUsageResource(config) {
                 signal: abortSignal,
             }, sessionUsageResponseSchema);
         },
+        /**
+         * Retrieves usage.
+         */
         async get({ abortSignal, ...query } = {}) {
             return await requestJson(config, "/v1/usage", {
                 query,
                 signal: abortSignal,
             }, usageResponseSchema);
         },
+        /**
+         * Retrieves usage for one Agent.
+         */
         async getForAgent({ agentId, abortSignal, ...query }) {
             return await requestJson(config, `/v1/agents/${agentId}/usage`, { query, signal: abortSignal }, usageResponseSchema);
         },
+        /**
+         * Retrieves usage totals, daily usage, and bounded rankings.
+         */
         async overview({ abortSignal, ...query } = {}) {
             return await requestJson(config, "/v1/usage/overview", { query, signal: abortSignal }, usageOverviewResponseSchemaForQuery(query));
         },

package/dist/resources/workspaces.d.ts

@@ -1,2 +1,7 @@
 import type { HttpConfig, WorkspacesResource } from "../types.ts";
+/**
+ * Builds the Workspaces operations using the shared HTTP configuration.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
+ */
 export declare function createWorkspacesResource(config: HttpConfig): WorkspacesResource;

package/dist/resources/workspaces.js

@@ -1,7 +1,15 @@
 import { workspaceSchema, workspacesListResponseSchema, } from "../contracts/entities/workspaces.js";
 import { requestJson, requestStream } from "../http.js";
+/**
+ * Builds the Workspaces operations using the shared HTTP configuration.
+ * @param config - Shared authentication and transport configuration.
+ * @returns The configured resource client.
+ */
 export function createWorkspacesResource(config) {
     return {
+        /**
+         * Creates workspaces.
+         */
         async create({ abortSignal, ...body } = {}) {
             return await requestJson(config, "/v1/workspaces", {
                 json: body,
@@ -9,13 +17,22 @@ export function createWorkspacesResource(config) {
                 method: "POST",
             }, workspaceSchema);
         },
+        /**
+         * Deletes workspaces.
+         */
         async delete({ workspaceId, abortSignal }) {
             const response = await requestStream(config, `/v1/workspaces/${encodeURIComponent(workspaceId)}`, { method: "DELETE", signal: abortSignal });
             return response.status === 202 ? "pending" : "completed";
         },
+        /**
+         * Retrieves workspaces.
+         */
         async get({ workspaceId, abortSignal }) {
             return await requestJson(config, `/v1/workspaces/${encodeURIComponent(workspaceId)}`, { signal: abortSignal }, workspaceSchema);
         },
+        /**
+         * Lists one page of workspaces.
+         */
         async list({ abortSignal, ...options } = {}) {
             return await requestJson(config, "/v1/workspaces", {
                 signal: abortSignal,
@@ -26,6 +43,9 @@ export function createWorkspacesResource(config) {
                 },
             }, workspacesListResponseSchema);
         },
+        /**
+         * Updates workspaces.
+         */
         async update({ workspaceId, abortSignal, ...body }) {
             return await requestJson(config, `/v1/workspaces/${encodeURIComponent(workspaceId)}`, { json: body, signal: abortSignal, method: "PUT" }, workspaceSchema);
         },