@roarkanalytics/sdk 2.34.0 → 3.0.0

package/src/resources/health.ts

@@ -7,6 +7,11 @@ import { RequestOptions } from '../internal/request-options';
 export class Health extends APIResource {
   /**
    * Returns the health status of the API and its dependencies
+   *
+   * @example
+   * ```ts
+   * const health = await client.health.get();
+   * ```
    */
   get(options?: RequestOptions): APIPromise<HealthGetResponse> {
     return this._client.get('/health', options);

package/src/resources/http-request-definition.ts

@@ -9,6 +9,15 @@ export class HTTPRequestDefinition extends APIResource {
   /**
    * Creates a new HTTP request definition. The signing secret is only returned in
    * this response and cannot be retrieved later.
+   *
+   * @example
+   * ```ts
+   * const httpRequestDefinition =
+   *   await client.httpRequestDefinition.create({
+   *     scope: 'AGENT_OUTBOUND_DIAL',
+   *     url: 'https://example.com',
+   *   });
+   * ```
    */
   create(
     body: HTTPRequestDefinitionCreateParams,
@@ -19,6 +28,12 @@ export class HTTPRequestDefinition extends APIResource {
 
   /**
    * Updates an existing HTTP request definition.
+   *
+   * @example
+   * ```ts
+   * const httpRequestDefinition =
+   *   await client.httpRequestDefinition.update('definitionId');
+   * ```
    */
   update(
     definitionID: string,
@@ -31,6 +46,12 @@ export class HTTPRequestDefinition extends APIResource {
   /**
    * Returns a paginated list of HTTP request definitions for the authenticated
    * project.
+   *
+   * @example
+   * ```ts
+   * const httpRequestDefinitions =
+   *   await client.httpRequestDefinition.list();
+   * ```
    */
   list(
     query: HTTPRequestDefinitionListParams | null | undefined = {},
@@ -41,6 +62,14 @@ export class HTTPRequestDefinition extends APIResource {
 
   /**
    * Returns a specific HTTP request definition by its ID.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.httpRequestDefinition.getByID(
+   *     'definitionId',
+   *   );
+   * ```
    */
   getByID(definitionID: string, options?: RequestOptions): APIPromise<HTTPRequestDefinitionGetByIDResponse> {
     return this._client.get(path`/v1/http-request-definition/${definitionID}`, options);

package/src/resources/index.ts

@@ -36,6 +36,7 @@ export {
 export {
   Config,
   type Bundle,
+  type ConfigFlowStep,
   type ConfigApplyResponse,
   type ConfigDiffResponse,
   type ConfigApplyParams,

package/src/resources/metric-collection-job.ts

@@ -9,6 +9,16 @@ export class MetricCollectionJob extends APIResource {
   /**
    * Creates a metric collection job for the specified calls or chats and metrics,
    * then triggers processing. Provide exactly one of callIds or chatIds.
+   *
+   * @example
+   * ```ts
+   * const metricCollectionJob =
+   *   await client.metricCollectionJob.create({
+   *     metrics: [
+   *       { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
+   *     ],
+   *   });
+   * ```
    */
   create(
     body: MetricCollectionJobCreateParams,
@@ -19,6 +29,12 @@ export class MetricCollectionJob extends APIResource {
 
   /**
    * Returns a paginated list of metric collection jobs for the project.
+   *
+   * @example
+   * ```ts
+   * const metricCollectionJobs =
+   *   await client.metricCollectionJob.list();
+   * ```
    */
   list(
     query: MetricCollectionJobListParams | null | undefined = {},
@@ -29,6 +45,13 @@ export class MetricCollectionJob extends APIResource {
 
   /**
    * Returns a specific metric collection job with progress information.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metricCollectionJob.getByID(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   getByID(jobID: string, options?: RequestOptions): APIPromise<MetricCollectionJobGetByIDResponse> {
     return this._client.get(path`/v1/metric/collection-jobs/${jobID}`, options);

package/src/resources/metric.ts

@@ -32,6 +32,11 @@ export class Metric extends APIResource {
   /**
    * Fetch all metric definitions available in the project, including both
    * system-generated and custom metrics.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metric.listDefinitions();
+   * ```
    */
   listDefinitions(options?: RequestOptions): APIPromise<MetricListDefinitionsResponse> {
     return this._client.get('/v1/metric/definitions', options);
@@ -1233,24 +1238,6 @@ export declare namespace MetricCreateDefinitionParams {
 
       sourceVariantId?: string;
     }
-
-    export interface Trigger {
-      operator:
-        | 'GREATER_THAN'
-        | 'GREATER_THAN_OR_EQUALS'
-        | 'LESS_THAN'
-        | 'LESS_THAN_OR_EQUALS'
-        | 'EQUALS'
-        | 'NOT_EQUALS';
-
-      sourceMetricDefinitionId: string;
-
-      thresholdValue: string;
-
-      sourceParticipantRole?: 'AGENT' | 'CUSTOMER' | 'SIMULATED_CUSTOMER' | 'BACKGROUND_SPEAKER';
-
-      sourceVariantId?: string;
-    }
   }
 }
 

package/src/resources/simulation-environment.ts

@@ -10,6 +10,12 @@ export class SimulationEnvironment extends APIResource {
    * Returns a paginated list of environments: the project's own plus the
    * environments Roark curates and shares across every project. Reference one by id
    * when setting a customer flow variant's environment.
+   *
+   * @example
+   * ```ts
+   * const simulationEnvironments =
+   *   await client.simulationEnvironment.list();
+   * ```
    */
   list(
     query: SimulationEnvironmentListParams | null | undefined = {},
@@ -20,6 +26,13 @@ export class SimulationEnvironment extends APIResource {
 
   /**
    * Returns a single environment by its ID.
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulationEnvironment.getByID(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   getByID(environmentID: string, options?: RequestOptions): APIPromise<SimulationEnvironmentGetByIDResponse> {
     return this._client.get(path`/v1/simulation/environment/${environmentID}`, options);

package/src/resources/simulation-job.ts

@@ -17,7 +17,7 @@ export class SimulationJob extends APIResource {
    * );
    * ```
    */
-  getByID(jobID: unknown, options?: RequestOptions): APIPromise<SimulationJobGetByIDResponse> {
+  getByID(jobID: string, options?: RequestOptions): APIPromise<SimulationJobGetByIDResponse> {
     return this._client.get(path`/v1/simulation/job/${jobID}`, options);
   }
 
@@ -28,7 +28,7 @@ export class SimulationJob extends APIResource {
    * @example
    * ```ts
    * const response = await client.simulationJob.lookup({
-   *   roarkPhoneNumber: {},
+   *   roarkPhoneNumber: 'roarkPhoneNumber',
    * });
    * ```
    */
@@ -178,6 +178,12 @@ export namespace SimulationJobGetByIDResponse {
         | 'PT'
         | 'IL';
 
+      /**
+       * How old the caller sounds and behaves. Only ages the persona's accent has a
+       * voice for are accepted; defaults to ADULT, which every accent supports.
+       */
+      age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
       /**
        * Background noise setting
        */
@@ -515,6 +521,12 @@ export namespace SimulationJobLookupResponse {
         | 'PT'
         | 'IL';
 
+      /**
+       * How old the caller sounds and behaves. Only ages the persona's accent has a
+       * voice for are accepted; defaults to ADULT, which every accent supports.
+       */
+      age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
       /**
        * Background noise setting
        */
@@ -720,14 +732,14 @@ export interface SimulationJobLookupParams {
    * case of an inbound simulation, this is the number that calls your agent; in the
    * case of an outbound simulation, this is the number you call from your agent.
    */
-  roarkPhoneNumber: unknown;
+  roarkPhoneNumber: string;
 
   /**
    * ISO 8601 timestamp of when the call was received. Alternatively, any time
    * between the start and end of the call is valid. Defaults to the current time,
    * which fetches any jobs that are currently ongoing.
    */
-  callReceivedAt?: unknown;
+  callReceivedAt?: string;
 }
 
 export declare namespace SimulationJob {

package/src/resources/simulation-persona.ts

@@ -65,9 +65,8 @@ export class SimulationPersona extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.simulationPersona.getByID(
-   *   'personaId',
-   * );
+   * const response =
+   *   await client.simulationPersona.getByID('personaId');
    * ```
    */
   getByID(personaID: string, options?: RequestOptions): APIPromise<SimulationPersonaGetByIDResponse> {
@@ -115,6 +114,12 @@ export namespace SimulationPersonaCreateResponse {
       | 'PT'
       | 'IL';
 
+    /**
+     * How old the caller sounds and behaves. Only ages the persona's accent has a
+     * voice for are accepted; defaults to ADULT, which every accent supports.
+     */
+    age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
     /**
      * Background noise setting
      */
@@ -320,6 +325,12 @@ export namespace SimulationPersonaUpdateResponse {
       | 'PT'
       | 'IL';
 
+    /**
+     * How old the caller sounds and behaves. Only ages the persona's accent has a
+     * voice for are accepted; defaults to ADULT, which every accent supports.
+     */
+    age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
     /**
      * Background noise setting
      */
@@ -527,6 +538,12 @@ export namespace SimulationPersonaListResponse {
       | 'PT'
       | 'IL';
 
+    /**
+     * How old the caller sounds and behaves. Only ages the persona's accent has a
+     * voice for are accepted; defaults to ADULT, which every accent supports.
+     */
+    age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
     /**
      * Background noise setting
      */
@@ -749,6 +766,12 @@ export namespace SimulationPersonaGetByIDResponse {
       | 'PT'
       | 'IL';
 
+    /**
+     * How old the caller sounds and behaves. Only ages the persona's accent has a
+     * voice for are accepted; defaults to ADULT, which every accent supports.
+     */
+    age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
     /**
      * Background noise setting
      */
@@ -977,6 +1000,12 @@ export interface SimulationPersonaCreateParams {
    */
   name: string;
 
+  /**
+   * How old the caller sounds and behaves. Only ages the persona's accent has a
+   * voice for are accepted; defaults to ADULT, which every accent supports.
+   */
+  age?: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
   /**
    * Background noise setting
    */
@@ -1128,6 +1157,12 @@ export interface SimulationPersonaUpdateParams {
     | 'PT'
     | 'IL';
 
+  /**
+   * How old the caller sounds and behaves. Only ages the persona's accent has a
+   * voice for are accepted; defaults to ADULT, which every accent supports.
+   */
+  age?: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
   /**
    * Background noise setting
    */

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

@@ -34,7 +34,7 @@ export class SimulationRunPlanJob extends APIResource {
    * );
    * ```
    */
-  getByID(jobID: unknown, options?: RequestOptions): APIPromise<SimulationRunPlanJobGetByIDResponse> {
+  getByID(jobID: string, options?: RequestOptions): APIPromise<SimulationRunPlanJobGetByIDResponse> {
     return this._client.get(path`/v1/simulation/plan/job/${jobID}`, options);
   }
 
@@ -47,9 +47,16 @@ export class SimulationRunPlanJob extends APIResource {
    * provide runtime variables to override plan-defined variables.
    *
    * @deprecated
+   *
+   * @example
+   * ```ts
+   * const response = await client.simulationRunPlanJob.start(
+   *   '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
+   * );
+   * ```
    */
   start(
-    planID: unknown,
+    planID: string,
     body: SimulationRunPlanJobStartParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<SimulationRunPlanJobStartResponse> {
@@ -341,6 +348,12 @@ export namespace SimulationRunPlanJobGetByIDResponse {
           | 'PT'
           | 'IL';
 
+        /**
+         * How old the caller sounds and behaves. Only ages the persona's accent has a
+         * voice for are accepted; defaults to ADULT, which every accent supports.
+         */
+        age: 'CHILD' | 'TEENAGER' | 'ADULT' | 'ELDERLY';
+
         /**
          * Background noise setting
          */

package/src/resources/simulation.ts

@@ -17,9 +17,9 @@ export class Simulation extends APIResource {
    * const response = await client.simulation.run({
    *   plan: {
    *     agentEndpoints: [
-   *       { id: '7c9e6679-7425-40de-944b-e07fc1f90ae7' },
+   *       { id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
    *     ],
-   *     direction: 'OUTBOUND',
+   *     direction: 'INBOUND',
    *     maxSimulationDurationSeconds: 300,
    *     metrics: [{}],
    *   },

package/src/resources/webhook.ts

@@ -9,6 +9,14 @@ export class Webhook extends APIResource {
   /**
    * Creates a new webhook with event subscriptions. The signing secret is only
    * returned in this response.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhook.create({
+   *   events: ['CALL_ANALYSIS_COMPLETED'],
+   *   url: 'https://example.com',
+   * });
+   * ```
    */
   create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse> {
     return this._client.post('/v1/webhook', { body, ...options });
@@ -16,6 +24,11 @@ export class Webhook extends APIResource {
 
   /**
    * Returns a paginated list of webhooks with their event subscriptions.
+   *
+   * @example
+   * ```ts
+   * const webhooks = await client.webhook.list();
+   * ```
    */
   list(
     query: WebhookListParams | null | undefined = {},
@@ -26,6 +39,11 @@ export class Webhook extends APIResource {
 
   /**
    * Deletes a webhook and all its event subscriptions.
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhook.delete('webhookId');
+   * ```
    */
   delete(webhookID: string, options?: RequestOptions): APIPromise<WebhookDeleteResponse> {
     return this._client.delete(path`/v1/webhook/${webhookID}`, options);
@@ -33,6 +51,11 @@ export class Webhook extends APIResource {
 
   /**
    * Returns a specific webhook with its event subscriptions.
+   *
+   * @example
+   * ```ts
+   * const response = await client.webhook.getByID('webhookId');
+   * ```
    */
   getByID(webhookID: string, options?: RequestOptions): APIPromise<WebhookGetByIDResponse> {
     return this._client.get(path`/v1/webhook/${webhookID}`, options);

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.34.0'; // x-release-please-version
+export const VERSION = '3.0.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

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

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

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

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}