@beyond-pci/sdk 1.0.0

package/src/models/operations/postv1merchantsmerchantidsaqlink.ts

@@ -0,0 +1,584 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Action after SAQ completion: "redirect" navigates to returnUrl, "close" closes the browser window, "none" shows a confirmation page.
+ */
+export const CompletionAction = {
+  Redirect: "redirect",
+  Close: "close",
+  None: "none",
+} as const;
+/**
+ * Action after SAQ completion: "redirect" navigates to returnUrl, "close" closes the browser window, "none" shows a confirmation page.
+ */
+export type CompletionAction = ClosedEnum<typeof CompletionAction>;
+
+/**
+ * Pre-select the SAQ form type, skipping the type-selection step.
+ */
+export const FormType = {
+  A: "A",
+  AEp: "A_EP",
+  B: "B",
+  BIp: "B_IP",
+  CVt: "C_VT",
+  C: "C",
+} as const;
+/**
+ * Pre-select the SAQ form type, skipping the type-selection step.
+ */
+export type FormType = ClosedEnum<typeof FormType>;
+
+export const Answer = {
+  Yes: "YES",
+  No: "NO",
+  Na: "NA",
+  Ccw: "CCW",
+} as const;
+export type Answer = ClosedEnum<typeof Answer>;
+
+export type Answers = {
+  answer: Answer;
+};
+
+/**
+ * Controls the Simple Mode toggle: "default" shows the toggle starting OFF, "on" shows the toggle starting ON, "hidden" hides the toggle entirely.
+ */
+export const SimpleMode = {
+  Default: "default",
+  On: "on",
+  Hidden: "hidden",
+} as const;
+/**
+ * Controls the Simple Mode toggle: "default" shows the toggle starting OFF, "on" shows the toggle starting ON, "hidden" hides the toggle entirely.
+ */
+export type SimpleMode = ClosedEnum<typeof SimpleMode>;
+
+export type PostV1MerchantsMerchantIdSaqLinkRequestBody = {
+  /**
+   * URL to redirect the merchant to after SAQ completion. Required when completionAction is "redirect".
+   */
+  returnUrl?: string | undefined;
+  /**
+   * Action after SAQ completion: "redirect" navigates to returnUrl, "close" closes the browser window, "none" shows a confirmation page.
+   */
+  completionAction?: CompletionAction | undefined;
+  /**
+   * Pre-select the SAQ form type, skipping the type-selection step.
+   */
+  formType?: FormType | undefined;
+  /**
+   * Prepopulated question answers keyed by item ID.
+   */
+  answers?: { [k: string]: Answers } | undefined;
+  /**
+   * Controls the Simple Mode toggle: "default" shows the toggle starting OFF, "on" shows the toggle starting ON, "hidden" hides the toggle entirely.
+   */
+  simpleMode?: SimpleMode | undefined;
+};
+
+export type PostV1MerchantsMerchantIdSaqLinkRequest = {
+  merchantId: string;
+  requestBody: PostV1MerchantsMerchantIdSaqLinkRequestBody;
+};
+
+export type PostV1MerchantsMerchantIdSaqLinkData = {
+  url: string;
+  submissionId: string;
+};
+
+export type PostV1MerchantsMerchantIdSaqLinkMeta = {
+  timestamp: Date;
+};
+
+/**
+ * Default Response
+ */
+export type PostV1MerchantsMerchantIdSaqLinkResponseBody = {
+  data: PostV1MerchantsMerchantIdSaqLinkData;
+  meta: PostV1MerchantsMerchantIdSaqLinkMeta;
+};
+
+/** @internal */
+export const CompletionAction$inboundSchema: z.ZodNativeEnum<
+  typeof CompletionAction
+> = z.nativeEnum(CompletionAction);
+
+/** @internal */
+export const CompletionAction$outboundSchema: z.ZodNativeEnum<
+  typeof CompletionAction
+> = CompletionAction$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CompletionAction$ {
+  /** @deprecated use `CompletionAction$inboundSchema` instead. */
+  export const inboundSchema = CompletionAction$inboundSchema;
+  /** @deprecated use `CompletionAction$outboundSchema` instead. */
+  export const outboundSchema = CompletionAction$outboundSchema;
+}
+
+/** @internal */
+export const FormType$inboundSchema: z.ZodNativeEnum<typeof FormType> = z
+  .nativeEnum(FormType);
+
+/** @internal */
+export const FormType$outboundSchema: z.ZodNativeEnum<typeof FormType> =
+  FormType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace FormType$ {
+  /** @deprecated use `FormType$inboundSchema` instead. */
+  export const inboundSchema = FormType$inboundSchema;
+  /** @deprecated use `FormType$outboundSchema` instead. */
+  export const outboundSchema = FormType$outboundSchema;
+}
+
+/** @internal */
+export const Answer$inboundSchema: z.ZodNativeEnum<typeof Answer> = z
+  .nativeEnum(Answer);
+
+/** @internal */
+export const Answer$outboundSchema: z.ZodNativeEnum<typeof Answer> =
+  Answer$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Answer$ {
+  /** @deprecated use `Answer$inboundSchema` instead. */
+  export const inboundSchema = Answer$inboundSchema;
+  /** @deprecated use `Answer$outboundSchema` instead. */
+  export const outboundSchema = Answer$outboundSchema;
+}
+
+/** @internal */
+export const Answers$inboundSchema: z.ZodType<Answers, z.ZodTypeDef, unknown> =
+  z.object({
+    answer: Answer$inboundSchema,
+  });
+
+/** @internal */
+export type Answers$Outbound = {
+  answer: string;
+};
+
+/** @internal */
+export const Answers$outboundSchema: z.ZodType<
+  Answers$Outbound,
+  z.ZodTypeDef,
+  Answers
+> = z.object({
+  answer: Answer$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Answers$ {
+  /** @deprecated use `Answers$inboundSchema` instead. */
+  export const inboundSchema = Answers$inboundSchema;
+  /** @deprecated use `Answers$outboundSchema` instead. */
+  export const outboundSchema = Answers$outboundSchema;
+  /** @deprecated use `Answers$Outbound` instead. */
+  export type Outbound = Answers$Outbound;
+}
+
+export function answersToJSON(answers: Answers): string {
+  return JSON.stringify(Answers$outboundSchema.parse(answers));
+}
+
+export function answersFromJSON(
+  jsonString: string,
+): SafeParseResult<Answers, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Answers$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Answers' from JSON`,
+  );
+}
+
+/** @internal */
+export const SimpleMode$inboundSchema: z.ZodNativeEnum<typeof SimpleMode> = z
+  .nativeEnum(SimpleMode);
+
+/** @internal */
+export const SimpleMode$outboundSchema: z.ZodNativeEnum<typeof SimpleMode> =
+  SimpleMode$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SimpleMode$ {
+  /** @deprecated use `SimpleMode$inboundSchema` instead. */
+  export const inboundSchema = SimpleMode$inboundSchema;
+  /** @deprecated use `SimpleMode$outboundSchema` instead. */
+  export const outboundSchema = SimpleMode$outboundSchema;
+}
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkRequestBody$inboundSchema:
+  z.ZodType<
+    PostV1MerchantsMerchantIdSaqLinkRequestBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    returnUrl: z.string().optional(),
+    completionAction: CompletionAction$inboundSchema.default("none"),
+    formType: FormType$inboundSchema.optional(),
+    answers: z.record(z.lazy(() => Answers$inboundSchema)).optional(),
+    simpleMode: SimpleMode$inboundSchema.default("default"),
+  });
+
+/** @internal */
+export type PostV1MerchantsMerchantIdSaqLinkRequestBody$Outbound = {
+  returnUrl?: string | undefined;
+  completionAction: string;
+  formType?: string | undefined;
+  answers?: { [k: string]: Answers$Outbound } | undefined;
+  simpleMode: string;
+};
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkRequestBody$outboundSchema:
+  z.ZodType<
+    PostV1MerchantsMerchantIdSaqLinkRequestBody$Outbound,
+    z.ZodTypeDef,
+    PostV1MerchantsMerchantIdSaqLinkRequestBody
+  > = z.object({
+    returnUrl: z.string().optional(),
+    completionAction: CompletionAction$outboundSchema.default("none"),
+    formType: FormType$outboundSchema.optional(),
+    answers: z.record(z.lazy(() => Answers$outboundSchema)).optional(),
+    simpleMode: SimpleMode$outboundSchema.default("default"),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PostV1MerchantsMerchantIdSaqLinkRequestBody$ {
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkRequestBody$inboundSchema` instead. */
+  export const inboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkRequestBody$inboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkRequestBody$outboundSchema` instead. */
+  export const outboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkRequestBody$outboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkRequestBody$Outbound` instead. */
+  export type Outbound = PostV1MerchantsMerchantIdSaqLinkRequestBody$Outbound;
+}
+
+export function postV1MerchantsMerchantIdSaqLinkRequestBodyToJSON(
+  postV1MerchantsMerchantIdSaqLinkRequestBody:
+    PostV1MerchantsMerchantIdSaqLinkRequestBody,
+): string {
+  return JSON.stringify(
+    PostV1MerchantsMerchantIdSaqLinkRequestBody$outboundSchema.parse(
+      postV1MerchantsMerchantIdSaqLinkRequestBody,
+    ),
+  );
+}
+
+export function postV1MerchantsMerchantIdSaqLinkRequestBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PostV1MerchantsMerchantIdSaqLinkRequestBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PostV1MerchantsMerchantIdSaqLinkRequestBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PostV1MerchantsMerchantIdSaqLinkRequestBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkRequest$inboundSchema: z.ZodType<
+  PostV1MerchantsMerchantIdSaqLinkRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  merchantId: z.string(),
+  RequestBody: z.lazy(() =>
+    PostV1MerchantsMerchantIdSaqLinkRequestBody$inboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "RequestBody": "requestBody",
+  });
+});
+
+/** @internal */
+export type PostV1MerchantsMerchantIdSaqLinkRequest$Outbound = {
+  merchantId: string;
+  RequestBody: PostV1MerchantsMerchantIdSaqLinkRequestBody$Outbound;
+};
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkRequest$outboundSchema: z.ZodType<
+  PostV1MerchantsMerchantIdSaqLinkRequest$Outbound,
+  z.ZodTypeDef,
+  PostV1MerchantsMerchantIdSaqLinkRequest
+> = z.object({
+  merchantId: z.string(),
+  requestBody: z.lazy(() =>
+    PostV1MerchantsMerchantIdSaqLinkRequestBody$outboundSchema
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    requestBody: "RequestBody",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PostV1MerchantsMerchantIdSaqLinkRequest$ {
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkRequest$inboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkRequest$outboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkRequest$Outbound` instead. */
+  export type Outbound = PostV1MerchantsMerchantIdSaqLinkRequest$Outbound;
+}
+
+export function postV1MerchantsMerchantIdSaqLinkRequestToJSON(
+  postV1MerchantsMerchantIdSaqLinkRequest:
+    PostV1MerchantsMerchantIdSaqLinkRequest,
+): string {
+  return JSON.stringify(
+    PostV1MerchantsMerchantIdSaqLinkRequest$outboundSchema.parse(
+      postV1MerchantsMerchantIdSaqLinkRequest,
+    ),
+  );
+}
+
+export function postV1MerchantsMerchantIdSaqLinkRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PostV1MerchantsMerchantIdSaqLinkRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PostV1MerchantsMerchantIdSaqLinkRequest$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PostV1MerchantsMerchantIdSaqLinkRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkData$inboundSchema: z.ZodType<
+  PostV1MerchantsMerchantIdSaqLinkData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+  submissionId: z.string(),
+});
+
+/** @internal */
+export type PostV1MerchantsMerchantIdSaqLinkData$Outbound = {
+  url: string;
+  submissionId: string;
+};
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkData$outboundSchema: z.ZodType<
+  PostV1MerchantsMerchantIdSaqLinkData$Outbound,
+  z.ZodTypeDef,
+  PostV1MerchantsMerchantIdSaqLinkData
+> = z.object({
+  url: z.string(),
+  submissionId: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PostV1MerchantsMerchantIdSaqLinkData$ {
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkData$inboundSchema` instead. */
+  export const inboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkData$inboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkData$outboundSchema` instead. */
+  export const outboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkData$outboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkData$Outbound` instead. */
+  export type Outbound = PostV1MerchantsMerchantIdSaqLinkData$Outbound;
+}
+
+export function postV1MerchantsMerchantIdSaqLinkDataToJSON(
+  postV1MerchantsMerchantIdSaqLinkData: PostV1MerchantsMerchantIdSaqLinkData,
+): string {
+  return JSON.stringify(
+    PostV1MerchantsMerchantIdSaqLinkData$outboundSchema.parse(
+      postV1MerchantsMerchantIdSaqLinkData,
+    ),
+  );
+}
+
+export function postV1MerchantsMerchantIdSaqLinkDataFromJSON(
+  jsonString: string,
+): SafeParseResult<PostV1MerchantsMerchantIdSaqLinkData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PostV1MerchantsMerchantIdSaqLinkData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostV1MerchantsMerchantIdSaqLinkData' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkMeta$inboundSchema: z.ZodType<
+  PostV1MerchantsMerchantIdSaqLinkMeta,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+});
+
+/** @internal */
+export type PostV1MerchantsMerchantIdSaqLinkMeta$Outbound = {
+  timestamp: string;
+};
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkMeta$outboundSchema: z.ZodType<
+  PostV1MerchantsMerchantIdSaqLinkMeta$Outbound,
+  z.ZodTypeDef,
+  PostV1MerchantsMerchantIdSaqLinkMeta
+> = z.object({
+  timestamp: z.date().transform(v => v.toISOString()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PostV1MerchantsMerchantIdSaqLinkMeta$ {
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkMeta$inboundSchema` instead. */
+  export const inboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkMeta$inboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkMeta$outboundSchema` instead. */
+  export const outboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkMeta$outboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkMeta$Outbound` instead. */
+  export type Outbound = PostV1MerchantsMerchantIdSaqLinkMeta$Outbound;
+}
+
+export function postV1MerchantsMerchantIdSaqLinkMetaToJSON(
+  postV1MerchantsMerchantIdSaqLinkMeta: PostV1MerchantsMerchantIdSaqLinkMeta,
+): string {
+  return JSON.stringify(
+    PostV1MerchantsMerchantIdSaqLinkMeta$outboundSchema.parse(
+      postV1MerchantsMerchantIdSaqLinkMeta,
+    ),
+  );
+}
+
+export function postV1MerchantsMerchantIdSaqLinkMetaFromJSON(
+  jsonString: string,
+): SafeParseResult<PostV1MerchantsMerchantIdSaqLinkMeta, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PostV1MerchantsMerchantIdSaqLinkMeta$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostV1MerchantsMerchantIdSaqLinkMeta' from JSON`,
+  );
+}
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkResponseBody$inboundSchema:
+  z.ZodType<
+    PostV1MerchantsMerchantIdSaqLinkResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    data: z.lazy(() => PostV1MerchantsMerchantIdSaqLinkData$inboundSchema),
+    meta: z.lazy(() => PostV1MerchantsMerchantIdSaqLinkMeta$inboundSchema),
+  });
+
+/** @internal */
+export type PostV1MerchantsMerchantIdSaqLinkResponseBody$Outbound = {
+  data: PostV1MerchantsMerchantIdSaqLinkData$Outbound;
+  meta: PostV1MerchantsMerchantIdSaqLinkMeta$Outbound;
+};
+
+/** @internal */
+export const PostV1MerchantsMerchantIdSaqLinkResponseBody$outboundSchema:
+  z.ZodType<
+    PostV1MerchantsMerchantIdSaqLinkResponseBody$Outbound,
+    z.ZodTypeDef,
+    PostV1MerchantsMerchantIdSaqLinkResponseBody
+  > = z.object({
+    data: z.lazy(() => PostV1MerchantsMerchantIdSaqLinkData$outboundSchema),
+    meta: z.lazy(() => PostV1MerchantsMerchantIdSaqLinkMeta$outboundSchema),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PostV1MerchantsMerchantIdSaqLinkResponseBody$ {
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkResponseBody$inboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    PostV1MerchantsMerchantIdSaqLinkResponseBody$outboundSchema;
+  /** @deprecated use `PostV1MerchantsMerchantIdSaqLinkResponseBody$Outbound` instead. */
+  export type Outbound = PostV1MerchantsMerchantIdSaqLinkResponseBody$Outbound;
+}
+
+export function postV1MerchantsMerchantIdSaqLinkResponseBodyToJSON(
+  postV1MerchantsMerchantIdSaqLinkResponseBody:
+    PostV1MerchantsMerchantIdSaqLinkResponseBody,
+): string {
+  return JSON.stringify(
+    PostV1MerchantsMerchantIdSaqLinkResponseBody$outboundSchema.parse(
+      postV1MerchantsMerchantIdSaqLinkResponseBody,
+    ),
+  );
+}
+
+export function postV1MerchantsMerchantIdSaqLinkResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PostV1MerchantsMerchantIdSaqLinkResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PostV1MerchantsMerchantIdSaqLinkResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PostV1MerchantsMerchantIdSaqLinkResponseBody' from JSON`,
+  );
+}