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

import { object, optional, Schema, string } from '../schema.js';
import {
  ExperienceContextShippingPreference,
  experienceContextShippingPreferenceSchema,
} from './experienceContextShippingPreference.js';
import {
  VaultInstructionAction,
  vaultInstructionActionSchema,
} from './vaultInstructionAction.js';
import { VaultUserAction, vaultUserActionSchema } from './vaultUserAction.js';

/** A resource representing an experience context of vault a venmo account. */
export interface VenmoExperienceContext {
  /** The label that overrides the business name in the PayPal account on the PayPal site. The pattern is defined by an external party and supports Unicode. */
  brandName?: string;
  /** The shipping preference. This only applies to PayPal payment source. */
  shippingPreference?: ExperienceContextShippingPreference;
  /** DEPRECATED. Vault Instruction on action to be performed after a successful payer approval. */
  vaultInstruction?: VaultInstructionAction;
  /** User Action on action to be performed after a successful payer approval. */
  userAction?: VaultUserAction;
}

export const venmoExperienceContextSchema: Schema<VenmoExperienceContext> = object(
  {
    brandName: ['brand_name', optional(string())],
    shippingPreference: [
      'shipping_preference',
      optional(experienceContextShippingPreferenceSchema),
    ],
    vaultInstruction: [
      'vault_instruction',
      optional(vaultInstructionActionSchema),
    ],
    userAction: ['user_action', optional(vaultUserActionSchema)],
  }
);