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

package/src/models/state-fetch-response.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type StateFetchResponse = {
+  instanceId: string;
+  status: string;
+  context?: { [k: string]: any } | undefined;
+  result?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const StateFetchResponse$inboundSchema: z.ZodMiniType<
+  StateFetchResponse,
+  unknown
+> = z.object({
+  instanceId: types.string(),
+  status: types.string(),
+  context: types.optional(z.record(z.string(), z.any())),
+  result: types.optional(z.record(z.string(), z.any())),
+});
+
+export function stateFetchResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<StateFetchResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StateFetchResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StateFetchResponse' from JSON`,
+  );
+}

package/src/models/terminate-response.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import * as types from "../types/primitives.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type TerminateResponse = {
+  instanceId: string;
+};
+
+/** @internal */
+export const TerminateResponse$inboundSchema: z.ZodMiniType<
+  TerminateResponse,
+  unknown
+> = z.object({
+  instanceId: types.string(),
+});
+
+export function terminateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<TerminateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TerminateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TerminateResponse' from JSON`,
+  );
+}

package/src/models/update-sandbox-scenario-request.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+/**
+ * Scenario payload (ScenarioPayload). Requires `modules`; optionally `defaultOutcome`, `description`, and extra passthrough fields. Validated by the store against the same schema the sandbox runtime enforces, so an accepted document is guaranteed runnable.
+ */
+export type UpdateSandboxScenarioRequestData = {};
+
+export type UpdateSandboxScenarioRequest = {
+  /**
+   * Scenario payload (ScenarioPayload). Requires `modules`; optionally `defaultOutcome`, `description`, and extra passthrough fields. Validated by the store against the same schema the sandbox runtime enforces, so an accepted document is guaranteed runnable.
+   */
+  data: UpdateSandboxScenarioRequestData;
+};
+
+/** @internal */
+export type UpdateSandboxScenarioRequestData$Outbound = {};
+
+/** @internal */
+export const UpdateSandboxScenarioRequestData$outboundSchema: z.ZodMiniType<
+  UpdateSandboxScenarioRequestData$Outbound,
+  UpdateSandboxScenarioRequestData
+> = z.object({});
+
+export function updateSandboxScenarioRequestDataToJSON(
+  updateSandboxScenarioRequestData: UpdateSandboxScenarioRequestData,
+): string {
+  return JSON.stringify(
+    UpdateSandboxScenarioRequestData$outboundSchema.parse(
+      updateSandboxScenarioRequestData,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateSandboxScenarioRequest$Outbound = {
+  data: UpdateSandboxScenarioRequestData$Outbound;
+};
+
+/** @internal */
+export const UpdateSandboxScenarioRequest$outboundSchema: z.ZodMiniType<
+  UpdateSandboxScenarioRequest$Outbound,
+  UpdateSandboxScenarioRequest
+> = z.object({
+  data: z.lazy(() => UpdateSandboxScenarioRequestData$outboundSchema),
+});
+
+export function updateSandboxScenarioRequestToJSON(
+  updateSandboxScenarioRequest: UpdateSandboxScenarioRequest,
+): string {
+  return JSON.stringify(
+    UpdateSandboxScenarioRequest$outboundSchema.parse(
+      updateSandboxScenarioRequest,
+    ),
+  );
+}

package/src/sdk/addresses.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { addressesRetrieve } from "../funcs/addresses-retrieve.js";
+import { addressesSearch } from "../funcs/addresses-search.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Addresses extends ClientSDK {
+  /**
+   * 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.
+   */
+  async search(
+    security: operations.SearchAddressesSecurity,
+    request?: operations.SearchAddressesRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.LoqateSearchResponse> {
+    return unwrapAsync(addressesSearch(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * 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.
+   */
+  async retrieve(
+    security: operations.RetrieveAddressSecurity,
+    request?: operations.RetrieveAddressRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.LoqateRetrieveResponse> {
+    return unwrapAsync(addressesRetrieve(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/devices.ts

@@ -4,22 +4,42 @@
 
 import { devicesAdd } from "../funcs/devices-add.js";
 import { devicesConnect } from "../funcs/devices-connect.js";
+import { devicesRefresh } from "../funcs/devices-refresh.js";
+import { devicesValidate } from "../funcs/devices-validate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Devices extends ClientSDK {
   /**
-   * Connect or Refresh End User Device
+   * Generate connect token
    *
    * @remarks
-   * Connect or Refresh End User Device
+   * Generates a one-time connect token for device onboarding.
+   */
+  async add(
+    request?: operations.AddDeviceRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.DeviceStartResponse> {
+    return unwrapAsync(devicesAdd(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Complete the device-onboarding handshake
+   *
+   * @remarks
+   * Completes the device-onboarding handshake. See partner integration guide.
    */
   async connect(
     security: operations.DeviceConnectSecurity,
-    request?: operations.DeviceConnectRequest | undefined,
+    request: operations.DeviceConnectRequest,
     options?: RequestOptions,
-  ): Promise<operations.DeviceConnectResponse> {
+  ): Promise<models.DeviceConnectResponse> {
     return unwrapAsync(devicesConnect(
       this,
       security,
@@ -29,18 +49,33 @@ export class Devices extends ClientSDK {
   }
 
   /**
-   * Create Connect Secret
+   * Renew a device session
    *
    * @remarks
-   * Create Connect Secret
+   * Renews a device session. See partner integration guide.
    */
-  async add(
-    request?: operations.AddDeviceRequest | undefined,
+  async refresh(
     options?: RequestOptions,
-  ): Promise<operations.AddDeviceResponse> {
-    return unwrapAsync(devicesAdd(
+  ): Promise<models.DeviceRefreshResponse> {
+    return unwrapAsync(devicesRefresh(
       this,
-      request,
+      options,
+    ));
+  }
+
+  /**
+   * Validate end-user session
+   *
+   * @remarks
+   * Validates an end-user JWT and returns session information.
+   */
+  async validate(
+    security: operations.DeviceValidateSecurity,
+    options?: RequestOptions,
+  ): Promise<models.DeviceValidateResponse> {
+    return unwrapAsync(devicesValidate(
+      this,
+      security,
       options,
     ));
   }

package/src/sdk/instances.ts

@@ -3,21 +3,42 @@
  */
 
 import { instancesDelete } from "../funcs/instances-delete.js";
+import { instancesHandoffToken } from "../funcs/instances-handoff-token.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Instances extends ClientSDK {
   /**
-   * Delete instance
+   * Mint a fresh position-scoped handoff token
    *
    * @remarks
-   * Delete instance
+   * 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 }.
+   */
+  async handoffToken(
+    security: operations.CreateHandoffTokenSecurity,
+    request: operations.CreateHandoffTokenRequest,
+    options?: RequestOptions,
+  ): Promise<models.HandoffTokenResponse> {
+    return unwrapAsync(instancesHandoffToken(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete journey state
+   *
+   * @remarks
+   * Permanently deletes a completed journey instance (REQ-02-002).
    */
   async delete(
     request?: operations.DeleteInstanceRequest | undefined,
     options?: RequestOptions,
-  ): Promise<operations.DeleteInstanceResponse> {
+  ): Promise<models.DeleteResponse> {
     return unwrapAsync(instancesDelete(
       this,
       request,

package/src/sdk/interactions.ts

@@ -4,22 +4,43 @@
 
 import { interactionsFetch } from "../funcs/interactions-fetch.js";
 import { interactionsSubmit } from "../funcs/interactions-submit.js";
+import { interactionsUploadAsset } from "../funcs/interactions-upload-asset.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Interactions extends ClientSDK {
   /**
-   * Submit Interaction
+   * Fetch current interaction
    *
    * @remarks
-   * Submit Interaction
+   * Retrieves the current interaction state for a journey instance.
+   */
+  async fetch(
+    security: operations.FetchInteractionSecurity,
+    request?: operations.FetchInteractionRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.FetchInteractionResponse> {
+    return unwrapAsync(interactionsFetch(
+      this,
+      security,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Submit interaction data
+   *
+   * @remarks
+   * Submits participant data for an interaction.
    */
   async submit(
     security: operations.SubmitInteractionSecurity,
     request?: operations.SubmitInteractionRequest | undefined,
     options?: RequestOptions,
-  ): Promise<operations.SubmitInteractionResponse> {
+  ): Promise<models.InteractionSubmitResponse> {
     return unwrapAsync(interactionsSubmit(
       this,
       security,
@@ -29,20 +50,18 @@ export class Interactions extends ClientSDK {
   }
 
   /**
-   * Fetch Interaction
+   * Stream an interaction asset to storage
    *
    * @remarks
-   * Fetch Interaction
+   * Streams a raw asset body (application/octet-stream) to storage and returns its gofs key. Identifiers are passed as X-Instance-Id, X-Interaction-Id and X-Domain-Element-Id headers. Accepts capture elements: the encrypted selfie (EncryptedSelfie/selfieImage), the plain selfie (Selfie/selfieImage), and both document sides (PrimaryDocument/side1Image, PrimaryDocument/side2Image). An element the current deployment does not accept returns 422 — submit that asset inline (base64) in the interaction submit instead.
    */
-  async fetch(
-    security: operations.FetchInteractionSecurity,
-    request?: operations.FetchInteractionRequest | undefined,
+  async uploadAsset(
+    security: operations.UploadInteractionAssetSecurity,
     options?: RequestOptions,
-  ): Promise<operations.FetchInteractionResponse> {
-    return unwrapAsync(interactionsFetch(
+  ): Promise<operations.UploadInteractionAssetResponse> {
+    return unwrapAsync(interactionsUploadAsset(
       this,
       security,
-      request,
       options,
     ));
   }

package/src/sdk/journeys.ts

@@ -2,23 +2,26 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { journeysGetSchemas } from "../funcs/journeys-get-schemas.js";
 import { journeysGetState } from "../funcs/journeys-get-state.js";
 import { journeysStart } from "../funcs/journeys-start.js";
+import { journeysTerminate } from "../funcs/journeys-terminate.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class Journeys extends ClientSDK {
   /**
-   * Start Journey
+   * Start a new journey
    *
    * @remarks
-   * Start Journey
+   * Creates a new journey instance from a resource definition.
    */
   async start(
     request?: operations.StartJourneyRequest | undefined,
     options?: RequestOptions,
-  ): Promise<operations.StartJourneyResponse> {
+  ): Promise<models.JourneyStartResponse> {
     return unwrapAsync(journeysStart(
       this,
       request,
@@ -27,10 +30,10 @@ export class Journeys extends ClientSDK {
   }
 
   /**
-   * Get State Data
+   * Fetch journey state
    *
    * @remarks
-   * Get State Data
+   * Retrieves the current state of a journey instance.
    */
   async getState(
     request?: operations.GetJourneyStateRequest | undefined,
@@ -42,4 +45,63 @@ export class Journeys extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Fetch interaction JSON schemas
+   *
+   * @remarks
+   * Retrieves design-time JSON schemas for the interactions in a delivery — what information the journey
+   * expects a user to complete, which fields are required, and what shape they take.
+   *
+   * Identifiers are short on both sides; this endpoint never accepts or returns a GRN.
+   * `resourceId` is the same short identifier `POST /journey/start` takes (`my-delivery@latest`), and the
+   * organization is derived from your token. The response reports the short `deliveryId` plus
+   * `resolvedVersion`, the concrete revision it resolved — join them as `<deliveryId>@<resolvedVersion>` to
+   * pin `/journey/start` to exactly the revision these schemas describe (`@latest` is an alias, not a
+   * snapshot).
+   *
+   * Two caveats on that pin. `/journey/start` serves from a cache, so it can briefly run a revision behind
+   * the one described here. And the pin is only startable when the delivery lives in your token's primary
+   * organization: this endpoint also searches organizations granted by the token's `x_orgs` federation
+   * claim, which `/journey/start` does not, so a delivery found only through federation is readable here
+   * but not startable with the same token.
+   *
+   * Known limitation on that federated search: a delivery that a parent organization *linked* into yours
+   * is not currently followed to its source and reports 404 here, even though `/journey/start` can run it.
+   *
+   * Filters by `interactionId` and/or `instruction` are optional; `instruction` requires `interactionId`.
+   * `interactionId` is the short interaction id (e.g. `segment1`) — a GRN, or a short id carrying an
+   * `@version` suffix, is rejected with 400.
+   *
+   * Note: the `interactionId` reported here is a design-time label for reading the journey. It is not the
+   * identifier `POST /journey/interaction/submit` expects — that one comes from
+   * `POST /journey/interaction/fetch`, which uses the runtime's own identifiers.
+   */
+  async getSchemas(
+    request?: operations.GetJourneySchemasRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.SchemaFetchResponse> {
+    return unwrapAsync(journeysGetSchemas(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Terminate journey
+   *
+   * @remarks
+   * Terminates an active journey instance.
+   */
+  async terminate(
+    request?: operations.TerminateJourneyRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<models.TerminateResponse> {
+    return unwrapAsync(journeysTerminate(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/sandbox.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { sandboxCreateScenario } from "../funcs/sandbox-create-scenario.js";
+import { sandboxDeleteScenario } from "../funcs/sandbox-delete-scenario.js";
+import { sandboxGetScenario } from "../funcs/sandbox-get-scenario.js";
+import { sandboxListScenarios } from "../funcs/sandbox-list-scenarios.js";
+import { sandboxPutScenario } from "../funcs/sandbox-put-scenario.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Sandbox extends ClientSDK {
+  /**
+   * Create a sandbox scenario on a journey
+   *
+   * @remarks
+   * Creates an org-tier sandbox scenario belonging to the journey in the path. Returns 409 if the name is taken on that journey (the same name may exist on other journeys). The scenario is resolvable at journey-start, for runs of that journey only, via the x-gbg-scenario header. Org is taken from the token.
+   */
+  async createScenario(
+    request: operations.CreateSandboxScenarioRequest,
+    options?: RequestOptions,
+  ): Promise<models.SandboxScenarioWritten> {
+    return unwrapAsync(sandboxCreateScenario(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List a journey's sandbox scenarios
+   *
+   * @remarks
+   * Lists the org's sandbox scenarios belonging to the journey in the path — never another journey's. Pass includePlatform=true to also return read-only GBG-provided platform scenarios (available on every journey); an org scenario shadows a platform scenario of the same name.
+   */
+  async listScenarios(
+    request: operations.ListSandboxScenariosRequest,
+    options?: RequestOptions,
+  ): Promise<Array<models.SandboxScenarioSummary>> {
+    return unwrapAsync(sandboxListScenarios(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Read a sandbox scenario
+   *
+   * @remarks
+   * Reads one org-tier sandbox scenario of the journey in the path. By default does not fall back to the platform tier or to another journey, so a name that exists only at platform level, or only on another journey, returns 404. Pass includePlatform=true to fall back to the read-only GBG-provided scenario of that name; the response `tier` says which tier served it. Another journey is never consulted either way.
+   */
+  async getScenario(
+    request: operations.GetSandboxScenarioRequest,
+    options?: RequestOptions,
+  ): Promise<models.SandboxScenario> {
+    return unwrapAsync(sandboxGetScenario(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Replace a sandbox scenario
+   *
+   * @remarks
+   * Replaces an existing org-tier sandbox scenario of the journey in the path. Returns 404 if it does not exist on that journey — use POST to create. Requires UPDATE:journey; creating (POST) requires CREATE:journey, so an edit-only grant cannot mint new scenarios through this endpoint.
+   */
+  async putScenario(
+    request: operations.PutSandboxScenarioRequest,
+    options?: RequestOptions,
+  ): Promise<models.SandboxScenarioWritten> {
+    return unwrapAsync(sandboxPutScenario(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Delete a sandbox scenario
+   *
+   * @remarks
+   * Deletes an org-tier sandbox scenario of the journey in the path by archiving it: it disappears from listings and journey-start resolution, but its version history is retained and creating the same name again restores it. A platform scenario of the same name, previously shadowed by this one on this journey, becomes resolvable again at journey-start.
+   */
+  async deleteScenario(
+    request: operations.DeleteSandboxScenarioRequest,
+    options?: RequestOptions,
+  ): Promise<void> {
+    return unwrapAsync(sandboxDeleteScenario(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/sdk.ts

@@ -3,28 +3,34 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
+import { Addresses } from "./addresses.js";
 import { Devices } from "./devices.js";
-import { Health } from "./health.js";
 import { Instances } from "./instances.js";
 import { Interactions } from "./interactions.js";
 import { Journeys } from "./journeys.js";
+import { Sandbox } from "./sandbox.js";
 import { Tasks } from "./tasks.js";
 import { Tokens } from "./tokens.js";
 
 export class Go extends ClientSDK {
-  private _tokens?: Tokens;
-  get tokens(): Tokens {
-    return (this._tokens ??= new Tokens(this._options));
+  private _journeys?: Journeys;
+  get journeys(): Journeys {
+    return (this._journeys ??= new Journeys(this._options));
   }
 
-  private _health?: Health;
-  get health(): Health {
-    return (this._health ??= new Health(this._options));
+  private _interactions?: Interactions;
+  get interactions(): Interactions {
+    return (this._interactions ??= new Interactions(this._options));
   }
 
-  private _devices?: Devices;
-  get devices(): Devices {
-    return (this._devices ??= new Devices(this._options));
+  private _instances?: Instances;
+  get instances(): Instances {
+    return (this._instances ??= new Instances(this._options));
+  }
+
+  private _addresses?: Addresses;
+  get addresses(): Addresses {
+    return (this._addresses ??= new Addresses(this._options));
   }
 
   private _tasks?: Tasks;
@@ -32,18 +38,18 @@ export class Go extends ClientSDK {
     return (this._tasks ??= new Tasks(this._options));
   }
 
-  private _journeys?: Journeys;
-  get journeys(): Journeys {
-    return (this._journeys ??= new Journeys(this._options));
+  private _devices?: Devices;
+  get devices(): Devices {
+    return (this._devices ??= new Devices(this._options));
   }
 
-  private _instances?: Instances;
-  get instances(): Instances {
-    return (this._instances ??= new Instances(this._options));
+  private _sandbox?: Sandbox;
+  get sandbox(): Sandbox {
+    return (this._sandbox ??= new Sandbox(this._options));
   }
 
-  private _interactions?: Interactions;
-  get interactions(): Interactions {
-    return (this._interactions ??= new Interactions(this._options));
+  private _tokens?: Tokens;
+  get tokens(): Tokens {
+    return (this._tokens ??= new Tokens(this._options));
   }
 }