oz-agent-sdk 1.0.0-alpha.7

package/src/resources/agent/schedules.ts

@@ -0,0 +1,305 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AgentAPI from './agent';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Schedules extends APIResource {
+  /**
+   * Create a new scheduled agent that runs on a cron schedule. The agent will be
+   * triggered automatically based on the cron expression.
+   *
+   * @example
+   * ```ts
+   * const scheduledAgentItem =
+   *   await client.agent.schedules.create({
+   *     cron_schedule: '0 9 * * *',
+   *     name: 'Daily Code Review',
+   *     prompt:
+   *       'Review open pull requests and provide feedback',
+   *     enabled: true,
+   *   });
+   * ```
+   */
+  create(body: ScheduleCreateParams, options?: RequestOptions): APIPromise<ScheduledAgentItem> {
+    return this._client.post('/agent/schedules', { body, ...options });
+  }
+
+  /**
+   * Retrieve detailed information about a specific scheduled agent, including its
+   * configuration, history, and next scheduled run time.
+   *
+   * @example
+   * ```ts
+   * const scheduledAgentItem =
+   *   await client.agent.schedules.retrieve('scheduleId');
+   * ```
+   */
+  retrieve(scheduleID: string, options?: RequestOptions): APIPromise<ScheduledAgentItem> {
+    return this._client.get(path`/agent/schedules/${scheduleID}`, options);
+  }
+
+  /**
+   * Update an existing scheduled agent's configuration. All fields except
+   * agent_config are required.
+   *
+   * @example
+   * ```ts
+   * const scheduledAgentItem =
+   *   await client.agent.schedules.update('scheduleId', {
+   *     cron_schedule: 'cron_schedule',
+   *     enabled: true,
+   *     name: 'name',
+   *     prompt: 'prompt',
+   *   });
+   * ```
+   */
+  update(
+    scheduleID: string,
+    body: ScheduleUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ScheduledAgentItem> {
+    return this._client.put(path`/agent/schedules/${scheduleID}`, { body, ...options });
+  }
+
+  /**
+   * Retrieve all scheduled agents accessible to the authenticated user. Results are
+   * sorted alphabetically by name.
+   *
+   * @example
+   * ```ts
+   * const schedules = await client.agent.schedules.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<ScheduleListResponse> {
+    return this._client.get('/agent/schedules', options);
+  }
+
+  /**
+   * Delete a scheduled agent. This will stop all future scheduled runs.
+   *
+   * @example
+   * ```ts
+   * const schedule = await client.agent.schedules.delete(
+   *   'scheduleId',
+   * );
+   * ```
+   */
+  delete(scheduleID: string, options?: RequestOptions): APIPromise<ScheduleDeleteResponse> {
+    return this._client.delete(path`/agent/schedules/${scheduleID}`, options);
+  }
+
+  /**
+   * Pause a scheduled agent. The agent will not run until resumed. This sets the
+   * enabled flag to false.
+   *
+   * @example
+   * ```ts
+   * const scheduledAgentItem =
+   *   await client.agent.schedules.pause('scheduleId');
+   * ```
+   */
+  pause(scheduleID: string, options?: RequestOptions): APIPromise<ScheduledAgentItem> {
+    return this._client.post(path`/agent/schedules/${scheduleID}/pause`, options);
+  }
+
+  /**
+   * Resume a paused scheduled agent. The agent will start running according to its
+   * cron schedule. This sets the enabled flag to true.
+   *
+   * @example
+   * ```ts
+   * const scheduledAgentItem =
+   *   await client.agent.schedules.resume('scheduleId');
+   * ```
+   */
+  resume(scheduleID: string, options?: RequestOptions): APIPromise<ScheduledAgentItem> {
+    return this._client.post(path`/agent/schedules/${scheduleID}/resume`, options);
+  }
+}
+
+export interface ScheduledAgentItem {
+  /**
+   * Unique identifier for the scheduled agent
+   */
+  id: string;
+
+  /**
+   * Timestamp when the schedule was created (RFC3339)
+   */
+  created_at: string;
+
+  /**
+   * Cron expression defining when the agent runs (e.g., "0 9 \* \* \*" for daily at
+   * 9am UTC)
+   */
+  cron_schedule: string;
+
+  /**
+   * Whether the schedule is currently active
+   */
+  enabled: boolean;
+
+  /**
+   * Human-readable name for the schedule
+   */
+  name: string;
+
+  /**
+   * The prompt/instruction for the agent to execute
+   */
+  prompt: string;
+
+  /**
+   * Timestamp when the schedule was last updated (RFC3339)
+   */
+  updated_at: string;
+
+  /**
+   * Configuration for an cloud agent run
+   */
+  agent_config?: AgentAPI.AmbientAgentConfig;
+
+  created_by?: AgentAPI.UserProfile;
+
+  /**
+   * Configuration for a cloud environment used by scheduled agents
+   */
+  environment?: AgentAPI.CloudEnvironmentConfig;
+
+  /**
+   * Scheduler-derived history metadata for a scheduled agent
+   */
+  history?: ScheduledAgentItem.History;
+
+  /**
+   * Error message from the last failed spawn attempt, if any
+   */
+  last_spawn_error?: string | null;
+
+  /**
+   * Ownership scope for a resource (team or personal)
+   */
+  scope?: ScheduledAgentItem.Scope;
+
+  updated_by?: AgentAPI.UserProfile;
+}
+
+export namespace ScheduledAgentItem {
+  /**
+   * Scheduler-derived history metadata for a scheduled agent
+   */
+  export interface History {
+    /**
+     * Timestamp of the last successful run (RFC3339)
+     */
+    last_ran?: string | null;
+
+    /**
+     * Timestamp of the next scheduled run (RFC3339)
+     */
+    next_run?: string | null;
+  }
+
+  /**
+   * Ownership scope for a resource (team or personal)
+   */
+  export interface Scope {
+    /**
+     * Type of ownership ("User" for personal, "Team" for team-owned)
+     */
+    type: 'User' | 'Team';
+
+    /**
+     * UID of the owning user or team
+     */
+    uid?: string;
+  }
+}
+
+export interface ScheduleListResponse {
+  /**
+   * List of scheduled agents
+   */
+  schedules: Array<ScheduledAgentItem>;
+}
+
+export interface ScheduleDeleteResponse {
+  /**
+   * Whether the deletion was successful
+   */
+  success: boolean;
+}
+
+export interface ScheduleCreateParams {
+  /**
+   * Cron expression defining when the agent runs (e.g., "0 9 \* \* \*" for daily at
+   * 9am UTC)
+   */
+  cron_schedule: string;
+
+  /**
+   * Human-readable name for the schedule
+   */
+  name: string;
+
+  /**
+   * The prompt/instruction for the agent to execute
+   */
+  prompt: string;
+
+  /**
+   * Configuration for an cloud agent run
+   */
+  agent_config?: AgentAPI.AmbientAgentConfig;
+
+  /**
+   * Whether the schedule should be active immediately
+   */
+  enabled?: boolean;
+
+  /**
+   * Whether to create a team-owned schedule. Defaults to true for users on a single
+   * team.
+   */
+  team?: boolean;
+}
+
+export interface ScheduleUpdateParams {
+  /**
+   * Cron expression defining when the agent runs
+   */
+  cron_schedule: string;
+
+  /**
+   * Whether the schedule should be active
+   */
+  enabled: boolean;
+
+  /**
+   * Human-readable name for the schedule
+   */
+  name: string;
+
+  /**
+   * The prompt/instruction for the agent to execute
+   */
+  prompt: string;
+
+  /**
+   * Configuration for an cloud agent run
+   */
+  agent_config?: AgentAPI.AmbientAgentConfig;
+}
+
+export declare namespace Schedules {
+  export {
+    type ScheduledAgentItem as ScheduledAgentItem,
+    type ScheduleListResponse as ScheduleListResponse,
+    type ScheduleDeleteResponse as ScheduleDeleteResponse,
+    type ScheduleCreateParams as ScheduleCreateParams,
+    type ScheduleUpdateParams as ScheduleUpdateParams,
+  };
+}

package/src/resources/agent.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './agent/index';

package/src/resources/index.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Agent,
+  type AgentSkill,
+  type AmbientAgentConfig,
+  type CloudEnvironmentConfig,
+  type McpServerConfig,
+  type UserProfile,
+  type AgentListResponse,
+  type AgentRunResponse,
+  type AgentListParams,
+  type AgentRunParams,
+} from './agent/agent';

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '1.0.0-alpha.7'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "1.0.0-alpha.7";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,kBAAkB,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "1.0.0-alpha.7";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,kBAAkB,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '1.0.0-alpha.7'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,eAAe,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '1.0.0-alpha.7'; // x-release-please-version
+//# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,2BAA2B"}