@roarkanalytics/sdk 5.11.0 → 5.12.0

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

@@ -26,6 +26,25 @@ export declare class MetricCollectionJob extends APIResource {
      * ```
      */
     list(query?: MetricCollectionJobListParams | null | undefined, options?: RequestOptions): APIPromise<MetricCollectionJobListResponse>;
+    /**
+     * Stops a metric collection job that has not finished. No further conversations
+     * are processed and the job ends in CANCELED.
+     *
+     * Items the job had not reached are marked SKIPPED. Metric values already produced
+     * are kept, and items that were mid-computation when the cancel arrived may still
+     * complete. Only the items that completed are billed.
+     *
+     * Safe to call more than once: a job that has already finished (COMPLETED, FAILED,
+     * or CANCELED) is returned unchanged.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metricCollectionJob.cancel(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    cancel(jobID: string, options?: RequestOptions): APIPromise<MetricCollectionJobCancelResponse>;
     /**
      * Returns a specific metric collection job with progress information.
      *
@@ -58,7 +77,8 @@ export declare namespace MetricCollectionJobCreateResponse {
          */
         completedAt: string | null;
         /**
-         * Number of successfully completed items
+         * Number of items that finished without failing: a value was written, or the
+         * metric did not apply to the conversation
          */
         completedItems: number;
         /**
@@ -66,11 +86,13 @@ export declare namespace MetricCollectionJobCreateResponse {
          */
         createdAt: string;
         /**
-         * Error message if the job failed
+         * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+         * items failed
          */
         errorMessage: string | null;
         /**
-         * Number of failed items
+         * Number of items that could not be computed, for example because an artifact the
+         * metric reads (such as diarization) failed to generate
          */
         failedItems: number;
         /**
@@ -120,7 +142,8 @@ export declare namespace MetricCollectionJobListResponse {
          */
         completedAt: string | null;
         /**
-         * Number of successfully completed items
+         * Number of items that finished without failing: a value was written, or the
+         * metric did not apply to the conversation
          */
         completedItems: number;
         /**
@@ -128,11 +151,13 @@ export declare namespace MetricCollectionJobListResponse {
          */
         createdAt: string;
         /**
-         * Error message if the job failed
+         * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+         * items failed
          */
         errorMessage: string | null;
         /**
-         * Number of failed items
+         * Number of items that could not be computed, for example because an artifact the
+         * metric reads (such as diarization) failed to generate
          */
         failedItems: number;
         /**
@@ -175,6 +200,70 @@ export declare namespace MetricCollectionJobListResponse {
         total: number;
     }
 }
+export interface MetricCollectionJobCancelResponse {
+    /**
+     * A metric collection job that processes metrics for calls or chats
+     */
+    data: MetricCollectionJobCancelResponse.Data;
+}
+export declare namespace MetricCollectionJobCancelResponse {
+    /**
+     * A metric collection job that processes metrics for calls or chats
+     */
+    interface Data {
+        /**
+         * Unique identifier of the metric collection job
+         */
+        id: string;
+        /**
+         * When the job completed
+         */
+        completedAt: string | null;
+        /**
+         * Number of items that finished without failing: a value was written, or the
+         * metric did not apply to the conversation
+         */
+        completedItems: number;
+        /**
+         * When the job was created
+         */
+        createdAt: string;
+        /**
+         * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+         * items failed
+         */
+        errorMessage: string | null;
+        /**
+         * Number of items that could not be computed, for example because an artifact the
+         * metric reads (such as diarization) failed to generate
+         */
+        failedItems: number;
+        /**
+         * IDs of the metric policies that triggered this job
+         */
+        policyIds: Array<string>;
+        /**
+         * When the job started processing
+         */
+        startedAt: string | null;
+        /**
+         * Current status of the job
+         */
+        status: 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELED';
+        /**
+         * Total number of call-metric pairs to process
+         */
+        totalItems: number;
+        /**
+         * What triggered this job
+         */
+        triggeredBy: 'USER_MANUAL' | 'USER_API' | 'METRIC_POLICY' | 'SIMULATION';
+        /**
+         * When the job was last updated
+         */
+        updatedAt: string;
+    }
+}
 export interface MetricCollectionJobGetByIDResponse {
     /**
      * A metric collection job that processes metrics for calls or chats
@@ -195,7 +284,8 @@ export declare namespace MetricCollectionJobGetByIDResponse {
          */
         completedAt: string | null;
         /**
-         * Number of successfully completed items
+         * Number of items that finished without failing: a value was written, or the
+         * metric did not apply to the conversation
          */
         completedItems: number;
         /**
@@ -203,11 +293,13 @@ export declare namespace MetricCollectionJobGetByIDResponse {
          */
         createdAt: string;
         /**
-         * Error message if the job failed
+         * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+         * items failed
          */
         errorMessage: string | null;
         /**
-         * Number of failed items
+         * Number of items that could not be computed, for example because an artifact the
+         * metric reads (such as diarization) failed to generate
          */
         failedItems: number;
         /**
@@ -283,6 +375,6 @@ export interface MetricCollectionJobListParams {
     status?: 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELED';
 }
 export declare namespace MetricCollectionJob {
-    export { type MetricCollectionJobCreateResponse as MetricCollectionJobCreateResponse, type MetricCollectionJobListResponse as MetricCollectionJobListResponse, type MetricCollectionJobGetByIDResponse as MetricCollectionJobGetByIDResponse, type MetricCollectionJobCreateParams as MetricCollectionJobCreateParams, type MetricCollectionJobListParams as MetricCollectionJobListParams, };
+    export { type MetricCollectionJobCreateResponse as MetricCollectionJobCreateResponse, type MetricCollectionJobListResponse as MetricCollectionJobListResponse, type MetricCollectionJobCancelResponse as MetricCollectionJobCancelResponse, type MetricCollectionJobGetByIDResponse as MetricCollectionJobGetByIDResponse, type MetricCollectionJobCreateParams as MetricCollectionJobCreateParams, type MetricCollectionJobListParams as MetricCollectionJobListParams, };
 }
 //# sourceMappingURL=metric-collection-job.d.ts.map

package/resources/metric-collection-job.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"metric-collection-job.d.ts","sourceRoot":"","sources":["../src/resources/metric-collection-job.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;CAGjG;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;QAEvE;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,aAAa,GAAG,UAAU,GAAG,eAAe,GAAG,YAAY,CAAC;QAEzE;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,KAAK,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;IAElD,UAAU,EAAE,+BAA+B,CAAC,UAAU,CAAC;CACxD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;QAEvE;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,aAAa,GAAG,UAAU,GAAG,eAAe,GAAG,YAAY,CAAC;QAEzE;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,IAAI,EAAE,kCAAkC,CAAC,IAAI,CAAC;CAC/C;AAED,yBAAiB,kCAAkC,CAAC;IAClD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;QAEvE;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,aAAa,GAAG,UAAU,GAAG,eAAe,GAAG,YAAY,CAAC;QAEzE;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC;IAExD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;CACzE;AAED,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}
+{"version":3,"file":"metric-collection-job.d.ts","sourceRoot":"","sources":["../src/resources/metric-collection-job.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,IAAI,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,6BAA6B,GAAG,IAAI,GAAG,SAAc,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,+BAA+B,CAAC;IAI9C;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iCAAiC,CAAC;IAI9F;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kCAAkC,CAAC;CAGjG;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;QAEvE;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,aAAa,GAAG,UAAU,GAAG,eAAe,GAAG,YAAY,CAAC;QAEzE;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,KAAK,CAAC,+BAA+B,CAAC,IAAI,CAAC,CAAC;IAElD,UAAU,EAAE,+BAA+B,CAAC,UAAU,CAAC;CACxD;AAED,yBAAiB,+BAA+B,CAAC;IAC/C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;QAEvE;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,aAAa,GAAG,UAAU,GAAG,eAAe,GAAG,YAAY,CAAC;QAEzE;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC;CAC9C;AAED,yBAAiB,iCAAiC,CAAC;IACjD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;QAEvE;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,aAAa,GAAG,UAAU,GAAG,eAAe,GAAG,YAAY,CAAC;QAEzE;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,IAAI,EAAE,kCAAkC,CAAC,IAAI,CAAC;CAC/C;AAED,yBAAiB,kCAAkC,CAAC;IAClD;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEzB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;WAEG;QACH,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;QAEvE;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,aAAa,GAAG,UAAU,GAAG,eAAe,GAAG,YAAY,CAAC;QAEzE;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,+BAA+B;IAC9C;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC;IAExD;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,+BAA+B,CAAC;IAC/C,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;CACzE;AAED,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,6BAA6B,IAAI,6BAA6B,GACpE,CAAC;CACH"}

package/resources/metric-collection-job.js

@@ -33,6 +33,27 @@ class MetricCollectionJob extends resource_1.APIResource {
     list(query = {}, options) {
         return this._client.get('/v1/metric/collection-jobs', { query, ...options });
     }
+    /**
+     * Stops a metric collection job that has not finished. No further conversations
+     * are processed and the job ends in CANCELED.
+     *
+     * Items the job had not reached are marked SKIPPED. Metric values already produced
+     * are kept, and items that were mid-computation when the cancel arrived may still
+     * complete. Only the items that completed are billed.
+     *
+     * Safe to call more than once: a job that has already finished (COMPLETED, FAILED,
+     * or CANCELED) is returned unchanged.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metricCollectionJob.cancel(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    cancel(jobID, options) {
+        return this._client.post((0, path_1.path) `/v1/metric/collection-jobs/${jobID}/cancel`, options);
+    }
     /**
      * Returns a specific metric collection job with progress information.
      *

package/resources/metric-collection-job.js.map

@@ -1 +1 @@
-{"version":3,"file":"metric-collection-job.js","sourceRoot":"","sources":["../src/resources/metric-collection-job.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,mBAAoB,SAAQ,sBAAW;IAClD;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAa,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8BAA8B,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAlDD,kDAkDC"}
+{"version":3,"file":"metric-collection-job.js","sourceRoot":"","sources":["../src/resources/metric-collection-job.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAA8C;AAE9C,MAAa,mBAAoB,SAAQ,sBAAW;IAClD;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,8BAA8B,KAAK,SAAS,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAa,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,8BAA8B,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AAxED,kDAwEC"}

package/resources/metric-collection-job.mjs

@@ -30,6 +30,27 @@ export class MetricCollectionJob extends APIResource {
     list(query = {}, options) {
         return this._client.get('/v1/metric/collection-jobs', { query, ...options });
     }
+    /**
+     * Stops a metric collection job that has not finished. No further conversations
+     * are processed and the job ends in CANCELED.
+     *
+     * Items the job had not reached are marked SKIPPED. Metric values already produced
+     * are kept, and items that were mid-computation when the cancel arrived may still
+     * complete. Only the items that completed are billed.
+     *
+     * Safe to call more than once: a job that has already finished (COMPLETED, FAILED,
+     * or CANCELED) is returned unchanged.
+     *
+     * @example
+     * ```ts
+     * const response = await client.metricCollectionJob.cancel(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    cancel(jobID, options) {
+        return this._client.post(path `/v1/metric/collection-jobs/${jobID}/cancel`, options);
+    }
     /**
      * Returns a specific metric collection job with progress information.
      *

package/resources/metric-collection-job.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"metric-collection-job.mjs","sourceRoot":"","sources":["../src/resources/metric-collection-job.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAa,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8BAA8B,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF"}
+{"version":3,"file":"metric-collection-job.mjs","sourceRoot":"","sources":["../src/resources/metric-collection-job.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAG/C,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,OAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,4BAA4B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CACF,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,KAAa,EAAE,OAAwB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,8BAA8B,KAAK,SAAS,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAa,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,8BAA8B,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF"}

package/src/client.ts

@@ -204,6 +204,7 @@ import {
 } from './resources/metric';
 import {
   MetricCollectionJob,
+  MetricCollectionJobCancelResponse,
   MetricCollectionJobCreateParams,
   MetricCollectionJobCreateResponse,
   MetricCollectionJobGetByIDResponse,
@@ -1250,6 +1251,7 @@ export declare namespace Roark {
     MetricCollectionJob as MetricCollectionJob,
     type MetricCollectionJobCreateResponse as MetricCollectionJobCreateResponse,
     type MetricCollectionJobListResponse as MetricCollectionJobListResponse,
+    type MetricCollectionJobCancelResponse as MetricCollectionJobCancelResponse,
     type MetricCollectionJobGetByIDResponse as MetricCollectionJobGetByIDResponse,
     type MetricCollectionJobCreateParams as MetricCollectionJobCreateParams,
     type MetricCollectionJobListParams as MetricCollectionJobListParams,

package/src/resources/call.ts

@@ -560,7 +560,8 @@ export namespace CallAppendToolInvocationsResponse {
       completedAt: string | null;
 
       /**
-       * Number of successfully completed items
+       * Number of items that finished without failing: a value was written, or the
+       * metric did not apply to the conversation
        */
       completedItems: number;
 
@@ -570,12 +571,14 @@ export namespace CallAppendToolInvocationsResponse {
       createdAt: string;
 
       /**
-       * Error message if the job failed
+       * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+       * items failed
        */
       errorMessage: string | null;
 
       /**
-       * Number of failed items
+       * Number of items that could not be computed, for example because an artifact the
+       * metric reads (such as diarization) failed to generate
        */
       failedItems: number;
 
@@ -1764,7 +1767,8 @@ export namespace CallUpdatePropertiesResponse {
       completedAt: string | null;
 
       /**
-       * Number of successfully completed items
+       * Number of items that finished without failing: a value was written, or the
+       * metric did not apply to the conversation
        */
       completedItems: number;
 
@@ -1774,12 +1778,14 @@ export namespace CallUpdatePropertiesResponse {
       createdAt: string;
 
       /**
-       * Error message if the job failed
+       * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+       * items failed
        */
       errorMessage: string | null;
 
       /**
-       * Number of failed items
+       * Number of items that could not be computed, for example because an artifact the
+       * metric reads (such as diarization) failed to generate
        */
       failedItems: number;
 

package/src/resources/index.ts

@@ -189,6 +189,7 @@ export {
   MetricCollectionJob,
   type MetricCollectionJobCreateResponse,
   type MetricCollectionJobListResponse,
+  type MetricCollectionJobCancelResponse,
   type MetricCollectionJobGetByIDResponse,
   type MetricCollectionJobCreateParams,
   type MetricCollectionJobListParams,

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

@@ -42,6 +42,28 @@ export class MetricCollectionJob extends APIResource {
     return this._client.get('/v1/metric/collection-jobs', { query, ...options });
   }
 
+  /**
+   * Stops a metric collection job that has not finished. No further conversations
+   * are processed and the job ends in CANCELED.
+   *
+   * Items the job had not reached are marked SKIPPED. Metric values already produced
+   * are kept, and items that were mid-computation when the cancel arrived may still
+   * complete. Only the items that completed are billed.
+   *
+   * Safe to call more than once: a job that has already finished (COMPLETED, FAILED,
+   * or CANCELED) is returned unchanged.
+   *
+   * @example
+   * ```ts
+   * const response = await client.metricCollectionJob.cancel(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  cancel(jobID: string, options?: RequestOptions): APIPromise<MetricCollectionJobCancelResponse> {
+    return this._client.post(path`/v1/metric/collection-jobs/${jobID}/cancel`, options);
+  }
+
   /**
    * Returns a specific metric collection job with progress information.
    *
@@ -80,7 +102,8 @@ export namespace MetricCollectionJobCreateResponse {
     completedAt: string | null;
 
     /**
-     * Number of successfully completed items
+     * Number of items that finished without failing: a value was written, or the
+     * metric did not apply to the conversation
      */
     completedItems: number;
 
@@ -90,12 +113,14 @@ export namespace MetricCollectionJobCreateResponse {
     createdAt: string;
 
     /**
-     * Error message if the job failed
+     * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+     * items failed
      */
     errorMessage: string | null;
 
     /**
-     * Number of failed items
+     * Number of items that could not be computed, for example because an artifact the
+     * metric reads (such as diarization) failed to generate
      */
     failedItems: number;
 
@@ -156,7 +181,8 @@ export namespace MetricCollectionJobListResponse {
     completedAt: string | null;
 
     /**
-     * Number of successfully completed items
+     * Number of items that finished without failing: a value was written, or the
+     * metric did not apply to the conversation
      */
     completedItems: number;
 
@@ -166,12 +192,14 @@ export namespace MetricCollectionJobListResponse {
     createdAt: string;
 
     /**
-     * Error message if the job failed
+     * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+     * items failed
      */
     errorMessage: string | null;
 
     /**
-     * Number of failed items
+     * Number of items that could not be computed, for example because an artifact the
+     * metric reads (such as diarization) failed to generate
      */
     failedItems: number;
 
@@ -224,6 +252,83 @@ export namespace MetricCollectionJobListResponse {
   }
 }
 
+export interface MetricCollectionJobCancelResponse {
+  /**
+   * A metric collection job that processes metrics for calls or chats
+   */
+  data: MetricCollectionJobCancelResponse.Data;
+}
+
+export namespace MetricCollectionJobCancelResponse {
+  /**
+   * A metric collection job that processes metrics for calls or chats
+   */
+  export interface Data {
+    /**
+     * Unique identifier of the metric collection job
+     */
+    id: string;
+
+    /**
+     * When the job completed
+     */
+    completedAt: string | null;
+
+    /**
+     * Number of items that finished without failing: a value was written, or the
+     * metric did not apply to the conversation
+     */
+    completedItems: number;
+
+    /**
+     * When the job was created
+     */
+    createdAt: string;
+
+    /**
+     * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+     * items failed
+     */
+    errorMessage: string | null;
+
+    /**
+     * Number of items that could not be computed, for example because an artifact the
+     * metric reads (such as diarization) failed to generate
+     */
+    failedItems: number;
+
+    /**
+     * IDs of the metric policies that triggered this job
+     */
+    policyIds: Array<string>;
+
+    /**
+     * When the job started processing
+     */
+    startedAt: string | null;
+
+    /**
+     * Current status of the job
+     */
+    status: 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELED';
+
+    /**
+     * Total number of call-metric pairs to process
+     */
+    totalItems: number;
+
+    /**
+     * What triggered this job
+     */
+    triggeredBy: 'USER_MANUAL' | 'USER_API' | 'METRIC_POLICY' | 'SIMULATION';
+
+    /**
+     * When the job was last updated
+     */
+    updatedAt: string;
+  }
+}
+
 export interface MetricCollectionJobGetByIDResponse {
   /**
    * A metric collection job that processes metrics for calls or chats
@@ -247,7 +352,8 @@ export namespace MetricCollectionJobGetByIDResponse {
     completedAt: string | null;
 
     /**
-     * Number of successfully completed items
+     * Number of items that finished without failing: a value was written, or the
+     * metric did not apply to the conversation
      */
     completedItems: number;
 
@@ -257,12 +363,14 @@ export namespace MetricCollectionJobGetByIDResponse {
     createdAt: string;
 
     /**
-     * Error message if the job failed
+     * Why the job failed or, on a COMPLETED job with failedItems above 0, why those
+     * items failed
      */
     errorMessage: string | null;
 
     /**
-     * Number of failed items
+     * Number of items that could not be computed, for example because an artifact the
+     * metric reads (such as diarization) failed to generate
      */
     failedItems: number;
 
@@ -356,6 +464,7 @@ export declare namespace MetricCollectionJob {
   export {
     type MetricCollectionJobCreateResponse as MetricCollectionJobCreateResponse,
     type MetricCollectionJobListResponse as MetricCollectionJobListResponse,
+    type MetricCollectionJobCancelResponse as MetricCollectionJobCancelResponse,
     type MetricCollectionJobGetByIDResponse as MetricCollectionJobGetByIDResponse,
     type MetricCollectionJobCreateParams as MetricCollectionJobCreateParams,
     type MetricCollectionJobListParams as MetricCollectionJobListParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '5.11.0'; // x-release-please-version
+export const VERSION = '5.12.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "5.11.0";
+export declare const VERSION = "5.12.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.11.0'; // x-release-please-version
+exports.VERSION = '5.12.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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