@rippling/rippling-sdk 0.2.0-alpha.86 → 0.2.0-alpha.87

package/src/resources/agents/sessions/events.ts

@@ -0,0 +1,107 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Agents defined by the company
+ */
+export class Events extends APIResource {
+  /**
+   * List events for an agent session after an optional sequence number.
+   */
+  retrieve(
+    sessionID: string,
+    query: EventRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EventRetrieveResponse> {
+    return this._client.get(path`/agents/sessions/${sessionID}/events/`, { query, ...options });
+  }
+}
+
+export interface EventRetrieveResponse {
+  /**
+   * Session events
+   */
+  events?: Array<EventRetrieveResponse.Event>;
+
+  /**
+   * Whether the session has ended
+   */
+  is_terminal?: boolean;
+
+  /**
+   * The latest event sequence number
+   */
+  last_sequence?: number;
+
+  /**
+   * Use this sequence number as after_sequence to continue the event stream
+   */
+  next_after_sequence?: number;
+
+  /**
+   * The current session status
+   */
+  status?: string;
+}
+
+export namespace EventRetrieveResponse {
+  export interface Event {
+    /**
+     * When the event was created
+     */
+    created_at?: string;
+
+    /**
+     * The ID of the session event
+     */
+    event_id?: string;
+
+    /**
+     * The event type
+     */
+    event_type?: string;
+
+    /**
+     * Structured event fields
+     */
+    fields?: unknown;
+
+    /**
+     * The event severity level
+     */
+    level?: string;
+
+    /**
+     * The event message
+     */
+    message?: string;
+
+    /**
+     * The event sequence number
+     */
+    sequence?: number;
+  }
+}
+
+export interface EventRetrieveParams {
+  /**
+   * Only return results after this control-plane sequence number.
+   */
+  after_sequence?: number;
+
+  /**
+   * The maximum number of results to return.
+   */
+  limit?: number;
+}
+
+export declare namespace Events {
+  export {
+    type EventRetrieveResponse as EventRetrieveResponse,
+    type EventRetrieveParams as EventRetrieveParams,
+  };
+}

package/src/resources/agents/sessions/index.ts

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Events, type EventRetrieveResponse, type EventRetrieveParams } from './events';
+export {
+  Sessions,
+  type SessionCreateResponse,
+  type SessionListResponse,
+  type SessionRetrieveResponse,
+  type SessionCreateParams,
+  type SessionListParams,
+  type SessionListResponsesPageCursorURL,
+} from './sessions';

package/src/resources/agents/sessions/sessions.ts

@@ -0,0 +1,216 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as EventsAPI from './events';
+import { EventRetrieveParams, EventRetrieveResponse, Events } from './events';
+import { APIPromise } from '../../../core/api-promise';
+import { PageCursorURL, PagePromise } from '../../../core/pagination';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * Agents defined by the company
+ */
+export class Sessions extends APIResource {
+  events: EventsAPI.Events = new EventsAPI.Events(this._client);
+
+  /**
+   * Start an agent session with a prompt.
+   */
+  create(body: SessionCreateParams, options?: RequestOptions): APIPromise<SessionCreateResponse> {
+    return this._client.post('/agents/sessions/', { body, ...options });
+  }
+
+  /**
+   * A list of sessions for an agent.
+   */
+  list(
+    agentID: string,
+    query: SessionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SessionListResponsesPageCursorURL, SessionListResponse> {
+    return this._client.getAPIList(path`/agents/${agentID}/sessions/`, PageCursorURL<SessionListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Retrieve an agent session, including its terminal output or error when
+   * available.
+   */
+  retrieve(sessionID: string, options?: RequestOptions): APIPromise<SessionRetrieveResponse> {
+    return this._client.get(path`/agents/sessions/${sessionID}/`, options);
+  }
+}
+
+export type SessionListResponsesPageCursorURL = PageCursorURL<SessionListResponse>;
+
+export interface SessionCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The ID of the agent to run
+   */
+  agent_id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The prompt to send to the agent
+   */
+  prompt: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The session error message
+   */
+  error_message?: string;
+
+  /**
+   * The output of the session
+   */
+  output?: unknown;
+
+  /**
+   * The status of the session
+   */
+  status?: string;
+}
+
+export interface SessionListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The ID of the agent to run
+   */
+  agent_id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The prompt to send to the agent
+   */
+  prompt: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The session error message
+   */
+  error_message?: string;
+
+  /**
+   * The output of the session
+   */
+  output?: unknown;
+
+  /**
+   * The status of the session
+   */
+  status?: string;
+}
+
+export interface SessionRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The ID of the agent to run
+   */
+  agent_id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The prompt to send to the agent
+   */
+  prompt: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The session error message
+   */
+  error_message?: string;
+
+  /**
+   * The output of the session
+   */
+  output?: unknown;
+
+  /**
+   * The status of the session
+   */
+  status?: string;
+}
+
+export interface SessionCreateParams {
+  /**
+   * The ID of the agent to run
+   */
+  agent_id: string;
+
+  /**
+   * The prompt to send to the agent
+   */
+  prompt: string;
+}
+
+export interface SessionListParams {
+  /**
+   * The cursor from a previous next_link.
+   */
+  cursor?: string;
+
+  /**
+   * The maximum number of results to return.
+   */
+  limit?: number;
+}
+
+Sessions.Events = Events;
+
+export declare namespace Sessions {
+  export {
+    type SessionCreateResponse as SessionCreateResponse,
+    type SessionListResponse as SessionListResponse,
+    type SessionRetrieveResponse as SessionRetrieveResponse,
+    type SessionListResponsesPageCursorURL as SessionListResponsesPageCursorURL,
+    type SessionCreateParams as SessionCreateParams,
+    type SessionListParams as SessionListParams,
+  };
+
+  export {
+    Events as Events,
+    type EventRetrieveResponse as EventRetrieveResponse,
+    type EventRetrieveParams as EventRetrieveParams,
+  };
+}

package/src/resources/agents/sessions.ts

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

package/src/resources/agents/source-revisions.ts

@@ -0,0 +1,267 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Agents defined by the company
+ */
+export class SourceRevisions extends APIResource {
+  /**
+   * A list of source revisions for an agent.
+   */
+  list(
+    agentID: string,
+    query: SourceRevisionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SourceRevisionListResponsesPageCursorURL, SourceRevisionListResponse> {
+    return this._client.getAPIList(
+      path`/agents/${agentID}/source-revisions/`,
+      PageCursorURL<SourceRevisionListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Create a source revision for an agent.
+   */
+  create(
+    agentID: string,
+    body: SourceRevisionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<SourceRevisionCreateResponse> {
+    return this._client.post(path`/agents/${agentID}/source-revisions/`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a source revision for an agent.
+   */
+  retrieve(
+    agentID: string,
+    sourceRevisionID: string,
+    options?: RequestOptions,
+  ): APIPromise<SourceRevisionRetrieveResponse> {
+    return this._client.get(path`/agents/${agentID}/source-revisions/${sourceRevisionID}/`, options);
+  }
+}
+
+export type SourceRevisionListResponsesPageCursorURL = PageCursorURL<SourceRevisionListResponse>;
+
+/**
+ * List representation of an agent source revision without source contents.
+ */
+export interface SourceRevisionListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Skill IDs used by the agent
+   */
+  skill_ids?: Array<string>;
+
+  /**
+   * The digest of the source revision
+   */
+  source_digest?: string;
+
+  /**
+   * The version number of the source revision
+   */
+  version?: number;
+}
+
+export interface SourceRevisionCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The entrypoint file
+   */
+  entrypoint: string;
+
+  /**
+   * The files in the source revision
+   */
+  files: Array<SourceRevisionCreateResponse.File>;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Skill IDs used by the agent
+   */
+  skill_ids?: Array<string>;
+
+  /**
+   * The digest of the source revision
+   */
+  source_digest?: string;
+
+  /**
+   * The version number of the source revision
+   */
+  version?: number;
+}
+
+export namespace SourceRevisionCreateResponse {
+  export interface File {
+    /**
+     * The contents of the source file
+     */
+    content: string;
+
+    /**
+     * The source file language or format
+     */
+    kind: string;
+
+    /**
+     * The path of the source file
+     */
+    path: string;
+  }
+}
+
+export interface SourceRevisionRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The entrypoint file
+   */
+  entrypoint: string;
+
+  /**
+   * The files in the source revision
+   */
+  files: Array<SourceRevisionRetrieveResponse.File>;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * Skill IDs used by the agent
+   */
+  skill_ids?: Array<string>;
+
+  /**
+   * The digest of the source revision
+   */
+  source_digest?: string;
+
+  /**
+   * The version number of the source revision
+   */
+  version?: number;
+}
+
+export namespace SourceRevisionRetrieveResponse {
+  export interface File {
+    /**
+     * The contents of the source file
+     */
+    content: string;
+
+    /**
+     * The source file language or format
+     */
+    kind: string;
+
+    /**
+     * The path of the source file
+     */
+    path: string;
+  }
+}
+
+export interface SourceRevisionListParams {
+  /**
+   * The cursor from a previous next_link.
+   */
+  cursor?: string;
+
+  /**
+   * The maximum number of results to return.
+   */
+  limit?: number;
+}
+
+export interface SourceRevisionCreateParams {
+  /**
+   * The entrypoint file
+   */
+  entrypoint: string;
+
+  /**
+   * The files in the source revision
+   */
+  files: Array<SourceRevisionCreateParams.File>;
+
+  /**
+   * Skill IDs used by the agent
+   */
+  skill_ids?: Array<string>;
+}
+
+export namespace SourceRevisionCreateParams {
+  export interface File {
+    /**
+     * The contents of the source file
+     */
+    content: string;
+
+    /**
+     * The source file language or format
+     */
+    kind: string;
+
+    /**
+     * The path of the source file
+     */
+    path: string;
+  }
+}
+
+export declare namespace SourceRevisions {
+  export {
+    type SourceRevisionListResponse as SourceRevisionListResponse,
+    type SourceRevisionCreateResponse as SourceRevisionCreateResponse,
+    type SourceRevisionRetrieveResponse as SourceRevisionRetrieveResponse,
+    type SourceRevisionListResponsesPageCursorURL as SourceRevisionListResponsesPageCursorURL,
+    type SourceRevisionListParams as SourceRevisionListParams,
+    type SourceRevisionCreateParams as SourceRevisionCreateParams,
+  };
+}

package/src/resources/agents.ts

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

package/src/resources/break-policies.ts

@@ -14,7 +14,7 @@ export class BreakPolicies extends APIResource {
   /**
    * A list of break policies.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(

package/src/resources/break-types.ts

@@ -14,7 +14,7 @@ export class BreakTypes extends APIResource {
   /**
    * A list of break types.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `policy_id`
    * - Expandable fields: `policy`
    * - Sortable fields: `id`, `created_at`, `updated_at`

package/src/resources/business-structure-paths.ts

@@ -15,7 +15,7 @@ export class BusinessStructurePaths extends APIResource {
   /**
    * A list of business-structure-paths.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Expandable fields: `parent`, `job_codes`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */

package/src/resources/candidate-applications.ts

@@ -12,7 +12,7 @@ export class CandidateApplications extends APIResource {
   /**
    * A list of candidate applications.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Expandable fields: `job`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */

package/src/resources/candidates.ts

@@ -11,7 +11,7 @@ export class Candidates extends APIResource {
   /**
    * A list of candidates.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */
   list(

package/src/resources/company-legal-entities.ts

@@ -15,7 +15,7 @@ export class CompanyLegalEntities extends APIResource {
   /**
    * A list of company legal entities.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `country_code`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */

package/src/resources/company-legal-entity-workers.ts

@@ -14,7 +14,7 @@ export class CompanyLegalEntityWorkers extends APIResource {
   /**
    * A list of company-legal-entity-workers.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `status`, `company_entity_id`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */

package/src/resources/compensation-bands-details.ts

@@ -15,7 +15,7 @@ export class CompensationBandsDetails extends APIResource {
   /**
    * A list of compensation bands details.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `created_at`, `updated_at`, `internal_job_code`,
    *   `worker_id`
    * - Expandable fields: `worker`

package/src/resources/compensations.ts

@@ -15,7 +15,7 @@ export class Compensations extends APIResource {
   /**
    * A list of compensations.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Expandable fields: `worker`
    * - Sortable fields: `id`, `created_at`, `updated_at`
    */

package/src/resources/device-orders.ts

@@ -15,7 +15,7 @@ export class DeviceOrders extends APIResource {
   /**
    * A list of device orders.
    *
-   * - Requires: `API Tier 2`
+   * - Requires: `API Tier 1`
    * - Filterable fields: `worker_id`, `status`
    * - Expandable fields: `worker`
    * - Sortable fields: `id`, `created_at`, `updated_at`