@roarkanalytics/sdk 5.15.0 → 5.17.0

package/src/resources/phone-number.ts

@@ -0,0 +1,472 @@
+// 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';
+
+export class PhoneNumber extends APIResource {
+  /**
+   * Buys a number from the carrier for this project. Free inside the plan allowance;
+   * past it, the first month of rent is charged now and monthly after that.
+   *
+   * @example
+   * ```ts
+   * const phoneNumber = await client.phoneNumber.create({
+   *   e164: '+14155550123',
+   * });
+   * ```
+   */
+  create(body: PhoneNumberCreateParams, options?: RequestOptions): APIPromise<PhoneNumberCreateResponse> {
+    return this._client.post('/v1/phone-number', { body, ...options });
+  }
+
+  /**
+   * Relabels a number or changes which agent it is assigned to. A field left out is
+   * untouched; null clears it.
+   *
+   * @example
+   * ```ts
+   * const phoneNumber = await client.phoneNumber.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  update(
+    phoneNumberID: string,
+    body: PhoneNumberUpdateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberUpdateResponse> {
+    return this._client.put(path`/v1/phone-number/${phoneNumberID}`, { body, ...options });
+  }
+
+  /**
+   * Returns the phone numbers the project owns, oldest first, with the agent each is
+   * assigned to.
+   *
+   * @example
+   * ```ts
+   * const phoneNumbers = await client.phoneNumber.list();
+   * ```
+   */
+  list(
+    query: PhoneNumberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberListResponse> {
+    return this._client.get('/v1/phone-number', { query, ...options });
+  }
+
+  /**
+   * Gives the number back to the carrier. This cannot be undone: rent stops today
+   * and nothing is refunded.
+   *
+   * @example
+   * ```ts
+   * const phoneNumber = await client.phoneNumber.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  delete(phoneNumberID: string, options?: RequestOptions): APIPromise<PhoneNumberDeleteResponse> {
+    return this._client.delete(path`/v1/phone-number/${phoneNumberID}`, options);
+  }
+
+  /**
+   * Returns how many numbers the organization gets for free, how many it holds, what
+   * a paid number costs a month, and whether a purchase would be admitted right now.
+   *
+   * @example
+   * ```ts
+   * const response = await client.phoneNumber.getAllowance();
+   * ```
+   */
+  getAllowance(options?: RequestOptions): APIPromise<PhoneNumberGetAllowanceResponse> {
+    return this._client.get('/v1/phone-number/allowance', options);
+  }
+
+  /**
+   * Returns US numbers the carrier has for sale, narrowed by area code or by digits
+   * the number must contain. Buy one with POST /v1/phone-number.
+   *
+   * @example
+   * ```ts
+   * const response = await client.phoneNumber.listAvailable();
+   * ```
+   */
+  listAvailable(
+    query: PhoneNumberListAvailableParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberListAvailableResponse> {
+    return this._client.get('/v1/phone-number/available', { query, ...options });
+  }
+}
+
+export interface PhoneNumberCreateResponse {
+  /**
+   * A phone number the project owns
+   */
+  data: PhoneNumberCreateResponse.Data;
+}
+
+export namespace PhoneNumberCreateResponse {
+  /**
+   * A phone number the project owns
+   */
+  export interface Data {
+    /**
+     * Phone number ID
+     */
+    id: string;
+
+    /**
+     * The agent the number is assigned to, if any
+     */
+    agentId: string | null;
+
+    /**
+     * The number in E.164 format
+     */
+    e164: string;
+
+    /**
+     * Whether the number sits inside the plan free allowance right now
+     */
+    isFree: boolean;
+
+    /**
+     * ISO 3166-2 code of the region the number is from, when the carrier gave one
+     */
+    localityCode: string | null;
+
+    /**
+     * What a month of this number costs in micro-dollars; 0 while it is free
+     */
+    monthlyRentMicros: number;
+
+    /**
+     * Label the project gave the number
+     */
+    name: string | null;
+
+    /**
+     * When the number was bought (ISO 8601)
+     */
+    purchasedAt: string;
+
+    /**
+     * When the next month of rent is due (ISO 8601)
+     */
+    rentNextChargeAt: string;
+  }
+}
+
+export interface PhoneNumberUpdateResponse {
+  /**
+   * A phone number the project owns
+   */
+  data: PhoneNumberUpdateResponse.Data;
+}
+
+export namespace PhoneNumberUpdateResponse {
+  /**
+   * A phone number the project owns
+   */
+  export interface Data {
+    /**
+     * Phone number ID
+     */
+    id: string;
+
+    /**
+     * The agent the number is assigned to, if any
+     */
+    agentId: string | null;
+
+    /**
+     * The number in E.164 format
+     */
+    e164: string;
+
+    /**
+     * Whether the number sits inside the plan free allowance right now
+     */
+    isFree: boolean;
+
+    /**
+     * ISO 3166-2 code of the region the number is from, when the carrier gave one
+     */
+    localityCode: string | null;
+
+    /**
+     * What a month of this number costs in micro-dollars; 0 while it is free
+     */
+    monthlyRentMicros: number;
+
+    /**
+     * Label the project gave the number
+     */
+    name: string | null;
+
+    /**
+     * When the number was bought (ISO 8601)
+     */
+    purchasedAt: string;
+
+    /**
+     * When the next month of rent is due (ISO 8601)
+     */
+    rentNextChargeAt: string;
+  }
+}
+
+export interface PhoneNumberListResponse {
+  data: Array<PhoneNumberListResponse.Data>;
+}
+
+export namespace PhoneNumberListResponse {
+  /**
+   * A phone number the project owns
+   */
+  export interface Data {
+    /**
+     * Phone number ID
+     */
+    id: string;
+
+    /**
+     * The agent the number is assigned to, if any
+     */
+    agentId: string | null;
+
+    /**
+     * The number in E.164 format
+     */
+    e164: string;
+
+    /**
+     * Whether the number sits inside the plan free allowance right now
+     */
+    isFree: boolean;
+
+    /**
+     * ISO 3166-2 code of the region the number is from, when the carrier gave one
+     */
+    localityCode: string | null;
+
+    /**
+     * What a month of this number costs in micro-dollars; 0 while it is free
+     */
+    monthlyRentMicros: number;
+
+    /**
+     * Label the project gave the number
+     */
+    name: string | null;
+
+    /**
+     * When the number was bought (ISO 8601)
+     */
+    purchasedAt: string;
+
+    /**
+     * When the next month of rent is due (ISO 8601)
+     */
+    rentNextChargeAt: string;
+  }
+}
+
+export interface PhoneNumberDeleteResponse {
+  /**
+   * Confirmation that a phone number was released
+   */
+  data: PhoneNumberDeleteResponse.Data;
+}
+
+export namespace PhoneNumberDeleteResponse {
+  /**
+   * Confirmation that a phone number was released
+   */
+  export interface Data {
+    /**
+     * Phone number ID
+     */
+    id: string;
+
+    /**
+     * Always true; the number is gone and rent has stopped
+     */
+    released: true;
+  }
+}
+
+export interface PhoneNumberGetAllowanceResponse {
+  /**
+   * How many numbers the organization gets for free and whether it may buy the next
+   * one
+   */
+  data: PhoneNumberGetAllowanceResponse.Data;
+}
+
+export namespace PhoneNumberGetAllowanceResponse {
+  /**
+   * How many numbers the organization gets for free and whether it may buy the next
+   * one
+   */
+  export interface Data {
+    /**
+     * Why a purchase would be refused; null when canPurchase is true
+     */
+    blockedReason:
+      | 'PAYMENT_METHOD_REQUIRED'
+      | 'INSUFFICIENT_CREDITS'
+      | 'SPEND_CAP_REACHED'
+      | 'PLAN_LIMIT_REACHED'
+      | null;
+
+    /**
+     * Whether a purchase would be admitted right now
+     */
+    canPurchase: boolean;
+
+    /**
+     * Numbers included at no charge
+     */
+    freeLimit: number;
+
+    /**
+     * True when the free allowance comes from a per-organization override
+     */
+    isOverridden: boolean;
+
+    /**
+     * What one paid number costs a month, in micro-dollars
+     */
+    monthlyRentMicros: number;
+
+    /**
+     * Whether the next number would be free
+     */
+    nextIsFree: boolean;
+
+    /**
+     * How many of those sit outside the free allowance
+     */
+    paidCount: number;
+
+    /**
+     * The billing plan the allowance comes from
+     */
+    plan: 'PAYG' | 'TEAM' | 'ENTERPRISE';
+
+    /**
+     * Numbers the organization holds right now
+     */
+    used: number;
+  }
+}
+
+export interface PhoneNumberListAvailableResponse {
+  data: Array<PhoneNumberListAvailableResponse.Data>;
+}
+
+export namespace PhoneNumberListAvailableResponse {
+  /**
+   * A number the carrier has for sale
+   */
+  export interface Data {
+    /**
+     * The number in E.164 format
+     */
+    e164: string;
+
+    /**
+     * Locality the carrier lists, e.g. a city
+     */
+    locality: string | null;
+
+    /**
+     * Region the carrier lists, e.g. a state code
+     */
+    region: string | null;
+  }
+}
+
+export interface PhoneNumberCreateParams {
+  /**
+   * The number to buy, in E.164 format, from a search result
+   */
+  e164: string;
+
+  /**
+   * The agent to assign the number to
+   */
+  agentId?: string;
+
+  /**
+   * Whether you expect this number to be free (from the allowance). The purchase is
+   * refused with 409 if that has changed since you checked.
+   */
+  expectFree?: boolean;
+
+  /**
+   * The monthly rent you expect for a paid number, in micros (from the allowance).
+   * The purchase is refused with 409 if that has changed since you checked.
+   */
+  expectMonthlyRentMicros?: number;
+
+  /**
+   * A label for the number
+   */
+  name?: string;
+}
+
+export interface PhoneNumberUpdateParams {
+  /**
+   * Agent to assign the number to; null unassigns, omit to leave it alone
+   */
+  agentId?: string | null;
+
+  /**
+   * New label; null clears it, omit to leave it alone
+   */
+  name?: string | null;
+}
+
+export interface PhoneNumberListParams {
+  /**
+   * Only the numbers assigned to this agent
+   */
+  agentId?: string;
+}
+
+export interface PhoneNumberListAvailableParams {
+  /**
+   * Three-digit US area code
+   */
+  areaCode?: string;
+
+  /**
+   * Digits or letters the number must contain (1 to 7, \* matches any digit)
+   */
+  contains?: string;
+
+  /**
+   * Maximum number of results (default: 20, max: 50)
+   */
+  limit?: number;
+}
+
+export declare namespace PhoneNumber {
+  export {
+    type PhoneNumberCreateResponse as PhoneNumberCreateResponse,
+    type PhoneNumberUpdateResponse as PhoneNumberUpdateResponse,
+    type PhoneNumberListResponse as PhoneNumberListResponse,
+    type PhoneNumberDeleteResponse as PhoneNumberDeleteResponse,
+    type PhoneNumberGetAllowanceResponse as PhoneNumberGetAllowanceResponse,
+    type PhoneNumberListAvailableResponse as PhoneNumberListAvailableResponse,
+    type PhoneNumberCreateParams as PhoneNumberCreateParams,
+    type PhoneNumberUpdateParams as PhoneNumberUpdateParams,
+    type PhoneNumberListParams as PhoneNumberListParams,
+    type PhoneNumberListAvailableParams as PhoneNumberListAvailableParams,
+  };
+}

package/src/resources/simulation-run-plan-job.ts

@@ -1627,7 +1627,8 @@ export namespace SimulationRunPlanJobGetCostResponse {
         | 'METRIC'
         | 'TRANSCRIPTION'
         | 'INTERNAL_LLM'
-        | 'INTERNAL_STT';
+        | 'INTERNAL_STT'
+        | 'PHONE_NUMBER';
 
       /**
        * SIMULATION or POST_CALL.
@@ -1681,7 +1682,8 @@ export namespace SimulationRunPlanJobGetCostResponse {
           | 'METRIC'
           | 'TRANSCRIPTION'
           | 'INTERNAL_LLM'
-          | 'INTERNAL_STT';
+          | 'INTERNAL_STT'
+          | 'PHONE_NUMBER';
 
         /**
          * SIMULATION or POST_CALL.

package/src/resources/simulation.ts

@@ -198,6 +198,7 @@ export interface SimulationMockToolParams {
 export type SimulationRunParams =
   | SimulationRunParams.RunSimulationFromConfig
   | SimulationRunParams.RunSimulationFromPlanID
+  | SimulationRunParams.RunSimulationFromConfigKey
   | SimulationRunParams.RunSimulationFromTemplate;
 
 export declare namespace SimulationRunParams {
@@ -784,6 +785,81 @@ export declare namespace SimulationRunParams {
     }
   }
 
+  export interface RunSimulationFromConfigKey {
+    /**
+     * The config key of a plan to run, as applied from config as code
+     * (`simulationPlan/<name>`). Runs a config-managed plan by name, with no id
+     * lookup. Unique per project.
+     */
+    planConfigKey: string;
+
+    /**
+     * Values for the {{variables}} the run resolves, overriding whatever the plan has
+     * pinned.
+     *
+     * An object applies them to the whole run:
+     *
+     * { "orderNumber": "12345", "tier": "gold" }
+     *
+     * An array applies them per flow, or to just its happy path or one of its edge
+     * cases, when a single set will not do. Each entry carries what it applies to:
+     *
+     * [ { "flowId": "550e8400-...", "variables": { "orderNumber": "12345" } }, {
+     * "flowId": "550e8400-...", "happyPath": true, "variables": { "orderNumber":
+     * "55555" } }, { "flowId": "550e8400-...", "edgeCaseId": "7a3d2e1f-...",
+     * "variables": { "orderNumber": "67890" } } ]
+     *
+     * An entry that narrows to neither covers everything that flow resolves. A flow
+     * this plan does not attach, or an edge case that does not belong to the flow, is
+     * rejected rather than ignored.
+     *
+     * A plan built on scenarios rather than customer flows targets them the same way,
+     * with `scenarioId` in place of `flowId`. That form is deprecated alongside
+     * scenarios themselves, and still accepted so runs against those plans keep
+     * working.
+     */
+    variables?:
+      | { [key: string]: string }
+      | Array<RunSimulationFromConfigKey.UnionMember1>
+      | Array<RunSimulationFromConfigKey.UnionMember2>;
+  }
+
+  export namespace RunSimulationFromConfigKey {
+    export interface UnionMember1 {
+      /**
+       * A customer flow this plan runs.
+       */
+      flowId: string;
+
+      /**
+       * The values to apply.
+       */
+      variables: { [key: string]: string };
+
+      /**
+       * Narrow to one edge case of that flow.
+       */
+      edgeCaseId?: string;
+
+      /**
+       * Narrow to the flow's happy path.
+       */
+      happyPath?: true;
+    }
+
+    export interface UnionMember2 {
+      /**
+       * ID of the scenario to apply variables to
+       */
+      scenarioId: string;
+
+      /**
+       * Key-value pairs for this scenario
+       */
+      variables: { [key: string]: string };
+    }
+  }
+
   export interface RunSimulationFromTemplate {
     /**
      * The agent endpoints to call. No template can know these.

package/src/resources/usage.ts

@@ -115,7 +115,8 @@ export namespace UsageGetResponse {
           | 'METRIC'
           | 'TRANSCRIPTION'
           | 'INTERNAL_LLM'
-          | 'INTERNAL_STT';
+          | 'INTERNAL_STT'
+          | 'PHONE_NUMBER';
 
         /**
          * Whether this cost came from a SIMULATION or a production call (POST_CALL).

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.15.0'; // x-release-please-version
+export const VERSION = '5.17.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.15.0";
+export declare const VERSION = "5.17.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.15.0";
+export declare const VERSION = "5.17.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

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

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '5.15.0'; // x-release-please-version
+export const VERSION = '5.17.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map