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

import { array, lazy, number, object, optional, Schema } from '../schema.js';
import { LinkDescription, linkDescriptionSchema } from './linkDescription.js';
import {
  PaymentTokenResponse,
  paymentTokenResponseSchema,
} from './paymentTokenResponse.js';
import {
  VaultResponseCustomer,
  vaultResponseCustomerSchema,
} from './vaultResponseCustomer.js';

/** Collection of payment tokens saved for a given customer. */
export interface CustomerVaultPaymentTokensResponse {
  /** Total number of items. */
  totalItems?: number;
  /** Total number of pages. */
  totalPages?: number;
  /** This object defines a customer in your system. Use it to manage customer profiles, save payment methods and contact details. */
  customer?: VaultResponseCustomer;
  paymentTokens?: PaymentTokenResponse[];
  /** An array of related [HATEOAS links](/api/rest/responses/#hateoas). */
  links?: LinkDescription[];
}

export const customerVaultPaymentTokensResponseSchema: Schema<CustomerVaultPaymentTokensResponse> = lazy(
  () =>
    object({
      totalItems: ['total_items', optional(number())],
      totalPages: ['total_pages', optional(number())],
      customer: ['customer', optional(vaultResponseCustomerSchema)],
      paymentTokens: [
        'payment_tokens',
        optional(array(paymentTokenResponseSchema)),
      ],
      links: ['links', optional(array(linkDescriptionSchema))],
    })
);