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

package/src/funcs/interactions-upload-asset.ts

@@ -0,0 +1,173 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GoCore } from "../core.js";
+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 { 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 operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Stream an interaction asset to storage
+ *
+ * @remarks
+ * 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.
+ */
+export function interactionsUploadAsset(
+  client: GoCore,
+  security: operations.UploadInteractionAssetSecurity,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.UploadInteractionAssetResponse,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    security,
+    options,
+  ));
+}
+
+async function $do(
+  client: GoCore,
+  security: operations.UploadInteractionAssetSecurity,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.UploadInteractionAssetResponse,
+      | errors.ErrorResponse
+      | GoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const path = pathToFunc("/v2/captain/journey/interaction/asset/upload")();
+
+  const headers = new Headers(compactMap({
+    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: "uploadInteractionAsset",
+    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,
+    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<
+    operations.UploadInteractionAssetResponse,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.UploadInteractionAssetResponse$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 409, 422, 429],
+      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/journeys-get-schemas.ts

@@ -0,0 +1,207 @@
+/*
+ * 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 { extractSecurity, resolveGlobalSecurity } 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";
+
+/**
+ * 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.
+ *
+ * If set, this operation will use {@link Security.customerAccess} from the global security.
+ */
+export function journeysGetSchemas(
+  client: GoCore,
+  request?: operations.GetJourneySchemasRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.SchemaFetchResponse,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GoCore,
+  request?: operations.GetJourneySchemasRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.SchemaFetchResponse,
+      | errors.ErrorResponse
+      | GoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(
+        z.optional(operations.GetJourneySchemasRequest$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/schema/fetch")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.customerAccess);
+  const securityInput = secConfig == null ? {} : { customerAccess: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput, [0]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getJourneySchemas",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.customerAccess,
+    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.SchemaFetchResponse,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.SchemaFetchResponse$inboundSchema),
+    M.jsonErr([400, 401, 404, 422], 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/journeys-get-state.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";
 
 /**
- * Get State Data
+ * Fetch journey state
  *
  * @remarks
- * Get State Data
+ * Retrieves the current state of a journey instance.
  *
  * If set, this operation will use {@link Security.customerAccess} from the global security.
  */
@@ -41,6 +42,7 @@ export function journeysGetState(
 ): APIPromise<
   Result<
     operations.GetJourneyStateResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -66,6 +68,7 @@ async function $do(
   [
     Result<
       operations.GetJourneyStateResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -91,11 +94,13 @@ 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/state/fetch")();
+  const path = pathToFunc("/v2/captain/journey/state/fetch")();
+
+  const query = encodeFormQuery({
+    "view": payload?.view,
+  });
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -127,6 +132,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,
@@ -148,8 +154,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
     operations.GetJourneyStateResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -160,9 +171,11 @@ async function $do(
     | SDKValidationError
   >(
     M.json(200, operations.GetJourneyStateResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    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/journeys-start.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";
 
 /**
- * Start Journey
+ * Start a new journey
  *
  * @remarks
- * Start Journey
+ * Creates a new journey instance from a resource definition.
  *
  * If set, this operation will use {@link Security.customerAccess} from the global security.
  */
@@ -40,7 +42,8 @@ export function journeysStart(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.StartJourneyResponse,
+    models.JourneyStartResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -65,7 +68,8 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.StartJourneyResponse,
+      models.JourneyStartResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -92,7 +96,7 @@ async function $do(
     ? null
     : encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/journey/start")();
+  const path = pathToFunc("/v2/captain/journey/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.StartJourneyResponse,
+    models.JourneyStartResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -156,11 +165,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.StartJourneyResponse$inboundSchema),
-    M.json(201, operations.StartJourneyResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    M.json(201, models.JourneyStartResponse$inboundSchema),
+    M.jsonErr([400, 401, 403, 404, 429], 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/{tasks-list-schema.ts → journeys-terminate.ts}

@@ -20,27 +20,30 @@ 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 Tasks Schema
+ * Terminate journey
  *
  * @remarks
- * Get Tasks Schema
+ * Terminates an active journey instance.
  *
  * If set, this operation will use {@link Security.customerAccess} from the global security.
  */
-export function tasksListSchema(
+export function journeysTerminate(
   client: GoCore,
-  request?: operations.GetTasksSchemaRequest | undefined,
+  request?: operations.TerminateJourneyRequest | undefined,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetTasksSchemaResponse,
+    models.TerminateResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -60,12 +63,13 @@ export function tasksListSchema(
 
 async function $do(
   client: GoCore,
-  request?: operations.GetTasksSchemaRequest | undefined,
+  request?: operations.TerminateJourneyRequest | undefined,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.GetTasksSchemaResponse,
+      models.TerminateResponse,
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -82,7 +86,7 @@ async function $do(
     request,
     (value) =>
       z.parse(
-        z.optional(operations.GetTasksSchemaRequest$outboundSchema),
+        z.optional(operations.TerminateJourneyRequest$outboundSchema),
         value,
       ),
     "Input validation failed",
@@ -95,7 +99,7 @@ async function $do(
     ? null
     : encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/journey/task/list/schema")();
+  const path = pathToFunc("/v2/captain/journey/terminate")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -109,7 +113,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "getTasksSchema",
+    operationID: "terminateJourney",
     oAuth2Scopes: null,
 
     resolvedSecurity: requestSecurity,
@@ -148,8 +152,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.GetTasksSchemaResponse,
+    models.TerminateResponse,
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -159,10 +168,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetTasksSchemaResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    M.json(200, models.TerminateResponse$inboundSchema),
+    M.jsonErr([400, 401, 404, 409], 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 }];
   }