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

import { array, lazy, object, optional, Schema } from '../schema';
import { Address, addressSchema } from './address';
import { FullfillmentType, fullfillmentTypeSchema } from './fullfillmentType';
import {
  PhoneNumberWithCountryCode,
  phoneNumberWithCountryCodeSchema,
} from './phoneNumberWithCountryCode';
import { ShippingName, shippingNameSchema } from './shippingName';
import { ShippingOption, shippingOptionSchema } from './shippingOption';

/** The shipping details. */
export interface ShippingDetails {
  /** The name of the party. */
  name?: ShippingName;
  /** The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en). */
  phoneNumber?: PhoneNumberWithCountryCode;
  /** A classification for the method of purchase fulfillment (e.g shipping, in-store pickup, etc). Either `type` or `options` may be present, but not both. */
  type?: FullfillmentType;
  /** An array of shipping options that the payee or merchant offers to the payer to ship or pick up their items. */
  options?: ShippingOption[];
  /** 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). */
  address?: Address;
}

export const shippingDetailsSchema: Schema<ShippingDetails> = object({
  name: ['name', optional(lazy(() => shippingNameSchema))],
  phoneNumber: [
    'phone_number',
    optional(lazy(() => phoneNumberWithCountryCodeSchema)),
  ],
  type: ['type', optional(fullfillmentTypeSchema)],
  options: ['options', optional(array(lazy(() => shippingOptionSchema)))],
  address: ['address', optional(lazy(() => addressSchema))],
});