paypal/index.js

'use strict';
/** @module braintree-web/paypal */

/**
 * Options for {@link module:braintree-web/paypal.create|create}
 * @typedef {object} createOptions
 * @property {Client} client A {@link Client} instance
 * @property {string|number} options.amount The amount of the transaction
 * @property {string} options.currency The currency code of the amount, such as 'USD'
 * @property {string} [options.displayName] The merchant name displayed inside of the PayPal lightbox; defaults to the company name on your Braintree account
 * @property {string} [options.locale=en_us] Use this option to change the language, links, and terminology used in the PayPal flow to suit the country and language of your customer
 * @property {boolean} [options.enableShippingAddress=false] Returns a shipping address object in {@link PayPal#tokenize}
 * @property {string} [options.flow] Set to 'checkout' for one-time payment flow, or 'vault' for Vault flow
 * @property {object=} options.shippingAddressOverride Allows you to pass a shipping address you have already collected into the PayPal payment flow
 * @property {string} options.shippingAddressOverride.line1 Street address
 * @property {string=} options.shippingAddressOverride.line2 Street address (extended)
 * @property {string} options.shippingAddressOverride.city City
 * @property {string} options.shippingAddressOverride.state State
 * @property {string} options.shippingAddressOverride.postalCode Postal code
 * @property {string} options.shippingAddressOverride.countryCode Country
 * @property {string=} options.shippingAddressOverride.phone Phone number
 * @property {string=} options.shippingAddressOverride.recipientName Recipient's name
 * @property {boolean} [options.shippingAddressEditable=true] Set to false to disable user editing of the shipping address
 */

var create = require('./external/create');
var packageVersion = require('package.version');

module.exports = {
  /**
   * @static
   * @function
   * @param {module:braintree-web/paypal~createOptions} options Object containing configuration options for this module
   * @param {errback} callback The second argument, <code>data</code>, is the {@link PayPal} instance
   * @returns {void}
   */
  create: create,
  /**
   * @description The current version of the SDK, i.e. `{@pkg version}`.
   * @type {string}
   */
  VERSION: packageVersion
};