/**
 * 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 {
  AppSwitchContext,
  appSwitchContextSchema,
} from './appSwitchContext.js';
import {
  ExperienceContextShippingPreference,
  experienceContextShippingPreferenceSchema,
} from './experienceContextShippingPreference.js';
import {
  VaultInstructionAction,
  vaultInstructionActionSchema,
} from './vaultInstructionAction.js';
import { VaultUserAction, vaultUserActionSchema } from './vaultUserAction.js';

/** Customizes the Vault creation flow experience for your customers. */
export interface VaultExperienceContext {
  /** 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 [language tag](https://tools.ietf.org/html/bcp47#section-2) for the language in which to localize the error-related strings, such as messages, issues, and suggested actions. The tag is made up of the [ISO 639-2 language code](https://www.loc.gov/standards/iso639-2/php/code_list.php), the optional [ISO-15924 script tag](https://www.unicode.org/iso15924/codelists.html), and the [ISO-3166 alpha-2 country code](/api/rest/reference/country-codes/) or [M49 region code](https://unstats.un.org/unsd/methodology/m49/). */
  locale?: string;
  /** The URL where the customer is redirected after customer approves leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. */
  returnUrl?: string;
  /** The URL where the customer is redirected after customer cancels or leaves the flow. It is a required field for contingency flows like PayPal wallet, 3DS. */
  cancelUrl?: 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;
  /** Merchant provided details of the native app or mobile web browser to facilitate buyer's app switch to the PayPal consumer app. */
  appSwitchContext?: AppSwitchContext;
  /** User Action on action to be performed after a successful payer approval. */
  userAction?: VaultUserAction;
}

export const vaultExperienceContextSchema: Schema<VaultExperienceContext> = lazy(
  () =>
    object({
      brandName: ['brand_name', optional(string())],
      locale: ['locale', optional(string())],
      returnUrl: ['return_url', optional(string())],
      cancelUrl: ['cancel_url', optional(string())],
      shippingPreference: [
        'shipping_preference',
        optional(experienceContextShippingPreferenceSchema),
      ],
      vaultInstruction: [
        'vault_instruction',
        optional(vaultInstructionActionSchema),
      ],
      appSwitchContext: [
        'app_switch_context',
        optional(appSwitchContextSchema),
      ],
      userAction: ['user_action', optional(vaultUserActionSchema)],
    })
);