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

package/src/models/operations/terminate-journey.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type TerminateJourneyRequest = {
+  /**
+   * Journey Instance Id, a unique identifier for a started journey instance.
+   */
+  instanceId: string;
+  reason?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export type TerminateJourneyRequest$Outbound = {
+  instanceId: string;
+  reason?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const TerminateJourneyRequest$outboundSchema: z.ZodMiniType<
+  TerminateJourneyRequest$Outbound,
+  TerminateJourneyRequest
+> = z.catchall(
+  z.object({
+    instanceId: z.string(),
+    reason: z.optional(z.string()),
+  }),
+  z.any(),
+);
+
+export function terminateJourneyRequestToJSON(
+  terminateJourneyRequest: TerminateJourneyRequest,
+): string {
+  return JSON.stringify(
+    TerminateJourneyRequest$outboundSchema.parse(terminateJourneyRequest),
+  );
+}

package/src/models/operations/upload-interaction-asset.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+
+export type UploadInteractionAssetSecurity = {
+  customerAccess?: string | undefined;
+  interactionAccess?: string | undefined;
+};
+
+/**
+ * Asset stored; returns the gofs key to reference in the subsequent submit
+ */
+export type UploadInteractionAssetResponse = {
+  domainElementId: string;
+  gofsKey: string;
+};
+
+/** @internal */
+export type UploadInteractionAssetSecurity$Outbound = {
+  CustomerAccess?: string | undefined;
+  InteractionAccess?: string | undefined;
+};
+
+/** @internal */
+export const UploadInteractionAssetSecurity$outboundSchema: z.ZodMiniType<
+  UploadInteractionAssetSecurity$Outbound,
+  UploadInteractionAssetSecurity
+> = z.pipe(
+  z.object({
+    customerAccess: z.optional(z.string()),
+    interactionAccess: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      customerAccess: "CustomerAccess",
+      interactionAccess: "InteractionAccess",
+    });
+  }),
+);
+
+export function uploadInteractionAssetSecurityToJSON(
+  uploadInteractionAssetSecurity: UploadInteractionAssetSecurity,
+): string {
+  return JSON.stringify(
+    UploadInteractionAssetSecurity$outboundSchema.parse(
+      uploadInteractionAssetSecurity,
+    ),
+  );
+}
+
+/** @internal */
+export const UploadInteractionAssetResponse$inboundSchema: z.ZodMiniType<
+  UploadInteractionAssetResponse,
+  unknown
+> = z.object({
+  domainElementId: z.string(),
+  gofsKey: z.string(),
+});
+
+export function uploadInteractionAssetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<UploadInteractionAssetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UploadInteractionAssetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UploadInteractionAssetResponse' from JSON`,
+  );
+}

package/src/models/outstanding-group.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 { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type OutstandingGroup = {
+  elementId: string;
+  /**
+   * How many of `refs` are needed. Only 'at-least-one' today; more values may be added.
+   */
+  cardinality: string;
+  refs: Array<string>;
+};
+
+/** @internal */
+export const OutstandingGroup$inboundSchema: z.ZodMiniType<
+  OutstandingGroup,
+  unknown
+> = z.object({
+  elementId: z.string(),
+  cardinality: z.string(),
+  refs: z.array(z.string()),
+});
+
+export function outstandingGroupFromJSON(
+  jsonString: string,
+): SafeParseResult<OutstandingGroup, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OutstandingGroup$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OutstandingGroup' from JSON`,
+  );
+}

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

@@ -0,0 +1,57 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type Schema = {
+  interactionId: string;
+  instruction?: string | undefined;
+  schema: { [k: string]: any };
+};
+
+export type SchemaFetchResponse = {
+  deliveryId: string;
+  resolvedVersion: string;
+  schemas: Array<Schema>;
+};
+
+/** @internal */
+export const Schema$inboundSchema: z.ZodMiniType<Schema, unknown> = z.object({
+  interactionId: z.string(),
+  instruction: z.optional(z.string()),
+  schema: z.record(z.string(), z.any()),
+});
+
+export function schemaFromJSON(
+  jsonString: string,
+): SafeParseResult<Schema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Schema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Schema' from JSON`,
+  );
+}
+
+/** @internal */
+export const SchemaFetchResponse$inboundSchema: z.ZodMiniType<
+  SchemaFetchResponse,
+  unknown
+> = z.object({
+  deliveryId: z.string(),
+  resolvedVersion: z.string(),
+  schemas: z.array(z.lazy(() => Schema$inboundSchema)),
+});
+
+export function schemaFetchResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SchemaFetchResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SchemaFetchResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SchemaFetchResponse' from JSON`,
+  );
+}

package/src/models/slim-document.ts

@@ -0,0 +1,134 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdk-validation-error.js";
+import {
+  SlimExtraction,
+  SlimExtraction$inboundSchema,
+} from "./slim-extraction.js";
+import {
+  SlimValidation,
+  SlimValidation$inboundSchema,
+} from "./slim-validation.js";
+
+export type Side = {
+  side: string;
+  id: string;
+  documentQuality: string;
+  documentQualityScore: number;
+};
+
+export type Classification = {
+  ids?: Array<string> | undefined;
+  category?: string | undefined;
+  type?: string | undefined;
+  subtype?: string | undefined;
+  isDoubleSided?: boolean | undefined;
+  hasNFC?: boolean | undefined;
+  year?: string | undefined;
+  countryCode?: string | undefined;
+  countryName?: string | undefined;
+  stateCode?: string | undefined;
+  stateName?: string | undefined;
+  sides?: Array<Side> | undefined;
+};
+
+export type SlimDocument = {
+  type?: string | undefined;
+  category?: string | undefined;
+  subType?: string | undefined;
+  format?: string | undefined;
+  number?: string | undefined;
+  /**
+   * Specified in year, month and day separated by -.  For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
+   */
+  issueDate?: string | undefined;
+  /**
+   * Specified in year, month and day separated by -.  For example 2017-1-1 or 2017-01-01 which conforms to ISO 8601
+   */
+  expiryDate?: string | undefined;
+  /**
+   * Country the address is in. It must be a valid ISO2 or ISO3 country code
+   */
+  country?: string | undefined;
+  classification?: Classification | undefined;
+  extraction?: SlimExtraction | undefined;
+  validation?: SlimValidation | undefined;
+};
+
+/** @internal */
+export const Side$inboundSchema: z.ZodMiniType<Side, unknown> = z.object({
+  side: z.string(),
+  id: z.string(),
+  documentQuality: z.string(),
+  documentQualityScore: z.number(),
+});
+
+export function sideFromJSON(
+  jsonString: string,
+): SafeParseResult<Side, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Side$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Side' from JSON`,
+  );
+}
+
+/** @internal */
+export const Classification$inboundSchema: z.ZodMiniType<
+  Classification,
+  unknown
+> = z.object({
+  ids: z.optional(z.array(z.string())),
+  category: z.optional(z.string()),
+  type: z.optional(z.string()),
+  subtype: z.optional(z.string()),
+  isDoubleSided: z.optional(z.boolean()),
+  hasNFC: z.optional(z.boolean()),
+  year: z.optional(z.string()),
+  countryCode: z.optional(z.string()),
+  countryName: z.optional(z.string()),
+  stateCode: z.optional(z.string()),
+  stateName: z.optional(z.string()),
+  sides: z.optional(z.array(z.lazy(() => Side$inboundSchema))),
+});
+
+export function classificationFromJSON(
+  jsonString: string,
+): SafeParseResult<Classification, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Classification$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Classification' from JSON`,
+  );
+}
+
+/** @internal */
+export const SlimDocument$inboundSchema: z.ZodMiniType<SlimDocument, unknown> =
+  z.object({
+    type: z.optional(z.string()),
+    category: z.optional(z.string()),
+    subType: z.optional(z.string()),
+    format: z.optional(z.string()),
+    number: z.optional(z.string()),
+    issueDate: z.optional(z.string()),
+    expiryDate: z.optional(z.string()),
+    country: z.optional(z.string()),
+    classification: z.optional(z.lazy(() => Classification$inboundSchema)),
+    extraction: z.optional(SlimExtraction$inboundSchema),
+    validation: z.optional(SlimValidation$inboundSchema),
+  });
+
+export function slimDocumentFromJSON(
+  jsonString: string,
+): SafeParseResult<SlimDocument, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SlimDocument$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SlimDocument' from JSON`,
+  );
+}

package/src/models/slim-extraction.ts

@@ -0,0 +1,235 @@
+/*
+ * 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 { SDKValidationError } from "./errors/sdk-validation-error.js";
+
+export type AggregatedFieldBoundingBox = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+
+export type AggregatedFieldRegionOfInterest = {
+  boundingBox?: AggregatedFieldBoundingBox | undefined;
+  side: string;
+  spectrum?: string | undefined;
+  imageId?: string | undefined;
+};
+
+export type AggregatedField = {
+  label: string;
+  value: string;
+  source: string;
+  isNonLatin: boolean;
+  regionOfInterest?: AggregatedFieldRegionOfInterest | undefined;
+};
+
+export type DetailBoundingBox = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+
+export type DetailRegionOfInterest = {
+  boundingBox?: DetailBoundingBox | undefined;
+  side: string;
+  spectrum?: string | undefined;
+  imageId?: string | undefined;
+};
+
+export type Detail = {
+  label: string;
+  value: string;
+  source: string;
+  isNonLatin: boolean;
+  regionOfInterest?: DetailRegionOfInterest | undefined;
+};
+
+export type ExtractedField = {
+  label: string;
+  details: Array<Detail>;
+};
+
+export type SlimExtraction = {
+  aggregatedFields?: Array<AggregatedField> | undefined;
+  extractedFields?: Array<ExtractedField> | undefined;
+};
+
+/** @internal */
+export const AggregatedFieldBoundingBox$inboundSchema: z.ZodMiniType<
+  AggregatedFieldBoundingBox,
+  unknown
+> = z.object({
+  x: z.number(),
+  y: z.number(),
+  width: z.number(),
+  height: z.number(),
+});
+
+export function aggregatedFieldBoundingBoxFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatedFieldBoundingBox, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatedFieldBoundingBox$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatedFieldBoundingBox' from JSON`,
+  );
+}
+
+/** @internal */
+export const AggregatedFieldRegionOfInterest$inboundSchema: z.ZodMiniType<
+  AggregatedFieldRegionOfInterest,
+  unknown
+> = z.object({
+  boundingBox: z.optional(
+    z.lazy(() => AggregatedFieldBoundingBox$inboundSchema),
+  ),
+  side: z.string(),
+  spectrum: z.optional(z.string()),
+  imageId: z.optional(z.string()),
+});
+
+export function aggregatedFieldRegionOfInterestFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatedFieldRegionOfInterest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatedFieldRegionOfInterest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatedFieldRegionOfInterest' from JSON`,
+  );
+}
+
+/** @internal */
+export const AggregatedField$inboundSchema: z.ZodMiniType<
+  AggregatedField,
+  unknown
+> = z.object({
+  label: z.string(),
+  value: z.string(),
+  source: z.string(),
+  isNonLatin: z.boolean(),
+  regionOfInterest: z.optional(
+    z.lazy(() => AggregatedFieldRegionOfInterest$inboundSchema),
+  ),
+});
+
+export function aggregatedFieldFromJSON(
+  jsonString: string,
+): SafeParseResult<AggregatedField, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AggregatedField$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AggregatedField' from JSON`,
+  );
+}
+
+/** @internal */
+export const DetailBoundingBox$inboundSchema: z.ZodMiniType<
+  DetailBoundingBox,
+  unknown
+> = z.object({
+  x: z.number(),
+  y: z.number(),
+  width: z.number(),
+  height: z.number(),
+});
+
+export function detailBoundingBoxFromJSON(
+  jsonString: string,
+): SafeParseResult<DetailBoundingBox, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DetailBoundingBox$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DetailBoundingBox' from JSON`,
+  );
+}
+
+/** @internal */
+export const DetailRegionOfInterest$inboundSchema: z.ZodMiniType<
+  DetailRegionOfInterest,
+  unknown
+> = z.object({
+  boundingBox: z.optional(z.lazy(() => DetailBoundingBox$inboundSchema)),
+  side: z.string(),
+  spectrum: z.optional(z.string()),
+  imageId: z.optional(z.string()),
+});
+
+export function detailRegionOfInterestFromJSON(
+  jsonString: string,
+): SafeParseResult<DetailRegionOfInterest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DetailRegionOfInterest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DetailRegionOfInterest' from JSON`,
+  );
+}
+
+/** @internal */
+export const Detail$inboundSchema: z.ZodMiniType<Detail, unknown> = z.object({
+  label: z.string(),
+  value: z.string(),
+  source: z.string(),
+  isNonLatin: z.boolean(),
+  regionOfInterest: z.optional(
+    z.lazy(() => DetailRegionOfInterest$inboundSchema),
+  ),
+});
+
+export function detailFromJSON(
+  jsonString: string,
+): SafeParseResult<Detail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Detail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Detail' from JSON`,
+  );
+}
+
+/** @internal */
+export const ExtractedField$inboundSchema: z.ZodMiniType<
+  ExtractedField,
+  unknown
+> = z.object({
+  label: z.string(),
+  details: z.array(z.lazy(() => Detail$inboundSchema)),
+});
+
+export function extractedFieldFromJSON(
+  jsonString: string,
+): SafeParseResult<ExtractedField, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExtractedField$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExtractedField' from JSON`,
+  );
+}
+
+/** @internal */
+export const SlimExtraction$inboundSchema: z.ZodMiniType<
+  SlimExtraction,
+  unknown
+> = z.object({
+  aggregatedFields: z.optional(
+    z.array(z.lazy(() => AggregatedField$inboundSchema)),
+  ),
+  extractedFields: z.optional(
+    z.array(z.lazy(() => ExtractedField$inboundSchema)),
+  ),
+});
+
+export function slimExtractionFromJSON(
+  jsonString: string,
+): SafeParseResult<SlimExtraction, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SlimExtraction$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SlimExtraction' from JSON`,
+  );
+}