@rippling/rippling-sdk 0.2.0-alpha.95 → 0.2.0-alpha.97

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

@@ -52,15 +52,43 @@ export interface MessageCreateResponse {
    */
   error_message?: string;
 
+  /**
+   * The stable LangSmith thread identifier for this session
+   */
+  langsmith_thread_id?: string;
+
   /**
    * The output of the session
    */
   output?: unknown;
 
+  /**
+   * Receipt that ACP restored the requested session resume state
+   */
+  session_resume_receipt?: MessageCreateResponse.SessionResumeReceipt;
+
   /**
    * The status of the session
    */
   status?: string;
+
+  /**
+   * Receipt for correlating agent.submission.settled events after create or
+   * append-message writes
+   */
+  submission_id?: string;
+}
+
+export namespace MessageCreateResponse {
+  /**
+   * Receipt that ACP restored the requested session resume state
+   */
+  export interface SessionResumeReceipt {
+    /**
+     * The session resume state restore status
+     */
+    status?: string;
+  }
 }
 
 export interface MessageCreateParams {

package/src/resources/agents/sessions/resume-state.ts

@@ -0,0 +1,32 @@
+// 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 ResumeState extends APIResource {
+  /**
+   * Capture opaque state that can restore a compatible eval agent session.
+   */
+  create(sessionID: string, options?: RequestOptions): APIPromise<ResumeStateCreateResponse> {
+    return this._client.post(path`/agents/sessions/${sessionID}/resume-state/`, options);
+  }
+}
+
+/**
+ * Opaque state used to restore an eval agent session.
+ */
+export interface ResumeStateCreateResponse {
+  /**
+   * An opaque base64-encoded agent session resume state
+   */
+  artifact: string;
+}
+
+export declare namespace ResumeState {
+  export { type ResumeStateCreateResponse as ResumeStateCreateResponse };
+}

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

@@ -5,6 +5,8 @@ import * as EventsAPI from './events';
 import { EventRetrieveParams, EventRetrieveResponse, Events } from './events';
 import * as MessagesAPI from './messages';
 import { MessageCreateParams, MessageCreateResponse, Messages } from './messages';
+import * as ResumeStateAPI from './resume-state';
+import { ResumeState, ResumeStateCreateResponse } from './resume-state';
 import { APIPromise } from '../../../core/api-promise';
 import { PageCursorURL, PagePromise } from '../../../core/pagination';
 import { RequestOptions } from '../../../internal/request-options';
@@ -15,6 +17,7 @@ import { path } from '../../../internal/utils/path';
  */
 export class Sessions extends APIResource {
   messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
+  resumeState: ResumeStateAPI.ResumeState = new ResumeStateAPI.ResumeState(this._client);
   events: EventsAPI.Events = new EventsAPI.Events(this._client);
 
   /**
@@ -80,15 +83,43 @@ export interface SessionCreateResponse {
    */
   error_message?: string;
 
+  /**
+   * The stable LangSmith thread identifier for this session
+   */
+  langsmith_thread_id?: string;
+
   /**
    * The output of the session
    */
   output?: unknown;
 
+  /**
+   * Receipt that ACP restored the requested session resume state
+   */
+  session_resume_receipt?: SessionCreateResponse.SessionResumeReceipt;
+
   /**
    * The status of the session
    */
   status?: string;
+
+  /**
+   * Receipt for correlating agent.submission.settled events after create or
+   * append-message writes
+   */
+  submission_id?: string;
+}
+
+export namespace SessionCreateResponse {
+  /**
+   * Receipt that ACP restored the requested session resume state
+   */
+  export interface SessionResumeReceipt {
+    /**
+     * The session resume state restore status
+     */
+    status?: string;
+  }
 }
 
 export interface SessionListResponse {
@@ -122,15 +153,43 @@ export interface SessionListResponse {
    */
   error_message?: string;
 
+  /**
+   * The stable LangSmith thread identifier for this session
+   */
+  langsmith_thread_id?: string;
+
   /**
    * The output of the session
    */
   output?: unknown;
 
+  /**
+   * Receipt that ACP restored the requested session resume state
+   */
+  session_resume_receipt?: SessionListResponse.SessionResumeReceipt;
+
   /**
    * The status of the session
    */
   status?: string;
+
+  /**
+   * Receipt for correlating agent.submission.settled events after create or
+   * append-message writes
+   */
+  submission_id?: string;
+}
+
+export namespace SessionListResponse {
+  /**
+   * Receipt that ACP restored the requested session resume state
+   */
+  export interface SessionResumeReceipt {
+    /**
+     * The session resume state restore status
+     */
+    status?: string;
+  }
 }
 
 export interface SessionRetrieveResponse {
@@ -164,15 +223,43 @@ export interface SessionRetrieveResponse {
    */
   error_message?: string;
 
+  /**
+   * The stable LangSmith thread identifier for this session
+   */
+  langsmith_thread_id?: string;
+
   /**
    * The output of the session
    */
   output?: unknown;
 
+  /**
+   * Receipt that ACP restored the requested session resume state
+   */
+  session_resume_receipt?: SessionRetrieveResponse.SessionResumeReceipt;
+
   /**
    * The status of the session
    */
   status?: string;
+
+  /**
+   * Receipt for correlating agent.submission.settled events after create or
+   * append-message writes
+   */
+  submission_id?: string;
+}
+
+export namespace SessionRetrieveResponse {
+  /**
+   * Receipt that ACP restored the requested session resume state
+   */
+  export interface SessionResumeReceipt {
+    /**
+     * The session resume state restore status
+     */
+    status?: string;
+  }
 }
 
 export interface SessionCreateParams {
@@ -185,6 +272,23 @@ export interface SessionCreateParams {
    * The prompt to send to the agent
    */
   prompt: string;
+
+  /**
+   * Optional opaque state used to restore the new session
+   */
+  session_resume_state?: SessionCreateParams.SessionResumeState;
+}
+
+export namespace SessionCreateParams {
+  /**
+   * Optional opaque state used to restore the new session
+   */
+  export interface SessionResumeState {
+    /**
+     * An opaque base64-encoded agent session resume state
+     */
+    artifact: string;
+  }
 }
 
 export interface SessionListParams {
@@ -200,6 +304,7 @@ export interface SessionListParams {
 }
 
 Sessions.Messages = Messages;
+Sessions.ResumeState = ResumeState;
 Sessions.Events = Events;
 
 export declare namespace Sessions {
@@ -218,6 +323,8 @@ export declare namespace Sessions {
     type MessageCreateParams as MessageCreateParams,
   };
 
+  export { ResumeState as ResumeState, type ResumeStateCreateResponse as ResumeStateCreateResponse };
+
   export {
     Events as Events,
     type EventRetrieveResponse as EventRetrieveResponse,

package/src/resources/background-check-candidates.ts

@@ -0,0 +1,434 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as BusinessPartnersAPI from './business-partners';
+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';
+
+/**
+ * Candidates who have been submitted for background check screening
+ */
+export class BackgroundCheckCandidates extends APIResource {
+  /**
+   * A list of background check candidates.
+   *
+   * - Requires: `API Tier 2`
+   * - Filterable fields: `external_id`, `email`, `created_at`, `updated_at`
+   * - Sortable fields: `created_at`, `updated_at`
+   */
+  list(
+    query: BackgroundCheckCandidateListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<BackgroundCheckCandidateListResponsesPageCursorURL, BackgroundCheckCandidateListResponse> {
+    return this._client.getAPIList(
+      '/background-check-candidates/',
+      PageCursorURL<BackgroundCheckCandidateListResponse>,
+      { query, ...options },
+    );
+  }
+
+  /**
+   * Create a new background check candidate
+   */
+  create(
+    body: BackgroundCheckCandidateCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<BackgroundCheckCandidateCreateResponse> {
+    return this._client.post('/background-check-candidates/', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific background check candidate
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<BackgroundCheckCandidateRetrieveResponse> {
+    return this._client.get(path`/background-check-candidates/${id}/`, options);
+  }
+
+  /**
+   * Update a specific background check candidate.
+   */
+  update(
+    id: string,
+    body: BackgroundCheckCandidateUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<BackgroundCheckCandidateUpdateResponse> {
+    return this._client.patch(path`/background-check-candidates/${id}/`, { body, ...options });
+  }
+
+  /**
+   * Delete a background check candidate
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/background-check-candidates/${id}/`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export type BackgroundCheckCandidateListResponsesPageCursorURL =
+  PageCursorURL<BackgroundCheckCandidateListResponse>;
+
+/**
+ * Background Check Candidate DTO.
+ *
+ *     Represents a candidate who has been submitted for background check screening.
+ *
+ *     Required on Create (but nullable on read for legacy rows):
+ *     - email: Required for new candidates, but may be null on read for legacy rows
+ *     - external_id: Required for new candidates, but may be null on read for legacy rows
+ *
+ *     Optional Fields:
+ *     - owner_id: May be null if no provider is associated
+ *     - first_name: May be null if name is not available
+ *     - last_name: May be null if name is not available
+ *     - middle_name: May be null if not provided
+ *
+ *     Sensitive Fields:
+ *     - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model
+ *     - These do not require separate OAuth scopes beyond the resource-level scopes
+ *       (background-check-candidates.read / .read-write) because they are not updating
+ *       role or worker data, only storing candidate names for background check processing
+ *
+ *     Note: first_name, last_name, and middle_name are NOT filterable.
+ *     Only external_id, email, created_at, and updated_at support filtering.
+ */
+export interface BackgroundCheckCandidateListResponse {
+  /**
+   * The email address of the candidate. Required on create, but may be null on read
+   * for legacy rows.
+   */
+  email: string;
+
+  /**
+   * The provider's unique identifier for the candidate. Required on create, but may
+   * be null on read for legacy rows. Can only be set once (during creation or when
+   * null). Cannot be changed after being set.
+   */
+  external_id: string;
+
+  /**
+   * The unique identifier of the background check candidate.
+   */
+  id?: string;
+
+  /**
+   * The timestamp when the candidate was created.
+   */
+  created_at?: string;
+
+  /**
+   * The first name of the candidate.
+   */
+  first_name?: string;
+
+  /**
+   * The last name of the candidate.
+   */
+  last_name?: string;
+
+  /**
+   * The middle name of the candidate.
+   */
+  middle_name?: string;
+
+  /**
+   * The ID of the background check provider (OAuth spoke owner).
+   */
+  owner_id?: string;
+
+  /**
+   * The timestamp when the candidate was last updated.
+   */
+  updated_at?: string;
+}
+
+/**
+ * Background Check Candidate DTO.
+ *
+ *     Represents a candidate who has been submitted for background check screening.
+ *
+ *     Required on Create (but nullable on read for legacy rows):
+ *     - email: Required for new candidates, but may be null on read for legacy rows
+ *     - external_id: Required for new candidates, but may be null on read for legacy rows
+ *
+ *     Optional Fields:
+ *     - owner_id: May be null if no provider is associated
+ *     - first_name: May be null if name is not available
+ *     - last_name: May be null if name is not available
+ *     - middle_name: May be null if not provided
+ *
+ *     Sensitive Fields:
+ *     - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model
+ *     - These do not require separate OAuth scopes beyond the resource-level scopes
+ *       (background-check-candidates.read / .read-write) because they are not updating
+ *       role or worker data, only storing candidate names for background check processing
+ *
+ *     Note: first_name, last_name, and middle_name are NOT filterable.
+ *     Only external_id, email, created_at, and updated_at support filtering.
+ */
+export interface BackgroundCheckCandidateCreateResponse {
+  /**
+   * The email address of the candidate. Required on create, but may be null on read
+   * for legacy rows.
+   */
+  email: string;
+
+  /**
+   * The provider's unique identifier for the candidate. Required on create, but may
+   * be null on read for legacy rows. Can only be set once (during creation or when
+   * null). Cannot be changed after being set.
+   */
+  external_id: string;
+
+  /**
+   * The unique identifier of the background check candidate.
+   */
+  id?: string;
+
+  /**
+   * The timestamp when the candidate was created.
+   */
+  created_at?: string;
+
+  /**
+   * The first name of the candidate.
+   */
+  first_name?: string;
+
+  /**
+   * The last name of the candidate.
+   */
+  last_name?: string;
+
+  /**
+   * The middle name of the candidate.
+   */
+  middle_name?: string;
+
+  /**
+   * The ID of the background check provider (OAuth spoke owner).
+   */
+  owner_id?: string;
+
+  /**
+   * The timestamp when the candidate was last updated.
+   */
+  updated_at?: string;
+}
+
+/**
+ * Meta information for the response.
+ */
+export interface BackgroundCheckCandidateRetrieveResponse extends BusinessPartnersAPI.Meta {
+  /**
+   * The email address of the candidate. Required on create, but may be null on read
+   * for legacy rows.
+   */
+  email: string;
+
+  /**
+   * The provider's unique identifier for the candidate. Required on create, but may
+   * be null on read for legacy rows. Can only be set once (during creation or when
+   * null). Cannot be changed after being set.
+   */
+  external_id: string;
+
+  /**
+   * The unique identifier of the background check candidate.
+   */
+  id?: string;
+
+  /**
+   * The timestamp when the candidate was created.
+   */
+  created_at?: string;
+
+  /**
+   * The first name of the candidate.
+   */
+  first_name?: string;
+
+  /**
+   * The last name of the candidate.
+   */
+  last_name?: string;
+
+  /**
+   * The middle name of the candidate.
+   */
+  middle_name?: string;
+
+  /**
+   * The ID of the background check provider (OAuth spoke owner).
+   */
+  owner_id?: string;
+
+  /**
+   * The timestamp when the candidate was last updated.
+   */
+  updated_at?: string;
+}
+
+/**
+ * Background Check Candidate DTO.
+ *
+ *     Represents a candidate who has been submitted for background check screening.
+ *
+ *     Required on Create (but nullable on read for legacy rows):
+ *     - email: Required for new candidates, but may be null on read for legacy rows
+ *     - external_id: Required for new candidates, but may be null on read for legacy rows
+ *
+ *     Optional Fields:
+ *     - owner_id: May be null if no provider is associated
+ *     - first_name: May be null if name is not available
+ *     - last_name: May be null if name is not available
+ *     - middle_name: May be null if not provided
+ *
+ *     Sensitive Fields:
+ *     - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model
+ *     - These do not require separate OAuth scopes beyond the resource-level scopes
+ *       (background-check-candidates.read / .read-write) because they are not updating
+ *       role or worker data, only storing candidate names for background check processing
+ *
+ *     Note: first_name, last_name, and middle_name are NOT filterable.
+ *     Only external_id, email, created_at, and updated_at support filtering.
+ */
+export interface BackgroundCheckCandidateUpdateResponse {
+  /**
+   * The email address of the candidate. Required on create, but may be null on read
+   * for legacy rows.
+   */
+  email: string;
+
+  /**
+   * The provider's unique identifier for the candidate. Required on create, but may
+   * be null on read for legacy rows. Can only be set once (during creation or when
+   * null). Cannot be changed after being set.
+   */
+  external_id: string;
+
+  /**
+   * The unique identifier of the background check candidate.
+   */
+  id?: string;
+
+  /**
+   * The timestamp when the candidate was created.
+   */
+  created_at?: string;
+
+  /**
+   * The first name of the candidate.
+   */
+  first_name?: string;
+
+  /**
+   * The last name of the candidate.
+   */
+  last_name?: string;
+
+  /**
+   * The middle name of the candidate.
+   */
+  middle_name?: string;
+
+  /**
+   * The ID of the background check provider (OAuth spoke owner).
+   */
+  owner_id?: string;
+
+  /**
+   * The timestamp when the candidate was last updated.
+   */
+  updated_at?: string;
+}
+
+export interface BackgroundCheckCandidateListParams {
+  cursor?: string;
+
+  filter?: string;
+
+  /**
+   * The maximum number of results to return. Defaults to 50. Maximum is 100.
+   */
+  limit?: number;
+
+  order_by?: string;
+}
+
+export interface BackgroundCheckCandidateCreateParams {
+  /**
+   * The email address of the candidate. Required on create, but may be null on read
+   * for legacy rows.
+   */
+  email: string;
+
+  /**
+   * The provider's unique identifier for the candidate. Required on create, but may
+   * be null on read for legacy rows. Can only be set once (during creation or when
+   * null). Cannot be changed after being set.
+   */
+  external_id: string;
+
+  /**
+   * The first name of the candidate.
+   */
+  first_name?: string;
+
+  /**
+   * The last name of the candidate.
+   */
+  last_name?: string;
+
+  /**
+   * The middle name of the candidate.
+   */
+  middle_name?: string;
+}
+
+export interface BackgroundCheckCandidateUpdateParams {
+  /**
+   * The email address of the candidate. Required on create, but may be null on read
+   * for legacy rows.
+   */
+  email: string;
+
+  /**
+   * The provider's unique identifier for the candidate. Required on create, but may
+   * be null on read for legacy rows. Can only be set once (during creation or when
+   * null). Cannot be changed after being set.
+   */
+  external_id: string;
+
+  /**
+   * The first name of the candidate.
+   */
+  first_name?: string;
+
+  /**
+   * The last name of the candidate.
+   */
+  last_name?: string;
+
+  /**
+   * The middle name of the candidate.
+   */
+  middle_name?: string;
+}
+
+export declare namespace BackgroundCheckCandidates {
+  export {
+    type BackgroundCheckCandidateListResponse as BackgroundCheckCandidateListResponse,
+    type BackgroundCheckCandidateCreateResponse as BackgroundCheckCandidateCreateResponse,
+    type BackgroundCheckCandidateRetrieveResponse as BackgroundCheckCandidateRetrieveResponse,
+    type BackgroundCheckCandidateUpdateResponse as BackgroundCheckCandidateUpdateResponse,
+    type BackgroundCheckCandidateListResponsesPageCursorURL as BackgroundCheckCandidateListResponsesPageCursorURL,
+    type BackgroundCheckCandidateListParams as BackgroundCheckCandidateListParams,
+    type BackgroundCheckCandidateCreateParams as BackgroundCheckCandidateCreateParams,
+    type BackgroundCheckCandidateUpdateParams as BackgroundCheckCandidateUpdateParams,
+  };
+}