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

package/src/resources/agents/agents.ts

@@ -0,0 +1,340 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as DeploymentsAPI from './deployments';
+import {
+  DeploymentCreateParams,
+  DeploymentCreateResponse,
+  DeploymentListParams,
+  DeploymentListResponse,
+  DeploymentListResponsesPageCursorURL,
+  DeploymentRetrieveResponse,
+  Deployments,
+} from './deployments';
+import * as SourceRevisionsAPI from './source-revisions';
+import {
+  SourceRevisionCreateParams,
+  SourceRevisionCreateResponse,
+  SourceRevisionListParams,
+  SourceRevisionListResponse,
+  SourceRevisionListResponsesPageCursorURL,
+  SourceRevisionRetrieveResponse,
+  SourceRevisions,
+} from './source-revisions';
+import * as SessionsAPI from './sessions/sessions';
+import {
+  SessionCreateParams,
+  SessionCreateResponse,
+  SessionListParams,
+  SessionListResponse,
+  SessionListResponsesPageCursorURL,
+  SessionRetrieveResponse,
+  Sessions,
+} from './sessions/sessions';
+import { APIPromise } from '../../core/api-promise';
+import { PageCursorURL, PagePromise } from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Agents defined by the company
+ */
+export class Agents extends APIResource {
+  sourceRevisions: SourceRevisionsAPI.SourceRevisions = new SourceRevisionsAPI.SourceRevisions(this._client);
+  deployments: DeploymentsAPI.Deployments = new DeploymentsAPI.Deployments(this._client);
+  sessions: SessionsAPI.Sessions = new SessionsAPI.Sessions(this._client);
+
+  /**
+   * A list of agents.
+   */
+  list(
+    query: AgentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<AgentListResponsesPageCursorURL, AgentListResponse> {
+    return this._client.getAPIList('/agents/', PageCursorURL<AgentListResponse>, { query, ...options });
+  }
+
+  /**
+   * Create a new agent.
+   */
+  create(body: AgentCreateParams, options?: RequestOptions): APIPromise<AgentCreateResponse> {
+    return this._client.post('/agents/', { body, ...options });
+  }
+
+  /**
+   * Retrieve an agent.
+   */
+  retrieve(agentID: string, options?: RequestOptions): APIPromise<AgentRetrieveResponse> {
+    return this._client.get(path`/agents/${agentID}/`, options);
+  }
+
+  /**
+   * Update an agent's name or description.
+   */
+  update(
+    agentID: string,
+    body: AgentUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AgentUpdateResponse> {
+    return this._client.patch(path`/agents/${agentID}/`, { body, ...options });
+  }
+
+  /**
+   * Delete an agent.
+   */
+  delete(agentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/agents/${agentID}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type AgentListResponsesPageCursorURL = PageCursorURL<AgentListResponse>;
+
+export interface AgentListResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The API name of the agent
+   */
+  api_name: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the agent
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The description of the agent
+   */
+  description?: string;
+
+  /**
+   * Whether the agent is used for evaluations
+   */
+  is_for_evals?: boolean;
+}
+
+export interface AgentCreateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The API name of the agent
+   */
+  api_name: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the agent
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The description of the agent
+   */
+  description?: string;
+
+  /**
+   * Whether the agent is used for evaluations
+   */
+  is_for_evals?: boolean;
+}
+
+export interface AgentRetrieveResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The API name of the agent
+   */
+  api_name: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the agent
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The description of the agent
+   */
+  description?: string;
+
+  /**
+   * Whether the agent is used for evaluations
+   */
+  is_for_evals?: boolean;
+}
+
+export interface AgentUpdateResponse {
+  /**
+   * Identifier field
+   */
+  id: string;
+
+  /**
+   * The API name of the agent
+   */
+  api_name: string;
+
+  /**
+   * Record creation date
+   */
+  created_at: string;
+
+  /**
+   * The display name of the agent
+   */
+  name: string;
+
+  /**
+   * Record update date
+   */
+  updated_at: string;
+
+  /**
+   * The description of the agent
+   */
+  description?: string;
+
+  /**
+   * Whether the agent is used for evaluations
+   */
+  is_for_evals?: boolean;
+}
+
+export interface AgentListParams {
+  /**
+   * The cursor from a previous next_link.
+   */
+  cursor?: string;
+
+  /**
+   * Filter by api_name or is_for_evals using OData syntax.
+   */
+  filter?: string;
+
+  /**
+   * The maximum number of results to return.
+   */
+  limit?: number;
+}
+
+export interface AgentCreateParams {
+  /**
+   * The API name of the agent
+   */
+  api_name: string;
+
+  /**
+   * The display name of the agent
+   */
+  name: string;
+
+  /**
+   * The description of the agent
+   */
+  description?: string;
+
+  /**
+   * Whether the agent is used for evaluations
+   */
+  is_for_evals?: boolean;
+}
+
+export interface AgentUpdateParams {
+  /**
+   * The description of the agent
+   */
+  description?: string;
+
+  /**
+   * The display name of the agent
+   */
+  name?: string;
+}
+
+Agents.SourceRevisions = SourceRevisions;
+Agents.Deployments = Deployments;
+Agents.Sessions = Sessions;
+
+export declare namespace Agents {
+  export {
+    type AgentListResponse as AgentListResponse,
+    type AgentCreateResponse as AgentCreateResponse,
+    type AgentRetrieveResponse as AgentRetrieveResponse,
+    type AgentUpdateResponse as AgentUpdateResponse,
+    type AgentListResponsesPageCursorURL as AgentListResponsesPageCursorURL,
+    type AgentListParams as AgentListParams,
+    type AgentCreateParams as AgentCreateParams,
+    type AgentUpdateParams as AgentUpdateParams,
+  };
+
+  export {
+    SourceRevisions as SourceRevisions,
+    type SourceRevisionListResponse as SourceRevisionListResponse,
+    type SourceRevisionCreateResponse as SourceRevisionCreateResponse,
+    type SourceRevisionRetrieveResponse as SourceRevisionRetrieveResponse,
+    type SourceRevisionListResponsesPageCursorURL as SourceRevisionListResponsesPageCursorURL,
+    type SourceRevisionListParams as SourceRevisionListParams,
+    type SourceRevisionCreateParams as SourceRevisionCreateParams,
+  };
+
+  export {
+    Deployments as Deployments,
+    type DeploymentListResponse as DeploymentListResponse,
+    type DeploymentCreateResponse as DeploymentCreateResponse,
+    type DeploymentRetrieveResponse as DeploymentRetrieveResponse,
+    type DeploymentListResponsesPageCursorURL as DeploymentListResponsesPageCursorURL,
+    type DeploymentListParams as DeploymentListParams,
+    type DeploymentCreateParams as DeploymentCreateParams,
+  };
+
+  export {
+    Sessions as Sessions,
+    type SessionCreateResponse as SessionCreateResponse,
+    type SessionListResponse as SessionListResponse,
+    type SessionRetrieveResponse as SessionRetrieveResponse,
+    type SessionListResponsesPageCursorURL as SessionListResponsesPageCursorURL,
+    type SessionCreateParams as SessionCreateParams,
+    type SessionListParams as SessionListParams,
+  };
+}

package/src/resources/agents/deployments.ts

@@ -0,0 +1,249 @@
+// 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 Deployments extends APIResource {
+  /**
+   * A list of deployments for an agent.
+   */
+  list(
+    agentID: string,
+    query: DeploymentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<DeploymentListResponsesPageCursorURL, DeploymentListResponse> {
+    return this._client.getAPIList(
+      path`/agents/${agentID}/deployments/`,
+      PageCursorURL<DeploymentListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Deploy a source revision for an agent.
+   */
+  create(
+    agentID: string,
+    body: DeploymentCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<DeploymentCreateResponse> {
+    return this._client.post(path`/agents/${agentID}/deployments/`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a deployment for an agent.
+   */
+  retrieve(
+    agentID: string,
+    deploymentID: string,
+    options?: RequestOptions,
+  ): APIPromise<DeploymentRetrieveResponse> {
+    return this._client.get(path`/agents/${agentID}/deployments/${deploymentID}/`, options);
+  }
+}
+
+export type DeploymentListResponsesPageCursorURL = PageCursorURL<DeploymentListResponse>;
+
+export interface DeploymentListResponse {
+  /**
+   * The ID of the deployment
+   */
+  deployment_id?: string;
+
+  /**
+   * Diagnostics emitted while creating the deployment
+   */
+  diagnostics?: Array<DeploymentListResponse.Diagnostic>;
+
+  /**
+   * Whether the deployment is active
+   */
+  is_active?: boolean;
+
+  /**
+   * The deployment outcome
+   */
+  outcome?: string;
+
+  /**
+   * The digest of the deployed source revision
+   */
+  source_digest?: string;
+
+  /**
+   * The source revision version deployed by the control plane
+   */
+  source_revision_version?: number;
+
+  /**
+   * The deployment stage
+   */
+  stage?: string;
+}
+
+export namespace DeploymentListResponse {
+  export interface Diagnostic {
+    /**
+     * The diagnostic message
+     */
+    message?: string;
+
+    /**
+     * The source path for the diagnostic
+     */
+    path?: string;
+
+    /**
+     * The diagnostic severity
+     */
+    severity?: string;
+  }
+}
+
+export interface DeploymentCreateResponse {
+  /**
+   * The ID of the deployment
+   */
+  deployment_id?: string;
+
+  /**
+   * Diagnostics emitted while creating the deployment
+   */
+  diagnostics?: Array<DeploymentCreateResponse.Diagnostic>;
+
+  /**
+   * Whether the deployment is active
+   */
+  is_active?: boolean;
+
+  /**
+   * The deployment outcome
+   */
+  outcome?: string;
+
+  /**
+   * The digest of the deployed source revision
+   */
+  source_digest?: string;
+
+  /**
+   * The source revision version deployed by the control plane
+   */
+  source_revision_version?: number;
+
+  /**
+   * The deployment stage
+   */
+  stage?: string;
+}
+
+export namespace DeploymentCreateResponse {
+  export interface Diagnostic {
+    /**
+     * The diagnostic message
+     */
+    message?: string;
+
+    /**
+     * The source path for the diagnostic
+     */
+    path?: string;
+
+    /**
+     * The diagnostic severity
+     */
+    severity?: string;
+  }
+}
+
+export interface DeploymentRetrieveResponse {
+  /**
+   * The ID of the deployment
+   */
+  deployment_id?: string;
+
+  /**
+   * Diagnostics emitted while creating the deployment
+   */
+  diagnostics?: Array<DeploymentRetrieveResponse.Diagnostic>;
+
+  /**
+   * Whether the deployment is active
+   */
+  is_active?: boolean;
+
+  /**
+   * The deployment outcome
+   */
+  outcome?: string;
+
+  /**
+   * The digest of the deployed source revision
+   */
+  source_digest?: string;
+
+  /**
+   * The source revision version deployed by the control plane
+   */
+  source_revision_version?: number;
+
+  /**
+   * The deployment stage
+   */
+  stage?: string;
+}
+
+export namespace DeploymentRetrieveResponse {
+  export interface Diagnostic {
+    /**
+     * The diagnostic message
+     */
+    message?: string;
+
+    /**
+     * The source path for the diagnostic
+     */
+    path?: string;
+
+    /**
+     * The diagnostic severity
+     */
+    severity?: string;
+  }
+}
+
+export interface DeploymentListParams {
+  /**
+   * Only return results after this control-plane sequence number.
+   */
+  after_sequence?: number;
+
+  /**
+   * The maximum number of results to return.
+   */
+  limit?: number;
+}
+
+export interface DeploymentCreateParams {
+  /**
+   * The ID of the source revision to deploy
+   */
+  source_revision_id: string;
+}
+
+export declare namespace Deployments {
+  export {
+    type DeploymentListResponse as DeploymentListResponse,
+    type DeploymentCreateResponse as DeploymentCreateResponse,
+    type DeploymentRetrieveResponse as DeploymentRetrieveResponse,
+    type DeploymentListResponsesPageCursorURL as DeploymentListResponsesPageCursorURL,
+    type DeploymentListParams as DeploymentListParams,
+    type DeploymentCreateParams as DeploymentCreateParams,
+  };
+}

package/src/resources/agents/index.ts

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Agents,
+  type AgentListResponse,
+  type AgentCreateResponse,
+  type AgentRetrieveResponse,
+  type AgentUpdateResponse,
+  type AgentListParams,
+  type AgentCreateParams,
+  type AgentUpdateParams,
+  type AgentListResponsesPageCursorURL,
+} from './agents';
+export {
+  Deployments,
+  type DeploymentListResponse,
+  type DeploymentCreateResponse,
+  type DeploymentRetrieveResponse,
+  type DeploymentListParams,
+  type DeploymentCreateParams,
+  type DeploymentListResponsesPageCursorURL,
+} from './deployments';
+export {
+  Sessions,
+  type SessionCreateResponse,
+  type SessionListResponse,
+  type SessionRetrieveResponse,
+  type SessionCreateParams,
+  type SessionListParams,
+  type SessionListResponsesPageCursorURL,
+} from './sessions/index';
+export {
+  SourceRevisions,
+  type SourceRevisionListResponse,
+  type SourceRevisionCreateResponse,
+  type SourceRevisionRetrieveResponse,
+  type SourceRevisionListParams,
+  type SourceRevisionCreateParams,
+  type SourceRevisionListResponsesPageCursorURL,
+} from './source-revisions';