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

import { lazy, object, optional, Schema, string } from '../schema.js';
import { Address, addressSchema } from './address.js';
import { CardType, cardTypeSchema } from './cardType.js';
import {
  SubscriptionsCardAttributes,
  subscriptionsCardAttributesSchema,
} from './subscriptionsCardAttributes.js';
import {
  SubscriptionsCardBrand,
  subscriptionsCardBrandSchema,
} from './subscriptionsCardBrand.js';

/** The payment card to use to fund a payment. Can be a credit or debit card. */
export interface SubscriptionCardRequest {
  /** The card holder's name as it appears on the card. */
  name?: string;
  /** The primary account number (PAN) for the payment card. */
  number?: string;
  /** The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). */
  expiry?: string;
  /** The three- or four-digit security code of the card. Also known as the CVV, CVC, CVN, CVE, or CID. This parameter cannot be present in the request when `payment_initiator=MERCHANT`. */
  securityCode?: string;
  /** Type of card. i.e Credit, Debit and so on. */
  type?: CardType;
  /** The card network or brand. Applies to credit, debit, gift, and payment cards. */
  brand?: SubscriptionsCardBrand;
  /** The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls: the autocomplete attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-controls-the-autocomplete-attribute). */
  billingAddress?: Address;
  /** Additional attributes associated with the use of this card. */
  attributes?: SubscriptionsCardAttributes;
}

export const subscriptionCardRequestSchema: Schema<SubscriptionCardRequest> = lazy(
  () =>
    object({
      name: ['name', optional(string())],
      number: ['number', optional(string())],
      expiry: ['expiry', optional(string())],
      securityCode: ['security_code', optional(string())],
      type: ['type', optional(cardTypeSchema)],
      brand: ['brand', optional(subscriptionsCardBrandSchema)],
      billingAddress: ['billing_address', optional(addressSchema)],
      attributes: ['attributes', optional(subscriptionsCardAttributesSchema)],
    })
);