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

package/src/funcs/sandbox-list-scenarios.ts

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { GoCore } from "../core.js";
+import { encodeFormQuery, 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 { 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";
+
+/**
+ * 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.
+ *
+ * If set, this operation will use {@link Security.customerAccess} from the global security.
+ */
+export function sandboxListScenarios(
+  client: GoCore,
+  request: operations.ListSandboxScenariosRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Array<models.SandboxScenarioSummary>,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GoCore,
+  request: operations.ListSandboxScenariosRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Array<models.SandboxScenarioSummary>,
+      | errors.ErrorResponse
+      | GoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(operations.ListSandboxScenariosRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    journeyId: encodeSimple("journeyId", payload.journeyId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/v2/captain/sandbox/journeys/{journeyId}/scenarios")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "includePlatform": payload.includePlatform,
+  });
+
+  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, [0]);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "listSandboxScenarios",
+    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: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    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<
+    Array<models.SandboxScenarioSummary>,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, z.array(models.SandboxScenarioSummary$inboundSchema)),
+    M.jsonErr([400, 401, 403], errors.ErrorResponse$inboundSchema),
+    M.jsonErr(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/sandbox-put-scenario.ts

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { GoCore } from "../core.js";
+import { encodeJSON, 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 { 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";
+
+/**
+ * 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.
+ *
+ * If set, this operation will use {@link Security.customerAccess} from the global security.
+ */
+export function sandboxPutScenario(
+  client: GoCore,
+  request: operations.PutSandboxScenarioRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    models.SandboxScenarioWritten,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GoCore,
+  request: operations.PutSandboxScenarioRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      models.SandboxScenarioWritten,
+      | errors.ErrorResponse
+      | GoError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(operations.PutSandboxScenarioRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.body, { explode: true });
+
+  const pathParams = {
+    journeyId: encodeSimple("journeyId", payload.journeyId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    name: encodeSimple("name", payload.name, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/v2/captain/sandbox/journeys/{journeyId}/scenarios/{name}",
+  )(pathParams);
+
+  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: "putSandboxScenario",
+    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: "PUT",
+    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.SandboxScenarioWritten,
+    | errors.ErrorResponse
+    | GoError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, models.SandboxScenarioWritten$inboundSchema),
+    M.jsonErr([400, 401, 403, 404], errors.ErrorResponse$inboundSchema),
+    M.jsonErr(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/tasks-get-schema.ts

@@ -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,12 +28,14 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get Task Schema
+ * Fetch V1-compat task schema
  *
  * @remarks
- * Get Task Schema
+ * V1 compatibility shim. Returns a Draft-07 JSON Schema for the active interaction of the journey identified by taskId (taskId = V2 instanceId), or { processing: true } while modules execute.
  *
  * If set, this operation will use {@link Security.customerAccess} from the global security.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
  */
 export function tasksGetSchema(
   client: GoCore,
@@ -40,7 +43,8 @@ export function tasksGetSchema(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.GetTaskSchemaResponse,
+    { [k: string]: any },
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -65,7 +69,8 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetTaskSchemaResponse,
+      { [k: string]: any },
+      | errors.ErrorResponse
       | GoError
       | ResponseValidationError
       | ConnectionError
@@ -95,7 +100,7 @@ async function $do(
     ? null
     : encodeJSON("body", payload, { explode: true });
 
-  const path = pathToFunc("/journey/task/schema")();
+  const path = pathToFunc("/v2/captain/journey/task/schema")();
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
@@ -148,8 +153,13 @@ async function $do(
   }
   const response = doResult.value;
 
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
   const [result] = await M.match<
-    operations.GetTaskSchemaResponse,
+    { [k: string]: any },
+    | errors.ErrorResponse
     | GoError
     | ResponseValidationError
     | ConnectionError
@@ -159,10 +169,12 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.GetTaskSchemaResponse$inboundSchema),
-    M.fail([400, 401, 403, 404, 405, "4XX"]),
-    M.fail([500, 503, "5XX"]),
-  )(response, req);
+    M.json(200, z.record(z.string(), z.any())),
+    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/tokens-generate.ts

@@ -109,7 +109,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: baseURL ?? "",
-    operationID: "post_/as/token.oauth2",
+    operationID: "postAsTokenOauth2",
     oAuth2Scopes: null,
 
     resolvedSecurity: null,

package/src/lib/config.ts

@@ -11,9 +11,18 @@ import { Params, pathToFunc } from "./url.js";
  * Contains the list of servers available to the SDK
  */
 export const ServerList = [
-  "https://eu.platform.go.gbgplc.com/v2/captain",
-  "https://us.platform.go.gbgplc.com/v2/captain",
-  "https://au.platform.go.gbgplc.com/v2/captain",
+  /**
+   * EU
+   */
+  "https://eu.platform.go.gbgplc.com",
+  /**
+   * US
+   */
+  "https://us.platform.go.gbgplc.com",
+  /**
+   * AU
+   */
+  "https://au.platform.go.gbgplc.com",
 ] as const;
 
 export type SDKOptions = {
@@ -59,8 +68,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "1.0.0",
-  sdkVersion: "0.1.2",
-  genVersion: "2.937.18",
-  userAgent: "speakeasy-sdk/typescript 0.1.2 2.937.18 1.0.0 @gbg/go-core",
+  openapiDocVersion: "2.x",
+  sdkVersion: "0.2.0-alpha.0",
+  genVersion: "2.946.0",
+  userAgent: "speakeasy-sdk/typescript 0.2.0-alpha.0 2.946.0 2.x @gbg/go-core",
 } as const;

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

@@ -0,0 +1,65 @@
+/*
+ * 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 CreateSandboxScenarioRequestData = {};
+
+export type CreateSandboxScenarioRequest = {
+  /**
+   * Scenario identifier, unique per journey (GGO-18332). The same name may exist on other journeys of the org with different content.
+   */
+  name: string;
+  /**
+   * 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: CreateSandboxScenarioRequestData;
+};
+
+/** @internal */
+export type CreateSandboxScenarioRequestData$Outbound = {};
+
+/** @internal */
+export const CreateSandboxScenarioRequestData$outboundSchema: z.ZodMiniType<
+  CreateSandboxScenarioRequestData$Outbound,
+  CreateSandboxScenarioRequestData
+> = z.object({});
+
+export function createSandboxScenarioRequestDataToJSON(
+  createSandboxScenarioRequestData: CreateSandboxScenarioRequestData,
+): string {
+  return JSON.stringify(
+    CreateSandboxScenarioRequestData$outboundSchema.parse(
+      createSandboxScenarioRequestData,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateSandboxScenarioRequest$Outbound = {
+  name: string;
+  data: CreateSandboxScenarioRequestData$Outbound;
+};
+
+/** @internal */
+export const CreateSandboxScenarioRequest$outboundSchema: z.ZodMiniType<
+  CreateSandboxScenarioRequest$Outbound,
+  CreateSandboxScenarioRequest
+> = z.object({
+  name: z.string(),
+  data: z.lazy(() => CreateSandboxScenarioRequestData$outboundSchema),
+});
+
+export function createSandboxScenarioRequestToJSON(
+  createSandboxScenarioRequest: CreateSandboxScenarioRequest,
+): string {
+  return JSON.stringify(
+    CreateSandboxScenarioRequest$outboundSchema.parse(
+      createSandboxScenarioRequest,
+    ),
+  );
+}

package/src/models/delete-response.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.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 const DeleteResponseStatus = {
+  Deleted: "deleted",
+} as const;
+export type DeleteResponseStatus = ClosedEnum<typeof DeleteResponseStatus>;
+
+export type DeleteResponse = {
+  instanceId: string;
+  status: DeleteResponseStatus;
+  message: string;
+};
+
+/** @internal */
+export const DeleteResponseStatus$inboundSchema: z.ZodMiniEnum<
+  typeof DeleteResponseStatus
+> = z.enum(DeleteResponseStatus);
+
+/** @internal */
+export const DeleteResponse$inboundSchema: z.ZodMiniType<
+  DeleteResponse,
+  unknown
+> = z.object({
+  instanceId: types.string(),
+  status: DeleteResponseStatus$inboundSchema,
+  message: types.string(),
+});
+
+export function deleteResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteResponse' from JSON`,
+  );
+}

package/src/models/device-connect-response.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../lib/schemas.js";
+import { ClosedEnum } from "../types/enums.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 const DeviceConnectResponseTokenType = {
+  EndUser: "end-user",
+} as const;
+export type DeviceConnectResponseTokenType = ClosedEnum<
+  typeof DeviceConnectResponseTokenType
+>;
+
+export type DeviceConnectResponse = {
+  endUserToken: string;
+  tokenType: DeviceConnectResponseTokenType;
+  expiresIn: number;
+  instanceId: string;
+  resumeCredential?: string | undefined;
+  credentialExpiresAt?: string | undefined;
+  credentialExpiresIn?: number | undefined;
+};
+
+/** @internal */
+export const DeviceConnectResponseTokenType$inboundSchema: z.ZodMiniEnum<
+  typeof DeviceConnectResponseTokenType
+> = z.enum(DeviceConnectResponseTokenType);
+
+/** @internal */
+export const DeviceConnectResponse$inboundSchema: z.ZodMiniType<
+  DeviceConnectResponse,
+  unknown
+> = z.object({
+  endUserToken: types.string(),
+  tokenType: DeviceConnectResponseTokenType$inboundSchema,
+  expiresIn: types.number(),
+  instanceId: types.string(),
+  resumeCredential: types.optional(types.string()),
+  credentialExpiresAt: types.optional(types.string()),
+  credentialExpiresIn: types.optional(types.number()),
+});
+
+export function deviceConnectResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeviceConnectResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeviceConnectResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeviceConnectResponse' from JSON`,
+  );
+}