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

import { boolean, lazy, object, optional, Schema, string } from '../schema.js';
import {
  PaypalPaymentTokenCustomerType,
  paypalPaymentTokenCustomerTypeSchema,
} from './paypalPaymentTokenCustomerType.js';
import {
  PaypalPaymentTokenUsageType,
  paypalPaymentTokenUsageTypeSchema,
} from './paypalPaymentTokenUsageType.js';
import { Plan, planSchema } from './plan.js';
import { UsagePattern, usagePatternSchema } from './usagePattern.js';
import {
  VaultedDigitalWalletShippingDetails,
  vaultedDigitalWalletShippingDetailsSchema,
} from './vaultedDigitalWalletShippingDetails.js';
import {
  VaultExperienceContext,
  vaultExperienceContextSchema,
} from './vaultExperienceContext.js';

/** A resource representing a request to vault PayPal Wallet. */
export interface VaultPaypalWalletRequest {
  /** The description displayed to the consumer on the approval flow for a digital wallet, as well as on the merchant view of the payment token management experience. exp: PayPal.com. */
  description?: string;
  /** Expected business/charge model for the billing agreement. */
  usagePattern?: UsagePattern;
  /** The shipping details. */
  shipping?: VaultedDigitalWalletShippingDetails;
  /** Create multiple payment tokens for the same payer, merchant/platform combination. Use this when the customer has not logged in at merchant/platform. The payment token thus generated, can then also be used to create the customer account at merchant/platform. Use this also when multiple payment tokens are required for the same payer, different customer at merchant/platform. This helps to identify customers distinctly even though they may share the same PayPal account. This only applies to PayPal payment source. */
  permitMultiplePaymentTokens?: boolean;
  /** The usage type associated with a digital wallet payment token. */
  usageType?: PaypalPaymentTokenUsageType;
  /** The customer type associated with a digital wallet payment token. This is to indicate whether the customer acting on the merchant / platform is either a business or a consumer. */
  customerType?: PaypalPaymentTokenCustomerType;
  /** The merchant level Recurring Billing plan metadata for the Billing Agreement. */
  billingPlan?: Plan;
  /** A resource representing an experience context of vault PayPal Wallet. */
  experienceContext?: VaultExperienceContext;
}

export const vaultPaypalWalletRequestSchema: Schema<VaultPaypalWalletRequest> = lazy(
  () =>
    object({
      description: ['description', optional(string())],
      usagePattern: ['usage_pattern', optional(usagePatternSchema)],
      shipping: [
        'shipping',
        optional(vaultedDigitalWalletShippingDetailsSchema),
      ],
      permitMultiplePaymentTokens: [
        'permit_multiple_payment_tokens',
        optional(boolean()),
      ],
      usageType: ['usage_type', optional(paypalPaymentTokenUsageTypeSchema)],
      customerType: [
        'customer_type',
        optional(paypalPaymentTokenCustomerTypeSchema),
      ],
      billingPlan: ['billing_plan', optional(planSchema)],
      experienceContext: [
        'experience_context',
        optional(vaultExperienceContextSchema),
      ],
    })
);