import { APIResource } from "../../core/resource.mjs"; import * as DeploymentsAPI from "./deployments.mjs"; import { DeploymentCreateParams, DeploymentCreateResponse, DeploymentListParams, DeploymentListResponse, DeploymentListResponsesPageCursorURL, DeploymentRetrieveResponse, Deployments } from "./deployments.mjs"; import * as SourceRevisionsAPI from "./source-revisions.mjs"; import { SourceRevisionCreateParams, SourceRevisionCreateResponse, SourceRevisionListParams, SourceRevisionListResponse, SourceRevisionListResponsesPageCursorURL, SourceRevisionRetrieveResponse, SourceRevisions } from "./source-revisions.mjs"; import * as SessionsAPI from "./sessions/sessions.mjs"; import { SessionCreateParams, SessionCreateResponse, SessionListParams, SessionListResponse, SessionListResponsesPageCursorURL, SessionRetrieveResponse, Sessions } from "./sessions/sessions.mjs"; import { APIPromise } from "../../core/api-promise.mjs"; import { PageCursorURL, PagePromise } from "../../core/pagination.mjs"; import { RequestOptions } from "../../internal/request-options.mjs"; /** * Agents defined by the company */ export declare class Agents extends APIResource { sourceRevisions: SourceRevisionsAPI.SourceRevisions; deployments: DeploymentsAPI.Deployments; sessions: SessionsAPI.Sessions; /** * A list of agents. * * @example HTTP * Representative request and response shapes. * ``` * GET /agents/?limit=1&cursor=cursor&filter=filter HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "results": [ * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "api_name": "string", * "description": "string", * "is_for_evals": false * } * ], * "next_link": "string" * } * ``` */ list(query?: AgentListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Create a new agent. * * @example HTTP * Representative request and response shapes. * ``` * POST /agents/ HTTP/1.1 * Host: rest.ripplingapis.com * Content-Type: application/json * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * { * "api_name": "api_name", * "name": "name" * } * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "api_name": "string", * "description": "string", * "is_for_evals": false * } * ``` */ create(body: AgentCreateParams, options?: RequestOptions): APIPromise; /** * Retrieve an agent. * * @example HTTP * Representative request and response shapes. * ``` * GET /agents/{agent_id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "api_name": "string", * "description": "string", * "is_for_evals": false * } * ``` */ retrieve(agentID: string, options?: RequestOptions): APIPromise; /** * Update an agent's name or description. * * @example HTTP * Representative request and response shapes. * ``` * PATCH /agents/{agent_id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Content-Type: application/json * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * {} * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "api_name": "string", * "description": "string", * "is_for_evals": false * } * ``` */ update(agentID: string, body?: AgentUpdateParams | null | undefined, options?: RequestOptions): APIPromise; /** * Delete an agent. * * @example HTTP * Representative request and response shapes. * ``` * DELETE /agents/{agent_id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * ``` */ delete(agentID: string, options?: RequestOptions): APIPromise; } export type AgentListResponsesPageCursorURL = PageCursorURL; 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; } 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, }; } //# sourceMappingURL=agents.d.mts.map