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

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("/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 }];
   }

package/src/funcs/{tasks-list.ts → devices-validate.ts}

@@ -2,13 +2,10 @@
  * 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";
@@ -20,26 +17,28 @@ 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";
 
 /**
- * Get End User Tasks
+ * Validate end-user session
  *
  * @remarks
- * Get End User Tasks
+ * Validates an end-user JWT and returns session information.
  */
-export function tasksList(
+export function devicesValidate(
   client: GoCore,
-  security: operations.GetTasksSecurity,
-  request?: operations.GetTasksRequest | undefined,
+  security: operations.DeviceValidateSecurity,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetTasksResponse,
+    models.DeviceValidateResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -53,20 +52,19 @@ export function tasksList(
   return new APIPromise($do(
     client,
     security,
-    request,
     options,
   ));
 }
 
 async function $do(
   client: GoCore,
-  security: operations.GetTasksSecurity,
-  request?: operations.GetTasksRequest | undefined,
+  security: operations.DeviceValidateSecurity,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.GetTasksResponse,
+      models.DeviceValidateResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -79,24 +77,9 @@ async function $do(
     APICall,
   ]
 > {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      z.parse(z.optional(operations.GetTasksRequest$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("/journey/task/list")();
+  const path = pathToFunc("/journey/device/validate")();
 
   const headers = new Headers(compactMap({
-    "Content-Type": "application/json",
     Accept: "application/json",
   }));
 
@@ -105,7 +88,7 @@ async function $do(
       {
         fieldName: "Authorization",
         type: "http:bearer",
-        value: security?.pingID,
+        value: security?.interactionAccess,
       },
     ],
   );
@@ -113,7 +96,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getTasks",
+    operationID: "deviceValidate",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -131,7 +114,6 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
-    body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
   }, options);
@@ -152,8 +134,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.GetTasksResponse,
+    models.DeviceValidateResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -163,10 +150,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetTasksResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    M.json(200, models.DeviceValidateResponse$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 }];
   }

package/src/funcs/instances-delete.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";
 
 /**
- * Delete instance
+ * Delete journey state
  *
  * @remarks
- * Delete instance
+ * Permanently deletes a completed journey instance (REQ-02-002).
  *
  * If set, this operation will use {@link Security.customerAccess} from the global security.
  */
@@ -40,7 +42,8 @@ export function instancesDelete(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.DeleteInstanceResponse,
+    models.DeleteResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -65,7 +68,8 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.DeleteInstanceResponse,
+      models.DeleteResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -148,8 +152,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.DeleteInstanceResponse,
+    models.DeleteResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -159,10 +168,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.DeleteInstanceResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    M.json(200, models.DeleteResponse$inboundSchema),
+    M.jsonErr([400, 401, 403, 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/instances-handoff-token.ts

@@ -0,0 +1,191 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { GoCore } from "../core.js";
+import { encodeSimple } 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";
+
+/**
+ * Mint a fresh position-scoped handoff token
+ *
+ * @remarks
+ * Mints a fresh page-mode delivery-token + connect-secret pair pointing at the same instance, stamped devicePosition=joined, so a second device can join. Device-token only, and only from the device that started the journey; customer tokens and already-joined devices are rejected with 403. Returns { instanceUrl, devicePosition, expiresIn }.
+ */
+export function instancesHandoffToken(
+  client: GoCore,
+  security: operations.CreateHandoffTokenSecurity,
+  request: operations.CreateHandoffTokenRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.HandoffTokenResponse,
+    | 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.CreateHandoffTokenSecurity,
+  request: operations.CreateHandoffTokenRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.HandoffTokenResponse,
+      | errors.ErrorResponse
+      | GoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(operations.CreateHandoffTokenRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    instanceId: encodeSimple("instanceId", payload.instanceId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/journey/instance/{instanceId}/handoff-token")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const requestSecurity = resolveSecurity(
+    [
+      {
+        fieldName: "Authorization",
+        type: "http:bearer",
+        value: security?.interactionAccess,
+      },
+    ],
+  );
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "createHandoffToken",
+    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.HandoffTokenResponse,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, models.HandoffTokenResponse$inboundSchema),
+    M.jsonErr([400, 401, 403, 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/interactions-fetch.ts

@@ -4,7 +4,7 @@
 
 import * as z from "zod/v4-mini";
 import { GoCore } from "../core.js";
-import { encodeJSON } from "../lib/encodings.js";
+import { encodeFormQuery, encodeJSON } from "../lib/encodings.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -20,6 +20,7 @@ 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";
@@ -27,10 +28,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Fetch Interaction
+ * Fetch current interaction
  *
  * @remarks
- * Fetch Interaction
+ * Retrieves the current interaction state for a journey instance.
  */
 export function interactionsFetch(
   client: GoCore,
@@ -40,6 +41,7 @@ export function interactionsFetch(
 ): APIPromise<
   Result<
     operations.FetchInteractionResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -67,6 +69,7 @@ async function $do(
   [
     Result<
       operations.FetchInteractionResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -92,18 +95,27 @@ async function $do(
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload?.body, { explode: true });
 
   const path = pathToFunc("/journey/interaction/fetch")();
 
+  const query = encodeFormQuery({
+    "view": payload?.view,
+  });
+
   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",
@@ -134,6 +146,7 @@ async function $do(
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
+    query: query,
     body: body,
     userAgent: client._options.userAgent,
     timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
@@ -155,8 +168,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     operations.FetchInteractionResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -167,9 +185,11 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, operations.FetchInteractionResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    M.jsonErr([400, 401, 403, 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 }];
   }