@roarkanalytics/sdk 2.5.0 → 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 2.7.0 (2025-09-05)
4
+
5
+ Full Changelog: [v2.6.0...v2.7.0](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v2.6.0...v2.7.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([1aa6d12](https://github.com/roarkhq/sdk-roark-analytics-node/commit/1aa6d12a96f4269c7b8a51806207696b86d4e2fc))
10
+
11
+ ## 2.6.0 (2025-09-04)
12
+
13
+ Full Changelog: [v2.5.0...v2.6.0](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v2.5.0...v2.6.0)
14
+
15
+ ### Features
16
+
17
+ * **api:** manual updates ([1fdf365](https://github.com/roarkhq/sdk-roark-analytics-node/commit/1fdf365e44817dbfaea81d0a64ff691ca4ce7d36))
18
+
3
19
  ## 2.5.0 (2025-09-04)
4
20
 
5
21
  Full Changelog: [v2.4.1...v2.5.0](https://github.com/roarkhq/sdk-roark-analytics-node/compare/v2.4.1...v2.5.0)
package/index.d.mts CHANGED
@@ -7,7 +7,7 @@ import { Call, CallGetEvaluationRunsResponse, CallGetSentimentRunsResponse } fro
7
7
  import { Evaluation, EvaluationCreateJobParams, EvaluationCreateJobResponse, EvaluationGetEvaluatorByIDResponse, EvaluationGetEvaluatorsParams, EvaluationGetEvaluatorsResponse, EvaluationGetJobResponse, EvaluationGetJobRunsParams, EvaluationGetJobRunsResponse } from "./resources/evaluation.js";
8
8
  import { Health, HealthGetResponse } from "./resources/health.js";
9
9
  import { IntegrationCreateRetellCallParams, IntegrationCreateRetellCallResponse, IntegrationCreateVapiCallParams, IntegrationCreateVapiCallResponse, Integrations } from "./resources/integrations.js";
10
- import { Simulation, SimulationGetJobByIDResponse, SimulationGetJobParams, SimulationGetJobResponse } from "./resources/simulation.js";
10
+ import { Simulation, SimulationGetJobByIDResponse, SimulationLookupJobParams, SimulationLookupJobResponse } from "./resources/simulation.js";
11
11
  export interface ClientOptions {
12
12
  /**
13
13
  * JWT token for authentication
@@ -118,7 +118,7 @@ export declare namespace Roark {
118
118
  export { Evaluation as Evaluation, type EvaluationCreateJobResponse as EvaluationCreateJobResponse, type EvaluationGetEvaluatorByIDResponse as EvaluationGetEvaluatorByIDResponse, type EvaluationGetEvaluatorsResponse as EvaluationGetEvaluatorsResponse, type EvaluationGetJobResponse as EvaluationGetJobResponse, type EvaluationGetJobRunsResponse as EvaluationGetJobRunsResponse, type EvaluationCreateJobParams as EvaluationCreateJobParams, type EvaluationGetEvaluatorsParams as EvaluationGetEvaluatorsParams, type EvaluationGetJobRunsParams as EvaluationGetJobRunsParams, };
119
119
  export { Call as Call, type CallGetEvaluationRunsResponse as CallGetEvaluationRunsResponse, type CallGetSentimentRunsResponse as CallGetSentimentRunsResponse, };
120
120
  export { Integrations as Integrations, type IntegrationCreateRetellCallResponse as IntegrationCreateRetellCallResponse, type IntegrationCreateVapiCallResponse as IntegrationCreateVapiCallResponse, type IntegrationCreateRetellCallParams as IntegrationCreateRetellCallParams, type IntegrationCreateVapiCallParams as IntegrationCreateVapiCallParams, };
121
- export { Simulation as Simulation, type SimulationGetJobResponse as SimulationGetJobResponse, type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse, type SimulationGetJobParams as SimulationGetJobParams, };
121
+ export { Simulation as Simulation, type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse, type SimulationLookupJobResponse as SimulationLookupJobResponse, type SimulationLookupJobParams as SimulationLookupJobParams, };
122
122
  }
123
123
  export { toFile, fileFromPath } from "./uploads.js";
124
124
  export { RoarkError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.js";
package/index.d.ts CHANGED
@@ -7,7 +7,7 @@ import { Call, CallGetEvaluationRunsResponse, CallGetSentimentRunsResponse } fro
7
7
  import { Evaluation, EvaluationCreateJobParams, EvaluationCreateJobResponse, EvaluationGetEvaluatorByIDResponse, EvaluationGetEvaluatorsParams, EvaluationGetEvaluatorsResponse, EvaluationGetJobResponse, EvaluationGetJobRunsParams, EvaluationGetJobRunsResponse } from "./resources/evaluation.js";
8
8
  import { Health, HealthGetResponse } from "./resources/health.js";
9
9
  import { IntegrationCreateRetellCallParams, IntegrationCreateRetellCallResponse, IntegrationCreateVapiCallParams, IntegrationCreateVapiCallResponse, Integrations } from "./resources/integrations.js";
10
- import { Simulation, SimulationGetJobByIDResponse, SimulationGetJobParams, SimulationGetJobResponse } from "./resources/simulation.js";
10
+ import { Simulation, SimulationGetJobByIDResponse, SimulationLookupJobParams, SimulationLookupJobResponse } from "./resources/simulation.js";
11
11
  export interface ClientOptions {
12
12
  /**
13
13
  * JWT token for authentication
@@ -118,7 +118,7 @@ export declare namespace Roark {
118
118
  export { Evaluation as Evaluation, type EvaluationCreateJobResponse as EvaluationCreateJobResponse, type EvaluationGetEvaluatorByIDResponse as EvaluationGetEvaluatorByIDResponse, type EvaluationGetEvaluatorsResponse as EvaluationGetEvaluatorsResponse, type EvaluationGetJobResponse as EvaluationGetJobResponse, type EvaluationGetJobRunsResponse as EvaluationGetJobRunsResponse, type EvaluationCreateJobParams as EvaluationCreateJobParams, type EvaluationGetEvaluatorsParams as EvaluationGetEvaluatorsParams, type EvaluationGetJobRunsParams as EvaluationGetJobRunsParams, };
119
119
  export { Call as Call, type CallGetEvaluationRunsResponse as CallGetEvaluationRunsResponse, type CallGetSentimentRunsResponse as CallGetSentimentRunsResponse, };
120
120
  export { Integrations as Integrations, type IntegrationCreateRetellCallResponse as IntegrationCreateRetellCallResponse, type IntegrationCreateVapiCallResponse as IntegrationCreateVapiCallResponse, type IntegrationCreateRetellCallParams as IntegrationCreateRetellCallParams, type IntegrationCreateVapiCallParams as IntegrationCreateVapiCallParams, };
121
- export { Simulation as Simulation, type SimulationGetJobResponse as SimulationGetJobResponse, type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse, type SimulationGetJobParams as SimulationGetJobParams, };
121
+ export { Simulation as Simulation, type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse, type SimulationLookupJobResponse as SimulationLookupJobResponse, type SimulationLookupJobParams as SimulationLookupJobParams, };
122
122
  }
123
123
  export { toFile, fileFromPath } from "./uploads.js";
124
124
  export { RoarkError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.js";
package/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,MAAM,kBAAkB,CAAC;AACrG,OAAO,EACL,UAAU,EACV,yBAAyB,EACzB,2BAA2B,EAC3B,kCAAkC,EAClC,6BAA6B,EAC7B,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,EAC1B,4BAA4B,EAC7B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EACL,iCAAiC,EACjC,mCAAmC,EACnC,+BAA+B,EAC/B,iCAAiC,EACjC,YAAY,EACb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,UAAU,EACV,4BAA4B,EAC5B,sBAAsB,EACtB,wBAAwB,EACzB,MAAM,wBAAwB,CAAC;AAEhC,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE9B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;CAC9C;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,IAAI,CAAC,SAAS;;IACvC,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAAwC,EACxC,WAAoD,EACpD,GAAG,IAAI,EACR,GAAE,aAAkB;IA2BrB,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C,UAAU,EAAE,GAAG,CAAC,UAAU,CAA4B;IACtD,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,UAAU,EAAE,GAAG,CAAC,UAAU,CAA4B;cASnC,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAO5D,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAIzD,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,MAAM,CAAC,KAAK,eAAQ;IACpB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,UAAU,2BAAqB;IACtC,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;AAQD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;IAEzE,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,SAAS,CAAC;AAEjB,eAAe,KAAK,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,KAAK,IAAI,MAAM,QAAQ,CAAC;AAC/B,OAAO,KAAK,MAAM,MAAM,SAAS,CAAC;AAClC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,KAAK,GAAG,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,6BAA6B,EAAE,4BAA4B,EAAE,MAAM,kBAAkB,CAAC;AACrG,OAAO,EACL,UAAU,EACV,yBAAyB,EACzB,2BAA2B,EAC3B,kCAAkC,EAClC,6BAA6B,EAC7B,+BAA+B,EAC/B,wBAAwB,EACxB,0BAA0B,EAC1B,4BAA4B,EAC7B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EACL,iCAAiC,EACjC,mCAAmC,EACnC,+BAA+B,EAC/B,iCAAiC,EACjC,YAAY,EACb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,UAAU,EACV,4BAA4B,EAC5B,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,wBAAwB,CAAC;AAEhC,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEjC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE9B;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAE/B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;IAE1C;;;;;OAKG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;CAC9C;AAED;;GAEG;AACH,qBAAa,KAAM,SAAQ,IAAI,CAAC,SAAS;;IACvC,WAAW,EAAE,MAAM,CAAC;IAEpB,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;OAWG;gBACS,EACV,OAAwC,EACxC,WAAoD,EACpD,GAAG,IAAI,EACR,GAAE,aAAkB;IA2BrB,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C,UAAU,EAAE,GAAG,CAAC,UAAU,CAA4B;IACtD,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,YAAY,EAAE,GAAG,CAAC,YAAY,CAA8B;IAC5D,UAAU,EAAE,GAAG,CAAC,UAAU,CAA4B;cASnC,YAAY,IAAI,IAAI,CAAC,YAAY,GAAG,SAAS;cAI7C,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAO5D,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,OAAO;cAIzD,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAIzE,MAAM,CAAC,KAAK,eAAQ;IACpB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,UAAU,2BAAqB;IACtC,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAC/B,MAAM,CAAC,YAAY,8BAAwB;CAC5C;AAQD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;IAEzE,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;IAEF,OAAO,EACL,UAAU,IAAI,UAAU,EACxB,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH;AAED,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,EACL,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,yBAAyB,EACzB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,SAAS,CAAC;AAEjB,eAAe,KAAK,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@roarkanalytics/sdk",
3
- "version": "2.5.0",
3
+ "version": "2.7.0",
4
4
  "description": "The official TypeScript library for the Roark API",
5
5
  "author": "Roark <james@roark.ai>",
6
6
  "types": "./index.d.ts",
@@ -2,5 +2,5 @@ export { Call, type CallGetEvaluationRunsResponse, type CallGetSentimentRunsResp
2
2
  export { Evaluation, type EvaluationCreateJobResponse, type EvaluationGetEvaluatorByIDResponse, type EvaluationGetEvaluatorsResponse, type EvaluationGetJobResponse, type EvaluationGetJobRunsResponse, type EvaluationCreateJobParams, type EvaluationGetEvaluatorsParams, type EvaluationGetJobRunsParams, } from "./evaluation.js";
3
3
  export { Health, type HealthGetResponse } from "./health.js";
4
4
  export { Integrations, type IntegrationCreateRetellCallResponse, type IntegrationCreateVapiCallResponse, type IntegrationCreateRetellCallParams, type IntegrationCreateVapiCallParams, } from "./integrations.js";
5
- export { Simulation, type SimulationGetJobResponse, type SimulationGetJobByIDResponse, type SimulationGetJobParams, } from "./simulation.js";
5
+ export { Simulation, type SimulationGetJobByIDResponse, type SimulationLookupJobResponse, type SimulationLookupJobParams, } from "./simulation.js";
6
6
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,KAAK,6BAA6B,EAAE,KAAK,4BAA4B,EAAE,MAAM,QAAQ,CAAC;AACrG,OAAO,EACL,UAAU,EACV,KAAK,2BAA2B,EAChC,KAAK,kCAAkC,EACvC,KAAK,+BAA+B,EACpC,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,GAChC,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC1D,OAAO,EACL,YAAY,EACZ,KAAK,mCAAmC,EACxC,KAAK,iCAAiC,EACtC,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,GACrC,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,UAAU,EACV,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,sBAAsB,GAC5B,MAAM,cAAc,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,KAAK,6BAA6B,EAAE,KAAK,4BAA4B,EAAE,MAAM,QAAQ,CAAC;AACrG,OAAO,EACL,UAAU,EACV,KAAK,2BAA2B,EAChC,KAAK,kCAAkC,EACvC,KAAK,+BAA+B,EACpC,KAAK,wBAAwB,EAC7B,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,0BAA0B,GAChC,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC1D,OAAO,EACL,YAAY,EACZ,KAAK,mCAAmC,EACxC,KAAK,iCAAiC,EACtC,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,GACrC,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,UAAU,EACV,KAAK,4BAA4B,EACjC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,GAC/B,MAAM,cAAc,CAAC"}
@@ -1,22 +1,37 @@
1
1
  import { APIResource } from "../resource.js";
2
2
  import * as Core from "../core.js";
3
3
  export declare class Simulation extends APIResource {
4
- /**
5
- * Find a simulation job by looking up the active lease for the given phone numbers
6
- */
7
- getJob(query: SimulationGetJobParams, options?: Core.RequestOptions): Core.APIPromise<SimulationGetJobResponse>;
8
4
  /**
9
5
  * Find a simulation job directly by its ID
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * const response = await client.simulation.getJobById(
10
+ * '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
11
+ * );
12
+ * ```
10
13
  */
11
14
  getJobById(jobId: unknown, options?: Core.RequestOptions): Core.APIPromise<SimulationGetJobByIDResponse>;
15
+ /**
16
+ * Find the matching simulation job using the number used by the Roark simulation
17
+ * agent.
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * const response = await client.simulation.lookupJob({
22
+ * roarkPhoneNumber: {},
23
+ * });
24
+ * ```
25
+ */
26
+ lookupJob(query: SimulationLookupJobParams, options?: Core.RequestOptions): Core.APIPromise<SimulationLookupJobResponse>;
12
27
  }
13
- export interface SimulationGetJobResponse {
28
+ export interface SimulationGetJobByIDResponse {
14
29
  /**
15
30
  * Simulation job with related entities
16
31
  */
17
- data: SimulationGetJobResponse.Data;
32
+ data: SimulationGetJobByIDResponse.Data;
18
33
  }
19
- export declare namespace SimulationGetJobResponse {
34
+ export declare namespace SimulationGetJobByIDResponse {
20
35
  /**
21
36
  * Simulation job with related entities
22
37
  */
@@ -152,13 +167,13 @@ export declare namespace SimulationGetJobResponse {
152
167
  }
153
168
  }
154
169
  }
155
- export interface SimulationGetJobByIDResponse {
170
+ export interface SimulationLookupJobResponse {
156
171
  /**
157
172
  * Simulation job with related entities
158
173
  */
159
- data: SimulationGetJobByIDResponse.Data;
174
+ data: SimulationLookupJobResponse.Data;
160
175
  }
161
- export declare namespace SimulationGetJobByIDResponse {
176
+ export declare namespace SimulationLookupJobResponse {
162
177
  /**
163
178
  * Simulation job with related entities
164
179
  */
@@ -294,21 +309,21 @@ export declare namespace SimulationGetJobByIDResponse {
294
309
  }
295
310
  }
296
311
  }
297
- export interface SimulationGetJobParams {
298
- /**
299
- * Customer phone number in E.164 format
300
- */
301
- phoneNumber: unknown;
312
+ export interface SimulationLookupJobParams {
302
313
  /**
303
- * Roark-assigned phone number in E.164 format
314
+ * Phone number provisioned by Roark for the simulation job in E.164 format. In the
315
+ * case of an inbound simulation, this is the number that calls your agent; in the
316
+ * case of an outbound simulation, this is the number you call from your agent.
304
317
  */
305
318
  roarkPhoneNumber: unknown;
306
319
  /**
307
- * ISO 8601 timestamp to check for active lease (defaults to current time)
320
+ * ISO 8601 timestamp of when the call was received. Alternatively, any time
321
+ * between the start and end of the call is valid. Defaults to the current time,
322
+ * which fetches any jobs that are currently ongoing.
308
323
  */
309
- timestamp?: unknown;
324
+ callReceivedAt?: unknown;
310
325
  }
311
326
  export declare namespace Simulation {
312
- export { type SimulationGetJobResponse as SimulationGetJobResponse, type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse, type SimulationGetJobParams as SimulationGetJobParams, };
327
+ export { type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse, type SimulationLookupJobResponse as SimulationLookupJobResponse, type SimulationLookupJobParams as SimulationLookupJobParams, };
313
328
  }
314
329
  //# sourceMappingURL=simulation.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"simulation.d.ts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,MAAM,CACJ,KAAK,EAAE,sBAAsB,EAC7B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;IAI5C;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;CAGzG;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,YAAY,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC,IAAI,CAAC;CACzC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,YAAY,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
1
+ {"version":3,"file":"simulation.d.ts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,SAAS,CACP,KAAK,EAAE,yBAAyB,EAChC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;CAGhD;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,IAAI,EAAE,4BAA4B,CAAC,IAAI,CAAC;CACzC;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,YAAY,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAC,IAAI,CAAC;CACxC;AAED,yBAAiB,2BAA2B,CAAC;IAC3C;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC;QAElC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;QAEtB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,aAAa;YAC5B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;QAED;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,eAAe,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,WAAW,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,YAAY,EAAE,OAAO,CAAC;YAEtB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,iBAAiB,EAAE,MAAM,CAAC;YAE1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,aAAa,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;QAED;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC7B;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;OAIG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
@@ -5,16 +5,31 @@ exports.Simulation = void 0;
5
5
  const resource_1 = require("../resource.js");
6
6
  class Simulation extends resource_1.APIResource {
7
7
  /**
8
- * Find a simulation job by looking up the active lease for the given phone numbers
8
+ * Find a simulation job directly by its ID
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const response = await client.simulation.getJobById(
13
+ * '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
14
+ * );
15
+ * ```
9
16
  */
10
- getJob(query, options) {
11
- return this._client.get('/v1/simulation/job', { query, ...options });
17
+ getJobById(jobId, options) {
18
+ return this._client.get(`/v1/simulation/job/${jobId}`, options);
12
19
  }
13
20
  /**
14
- * Find a simulation job directly by its ID
21
+ * Find the matching simulation job using the number used by the Roark simulation
22
+ * agent.
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * const response = await client.simulation.lookupJob({
27
+ * roarkPhoneNumber: {},
28
+ * });
29
+ * ```
15
30
  */
16
- getJobById(jobId, options) {
17
- return this._client.get(`/v1/simulation/jobs/${jobId}`, options);
31
+ lookupJob(query, options) {
32
+ return this._client.get('/v1/simulation/job/lookup', { query, ...options });
18
33
  }
19
34
  }
20
35
  exports.Simulation = Simulation;
@@ -1 +1 @@
1
- {"version":3,"file":"simulation.js","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;OAEG;IACH,MAAM,CACJ,KAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAAc,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAjBD,gCAiBC"}
1
+ {"version":3,"file":"simulation.js","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,6CAA0C;AAG1C,MAAa,UAAW,SAAQ,sBAAW;IACzC;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAc,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF;AAhCD,gCAgCC"}
@@ -2,16 +2,31 @@
2
2
  import { APIResource } from "../resource.mjs";
3
3
  export class Simulation extends APIResource {
4
4
  /**
5
- * Find a simulation job by looking up the active lease for the given phone numbers
5
+ * Find a simulation job directly by its ID
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * const response = await client.simulation.getJobById(
10
+ * '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
11
+ * );
12
+ * ```
6
13
  */
7
- getJob(query, options) {
8
- return this._client.get('/v1/simulation/job', { query, ...options });
14
+ getJobById(jobId, options) {
15
+ return this._client.get(`/v1/simulation/job/${jobId}`, options);
9
16
  }
10
17
  /**
11
- * Find a simulation job directly by its ID
18
+ * Find the matching simulation job using the number used by the Roark simulation
19
+ * agent.
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const response = await client.simulation.lookupJob({
24
+ * roarkPhoneNumber: {},
25
+ * });
26
+ * ```
12
27
  */
13
- getJobById(jobId, options) {
14
- return this._client.get(`/v1/simulation/jobs/${jobId}`, options);
28
+ lookupJob(query, options) {
29
+ return this._client.get('/v1/simulation/job/lookup', { query, ...options });
15
30
  }
16
31
  }
17
32
  //# sourceMappingURL=simulation.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"simulation.mjs","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,MAAM,CACJ,KAA6B,EAC7B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,KAAc,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF"}
1
+ {"version":3,"file":"simulation.mjs","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAGtB,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;OASG;IACH,UAAU,CAAC,KAAc,EAAE,OAA6B;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,KAAgC,EAChC,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACF"}
package/src/index.ts CHANGED
@@ -29,8 +29,8 @@ import {
29
29
  import {
30
30
  Simulation,
31
31
  SimulationGetJobByIDResponse,
32
- SimulationGetJobParams,
33
- SimulationGetJobResponse,
32
+ SimulationLookupJobParams,
33
+ SimulationLookupJobResponse,
34
34
  } from './resources/simulation';
35
35
 
36
36
  export interface ClientOptions {
@@ -241,9 +241,9 @@ export declare namespace Roark {
241
241
 
242
242
  export {
243
243
  Simulation as Simulation,
244
- type SimulationGetJobResponse as SimulationGetJobResponse,
245
244
  type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse,
246
- type SimulationGetJobParams as SimulationGetJobParams,
245
+ type SimulationLookupJobResponse as SimulationLookupJobResponse,
246
+ type SimulationLookupJobParams as SimulationLookupJobParams,
247
247
  };
248
248
  }
249
249
 
@@ -22,7 +22,7 @@ export {
22
22
  } from './integrations';
23
23
  export {
24
24
  Simulation,
25
- type SimulationGetJobResponse,
26
25
  type SimulationGetJobByIDResponse,
27
- type SimulationGetJobParams,
26
+ type SimulationLookupJobResponse,
27
+ type SimulationLookupJobParams,
28
28
  } from './simulation';
@@ -5,31 +5,46 @@ import * as Core from '../core';
5
5
 
6
6
  export class Simulation extends APIResource {
7
7
  /**
8
- * Find a simulation job by looking up the active lease for the given phone numbers
8
+ * Find a simulation job directly by its ID
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * const response = await client.simulation.getJobById(
13
+ * '7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f',
14
+ * );
15
+ * ```
9
16
  */
10
- getJob(
11
- query: SimulationGetJobParams,
12
- options?: Core.RequestOptions,
13
- ): Core.APIPromise<SimulationGetJobResponse> {
14
- return this._client.get('/v1/simulation/job', { query, ...options });
17
+ getJobById(jobId: unknown, options?: Core.RequestOptions): Core.APIPromise<SimulationGetJobByIDResponse> {
18
+ return this._client.get(`/v1/simulation/job/${jobId}`, options);
15
19
  }
16
20
 
17
21
  /**
18
- * Find a simulation job directly by its ID
22
+ * Find the matching simulation job using the number used by the Roark simulation
23
+ * agent.
24
+ *
25
+ * @example
26
+ * ```ts
27
+ * const response = await client.simulation.lookupJob({
28
+ * roarkPhoneNumber: {},
29
+ * });
30
+ * ```
19
31
  */
20
- getJobById(jobId: unknown, options?: Core.RequestOptions): Core.APIPromise<SimulationGetJobByIDResponse> {
21
- return this._client.get(`/v1/simulation/jobs/${jobId}`, options);
32
+ lookupJob(
33
+ query: SimulationLookupJobParams,
34
+ options?: Core.RequestOptions,
35
+ ): Core.APIPromise<SimulationLookupJobResponse> {
36
+ return this._client.get('/v1/simulation/job/lookup', { query, ...options });
22
37
  }
23
38
  }
24
39
 
25
- export interface SimulationGetJobResponse {
40
+ export interface SimulationGetJobByIDResponse {
26
41
  /**
27
42
  * Simulation job with related entities
28
43
  */
29
- data: SimulationGetJobResponse.Data;
44
+ data: SimulationGetJobByIDResponse.Data;
30
45
  }
31
46
 
32
- export namespace SimulationGetJobResponse {
47
+ export namespace SimulationGetJobByIDResponse {
33
48
  /**
34
49
  * Simulation job with related entities
35
50
  */
@@ -193,14 +208,14 @@ export namespace SimulationGetJobResponse {
193
208
  }
194
209
  }
195
210
 
196
- export interface SimulationGetJobByIDResponse {
211
+ export interface SimulationLookupJobResponse {
197
212
  /**
198
213
  * Simulation job with related entities
199
214
  */
200
- data: SimulationGetJobByIDResponse.Data;
215
+ data: SimulationLookupJobResponse.Data;
201
216
  }
202
217
 
203
- export namespace SimulationGetJobByIDResponse {
218
+ export namespace SimulationLookupJobResponse {
204
219
  /**
205
220
  * Simulation job with related entities
206
221
  */
@@ -364,27 +379,26 @@ export namespace SimulationGetJobByIDResponse {
364
379
  }
365
380
  }
366
381
 
367
- export interface SimulationGetJobParams {
368
- /**
369
- * Customer phone number in E.164 format
370
- */
371
- phoneNumber: unknown;
372
-
382
+ export interface SimulationLookupJobParams {
373
383
  /**
374
- * Roark-assigned phone number in E.164 format
384
+ * Phone number provisioned by Roark for the simulation job in E.164 format. In the
385
+ * case of an inbound simulation, this is the number that calls your agent; in the
386
+ * case of an outbound simulation, this is the number you call from your agent.
375
387
  */
376
388
  roarkPhoneNumber: unknown;
377
389
 
378
390
  /**
379
- * ISO 8601 timestamp to check for active lease (defaults to current time)
391
+ * ISO 8601 timestamp of when the call was received. Alternatively, any time
392
+ * between the start and end of the call is valid. Defaults to the current time,
393
+ * which fetches any jobs that are currently ongoing.
380
394
  */
381
- timestamp?: unknown;
395
+ callReceivedAt?: unknown;
382
396
  }
383
397
 
384
398
  export declare namespace Simulation {
385
399
  export {
386
- type SimulationGetJobResponse as SimulationGetJobResponse,
387
400
  type SimulationGetJobByIDResponse as SimulationGetJobByIDResponse,
388
- type SimulationGetJobParams as SimulationGetJobParams,
401
+ type SimulationLookupJobResponse as SimulationLookupJobResponse,
402
+ type SimulationLookupJobParams as SimulationLookupJobParams,
389
403
  };
390
404
  }
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '2.5.0'; // x-release-please-version
1
+ export const VERSION = '2.7.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "2.5.0";
1
+ export declare const VERSION = "2.7.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '2.5.0'; // x-release-please-version
4
+ exports.VERSION = '2.7.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '2.5.0'; // x-release-please-version
1
+ export const VERSION = '2.7.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map