/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import * as z from "zod/v3";
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/sdkvalidationerror.js";
import {
  DefinitionFieldFormat,
  DefinitionFieldFormat$inboundSchema,
} from "./definitionfieldformat.js";

/**
 * A single field that needs to be submitted for a payment service when it is created.
 */
export type DefinitionField = {
  /**
   * The key of a field that can be submitted.
   */
  key: string;
  /**
   * The human readable name for this field.
   */
  displayName: string;
  /**
   * Defines if this field is required when the service is created.
   */
  required: boolean;
  format: DefinitionFieldFormat;
  /**
   * Defines if this field is secret. When `true` the field's value is not returned when querying the payment service information.
   */
  secret: boolean;
  /**
   * Defines if this field can be verified through the verify credentials button.
   */
  verifiable: boolean;
};

/** @internal */
export const DefinitionField$inboundSchema: z.ZodType<
  DefinitionField,
  z.ZodTypeDef,
  unknown
> = z.object({
  key: z.string(),
  display_name: z.string(),
  required: z.boolean(),
  format: DefinitionFieldFormat$inboundSchema,
  secret: z.boolean(),
  verifiable: z.boolean(),
}).transform((v) => {
  return remap$(v, {
    "display_name": "displayName",
  });
});

export function definitionFieldFromJSON(
  jsonString: string,
): SafeParseResult<DefinitionField, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => DefinitionField$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'DefinitionField' from JSON`,
  );
}