/*
 * 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 { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";

/**
 * An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan.").
 *
 * @remarks
 *
 *  Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA).
 */
export type PhoneNumberShortCodeUpdate = {
  /**
   * Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
   */
  number?: string | undefined;
  /**
   * Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB".
   *
   * @remarks
   *
   *  Reference(s):
   *  - http://www.unicode.org/reports/tr35/#unicode_region_subtag
   */
  regionCode?: string | undefined;
};

/** @internal */
export const PhoneNumberShortCodeUpdate$inboundSchema: z.ZodType<
  PhoneNumberShortCodeUpdate,
  z.ZodTypeDef,
  unknown
> = z.object({
  number: z.string().optional(),
  region_code: z.string().optional(),
}).transform((v) => {
  return remap$(v, {
    "region_code": "regionCode",
  });
});

/** @internal */
export type PhoneNumberShortCodeUpdate$Outbound = {
  number?: string | undefined;
  region_code?: string | undefined;
};

/** @internal */
export const PhoneNumberShortCodeUpdate$outboundSchema: z.ZodType<
  PhoneNumberShortCodeUpdate$Outbound,
  z.ZodTypeDef,
  PhoneNumberShortCodeUpdate
> = z.object({
  number: z.string().optional(),
  regionCode: z.string().optional(),
}).transform((v) => {
  return remap$(v, {
    regionCode: "region_code",
  });
});

/**
 * @internal
 * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
 */
export namespace PhoneNumberShortCodeUpdate$ {
  /** @deprecated use `PhoneNumberShortCodeUpdate$inboundSchema` instead. */
  export const inboundSchema = PhoneNumberShortCodeUpdate$inboundSchema;
  /** @deprecated use `PhoneNumberShortCodeUpdate$outboundSchema` instead. */
  export const outboundSchema = PhoneNumberShortCodeUpdate$outboundSchema;
  /** @deprecated use `PhoneNumberShortCodeUpdate$Outbound` instead. */
  export type Outbound = PhoneNumberShortCodeUpdate$Outbound;
}

export function phoneNumberShortCodeUpdateToJSON(
  phoneNumberShortCodeUpdate: PhoneNumberShortCodeUpdate,
): string {
  return JSON.stringify(
    PhoneNumberShortCodeUpdate$outboundSchema.parse(phoneNumberShortCodeUpdate),
  );
}

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