/**
 * PayPal Server SDKLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import { object, optional, Schema, string } from '../schema.js';

/** The name of the party. */
export interface SubscriptionPayerName {
  /** The prefix, or title, to the party's name. */
  prefix?: string;
  /** When the party is a person, the party's given, or first, name. */
  givenName?: string;
  /** When the party is a person, the party's surname or family name. Also known as the last name. Required when the party is a person. Use also to store multiple surnames including the matronymic, or mother's, surname. */
  surname?: string;
  /** When the party is a person, the party's middle name. Use also to store multiple middle names including the patronymic, or father's, middle name. */
  middleName?: string;
  /** The suffix for the party's name. */
  suffix?: string;
  /** When the party is a person, the party's full name. */
  fullName?: string;
}

export const subscriptionPayerNameSchema: Schema<SubscriptionPayerName> = object(
  {
    prefix: ['prefix', optional(string())],
    givenName: ['given_name', optional(string())],
    surname: ['surname', optional(string())],
    middleName: ['middle_name', optional(string())],
    suffix: ['suffix', optional(string())],
    fullName: ['full_name', optional(string())],
  }
);