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

package/src/funcs/{tasks-update.ts → addresses-retrieve.ts}

@@ -20,26 +20,29 @@ import {
   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 { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Put End User Data
+ * Retrieve full address via Loqate Capture
  *
  * @remarks
- * Put End User Data
+ * Server-side proxy for the Loqate Capture Retrieve endpoint. Returns the full address detail for a given Loqate address ID.
  */
-export function tasksUpdate(
+export function addressesRetrieve(
   client: GoCore,
-  security: operations.UpdateTaskSecurity,
-  request?: operations.UpdateTaskRequest | undefined,
+  security: operations.RetrieveAddressSecurity,
+  request?: operations.RetrieveAddressRequest | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.UpdateTaskResponse,
+    models.LoqateRetrieveResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -60,13 +63,14 @@ export function tasksUpdate(
 
 async function $do(
   client: GoCore,
-  security: operations.UpdateTaskSecurity,
-  request?: operations.UpdateTaskRequest | undefined,
+  security: operations.RetrieveAddressSecurity,
+  request?: operations.RetrieveAddressRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.UpdateTaskResponse,
+      models.LoqateRetrieveResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -82,7 +86,10 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      z.parse(z.optional(operations.UpdateTaskRequest$outboundSchema), value),
+      z.parse(
+        z.optional(operations.RetrieveAddressRequest$outboundSchema),
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
@@ -93,7 +100,7 @@ async function $do(
     ? null
     : encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/journey/task/update")();
+  const path = pathToFunc("/v2/captain/journey/loqate/retrieve")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -105,7 +112,14 @@ async function $do(
       {
         fieldName: "Authorization",
         type: "http:bearer",
-        value: security?.pingID,
+        value: security?.customerAccess,
+      },
+    ],
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.interactionAccess,
       },
     ],
   );
@@ -113,7 +127,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "updateTask",
+    operationID: "retrieveAddress",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -152,8 +166,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.UpdateTaskResponse,
+    models.LoqateRetrieveResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -163,10 +182,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.UpdateTaskResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    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 }];
   }

package/src/funcs/addresses-search.ts

@@ -0,0 +1,196 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { GoCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { resolveSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Search addresses via Loqate Capture
+ *
+ * @remarks
+ * 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 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
+  >
+> {
+  return new APIPromise($do(
+    client,
+    security,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GoCore,
+  security: operations.SearchAddressesSecurity,
+  request?: operations.SearchAddressesRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.LoqateSearchResponse,
+      | errors.ErrorResponse
+      | GoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        z.optional(operations.SearchAddressesRequest$outboundSchema),
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = payload === undefined
+    ? null
+    : encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/captain/journey/loqate/search")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const requestSecurity = resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.customerAccess,
+      },
+    ],
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.interactionAccess,
+      },
+    ],
+  );
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "searchAddresses",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    models.LoqateSearchResponse,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    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 }];
+}

package/src/funcs/devices-add.ts

@@ -20,17 +20,19 @@ import {
   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 { APICall, 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.
  */
@@ -40,7 +42,8 @@ export function devicesAdd(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.AddDeviceResponse,
+    models.DeviceStartResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -65,7 +68,8 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.AddDeviceResponse,
+      models.DeviceStartResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -92,7 +96,7 @@ async function $do(
     ? null
     : encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/journey/device/start")();
+  const path = pathToFunc("/v2/captain/journey/device/start")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -145,8 +149,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.AddDeviceResponse,
+    models.DeviceStartResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -156,11 +165,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    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);
+    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 }];
   }

package/src/funcs/devices-connect.ts

@@ -20,26 +20,29 @@ import {
   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 { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Connect or Refresh End User Device
+ * Complete the device-onboarding handshake
  *
  * @remarks
- * Connect or Refresh End User Device
+ * Completes the device-onboarding handshake. See partner integration guide.
  */
 export function devicesConnect(
   client: GoCore,
   security: operations.DeviceConnectSecurity,
-  request?: operations.DeviceConnectRequest | undefined,
+  request: operations.DeviceConnectRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.DeviceConnectResponse,
+    models.DeviceConnectResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -61,12 +64,13 @@ export function devicesConnect(
 async function $do(
   client: GoCore,
   security: operations.DeviceConnectSecurity,
-  request?: operations.DeviceConnectRequest | undefined,
+  request: operations.DeviceConnectRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.DeviceConnectResponse,
+      models.DeviceConnectResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -81,22 +85,16 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      z.parse(
-        z.optional(operations.DeviceConnectRequest$outboundSchema),
-        value,
-      ),
+    (value) => z.parse(operations.DeviceConnectRequest$outboundSchema, value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/journey/device/connect")();
+  const path = pathToFunc("/v2/captain/journey/device/connect")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -155,8 +153,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.DeviceConnectResponse,
+    models.DeviceConnectResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -166,11 +169,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.DeviceConnectResponse$inboundSchema),
-    M.json(201, operations.DeviceConnectResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    M.json(201, models.DeviceConnectResponse$inboundSchema),
+    M.jsonErr([400, 401], 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 }];
   }

package/src/funcs/{health-get.ts → devices-refresh.ts}

@@ -7,7 +7,6 @@ import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
 import { RequestOptions } from "../lib/sdks.js";
-import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
 import { pathToFunc } from "../lib/url.js";
 import { GoError } from "../models/errors/go-error.js";
 import {
@@ -17,24 +16,26 @@ import {
   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 operations from "../models/operations/index.js";
+import * as models from "../models/index.js";
 import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Obtain the flow-captain health status
+ * Renew a device session
  *
  * @remarks
- * Obtain the flow-captain health status
+ * Renews a device session. See partner integration guide.
  */
-export function healthGet(
+export function devicesRefresh(
   client: GoCore,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.HealthResponse,
+    models.DeviceRefreshResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -57,7 +58,8 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.HealthResponse,
+      models.DeviceRefreshResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -70,25 +72,21 @@ async function $do(
     APICall,
   ]
 > {
-  const path = pathToFunc("/journey/health")();
+  const path = pathToFunc("/v2/captain/journey/device/refresh")();
 
   const headers = new Headers(compactMap({
     Accept: "application/json",
   }));
 
-  const secConfig = await extractSecurity(client._options.customerAccess);
-  const securityInput = secConfig == null ? {} : { customerAccess: secConfig };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "health",
+    operationID: "deviceRefresh",
     oAuth2Scopes: null,
 
-    resolvedSecurity: requestSecurity,
+    resolvedSecurity: null,
 
-    securitySource: client._options.customerAccess,
+    securitySource: null,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },
@@ -96,8 +94,7 @@ async function $do(
   };
 
   const requestRes = client._createRequest(context, {
-    security: requestSecurity,
-    method: "GET",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
@@ -121,8 +118,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.HealthResponse,
+    models.DeviceRefreshResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -132,10 +134,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.HealthResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    M.json(201, models.DeviceRefreshResponse$inboundSchema),
+    M.jsonErr(401, 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 }];
   }