@gbg/go-core 0.1.3 → 0.2.0-alpha.0

package/FUNCTIONS.md

@@ -20,19 +20,21 @@ specific category of applications.
 
 ```typescript
 import { GoCore } from "@gbg/go-core/core.js";
-import { tokensGenerate } from "@gbg/go-core/funcs/tokens-generate.js";
+import { journeysStart } from "@gbg/go-core/funcs/journeys-start.js";
 
 // Use `GoCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
-const go = new GoCore();
+const go = new GoCore({
+  customerAccess: process.env["GO_CUSTOMER_ACCESS"] ?? "",
+});
 
 async function run() {
-  const res = await tokensGenerate(go);
+  const res = await journeysStart(go);
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("tokensGenerate failed:", res.error);
+    console.log("journeysStart failed:", res.error);
   }
 }
 

package/README.md

@@ -8,7 +8,7 @@ Developer-friendly & type-safe Typescript SDK specifically catered to leverage _
 <!-- Start Summary [summary] -->
 ## Summary
 
-GBG GO Next Gen Flow Captain API: API for Customers and End Users to interact with the GBG GO Next Gen Flow Captain
+GBG GO Journey API: GBG GO API for orchestrating identity verification journeys.
 <!-- End Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
@@ -80,10 +80,12 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 ```typescript
 import { Go } from "@gbg/go-core";
 
-const go = new Go();
+const go = new Go({
+  customerAccess: process.env["GO_CUSTOMER_ACCESS"] ?? "",
+});
 
 async function run() {
-  const result = await go.tokens.generate();
+  const result = await go.journeys.start();
 
   console.log(result);
 }
@@ -113,7 +115,7 @@ const go = new Go({
 });
 
 async function run() {
-  const result = await go.tokens.generate();
+  const result = await go.journeys.start();
 
   console.log(result);
 }
@@ -131,15 +133,8 @@ import { Go } from "@gbg/go-core";
 const go = new Go();
 
 async function run() {
-  const result = await go.devices.connect({
-    deviceConnect: process.env["GO_DEVICE_CONNECT"] ?? "",
-  }, {
-    connectToken: "s4FUx8Ny8ijXRtFigz3x1_8rb9bd_5ZD",
-    deviceInfo: {
-      deviceId: "exampleDeviceId123",
-      deviceName: "deviceName",
-      deviceType: "deviceType",
-    },
+  const result = await go.interactions.fetch({}, {
+    view: "slim",
   });
 
   console.log(result);
@@ -156,35 +151,47 @@ run();
 <details open>
 <summary>Available methods</summary>
 
-### [Devices](docs/sdks/devices/README.md)
+### [Addresses](docs/sdks/addresses/README.md)
 
-* [connect](docs/sdks/devices/README.md#connect) - Connect or Refresh End User Device
-* [add](docs/sdks/devices/README.md#add) - Create Connect Secret
+* [search](docs/sdks/addresses/README.md#search) - Search addresses via Loqate Capture
+* [retrieve](docs/sdks/addresses/README.md#retrieve) - Retrieve full address via Loqate Capture
 
-### [Health](docs/sdks/health/README.md)
+### [Devices](docs/sdks/devices/README.md)
 
-* [get](docs/sdks/health/README.md#get) - Obtain the flow-captain health status
+* [add](docs/sdks/devices/README.md#add) - Generate connect token
+* [connect](docs/sdks/devices/README.md#connect) - Complete the device-onboarding handshake
+* [refresh](docs/sdks/devices/README.md#refresh) - Renew a device session
+* [validate](docs/sdks/devices/README.md#validate) - Validate end-user session
 
 ### [Instances](docs/sdks/instances/README.md)
 
-* [delete](docs/sdks/instances/README.md#delete) - Delete instance
+* [handoffToken](docs/sdks/instances/README.md#handofftoken) - Mint a fresh position-scoped handoff token
+* [delete](docs/sdks/instances/README.md#delete) - Delete journey state
 
 ### [Interactions](docs/sdks/interactions/README.md)
 
-* [submit](docs/sdks/interactions/README.md#submit) - Submit Interaction
-* [fetch](docs/sdks/interactions/README.md#fetch) - Fetch Interaction
+* [fetch](docs/sdks/interactions/README.md#fetch) - Fetch current interaction
+* [submit](docs/sdks/interactions/README.md#submit) - Submit interaction data
+* [uploadAsset](docs/sdks/interactions/README.md#uploadasset) - Stream an interaction asset to storage
 
 ### [Journeys](docs/sdks/journeys/README.md)
 
-* [start](docs/sdks/journeys/README.md#start) - Start Journey
-* [getState](docs/sdks/journeys/README.md#getstate) - Get State Data
+* [start](docs/sdks/journeys/README.md#start) - Start a new journey
+* [getState](docs/sdks/journeys/README.md#getstate) - Fetch journey state
+* [getSchemas](docs/sdks/journeys/README.md#getschemas) - Fetch interaction JSON schemas
+* [terminate](docs/sdks/journeys/README.md#terminate) - Terminate journey
+
+### [Sandbox](docs/sdks/sandbox/README.md)
+
+* [createScenario](docs/sdks/sandbox/README.md#createscenario) - Create a sandbox scenario on a journey
+* [listScenarios](docs/sdks/sandbox/README.md#listscenarios) - List a journey's sandbox scenarios
+* [getScenario](docs/sdks/sandbox/README.md#getscenario) - Read a sandbox scenario
+* [putScenario](docs/sdks/sandbox/README.md#putscenario) - Replace a sandbox scenario
+* [deleteScenario](docs/sdks/sandbox/README.md#deletescenario) - Delete a sandbox scenario
 
-### [Tasks](docs/sdks/tasks/README.md)
+### [~~Tasks~~](docs/sdks/tasks/README.md)
 
-* [list](docs/sdks/tasks/README.md#list) - Get End User Tasks
-* [update](docs/sdks/tasks/README.md#update) - Put End User Data
-* [getSchema](docs/sdks/tasks/README.md#getschema) - Get Task Schema
-* [listSchema](docs/sdks/tasks/README.md#listschema) - Get Tasks Schema
+* [~~getSchema~~](docs/sdks/tasks/README.md#getschema) - Fetch V1-compat task schema :warning: **Deprecated**
 
 ### [Tokens](docs/sdks/tokens/README.md)
 
@@ -208,19 +215,28 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [`devicesAdd`](docs/sdks/devices/README.md#add) - Create Connect Secret
-- [`devicesConnect`](docs/sdks/devices/README.md#connect) - Connect or Refresh End User Device
-- [`healthGet`](docs/sdks/health/README.md#get) - Obtain the flow-captain health status
-- [`instancesDelete`](docs/sdks/instances/README.md#delete) - Delete instance
-- [`interactionsFetch`](docs/sdks/interactions/README.md#fetch) - Fetch Interaction
-- [`interactionsSubmit`](docs/sdks/interactions/README.md#submit) - Submit Interaction
-- [`journeysGetState`](docs/sdks/journeys/README.md#getstate) - Get State Data
-- [`journeysStart`](docs/sdks/journeys/README.md#start) - Start Journey
-- [`tasksGetSchema`](docs/sdks/tasks/README.md#getschema) - Get Task Schema
-- [`tasksList`](docs/sdks/tasks/README.md#list) - Get End User Tasks
-- [`tasksListSchema`](docs/sdks/tasks/README.md#listschema) - Get Tasks Schema
-- [`tasksUpdate`](docs/sdks/tasks/README.md#update) - Put End User Data
+- [`addressesRetrieve`](docs/sdks/addresses/README.md#retrieve) - Retrieve full address via Loqate Capture
+- [`addressesSearch`](docs/sdks/addresses/README.md#search) - Search addresses via Loqate Capture
+- [`devicesAdd`](docs/sdks/devices/README.md#add) - Generate connect token
+- [`devicesConnect`](docs/sdks/devices/README.md#connect) - Complete the device-onboarding handshake
+- [`devicesRefresh`](docs/sdks/devices/README.md#refresh) - Renew a device session
+- [`devicesValidate`](docs/sdks/devices/README.md#validate) - Validate end-user session
+- [`instancesDelete`](docs/sdks/instances/README.md#delete) - Delete journey state
+- [`instancesHandoffToken`](docs/sdks/instances/README.md#handofftoken) - Mint a fresh position-scoped handoff token
+- [`interactionsFetch`](docs/sdks/interactions/README.md#fetch) - Fetch current interaction
+- [`interactionsSubmit`](docs/sdks/interactions/README.md#submit) - Submit interaction data
+- [`interactionsUploadAsset`](docs/sdks/interactions/README.md#uploadasset) - Stream an interaction asset to storage
+- [`journeysGetSchemas`](docs/sdks/journeys/README.md#getschemas) - Fetch interaction JSON schemas
+- [`journeysGetState`](docs/sdks/journeys/README.md#getstate) - Fetch journey state
+- [`journeysStart`](docs/sdks/journeys/README.md#start) - Start a new journey
+- [`journeysTerminate`](docs/sdks/journeys/README.md#terminate) - Terminate journey
+- [`sandboxCreateScenario`](docs/sdks/sandbox/README.md#createscenario) - Create a sandbox scenario on a journey
+- [`sandboxDeleteScenario`](docs/sdks/sandbox/README.md#deletescenario) - Delete a sandbox scenario
+- [`sandboxGetScenario`](docs/sdks/sandbox/README.md#getscenario) - Read a sandbox scenario
+- [`sandboxListScenarios`](docs/sdks/sandbox/README.md#listscenarios) - List a journey's sandbox scenarios
+- [`sandboxPutScenario`](docs/sdks/sandbox/README.md#putscenario) - Replace a sandbox scenario
 - [`tokensGenerate`](docs/sdks/tokens/README.md#generate) - Generate access token
+- ~~[`tasksGetSchema`](docs/sdks/tasks/README.md#getschema)~~ - Fetch V1-compat task schema :warning: **Deprecated**
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -234,10 +250,12 @@ To change the default retry strategy for a single API call, simply provide a ret
 ```typescript
 import { Go } from "@gbg/go-core";
 
-const go = new Go();
+const go = new Go({
+  customerAccess: process.env["GO_CUSTOMER_ACCESS"] ?? "",
+});
 
 async function run() {
-  const result = await go.tokens.generate(undefined, {
+  const result = await go.journeys.start(undefined, {
     retries: {
       strategy: "backoff",
       backoff: {
@@ -272,10 +290,11 @@ const go = new Go({
     },
     retryConnectionErrors: false,
   },
+  customerAccess: process.env["GO_CUSTOMER_ACCESS"] ?? "",
 });
 
 async function run() {
-  const result = await go.tokens.generate();
+  const result = await go.journeys.start();
 
   console.log(result);
 }
@@ -290,32 +309,41 @@ run();
 
 [`GoError`](./src/models/errors/go-error.ts) is the base class for all HTTP error responses. It has the following properties:
 
-| Property            | Type       | Description                                            |
-| ------------------- | ---------- | ------------------------------------------------------ |
-| `error.message`     | `string`   | Error message                                          |
-| `error.statusCode`  | `number`   | HTTP response status code eg `404`                     |
-| `error.headers`     | `Headers`  | HTTP response headers                                  |
-| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned. |
-| `error.rawResponse` | `Response` | Raw HTTP response                                      |
+| Property            | Type       | Description                                                                             |
+| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
+| `error.message`     | `string`   | Error message                                                                           |
+| `error.statusCode`  | `number`   | HTTP response status code eg `404`                                                      |
+| `error.headers`     | `Headers`  | HTTP response headers                                                                   |
+| `error.body`        | `string`   | HTTP body. Can be empty string if no body is returned.                                  |
+| `error.rawResponse` | `Response` | Raw HTTP response                                                                       |
+| `error.data$`       |            | Optional. Some errors may contain structured data. [See Error Classes](#error-classes). |
 
 ### Example
 ```typescript
 import { Go } from "@gbg/go-core";
 import * as errors from "@gbg/go-core/models/errors";
 
-const go = new Go();
+const go = new Go({
+  customerAccess: process.env["GO_CUSTOMER_ACCESS"] ?? "",
+});
 
 async function run() {
   try {
-    const result = await go.tokens.generate();
+    const result = await go.journeys.start();
 
     console.log(result);
   } catch (error) {
+    // The base class for HTTP error responses
     if (error instanceof errors.GoError) {
       console.log(error.message);
       console.log(error.statusCode);
       console.log(error.body);
       console.log(error.headers);
+
+      // Depending on the method different errors may be thrown
+      if (error instanceof errors.ErrorResponse) {
+        console.log(error.data$.errors); // GbgError[]
+      }
     }
   }
 }
@@ -325,8 +353,9 @@ run();
 ```
 
 ### Error Classes
-**Primary error:**
+**Primary errors:**
 * [`GoError`](./src/models/errors/go-error.ts): The base class for HTTP error responses.
+  * [`ErrorResponse`](./src/models/errors/error-response.ts): *
 
 <details><summary>Less common errors (6)</summary>
 
@@ -344,6 +373,8 @@ run();
 * [`ResponseValidationError`](./src/models/errors/response-validation-error.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
 
 </details>
+
+\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -353,11 +384,11 @@ run();
 
 You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
 
-| #   | Server                                         | Description |
-| --- | ---------------------------------------------- | ----------- |
-| 0   | `https://eu.platform.go.gbgplc.com/v2/captain` |             |
-| 1   | `https://us.platform.go.gbgplc.com/v2/captain` |             |
-| 2   | `https://au.platform.go.gbgplc.com/v2/captain` |             |
+| #   | Server                              | Description |
+| --- | ----------------------------------- | ----------- |
+| 0   | `https://eu.platform.go.gbgplc.com` | EU          |
+| 1   | `https://us.platform.go.gbgplc.com` | US          |
+| 2   | `https://au.platform.go.gbgplc.com` | AU          |
 
 #### Example
 
@@ -370,7 +401,7 @@ const go = new Go({
 });
 
 async function run() {
-  const result = await go.health.get();
+  const result = await go.journeys.start();
 
   console.log(result);
 }
@@ -386,12 +417,12 @@ The default server can also be overridden globally by passing a URL to the `serv
 import { Go } from "@gbg/go-core";
 
 const go = new Go({
-  serverURL: "https://au.platform.go.gbgplc.com/v2/captain",
+  serverURL: "https://au.platform.go.gbgplc.com",
   customerAccess: process.env["GO_CUSTOMER_ACCESS"] ?? "",
 });
 
 async function run() {
-  const result = await go.health.get();
+  const result = await go.journeys.start();
 
   console.log(result);
 }

package/dist/commonjs/funcs/addresses-retrieve.d.ts

@@ -0,0 +1,19 @@
+import { GoCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { GoError } from "../models/errors/go-error.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Retrieve full address via Loqate Capture
+ *
+ * @remarks
+ * Server-side proxy for the Loqate Capture Retrieve endpoint. Returns the full address detail for a given Loqate address ID.
+ */
+export declare function addressesRetrieve(client: GoCore, security: operations.RetrieveAddressSecurity, request?: operations.RetrieveAddressRequest | undefined, options?: RequestOptions): APIPromise<Result<models.LoqateRetrieveResponse, errors.ErrorResponse | GoError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=addresses-retrieve.d.ts.map

package/dist/commonjs/funcs/addresses-retrieve.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses-retrieve.d.ts","sourceRoot":"","sources":["../../../src/funcs/addresses-retrieve.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAMpC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,UAAU,CAAC,uBAAuB,EAC5C,OAAO,CAAC,EAAE,UAAU,CAAC,sBAAsB,GAAG,SAAS,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,sBAAsB,EAC3B,MAAM,CAAC,aAAa,GACpB,OAAO,GACP,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAOA"}

package/dist/commonjs/funcs/{tasks-list.js → addresses-retrieve.js}

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tasksList = tasksList;
+exports.addressesRetrieve = addressesRetrieve;
 const z = __importStar(require("zod/v4-mini"));
 const encodings_js_1 = require("../lib/encodings.js");
 const http_js_1 = require("../lib/http.js");
@@ -45,19 +45,21 @@ const primitives_js_1 = require("../lib/primitives.js");
 const schemas_js_1 = require("../lib/schemas.js");
 const security_js_1 = require("../lib/security.js");
 const url_js_1 = require("../lib/url.js");
+const errors = __importStar(require("../models/errors/index.js"));
+const models = __importStar(require("../models/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Get End User Tasks
+ * Retrieve full address via Loqate Capture
  *
  * @remarks
- * Get End User Tasks
+ * Server-side proxy for the Loqate Capture Retrieve endpoint. Returns the full address detail for a given Loqate address ID.
  */
-function tasksList(client, security, request, options) {
+function addressesRetrieve(client, security, request, options) {
     return new async_js_1.APIPromise($do(client, security, request, options));
 }
 async function $do(client, security, request, options) {
-    const parsed = (0, schemas_js_1.safeParse)(request, (value) => z.parse(z.optional(operations.GetTasksRequest$outboundSchema), value), "Input validation failed");
+    const parsed = (0, schemas_js_1.safeParse)(request, (value) => z.parse(z.optional(operations.RetrieveAddressRequest$outboundSchema), value), "Input validation failed");
     if (!parsed.ok) {
         return [parsed, { status: "invalid" }];
     }
@@ -65,7 +67,7 @@ async function $do(client, security, request, options) {
     const body = payload === undefined
         ? null
         : (0, encodings_js_1.encodeJSON)("body", payload, { explode: true });
-    const path = (0, url_js_1.pathToFunc)("/journey/task/list")();
+    const path = (0, url_js_1.pathToFunc)("/v2/captain/journey/loqate/retrieve")();
     const headers = new Headers((0, primitives_js_1.compactMap)({
         "Content-Type": "application/json",
         Accept: "application/json",
@@ -74,13 +76,19 @@ async function $do(client, security, request, options) {
         {
             fieldName: "Authorization",
             type: "http:bearer",
-            value: security?.pingID,
+            value: security?.customerAccess,
+        },
+    ], [
+        {
+            fieldName: "Authorization",
+            type: "http:bearer",
+            value: security?.interactionAccess,
         },
     ]);
     const context = {
         options: client._options,
         baseURL: options?.serverURL ?? client._baseURL ?? "",
-        operationID: "getTasks",
+        operationID: "retrieveAddress",
         oAuth2Scopes: null,
         resolvedSecurity: requestSecurity,
         securitySource: security,
@@ -113,10 +121,13 @@ async function $do(client, security, request, options) {
         return [doResult, { status: "request-error", request: req }];
     }
     const response = doResult.value;
-    const [result] = await M.match(M.json(200, operations.GetTasksResponse$inboundSchema), M.fail([400, 401, 403, 404, 405, "4XX"]), M.fail([500, 503, "5XX"]))(response, req);
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(200, models.LoqateRetrieveResponse$inboundSchema), M.jsonErr([400, 401, 404], errors.ErrorResponse$inboundSchema), M.jsonErr([500, 503], errors.ErrorResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
     if (!result.ok) {
         return [result, { status: "complete", request: req, response }];
     }
     return [result, { status: "complete", request: req, response }];
 }
-//# sourceMappingURL=tasks-list.js.map
+//# sourceMappingURL=addresses-retrieve.js.map

package/dist/commonjs/funcs/addresses-retrieve.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses-retrieve.js","sourceRoot":"","sources":["../../../src/funcs/addresses-retrieve.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCH,8CAyBC;AAzDD,+CAAiC;AAEjC,sDAAiD;AACjD,4CAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAAqD;AACrD,0CAA2C;AAS3C,kEAAoD;AAGpD,2DAA6C;AAC7C,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,MAAc,EACd,QAA4C,EAC5C,OAAuD,EACvD,OAAwB;IAexB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAc,EACd,QAA4C,EAC5C,OAAuD,EACvD,OAAwB;IAkBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,qCAAqC,CAAC,EAC5D,KAAK,CACN,EACH,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,KAAK,SAAS;QAChC,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,qCAAqC,CAAC,EAAE,CAAC;IAEjE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,eAAe,GAAG,IAAA,6BAAe,EACrC;QACE;YACE,SAAS,EAAE,eAAe;YAC1B,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,QAAQ,EAAE,cAAc;SAChC;KACF,EACD;QACE;YACE,SAAS,EAAE,eAAe;YAC1B,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,QAAQ,EAAE,iBAAiB;SACnC;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,iBAAiB;QAC9B,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,QAAQ;QACxB,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,iBAAiB,EAAE,CAAC,UAAkB,EAAE,EAAE,CACxC,IAAA,yBAAe,EAAC,EAAE,MAAM,EAAE,UAAU,EAAc,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,oCAAoC,CAAC,EACxD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,2BAA2B,CAAC,EAC9D,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,2BAA2B,CAAC,EACzD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}

package/dist/{esm/funcs/tasks-list-schema.d.ts → commonjs/funcs/addresses-search.d.ts}

@@ -2,18 +2,18 @@ import { GoCore } from "../core.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { GoError } from "../models/errors/go-error.js";
 import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
 import { ResponseValidationError } from "../models/errors/response-validation-error.js";
 import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Get Tasks Schema
+ * Search addresses via Loqate Capture
  *
  * @remarks
- * Get Tasks Schema
- *
- * If set, this operation will use {@link Security.customerAccess} from the global security.
+ * Server-side proxy for the Loqate Capture Find endpoint. Returns address suggestions for a free-text query; the Loqate API key is held server-side and never reaches the browser.
  */
-export declare function tasksListSchema(client: GoCore, request?: operations.GetTasksSchemaRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.GetTasksSchemaResponse, GoError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
-//# sourceMappingURL=tasks-list-schema.d.ts.map
+export declare function addressesSearch(client: GoCore, security: operations.SearchAddressesSecurity, request?: operations.SearchAddressesRequest | undefined, options?: RequestOptions): APIPromise<Result<models.LoqateSearchResponse, errors.ErrorResponse | GoError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=addresses-search.d.ts.map

package/dist/commonjs/funcs/addresses-search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses-search.d.ts","sourceRoot":"","sources":["../../../src/funcs/addresses-search.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAMpC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,UAAU,CAAC,uBAAuB,EAC5C,OAAO,CAAC,EAAE,UAAU,CAAC,sBAAsB,GAAG,SAAS,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,oBAAoB,EACzB,MAAM,CAAC,aAAa,GACpB,OAAO,GACP,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAOA"}

package/dist/commonjs/funcs/{tasks-update.js → addresses-search.js}

@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tasksUpdate = tasksUpdate;
+exports.addressesSearch = addressesSearch;
 const z = __importStar(require("zod/v4-mini"));
 const encodings_js_1 = require("../lib/encodings.js");
 const http_js_1 = require("../lib/http.js");
@@ -45,19 +45,21 @@ const primitives_js_1 = require("../lib/primitives.js");
 const schemas_js_1 = require("../lib/schemas.js");
 const security_js_1 = require("../lib/security.js");
 const url_js_1 = require("../lib/url.js");
+const errors = __importStar(require("../models/errors/index.js"));
+const models = __importStar(require("../models/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Put End User Data
+ * Search addresses via Loqate Capture
  *
  * @remarks
- * Put End User Data
+ * Server-side proxy for the Loqate Capture Find endpoint. Returns address suggestions for a free-text query; the Loqate API key is held server-side and never reaches the browser.
  */
-function tasksUpdate(client, security, request, options) {
+function addressesSearch(client, security, request, options) {
     return new async_js_1.APIPromise($do(client, security, request, options));
 }
 async function $do(client, security, request, options) {
-    const parsed = (0, schemas_js_1.safeParse)(request, (value) => z.parse(z.optional(operations.UpdateTaskRequest$outboundSchema), value), "Input validation failed");
+    const parsed = (0, schemas_js_1.safeParse)(request, (value) => z.parse(z.optional(operations.SearchAddressesRequest$outboundSchema), value), "Input validation failed");
     if (!parsed.ok) {
         return [parsed, { status: "invalid" }];
     }
@@ -65,7 +67,7 @@ async function $do(client, security, request, options) {
     const body = payload === undefined
         ? null
         : (0, encodings_js_1.encodeJSON)("body", payload, { explode: true });
-    const path = (0, url_js_1.pathToFunc)("/journey/task/update")();
+    const path = (0, url_js_1.pathToFunc)("/v2/captain/journey/loqate/search")();
     const headers = new Headers((0, primitives_js_1.compactMap)({
         "Content-Type": "application/json",
         Accept: "application/json",
@@ -74,13 +76,19 @@ async function $do(client, security, request, options) {
         {
             fieldName: "Authorization",
             type: "http:bearer",
-            value: security?.pingID,
+            value: security?.customerAccess,
+        },
+    ], [
+        {
+            fieldName: "Authorization",
+            type: "http:bearer",
+            value: security?.interactionAccess,
         },
     ]);
     const context = {
         options: client._options,
         baseURL: options?.serverURL ?? client._baseURL ?? "",
-        operationID: "updateTask",
+        operationID: "searchAddresses",
         oAuth2Scopes: null,
         resolvedSecurity: requestSecurity,
         securitySource: security,
@@ -113,10 +121,13 @@ async function $do(client, security, request, options) {
         return [doResult, { status: "request-error", request: req }];
     }
     const response = doResult.value;
-    const [result] = await M.match(M.json(200, operations.UpdateTaskResponse$inboundSchema), M.fail([400, 401, 403, 404, 405, "4XX"]), M.fail([500, 503, "5XX"]))(response, req);
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(200, models.LoqateSearchResponse$inboundSchema), M.jsonErr([400, 401, 404], errors.ErrorResponse$inboundSchema), M.jsonErr([500, 503], errors.ErrorResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
     if (!result.ok) {
         return [result, { status: "complete", request: req, response }];
     }
     return [result, { status: "complete", request: req, response }];
 }
-//# sourceMappingURL=tasks-update.js.map
+//# sourceMappingURL=addresses-search.js.map

package/dist/commonjs/funcs/addresses-search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresses-search.js","sourceRoot":"","sources":["../../../src/funcs/addresses-search.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCH,0CAyBC;AAzDD,+CAAiC;AAEjC,sDAAiD;AACjD,4CAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAAqD;AACrD,0CAA2C;AAS3C,kEAAoD;AAGpD,2DAA6C;AAC7C,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,eAAe,CAC7B,MAAc,EACd,QAA4C,EAC5C,OAAuD,EACvD,OAAwB;IAexB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,QAAQ,EACR,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAc,EACd,QAA4C,EAC5C,OAAuD,EACvD,OAAwB;IAkBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,CAAC,CAAC,KAAK,CACL,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,qCAAqC,CAAC,EAC5D,KAAK,CACN,EACH,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,KAAK,SAAS;QAChC,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAEnD,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,mCAAmC,CAAC,EAAE,CAAC;IAE/D,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,eAAe,GAAG,IAAA,6BAAe,EACrC;QACE;YACE,SAAS,EAAE,eAAe;YAC1B,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,QAAQ,EAAE,cAAc;SAChC;KACF,EACD;QACE;YACE,SAAS,EAAE,eAAe;YAC1B,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,QAAQ,EAAE,iBAAiB;SACnC;KACF,CACF,CAAC;IAEF,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,iBAAiB;QAC9B,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,QAAQ;QACxB,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,iBAAiB,EAAE,CAAC,UAAkB,EAAE,EAAE,CACxC,IAAA,yBAAe,EAAC,EAAE,MAAM,EAAE,UAAU,EAAc,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,kCAAkC,CAAC,EACtD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,2BAA2B,CAAC,EAC9D,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,2BAA2B,CAAC,EACzD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}

package/dist/commonjs/funcs/devices-add.d.ts

@@ -2,18 +2,20 @@ import { GoCore } from "../core.js";
 import { RequestOptions } from "../lib/sdks.js";
 import { GoError } from "../models/errors/go-error.js";
 import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
 import { ResponseValidationError } from "../models/errors/response-validation-error.js";
 import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
 import { APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 /**
- * Create Connect Secret
+ * Generate connect token
  *
  * @remarks
- * Create Connect Secret
+ * Generates a one-time connect token for device onboarding.
  *
  * If set, this operation will use {@link Security.customerAccess} from the global security.
  */
-export declare function devicesAdd(client: GoCore, request?: operations.AddDeviceRequest | undefined, options?: RequestOptions): APIPromise<Result<operations.AddDeviceResponse, GoError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+export declare function devicesAdd(client: GoCore, request?: operations.AddDeviceRequest | undefined, options?: RequestOptions): APIPromise<Result<models.DeviceStartResponse, errors.ErrorResponse | GoError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=devices-add.d.ts.map

package/dist/commonjs/funcs/devices-add.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"devices-add.d.ts","sourceRoot":"","sources":["../../../src/funcs/devices-add.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAMpC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,UAAU,CAAC,gBAAgB,GAAG,SAAS,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,iBAAiB,EAC1B,OAAO,GACP,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}
+{"version":3,"file":"devices-add.d.ts","sourceRoot":"","sources":["../../../src/funcs/devices-add.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAMpC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AACvD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,UAAU,CAAC,gBAAgB,GAAG,SAAS,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,mBAAmB,EACxB,MAAM,CAAC,aAAa,GACpB,OAAO,GACP,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}

package/dist/commonjs/funcs/devices-add.js

@@ -45,13 +45,15 @@ const primitives_js_1 = require("../lib/primitives.js");
 const schemas_js_1 = require("../lib/schemas.js");
 const security_js_1 = require("../lib/security.js");
 const url_js_1 = require("../lib/url.js");
+const errors = __importStar(require("../models/errors/index.js"));
+const models = __importStar(require("../models/index.js"));
 const operations = __importStar(require("../models/operations/index.js"));
 const async_js_1 = require("../types/async.js");
 /**
- * Create Connect Secret
+ * Generate connect token
  *
  * @remarks
- * Create Connect Secret
+ * Generates a one-time connect token for device onboarding.
  *
  * If set, this operation will use {@link Security.customerAccess} from the global security.
  */
@@ -67,7 +69,7 @@ async function $do(client, request, options) {
     const body = payload === undefined
         ? null
         : (0, encodings_js_1.encodeJSON)("body", payload, { explode: true });
-    const path = (0, url_js_1.pathToFunc)("/journey/device/start")();
+    const path = (0, url_js_1.pathToFunc)("/v2/captain/journey/device/start")();
     const headers = new Headers((0, primitives_js_1.compactMap)({
         "Content-Type": "application/json",
         Accept: "application/json",
@@ -111,7 +113,10 @@ async function $do(client, request, options) {
         return [doResult, { status: "request-error", request: req }];
     }
     const response = doResult.value;
-    const [result] = await M.match(M.json(200, operations.AddDeviceResponse$inboundSchema), M.json(201, operations.AddDeviceResponse$inboundSchema), M.fail([400, 401, 403, 404, 405, "4XX"]), M.fail([500, 503, "5XX"]))(response, req);
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(201, models.DeviceStartResponse$inboundSchema), M.jsonErr([400, 401, 403, 404], errors.ErrorResponse$inboundSchema), M.jsonErr(500, errors.ErrorResponse$inboundSchema), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
     if (!result.ok) {
         return [result, { status: "complete", request: req, response }];
     }