diff --git a/6.0.0-beta4/Classes.html b/6.0.0-beta4/Classes.html new file mode 100644 index 0000000000..95bdbcd4d5 --- /dev/null +++ b/6.0.0-beta4/Classes.html @@ -0,0 +1,2268 @@ + + + + Classes Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Classes Reference +

+ +
+ +
+ +
+
+

Classes

+

The following classes are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + BTAPIClient + +
    +
    +
    +
    +
    +
    +

    This class acts as the entry point for accessing the Braintree APIs via common HTTP methods performed on API endpoints.

    +
    +

    Note

    + It also manages authentication via tokenization key and provides access to a merchant’s gateway configuration. + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAPIClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    THIS CODE IS GENERATED BY codify_certificates.swift +in Braintree Github Enterprise repo braintree-ios-certificate-generation.

    + +

    Encapsulates our trusted x509 Certificates for Secure SSL Communication with Braintree’s servers +to avoid storing certificate files in an NSBundle.

    + +

    Do not update this file directly. If new certificates are needed, update the certificates directory +in braintree-ios-certificate-generation and re-run the certificate generation script.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAPIPinnedCertificates : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTAppContextSwitcher + +
    +
    +
    +
    +
    +
    +

    Handles return URLs when returning from app context switch and routes the return URL to the correct app context switch client class.

    +
    +

    Note

    + returnURLScheme must contain your app’s registered URL Type that starts with the app’s bundle ID. +When your app returns from app switch, the app delegate should call handleOpenURL (or handleOpen if not using SceneDelegate) + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAppContextSwitcher : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTBinData + +
    +
    +
    +
    +
    +
    +

    Contains the bin data associated with a payment method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTBinData : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTClientMetadata + +
    +
    +
    +
    +
    +
    +

    Represents the metadata associated with a session for posting along with payment data during tokenization.

    + +

    When a payment method is tokenized, the client api accepts parameters under +_meta which are used to determine where payment data originated.

    + +

    In general, this data may evolve and be used in different ways by different +integrations in a single app. For example, if both Apple Pay and drop in are +used. In this case, the source and integration may change over time, while +the sessionID should remain constant. To achieve this, users of this class +should use mutableCopy to create a new copy based on the existing session +and then update the object as needed.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTClientMetadata : NSObject, NSMutableCopying
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTClientToken + +
    +
    +
    +
    +
    +
    +

    An authorization string used to initialize the Braintree SDK

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTClientToken : NSObject, NSCoding, NSCopying
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTConfiguration + +
    +
    +
    +
    +
    +
    +

    Contains information specific to a merchant’s Braintree integration

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTConfiguration : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTJSON + +
    +
    +
    +
    +
    +
    +

    A type-safe wrapper around JSON +@see http://www.json.org/

    + +

    The primary goal of this class is to two-fold: (1) prevent bugs by staying true to JSON (json.org) +rather than interpreting it in mysterious ways; (2) prevent bugs by making JSON interpretation +as un-surprising as possible.

    + +

    Most notably, type casting occurs via the as* nullable methods; errors are deferred and can be checked explicitly using isError and asError.

    +

    Example Data:

    +
       {
+     "foo": "bar",
+     "baz": [1, 2, 3]
+   }
+
    +

    Example Usage:

    +
       let json : BTJSON = BTJSON(data:data);
+   json.isError  // false
+   json.isObject // true
+   json.isNumber // false
+   json.asObject // self
+   json["foo"]   // JSON(@"bar")
+   json["foo"].isString // true
+   json["foo"].asString // @"bar"
+   json["baz"].asString // null
+   json["baz"]["quux"].isError // true
+   json["baz"]["quux"].asError // NSError(domain: BTJSONErrorDomain, code: BTJSONErrorCodeTypeInvalid)
+   json["baz"][0].asError // null
+   json["baz"][0].asInteger //
+   json["random"]["nested"]["things"][3].isError // true
+
+   let json : BTJSON = BTJSON() // json.asJson => {}
+   json["foo"][0] = "bar" // json.asJSON => { "foo": ["bar"] }
+   json["baz"] = [ 1, 2, 3 ] // json.asJSON => { "foo": ["bar"], "baz": [1,2,3] }
+   json["quux"] = NSSet() // json.isError => true, json.asJSON => throws NSError(domain: BTJSONErrorDomain, code: BTJSONErrorInvalidData)
+
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTJSON : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLogLevelDescription + +
    +
    +
    +
    +
    +
    +

    Wrapper for accessing the string value of the log level

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTLogLevelDescription : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Required for Objective-C compatibility. Necessary behavior is provided by the swift version.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTMutableClientMetadata : BTClientMetadata
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPaymentMethodNonce + +
    +
    +
    +
    +
    +
    +

    BTPaymentMethodNonce is for generic tokenized payment information.

    + +

    For example, if a customer’s vaulted payment methods contains a type that’s not recognized or supported by the +Braintree SDK or the client-side integration (e.g. the vault contains a PayPal account but the client-side +integration does not include the PayPal component), this type can act as a fallback.

    + +

    The payment method nonce is a public token that acts as a placeholder for sensitive payments data that +has been uploaded to Braintree for subsequent processing. The nonce is safe to access on the client and can be +used on your server to reference the data in Braintree operations, such as Transaction.sale.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+open class BTPaymentMethodNonce : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A JSON parser that parses BTJSON into concrete BTPaymentMethodNonce objects. It supports registration of parsers at runtime.

    + +

    BTPaymentMethodNonceParser provides access to JSON parsing for different payment options +without introducing compile-time dependencies on payment option frameworks and their symbols.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPaymentMethodNonceParser : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPostalAddress + +
    +
    +
    +
    +
    +
    +

    Generic postal address

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPostalAddress : NSObject, NSCopying
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTURLUtils + +
    +
    +
    +
    +
    +
    +

    A helper class for converting URL queries to and from dictionaries

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTURLUtils : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains information about a PayPal payment method.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalNativeCheckoutAccountNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Client used to collect PayPal payment methods. If possible, this client will present a native flow; otherwise, it will fall back to a web flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTPayPalNativeCheckoutClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Options for the PayPal Checkout flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalNativeCheckoutRequest : BTPayPalCheckoutRequest
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Options for the PayPal Vault flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalNativeVaultRequest : BTPayPalVaultRequest
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Used to integrate with SEPA Direct Debit.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTSEPADirectDebitClient : BTWebAuthenticationSessionClient
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A payment method nonce representing a SEPA Direct Debit payment.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTSEPADirectDebitNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Parameters for creating a SEPA Direct Debit tokenization request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTSEPADirectDebitRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    BTAmericanExpressClient enables you to look up the rewards balance of American Express cards.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTAmericanExpressClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains information about an American Express rewards balance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAmericanExpressRewardsBalance : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTDataCollector + +
    +
    +
    +
    +
    +
    +

    Braintree’s advanced fraud protection solution.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTDataCollector : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTApplePayCardNonce + +
    +
    +
    +
    +
    +
    +

    Contains information about a tokenized Apple Pay card.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTApplePayCardNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTApplePayClient + +
    +
    +
    +
    +
    +
    +

    Used to process Apple Pay payments

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTApplePayClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLocalPaymentClient + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTLocalPaymentClient : BTWebAuthenticationSessionClient
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLocalPaymentRequest + +
    +
    +
    +
    +
    +
    +

    Used to initialize a local payment flow

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTLocalPaymentRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLocalPaymentResult + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTLocalPaymentResult : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Additional information for a 3DS lookup. Used in 3DS 2.0+ flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureAdditionalInformation : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureClient + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureLookup + +
    +
    +
    +
    +
    +
    +

    The result of a 3DS lookup. +Contains liability shift and challenge information.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureLookup : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Postal address for 3D Secure flows

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecurePostalAddress : NSObject
    +
    extension BTThreeDSecurePostalAddress: NSCopying
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureRequest + +
    +
    +
    +
    +
    +
    +

    Used to initialize a 3D Secure payment flow

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureResult + +
    +
    +
    +
    +
    +
    +

    The result of a 3D Secure payment flow

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureResult : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Base customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2BaseCustomization : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Button customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2ButtonCustomization : BTThreeDSecureV2BaseCustomization
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Label customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2LabelCustomization : BTThreeDSecureV2BaseCustomization
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Text box customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2TextBoxCustomization : BTThreeDSecureV2BaseCustomization
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Toolbar customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2ToolbarCustomization : BTThreeDSecureV2BaseCustomization
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    UI customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2UICustomization : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Information pertaining to the regulatory environment for a credit card if authentication insight is requested during tokenization.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAuthenticationInsight : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTCard + +
    +
    +
    +
    +
    +
    +

    The card tokenization request represents raw credit or debit card data provided by the customer. +Its main purpose is to serve as the input for tokenization.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTCard : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTCardClient + +
    +
    +
    +
    +
    +
    +

    Used to process cards

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTCardClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTCardNonce + +
    +
    +
    +
    +
    +
    +

    Contains information about a tokenized card.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTCardNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTCardRequest + +
    +
    +
    +
    +
    +
    +

    Contains information about a card to tokenize

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTCardRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureInfo + +
    +
    +
    +
    +
    +
    +

    Contains information about the 3D Secure status of a payment method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureInfo : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalAccountNonce + +
    +
    +
    +
    +
    +
    +

    Contains information about a PayPal payment method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalAccountNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Options for the PayPal Checkout flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+open class BTPayPalCheckoutRequest : BTPayPalRequest
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalClient + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTPayPalClient : BTWebAuthenticationSessionClient
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains information about a PayPal credit financing option

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalCreditFinancing : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains information about a PayPal credit amount

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalCreditFinancingAmount : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalLineItem + +
    +
    +
    +
    +
    +
    +

    A PayPal line item to be displayed in the PayPal checkout flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalLineItem : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalRequest + +
    +
    +
    +
    +
    +
    +

    Base options for PayPal Checkout and PayPal Vault flows.

    +
    +

    Note

    + Do not instantiate this class directly. Instead, use BTPayPalCheckoutRequest or BTPayPalVaultRequest. + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+open class BTPayPalRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalVaultRequest + +
    +
    +
    +
    +
    +
    +

    Options for the PayPal Vault flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+open class BTPayPalVaultRequest : BTPayPalRequest
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTVenmoAccountNonce + +
    +
    +
    +
    +
    +
    +

    Contains information about a Venmo Account payment method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTVenmoAccountNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTVenmoClient + +
    +
    +
    +
    +
    +
    +

    Used to process Venmo payments

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTVenmoClient : NSObject
    +
    extension BTVenmoClient: BTAppContextSwitchClient
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTVenmoRequest + +
    +
    +
    +
    +
    +
    +

    A BTVenmoRequest specifies options that contribute to the Venmo flow

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTVenmoRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTAPIClient.html b/6.0.0-beta4/Classes/BTAPIClient.html new file mode 100644 index 0000000000..a34905ab3e --- /dev/null +++ b/6.0.0-beta4/Classes/BTAPIClient.html @@ -0,0 +1,699 @@ + + + + BTAPIClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAPIClient Class Reference +

+ +
+ +
+ +
+
+

BTAPIClient

+
+
+ + 
@objcMembers
+public class BTAPIClient : NSObject
+ +
+
+

This class acts as the entry point for accessing the Braintree APIs via common HTTP methods performed on API endpoints.

+
+

Note

+ It also manages authentication via tokenization key and provides access to a merchant’s gateway configuration. + +
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + RequestCompletion + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public typealias RequestCompletion = (BTJSON?, HTTPURLResponse?, Error?) -> Void
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + tokenizationKey + +
    +
    +
    +
    +
    +
    +

    The tokenization key used to authorize the APIClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var tokenizationKey: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + clientToken + +
    +
    +
    +
    +
    +
    +

    The client token used to authorize the APIClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var clientToken: BTClientToken?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Client metadata that is used for tracking the client session

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var metadata: BTClientMetadata { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializers +

+
+
+
    +
  • +
    + + + + init(authorization:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new API client.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAuthorization:)
+public convenience init?(authorization: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + authorization + + +
    +

    Your tokenization key, client token, or PayPal ID Token. Passing an invalid value may return nil.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Provides configuration data as a BTJSON object.

    + +

    The configuration data can be used by supported payment options to configure themselves + dynamically through the Control Panel. It also contains configuration options for the Braintree SDK Core components.

    +
    +

    Note

    + This method is asynchronous because it requires a network call to fetch the +configuration for a merchant account from Braintree servers. This configuration is +cached on subsequent calls for better performance. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func fetchOrReturnRemoteConfiguration(_ completion: @escaping (BTConfiguration?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    Callback that returns either a BTConfiguration or Error

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Fetches a customer’s vaulted payment method nonces. +Must be using client token with a customer ID specified.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func fetchPaymentMethodNonces(_ completion: @escaping ([BTPaymentMethodNonce]?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    Callback that returns either an array of payment method nonces or an error

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Fetches a customer’s vaulted payment method nonces. +Must be using client token with a customer ID specified.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func fetchPaymentMethodNonces(_ defaultFirst: Bool, completion: @escaping ([BTPaymentMethodNonce]?, Error?) -> Void)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTAPIPinnedCertificates.html b/6.0.0-beta4/Classes/BTAPIPinnedCertificates.html new file mode 100644 index 0000000000..d8b4c09174 --- /dev/null +++ b/6.0.0-beta4/Classes/BTAPIPinnedCertificates.html @@ -0,0 +1,382 @@ + + + + BTAPIPinnedCertificates Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAPIPinnedCertificates Class Reference +

+ +
+ +
+ +
+
+

BTAPIPinnedCertificates

+
+
+ + 
@objcMembers
+public class BTAPIPinnedCertificates : NSObject
+ +
+
+

THIS CODE IS GENERATED BY codify_certificates.swift +in Braintree Github Enterprise repo braintree-ios-certificate-generation.

+ +

Encapsulates our trusted x509 Certificates for Secure SSL Communication with Braintree’s servers +to avoid storing certificate files in an NSBundle.

+ +

Do not update this file directly. If new certificates are needed, update the certificates directory +in braintree-ios-certificate-generation and re-run the certificate generation script.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTAmericanExpressClient.html b/6.0.0-beta4/Classes/BTAmericanExpressClient.html new file mode 100644 index 0000000000..03405bb3fa --- /dev/null +++ b/6.0.0-beta4/Classes/BTAmericanExpressClient.html @@ -0,0 +1,469 @@ + + + + BTAmericanExpressClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAmericanExpressClient Class Reference +

+ +
+ +
+ +
+
+

BTAmericanExpressClient

+
+
+ + 
@objc
+public class BTAmericanExpressClient : NSObject
+ +
+
+

BTAmericanExpressClient enables you to look up the rewards balance of American Express cards.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTAmericanExpressRewardsBalance.html b/6.0.0-beta4/Classes/BTAmericanExpressRewardsBalance.html new file mode 100644 index 0000000000..ac8a088596 --- /dev/null +++ b/6.0.0-beta4/Classes/BTAmericanExpressRewardsBalance.html @@ -0,0 +1,586 @@ + + + + BTAmericanExpressRewardsBalance Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAmericanExpressRewardsBalance Class Reference +

+ +
+ +
+ +
+
+

BTAmericanExpressRewardsBalance

+
+
+ + 
@objcMembers
+public class BTAmericanExpressRewardsBalance : NSObject
+ +
+
+

Contains information about an American Express rewards balance.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + errorCode + +
    +
    +
    +
    +
    +
    +

    Optional. An error code when there was an issue fetching the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var errorCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + errorMessage + +
    +
    +
    +
    +
    +
    +

    Optional. An error message when there was an issue fetching the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var errorMessage: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + conversionRate + +
    +
    +
    +
    +
    +
    +

    Optional. The conversion rate associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var conversionRate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + currencyAmount + +
    +
    +
    +
    +
    +
    +

    Optional. The currency amount associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currencyAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + currencyIsoCode + +
    +
    +
    +
    +
    +
    +

    Optional. The currency ISO code associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currencyIsoCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + requestID + +
    +
    +
    +
    +
    +
    +

    Optional. The request ID used when fetching the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var requestID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + rewardsAmount + +
    +
    +
    +
    +
    +
    +

    Optional. The rewards amount associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var rewardsAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + rewardsUnit + +
    +
    +
    +
    +
    +
    +

    Optional. The rewards unit associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var rewardsUnit: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTAppContextSwitcher.html b/6.0.0-beta4/Classes/BTAppContextSwitcher.html new file mode 100644 index 0000000000..127baaff5f --- /dev/null +++ b/6.0.0-beta4/Classes/BTAppContextSwitcher.html @@ -0,0 +1,463 @@ + + + + BTAppContextSwitcher Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAppContextSwitcher Class Reference +

+ +
+ +
+ +
+
+

BTAppContextSwitcher

+
+
+ + 
@objcMembers
+public class BTAppContextSwitcher : NSObject
+ +
+
+

Handles return URLs when returning from app context switch and routes the return URL to the correct app context switch client class.

+
+

Note

+ returnURLScheme must contain your app’s registered URL Type that starts with the app’s bundle ID. +When your app returns from app switch, the app delegate should call handleOpenURL (or handleOpen if not using SceneDelegate) + +
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + sharedInstance + +
    +
    +
    +
    +
    +
    +

    Singleton for shared instance of BTAppContextSwitcher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let sharedInstance: BTAppContextSwitcher
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + returnURLScheme + +
    +
    +
    +
    +
    +
    +

    The URL scheme to return to this app after switching to another app or opening a SFSafariViewController. +This URL scheme must be registered as a URL Type in the app’s info.plist, and it must start with the app’s bundle ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var returnURLScheme: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + register(_:) + +
    +
    +
    +
    +
    +
    +

    Registers a class Type that can handle a return from app context switch with a static method.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(registerAppContextSwitchClient:)
+public func register(_ client: BTAppContextSwitchClient.Type)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + client + + +
    +

    A class Type that implements BTAppContextSwitchClient, the methods of which will be invoked statically on the class.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTApplePayCardNonce.html b/6.0.0-beta4/Classes/BTApplePayCardNonce.html new file mode 100644 index 0000000000..bb8869a4f9 --- /dev/null +++ b/6.0.0-beta4/Classes/BTApplePayCardNonce.html @@ -0,0 +1,376 @@ + + + + BTApplePayCardNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTApplePayCardNonce Class Reference +

+ +
+ +
+ +
+
+

BTApplePayCardNonce

+
+
+ + 
@objcMembers
+public class BTApplePayCardNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a tokenized Apple Pay card.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + binData + +
    +
    +
    +
    +
    +
    +

    The BIN data for the card number associated with this nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let binData: BTBinData
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTApplePayClient.html b/6.0.0-beta4/Classes/BTApplePayClient.html new file mode 100644 index 0000000000..853a4c7556 --- /dev/null +++ b/6.0.0-beta4/Classes/BTApplePayClient.html @@ -0,0 +1,636 @@ + + + + BTApplePayClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTApplePayClient Class Reference +

+ +
+ +
+ +
+
+

BTApplePayClient

+
+
+ + 
@objc
+public class BTApplePayClient : NSObject
+ +
+
+

Used to process Apple Pay payments

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Creates an Apple Pay client

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates a PKPaymentRequest with values from your Braintree Apple Pay configuration. +It populates the following values of PKPaymentRequest: countryCode, currencyCode, merchantIdentifier, supportedNetworks.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(makePaymentRequest:)
+public func makePaymentRequest(completion: @escaping (PKPaymentRequest?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    A completion block that returns the payment request or an error.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + makePaymentRequest() + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Creates a PKPaymentRequest with values from your Braintree Apple Pay configuration. +It populates the following values of PKPaymentRequest: countryCode, currencyCode, merchantIdentifier, supportedNetworks.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func makePaymentRequest() async throws -> PKPaymentRequest
    + +
    +
    +
    +

    Return Value

    +

    A PKPaymentRequest

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Tokenizes an Apple Pay payment.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeApplePayPayment:completion:)
+public func tokenize(_ payment: PKPayment, completion: @escaping (BTApplePayCardNonce?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + payment + + +
    +

    A PKPayment instance, typically obtained by presenting a PKPaymentAuthorizationViewController

    +
    +
    + + completion + + +
    +

    A completion block that is invoked when tokenization has completed. If tokenization succeeds, we will return a BTApplePayCardNonce +and error will be nil; if it fails, BTApplePayCardNonce will be nil and error will describe the failure.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Tokenizes an Apple Pay payment.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ payment: PKPayment) async throws -> BTApplePayCardNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + payment + + +
    +

    A PKPayment instance, typically obtained by presenting a PKPaymentAuthorizationViewController

    +
    +
    +
    +
    +

    Return Value

    +

    A BTApplePayCardNonce

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTAuthenticationInsight.html b/6.0.0-beta4/Classes/BTAuthenticationInsight.html new file mode 100644 index 0000000000..d61d2654ae --- /dev/null +++ b/6.0.0-beta4/Classes/BTAuthenticationInsight.html @@ -0,0 +1,387 @@ + + + + BTAuthenticationInsight Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAuthenticationInsight Class Reference +

+ +
+ +
+ +
+
+

BTAuthenticationInsight

+
+
+ + 
@objcMembers
+public class BTAuthenticationInsight : NSObject
+ +
+
+

Information pertaining to the regulatory environment for a credit card if authentication insight is requested during tokenization.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTBinData.html b/6.0.0-beta4/Classes/BTBinData.html new file mode 100644 index 0000000000..0c5b4102d3 --- /dev/null +++ b/6.0.0-beta4/Classes/BTBinData.html @@ -0,0 +1,647 @@ + + + + BTBinData Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTBinData Class Reference +

+ +
+ +
+ +
+
+

BTBinData

+
+
+ + 
@objcMembers
+public class BTBinData : NSObject
+ +
+
+

Contains the bin data associated with a payment method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + prepaid + +
    +
    +
    +
    +
    +
    +

    Whether the card is a prepaid card. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let prepaid: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + healthcare + +
    +
    +
    +
    +
    +
    +

    Whether the card is a healthcare card. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let healthcare: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + debit + +
    +
    +
    +
    +
    +
    +

    Whether the card is a debit card. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let debit: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + durbinRegulated + +
    +
    +
    +
    +
    +
    +

    A value indicating whether the issuing bank’s card range is regulated by the Durbin Amendment due to the bank’s assets. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let durbinRegulated: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + commercial + +
    +
    +
    +
    +
    +
    +

    Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let commercial: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payroll + +
    +
    +
    +
    +
    +
    +

    Whether the card is a payroll card. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payroll: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + issuingBank + +
    +
    +
    +
    +
    +
    +

    The bank that issued the credit card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let issuingBank: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryOfIssuance + +
    +
    +
    +
    +
    +
    +

    The country that issued the credit card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let countryOfIssuance: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + productID + +
    +
    +
    +
    +
    +
    +

    The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)), if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let productID: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(json:) + +
    +
    +
    +
    +
    +
    +

    Create a BTBinData object from JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithJSON:)
+public init(json: BTJSON?)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTCard.html b/6.0.0-beta4/Classes/BTCard.html new file mode 100644 index 0000000000..29826bd21f --- /dev/null +++ b/6.0.0-beta4/Classes/BTCard.html @@ -0,0 +1,1005 @@ + + + + BTCard Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCard Class Reference +

+ +
+ +
+ +
+
+

BTCard

+
+
+ + 
@objcMembers
+public class BTCard : NSObject
+ +
+
+

The card tokenization request represents raw credit or debit card data provided by the customer. +Its main purpose is to serve as the input for tokenization.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + number + +
    +
    +
    +
    +
    +
    +

    The card number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var number: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expirationMonth + +
    +
    +
    +
    +
    +
    +

    The expiration month as a one or two-digit number on the Gregorian calendar

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var expirationMonth: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expirationYear + +
    +
    +
    +
    +
    +
    +

    The expiration year as a two or four-digit number on the Gregorian calendar

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var expirationYear: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cvv + +
    +
    +
    +
    +
    +
    +

    The card verification code (like CVV or CID).

    +
    +

    Note

    + If you wish to create a CVV-only payment method nonce to verify a card already stored in your Vault, +omit all other properties to only collect CVV. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cvv: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The postal code associated with the card’s billing address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cardholderName + +
    +
    +
    +
    +
    +
    +

    Optional: the cardholder’s name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardholderName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    Optional: first name on the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    Optional: last name on the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + company + +
    +
    +
    +
    +
    +
    +

    Optional: company name associated with the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var company: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + streetAddress + +
    +
    +
    +
    +
    +
    +

    Optional: the street address associated with the card’s billing address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var streetAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + extendedAddress + +
    +
    +
    +
    +
    +
    +

    Optional: the extended address associated with the card’s billing address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var extendedAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + locality + +
    +
    +
    +
    +
    +
    +

    Optional: the city associated with the card’s billing address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var locality: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + region + +
    +
    +
    +
    +
    +
    +

    Optional: either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var region: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryName + +
    +
    +
    +
    +
    +
    +

    Optional: the country name associated with the card’s billing address.

    +
    +

    Note

    + Braintree only accepts specific country names. + +
    +

    See also

    + https://developer.paypal.com/braintree/docs/reference/general/countries#list-of-countries + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeAlpha2 + +
    +
    +
    +
    +
    +
    +

    Optional: the ISO 3166-1 alpha-2 country code specified in the card’s billing address.

    +
    +

    Note

    + Braintree only accepts specific alpha-2 values. + +
    +

    See also

    + https://developer.paypal.com/braintree/docs/reference/general/countries#list-of-countries + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeAlpha2: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeAlpha3 + +
    +
    +
    +
    +
    +
    +

    Optional: the ISO 3166-1 alpha-3 country code specified in the card’s billing address.

    +
    +

    Note

    + Braintree only accepts specific alpha-3 values. + +
    +

    See also

    + https://developer.paypal.com/braintree/docs/reference/general/countries#list-of-countries + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeAlpha3: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeNumeric + +
    +
    +
    +
    +
    +
    +

    Optional: The ISO 3166-1 numeric country code specified in the card’s billing address.

    +
    +

    Note

    + Braintree only accepts specific numeric values. +
    +

    See also

    + https://developer.paypal.com/braintree/docs/reference/general/countries#list-of-countries + +
    + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeNumeric: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shouldValidate + +
    +
    +
    +
    +
    +
    +

    Controls whether or not to return validations and/or verification results. By default, this is not enabled.

    +
    +

    Note

    + Use this flag with caution. By enabling client-side validation, certain tokenize card requests may result in adding the card to the vault. +These semantics are not currently documented. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shouldValidate: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional: If authentication insight is requested. If this property is set to true, a merchantAccountID must be provided. Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationInsightRequested: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + merchantAccountID + +
    +
    +
    +
    +
    +
    +

    Optional: The merchant account ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var merchantAccountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTCardClient.html b/6.0.0-beta4/Classes/BTCardClient.html new file mode 100644 index 0000000000..aa23c35edf --- /dev/null +++ b/6.0.0-beta4/Classes/BTCardClient.html @@ -0,0 +1,542 @@ + + + + BTCardClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCardClient Class Reference +

+ +
+ +
+ +
+
+

BTCardClient

+
+
+ + 
@objc
+public class BTCardClient : NSObject
+ +
+
+

Used to process cards

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Creates a card client

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Tokenizes a card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeCard:completion:)
+public func tokenize(_ card: BTCard, completion: @escaping (BTCardNonce?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + card + + +
    +

    The card to tokenize.

    +
    +
    + + completion + + +
    +

    A completion block that is invoked when card tokenization has completed. If tokenization succeeds, +tokenize will contain a nonce and error will be nil; if it fails, tokenize will be nil and errorwill describe the failure.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Tokenizes a card

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ card: BTCard) async throws -> BTCardNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + card + + +
    +

    The card to tokenize.

    +
    +
    +
    +
    +

    Return Value

    +

    On success, you will receive an instance of BTCardNonce

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTCardNonce.html b/6.0.0-beta4/Classes/BTCardNonce.html new file mode 100644 index 0000000000..073f5fa62c --- /dev/null +++ b/6.0.0-beta4/Classes/BTCardNonce.html @@ -0,0 +1,656 @@ + + + + BTCardNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCardNonce Class Reference +

+ +
+ +
+ +
+
+

BTCardNonce

+
+
+ + 
@objcMembers
+public class BTCardNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a tokenized card.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + cardNetwork + +
    +
    +
    +
    +
    +
    +

    The card network.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardNetwork: BTCardNetwork
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expirationMonth + +
    +
    +
    +
    +
    +
    +

    The expiration month of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var expirationMonth: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expirationYear + +
    +
    +
    +
    +
    +
    +

    The expiration year of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var expirationYear: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cardholderName + +
    +
    +
    +
    +
    +
    +

    The name of the cardholder, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardholderName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastTwo + +
    +
    +
    +
    +
    +
    +

    The last two digits of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastTwo: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastFour + +
    +
    +
    +
    +
    +
    +

    The last four digits of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastFour: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + bin + +
    +
    +
    +
    +
    +
    +

    The BIN number of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bin: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + binData + +
    +
    +
    +
    +
    +
    +

    The BIN data for the card number associated with this nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var binData: BTBinData
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + threeDSecureInfo + +
    +
    +
    +
    +
    +
    +

    The 3D Secure info for the card number associated with this nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureInfo: BTThreeDSecureInfo
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + authenticationInsight + +
    +
    +
    +
    +
    +
    +

    Details about the regulatory environment and applicable customer authentication regulation for a potential transaction. +This can be used to make an informed decision whether to perform 3D Secure authentication.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationInsight: BTAuthenticationInsight?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTCardRequest.html b/6.0.0-beta4/Classes/BTCardRequest.html new file mode 100644 index 0000000000..5fe31b37d9 --- /dev/null +++ b/6.0.0-beta4/Classes/BTCardRequest.html @@ -0,0 +1,425 @@ + + + + BTCardRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCardRequest Class Reference +

+ +
+ +
+ +
+
+

BTCardRequest

+
+
+ + 
@objcMembers
+public class BTCardRequest : NSObject
+ +
+
+

Contains information about a card to tokenize

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + card + +
    +
    +
    +
    +
    +
    +

    The BTCard associated with this instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var card: BTCard
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(card:) + +
    +
    +
    +
    +
    +
    +

    Initialize a Card request with a BTCard.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(card: BTCard)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + card + + +
    +

    The BTCard to initialize with.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTClientMetadata.html b/6.0.0-beta4/Classes/BTClientMetadata.html new file mode 100644 index 0000000000..56e545bfec --- /dev/null +++ b/6.0.0-beta4/Classes/BTClientMetadata.html @@ -0,0 +1,626 @@ + + + + BTClientMetadata Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTClientMetadata Class Reference +

+ +
+ +
+ +
+
+

BTClientMetadata

+
+
+ + 
@objcMembers
+public class BTClientMetadata : NSObject, NSMutableCopying
+ +
+
+

Represents the metadata associated with a session for posting along with payment data during tokenization.

+ +

When a payment method is tokenized, the client api accepts parameters under +_meta which are used to determine where payment data originated.

+ +

In general, this data may evolve and be used in different ways by different +integrations in a single app. For example, if both Apple Pay and drop in are +used. In this case, the source and integration may change over time, while +the sessionID should remain constant. To achieve this, users of this class +should use mutableCopy to create a new copy based on the existing session +and then update the object as needed.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + integration + +
    +
    +
    +
    +
    +
    +

    Integration type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var integration: BTClientMetadataIntegration
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + source + +
    +
    +
    +
    +
    +
    +

    Integration source

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var source: BTClientMetadataSource
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sessionID + +
    +
    +
    +
    +
    +
    +

    Auto-generated UUID

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sessionID: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + integrationString + +
    +
    +
    +
    +
    +
    +

    String representation of the integration

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var integrationString: String { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sourceString + +
    +
    +
    +
    +
    +
    +

    String representation of the source

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sourceString: String { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + parameters + +
    +
    +
    +
    +
    +
    +

    Additional metadata parameters

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var parameters: [String : Any] { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + mutableCopy(with:) + +
    +
    +
    +
    +
    +
    +

    Create a copy as BTMutableClientMetadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func mutableCopy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + copy(with:) + +
    +
    +
    +
    +
    +
    +

    Creates a copy of BTClientMetadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(copyWithZone:)
+public func copy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTClientToken.html b/6.0.0-beta4/Classes/BTClientToken.html new file mode 100644 index 0000000000..d0fecf6e5b --- /dev/null +++ b/6.0.0-beta4/Classes/BTClientToken.html @@ -0,0 +1,498 @@ + + + + BTClientToken Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTClientToken Class Reference +

+ +
+ +
+ +
+
+

BTClientToken

+
+
+ + 
@objcMembers
+public class BTClientToken : NSObject, NSCoding, NSCopying
+ +
+
+

An authorization string used to initialize the Braintree SDK

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

NSCoding conformance +

+
+
+
    +
  • +
    + + + + encode(with:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func encode(with coder: NSCoder)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(coder:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required convenience init?(coder: NSCoder)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

NSCopying conformance +

+
+
+
    +
  • +
    + + + + copy(with:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(copyWithZone:)
+public func copy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

NSObject override +

+
+
+
    +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func isEqual(_ object: Any?) -> Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTConfiguration.html b/6.0.0-beta4/Classes/BTConfiguration.html new file mode 100644 index 0000000000..02daa17f67 --- /dev/null +++ b/6.0.0-beta4/Classes/BTConfiguration.html @@ -0,0 +1,456 @@ + + + + BTConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTConfiguration Class Reference +

+ +
+ +
+ +
+
+

BTConfiguration

+
+
+ + 
@objcMembers
+public class BTConfiguration : NSObject
+ +
+
+

Contains information specific to a merchant’s Braintree integration

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + json + +
    +
    +
    +
    +
    +
    +

    The merchant account’s configuration as a BTJSON object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let json: BTJSON?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + environment + +
    +
    +
    +
    +
    +
    +

    The environment (production or sandbox)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var environment: String? { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(json:) + +
    +
    +
    +
    +
    +
    +

    Used to initialize a BTConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithJSON:)
+public init(json: BTJSON?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + json + + +
    +

    The BTJSON to initialize with

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTDataCollector.html b/6.0.0-beta4/Classes/BTDataCollector.html new file mode 100644 index 0000000000..0d87f62cbd --- /dev/null +++ b/6.0.0-beta4/Classes/BTDataCollector.html @@ -0,0 +1,568 @@ + + + + BTDataCollector Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTDataCollector Class Reference +

+ +
+ +
+ +
+
+

BTDataCollector

+
+
+ + 
@objc
+public class BTDataCollector : NSObject
+ +
+
+

Braintree’s advanced fraud protection solution.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initializes a BTDataCollector instance with a BTAPIClient.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An instance of BTAPIClient

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public methods +

+
+
+
    +
  • +
    + + + + clientMetadataID(_:) + +
    +
    +
    +
    +
    +
    +

    Returns a client metadata ID.

    +
    +

    Note

    + This returns a raw client metadata ID, which is not the correct format for device data when creating a transaction. Instead, it is recommended to use collectDeviceData. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clientMetadataID(_ pairingID: String?) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + pairingID + + +
    +

    A pairing ID to associate with this clientMetadataID must be 10-32 chars long or null

    +
    +
    +
    +
    +

    Return Value

    +

    A client metadata ID to send as a header

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + collectDeviceData(_:) + +
    +
    +
    +
    +
    +
    +

    Collects device data based on your merchant configuration.

    + +

    We recommend that you call this method as early as possible, e.g. at app launch. If that’s too early, + calling it when the customer initiates checkout is also fine. + Use the return value on your server, e.g. with Transaction.sale.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func collectDeviceData(_ completion: @escaping (String?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    A completion block that returns either a device data string that should be passed into server-side calls, such as Transaction.sale, or an error with the failure reason.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + collectDeviceData() + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Collects device data based on your merchant configuration.

    + +

    We recommend that you call this method as early as possible, e.g. at app launch. If that’s too early, + calling it when the customer initiates checkout is also fine. + Use the return value on your server, e.g. with Transaction.sale.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func collectDeviceData() async throws -> String
    + +
    +
    +
    +

    Return Value

    +

    A device data string that should be passed into server-side calls, such as Transaction.sale.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTJSON.html b/6.0.0-beta4/Classes/BTJSON.html new file mode 100644 index 0000000000..c01dd0fae1 --- /dev/null +++ b/6.0.0-beta4/Classes/BTJSON.html @@ -0,0 +1,1356 @@ + + + + BTJSON Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTJSON Class Reference +

+ +
+ +
+ +
+
+

BTJSON

+
+
+ + 
@objcMembers
+public class BTJSON : NSObject
+ +
+
+

A type-safe wrapper around JSON +@see http://www.json.org/

+ +

The primary goal of this class is to two-fold: (1) prevent bugs by staying true to JSON (json.org) +rather than interpreting it in mysterious ways; (2) prevent bugs by making JSON interpretation +as un-surprising as possible.

+ +

Most notably, type casting occurs via the as* nullable methods; errors are deferred and can be checked explicitly using isError and asError.

+

Example Data:

+
   {
+     "foo": "bar",
+     "baz": [1, 2, 3]
+   }
+
+

Example Usage:

+
   let json : BTJSON = BTJSON(data:data);
+   json.isError  // false
+   json.isObject // true
+   json.isNumber // false
+   json.asObject // self
+   json["foo"]   // JSON(@"bar")
+   json["foo"].isString // true
+   json["foo"].asString // @"bar"
+   json["baz"].asString // null
+   json["baz"]["quux"].isError // true
+   json["baz"]["quux"].asError // NSError(domain: BTJSONErrorDomain, code: BTJSONErrorCodeTypeInvalid)
+   json["baz"][0].asError // null
+   json["baz"][0].asInteger //
+   json["random"]["nested"]["things"][3].isError // true
+
+   let json : BTJSON = BTJSON() // json.asJson => {}
+   json["foo"][0] = "bar" // json.asJSON => { "foo": ["bar"] }
+   json["baz"] = [ 1, 2, 3 ] // json.asJSON => { "foo": ["bar"], "baz": [1,2,3] }
+   json["quux"] = NSSet() // json.isError => true, json.asJSON => throws NSError(domain: BTJSONErrorDomain, code: BTJSONErrorInvalidData)
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializers +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(value:) + +
    +
    +
    +
    +
    +
    +

    Initialize with a value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(value: Any?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + value + + +
    +

    The value to initialize with.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(data:) + +
    +
    +
    +
    +
    +
    +

    Initialize with data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(data: Data)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + data + + +
    +

    The Data to initialize with.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

JSON Type Checks +

+
+
+
    +
  • +
    + + + + isString + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a String

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isString: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid String

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isBool + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a Bool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isBool: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid Bool

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isNumber + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a NSNumber

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isNumber: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid NSNumber

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isArray + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a [Any]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isArray: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid [Any]

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isObject + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a [String: Any]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isObject: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid [String: Any]

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isError + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is an error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isError: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is not valid.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isTrue + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a value representing true

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isTrue: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is true

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isFalse + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a value representing false

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isFalse: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is false

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isNull + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a value representing nil

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isNull: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is nil

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Subscripting +

+
+
+
    +
  • +
    + + + + subscript(_:) + +
    +
    +
    +
    +
    +
    +

    Indexes into the JSON as if the current value is an object

    + +

    Notably, this method will always return successfully; however, if the value is not an object, the JSON will wrap an error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public subscript(index: Int) -> BTJSON { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + subscript(_:) + +
    +
    +
    +
    +
    +
    +

    Indexes into the JSON as if the current value is an array

    + +

    Notably, this method will always return successfully; however, if the value is not an array, the JSON will wrap an error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public subscript(key: String) -> BTJSON { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Validity Checks +

+
+
+
    +
  • +
    + + + + asError() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a NSError.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asError() -> NSError?
    + +
    +
    +
    +

    Return Value

    +

    A NSError representing the BTJSON instance.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

JSON Type Casts +

+
+
+
    +
  • +
    + + + + asString() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a String

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asString() -> String?
    + +
    +
    +
    +

    Return Value

    +

    A String representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asBool() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a Bool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asBool() -> Bool?
    + +
    +
    +
    +

    Return Value

    +

    A Bool representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asArray() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a [BTJSON]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asArray() -> [BTJSON]?
    + +
    +
    +
    +

    Return Value

    +

    A [BTJSON] representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asNumber() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a NSNumber

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asNumber() -> NSNumber?
    + +
    +
    +
    +

    Return Value

    +

    A NSNumber representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

JSON Extension Type Casts +

+
+
+
    +
  • +
    + + + + asURL() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a URL

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asURL() -> URL?
    + +
    +
    +
    +

    Return Value

    +

    A URL representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asStringArray() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a [String]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asStringArray() -> [String]?
    + +
    +
    +
    +

    Return Value

    +

    A [String] representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asDictionary() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a NSDictionary

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asDictionary() -> NSDictionary?
    + +
    +
    +
    +

    Return Value

    +

    A NSDictionary representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asIntegerOrZero() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a Int

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asIntegerOrZero() -> Int
    + +
    +
    +
    +

    Return Value

    +

    A Int representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asEnum(_:orDefault:) + +
    +
    +
    +
    +
    +
    +

    The BTJSON as an Enum

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asEnum(_ mapping: [String : Any], orDefault: Int) -> Int
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapping + + +
    +

    The mapping dictionary used to convert the value

    +
    +
    + + orDefault + + +
    +

    The default value if conversion fails

    +
    +
    +
    +
    +

    Return Value

    +

    An Enum representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asAddress() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a BTPostalAddress

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asAddress() -> BTPostalAddress?
    + +
    +
    +
    +

    Return Value

    +

    A BTPostalAddress parsed from the key/value pairs inside the BTJSON

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTLocalPaymentClient.html b/6.0.0-beta4/Classes/BTLocalPaymentClient.html new file mode 100644 index 0000000000..0b5c7493fd --- /dev/null +++ b/6.0.0-beta4/Classes/BTLocalPaymentClient.html @@ -0,0 +1,539 @@ + + + + BTLocalPaymentClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLocalPaymentClient Class Reference +

+ +
+ +
+ +
+
+

BTLocalPaymentClient

+
+
+ + 
@objcMembers
+public class BTLocalPaymentClient : BTWebAuthenticationSessionClient
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new BTLocalPaymentClient instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTLocalPaymentRequest.html b/6.0.0-beta4/Classes/BTLocalPaymentRequest.html new file mode 100644 index 0000000000..e1f3d5eac1 --- /dev/null +++ b/6.0.0-beta4/Classes/BTLocalPaymentRequest.html @@ -0,0 +1,778 @@ + + + + BTLocalPaymentRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLocalPaymentRequest Class Reference +

+ +
+ +
+ +
+
+

BTLocalPaymentRequest

+
+
+ + 
@objcMembers
+public class BTLocalPaymentRequest : NSObject
+ +
+
+

Used to initialize a local payment flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + paymentType + +
    +
    +
    +
    +
    +
    +

    The type of payment.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentType: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The country code of the local payment.

    + +

    This value must be one of the supported country codes for a given local payment type listed at the link below. For local payments supported in multiple countries, this value may determine which banks are presented to the customer.

    + +

    https://developer.paypal.com/braintree/docs/guides/local-payment-methods/client-side-custom/ios/v5#invoke-payment-flow

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentTypeCountryCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + merchantAccountID + +
    +
    +
    +
    +
    +
    +

    Optional: The address of the customer. An error will occur if this address is not valid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var merchantAccountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    Optional: The address of the customer. An error will occur if this address is not valid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var address: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount for the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var amount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + currencyCode + +
    +
    +
    +
    +
    +
    +

    Optional: A valid ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currencyCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    Optional: The merchant name displayed inside of the local payment flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var displayName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Optional: Payer email of the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + givenName + +
    +
    +
    +
    +
    +
    +

    Optional: Given (first) name of the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var givenName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + surname + +
    +
    +
    +
    +
    +
    +

    Optional: Surname (last name) of the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var surname: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    Optional: Phone number of the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phone: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Indicates whether or not the payment needs to be shipped. For digital goods, this should be false. Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isShippingAddressRequired: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + bic + +
    +
    +
    +
    +
    +
    +

    Optional: Bank Identification Code of the customer (specific to iDEAL transactions).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bic: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public weak var localPaymentFlowDelegate: BTLocalPaymentRequestDelegate?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTLocalPaymentResult.html b/6.0.0-beta4/Classes/BTLocalPaymentResult.html new file mode 100644 index 0000000000..77ff1be912 --- /dev/null +++ b/6.0.0-beta4/Classes/BTLocalPaymentResult.html @@ -0,0 +1,645 @@ + + + + BTLocalPaymentResult Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLocalPaymentResult Class Reference +

+ +
+ +
+ +
+
+

BTLocalPaymentResult

+
+
+ + 
@objcMembers
+public class BTLocalPaymentResult : NSObject
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    The billing address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let billingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + clientMetadataID + +
    +
    +
    +
    +
    +
    +

    Client Metadata ID associated with this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientMetadataID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Payer’s email address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    Payer’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    Payer’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + nonce + +
    +
    +
    +
    +
    +
    +

    The one-time use payment method nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let nonce: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payerID + +
    +
    +
    +
    +
    +
    +

    Payer ID associated with this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    Payer’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let phone: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingAddress + +
    +
    +
    +
    +
    +
    +

    The shipping address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let shippingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The type of the tokenized payment.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let type: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTLogLevelDescription.html b/6.0.0-beta4/Classes/BTLogLevelDescription.html new file mode 100644 index 0000000000..02e899001f --- /dev/null +++ b/6.0.0-beta4/Classes/BTLogLevelDescription.html @@ -0,0 +1,375 @@ + + + + BTLogLevelDescription Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLogLevelDescription Class Reference +

+ +
+ +
+ +
+
+

BTLogLevelDescription

+
+
+ + 
@objcMembers
+public class BTLogLevelDescription : NSObject
+ +
+
+

Wrapper for accessing the string value of the log level

+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalAccountNonce.html b/6.0.0-beta4/Classes/BTPayPalAccountNonce.html new file mode 100644 index 0000000000..ce2da3dd7a --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalAccountNonce.html @@ -0,0 +1,618 @@ + + + + BTPayPalAccountNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalAccountNonce Class Reference +

+ +
+ +
+ +
+
+

BTPayPalAccountNonce

+
+
+ + 
@objcMembers
+public class BTPayPalAccountNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a PayPal payment method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Payer’s email address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    Payer’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    Payer’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    Payer’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let phone: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    The billing address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let billingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingAddress + +
    +
    +
    +
    +
    +
    +

    The shipping address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let shippingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + clientMetadataID + +
    +
    +
    +
    +
    +
    +

    Client metadata id associated with this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientMetadataID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payerID + +
    +
    +
    +
    +
    +
    +

    Optional. Payer id associated with this transaction. +Will be provided for Vault and Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + creditFinancing + +
    +
    +
    +
    +
    +
    +

    Optional. Credit financing details if the customer pays with PayPal Credit. +Will be provided for Vault and Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let creditFinancing: BTPayPalCreditFinancing?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalCheckoutRequest.html b/6.0.0-beta4/Classes/BTPayPalCheckoutRequest.html new file mode 100644 index 0000000000..f8ea771e05 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalCheckoutRequest.html @@ -0,0 +1,674 @@ + + + + BTPayPalCheckoutRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalCheckoutRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalCheckoutRequest

+
+
+ + 
@objcMembers
+open class BTPayPalCheckoutRequest : BTPayPalRequest
+ +
+
+

Options for the PayPal Checkout flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    Used for a one-time payment.

    + +

    Amount must be greater than or equal to zero, may optionally contain exactly 2 decimal places separated by ‘.’ and is limited to 7 digits before the decimal point.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var amount: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + intent + +
    +
    +
    +
    +
    +
    +

    Optional: Payment intent. Defaults to .authorize. Only applies to PayPal Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intent: BTPayPalRequestIntent
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + userAction + +
    +
    +
    +
    +
    +
    +

    Optional: Changes the call-to-action in the PayPal Checkout flow. Defaults to .none.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var userAction: BTPayPalRequestUserAction
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + offerPayLater + +
    +
    +
    +
    +
    +
    +

    Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var offerPayLater: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + currencyCode + +
    +
    +
    +
    +
    +
    +

    Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

    +
    +

    Note

    + See https://developer.paypal.com/docs/api/reference/currency-codes/ for a list of supported currency codes. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currencyCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional: If set to true, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement during checkout. Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var requestBillingAgreement: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a PayPal Native Checkout request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(
+    amount: String,
+    intent: BTPayPalRequestIntent = .authorize,
+    userAction: BTPayPalRequestUserAction = .none,
+    offerPayLater: Bool = false,
+    currencyCode: String? = nil,
+    requestBillingAgreement: Bool = false
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    Used for a one-time payment. Amount must be greater than or equal to zero, may optionally contain exactly 2 decimal places separated by ‘.’

    +
    +
    + + intent + + +
    +

    Optional: Payment intent. Defaults to .authorize. Only applies to PayPal Checkout. +and is limited to 7 digits before the decimal point.

    +
    +
    + + userAction + + +
    +

    Optional: Changes the call-to-action in the PayPal Checkout flow. Defaults to .none.

    +
    +
    + + offerPayLater + + +
    +

    Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.

    +
    +
    + + currencyCode + + +
    +

    Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set. +See https://developer.paypal.com/docs/api/reference/currency-codes/ for a list of supported currency codes.

    +
    +
    + + requestBillingAgreement + + +
    +

    Optional: If set to true, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement +during checkout. Defaults to false.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalClient.html b/6.0.0-beta4/Classes/BTPayPalClient.html new file mode 100644 index 0000000000..86943b17c0 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalClient.html @@ -0,0 +1,705 @@ + + + + BTPayPalClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalClient Class Reference +

+ +
+ +
+ +
+
+

BTPayPalClient

+
+
+ + 
@objc
+public class BTPayPalClient : BTWebAuthenticationSessionClient
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new PayPal client instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    The API Client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Tokenize a PayPal request to be used with the PayPal Vault flow.

    +
    +

    Note

    + You can use this as the final step in your order/checkout flow. If you want, you may create a transaction from your +server when this method completes without any additional user interaction. + +
    + +

    On success, you will receive an instance of BTPayPalAccountNonce; on failure or user cancelation you will receive an error. +If the user cancels out of the flow, the error code will be .canceled.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeWithVaultRequest:completion:)
+public func tokenize(
+    _ request: BTPayPalVaultRequest,
+    completion: @escaping (BTPayPalAccountNonce?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + + +
    + + completion + + +
    +

    This completion will be invoked exactly once when tokenization is complete or an error occurs.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Tokenize a PayPal request to be used with the PayPal Vault flow.

    +
    +

    Note

    + You can use this as the final step in your order/checkout flow. If you want, you may create a transaction from your +server when this method completes without any additional user interaction. + +
    + +

    On success, you will receive an instance of BTPayPalAccountNonce; on failure or user cancelation you will receive an error. +If the user cancels out of the flow, the error code will be .canceled.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ request: BTPayPalVaultRequest) async throws -> BTPayPalAccountNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + + +
    +
    +
    +

    Return Value

    +

    A BTPayPalAccountNonce if successful

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Tokenize a PayPal request to be used with the PayPal Checkout or Pay Later flow.

    +
    +

    Note

    + You can use this as the final step in your order/checkout flow. If you want, you may create a transaction from your +server when this method completes without any additional user interaction. + +
    + +

    On success, you will receive an instance of BTPayPalAccountNonce; on failure or user cancelation you will receive an error. +If the user cancels out of the flow, the error code will be .canceled.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeWithCheckoutRequest:completion:)
+public func tokenize(
+    _ request: BTPayPalCheckoutRequest,
+    completion: @escaping (BTPayPalAccountNonce?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + + +
    + + completion + + +
    +

    This completion will be invoked exactly once when tokenization is complete or an error occurs.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Tokenize a PayPal request to be used with the PayPal Checkout or Pay Later flow.

    +
    +

    Note

    + You can use this as the final step in your order/checkout flow. If you want, you may create a transaction from your +server when this method completes without any additional user interaction. + +
    + +

    On success, you will receive an instance of BTPayPalAccountNonce; on failure or user cancelation you will receive an error. +If the user cancels out of the flow, the error code will be .canceled.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ request: BTPayPalCheckoutRequest) async throws -> BTPayPalAccountNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + + +
    +
    +
    +

    Return Value

    +

    A BTPayPalAccountNonce if successful

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalCreditFinancing.html b/6.0.0-beta4/Classes/BTPayPalCreditFinancing.html new file mode 100644 index 0000000000..0ae9511933 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalCreditFinancing.html @@ -0,0 +1,526 @@ + + + + BTPayPalCreditFinancing Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalCreditFinancing Class Reference +

+ +
+ +
+ +
+
+

BTPayPalCreditFinancing

+
+
+ + 
@objcMembers
+public class BTPayPalCreditFinancing : NSObject
+ +
+
+

Contains information about a PayPal credit financing option

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + cardAmountImmutable + +
    +
    +
    +
    +
    +
    +

    Indicates whether the card amount is editable after payer’s acceptance on PayPal side.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let cardAmountImmutable: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + monthlyPayment + +
    +
    +
    +
    +
    +
    +

    Estimated amount per month that the customer will need to pay including fees and interest.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let monthlyPayment: BTPayPalCreditFinancingAmount?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payerAcceptance + +
    +
    +
    +
    +
    +
    +

    Status of whether the customer ultimately was approved for and chose to make the payment using the approved installment credit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerAcceptance: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + term + +
    +
    +
    +
    +
    +
    +

    Length of financing terms in months.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let term: Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + totalCost + +
    +
    +
    +
    +
    +
    +

    Estimated total payment amount including interest and fees the user will pay during the lifetime of the loan.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let totalCost: BTPayPalCreditFinancingAmount?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + totalInterest + +
    +
    +
    +
    +
    +
    +

    Estimated interest or fees amount the payer will have to pay during the lifetime of the loan.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let totalInterest: BTPayPalCreditFinancingAmount?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalCreditFinancingAmount.html b/6.0.0-beta4/Classes/BTPayPalCreditFinancingAmount.html new file mode 100644 index 0000000000..7ddd358b2d --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalCreditFinancingAmount.html @@ -0,0 +1,406 @@ + + + + BTPayPalCreditFinancingAmount Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalCreditFinancingAmount Class Reference +

+ +
+ +
+ +
+
+

BTPayPalCreditFinancingAmount

+
+
+ + 
@objcMembers
+public class BTPayPalCreditFinancingAmount : NSObject
+ +
+
+

Contains information about a PayPal credit amount

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    3 letter currency code as defined by ISO 4217.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    An amount defined by ISO 4217 for the given currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let value: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalLineItem.html b/6.0.0-beta4/Classes/BTPayPalLineItem.html new file mode 100644 index 0000000000..bffc387923 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalLineItem.html @@ -0,0 +1,741 @@ + + + + BTPayPalLineItem Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalLineItem Class Reference +

+ +
+ +
+ +
+
+

BTPayPalLineItem

+
+
+ + 
@objcMembers
+public class BTPayPalLineItem : NSObject
+ +
+
+

A PayPal line item to be displayed in the PayPal checkout flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + quantity + +
    +
    +
    +
    +
    +
    +

    Number of units of the item purchased. This value must be a whole number and can’t be negative or zero.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let quantity: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + unitAmount + +
    +
    +
    +
    +
    +
    +

    Per-unit price of the item. Can include up to 2 decimal places. This value can’t be negative or zero.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let unitAmount: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    Item name. Maximum 127 characters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + kind + +
    +
    +
    +
    +
    +
    +

    Indicates whether the line item is a debit (sale) or credit (refund) to the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let kind: BTPayPalLineItemKind
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + unitTaxAmount + +
    +
    +
    +
    +
    +
    +

    Optional: Per-unit tax price of the item. Can include up to 2 decimal places. This value can’t be negative or zero.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let unitTaxAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + itemDescription + +
    +
    +
    +
    +
    +
    +

    Optional: Item description. Maximum 127 characters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let itemDescription: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + productCode + +
    +
    +
    +
    +
    +
    +

    Optional: Product or UPC code for the item. Maximum 127 characters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let productCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + url + +
    +
    +
    +
    +
    +
    +

    Optional: The URL to product information.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let url: URL?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Initializer +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initialize a PayPayLineItem

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithQuantity:unitAmount:name:kind:)
+public init(quantity: String, unitAmount: String, name: String, kind: BTPayPalLineItemKind)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + quantity + + +
    +

    Number of units of the item purchased. Can include up to 4 decimal places. This value can’t be negative or zero.

    +
    +
    + + unitAmount + + +
    +

    Per-unit price of the item. Can include up to 4 decimal places. This value can’t be negative or zero.

    +
    +
    + + name + + +
    +

    Item name. Maximum 127 characters.

    +
    +
    + + kind + + +
    +

    Indicates whether the line item is a debit (sale) or credit (refund) to the customer.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • +
    + + + + requestParameters() + +
    +
    +
    +
    +
    +
    +

    Returns the line item in a dictionary.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func requestParameters() -> [String : String]
    + +
    +
    +
    +

    Return Value

    +

    A dictionary with the line item information formatted for a request.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalNativeCheckoutAccountNonce.html b/6.0.0-beta4/Classes/BTPayPalNativeCheckoutAccountNonce.html new file mode 100644 index 0000000000..3dfde723fc --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalNativeCheckoutAccountNonce.html @@ -0,0 +1,596 @@ + + + + BTPayPalNativeCheckoutAccountNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalNativeCheckoutAccountNonce Class Reference +

+ +
+ +
+ +
+
+

BTPayPalNativeCheckoutAccountNonce

+
+
+ + 
@objcMembers
+public class BTPayPalNativeCheckoutAccountNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a PayPal payment method.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Payer’s email address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    Payer’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    Payer’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    Payer’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let phone: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    The billing address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let billingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingAddress + +
    +
    +
    +
    +
    +
    +

    The shipping address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let shippingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + clientMetadataID + +
    +
    +
    +
    +
    +
    +

    Client metadata id associated with this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientMetadataID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payerID + +
    +
    +
    +
    +
    +
    +

    Optional. Payer id associated with this transaction. +Will be provided for Vault and Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalNativeCheckoutClient.html b/6.0.0-beta4/Classes/BTPayPalNativeCheckoutClient.html new file mode 100644 index 0000000000..f3802b74f4 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalNativeCheckoutClient.html @@ -0,0 +1,677 @@ + + + + BTPayPalNativeCheckoutClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalNativeCheckoutClient Class Reference +

+ +
+ +
+ +
+
+

BTPayPalNativeCheckoutClient

+
+
+ + 
@objc
+public class BTPayPalNativeCheckoutClient : NSObject
+ +
+
+

Client used to collect PayPal payment methods. If possible, this client will present a native flow; otherwise, it will fall back to a web flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initializes a PayPal Native client.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    The Braintree API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalNativeCheckoutRequest.html b/6.0.0-beta4/Classes/BTPayPalNativeCheckoutRequest.html new file mode 100644 index 0000000000..adecf5d584 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalNativeCheckoutRequest.html @@ -0,0 +1,474 @@ + + + + BTPayPalNativeCheckoutRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalNativeCheckoutRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalNativeCheckoutRequest

+
+
+ + 
@objcMembers
+public class BTPayPalNativeCheckoutRequest : BTPayPalCheckoutRequest
+ +
+
+

Options for the PayPal Checkout flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a PayPal Native Checkout request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(
+    amount: String,
+    intent: BTPayPalRequestIntent = .authorize,
+    offerPayLater: Bool = false,
+    currencyCode: String? = nil,
+    requestBillingAgreement: Bool = false,
+    billingAgreementDescription: String? = nil
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    Used for a one-time payment. Amount must be greater than or equal to zero, may optionally contain exactly 2 decimal places separated by ‘.’

    +
    +
    + + intent + + +
    +

    Optional: Payment intent. Defaults to .authorize. Only applies to PayPal Checkout. +and is limited to 7 digits before the decimal point.

    +
    +
    + + offerPayLater + + +
    +

    Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.

    +
    +
    + + currencyCode + + +
    +

    Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set. +See https://developer.paypal.com/docs/api/reference/currency-codes/ for a list of supported currency codes.

    +
    +
    + + requestBillingAgreement + + +
    +

    Optional: If set to true, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement during checkout.

    +
    +
    + + billingAgreementDescription + + +
    +

    Optional: Display a custom description to the user for a billing agreement. For Checkout with Vault flows, you must also +set requestBillingAgreement to true on your BTPayPalNativeVaultRequest.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalNativeVaultRequest.html b/6.0.0-beta4/Classes/BTPayPalNativeVaultRequest.html new file mode 100644 index 0000000000..f3f48eb04b --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalNativeVaultRequest.html @@ -0,0 +1,420 @@ + + + + BTPayPalNativeVaultRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalNativeVaultRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalNativeVaultRequest

+
+
+ + 
@objcMembers
+public class BTPayPalNativeVaultRequest : BTPayPalVaultRequest
+ +
+
+

Options for the PayPal Vault flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a PayPal Native Vault request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(
+    offerCredit: Bool = false,
+    billingAgreementDescription: String? = nil
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + offerCredit + + +
    +

    Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

    +
    +
    + + billingAgreementDescription + + +
    +

    Optional: Display a custom description to the user for a billing agreement. For Checkout with Vault flows, you must also set +requestBillingAgreement to true on your BTPayPalCheckoutRequest.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalRequest.html b/6.0.0-beta4/Classes/BTPayPalRequest.html new file mode 100644 index 0000000000..a8e5784c10 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalRequest.html @@ -0,0 +1,673 @@ + + + + BTPayPalRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalRequest

+
+
+ + 
@objcMembers
+open class BTPayPalRequest : NSObject
+ +
+
+

Base options for PayPal Checkout and PayPal Vault flows.

+
+

Note

+ Do not instantiate this class directly. Instead, use BTPayPalCheckoutRequest or BTPayPalVaultRequest. + +
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Defaults to false. When set to true, the shipping address selector will be displayed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isShippingAddressRequired: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Defaults to false. Set to true to enable user editing of the shipping address.

    +
    +

    Note

    + Only applies when shippingAddressOverride is set. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isShippingAddressEditable: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + localeCode + +
    +
    +
    +
    +
    +
    +

    Optional: A locale code to use for the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var localeCode: BTPayPalLocaleCode
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional: A valid shipping address to be displayed in the transaction flow. An error will occur if this address is not valid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingAddressOverride: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + landingPageType + +
    +
    +
    +
    +
    +
    +

    Optional: Landing page type. Defaults to .none.

    +
    +

    Note

    + Setting the BTPayPalRequest’s landingPageType changes the PayPal page to display when a user lands on the PayPal site to complete the payment. +.login specifies a PayPal account login page is used. +.billing specifies a non-PayPal account landing page is used. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var landingPageType: BTPayPalRequestLandingPageType
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    Optional: The merchant name displayed inside of the PayPal flow; defaults to the company name on your Braintree account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var displayName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + merchantAccountID + +
    +
    +
    +
    +
    +
    +

    Optional: A non-default merchant account to use for tokenization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var merchantAccountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lineItems + +
    +
    +
    +
    +
    +
    +

    Optional: The line items for this transaction. It can include up to 249 line items.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lineItems: [BTPayPalLineItem]?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional: Display a custom description to the user for a billing agreement. For Checkout with Vault flows, you must also set + requestBillingAgreement to true on your BTPayPalCheckoutRequest.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var billingAgreementDescription: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + riskCorrelationID + +
    +
    +
    +
    +
    +
    +

    Optional: A risk correlation ID created with Set Transaction Context on your server.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var riskCorrelationID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPayPalVaultRequest.html b/6.0.0-beta4/Classes/BTPayPalVaultRequest.html new file mode 100644 index 0000000000..924a7cb4f4 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPayPalVaultRequest.html @@ -0,0 +1,447 @@ + + + + BTPayPalVaultRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalVaultRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalVaultRequest

+
+
+ + 
@objcMembers
+open class BTPayPalVaultRequest : BTPayPalRequest
+ +
+
+

Options for the PayPal Vault flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + offerCredit + +
    +
    +
    +
    +
    +
    +

    Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var offerCredit: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(offerCredit:) + +
    +
    +
    +
    +
    +
    +

    Initializes a PayPal Native Vault request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(offerCredit: Bool = false)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + offerCredit + + +
    +

    Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPaymentMethodNonce.html b/6.0.0-beta4/Classes/BTPaymentMethodNonce.html new file mode 100644 index 0000000000..01315e0818 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPaymentMethodNonce.html @@ -0,0 +1,642 @@ + + + + BTPaymentMethodNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPaymentMethodNonce Class Reference +

+ +
+ +
+ +
+
+

BTPaymentMethodNonce

+
+
+ + 
@objcMembers
+open class BTPaymentMethodNonce : NSObject
+ +
+
+

BTPaymentMethodNonce is for generic tokenized payment information.

+ +

For example, if a customer’s vaulted payment methods contains a type that’s not recognized or supported by the +Braintree SDK or the client-side integration (e.g. the vault contains a PayPal account but the client-side +integration does not include the PayPal component), this type can act as a fallback.

+ +

The payment method nonce is a public token that acts as a placeholder for sensitive payments data that +has been uploaded to Braintree for subsequent processing. The nonce is safe to access on the client and can be +used on your server to reference the data in Braintree operations, such as Transaction.sale.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + nonce + +
    +
    +
    +
    +
    +
    +

    The payment method nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var nonce: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The string identifying the type of the payment method.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var type: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isDefault + +
    +
    +
    +
    +
    +
    +

    The boolean indicating whether this is a default payment method.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isDefault: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(nonce:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new Payment Method Nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithNonce:)
+public init(nonce: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + nonce + + +
    +

    A transact-able payment method nonce.

    +
    +
    +
    +
    +

    Return Value

    +

    A Payment Method Nonce, or nil if nonce is nil.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(nonce:type:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new Payment Method Nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithNonce:type:)
+public init(nonce: String, type: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + nonce + + +
    +

    A transact-able payment method nonce.

    +
    +
    + + type + + +
    +

    A string identifying the type of the payment method.

    +
    +
    +
    +
    +

    Return Value

    +

    A Payment Method Nonce, or nil if nonce is nil.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a new Payment Method Nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithNonce:type:isDefault:)
+public init(nonce: String, type: String, isDefault: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + nonce + + +
    +

    A transact-able payment method nonce.

    +
    +
    + + type + + +
    +

    A string identifying the type of the payment method.

    +
    +
    + + isDefault + + +
    +

    A boolean indicating whether this is a default payment method.

    +
    +
    +
    +
    +

    Return Value

    +

    A Payment Method Nonce, or nil if nonce is nil.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPaymentMethodNonceParser.html b/6.0.0-beta4/Classes/BTPaymentMethodNonceParser.html new file mode 100644 index 0000000000..015bf0ef46 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPaymentMethodNonceParser.html @@ -0,0 +1,564 @@ + + + + BTPaymentMethodNonceParser Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPaymentMethodNonceParser Class Reference +

+ +
+ +
+ +
+
+

BTPaymentMethodNonceParser

+
+
+ + 
@objcMembers
+public class BTPaymentMethodNonceParser : NSObject
+ +
+
+

A JSON parser that parses BTJSON into concrete BTPaymentMethodNonce objects. It supports registration of parsers at runtime.

+ +

BTPaymentMethodNonceParser provides access to JSON parsing for different payment options +without introducing compile-time dependencies on payment option frameworks and their symbols.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    The singleton instance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(sharedParser)
+public static let shared: BTPaymentMethodNonceParser
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + allTypes + +
    +
    +
    +
    +
    +
    +

    An array of the tokenization types currently registered

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var allTypes: [String] { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isTypeAvailable(_:) + +
    +
    +
    +
    +
    +
    +

    Indicates whether a tokenization type is currently registered

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func isTypeAvailable(_ type: String) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + type + + +
    +

    The tokenization type string

    +
    +
    +
    +
    +

    Return Value

    +

    A bool indicating if the payment method type is available.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Registers a parsing block for a tokenization type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func registerType(_ type: String?, withParsingBlock: @escaping (_ json: BTJSON?) -> BTPaymentMethodNonce?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + type + + +
    +

    The tokenization type string

    +
    +
    + + withParsingBlock + + +
    +

    jsonParsingBlock The block to execute when parseJSON:type: is called for the tokenization type. +This block should return a BTPaymentMethodNonce object, or nil if the JSON cannot be parsed.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Parses tokenized payment information that has been serialized to JSON, and returns a BTPaymentMethodNonce object.

    + +

    The BTPaymentMethodNonce object is created by the JSON parsing block that has been registered for the tokenization type.

    + +

    If the type has not been registered, this method will attempt to read the nonce from the JSON and return + a basic object; if it fails, it will return nil.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func parseJSON(_ json: BTJSON?, withParsingBlockForType type: String?) -> BTPaymentMethodNonce?
    + +
    +
    +
    +

    Return Value

    +

    A BTPaymentMethodNonce object, or nil if the tokenized payment info JSON does not contain a nonce

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTPostalAddress.html b/6.0.0-beta4/Classes/BTPostalAddress.html new file mode 100644 index 0000000000..c5b1813dd9 --- /dev/null +++ b/6.0.0-beta4/Classes/BTPostalAddress.html @@ -0,0 +1,587 @@ + + + + BTPostalAddress Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPostalAddress Class Reference +

+ +
+ +
+ +
+
+

BTPostalAddress

+
+
+ + 
@objcMembers
+public class BTPostalAddress : NSObject, NSCopying
+ +
+
+

Generic postal address

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + recipientName + +
    +
    +
    +
    +
    +
    +

    Optional. Recipient name for shipping address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var recipientName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + streetAddress + +
    +
    +
    +
    +
    +
    +

    Line 1 of the Address (eg. number, street, etc).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var streetAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + extendedAddress + +
    +
    +
    +
    +
    +
    +

    Optional line 2 of the Address (eg. suite, apt #, etc.).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var extendedAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + locality + +
    +
    +
    +
    +
    +
    +

    City name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var locality: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeAlpha2 + +
    +
    +
    +
    +
    +
    +

    2 letter country code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeAlpha2: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    Zip code or equivalent is usually required for countries that have them. +For a list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + region + +
    +
    +
    +
    +
    +
    +

    Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var region: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + copy(with:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(copyWithZone:)
+public func copy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTSEPADirectDebitClient.html b/6.0.0-beta4/Classes/BTSEPADirectDebitClient.html new file mode 100644 index 0000000000..949ebb302a --- /dev/null +++ b/6.0.0-beta4/Classes/BTSEPADirectDebitClient.html @@ -0,0 +1,544 @@ + + + + BTSEPADirectDebitClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTSEPADirectDebitClient Class Reference +

+ +
+ +
+ +
+
+

BTSEPADirectDebitClient

+
+
+ + 
@objc
+public class BTSEPADirectDebitClient : BTWebAuthenticationSessionClient
+ +
+
+

Used to integrate with SEPA Direct Debit.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializers +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Creates a SEPA Direct Debit client.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An instance of BTAPIClient

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initiates an ASWebAuthenticationSession to display a mandate to the user. Upon successful mandate creation, tokenizes the payment method and returns a result

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeWithSEPADirectDebitRequest:completion:)
+public func tokenize(
+    _ request: BTSEPADirectDebitRequest,
+    completion:  @escaping (BTSEPADirectDebitNonce?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    a BTSEPADebitRequest

    +
    +
    + + completion + + +
    +

    This completion will be invoked exactly once when tokenization is complete or an error occurs

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Initiates an ASWebAuthenticationSession to display a mandate to the user. Upon successful mandate creation, tokenizes the payment method and returns a result

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ request: BTSEPADirectDebitRequest) async throws -> BTSEPADirectDebitNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + +
    +

    a BTSEPADebitRequest

    +
    +
    +
    +
    +

    Return Value

    +

    A BTSEPADirectDebitNonce if successful

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTSEPADirectDebitNonce.html b/6.0.0-beta4/Classes/BTSEPADirectDebitNonce.html new file mode 100644 index 0000000000..e76e8ba50c --- /dev/null +++ b/6.0.0-beta4/Classes/BTSEPADirectDebitNonce.html @@ -0,0 +1,436 @@ + + + + BTSEPADirectDebitNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTSEPADirectDebitNonce Class Reference +

+ +
+ +
+ +
+
+

BTSEPADirectDebitNonce

+
+
+ + 
@objcMembers
+public class BTSEPADirectDebitNonce : BTPaymentMethodNonce
+ +
+
+

A payment method nonce representing a SEPA Direct Debit payment.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTSEPADirectDebitRequest.html b/6.0.0-beta4/Classes/BTSEPADirectDebitRequest.html new file mode 100644 index 0000000000..44212e774a --- /dev/null +++ b/6.0.0-beta4/Classes/BTSEPADirectDebitRequest.html @@ -0,0 +1,642 @@ + + + + BTSEPADirectDebitRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTSEPADirectDebitRequest Class Reference +

+ +
+ +
+ +
+
+

BTSEPADirectDebitRequest

+
+
+ + 
@objcMembers
+public class BTSEPADirectDebitRequest : NSObject
+ +
+
+

Parameters for creating a SEPA Direct Debit tokenization request.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + accountHolderName + +
    +
    +
    +
    +
    +
    +

    Required. The account holder name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountHolderName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + iban + +
    +
    +
    +
    +
    +
    +

    Required. The full IBAN.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var iban: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + customerID + +
    +
    +
    +
    +
    +
    +

    Required. The customer ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var customerID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + mandateType + +
    +
    +
    +
    +
    +
    +

    Optional. The BTSEPADebitMandateType. If not set, defaults to .oneOff

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mandateType: BTSEPADirectDebitMandateType?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    Required. The user’s billing address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var billingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + merchantAccountID + +
    +
    +
    +
    +
    +
    +

    Optional. A non-default merchant account to use for tokenization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var merchantAccountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a new SEPA Direct Debit request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(
+    accountHolderName: String? = nil,
+    iban: String? = nil,
+    customerID: String? = nil,
+    mandateType: BTSEPADirectDebitMandateType? = .oneOff,
+    billingAddress: BTPostalAddress? = nil,
+    merchantAccountID: String? = nil
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + accountHolderName + + +
    +

    Required. The account holder name.

    +
    +
    + + iban + + +
    +

    Required. The full IBAN.

    +
    +
    + + customerID + + +
    +

    Required. The customer ID.

    +
    +
    + + mandateType + + +
    +

    Optional. The BTSEPADebitMandateType. If not set, defaults to .oneOff

    +
    +
    + + billingAddress + + +
    +

    Required. The user’s billing address.

    +
    +
    + + merchantAccountID + + +
    +

    Optional. A non-default merchant account to use for tokenization.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureAdditionalInformation.html b/6.0.0-beta4/Classes/BTThreeDSecureAdditionalInformation.html new file mode 100644 index 0000000000..e1276afb77 --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureAdditionalInformation.html @@ -0,0 +1,1678 @@ + + + + BTThreeDSecureAdditionalInformation Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureAdditionalInformation Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureAdditionalInformation

+
+
+ + 
@objcMembers
+public class BTThreeDSecureAdditionalInformation : NSObject
+ +
+
+

Additional information for a 3DS lookup. Used in 3DS 2.0+ flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + shippingAddress + +
    +
    +
    +
    +
    +
    +

    Optional. The shipping address used for verification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingAddress: BTThreeDSecurePostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit string indicating the shipping method chosen for the transaction

    + +

    Possible Values:

    + +
      +
    • 01: Ship to cardholder billing address
      • +
    • 02: Ship to another verified address on file with merchant
      • +
    • 03: Ship to address that is different than billing address
      • +
    • 04: Ship to store (store address should be populated on request)
      • +
    • 05: Digital goods
      • +
    • 06: Travel and event tickets, not shipped
      • +
    • 07: Other
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingMethodIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + productCode + +
    +
    +
    +
    +
    +
    +

    Optional. The 3-letter string representing the merchant product code

    + +

    Possible Values:

    + +
      +
    • AIR: Airline
      • +
    • GEN: General Retail
      • +
    • DIG: Digital Goods
      • +
    • SVC: Services
      • +
    • RES: Restaurant
      • +
    • TRA: Travel
      • +
    • DSP: Cash Dispensing
      • +
    • REN: Car Rental
      • +
    • GAS: Fueld
      • +
    • LUX: Luxury Retail
      • +
    • ACC: Accommodation Retail
      • +
    • TBD: Other
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var productCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + deliveryTimeframe + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit number indicating the delivery timeframe

    + +

    Possible values:

    + +
      +
    • 01: Electronic delivery
      • +
    • 02: Same day shipping
      • +
    • 03: Overnight shipping
      • +
    • 04: Two or more day shipping
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var deliveryTimeframe: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + deliveryEmail + +
    +
    +
    +
    +
    +
    +

    Optional. For electronic delivery, email address to which the merchandise was delivered

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var deliveryEmail: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + reorderIndicator + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit number indicating whether the cardholder is reordering previously purchased merchandise

    + +

    Possible values:

    + +
      +
    • 01: First time ordered
      • +
    • 02: Reordered
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var reorderIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + preorderIndicator + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit number indicating whether the cardholder is placing an order with a future availability or release date

    + +

    Possible values:

    + +
      +
    • 01: Merchandise available
      • +
    • 02: Future availability
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var preorderIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + preorderDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating expected date that a pre-ordered purchase will be available

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var preorderDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + giftCardAmount + +
    +
    +
    +
    +
    +
    +

    Optional. The purchase amount total for prepaid gift cards in major units

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var giftCardAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + giftCardCurrencyCode + +
    +
    +
    +
    +
    +
    +

    Optional. ISO 4217 currency code for the gift card purchased

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var giftCardCurrencyCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + giftCardCount + +
    +
    +
    +
    +
    +
    +

    Optional. Total count of individual prepaid gift cards purchased

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var giftCardCount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountAgeIndicator + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit value representing the length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.

    + +

    Possible values:

    + +
      +
    • 01: Changed during transaction
      • +
    • 02: Less than 30 days
      • +
    • 03: 30-60 days
      • +
    • 04: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountAgeIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountCreateDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder’s account was last changed. +This includes changes to the billing or shipping address, new payment accounts or new users added.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountCreateDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit value representing the length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.

    + +

    Possible values:

    + +
      +
    • 01: Changed during transaction
      • +
    • 02: Less than 30 days
      • +
    • 03: 30-60 days
      • +
    • 04: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountChangeIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountChangeDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder’s account was last changed. +This includes changes to the billing or shipping address, new payment accounts or new users added.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountChangeDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit value representing the length of time since the cardholder changed or reset the password on the account.

    + +

    Possible values:

    + +
      +
    • 01: No change
      • +
    • 02: Changed during transaction
      • +
    • 03: Less than 30 days
      • +
    • 04: 30-60 days
      • +
    • 05: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountPwdChangeIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountPwdChangeDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder last changed or reset password on account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountPwdChangeDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit value indicating when the shipping address used for transaction was first used.

    + +

    Possible values:

    + +
      +
    • 01: This transaction
      • +
    • 02: Less than 30 days
      • +
    • 03: 30-60 days
      • +
    • 04: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingAddressUsageIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date when the shipping address used for this transaction was first used.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingAddressUsageDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + transactionCountDay + +
    +
    +
    +
    +
    +
    +

    Optional. Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transactionCountDay: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + transactionCountYear + +
    +
    +
    +
    +
    +
    +

    Optional. Number of transactions (successful or abandoned) for this cardholder account within the last year.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transactionCountYear: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + addCardAttempts + +
    +
    +
    +
    +
    +
    +

    Optional. Number of add card attempts in the last 24 hours.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addCardAttempts: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountPurchases + +
    +
    +
    +
    +
    +
    +

    Optional. Number of purchases with this cardholder account during the previous six months.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountPurchases: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + fraudActivity + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit value indicating whether the merchant experienced suspicious activity (including previous fraud) on the account.

    + +

    Possible values:

    + +
      +
    • 01: No suspicious activity
      • +
    • 02: Suspicious activity observed
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var fraudActivity: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingNameIndicator + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit value indicating if the cardholder name on the account is identical to the shipping name used for the transaction.

    + +

    Possible values:

    + +
      +
    • 01: Account name identical to shipping name
      • +
    • 02: Account name different than shipping name
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingNameIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit value indicating the length of time that the payment account was enrolled in the merchant account.

    + +

    Possible values:

    + +
      +
    • 01: No account (guest checkout)
      • +
    • 02: During the transaction
      • +
    • 03: Less than 30 days
      • +
    • 04: 30-60 days
      • +
    • 05: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentAccountIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + paymentAccountAge + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date the payment account was added to the cardholder account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentAccountAge: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + addressMatch + +
    +
    +
    +
    +
    +
    +

    Optional. The 1-character value (Y/N) indicating whether cardholder billing and shipping addresses match.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressMatch: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountID + +
    +
    +
    +
    +
    +
    +

    Optional. Additional cardholder account information.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ipAddress + +
    +
    +
    +
    +
    +
    +

    Optional. The IP address of the consumer. IPv4 and IPv6 are supported.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var ipAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + orderDescription + +
    +
    +
    +
    +
    +
    +

    Optional. Brief description of items purchased.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var orderDescription: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + taxAmount + +
    +
    +
    +
    +
    +
    +

    Optional. Unformatted tax amount without any decimalization (ie. $123.67 = 12367).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var taxAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + userAgent + +
    +
    +
    +
    +
    +
    +

    Optional. The exact content of the HTTP user agent header.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var userAgent: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit number indicating the type of authentication request.

    + +

    Possible values:

    + +
      +
    • 02: Recurring transaction
      • +
    • 03: Installment transaction
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + installment + +
    +
    +
    +
    +
    +
    +

    Optional. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var installment: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + purchaseDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 14-digit number (format: YYYYMMDDHHMMSS) indicating the date in UTC of original purchase.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var purchaseDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + recurringEnd + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date after which no further recurring authorizations should be performed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var recurringEnd: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + recurringFrequency + +
    +
    +
    +
    +
    +
    +

    Optional. Integer value indicating the minimum number of days between recurring authorizations. +A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months (ex. 6 months = 168).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var recurringFrequency: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sdkMaxTimeout + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit number of minutes (minimum 05) to set the maximum amount of time for all 3DS 2.0 messages to be communicated between all components.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sdkMaxTimeout: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + workPhoneNumber + +
    +
    +
    +
    +
    +
    +

    Optional. The work phone number used for verification. Only numbers; remove dashes, parenthesis and other characters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var workPhoneNumber: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureClient.html b/6.0.0-beta4/Classes/BTThreeDSecureClient.html new file mode 100644 index 0000000000..acfcf9c666 --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureClient.html @@ -0,0 +1,758 @@ + + + + BTThreeDSecureClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureClient Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureClient

+
+
+ + 
@objcMembers
+public class BTThreeDSecureClient : NSObject
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new BTThreeDSecureClient instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Starts the 3DS flow using a BTThreeDSecureRequest.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func startPaymentFlow(_ request: BTThreeDSecureRequest, completion: @escaping (BTThreeDSecureResult?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    A BTThreeDSecureRequest request.

    +
    +
    + + completion + + +
    +

    This completion will be invoked exactly once when the 3DS flow is complete or an error occurs.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a stringified JSON object containing the information necessary to perform a lookup.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(prepareLookup:completion:)
+public func prepareLookup(
+    _ request: BTThreeDSecureRequest,
+    completion: @escaping (String?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    The BTThreeDSecureRequest object where prepareLookup was called.

    +
    +
    + + completion + + +
    +

    This completion will be invoked exactly once with the client payload string or an error.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + prepareLookup(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Creates a stringified JSON object containing the information necessary to perform a lookup.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func prepareLookup(_ request: BTThreeDSecureRequest) async throws -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + +
    +

    The BTThreeDSecureRequest object where prepareLookup was called.

    +
    +
    +
    +
    +

    Return Value

    +

    On success, you will receive a client payload string

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a challenge from a server side lookup call.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initializeChallengeWithLookupResponse:request:completion:)
+public func initializeChallenge(
+    lookupResponse: String,
+    request: BTThreeDSecureRequest,
+    completion: @escaping (BTThreeDSecureResult?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + lookupResponse + + +
    +

    The JSON string returned by the server side lookup.

    +
    +
    + + request + + +
    +

    The BTThreeDSecureRequest object where prepareLookup was called.

    +
    +
    + + completion + + +
    +

    This completion will be invoked exactly once when the payment flow is complete or an error occurs.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + initializeChallenge(lookupResponse:request:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Initialize a challenge from a server side lookup call.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func initializeChallenge(
+    lookupResponse: String,
+    request: BTThreeDSecureRequest
+) async throws -> BTThreeDSecureResult
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + lookupResponse + + +
    +

    The JSON string returned by the server side lookup.

    +
    +
    + + request + + +
    +

    The BTThreeDSecureRequest object where prepareLookup was called.

    +
    +
    +
    +
    +

    Return Value

    +

    On success, you will receive an instance of BTThreeDSecureResult

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureInfo.html b/6.0.0-beta4/Classes/BTThreeDSecureInfo.html new file mode 100644 index 0000000000..bb5366dc0d --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureInfo.html @@ -0,0 +1,913 @@ + + + + BTThreeDSecureInfo Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureInfo Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureInfo

+
+
+ + 
@objcMembers
+public class BTThreeDSecureInfo : NSObject
+ +
+
+

Contains information about the 3D Secure status of a payment method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + acsTransactionID + +
    +
    +
    +
    +
    +
    +

    Unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var acsTransactionID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    On authentication, the transaction status result identifier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationTransactionStatus: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    On authentication, provides additional information as to why the transaction status has the specific value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationTransactionStatusReason: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cavv + +
    +
    +
    +
    +
    +
    +

    Cardholder authentication verification value or “CAVV” is the main encrypted message issuers and card networks use to verify authentication has occured. +Mastercard uses an “AVV” message which will also be returned in the cavv parameter.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cavv: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + dsTransactionID + +
    +
    +
    +
    +
    +
    +

    Directory Server Transaction ID is an ID used by the card brand’s 3DS directory server.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dsTransactionID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + eciFlag + +
    +
    +
    +
    +
    +
    +

    The ecommerce indicator flag indicates the outcome of the 3DS authentication. +Possible values are 00, 01, and 02 for Mastercard 05, 06, and 07 for all other cardbrands.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var eciFlag: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + enrolled + +
    +
    +
    +
    +
    +
    +

    Indicates whether a card is enrolled in a 3D Secure program or not. Possible values:

    + +
      +
    • Y = Yes
      • +
    • N = No
      • +
    • U = Unavailable
      • +
    • B = Bypass
      • +
    • E = RequestFailure
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var enrolled: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + liabilityShifted + +
    +
    +
    +
    +
    +
    +

    If the 3D Secure liability shift has occurred.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var liabilityShifted: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If the 3D Secure liability shift is possible.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var liabilityShiftPossible: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    On lookup, the transaction status result identifier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lookupTransactionStatus: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    On lookup, provides additional information as to why the transaction status has the specific value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lookupTransactionStatusReason: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + paresStatus + +
    +
    +
    +
    +
    +
    +

    The Payer Authentication Response (PARes) Status, a transaction status result identifier. Possible Values:

    + +
      +
    • Y – Successful Authentication
      • +
    • N – Failed Authentication
      • +
    • U – Unable to Complete Authentication
      • +
    • A– Successful Stand-In Attempts Transaction
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paresStatus: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The 3D Secure status value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var status: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unique identifier assigned to the 3D Secure authentication performed for this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureAuthenticationID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unique transaction identifier assigned by the 3DS Server to identify a single transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureServerTransactionID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + threeDSecureVersion + +
    +
    +
    +
    +
    +
    +

    The 3DS version used in the authentication, example “1.0.2” or “2.1.0”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureVersion: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + wasVerified + +
    +
    +
    +
    +
    +
    +

    Indicates if the 3D Secure lookup was performed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var wasVerified: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + xid + +
    +
    +
    +
    +
    +
    +

    Transaction identifier resulting from 3D Secure authentication. Uniquely identifies the transaction and sometimes required in the authorization message. +This field will no longer be used in 3DS 2 authentications.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var xid: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureLookup.html b/6.0.0-beta4/Classes/BTThreeDSecureLookup.html new file mode 100644 index 0000000000..16d7fb7d74 --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureLookup.html @@ -0,0 +1,597 @@ + + + + BTThreeDSecureLookup Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureLookup Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureLookup

+
+
+ + 
@objcMembers
+public class BTThreeDSecureLookup : NSObject
+ +
+
+

The result of a 3DS lookup. +Contains liability shift and challenge information.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + paReq + +
    +
    +
    +
    +
    +
    +

    The “PAReq” or “Payment Authentication Request” is the encoded request message used to initiate authentication.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paReq: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + md + +
    +
    +
    +
    +
    +
    +

    The unique 3DS identifier assigned by Braintree to track the 3DS call as it progresses.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var md: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + acsURL + +
    +
    +
    +
    +
    +
    +

    The URL which the customer will be redirected to for a 3DS Interface. +In 3DS 2, the presence of an acsURL indicates there is a challenge as it would otherwise frictionlessly complete without an acsURL.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var acsURL: URL?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + termURL + +
    +
    +
    +
    +
    +
    +

    The termURL is the fully qualified URL that the customer will be redirected to once the authentication completes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var termURL: URL?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + threeDSecureVersion + +
    +
    +
    +
    +
    +
    +

    The full version string of the 3DS lookup result.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureVersion: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Indicates a 3DS 2 lookup result.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isThreeDSecureVersion2: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + transactionID + +
    +
    +
    +
    +
    +
    +

    This a secondary unique 3DS identifier assigned by Braintree to track the 3DS call as it progresses.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transactionID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Indicates that a 3DS challenge is required.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var requiresUserAuthentication: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecurePostalAddress.html b/6.0.0-beta4/Classes/BTThreeDSecurePostalAddress.html new file mode 100644 index 0000000000..fddad5d70a --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecurePostalAddress.html @@ -0,0 +1,704 @@ + + + + BTThreeDSecurePostalAddress Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecurePostalAddress Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecurePostalAddress

+
+
+ + 
@objcMembers
+public class BTThreeDSecurePostalAddress : NSObject
+
extension BTThreeDSecurePostalAddress: NSCopying
+ +
+
+

Postal address for 3D Secure flows

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + givenName + +
    +
    +
    +
    +
    +
    +

    Optional. Given name associated with the address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var givenName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + surname + +
    +
    +
    +
    +
    +
    +

    Optional. Surname associated with the address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var surname: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + streetAddress + +
    +
    +
    +
    +
    +
    +

    Optional. Line 1 of the Address (eg. number, street, etc)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var streetAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + extendedAddress + +
    +
    +
    +
    +
    +
    +

    Optional. Line 2 of the Address (eg. suite, apt #, etc.)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var extendedAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + line3 + +
    +
    +
    +
    +
    +
    +

    Optional. Line 3 of the Address (eg. suite, apt #, etc.)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var line3: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + locality + +
    +
    +
    +
    +
    +
    +

    Optional. City name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var locality: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + region + +
    +
    +
    +
    +
    +
    +

    Optional. Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var region: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    Optional. Zip code or equivalent is usually required for countries that have them. +For a list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeAlpha2 + +
    +
    +
    +
    +
    +
    +

    Optional. 2 letter country code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeAlpha2: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    Optional. The phone number associated with the address

    +
    +

    Note

    + Only numbers. Remove dashes, parentheses and other characters + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

NSCopying Protocol Conformance +

+
+
+
    +
  • +
    + + + + copy(with:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func copy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureRequest.html b/6.0.0-beta4/Classes/BTThreeDSecureRequest.html new file mode 100644 index 0000000000..e6c1d8af6a --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureRequest.html @@ -0,0 +1,824 @@ + + + + BTThreeDSecureRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureRequest Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureRequest

+
+
+ + 
@objcMembers
+public class BTThreeDSecureRequest : NSObject
+ +
+
+

Used to initialize a 3D Secure payment flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + nonce + +
    +
    +
    +
    +
    +
    +

    A nonce to be verified by ThreeDSecure

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var nonce: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount for the transaction

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var amount: NSDecimalNumber?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountType + +
    +
    +
    +
    +
    +
    +

    Optional. The account type selected by the cardholder

    +
    +

    Note

    + Some cards can be processed using either a credit or debit account and cardholders have the option to choose which account to use. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountType: BTThreeDSecureAccountType
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    Optional. The billing address used for verification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var billingAddress: BTThreeDSecurePostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + mobilePhoneNumber + +
    +
    +
    +
    +
    +
    +

    Optional. The mobile phone number used for verification

    +
    +

    Note

    + Only numbers. Remove dashes, parentheses and other characters + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mobilePhoneNumber: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Optional. The email used for verification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingMethod + +
    +
    +
    +
    +
    +
    +

    Optional. The shipping method chosen for the transaction

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingMethod: BTThreeDSecureShippingMethod
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + additionalInformation + +
    +
    +
    +
    +
    +
    +

    Optional. The additional information used for verification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var additionalInformation: BTThreeDSecureAdditionalInformation?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + challengeRequested + +
    +
    +
    +
    +
    +
    +

    Optional. If set to true, an authentication challenge will be forced if possible.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var challengeRequested: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + exemptionRequested + +
    +
    +
    +
    +
    +
    +

    Optional. If set to true, an exemption to the authentication challenge will be requested.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var exemptionRequested: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The exemption type to be requested. If an exemption is requested and the exemption’s conditions are satisfied, then it will be applied.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var requestedExemptionType: BTThreeDSecureRequestedExemptionType
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + dataOnlyRequested + +
    +
    +
    +
    +
    +
    +

    Optional. Indicates whether to use the data only flow. In this flow, frictionless 3DS is ensured for Mastercard cardholders as the card scheme provides a risk score +for the issuer to determine whether to approve. If data only is not supported by the processor, a validation error will be raised. +Non-Mastercard cardholders will fallback to a normal 3DS flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dataOnlyRequested: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cardAddChallenge + +
    +
    +
    +
    +
    +
    +

    Optional. An authentication created using this property should only be used for adding a payment method to the merchant’s vault and not for creating transactions.

    + +

    Defaults to .unspecified.

    + +

    If set to .challengeRequested, the authentication challenge will be requested from the issuer to confirm adding new card to the merchant’s vault. +If set to .notRequested the authentication challenge will not be requested from the issuer. +If set to .unspecified, when the amount is 0, the authentication challenge will be requested from the issuer. +If set to .unspecified, when the amount is greater than 0, the authentication challenge will not be requested from the issuer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardAddChallenge: BTThreeDSecureCardAddChallenge
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + v2UICustomization + +
    +
    +
    +
    +
    +
    +

    Optional. UI Customization for 3DS2 challenge views.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var v2UICustomization: BTThreeDSecureV2UICustomization?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A delegate for receiving information about the ThreeDSecure payment flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public weak var threeDSecureRequestDelegate: BTThreeDSecureRequestDelegate?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureResult.html b/6.0.0-beta4/Classes/BTThreeDSecureResult.html new file mode 100644 index 0000000000..76ee992ae1 --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureResult.html @@ -0,0 +1,445 @@ + + + + BTThreeDSecureResult Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureResult Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureResult

+
+
+ + 
@objcMembers
+public class BTThreeDSecureResult : NSObject
+ +
+
+

The result of a 3D Secure payment flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + tokenizedCard + +
    +
    +
    +
    +
    +
    +

    The BTCardNonce resulting from the 3D Secure flow

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var tokenizedCard: BTCardNonce?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lookup + +
    +
    +
    +
    +
    +
    +

    The result of a 3D Secure lookup. Contains liability shift and challenge information.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lookup: BTThreeDSecureLookup?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + errorMessage + +
    +
    +
    +
    +
    +
    +

    The error message when the 3D Secure flow is unsuccessful

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var errorMessage: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureV2BaseCustomization.html b/6.0.0-beta4/Classes/BTThreeDSecureV2BaseCustomization.html new file mode 100644 index 0000000000..e70dba50f4 --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureV2BaseCustomization.html @@ -0,0 +1,445 @@ + + + + BTThreeDSecureV2BaseCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2BaseCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2BaseCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2BaseCustomization : NSObject
+ +
+
+

Base customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + textFontName + +
    +
    +
    +
    +
    +
    +

    Font type for the UI element.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var textFontName: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + textColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var textColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + textFontSize + +
    +
    +
    +
    +
    +
    +

    Font size for the UI element.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var textFontSize: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureV2ButtonCustomization.html b/6.0.0-beta4/Classes/BTThreeDSecureV2ButtonCustomization.html new file mode 100644 index 0000000000..51c8df58b5 --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureV2ButtonCustomization.html @@ -0,0 +1,457 @@ + + + + BTThreeDSecureV2ButtonCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2ButtonCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2ButtonCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2ButtonCustomization : BTThreeDSecureV2BaseCustomization
+ +
+
+

Button customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + backgroundColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var backgroundColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cornerRadius + +
    +
    +
    +
    +
    +
    +

    Radius (integer value) for the button corners.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cornerRadius: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureV2LabelCustomization.html b/6.0.0-beta4/Classes/BTThreeDSecureV2LabelCustomization.html new file mode 100644 index 0000000000..b8a3dbc669 --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureV2LabelCustomization.html @@ -0,0 +1,487 @@ + + + + BTThreeDSecureV2LabelCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2LabelCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2LabelCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2LabelCustomization : BTThreeDSecureV2BaseCustomization
+ +
+
+

Label customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + headingTextColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var headingTextColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + headingTextFontName + +
    +
    +
    +
    +
    +
    +

    Font type for the heading label text.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var headingTextFontName: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + headingTextFontSize + +
    +
    +
    +
    +
    +
    +

    Font size for the heading label text.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var headingTextFontSize: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureV2TextBoxCustomization.html b/6.0.0-beta4/Classes/BTThreeDSecureV2TextBoxCustomization.html new file mode 100644 index 0000000000..9c729aee99 --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureV2TextBoxCustomization.html @@ -0,0 +1,487 @@ + + + + BTThreeDSecureV2TextBoxCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2TextBoxCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2TextBoxCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2TextBoxCustomization : BTThreeDSecureV2BaseCustomization
+ +
+
+

Text box customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + borderWidth + +
    +
    +
    +
    +
    +
    +

    Width (integer value) of the text box border.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var borderWidth: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + borderColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var borderColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cornerRadius + +
    +
    +
    +
    +
    +
    +

    Radius (integer value) for the text box corners.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cornerRadius: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureV2ToolbarCustomization.html b/6.0.0-beta4/Classes/BTThreeDSecureV2ToolbarCustomization.html new file mode 100644 index 0000000000..fc78f15988 --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureV2ToolbarCustomization.html @@ -0,0 +1,487 @@ + + + + BTThreeDSecureV2ToolbarCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2ToolbarCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2ToolbarCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2ToolbarCustomization : BTThreeDSecureV2BaseCustomization
+ +
+
+

Toolbar customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + backgroundColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var backgroundColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + headerText + +
    +
    +
    +
    +
    +
    +

    Text for the header.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var headerText: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + buttonText + +
    +
    +
    +
    +
    +
    +

    Text for the button. For example, “Cancel”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var buttonText: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTThreeDSecureV2UICustomization.html b/6.0.0-beta4/Classes/BTThreeDSecureV2UICustomization.html new file mode 100644 index 0000000000..edccc2170e --- /dev/null +++ b/6.0.0-beta4/Classes/BTThreeDSecureV2UICustomization.html @@ -0,0 +1,520 @@ + + + + BTThreeDSecureV2UICustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2UICustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2UICustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2UICustomization : NSObject
+ +
+
+

UI customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+ +
+
+
+ + +
+ +

Public Methods +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTURLUtils.html b/6.0.0-beta4/Classes/BTURLUtils.html new file mode 100644 index 0000000000..8242bef391 --- /dev/null +++ b/6.0.0-beta4/Classes/BTURLUtils.html @@ -0,0 +1,435 @@ + + + + BTURLUtils Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTURLUtils Class Reference +

+ +
+ +
+ +
+
+

BTURLUtils

+
+
+ + 
@objc
+public class BTURLUtils : NSObject
+ +
+
+

A helper class for converting URL queries to and from dictionaries

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + queryString(from:) + +
    +
    +
    +
    +
    +
    +

    Converts a key/value dictionary to a valid query string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(queryStringWithDictionary:)
+public static func queryString(from dict: NSDictionary) -> String
    + +
    +
    +
    +

    Return Value

    +

    A URL encoded query string

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + queryParameters(for:) + +
    +
    +
    +
    +
    +
    +

    Extract query parameters from a URL

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(queryParametersForURL:)
+public static func queryParameters(for url: URL) -> [String : String]
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + url + + +
    +

    URL to parse query paramters from

    +
    +
    +
    +
    +

    Return Value

    +

    Query parameters from the URL in a key/value dictionary

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTVenmoAccountNonce.html b/6.0.0-beta4/Classes/BTVenmoAccountNonce.html new file mode 100644 index 0000000000..341b8d2648 --- /dev/null +++ b/6.0.0-beta4/Classes/BTVenmoAccountNonce.html @@ -0,0 +1,535 @@ + + + + BTVenmoAccountNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTVenmoAccountNonce Class Reference +

+ +
+ +
+ +
+
+

BTVenmoAccountNonce

+
+
+ + 
@objcMembers
+public class BTVenmoAccountNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a Venmo Account payment method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    The email associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + externalID + +
    +
    +
    +
    +
    +
    +

    The external ID associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var externalID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The first name associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The last name associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The phone number associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + username + +
    +
    +
    +
    +
    +
    +

    The username associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var username: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTVenmoClient.html b/6.0.0-beta4/Classes/BTVenmoClient.html new file mode 100644 index 0000000000..b1ff8873a1 --- /dev/null +++ b/6.0.0-beta4/Classes/BTVenmoClient.html @@ -0,0 +1,605 @@ + + + + BTVenmoClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTVenmoClient Class Reference +

+ +
+ +
+ +
+
+

BTVenmoClient

+
+
+ + 
@objc
+public class BTVenmoClient : NSObject
+
extension BTVenmoClient: BTAppContextSwitchClient
+ +
+
+

Used to process Venmo payments

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Creates an Apple Pay client

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeWithVenmoRequest:completion:)
+public func tokenize(_ request: BTVenmoRequest, completion: @escaping (BTVenmoAccountNonce?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    A Venmo request.

    +
    +
    + + completion + + +
    +

    This completion will be invoked when app switch is complete or an error occurs. On success, you will receive +an instance of BTVenmoAccountNonce; on failure, an error; on user cancellation, you will receive nil for both parameters.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ request: BTVenmoRequest) async throws -> BTVenmoAccountNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + + +
    +
    +
    +

    Return Value

    +

    On success, you will receive an instance of BTVenmoAccountNonce

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isVenmoAppInstalled() + +
    +
    +
    +
    +
    +
    +

    Returns true if the proper Venmo app is installed and configured correctly, returns false otherwise.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func isVenmoAppInstalled() -> Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Switches to the App Store to download the Venmo application.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func openVenmoAppPageInAppStore()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Classes/BTVenmoRequest.html b/6.0.0-beta4/Classes/BTVenmoRequest.html new file mode 100644 index 0000000000..7163affd5a --- /dev/null +++ b/6.0.0-beta4/Classes/BTVenmoRequest.html @@ -0,0 +1,544 @@ + + + + BTVenmoRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTVenmoRequest Class Reference +

+ +
+ +
+ +
+
+

BTVenmoRequest

+
+
+ + 
@objcMembers
+public class BTVenmoRequest : NSObject
+ +
+
+

A BTVenmoRequest specifies options that contribute to the Venmo flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + profileID + +
    +
    +
    +
    +
    +
    +

    Optional. The Venmo profile ID to be used during payment authorization. Customers will see the business name and logo associated with this Venmo profile, and it may show up in the +Venmo app as a “Connected Merchant”. Venmo profile IDs can be found in the Braintree Control Panel. Leaving this nil will use the default Venmo profile.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var profileID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + vault + +
    +
    +
    +
    +
    +
    +

    Whether to automatically vault the Venmo account on the client. For client-side vaulting, you must initialize BTAPIClient with a client token that was created with a customer ID. +Also, paymentMethodUsage on the BTVenmoRequest must be set to .multiUse.

    + +

    If this property is set to false, you can still vault the Venmo account on your server, provided that paymentMethodUsage is not set to .singleUse. +Defaults to false

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var vault: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodUsage + +
    +
    +
    +
    +
    +
    +

    If set to .multiUse, the Venmo payment will be authorized for future payments and can be vaulted. + If set to .singleUse, the Venmo payment will be authorized for a one-time payment and cannot be vaulted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentMethodUsage: BTVenmoPaymentMethodUsage
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    Optional. The business name that will be displayed in the Venmo app payment approval screen. Only used by merchants onboarded as PayFast channel partners.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var displayName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums.html b/6.0.0-beta4/Enums.html new file mode 100644 index 0000000000..04b1d658e8 --- /dev/null +++ b/6.0.0-beta4/Enums.html @@ -0,0 +1,894 @@ + + + + Enumerations Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Enumerations Reference +

+ +
+ +
+ +
+
+

Enumerations

+

The following enumerations are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + BTCardNetwork + +
    +
    +
    +
    +
    +
    +

    Card type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTCardNetwork : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Integration Types

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTClientMetadataIntegration : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Source of the metadata

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTClientMetadataSource : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLogLevel + +
    +
    +
    +
    +
    +
    +

    Log level used to add formatted string to NSLog

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTLogLevel : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Mandate type for the SEPA Direct Debit request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTSEPADirectDebitMandateType : Int, CustomStringConvertible
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The account type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureAccountType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card add challenge request

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureCardAddChallenge : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    3D Secure requested exemption type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureRequestedExemptionType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The shipping method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureShippingMethod : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Button types that can be customized in 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureV2ButtonType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalRequestIntent + +
    +
    +
    +
    +
    +
    +

    Payment intent.

    +
    +

    Note

    + Must be set to BTPayPalRequestIntentSale for immediate payment, .authorize to authorize a payment for capture later, or .order to create an order. Defaults to .authorize. Only applies to PayPal Checkout. + +
    + +

    Capture payments later reference

    + +

    Create and process orders reference

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalRequestIntent : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The call-to-action in the PayPal Checkout flow.

    +
    +

    Note

    + By default the final button will show the localized word for “Continue” and implies that the final amount billed is not yet known. +Setting the BTPayPalRequest’s userAction to .payNow changes the button text to “Pay Now”, conveying to +the user that billing will take place immediately. + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalRequestUserAction : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalLineItemKind + +
    +
    +
    +
    +
    +
    +

    Use this option to specify whether a line item is a debit (sale) or credit (refund) to the customer.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalLineItemKind : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalLocaleCode + +
    +
    +
    +
    +
    +
    +

    A locale code to use for a transaction.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalLocaleCode : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalPaymentType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalPaymentType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Use this option to specify the PayPal page to display when a user lands on the PayPal site to complete the payment.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalRequestLandingPageType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Usage type for the tokenized Venmo account

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTVenmoPaymentMethodUsage : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTCardNetwork.html b/6.0.0-beta4/Enums/BTCardNetwork.html new file mode 100644 index 0000000000..5702224ab5 --- /dev/null +++ b/6.0.0-beta4/Enums/BTCardNetwork.html @@ -0,0 +1,796 @@ + + + + BTCardNetwork Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCardNetwork Enumeration Reference +

+ +
+ +
+ +
+
+

BTCardNetwork

+
+
+ + 
@objc
+public enum BTCardNetwork : Int
+ +
+
+

Card type

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    +

    Unknown card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unknown
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + AMEX + +
    +
    +
    +
    +
    +
    +

    American Express

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case AMEX
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + dinersClub + +
    +
    +
    +
    +
    +
    +

    Diners Club

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dinersClub
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + discover + +
    +
    +
    +
    +
    +
    +

    Discover

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case discover
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + masterCard + +
    +
    +
    +
    +
    +
    +

    Mastercard

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case masterCard
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + visa + +
    +
    +
    +
    +
    +
    +

    Visa

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case visa
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + JCB + +
    +
    +
    +
    +
    +
    +

    JCB

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case JCB
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + laser + +
    +
    +
    +
    +
    +
    +

    Laser

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case laser
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + maestro + +
    +
    +
    +
    +
    +
    +

    Maestro

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case maestro
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + unionPay + +
    +
    +
    +
    +
    +
    +

    Union Pay

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unionPay
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + hiper + +
    +
    +
    +
    +
    +
    +

    Hiper

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case hiper
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + hipercard + +
    +
    +
    +
    +
    +
    +

    Hipercard

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case hipercard
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + solo + +
    +
    +
    +
    +
    +
    +

    Solo

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case solo
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + switch + +
    +
    +
    +
    +
    +
    +

    Switch

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case `switch`
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ukMaestro + +
    +
    +
    +
    +
    +
    +

    UK Maestro

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ukMaestro
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTClientMetadataIntegration.html b/6.0.0-beta4/Enums/BTClientMetadataIntegration.html new file mode 100644 index 0000000000..5c876658a8 --- /dev/null +++ b/6.0.0-beta4/Enums/BTClientMetadataIntegration.html @@ -0,0 +1,406 @@ + + + + BTClientMetadataIntegration Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTClientMetadataIntegration Enumeration Reference +

+ +
+ +
+ +
+
+

BTClientMetadataIntegration

+
+
+ + 
@objc
+public enum BTClientMetadataIntegration : Int
+ +
+
+

Integration Types

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + custom + +
    +
    +
    +
    +
    +
    +

    Custom

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case custom
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + dropIn + +
    +
    +
    +
    +
    +
    +

    Drop-in

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dropIn
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTClientMetadataSource.html b/6.0.0-beta4/Enums/BTClientMetadataSource.html new file mode 100644 index 0000000000..48b111a1e0 --- /dev/null +++ b/6.0.0-beta4/Enums/BTClientMetadataSource.html @@ -0,0 +1,496 @@ + + + + BTClientMetadataSource Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTClientMetadataSource Enumeration Reference +

+ +
+ +
+ +
+
+

BTClientMetadataSource

+
+
+ + 
@objc
+public enum BTClientMetadataSource : Int
+ +
+
+

Source of the metadata

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    +

    Unknown source

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unknown
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payPalApp + +
    +
    +
    +
    +
    +
    +

    PayPal app

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payPalApp
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payPalBrowser + +
    +
    +
    +
    +
    +
    +

    PayPal browser

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payPalBrowser
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + venmoApp + +
    +
    +
    +
    +
    +
    +

    Venmo app

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case venmoApp
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + form + +
    +
    +
    +
    +
    +
    +

    Form

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case form
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTLogLevel.html b/6.0.0-beta4/Enums/BTLogLevel.html new file mode 100644 index 0000000000..d8846381c9 --- /dev/null +++ b/6.0.0-beta4/Enums/BTLogLevel.html @@ -0,0 +1,496 @@ + + + + BTLogLevel Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLogLevel Enumeration Reference +

+ +
+ +
+ +
+
+

BTLogLevel

+
+
+ + 
@objc
+public enum BTLogLevel : Int
+ +
+
+

Log level used to add formatted string to NSLog

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + critical + +
    +
    +
    +
    +
    +
    +

    Only log critical issues (e.g. irrecoverable errors)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case critical
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + error + +
    +
    +
    +
    +
    +
    +

    Log errors (e.g. expected or recoverable errors)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case error
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + warning + +
    +
    +
    +
    +
    +
    +

    Log warnings (e.g. use of pre-release features)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case warning
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + info + +
    +
    +
    +
    +
    +
    +

    Log basic information (e.g. state changes, network activity)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case info
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + debug + +
    +
    +
    +
    +
    +
    +

    Log debugging statements (anything and everything)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case debug
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTPayPalLineItemKind.html b/6.0.0-beta4/Enums/BTPayPalLineItemKind.html new file mode 100644 index 0000000000..af6ecbecd7 --- /dev/null +++ b/6.0.0-beta4/Enums/BTPayPalLineItemKind.html @@ -0,0 +1,406 @@ + + + + BTPayPalLineItemKind Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalLineItemKind Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalLineItemKind

+
+
+ + 
@objc
+public enum BTPayPalLineItemKind : Int
+ +
+
+

Use this option to specify whether a line item is a debit (sale) or credit (refund) to the customer.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + debit + +
    +
    +
    +
    +
    +
    +

    Debit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case debit
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + credit + +
    +
    +
    +
    +
    +
    +

    Credit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case credit
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTPayPalLocaleCode.html b/6.0.0-beta4/Enums/BTPayPalLocaleCode.html new file mode 100644 index 0000000000..89f3c16c35 --- /dev/null +++ b/6.0.0-beta4/Enums/BTPayPalLocaleCode.html @@ -0,0 +1,1158 @@ + + + + BTPayPalLocaleCode Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalLocaleCode Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalLocaleCode

+
+
+ + 
@objc
+public enum BTPayPalLocaleCode : Int
+ +
+
+

A locale code to use for a transaction.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case none
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + da_DK + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case da_DK
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + de_DE + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case de_DE
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + en_AU + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case en_AU
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + en_GB + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case en_GB
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + en_US + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case en_US
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + es_ES + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case es_ES
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + es_XC + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case es_XC
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + fr_CA + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fr_CA
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + fr_FR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fr_FR
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + fr_XC + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fr_XC
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + id_ID + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case id_ID
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + it_IT + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case it_IT
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ja_JP + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ja_JP
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ko_KR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ko_KR
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + nl_NL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case nl_NL
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + no_NO + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case no_NO
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + pl_PL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pl_PL
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + pt_BR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pt_BR
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + pt_PT + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pt_PT
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ru_RU + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ru_RU
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sv_SE + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case sv_SE
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + th_TH + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case th_TH
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tr_TR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case tr_TR
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + zh_CN + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case zh_CN
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + zh_HK + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case zh_HK
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + zh_TW + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case zh_TW
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + zh_XC + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case zh_XC
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTPayPalPaymentType.html b/6.0.0-beta4/Enums/BTPayPalPaymentType.html new file mode 100644 index 0000000000..8297bcb516 --- /dev/null +++ b/6.0.0-beta4/Enums/BTPayPalPaymentType.html @@ -0,0 +1,405 @@ + + + + BTPayPalPaymentType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalPaymentType Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalPaymentType

+
+
+ + 
@objc
+public enum BTPayPalPaymentType : Int
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + checkout + +
    +
    +
    +
    +
    +
    +

    Checkout

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case checkout
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + vault + +
    +
    +
    +
    +
    +
    +

    Vault

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case vault
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTPayPalRequestIntent.html b/6.0.0-beta4/Enums/BTPayPalRequestIntent.html new file mode 100644 index 0000000000..e2b0e24de6 --- /dev/null +++ b/6.0.0-beta4/Enums/BTPayPalRequestIntent.html @@ -0,0 +1,474 @@ + + + + BTPayPalRequestIntent Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalRequestIntent Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalRequestIntent

+
+
+ + 
@objc
+public enum BTPayPalRequestIntent : Int
+ +
+
+

Payment intent.

+
+

Note

+ Must be set to BTPayPalRequestIntentSale for immediate payment, .authorize to authorize a payment for capture later, or .order to create an order. Defaults to .authorize. Only applies to PayPal Checkout. + +
+ +

Capture payments later reference

+ +

Create and process orders reference

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + authorize + +
    +
    +
    +
    +
    +
    +

    Authorize

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case authorize
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sale + +
    +
    +
    +
    +
    +
    +

    Sale

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case sale
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + order + +
    +
    +
    +
    +
    +
    +

    Order

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case order
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + stringValue + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var stringValue: String { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTPayPalRequestLandingPageType.html b/6.0.0-beta4/Enums/BTPayPalRequestLandingPageType.html new file mode 100644 index 0000000000..a63ea5ba6a --- /dev/null +++ b/6.0.0-beta4/Enums/BTPayPalRequestLandingPageType.html @@ -0,0 +1,436 @@ + + + + BTPayPalRequestLandingPageType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalRequestLandingPageType Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalRequestLandingPageType

+
+
+ + 
@objc
+public enum BTPayPalRequestLandingPageType : Int
+ +
+
+

Use this option to specify the PayPal page to display when a user lands on the PayPal site to complete the payment.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    +

    Default

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case none
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + login + +
    +
    +
    +
    +
    +
    +

    Login

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case login
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billing + +
    +
    +
    +
    +
    +
    +

    Billing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case billing
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTPayPalRequestUserAction.html b/6.0.0-beta4/Enums/BTPayPalRequestUserAction.html new file mode 100644 index 0000000000..b6dc8c8c79 --- /dev/null +++ b/6.0.0-beta4/Enums/BTPayPalRequestUserAction.html @@ -0,0 +1,413 @@ + + + + BTPayPalRequestUserAction Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalRequestUserAction Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalRequestUserAction

+
+
+ + 
@objc
+public enum BTPayPalRequestUserAction : Int
+ +
+
+

The call-to-action in the PayPal Checkout flow.

+
+

Note

+ By default the final button will show the localized word for “Continue” and implies that the final amount billed is not yet known. +Setting the BTPayPalRequest’s userAction to .payNow changes the button text to “Pay Now”, conveying to +the user that billing will take place immediately. + +
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    +

    Default

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case none
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payNow + +
    +
    +
    +
    +
    +
    +

    Pay Now

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payNow
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTSEPADirectDebitMandateType.html b/6.0.0-beta4/Enums/BTSEPADirectDebitMandateType.html new file mode 100644 index 0000000000..2a08ee7794 --- /dev/null +++ b/6.0.0-beta4/Enums/BTSEPADirectDebitMandateType.html @@ -0,0 +1,433 @@ + + + + BTSEPADirectDebitMandateType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTSEPADirectDebitMandateType Enumeration Reference +

+ +
+ +
+ +
+
+

BTSEPADirectDebitMandateType

+
+
+ + 
@objc
+public enum BTSEPADirectDebitMandateType : Int, CustomStringConvertible
+ +
+
+

Mandate type for the SEPA Direct Debit request.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + oneOff + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case oneOff
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + recurrent + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case recurrent
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var description: String { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTThreeDSecureAccountType.html b/6.0.0-beta4/Enums/BTThreeDSecureAccountType.html new file mode 100644 index 0000000000..4bcfa584d7 --- /dev/null +++ b/6.0.0-beta4/Enums/BTThreeDSecureAccountType.html @@ -0,0 +1,436 @@ + + + + BTThreeDSecureAccountType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureAccountType Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureAccountType

+
+
+ + 
@objc
+public enum BTThreeDSecureAccountType : Int
+ +
+
+

The account type

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unspecified + +
    +
    +
    +
    +
    +
    +

    Unspecified

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unspecified
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + credit + +
    +
    +
    +
    +
    +
    +

    Credit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case credit
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + debit + +
    +
    +
    +
    +
    +
    +

    Debit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case debit
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTThreeDSecureCardAddChallenge.html b/6.0.0-beta4/Enums/BTThreeDSecureCardAddChallenge.html new file mode 100644 index 0000000000..15be0b2557 --- /dev/null +++ b/6.0.0-beta4/Enums/BTThreeDSecureCardAddChallenge.html @@ -0,0 +1,436 @@ + + + + BTThreeDSecureCardAddChallenge Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureCardAddChallenge Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureCardAddChallenge

+
+
+ + 
@objc
+public enum BTThreeDSecureCardAddChallenge : Int
+ +
+
+

The card add challenge request

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unspecified + +
    +
    +
    +
    +
    +
    +

    Unspecified

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unspecified
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + requested + +
    +
    +
    +
    +
    +
    +

    Requested

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case requested
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + notRequested + +
    +
    +
    +
    +
    +
    +

    Not Requested

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case notRequested
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTThreeDSecureRequestedExemptionType.html b/6.0.0-beta4/Enums/BTThreeDSecureRequestedExemptionType.html new file mode 100644 index 0000000000..2a947502a0 --- /dev/null +++ b/6.0.0-beta4/Enums/BTThreeDSecureRequestedExemptionType.html @@ -0,0 +1,496 @@ + + + + BTThreeDSecureRequestedExemptionType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureRequestedExemptionType Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureRequestedExemptionType

+
+
+ + 
@objc
+public enum BTThreeDSecureRequestedExemptionType : Int
+ +
+
+

3D Secure requested exemption type

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unspecified + +
    +
    +
    +
    +
    +
    +

    Unspecified

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unspecified
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lowValue + +
    +
    +
    +
    +
    +
    +

    Low value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lowValue
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + secureCorporate + +
    +
    +
    +
    +
    +
    +

    Secure corporate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case secureCorporate
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + trustedBeneficiary + +
    +
    +
    +
    +
    +
    +

    Trusted beneficiary

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case trustedBeneficiary
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Transaction risk analysis

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transactionRiskAnalysis
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTThreeDSecureShippingMethod.html b/6.0.0-beta4/Enums/BTThreeDSecureShippingMethod.html new file mode 100644 index 0000000000..9e4e133d00 --- /dev/null +++ b/6.0.0-beta4/Enums/BTThreeDSecureShippingMethod.html @@ -0,0 +1,556 @@ + + + + BTThreeDSecureShippingMethod Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureShippingMethod Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureShippingMethod

+
+
+ + 
@objc
+public enum BTThreeDSecureShippingMethod : Int
+ +
+
+

The shipping method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unspecified + +
    +
    +
    +
    +
    +
    +

    Unspecified

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unspecified
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sameDay + +
    +
    +
    +
    +
    +
    +

    Same Day

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case sameDay
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expedited + +
    +
    +
    +
    +
    +
    +

    Expedited

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expedited
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + priority + +
    +
    +
    +
    +
    +
    +

    Priority

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case priority
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ground + +
    +
    +
    +
    +
    +
    +

    Ground

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ground
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + electronicDelivery + +
    +
    +
    +
    +
    +
    +

    Electronic Delivery

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case electronicDelivery
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shipToStore + +
    +
    +
    +
    +
    +
    +

    Ship to Store

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case shipToStore
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTThreeDSecureV2ButtonType.html b/6.0.0-beta4/Enums/BTThreeDSecureV2ButtonType.html new file mode 100644 index 0000000000..3affd0ef1d --- /dev/null +++ b/6.0.0-beta4/Enums/BTThreeDSecureV2ButtonType.html @@ -0,0 +1,496 @@ + + + + BTThreeDSecureV2ButtonType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2ButtonType Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2ButtonType

+
+
+ + 
@objc
+public enum BTThreeDSecureV2ButtonType : Int
+ +
+
+

Button types that can be customized in 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + verify + +
    +
    +
    +
    +
    +
    +

    Verify button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verify
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + continue + +
    +
    +
    +
    +
    +
    +

    Continue button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case `continue`
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + next + +
    +
    +
    +
    +
    +
    +

    Next button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case next
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cancel + +
    +
    +
    +
    +
    +
    +

    Cancel button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cancel
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + resend + +
    +
    +
    +
    +
    +
    +

    Resend button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case resend
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Enums/BTVenmoPaymentMethodUsage.html b/6.0.0-beta4/Enums/BTVenmoPaymentMethodUsage.html new file mode 100644 index 0000000000..77aa72b55a --- /dev/null +++ b/6.0.0-beta4/Enums/BTVenmoPaymentMethodUsage.html @@ -0,0 +1,406 @@ + + + + BTVenmoPaymentMethodUsage Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTVenmoPaymentMethodUsage Enumeration Reference +

+ +
+ +
+ +
+
+

BTVenmoPaymentMethodUsage

+
+
+ + 
@objc
+public enum BTVenmoPaymentMethodUsage : Int
+ +
+
+

Usage type for the tokenized Venmo account

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + multiUse + +
    +
    +
    +
    +
    +
    +

    The Venmo payment will be authorized for future payments and can be vaulted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case multiUse
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + singleUse + +
    +
    +
    +
    +
    +
    +

    The Venmo payment will be authorized for a one-time payment and cannot be vaulted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case singleUse
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Extensions.html b/6.0.0-beta4/Extensions.html new file mode 100644 index 0000000000..a8dd0e2f11 --- /dev/null +++ b/6.0.0-beta4/Extensions.html @@ -0,0 +1,374 @@ + + + + Extensions Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Extensions Reference +

+ +
+ +
+ +
+
+

Extensions

+

The following extensions are available globally.

+ +
+
+ +
+
+
+
+ + +
+ +

CardinalValidationDelegate Protocol Conformance +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Extensions/BTThreeDSecureV2Provider.html b/6.0.0-beta4/Extensions/BTThreeDSecureV2Provider.html new file mode 100644 index 0000000000..900332fd47 --- /dev/null +++ b/6.0.0-beta4/Extensions/BTThreeDSecureV2Provider.html @@ -0,0 +1,377 @@ + + + + BTThreeDSecureV2Provider Extension Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2Provider Extension Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2Provider

+
+
+ + 
extension BTThreeDSecureV2Provider: CardinalValidationDelegate
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Protocols.html b/6.0.0-beta4/Protocols.html new file mode 100644 index 0000000000..d45bb4552c --- /dev/null +++ b/6.0.0-beta4/Protocols.html @@ -0,0 +1,398 @@ + + + + Protocols Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Protocols Reference +

+ +
+ +
+ +
+
+

Protocols

+

The following protocols are available globally.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Protocols/BTLocalPaymentRequestDelegate.html b/6.0.0-beta4/Protocols/BTLocalPaymentRequestDelegate.html new file mode 100644 index 0000000000..5ac0180daa --- /dev/null +++ b/6.0.0-beta4/Protocols/BTLocalPaymentRequestDelegate.html @@ -0,0 +1,378 @@ + + + + BTLocalPaymentRequestDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLocalPaymentRequestDelegate Protocol Reference +

+ +
+ +
+ +
+
+

BTLocalPaymentRequestDelegate

+
+
+ + 
@objc
+public protocol BTLocalPaymentRequestDelegate
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Required delegate method which returns the payment ID before the flow starts.

    + +

    Use this to do any preprocessing and setup for webhooks. Use the start() callback to continue the flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+func localPaymentStarted(_ request: BTLocalPaymentRequest, paymentID: String, start: @escaping () -> Void)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/Protocols/BTThreeDSecureRequestDelegate.html b/6.0.0-beta4/Protocols/BTThreeDSecureRequestDelegate.html new file mode 100644 index 0000000000..bfc1c6d90a --- /dev/null +++ b/6.0.0-beta4/Protocols/BTThreeDSecureRequestDelegate.html @@ -0,0 +1,378 @@ + + + + BTThreeDSecureRequestDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureRequestDelegate Protocol Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureRequestDelegate

+
+
+ + 
@objc
+public protocol BTThreeDSecureRequestDelegate
+ +
+
+

Protocol for ThreeDSecure Request flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Required delegate method which returns the ThreeDSecure lookup result before the flow continues. + Use this to do any UI preparation or custom lookup result handling. Use the next() callback to continue the flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+func onLookupComplete(_ request: BTThreeDSecureRequest, lookupResult: BTThreeDSecureResult, next: @escaping () -> Void)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/badge.svg b/6.0.0-beta4/badge.svg new file mode 100644 index 0000000000..a096feca83 --- /dev/null +++ b/6.0.0-beta4/badge.svg @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + documentation + + + documentation + + + 100% + + + 100% + + + diff --git a/6.0.0-beta4/css/highlight.css b/6.0.0-beta4/css/highlight.css new file mode 100644 index 0000000000..c170357ce7 --- /dev/null +++ b/6.0.0-beta4/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/6.0.0-beta4/css/jazzy.css b/6.0.0-beta4/css/jazzy.css new file mode 100644 index 0000000000..c7bb9fe22f --- /dev/null +++ b/6.0.0-beta4/css/jazzy.css @@ -0,0 +1,404 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +*, *:before, *:after { + box-sizing: inherit; } + +body { + margin: 0; + background: #fff; + color: #333; + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + letter-spacing: .2px; + -webkit-font-smoothing: antialiased; + box-sizing: border-box; } + +h1 { + font-size: 2rem; + font-weight: 700; + margin: 1.275em 0 0.6em; } + +h2 { + font-size: 1.75rem; + font-weight: 700; + margin: 1.275em 0 0.3em; } + +h3 { + font-size: 1.5rem; + font-weight: 700; + margin: 1em 0 0.3em; } + +h4 { + font-size: 1.25rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h5 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h6 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; + color: #777; } + +p { + margin: 0 0 1em; } + +ul, ol { + padding: 0 0 0 2em; + margin: 0 0 0.85em; } + +blockquote { + margin: 0 0 0.85em; + padding: 0 15px; + color: #858585; + border-left: 4px solid #e5e5e5; } + +img { + max-width: 100%; } + +a { + color: #4183c4; + text-decoration: none; } + a:hover, a:focus { + outline: 0; + text-decoration: underline; } + a.discouraged { + text-decoration: line-through; } + a.discouraged:hover, a.discouraged:focus { + text-decoration: underline line-through; } + +table { + background: #fff; + width: 100%; + border-collapse: collapse; + border-spacing: 0; + overflow: auto; + margin: 0 0 0.85em; } + +tr:nth-child(2n) { + background-color: #fbfbfb; } + +th, td { + padding: 6px 13px; + border: 1px solid #ddd; } + +hr { + height: 1px; + border: none; + background-color: #ddd; } + +pre { + margin: 0 0 1.275em; + padding: .85em 1em; + overflow: auto; + background: #f7f7f7; + font-size: .85em; + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +code { + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +.item-container p > code, .item-container li > code, .top-matter p > code, .top-matter li > code { + background: #f7f7f7; + padding: .2em; } + .item-container p > code:before, .item-container p > code:after, .item-container li > code:before, .item-container li > code:after, .top-matter p > code:before, .top-matter p > code:after, .top-matter li > code:before, .top-matter li > code:after { + letter-spacing: -.2em; + content: "\00a0"; } + +pre code { + padding: 0; + white-space: pre; } + +.content-wrapper { + display: flex; + flex-direction: column; } + @media (min-width: 768px) { + .content-wrapper { + flex-direction: row; } } +.header { + display: flex; + padding: 8px; + font-size: 0.875em; + background: #444; + color: #999; } + +.header-col { + margin: 0; + padding: 0 8px; } + +.header-col--primary { + flex: 1; } + +.header-link { + color: #fff; } + +.header-icon { + padding-right: 2px; + vertical-align: -3px; + height: 16px; } + +.breadcrumbs { + font-size: 0.875em; + padding: 8px 16px; + margin: 0; + background: #fbfbfb; + border-bottom: 1px solid #ddd; } + +.carat { + height: 10px; + margin: 0 5px; } + +.navigation { + order: 2; } + @media (min-width: 768px) { + .navigation { + order: 1; + width: 25%; + max-width: 300px; + padding-bottom: 64px; + overflow: hidden; + word-wrap: normal; + background: #fbfbfb; + border-right: 1px solid #ddd; } } +.nav-groups { + list-style-type: none; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #ddd; + padding: 8px 0 8px 16px; } + +.nav-group-name-link { + color: #333; } + +.nav-group-tasks { + margin: 8px 0; + padding: 0 0 0 8px; } + +.nav-group-task { + font-size: 1em; + list-style-type: none; + white-space: nowrap; } + +.nav-group-task-link { + color: #808080; } + +.main-content { + order: 1; } + @media (min-width: 768px) { + .main-content { + order: 2; + flex: 1; + padding-bottom: 60px; } } +.section { + padding: 0 32px; + border-bottom: 1px solid #ddd; } + +.section-content { + max-width: 834px; + margin: 0 auto; + padding: 16px 0; } + +.section-name { + color: #666; + display: block; } + .section-name p { + margin-bottom: inherit; } + +.declaration .highlight { + overflow-x: initial; + padding: 8px 0; + margin: 0; + background-color: transparent; + border: none; } + +.task-group-section { + border-top: 1px solid #ddd; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; } + +.section-name-container { + position: relative; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item-container { + padding: 0; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 20px; + font-size: 1rem; } + .item .declaration-note { + font-size: .85em; + color: #808080; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #ddd; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + left: 21px; + top: 7px; + display: block; + position: absolute; + width: 12px; + height: 12px; + border-left: 1px solid #ddd; + border-top: 1px solid #ddd; + background: #fff; + transform: rotate(45deg); } + +.height-container { + display: none; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #fff; + border: 1px solid #ddd; + border-top-width: 0; + padding-top: 10px; + padding-bottom: 5px; + padding: 8px 16px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4183c4; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #ddd; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +.footer { + padding: 8px 16px; + background: #444; + color: #ddd; + font-size: 0.8em; } + .footer p { + margin: 8px 0; } + .footer a { + color: #fff; } + +html.dash .header, html.dash .breadcrumbs, html.dash .navigation { + display: none; } + +html.dash .height-container { + display: block; } + +form[role=search] input { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + line-height: 24px; + padding: 0 10px; + margin: 0; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + +form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fbfbfb; + color: #333; + border: 1px solid #ddd; } + +form[role=search] .tt-highlight { + font-weight: bold; } + +form[role=search] .tt-suggestion { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + +form[role=search] .tt-suggestion:hover, +form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + +form[role=search] .tt-suggestion:hover .doc-parent-name, +form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Info.plist b/6.0.0-beta4/docsets/Braintree.docset/Contents/Info.plist new file mode 100644 index 0000000000..3d44f43bfe --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Info.plist @@ -0,0 +1,20 @@ + + + + + CFBundleIdentifier + com.jazzy.braintree + CFBundleName + Braintree + DocSetPlatformFamily + braintree + isDashDocset + + dashIndexFilePath + index.html + isJavaScriptEnabled + + DashDocSetFamily + dashtoc + + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes.html new file mode 100644 index 0000000000..95bdbcd4d5 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes.html @@ -0,0 +1,2268 @@ + + + + Classes Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Classes Reference +

+ +
+ +
+ +
+
+

Classes

+

The following classes are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + BTAPIClient + +
    +
    +
    +
    +
    +
    +

    This class acts as the entry point for accessing the Braintree APIs via common HTTP methods performed on API endpoints.

    +
    +

    Note

    + It also manages authentication via tokenization key and provides access to a merchant’s gateway configuration. + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAPIClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    THIS CODE IS GENERATED BY codify_certificates.swift +in Braintree Github Enterprise repo braintree-ios-certificate-generation.

    + +

    Encapsulates our trusted x509 Certificates for Secure SSL Communication with Braintree’s servers +to avoid storing certificate files in an NSBundle.

    + +

    Do not update this file directly. If new certificates are needed, update the certificates directory +in braintree-ios-certificate-generation and re-run the certificate generation script.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAPIPinnedCertificates : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTAppContextSwitcher + +
    +
    +
    +
    +
    +
    +

    Handles return URLs when returning from app context switch and routes the return URL to the correct app context switch client class.

    +
    +

    Note

    + returnURLScheme must contain your app’s registered URL Type that starts with the app’s bundle ID. +When your app returns from app switch, the app delegate should call handleOpenURL (or handleOpen if not using SceneDelegate) + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAppContextSwitcher : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTBinData + +
    +
    +
    +
    +
    +
    +

    Contains the bin data associated with a payment method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTBinData : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTClientMetadata + +
    +
    +
    +
    +
    +
    +

    Represents the metadata associated with a session for posting along with payment data during tokenization.

    + +

    When a payment method is tokenized, the client api accepts parameters under +_meta which are used to determine where payment data originated.

    + +

    In general, this data may evolve and be used in different ways by different +integrations in a single app. For example, if both Apple Pay and drop in are +used. In this case, the source and integration may change over time, while +the sessionID should remain constant. To achieve this, users of this class +should use mutableCopy to create a new copy based on the existing session +and then update the object as needed.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTClientMetadata : NSObject, NSMutableCopying
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTClientToken + +
    +
    +
    +
    +
    +
    +

    An authorization string used to initialize the Braintree SDK

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTClientToken : NSObject, NSCoding, NSCopying
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTConfiguration + +
    +
    +
    +
    +
    +
    +

    Contains information specific to a merchant’s Braintree integration

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTConfiguration : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTJSON + +
    +
    +
    +
    +
    +
    +

    A type-safe wrapper around JSON +@see http://www.json.org/

    + +

    The primary goal of this class is to two-fold: (1) prevent bugs by staying true to JSON (json.org) +rather than interpreting it in mysterious ways; (2) prevent bugs by making JSON interpretation +as un-surprising as possible.

    + +

    Most notably, type casting occurs via the as* nullable methods; errors are deferred and can be checked explicitly using isError and asError.

    +

    Example Data:

    +
       {
+     "foo": "bar",
+     "baz": [1, 2, 3]
+   }
+
    +

    Example Usage:

    +
       let json : BTJSON = BTJSON(data:data);
+   json.isError  // false
+   json.isObject // true
+   json.isNumber // false
+   json.asObject // self
+   json["foo"]   // JSON(@"bar")
+   json["foo"].isString // true
+   json["foo"].asString // @"bar"
+   json["baz"].asString // null
+   json["baz"]["quux"].isError // true
+   json["baz"]["quux"].asError // NSError(domain: BTJSONErrorDomain, code: BTJSONErrorCodeTypeInvalid)
+   json["baz"][0].asError // null
+   json["baz"][0].asInteger //
+   json["random"]["nested"]["things"][3].isError // true
+
+   let json : BTJSON = BTJSON() // json.asJson => {}
+   json["foo"][0] = "bar" // json.asJSON => { "foo": ["bar"] }
+   json["baz"] = [ 1, 2, 3 ] // json.asJSON => { "foo": ["bar"], "baz": [1,2,3] }
+   json["quux"] = NSSet() // json.isError => true, json.asJSON => throws NSError(domain: BTJSONErrorDomain, code: BTJSONErrorInvalidData)
+
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTJSON : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLogLevelDescription + +
    +
    +
    +
    +
    +
    +

    Wrapper for accessing the string value of the log level

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTLogLevelDescription : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Required for Objective-C compatibility. Necessary behavior is provided by the swift version.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTMutableClientMetadata : BTClientMetadata
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPaymentMethodNonce + +
    +
    +
    +
    +
    +
    +

    BTPaymentMethodNonce is for generic tokenized payment information.

    + +

    For example, if a customer’s vaulted payment methods contains a type that’s not recognized or supported by the +Braintree SDK or the client-side integration (e.g. the vault contains a PayPal account but the client-side +integration does not include the PayPal component), this type can act as a fallback.

    + +

    The payment method nonce is a public token that acts as a placeholder for sensitive payments data that +has been uploaded to Braintree for subsequent processing. The nonce is safe to access on the client and can be +used on your server to reference the data in Braintree operations, such as Transaction.sale.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+open class BTPaymentMethodNonce : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A JSON parser that parses BTJSON into concrete BTPaymentMethodNonce objects. It supports registration of parsers at runtime.

    + +

    BTPaymentMethodNonceParser provides access to JSON parsing for different payment options +without introducing compile-time dependencies on payment option frameworks and their symbols.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPaymentMethodNonceParser : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPostalAddress + +
    +
    +
    +
    +
    +
    +

    Generic postal address

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPostalAddress : NSObject, NSCopying
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTURLUtils + +
    +
    +
    +
    +
    +
    +

    A helper class for converting URL queries to and from dictionaries

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTURLUtils : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains information about a PayPal payment method.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalNativeCheckoutAccountNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Client used to collect PayPal payment methods. If possible, this client will present a native flow; otherwise, it will fall back to a web flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTPayPalNativeCheckoutClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Options for the PayPal Checkout flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalNativeCheckoutRequest : BTPayPalCheckoutRequest
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Options for the PayPal Vault flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalNativeVaultRequest : BTPayPalVaultRequest
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Used to integrate with SEPA Direct Debit.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTSEPADirectDebitClient : BTWebAuthenticationSessionClient
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A payment method nonce representing a SEPA Direct Debit payment.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTSEPADirectDebitNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Parameters for creating a SEPA Direct Debit tokenization request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTSEPADirectDebitRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    BTAmericanExpressClient enables you to look up the rewards balance of American Express cards.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTAmericanExpressClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains information about an American Express rewards balance.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAmericanExpressRewardsBalance : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTDataCollector + +
    +
    +
    +
    +
    +
    +

    Braintree’s advanced fraud protection solution.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTDataCollector : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTApplePayCardNonce + +
    +
    +
    +
    +
    +
    +

    Contains information about a tokenized Apple Pay card.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTApplePayCardNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTApplePayClient + +
    +
    +
    +
    +
    +
    +

    Used to process Apple Pay payments

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTApplePayClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLocalPaymentClient + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTLocalPaymentClient : BTWebAuthenticationSessionClient
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLocalPaymentRequest + +
    +
    +
    +
    +
    +
    +

    Used to initialize a local payment flow

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTLocalPaymentRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLocalPaymentResult + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTLocalPaymentResult : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Additional information for a 3DS lookup. Used in 3DS 2.0+ flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureAdditionalInformation : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureClient + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureLookup + +
    +
    +
    +
    +
    +
    +

    The result of a 3DS lookup. +Contains liability shift and challenge information.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureLookup : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Postal address for 3D Secure flows

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecurePostalAddress : NSObject
    +
    extension BTThreeDSecurePostalAddress: NSCopying
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureRequest + +
    +
    +
    +
    +
    +
    +

    Used to initialize a 3D Secure payment flow

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureResult + +
    +
    +
    +
    +
    +
    +

    The result of a 3D Secure payment flow

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureResult : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Base customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2BaseCustomization : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Button customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2ButtonCustomization : BTThreeDSecureV2BaseCustomization
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Label customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2LabelCustomization : BTThreeDSecureV2BaseCustomization
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Text box customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2TextBoxCustomization : BTThreeDSecureV2BaseCustomization
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Toolbar customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2ToolbarCustomization : BTThreeDSecureV2BaseCustomization
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    UI customization options for 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureV2UICustomization : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Information pertaining to the regulatory environment for a credit card if authentication insight is requested during tokenization.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTAuthenticationInsight : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTCard + +
    +
    +
    +
    +
    +
    +

    The card tokenization request represents raw credit or debit card data provided by the customer. +Its main purpose is to serve as the input for tokenization.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTCard : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTCardClient + +
    +
    +
    +
    +
    +
    +

    Used to process cards

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTCardClient : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTCardNonce + +
    +
    +
    +
    +
    +
    +

    Contains information about a tokenized card.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTCardNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTCardRequest + +
    +
    +
    +
    +
    +
    +

    Contains information about a card to tokenize

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTCardRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTThreeDSecureInfo + +
    +
    +
    +
    +
    +
    +

    Contains information about the 3D Secure status of a payment method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTThreeDSecureInfo : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalAccountNonce + +
    +
    +
    +
    +
    +
    +

    Contains information about a PayPal payment method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalAccountNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Options for the PayPal Checkout flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+open class BTPayPalCheckoutRequest : BTPayPalRequest
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalClient + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTPayPalClient : BTWebAuthenticationSessionClient
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains information about a PayPal credit financing option

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalCreditFinancing : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Contains information about a PayPal credit amount

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalCreditFinancingAmount : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalLineItem + +
    +
    +
    +
    +
    +
    +

    A PayPal line item to be displayed in the PayPal checkout flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTPayPalLineItem : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalRequest + +
    +
    +
    +
    +
    +
    +

    Base options for PayPal Checkout and PayPal Vault flows.

    +
    +

    Note

    + Do not instantiate this class directly. Instead, use BTPayPalCheckoutRequest or BTPayPalVaultRequest. + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+open class BTPayPalRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalVaultRequest + +
    +
    +
    +
    +
    +
    +

    Options for the PayPal Vault flow.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+open class BTPayPalVaultRequest : BTPayPalRequest
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTVenmoAccountNonce + +
    +
    +
    +
    +
    +
    +

    Contains information about a Venmo Account payment method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTVenmoAccountNonce : BTPaymentMethodNonce
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTVenmoClient + +
    +
    +
    +
    +
    +
    +

    Used to process Venmo payments

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public class BTVenmoClient : NSObject
    +
    extension BTVenmoClient: BTAppContextSwitchClient
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTVenmoRequest + +
    +
    +
    +
    +
    +
    +

    A BTVenmoRequest specifies options that contribute to the Venmo flow

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objcMembers
+public class BTVenmoRequest : NSObject
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAPIClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAPIClient.html new file mode 100644 index 0000000000..a34905ab3e --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAPIClient.html @@ -0,0 +1,699 @@ + + + + BTAPIClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAPIClient Class Reference +

+ +
+ +
+ +
+
+

BTAPIClient

+
+
+ + 
@objcMembers
+public class BTAPIClient : NSObject
+ +
+
+

This class acts as the entry point for accessing the Braintree APIs via common HTTP methods performed on API endpoints.

+
+

Note

+ It also manages authentication via tokenization key and provides access to a merchant’s gateway configuration. + +
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + RequestCompletion + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public typealias RequestCompletion = (BTJSON?, HTTPURLResponse?, Error?) -> Void
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + tokenizationKey + +
    +
    +
    +
    +
    +
    +

    The tokenization key used to authorize the APIClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var tokenizationKey: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + clientToken + +
    +
    +
    +
    +
    +
    +

    The client token used to authorize the APIClient

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var clientToken: BTClientToken?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + metadata + +
    +
    +
    +
    +
    +
    +

    Client metadata that is used for tracking the client session

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public private(set) var metadata: BTClientMetadata { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializers +

+
+
+
    +
  • +
    + + + + init(authorization:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new API client.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAuthorization:)
+public convenience init?(authorization: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + authorization + + +
    +

    Your tokenization key, client token, or PayPal ID Token. Passing an invalid value may return nil.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Provides configuration data as a BTJSON object.

    + +

    The configuration data can be used by supported payment options to configure themselves + dynamically through the Control Panel. It also contains configuration options for the Braintree SDK Core components.

    +
    +

    Note

    + This method is asynchronous because it requires a network call to fetch the +configuration for a merchant account from Braintree servers. This configuration is +cached on subsequent calls for better performance. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func fetchOrReturnRemoteConfiguration(_ completion: @escaping (BTConfiguration?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    Callback that returns either a BTConfiguration or Error

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Fetches a customer’s vaulted payment method nonces. +Must be using client token with a customer ID specified.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func fetchPaymentMethodNonces(_ completion: @escaping ([BTPaymentMethodNonce]?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    Callback that returns either an array of payment method nonces or an error

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Fetches a customer’s vaulted payment method nonces. +Must be using client token with a customer ID specified.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func fetchPaymentMethodNonces(_ defaultFirst: Bool, completion: @escaping ([BTPaymentMethodNonce]?, Error?) -> Void)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAPIPinnedCertificates.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAPIPinnedCertificates.html new file mode 100644 index 0000000000..d8b4c09174 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAPIPinnedCertificates.html @@ -0,0 +1,382 @@ + + + + BTAPIPinnedCertificates Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAPIPinnedCertificates Class Reference +

+ +
+ +
+ +
+
+

BTAPIPinnedCertificates

+
+
+ + 
@objcMembers
+public class BTAPIPinnedCertificates : NSObject
+ +
+
+

THIS CODE IS GENERATED BY codify_certificates.swift +in Braintree Github Enterprise repo braintree-ios-certificate-generation.

+ +

Encapsulates our trusted x509 Certificates for Secure SSL Communication with Braintree’s servers +to avoid storing certificate files in an NSBundle.

+ +

Do not update this file directly. If new certificates are needed, update the certificates directory +in braintree-ios-certificate-generation and re-run the certificate generation script.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAmericanExpressClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAmericanExpressClient.html new file mode 100644 index 0000000000..03405bb3fa --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAmericanExpressClient.html @@ -0,0 +1,469 @@ + + + + BTAmericanExpressClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAmericanExpressClient Class Reference +

+ +
+ +
+ +
+
+

BTAmericanExpressClient

+
+
+ + 
@objc
+public class BTAmericanExpressClient : NSObject
+ +
+
+

BTAmericanExpressClient enables you to look up the rewards balance of American Express cards.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAmericanExpressRewardsBalance.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAmericanExpressRewardsBalance.html new file mode 100644 index 0000000000..ac8a088596 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAmericanExpressRewardsBalance.html @@ -0,0 +1,586 @@ + + + + BTAmericanExpressRewardsBalance Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAmericanExpressRewardsBalance Class Reference +

+ +
+ +
+ +
+
+

BTAmericanExpressRewardsBalance

+
+
+ + 
@objcMembers
+public class BTAmericanExpressRewardsBalance : NSObject
+ +
+
+

Contains information about an American Express rewards balance.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + errorCode + +
    +
    +
    +
    +
    +
    +

    Optional. An error code when there was an issue fetching the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var errorCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + errorMessage + +
    +
    +
    +
    +
    +
    +

    Optional. An error message when there was an issue fetching the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var errorMessage: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + conversionRate + +
    +
    +
    +
    +
    +
    +

    Optional. The conversion rate associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var conversionRate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + currencyAmount + +
    +
    +
    +
    +
    +
    +

    Optional. The currency amount associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currencyAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + currencyIsoCode + +
    +
    +
    +
    +
    +
    +

    Optional. The currency ISO code associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currencyIsoCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + requestID + +
    +
    +
    +
    +
    +
    +

    Optional. The request ID used when fetching the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var requestID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + rewardsAmount + +
    +
    +
    +
    +
    +
    +

    Optional. The rewards amount associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var rewardsAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + rewardsUnit + +
    +
    +
    +
    +
    +
    +

    Optional. The rewards unit associated with the rewards balance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var rewardsUnit: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAppContextSwitcher.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAppContextSwitcher.html new file mode 100644 index 0000000000..127baaff5f --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAppContextSwitcher.html @@ -0,0 +1,463 @@ + + + + BTAppContextSwitcher Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAppContextSwitcher Class Reference +

+ +
+ +
+ +
+
+

BTAppContextSwitcher

+
+
+ + 
@objcMembers
+public class BTAppContextSwitcher : NSObject
+ +
+
+

Handles return URLs when returning from app context switch and routes the return URL to the correct app context switch client class.

+
+

Note

+ returnURLScheme must contain your app’s registered URL Type that starts with the app’s bundle ID. +When your app returns from app switch, the app delegate should call handleOpenURL (or handleOpen if not using SceneDelegate) + +
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + sharedInstance + +
    +
    +
    +
    +
    +
    +

    Singleton for shared instance of BTAppContextSwitcher

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public static let sharedInstance: BTAppContextSwitcher
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + returnURLScheme + +
    +
    +
    +
    +
    +
    +

    The URL scheme to return to this app after switching to another app or opening a SFSafariViewController. +This URL scheme must be registered as a URL Type in the app’s info.plist, and it must start with the app’s bundle ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var returnURLScheme: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + register(_:) + +
    +
    +
    +
    +
    +
    +

    Registers a class Type that can handle a return from app context switch with a static method.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(registerAppContextSwitchClient:)
+public func register(_ client: BTAppContextSwitchClient.Type)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + client + + +
    +

    A class Type that implements BTAppContextSwitchClient, the methods of which will be invoked statically on the class.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTApplePayCardNonce.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTApplePayCardNonce.html new file mode 100644 index 0000000000..bb8869a4f9 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTApplePayCardNonce.html @@ -0,0 +1,376 @@ + + + + BTApplePayCardNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTApplePayCardNonce Class Reference +

+ +
+ +
+ +
+
+

BTApplePayCardNonce

+
+
+ + 
@objcMembers
+public class BTApplePayCardNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a tokenized Apple Pay card.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + binData + +
    +
    +
    +
    +
    +
    +

    The BIN data for the card number associated with this nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let binData: BTBinData
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTApplePayClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTApplePayClient.html new file mode 100644 index 0000000000..853a4c7556 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTApplePayClient.html @@ -0,0 +1,636 @@ + + + + BTApplePayClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTApplePayClient Class Reference +

+ +
+ +
+ +
+
+

BTApplePayClient

+
+
+ + 
@objc
+public class BTApplePayClient : NSObject
+ +
+
+

Used to process Apple Pay payments

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Creates an Apple Pay client

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Creates a PKPaymentRequest with values from your Braintree Apple Pay configuration. +It populates the following values of PKPaymentRequest: countryCode, currencyCode, merchantIdentifier, supportedNetworks.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(makePaymentRequest:)
+public func makePaymentRequest(completion: @escaping (PKPaymentRequest?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    A completion block that returns the payment request or an error.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + makePaymentRequest() + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Creates a PKPaymentRequest with values from your Braintree Apple Pay configuration. +It populates the following values of PKPaymentRequest: countryCode, currencyCode, merchantIdentifier, supportedNetworks.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func makePaymentRequest() async throws -> PKPaymentRequest
    + +
    +
    +
    +

    Return Value

    +

    A PKPaymentRequest

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Tokenizes an Apple Pay payment.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeApplePayPayment:completion:)
+public func tokenize(_ payment: PKPayment, completion: @escaping (BTApplePayCardNonce?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + payment + + +
    +

    A PKPayment instance, typically obtained by presenting a PKPaymentAuthorizationViewController

    +
    +
    + + completion + + +
    +

    A completion block that is invoked when tokenization has completed. If tokenization succeeds, we will return a BTApplePayCardNonce +and error will be nil; if it fails, BTApplePayCardNonce will be nil and error will describe the failure.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Tokenizes an Apple Pay payment.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ payment: PKPayment) async throws -> BTApplePayCardNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + payment + + +
    +

    A PKPayment instance, typically obtained by presenting a PKPaymentAuthorizationViewController

    +
    +
    +
    +
    +

    Return Value

    +

    A BTApplePayCardNonce

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAuthenticationInsight.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAuthenticationInsight.html new file mode 100644 index 0000000000..d61d2654ae --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTAuthenticationInsight.html @@ -0,0 +1,387 @@ + + + + BTAuthenticationInsight Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTAuthenticationInsight Class Reference +

+ +
+ +
+ +
+
+

BTAuthenticationInsight

+
+
+ + 
@objcMembers
+public class BTAuthenticationInsight : NSObject
+ +
+
+

Information pertaining to the regulatory environment for a credit card if authentication insight is requested during tokenization.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTBinData.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTBinData.html new file mode 100644 index 0000000000..0c5b4102d3 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTBinData.html @@ -0,0 +1,647 @@ + + + + BTBinData Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTBinData Class Reference +

+ +
+ +
+ +
+
+

BTBinData

+
+
+ + 
@objcMembers
+public class BTBinData : NSObject
+ +
+
+

Contains the bin data associated with a payment method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + prepaid + +
    +
    +
    +
    +
    +
    +

    Whether the card is a prepaid card. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let prepaid: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + healthcare + +
    +
    +
    +
    +
    +
    +

    Whether the card is a healthcare card. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let healthcare: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + debit + +
    +
    +
    +
    +
    +
    +

    Whether the card is a debit card. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let debit: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + durbinRegulated + +
    +
    +
    +
    +
    +
    +

    A value indicating whether the issuing bank’s card range is regulated by the Durbin Amendment due to the bank’s assets. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let durbinRegulated: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + commercial + +
    +
    +
    +
    +
    +
    +

    Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let commercial: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payroll + +
    +
    +
    +
    +
    +
    +

    Whether the card is a payroll card. Possible values: Yes/No/Unknown

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payroll: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + issuingBank + +
    +
    +
    +
    +
    +
    +

    The bank that issued the credit card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let issuingBank: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryOfIssuance + +
    +
    +
    +
    +
    +
    +

    The country that issued the credit card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let countryOfIssuance: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + productID + +
    +
    +
    +
    +
    +
    +

    The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)), if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let productID: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(json:) + +
    +
    +
    +
    +
    +
    +

    Create a BTBinData object from JSON.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithJSON:)
+public init(json: BTJSON?)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCard.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCard.html new file mode 100644 index 0000000000..29826bd21f --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCard.html @@ -0,0 +1,1005 @@ + + + + BTCard Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCard Class Reference +

+ +
+ +
+ +
+
+

BTCard

+
+
+ + 
@objcMembers
+public class BTCard : NSObject
+ +
+
+

The card tokenization request represents raw credit or debit card data provided by the customer. +Its main purpose is to serve as the input for tokenization.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + number + +
    +
    +
    +
    +
    +
    +

    The card number

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var number: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expirationMonth + +
    +
    +
    +
    +
    +
    +

    The expiration month as a one or two-digit number on the Gregorian calendar

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var expirationMonth: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expirationYear + +
    +
    +
    +
    +
    +
    +

    The expiration year as a two or four-digit number on the Gregorian calendar

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var expirationYear: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cvv + +
    +
    +
    +
    +
    +
    +

    The card verification code (like CVV or CID).

    +
    +

    Note

    + If you wish to create a CVV-only payment method nonce to verify a card already stored in your Vault, +omit all other properties to only collect CVV. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cvv: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    The postal code associated with the card’s billing address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cardholderName + +
    +
    +
    +
    +
    +
    +

    Optional: the cardholder’s name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardholderName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    Optional: first name on the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    Optional: last name on the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + company + +
    +
    +
    +
    +
    +
    +

    Optional: company name associated with the card.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var company: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + streetAddress + +
    +
    +
    +
    +
    +
    +

    Optional: the street address associated with the card’s billing address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var streetAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + extendedAddress + +
    +
    +
    +
    +
    +
    +

    Optional: the extended address associated with the card’s billing address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var extendedAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + locality + +
    +
    +
    +
    +
    +
    +

    Optional: the city associated with the card’s billing address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var locality: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + region + +
    +
    +
    +
    +
    +
    +

    Optional: either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var region: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryName + +
    +
    +
    +
    +
    +
    +

    Optional: the country name associated with the card’s billing address.

    +
    +

    Note

    + Braintree only accepts specific country names. + +
    +

    See also

    + https://developer.paypal.com/braintree/docs/reference/general/countries#list-of-countries + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeAlpha2 + +
    +
    +
    +
    +
    +
    +

    Optional: the ISO 3166-1 alpha-2 country code specified in the card’s billing address.

    +
    +

    Note

    + Braintree only accepts specific alpha-2 values. + +
    +

    See also

    + https://developer.paypal.com/braintree/docs/reference/general/countries#list-of-countries + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeAlpha2: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeAlpha3 + +
    +
    +
    +
    +
    +
    +

    Optional: the ISO 3166-1 alpha-3 country code specified in the card’s billing address.

    +
    +

    Note

    + Braintree only accepts specific alpha-3 values. + +
    +

    See also

    + https://developer.paypal.com/braintree/docs/reference/general/countries#list-of-countries + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeAlpha3: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeNumeric + +
    +
    +
    +
    +
    +
    +

    Optional: The ISO 3166-1 numeric country code specified in the card’s billing address.

    +
    +

    Note

    + Braintree only accepts specific numeric values. +
    +

    See also

    + https://developer.paypal.com/braintree/docs/reference/general/countries#list-of-countries + +
    + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeNumeric: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shouldValidate + +
    +
    +
    +
    +
    +
    +

    Controls whether or not to return validations and/or verification results. By default, this is not enabled.

    +
    +

    Note

    + Use this flag with caution. By enabling client-side validation, certain tokenize card requests may result in adding the card to the vault. +These semantics are not currently documented. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shouldValidate: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional: If authentication insight is requested. If this property is set to true, a merchantAccountID must be provided. Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationInsightRequested: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + merchantAccountID + +
    +
    +
    +
    +
    +
    +

    Optional: The merchant account ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var merchantAccountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCardClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCardClient.html new file mode 100644 index 0000000000..aa23c35edf --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCardClient.html @@ -0,0 +1,542 @@ + + + + BTCardClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCardClient Class Reference +

+ +
+ +
+ +
+
+

BTCardClient

+
+
+ + 
@objc
+public class BTCardClient : NSObject
+ +
+
+

Used to process cards

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Creates a card client

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Tokenizes a card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeCard:completion:)
+public func tokenize(_ card: BTCard, completion: @escaping (BTCardNonce?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + card + + +
    +

    The card to tokenize.

    +
    +
    + + completion + + +
    +

    A completion block that is invoked when card tokenization has completed. If tokenization succeeds, +tokenize will contain a nonce and error will be nil; if it fails, tokenize will be nil and errorwill describe the failure.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Tokenizes a card

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ card: BTCard) async throws -> BTCardNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + card + + +
    +

    The card to tokenize.

    +
    +
    +
    +
    +

    Return Value

    +

    On success, you will receive an instance of BTCardNonce

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCardNonce.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCardNonce.html new file mode 100644 index 0000000000..073f5fa62c --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCardNonce.html @@ -0,0 +1,656 @@ + + + + BTCardNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCardNonce Class Reference +

+ +
+ +
+ +
+
+

BTCardNonce

+
+
+ + 
@objcMembers
+public class BTCardNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a tokenized card.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + cardNetwork + +
    +
    +
    +
    +
    +
    +

    The card network.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardNetwork: BTCardNetwork
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expirationMonth + +
    +
    +
    +
    +
    +
    +

    The expiration month of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var expirationMonth: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expirationYear + +
    +
    +
    +
    +
    +
    +

    The expiration year of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var expirationYear: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cardholderName + +
    +
    +
    +
    +
    +
    +

    The name of the cardholder, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardholderName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastTwo + +
    +
    +
    +
    +
    +
    +

    The last two digits of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastTwo: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastFour + +
    +
    +
    +
    +
    +
    +

    The last four digits of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastFour: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + bin + +
    +
    +
    +
    +
    +
    +

    The BIN number of the card, if available.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bin: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + binData + +
    +
    +
    +
    +
    +
    +

    The BIN data for the card number associated with this nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var binData: BTBinData
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + threeDSecureInfo + +
    +
    +
    +
    +
    +
    +

    The 3D Secure info for the card number associated with this nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureInfo: BTThreeDSecureInfo
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + authenticationInsight + +
    +
    +
    +
    +
    +
    +

    Details about the regulatory environment and applicable customer authentication regulation for a potential transaction. +This can be used to make an informed decision whether to perform 3D Secure authentication.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationInsight: BTAuthenticationInsight?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCardRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCardRequest.html new file mode 100644 index 0000000000..5fe31b37d9 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTCardRequest.html @@ -0,0 +1,425 @@ + + + + BTCardRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCardRequest Class Reference +

+ +
+ +
+ +
+
+

BTCardRequest

+
+
+ + 
@objcMembers
+public class BTCardRequest : NSObject
+ +
+
+

Contains information about a card to tokenize

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + card + +
    +
    +
    +
    +
    +
    +

    The BTCard associated with this instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var card: BTCard
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(card:) + +
    +
    +
    +
    +
    +
    +

    Initialize a Card request with a BTCard.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(card: BTCard)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + card + + +
    +

    The BTCard to initialize with.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTClientMetadata.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTClientMetadata.html new file mode 100644 index 0000000000..56e545bfec --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTClientMetadata.html @@ -0,0 +1,626 @@ + + + + BTClientMetadata Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTClientMetadata Class Reference +

+ +
+ +
+ +
+
+

BTClientMetadata

+
+
+ + 
@objcMembers
+public class BTClientMetadata : NSObject, NSMutableCopying
+ +
+
+

Represents the metadata associated with a session for posting along with payment data during tokenization.

+ +

When a payment method is tokenized, the client api accepts parameters under +_meta which are used to determine where payment data originated.

+ +

In general, this data may evolve and be used in different ways by different +integrations in a single app. For example, if both Apple Pay and drop in are +used. In this case, the source and integration may change over time, while +the sessionID should remain constant. To achieve this, users of this class +should use mutableCopy to create a new copy based on the existing session +and then update the object as needed.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + integration + +
    +
    +
    +
    +
    +
    +

    Integration type

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var integration: BTClientMetadataIntegration
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + source + +
    +
    +
    +
    +
    +
    +

    Integration source

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var source: BTClientMetadataSource
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sessionID + +
    +
    +
    +
    +
    +
    +

    Auto-generated UUID

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sessionID: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + integrationString + +
    +
    +
    +
    +
    +
    +

    String representation of the integration

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var integrationString: String { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sourceString + +
    +
    +
    +
    +
    +
    +

    String representation of the source

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sourceString: String { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + parameters + +
    +
    +
    +
    +
    +
    +

    Additional metadata parameters

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var parameters: [String : Any] { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + mutableCopy(with:) + +
    +
    +
    +
    +
    +
    +

    Create a copy as BTMutableClientMetadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func mutableCopy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + copy(with:) + +
    +
    +
    +
    +
    +
    +

    Creates a copy of BTClientMetadata

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(copyWithZone:)
+public func copy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTClientToken.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTClientToken.html new file mode 100644 index 0000000000..d0fecf6e5b --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTClientToken.html @@ -0,0 +1,498 @@ + + + + BTClientToken Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTClientToken Class Reference +

+ +
+ +
+ +
+
+

BTClientToken

+
+
+ + 
@objcMembers
+public class BTClientToken : NSObject, NSCoding, NSCopying
+ +
+
+

An authorization string used to initialize the Braintree SDK

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

NSCoding conformance +

+
+
+
    +
  • +
    + + + + encode(with:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func encode(with coder: NSCoder)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(coder:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public required convenience init?(coder: NSCoder)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

NSCopying conformance +

+
+
+
    +
  • +
    + + + + copy(with:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(copyWithZone:)
+public func copy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

NSObject override +

+
+
+
    +
  • +
    + + + + isEqual(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func isEqual(_ object: Any?) -> Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTConfiguration.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTConfiguration.html new file mode 100644 index 0000000000..02daa17f67 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTConfiguration.html @@ -0,0 +1,456 @@ + + + + BTConfiguration Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTConfiguration Class Reference +

+ +
+ +
+ +
+
+

BTConfiguration

+
+
+ + 
@objcMembers
+public class BTConfiguration : NSObject
+ +
+
+

Contains information specific to a merchant’s Braintree integration

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + json + +
    +
    +
    +
    +
    +
    +

    The merchant account’s configuration as a BTJSON object

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let json: BTJSON?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + environment + +
    +
    +
    +
    +
    +
    +

    The environment (production or sandbox)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var environment: String? { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(json:) + +
    +
    +
    +
    +
    +
    +

    Used to initialize a BTConfiguration

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithJSON:)
+public init(json: BTJSON?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + json + + +
    +

    The BTJSON to initialize with

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTDataCollector.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTDataCollector.html new file mode 100644 index 0000000000..0d87f62cbd --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTDataCollector.html @@ -0,0 +1,568 @@ + + + + BTDataCollector Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTDataCollector Class Reference +

+ +
+ +
+ +
+
+

BTDataCollector

+
+
+ + 
@objc
+public class BTDataCollector : NSObject
+ +
+
+

Braintree’s advanced fraud protection solution.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initializes a BTDataCollector instance with a BTAPIClient.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An instance of BTAPIClient

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public methods +

+
+
+
    +
  • +
    + + + + clientMetadataID(_:) + +
    +
    +
    +
    +
    +
    +

    Returns a client metadata ID.

    +
    +

    Note

    + This returns a raw client metadata ID, which is not the correct format for device data when creating a transaction. Instead, it is recommended to use collectDeviceData. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func clientMetadataID(_ pairingID: String?) -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + pairingID + + +
    +

    A pairing ID to associate with this clientMetadataID must be 10-32 chars long or null

    +
    +
    +
    +
    +

    Return Value

    +

    A client metadata ID to send as a header

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + collectDeviceData(_:) + +
    +
    +
    +
    +
    +
    +

    Collects device data based on your merchant configuration.

    + +

    We recommend that you call this method as early as possible, e.g. at app launch. If that’s too early, + calling it when the customer initiates checkout is also fine. + Use the return value on your server, e.g. with Transaction.sale.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func collectDeviceData(_ completion: @escaping (String?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + completion + + +
    +

    A completion block that returns either a device data string that should be passed into server-side calls, such as Transaction.sale, or an error with the failure reason.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + collectDeviceData() + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Collects device data based on your merchant configuration.

    + +

    We recommend that you call this method as early as possible, e.g. at app launch. If that’s too early, + calling it when the customer initiates checkout is also fine. + Use the return value on your server, e.g. with Transaction.sale.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func collectDeviceData() async throws -> String
    + +
    +
    +
    +

    Return Value

    +

    A device data string that should be passed into server-side calls, such as Transaction.sale.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTJSON.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTJSON.html new file mode 100644 index 0000000000..c01dd0fae1 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTJSON.html @@ -0,0 +1,1356 @@ + + + + BTJSON Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTJSON Class Reference +

+ +
+ +
+ +
+
+

BTJSON

+
+
+ + 
@objcMembers
+public class BTJSON : NSObject
+ +
+
+

A type-safe wrapper around JSON +@see http://www.json.org/

+ +

The primary goal of this class is to two-fold: (1) prevent bugs by staying true to JSON (json.org) +rather than interpreting it in mysterious ways; (2) prevent bugs by making JSON interpretation +as un-surprising as possible.

+ +

Most notably, type casting occurs via the as* nullable methods; errors are deferred and can be checked explicitly using isError and asError.

+

Example Data:

+
   {
+     "foo": "bar",
+     "baz": [1, 2, 3]
+   }
+
+

Example Usage:

+
   let json : BTJSON = BTJSON(data:data);
+   json.isError  // false
+   json.isObject // true
+   json.isNumber // false
+   json.asObject // self
+   json["foo"]   // JSON(@"bar")
+   json["foo"].isString // true
+   json["foo"].asString // @"bar"
+   json["baz"].asString // null
+   json["baz"]["quux"].isError // true
+   json["baz"]["quux"].asError // NSError(domain: BTJSONErrorDomain, code: BTJSONErrorCodeTypeInvalid)
+   json["baz"][0].asError // null
+   json["baz"][0].asInteger //
+   json["random"]["nested"]["things"][3].isError // true
+
+   let json : BTJSON = BTJSON() // json.asJson => {}
+   json["foo"][0] = "bar" // json.asJSON => { "foo": ["bar"] }
+   json["baz"] = [ 1, 2, 3 ] // json.asJSON => { "foo": ["bar"], "baz": [1,2,3] }
+   json["quux"] = NSSet() // json.isError => true, json.asJSON => throws NSError(domain: BTJSONErrorDomain, code: BTJSONErrorInvalidData)
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializers +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(value:) + +
    +
    +
    +
    +
    +
    +

    Initialize with a value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(value: Any?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + value + + +
    +

    The value to initialize with.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(data:) + +
    +
    +
    +
    +
    +
    +

    Initialize with data.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public convenience init(data: Data)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + data + + +
    +

    The Data to initialize with.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

JSON Type Checks +

+
+
+
    +
  • +
    + + + + isString + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a String

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isString: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid String

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isBool + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a Bool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isBool: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid Bool

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isNumber + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a NSNumber

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isNumber: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid NSNumber

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isArray + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a [Any]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isArray: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid [Any]

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isObject + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a [String: Any]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isObject: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is a valid [String: Any]

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isError + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is an error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isError: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is not valid.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isTrue + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a value representing true

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isTrue: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is true

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isFalse + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a value representing false

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isFalse: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is false

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isNull + +
    +
    +
    +
    +
    +
    +

    Checks if the BTJSON is a value representing nil

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isNull: Bool { get }
    + +
    +
    +
    +

    Return Value

    +

    true if this instance of BTJSON is nil

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Subscripting +

+
+
+
    +
  • +
    + + + + subscript(_:) + +
    +
    +
    +
    +
    +
    +

    Indexes into the JSON as if the current value is an object

    + +

    Notably, this method will always return successfully; however, if the value is not an object, the JSON will wrap an error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public subscript(index: Int) -> BTJSON { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + subscript(_:) + +
    +
    +
    +
    +
    +
    +

    Indexes into the JSON as if the current value is an array

    + +

    Notably, this method will always return successfully; however, if the value is not an array, the JSON will wrap an error.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public subscript(key: String) -> BTJSON { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Validity Checks +

+
+
+
    +
  • +
    + + + + asError() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a NSError.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asError() -> NSError?
    + +
    +
    +
    +

    Return Value

    +

    A NSError representing the BTJSON instance.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

JSON Type Casts +

+
+
+
    +
  • +
    + + + + asString() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a String

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asString() -> String?
    + +
    +
    +
    +

    Return Value

    +

    A String representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asBool() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a Bool

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asBool() -> Bool?
    + +
    +
    +
    +

    Return Value

    +

    A Bool representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asArray() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a [BTJSON]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asArray() -> [BTJSON]?
    + +
    +
    +
    +

    Return Value

    +

    A [BTJSON] representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asNumber() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a NSNumber

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asNumber() -> NSNumber?
    + +
    +
    +
    +

    Return Value

    +

    A NSNumber representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

JSON Extension Type Casts +

+
+
+
    +
  • +
    + + + + asURL() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a URL

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asURL() -> URL?
    + +
    +
    +
    +

    Return Value

    +

    A URL representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asStringArray() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a [String]

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asStringArray() -> [String]?
    + +
    +
    +
    +

    Return Value

    +

    A [String] representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asDictionary() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a NSDictionary

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asDictionary() -> NSDictionary?
    + +
    +
    +
    +

    Return Value

    +

    A NSDictionary representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asIntegerOrZero() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a Int

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asIntegerOrZero() -> Int
    + +
    +
    +
    +

    Return Value

    +

    A Int representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asEnum(_:orDefault:) + +
    +
    +
    +
    +
    +
    +

    The BTJSON as an Enum

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asEnum(_ mapping: [String : Any], orDefault: Int) -> Int
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + mapping + + +
    +

    The mapping dictionary used to convert the value

    +
    +
    + + orDefault + + +
    +

    The default value if conversion fails

    +
    +
    +
    +
    +

    Return Value

    +

    An Enum representing the BTJSON instance

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + asAddress() + +
    +
    +
    +
    +
    +
    +

    The BTJSON as a BTPostalAddress

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func asAddress() -> BTPostalAddress?
    + +
    +
    +
    +

    Return Value

    +

    A BTPostalAddress parsed from the key/value pairs inside the BTJSON

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLocalPaymentClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLocalPaymentClient.html new file mode 100644 index 0000000000..0b5c7493fd --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLocalPaymentClient.html @@ -0,0 +1,539 @@ + + + + BTLocalPaymentClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLocalPaymentClient Class Reference +

+ +
+ +
+ +
+
+

BTLocalPaymentClient

+
+
+ + 
@objcMembers
+public class BTLocalPaymentClient : BTWebAuthenticationSessionClient
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new BTLocalPaymentClient instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLocalPaymentRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLocalPaymentRequest.html new file mode 100644 index 0000000000..e1f3d5eac1 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLocalPaymentRequest.html @@ -0,0 +1,778 @@ + + + + BTLocalPaymentRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLocalPaymentRequest Class Reference +

+ +
+ +
+ +
+
+

BTLocalPaymentRequest

+
+
+ + 
@objcMembers
+public class BTLocalPaymentRequest : NSObject
+ +
+
+

Used to initialize a local payment flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + paymentType + +
    +
    +
    +
    +
    +
    +

    The type of payment.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentType: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The country code of the local payment.

    + +

    This value must be one of the supported country codes for a given local payment type listed at the link below. For local payments supported in multiple countries, this value may determine which banks are presented to the customer.

    + +

    https://developer.paypal.com/braintree/docs/guides/local-payment-methods/client-side-custom/ios/v5#invoke-payment-flow

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentTypeCountryCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + merchantAccountID + +
    +
    +
    +
    +
    +
    +

    Optional: The address of the customer. An error will occur if this address is not valid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var merchantAccountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + address + +
    +
    +
    +
    +
    +
    +

    Optional: The address of the customer. An error will occur if this address is not valid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var address: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount for the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var amount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + currencyCode + +
    +
    +
    +
    +
    +
    +

    Optional: A valid ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currencyCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    Optional: The merchant name displayed inside of the local payment flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var displayName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Optional: Payer email of the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + givenName + +
    +
    +
    +
    +
    +
    +

    Optional: Given (first) name of the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var givenName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + surname + +
    +
    +
    +
    +
    +
    +

    Optional: Surname (last name) of the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var surname: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    Optional: Phone number of the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phone: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Indicates whether or not the payment needs to be shipped. For digital goods, this should be false. Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isShippingAddressRequired: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + bic + +
    +
    +
    +
    +
    +
    +

    Optional: Bank Identification Code of the customer (specific to iDEAL transactions).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var bic: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public weak var localPaymentFlowDelegate: BTLocalPaymentRequestDelegate?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLocalPaymentResult.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLocalPaymentResult.html new file mode 100644 index 0000000000..77ff1be912 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLocalPaymentResult.html @@ -0,0 +1,645 @@ + + + + BTLocalPaymentResult Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLocalPaymentResult Class Reference +

+ +
+ +
+ +
+
+

BTLocalPaymentResult

+
+
+ + 
@objcMembers
+public class BTLocalPaymentResult : NSObject
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    The billing address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let billingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + clientMetadataID + +
    +
    +
    +
    +
    +
    +

    Client Metadata ID associated with this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientMetadataID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Payer’s email address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    Payer’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    Payer’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + nonce + +
    +
    +
    +
    +
    +
    +

    The one-time use payment method nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let nonce: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payerID + +
    +
    +
    +
    +
    +
    +

    Payer ID associated with this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    Payer’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let phone: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingAddress + +
    +
    +
    +
    +
    +
    +

    The shipping address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let shippingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The type of the tokenized payment.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let type: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLogLevelDescription.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLogLevelDescription.html new file mode 100644 index 0000000000..02e899001f --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTLogLevelDescription.html @@ -0,0 +1,375 @@ + + + + BTLogLevelDescription Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLogLevelDescription Class Reference +

+ +
+ +
+ +
+
+

BTLogLevelDescription

+
+
+ + 
@objcMembers
+public class BTLogLevelDescription : NSObject
+ +
+
+

Wrapper for accessing the string value of the log level

+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalAccountNonce.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalAccountNonce.html new file mode 100644 index 0000000000..ce2da3dd7a --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalAccountNonce.html @@ -0,0 +1,618 @@ + + + + BTPayPalAccountNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalAccountNonce Class Reference +

+ +
+ +
+ +
+
+

BTPayPalAccountNonce

+
+
+ + 
@objcMembers
+public class BTPayPalAccountNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a PayPal payment method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Payer’s email address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    Payer’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    Payer’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    Payer’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let phone: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    The billing address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let billingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingAddress + +
    +
    +
    +
    +
    +
    +

    The shipping address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let shippingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + clientMetadataID + +
    +
    +
    +
    +
    +
    +

    Client metadata id associated with this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientMetadataID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payerID + +
    +
    +
    +
    +
    +
    +

    Optional. Payer id associated with this transaction. +Will be provided for Vault and Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + creditFinancing + +
    +
    +
    +
    +
    +
    +

    Optional. Credit financing details if the customer pays with PayPal Credit. +Will be provided for Vault and Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let creditFinancing: BTPayPalCreditFinancing?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalCheckoutRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalCheckoutRequest.html new file mode 100644 index 0000000000..f8ea771e05 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalCheckoutRequest.html @@ -0,0 +1,674 @@ + + + + BTPayPalCheckoutRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalCheckoutRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalCheckoutRequest

+
+
+ + 
@objcMembers
+open class BTPayPalCheckoutRequest : BTPayPalRequest
+ +
+
+

Options for the PayPal Checkout flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    Used for a one-time payment.

    + +

    Amount must be greater than or equal to zero, may optionally contain exactly 2 decimal places separated by ‘.’ and is limited to 7 digits before the decimal point.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var amount: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + intent + +
    +
    +
    +
    +
    +
    +

    Optional: Payment intent. Defaults to .authorize. Only applies to PayPal Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var intent: BTPayPalRequestIntent
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + userAction + +
    +
    +
    +
    +
    +
    +

    Optional: Changes the call-to-action in the PayPal Checkout flow. Defaults to .none.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var userAction: BTPayPalRequestUserAction
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + offerPayLater + +
    +
    +
    +
    +
    +
    +

    Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var offerPayLater: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + currencyCode + +
    +
    +
    +
    +
    +
    +

    Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

    +
    +

    Note

    + See https://developer.paypal.com/docs/api/reference/currency-codes/ for a list of supported currency codes. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var currencyCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional: If set to true, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement during checkout. Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var requestBillingAgreement: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a PayPal Native Checkout request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(
+    amount: String,
+    intent: BTPayPalRequestIntent = .authorize,
+    userAction: BTPayPalRequestUserAction = .none,
+    offerPayLater: Bool = false,
+    currencyCode: String? = nil,
+    requestBillingAgreement: Bool = false
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    Used for a one-time payment. Amount must be greater than or equal to zero, may optionally contain exactly 2 decimal places separated by ‘.’

    +
    +
    + + intent + + +
    +

    Optional: Payment intent. Defaults to .authorize. Only applies to PayPal Checkout. +and is limited to 7 digits before the decimal point.

    +
    +
    + + userAction + + +
    +

    Optional: Changes the call-to-action in the PayPal Checkout flow. Defaults to .none.

    +
    +
    + + offerPayLater + + +
    +

    Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.

    +
    +
    + + currencyCode + + +
    +

    Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set. +See https://developer.paypal.com/docs/api/reference/currency-codes/ for a list of supported currency codes.

    +
    +
    + + requestBillingAgreement + + +
    +

    Optional: If set to true, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement +during checkout. Defaults to false.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalClient.html new file mode 100644 index 0000000000..86943b17c0 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalClient.html @@ -0,0 +1,705 @@ + + + + BTPayPalClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalClient Class Reference +

+ +
+ +
+ +
+
+

BTPayPalClient

+
+
+ + 
@objc
+public class BTPayPalClient : BTWebAuthenticationSessionClient
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new PayPal client instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    The API Client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Tokenize a PayPal request to be used with the PayPal Vault flow.

    +
    +

    Note

    + You can use this as the final step in your order/checkout flow. If you want, you may create a transaction from your +server when this method completes without any additional user interaction. + +
    + +

    On success, you will receive an instance of BTPayPalAccountNonce; on failure or user cancelation you will receive an error. +If the user cancels out of the flow, the error code will be .canceled.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeWithVaultRequest:completion:)
+public func tokenize(
+    _ request: BTPayPalVaultRequest,
+    completion: @escaping (BTPayPalAccountNonce?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + + +
    + + completion + + +
    +

    This completion will be invoked exactly once when tokenization is complete or an error occurs.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Tokenize a PayPal request to be used with the PayPal Vault flow.

    +
    +

    Note

    + You can use this as the final step in your order/checkout flow. If you want, you may create a transaction from your +server when this method completes without any additional user interaction. + +
    + +

    On success, you will receive an instance of BTPayPalAccountNonce; on failure or user cancelation you will receive an error. +If the user cancels out of the flow, the error code will be .canceled.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ request: BTPayPalVaultRequest) async throws -> BTPayPalAccountNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + + +
    +
    +
    +

    Return Value

    +

    A BTPayPalAccountNonce if successful

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Tokenize a PayPal request to be used with the PayPal Checkout or Pay Later flow.

    +
    +

    Note

    + You can use this as the final step in your order/checkout flow. If you want, you may create a transaction from your +server when this method completes without any additional user interaction. + +
    + +

    On success, you will receive an instance of BTPayPalAccountNonce; on failure or user cancelation you will receive an error. +If the user cancels out of the flow, the error code will be .canceled.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeWithCheckoutRequest:completion:)
+public func tokenize(
+    _ request: BTPayPalCheckoutRequest,
+    completion: @escaping (BTPayPalAccountNonce?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + + +
    + + completion + + +
    +

    This completion will be invoked exactly once when tokenization is complete or an error occurs.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Tokenize a PayPal request to be used with the PayPal Checkout or Pay Later flow.

    +
    +

    Note

    + You can use this as the final step in your order/checkout flow. If you want, you may create a transaction from your +server when this method completes without any additional user interaction. + +
    + +

    On success, you will receive an instance of BTPayPalAccountNonce; on failure or user cancelation you will receive an error. +If the user cancels out of the flow, the error code will be .canceled.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ request: BTPayPalCheckoutRequest) async throws -> BTPayPalAccountNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + + +
    +
    +
    +

    Return Value

    +

    A BTPayPalAccountNonce if successful

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalCreditFinancing.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalCreditFinancing.html new file mode 100644 index 0000000000..0ae9511933 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalCreditFinancing.html @@ -0,0 +1,526 @@ + + + + BTPayPalCreditFinancing Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalCreditFinancing Class Reference +

+ +
+ +
+ +
+
+

BTPayPalCreditFinancing

+
+
+ + 
@objcMembers
+public class BTPayPalCreditFinancing : NSObject
+ +
+
+

Contains information about a PayPal credit financing option

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + cardAmountImmutable + +
    +
    +
    +
    +
    +
    +

    Indicates whether the card amount is editable after payer’s acceptance on PayPal side.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let cardAmountImmutable: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + monthlyPayment + +
    +
    +
    +
    +
    +
    +

    Estimated amount per month that the customer will need to pay including fees and interest.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let monthlyPayment: BTPayPalCreditFinancingAmount?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payerAcceptance + +
    +
    +
    +
    +
    +
    +

    Status of whether the customer ultimately was approved for and chose to make the payment using the approved installment credit.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerAcceptance: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + term + +
    +
    +
    +
    +
    +
    +

    Length of financing terms in months.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let term: Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + totalCost + +
    +
    +
    +
    +
    +
    +

    Estimated total payment amount including interest and fees the user will pay during the lifetime of the loan.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let totalCost: BTPayPalCreditFinancingAmount?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + totalInterest + +
    +
    +
    +
    +
    +
    +

    Estimated interest or fees amount the payer will have to pay during the lifetime of the loan.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let totalInterest: BTPayPalCreditFinancingAmount?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalCreditFinancingAmount.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalCreditFinancingAmount.html new file mode 100644 index 0000000000..7ddd358b2d --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalCreditFinancingAmount.html @@ -0,0 +1,406 @@ + + + + BTPayPalCreditFinancingAmount Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalCreditFinancingAmount Class Reference +

+ +
+ +
+ +
+
+

BTPayPalCreditFinancingAmount

+
+
+ + 
@objcMembers
+public class BTPayPalCreditFinancingAmount : NSObject
+ +
+
+

Contains information about a PayPal credit amount

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + currency + +
    +
    +
    +
    +
    +
    +

    3 letter currency code as defined by ISO 4217.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let currency: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + value + +
    +
    +
    +
    +
    +
    +

    An amount defined by ISO 4217 for the given currency.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let value: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalLineItem.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalLineItem.html new file mode 100644 index 0000000000..bffc387923 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalLineItem.html @@ -0,0 +1,741 @@ + + + + BTPayPalLineItem Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalLineItem Class Reference +

+ +
+ +
+ +
+
+

BTPayPalLineItem

+
+
+ + 
@objcMembers
+public class BTPayPalLineItem : NSObject
+ +
+
+

A PayPal line item to be displayed in the PayPal checkout flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + quantity + +
    +
    +
    +
    +
    +
    +

    Number of units of the item purchased. This value must be a whole number and can’t be negative or zero.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let quantity: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + unitAmount + +
    +
    +
    +
    +
    +
    +

    Per-unit price of the item. Can include up to 2 decimal places. This value can’t be negative or zero.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let unitAmount: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + name + +
    +
    +
    +
    +
    +
    +

    Item name. Maximum 127 characters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let name: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + kind + +
    +
    +
    +
    +
    +
    +

    Indicates whether the line item is a debit (sale) or credit (refund) to the customer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let kind: BTPayPalLineItemKind
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + unitTaxAmount + +
    +
    +
    +
    +
    +
    +

    Optional: Per-unit tax price of the item. Can include up to 2 decimal places. This value can’t be negative or zero.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let unitTaxAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + itemDescription + +
    +
    +
    +
    +
    +
    +

    Optional: Item description. Maximum 127 characters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let itemDescription: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + productCode + +
    +
    +
    +
    +
    +
    +

    Optional: Product or UPC code for the item. Maximum 127 characters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let productCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + url + +
    +
    +
    +
    +
    +
    +

    Optional: The URL to product information.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let url: URL?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Initializer +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initialize a PayPayLineItem

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithQuantity:unitAmount:name:kind:)
+public init(quantity: String, unitAmount: String, name: String, kind: BTPayPalLineItemKind)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + +
    + + quantity + + +
    +

    Number of units of the item purchased. Can include up to 4 decimal places. This value can’t be negative or zero.

    +
    +
    + + unitAmount + + +
    +

    Per-unit price of the item. Can include up to 4 decimal places. This value can’t be negative or zero.

    +
    +
    + + name + + +
    +

    Item name. Maximum 127 characters.

    +
    +
    + + kind + + +
    +

    Indicates whether the line item is a debit (sale) or credit (refund) to the customer.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • +
    + + + + requestParameters() + +
    +
    +
    +
    +
    +
    +

    Returns the line item in a dictionary.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func requestParameters() -> [String : String]
    + +
    +
    +
    +

    Return Value

    +

    A dictionary with the line item information formatted for a request.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeCheckoutAccountNonce.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeCheckoutAccountNonce.html new file mode 100644 index 0000000000..3dfde723fc --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeCheckoutAccountNonce.html @@ -0,0 +1,596 @@ + + + + BTPayPalNativeCheckoutAccountNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalNativeCheckoutAccountNonce Class Reference +

+ +
+ +
+ +
+
+

BTPayPalNativeCheckoutAccountNonce

+
+
+ + 
@objcMembers
+public class BTPayPalNativeCheckoutAccountNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a PayPal payment method.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Payer’s email address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    Payer’s first name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    Payer’s last name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phone + +
    +
    +
    +
    +
    +
    +

    Payer’s phone number.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let phone: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    The billing address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let billingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingAddress + +
    +
    +
    +
    +
    +
    +

    The shipping address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let shippingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + clientMetadataID + +
    +
    +
    +
    +
    +
    +

    Client metadata id associated with this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientMetadataID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payerID + +
    +
    +
    +
    +
    +
    +

    Optional. Payer id associated with this transaction. +Will be provided for Vault and Checkout.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let payerID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeCheckoutClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeCheckoutClient.html new file mode 100644 index 0000000000..f3802b74f4 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeCheckoutClient.html @@ -0,0 +1,677 @@ + + + + BTPayPalNativeCheckoutClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalNativeCheckoutClient Class Reference +

+ +
+ +
+ +
+
+

BTPayPalNativeCheckoutClient

+
+
+ + 
@objc
+public class BTPayPalNativeCheckoutClient : NSObject
+ +
+
+

Client used to collect PayPal payment methods. If possible, this client will present a native flow; otherwise, it will fall back to a web flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initializes a PayPal Native client.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    The Braintree API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeCheckoutRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeCheckoutRequest.html new file mode 100644 index 0000000000..adecf5d584 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeCheckoutRequest.html @@ -0,0 +1,474 @@ + + + + BTPayPalNativeCheckoutRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalNativeCheckoutRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalNativeCheckoutRequest

+
+
+ + 
@objcMembers
+public class BTPayPalNativeCheckoutRequest : BTPayPalCheckoutRequest
+ +
+
+

Options for the PayPal Checkout flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a PayPal Native Checkout request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(
+    amount: String,
+    intent: BTPayPalRequestIntent = .authorize,
+    offerPayLater: Bool = false,
+    currencyCode: String? = nil,
+    requestBillingAgreement: Bool = false,
+    billingAgreementDescription: String? = nil
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + amount + + +
    +

    Used for a one-time payment. Amount must be greater than or equal to zero, may optionally contain exactly 2 decimal places separated by ‘.’

    +
    +
    + + intent + + +
    +

    Optional: Payment intent. Defaults to .authorize. Only applies to PayPal Checkout. +and is limited to 7 digits before the decimal point.

    +
    +
    + + offerPayLater + + +
    +

    Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.

    +
    +
    + + currencyCode + + +
    +

    Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set. +See https://developer.paypal.com/docs/api/reference/currency-codes/ for a list of supported currency codes.

    +
    +
    + + requestBillingAgreement + + +
    +

    Optional: If set to true, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement during checkout.

    +
    +
    + + billingAgreementDescription + + +
    +

    Optional: Display a custom description to the user for a billing agreement. For Checkout with Vault flows, you must also +set requestBillingAgreement to true on your BTPayPalNativeVaultRequest.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeVaultRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeVaultRequest.html new file mode 100644 index 0000000000..f3f48eb04b --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalNativeVaultRequest.html @@ -0,0 +1,420 @@ + + + + BTPayPalNativeVaultRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalNativeVaultRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalNativeVaultRequest

+
+
+ + 
@objcMembers
+public class BTPayPalNativeVaultRequest : BTPayPalVaultRequest
+ +
+
+

Options for the PayPal Vault flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initializes a PayPal Native Vault request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(
+    offerCredit: Bool = false,
+    billingAgreementDescription: String? = nil
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + offerCredit + + +
    +

    Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

    +
    +
    + + billingAgreementDescription + + +
    +

    Optional: Display a custom description to the user for a billing agreement. For Checkout with Vault flows, you must also set +requestBillingAgreement to true on your BTPayPalCheckoutRequest.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalRequest.html new file mode 100644 index 0000000000..a8e5784c10 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalRequest.html @@ -0,0 +1,673 @@ + + + + BTPayPalRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalRequest

+
+
+ + 
@objcMembers
+open class BTPayPalRequest : NSObject
+ +
+
+

Base options for PayPal Checkout and PayPal Vault flows.

+
+

Note

+ Do not instantiate this class directly. Instead, use BTPayPalCheckoutRequest or BTPayPalVaultRequest. + +
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Defaults to false. When set to true, the shipping address selector will be displayed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isShippingAddressRequired: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Defaults to false. Set to true to enable user editing of the shipping address.

    +
    +

    Note

    + Only applies when shippingAddressOverride is set. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isShippingAddressEditable: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + localeCode + +
    +
    +
    +
    +
    +
    +

    Optional: A locale code to use for the transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var localeCode: BTPayPalLocaleCode
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional: A valid shipping address to be displayed in the transaction flow. An error will occur if this address is not valid.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingAddressOverride: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + landingPageType + +
    +
    +
    +
    +
    +
    +

    Optional: Landing page type. Defaults to .none.

    +
    +

    Note

    + Setting the BTPayPalRequest’s landingPageType changes the PayPal page to display when a user lands on the PayPal site to complete the payment. +.login specifies a PayPal account login page is used. +.billing specifies a non-PayPal account landing page is used. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var landingPageType: BTPayPalRequestLandingPageType
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    Optional: The merchant name displayed inside of the PayPal flow; defaults to the company name on your Braintree account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var displayName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + merchantAccountID + +
    +
    +
    +
    +
    +
    +

    Optional: A non-default merchant account to use for tokenization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var merchantAccountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lineItems + +
    +
    +
    +
    +
    +
    +

    Optional: The line items for this transaction. It can include up to 249 line items.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lineItems: [BTPayPalLineItem]?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional: Display a custom description to the user for a billing agreement. For Checkout with Vault flows, you must also set + requestBillingAgreement to true on your BTPayPalCheckoutRequest.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var billingAgreementDescription: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + riskCorrelationID + +
    +
    +
    +
    +
    +
    +

    Optional: A risk correlation ID created with Set Transaction Context on your server.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var riskCorrelationID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalVaultRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalVaultRequest.html new file mode 100644 index 0000000000..924a7cb4f4 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPayPalVaultRequest.html @@ -0,0 +1,447 @@ + + + + BTPayPalVaultRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalVaultRequest Class Reference +

+ +
+ +
+ +
+
+

BTPayPalVaultRequest

+
+
+ + 
@objcMembers
+open class BTPayPalVaultRequest : BTPayPalRequest
+ +
+
+

Options for the PayPal Vault flow.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + offerCredit + +
    +
    +
    +
    +
    +
    +

    Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var offerCredit: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(offerCredit:) + +
    +
    +
    +
    +
    +
    +

    Initializes a PayPal Native Vault request

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(offerCredit: Bool = false)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + offerCredit + + +
    +

    Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPaymentMethodNonce.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPaymentMethodNonce.html new file mode 100644 index 0000000000..01315e0818 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPaymentMethodNonce.html @@ -0,0 +1,642 @@ + + + + BTPaymentMethodNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPaymentMethodNonce Class Reference +

+ +
+ +
+ +
+
+

BTPaymentMethodNonce

+
+
+ + 
@objcMembers
+open class BTPaymentMethodNonce : NSObject
+ +
+
+

BTPaymentMethodNonce is for generic tokenized payment information.

+ +

For example, if a customer’s vaulted payment methods contains a type that’s not recognized or supported by the +Braintree SDK or the client-side integration (e.g. the vault contains a PayPal account but the client-side +integration does not include the PayPal component), this type can act as a fallback.

+ +

The payment method nonce is a public token that acts as a placeholder for sensitive payments data that +has been uploaded to Braintree for subsequent processing. The nonce is safe to access on the client and can be +used on your server to reference the data in Braintree operations, such as Transaction.sale.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + nonce + +
    +
    +
    +
    +
    +
    +

    The payment method nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var nonce: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + type + +
    +
    +
    +
    +
    +
    +

    The string identifying the type of the payment method.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var type: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isDefault + +
    +
    +
    +
    +
    +
    +

    The boolean indicating whether this is a default payment method.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isDefault: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(nonce:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new Payment Method Nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithNonce:)
+public init(nonce: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + nonce + + +
    +

    A transact-able payment method nonce.

    +
    +
    +
    +
    +

    Return Value

    +

    A Payment Method Nonce, or nil if nonce is nil.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(nonce:type:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new Payment Method Nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithNonce:type:)
+public init(nonce: String, type: String)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + nonce + + +
    +

    A transact-able payment method nonce.

    +
    +
    + + type + + +
    +

    A string identifying the type of the payment method.

    +
    +
    +
    +
    +

    Return Value

    +

    A Payment Method Nonce, or nil if nonce is nil.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a new Payment Method Nonce.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithNonce:type:isDefault:)
+public init(nonce: String, type: String, isDefault: Bool)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + nonce + + +
    +

    A transact-able payment method nonce.

    +
    +
    + + type + + +
    +

    A string identifying the type of the payment method.

    +
    +
    + + isDefault + + +
    +

    A boolean indicating whether this is a default payment method.

    +
    +
    +
    +
    +

    Return Value

    +

    A Payment Method Nonce, or nil if nonce is nil.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPaymentMethodNonceParser.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPaymentMethodNonceParser.html new file mode 100644 index 0000000000..015bf0ef46 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPaymentMethodNonceParser.html @@ -0,0 +1,564 @@ + + + + BTPaymentMethodNonceParser Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPaymentMethodNonceParser Class Reference +

+ +
+ +
+ +
+
+

BTPaymentMethodNonceParser

+
+
+ + 
@objcMembers
+public class BTPaymentMethodNonceParser : NSObject
+ +
+
+

A JSON parser that parses BTJSON into concrete BTPaymentMethodNonce objects. It supports registration of parsers at runtime.

+ +

BTPaymentMethodNonceParser provides access to JSON parsing for different payment options +without introducing compile-time dependencies on payment option frameworks and their symbols.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + shared + +
    +
    +
    +
    +
    +
    +

    The singleton instance

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(sharedParser)
+public static let shared: BTPaymentMethodNonceParser
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + allTypes + +
    +
    +
    +
    +
    +
    +

    An array of the tokenization types currently registered

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var allTypes: [String] { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isTypeAvailable(_:) + +
    +
    +
    +
    +
    +
    +

    Indicates whether a tokenization type is currently registered

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func isTypeAvailable(_ type: String) -> Bool
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + type + + +
    +

    The tokenization type string

    +
    +
    +
    +
    +

    Return Value

    +

    A bool indicating if the payment method type is available.

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Registers a parsing block for a tokenization type.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func registerType(_ type: String?, withParsingBlock: @escaping (_ json: BTJSON?) -> BTPaymentMethodNonce?)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + type + + +
    +

    The tokenization type string

    +
    +
    + + withParsingBlock + + +
    +

    jsonParsingBlock The block to execute when parseJSON:type: is called for the tokenization type. +This block should return a BTPaymentMethodNonce object, or nil if the JSON cannot be parsed.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Parses tokenized payment information that has been serialized to JSON, and returns a BTPaymentMethodNonce object.

    + +

    The BTPaymentMethodNonce object is created by the JSON parsing block that has been registered for the tokenization type.

    + +

    If the type has not been registered, this method will attempt to read the nonce from the JSON and return + a basic object; if it fails, it will return nil.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func parseJSON(_ json: BTJSON?, withParsingBlockForType type: String?) -> BTPaymentMethodNonce?
    + +
    +
    +
    +

    Return Value

    +

    A BTPaymentMethodNonce object, or nil if the tokenized payment info JSON does not contain a nonce

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPostalAddress.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPostalAddress.html new file mode 100644 index 0000000000..c5b1813dd9 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTPostalAddress.html @@ -0,0 +1,587 @@ + + + + BTPostalAddress Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPostalAddress Class Reference +

+ +
+ +
+ +
+
+

BTPostalAddress

+
+
+ + 
@objcMembers
+public class BTPostalAddress : NSObject, NSCopying
+ +
+
+

Generic postal address

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + recipientName + +
    +
    +
    +
    +
    +
    +

    Optional. Recipient name for shipping address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var recipientName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + streetAddress + +
    +
    +
    +
    +
    +
    +

    Line 1 of the Address (eg. number, street, etc).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var streetAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + extendedAddress + +
    +
    +
    +
    +
    +
    +

    Optional line 2 of the Address (eg. suite, apt #, etc.).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var extendedAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + locality + +
    +
    +
    +
    +
    +
    +

    City name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var locality: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeAlpha2 + +
    +
    +
    +
    +
    +
    +

    2 letter country code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeAlpha2: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    Zip code or equivalent is usually required for countries that have them. +For a list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + region + +
    +
    +
    +
    +
    +
    +

    Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var region: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + copy(with:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(copyWithZone:)
+public func copy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTSEPADirectDebitClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTSEPADirectDebitClient.html new file mode 100644 index 0000000000..949ebb302a --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTSEPADirectDebitClient.html @@ -0,0 +1,544 @@ + + + + BTSEPADirectDebitClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTSEPADirectDebitClient Class Reference +

+ +
+ +
+ +
+
+

BTSEPADirectDebitClient

+
+
+ + 
@objc
+public class BTSEPADirectDebitClient : BTWebAuthenticationSessionClient
+ +
+
+

Used to integrate with SEPA Direct Debit.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializers +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Creates a SEPA Direct Debit client.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An instance of BTAPIClient

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initiates an ASWebAuthenticationSession to display a mandate to the user. Upon successful mandate creation, tokenizes the payment method and returns a result

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeWithSEPADirectDebitRequest:completion:)
+public func tokenize(
+    _ request: BTSEPADirectDebitRequest,
+    completion:  @escaping (BTSEPADirectDebitNonce?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    a BTSEPADebitRequest

    +
    +
    + + completion + + +
    +

    This completion will be invoked exactly once when tokenization is complete or an error occurs

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Initiates an ASWebAuthenticationSession to display a mandate to the user. Upon successful mandate creation, tokenizes the payment method and returns a result

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ request: BTSEPADirectDebitRequest) async throws -> BTSEPADirectDebitNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + +
    +

    a BTSEPADebitRequest

    +
    +
    +
    +
    +

    Return Value

    +

    A BTSEPADirectDebitNonce if successful

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTSEPADirectDebitNonce.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTSEPADirectDebitNonce.html new file mode 100644 index 0000000000..e76e8ba50c --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTSEPADirectDebitNonce.html @@ -0,0 +1,436 @@ + + + + BTSEPADirectDebitNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTSEPADirectDebitNonce Class Reference +

+ +
+ +
+ +
+
+

BTSEPADirectDebitNonce

+
+
+ + 
@objcMembers
+public class BTSEPADirectDebitNonce : BTPaymentMethodNonce
+ +
+
+

A payment method nonce representing a SEPA Direct Debit payment.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTSEPADirectDebitRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTSEPADirectDebitRequest.html new file mode 100644 index 0000000000..44212e774a --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTSEPADirectDebitRequest.html @@ -0,0 +1,642 @@ + + + + BTSEPADirectDebitRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTSEPADirectDebitRequest Class Reference +

+ +
+ +
+ +
+
+

BTSEPADirectDebitRequest

+
+
+ + 
@objcMembers
+public class BTSEPADirectDebitRequest : NSObject
+ +
+
+

Parameters for creating a SEPA Direct Debit tokenization request.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + accountHolderName + +
    +
    +
    +
    +
    +
    +

    Required. The account holder name.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountHolderName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + iban + +
    +
    +
    +
    +
    +
    +

    Required. The full IBAN.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var iban: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + customerID + +
    +
    +
    +
    +
    +
    +

    Required. The customer ID.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var customerID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + mandateType + +
    +
    +
    +
    +
    +
    +

    Optional. The BTSEPADebitMandateType. If not set, defaults to .oneOff

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mandateType: BTSEPADirectDebitMandateType?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    Required. The user’s billing address.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var billingAddress: BTPostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + merchantAccountID + +
    +
    +
    +
    +
    +
    +

    Optional. A non-default merchant account to use for tokenization.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var merchantAccountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a new SEPA Direct Debit request.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public init(
+    accountHolderName: String? = nil,
+    iban: String? = nil,
+    customerID: String? = nil,
+    mandateType: BTSEPADirectDebitMandateType? = .oneOff,
+    billingAddress: BTPostalAddress? = nil,
+    merchantAccountID: String? = nil
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + accountHolderName + + +
    +

    Required. The account holder name.

    +
    +
    + + iban + + +
    +

    Required. The full IBAN.

    +
    +
    + + customerID + + +
    +

    Required. The customer ID.

    +
    +
    + + mandateType + + +
    +

    Optional. The BTSEPADebitMandateType. If not set, defaults to .oneOff

    +
    +
    + + billingAddress + + +
    +

    Required. The user’s billing address.

    +
    +
    + + merchantAccountID + + +
    +

    Optional. A non-default merchant account to use for tokenization.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureAdditionalInformation.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureAdditionalInformation.html new file mode 100644 index 0000000000..e1276afb77 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureAdditionalInformation.html @@ -0,0 +1,1678 @@ + + + + BTThreeDSecureAdditionalInformation Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureAdditionalInformation Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureAdditionalInformation

+
+
+ + 
@objcMembers
+public class BTThreeDSecureAdditionalInformation : NSObject
+ +
+
+

Additional information for a 3DS lookup. Used in 3DS 2.0+ flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + shippingAddress + +
    +
    +
    +
    +
    +
    +

    Optional. The shipping address used for verification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingAddress: BTThreeDSecurePostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit string indicating the shipping method chosen for the transaction

    + +

    Possible Values:

    + +
      +
    • 01: Ship to cardholder billing address
      • +
    • 02: Ship to another verified address on file with merchant
      • +
    • 03: Ship to address that is different than billing address
      • +
    • 04: Ship to store (store address should be populated on request)
      • +
    • 05: Digital goods
      • +
    • 06: Travel and event tickets, not shipped
      • +
    • 07: Other
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingMethodIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + productCode + +
    +
    +
    +
    +
    +
    +

    Optional. The 3-letter string representing the merchant product code

    + +

    Possible Values:

    + +
      +
    • AIR: Airline
      • +
    • GEN: General Retail
      • +
    • DIG: Digital Goods
      • +
    • SVC: Services
      • +
    • RES: Restaurant
      • +
    • TRA: Travel
      • +
    • DSP: Cash Dispensing
      • +
    • REN: Car Rental
      • +
    • GAS: Fueld
      • +
    • LUX: Luxury Retail
      • +
    • ACC: Accommodation Retail
      • +
    • TBD: Other
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var productCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + deliveryTimeframe + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit number indicating the delivery timeframe

    + +

    Possible values:

    + +
      +
    • 01: Electronic delivery
      • +
    • 02: Same day shipping
      • +
    • 03: Overnight shipping
      • +
    • 04: Two or more day shipping
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var deliveryTimeframe: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + deliveryEmail + +
    +
    +
    +
    +
    +
    +

    Optional. For electronic delivery, email address to which the merchandise was delivered

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var deliveryEmail: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + reorderIndicator + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit number indicating whether the cardholder is reordering previously purchased merchandise

    + +

    Possible values:

    + +
      +
    • 01: First time ordered
      • +
    • 02: Reordered
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var reorderIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + preorderIndicator + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit number indicating whether the cardholder is placing an order with a future availability or release date

    + +

    Possible values:

    + +
      +
    • 01: Merchandise available
      • +
    • 02: Future availability
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var preorderIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + preorderDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating expected date that a pre-ordered purchase will be available

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var preorderDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + giftCardAmount + +
    +
    +
    +
    +
    +
    +

    Optional. The purchase amount total for prepaid gift cards in major units

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var giftCardAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + giftCardCurrencyCode + +
    +
    +
    +
    +
    +
    +

    Optional. ISO 4217 currency code for the gift card purchased

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var giftCardCurrencyCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + giftCardCount + +
    +
    +
    +
    +
    +
    +

    Optional. Total count of individual prepaid gift cards purchased

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var giftCardCount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountAgeIndicator + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit value representing the length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.

    + +

    Possible values:

    + +
      +
    • 01: Changed during transaction
      • +
    • 02: Less than 30 days
      • +
    • 03: 30-60 days
      • +
    • 04: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountAgeIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountCreateDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder’s account was last changed. +This includes changes to the billing or shipping address, new payment accounts or new users added.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountCreateDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit value representing the length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.

    + +

    Possible values:

    + +
      +
    • 01: Changed during transaction
      • +
    • 02: Less than 30 days
      • +
    • 03: 30-60 days
      • +
    • 04: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountChangeIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountChangeDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder’s account was last changed. +This includes changes to the billing or shipping address, new payment accounts or new users added.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountChangeDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit value representing the length of time since the cardholder changed or reset the password on the account.

    + +

    Possible values:

    + +
      +
    • 01: No change
      • +
    • 02: Changed during transaction
      • +
    • 03: Less than 30 days
      • +
    • 04: 30-60 days
      • +
    • 05: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountPwdChangeIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountPwdChangeDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder last changed or reset password on account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountPwdChangeDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit value indicating when the shipping address used for transaction was first used.

    + +

    Possible values:

    + +
      +
    • 01: This transaction
      • +
    • 02: Less than 30 days
      • +
    • 03: 30-60 days
      • +
    • 04: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingAddressUsageIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date when the shipping address used for this transaction was first used.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingAddressUsageDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + transactionCountDay + +
    +
    +
    +
    +
    +
    +

    Optional. Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transactionCountDay: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + transactionCountYear + +
    +
    +
    +
    +
    +
    +

    Optional. Number of transactions (successful or abandoned) for this cardholder account within the last year.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transactionCountYear: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + addCardAttempts + +
    +
    +
    +
    +
    +
    +

    Optional. Number of add card attempts in the last 24 hours.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addCardAttempts: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountPurchases + +
    +
    +
    +
    +
    +
    +

    Optional. Number of purchases with this cardholder account during the previous six months.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountPurchases: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + fraudActivity + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit value indicating whether the merchant experienced suspicious activity (including previous fraud) on the account.

    + +

    Possible values:

    + +
      +
    • 01: No suspicious activity
      • +
    • 02: Suspicious activity observed
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var fraudActivity: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingNameIndicator + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit value indicating if the cardholder name on the account is identical to the shipping name used for the transaction.

    + +

    Possible values:

    + +
      +
    • 01: Account name identical to shipping name
      • +
    • 02: Account name different than shipping name
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingNameIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit value indicating the length of time that the payment account was enrolled in the merchant account.

    + +

    Possible values:

    + +
      +
    • 01: No account (guest checkout)
      • +
    • 02: During the transaction
      • +
    • 03: Less than 30 days
      • +
    • 04: 30-60 days
      • +
    • 05: More than 60 days
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentAccountIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + paymentAccountAge + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date the payment account was added to the cardholder account.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentAccountAge: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + addressMatch + +
    +
    +
    +
    +
    +
    +

    Optional. The 1-character value (Y/N) indicating whether cardholder billing and shipping addresses match.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var addressMatch: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountID + +
    +
    +
    +
    +
    +
    +

    Optional. Additional cardholder account information.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ipAddress + +
    +
    +
    +
    +
    +
    +

    Optional. The IP address of the consumer. IPv4 and IPv6 are supported.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var ipAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + orderDescription + +
    +
    +
    +
    +
    +
    +

    Optional. Brief description of items purchased.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var orderDescription: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + taxAmount + +
    +
    +
    +
    +
    +
    +

    Optional. Unformatted tax amount without any decimalization (ie. $123.67 = 12367).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var taxAmount: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + userAgent + +
    +
    +
    +
    +
    +
    +

    Optional. The exact content of the HTTP user agent header.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var userAgent: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The 2-digit number indicating the type of authentication request.

    + +

    Possible values:

    + +
      +
    • 02: Recurring transaction
      • +
    • 03: Installment transaction
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationIndicator: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + installment + +
    +
    +
    +
    +
    +
    +

    Optional. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var installment: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + purchaseDate + +
    +
    +
    +
    +
    +
    +

    Optional. The 14-digit number (format: YYYYMMDDHHMMSS) indicating the date in UTC of original purchase.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var purchaseDate: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + recurringEnd + +
    +
    +
    +
    +
    +
    +

    Optional. The 8-digit number (format: YYYYMMDD) indicating the date after which no further recurring authorizations should be performed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var recurringEnd: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + recurringFrequency + +
    +
    +
    +
    +
    +
    +

    Optional. Integer value indicating the minimum number of days between recurring authorizations. +A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months (ex. 6 months = 168).

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var recurringFrequency: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sdkMaxTimeout + +
    +
    +
    +
    +
    +
    +

    Optional. The 2-digit number of minutes (minimum 05) to set the maximum amount of time for all 3DS 2.0 messages to be communicated between all components.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var sdkMaxTimeout: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + workPhoneNumber + +
    +
    +
    +
    +
    +
    +

    Optional. The work phone number used for verification. Only numbers; remove dashes, parenthesis and other characters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var workPhoneNumber: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureClient.html new file mode 100644 index 0000000000..acfcf9c666 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureClient.html @@ -0,0 +1,758 @@ + + + + BTThreeDSecureClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureClient Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureClient

+
+
+ + 
@objcMembers
+public class BTThreeDSecureClient : NSObject
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Initialize a new BTThreeDSecureClient instance.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Starts the 3DS flow using a BTThreeDSecureRequest.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func startPaymentFlow(_ request: BTThreeDSecureRequest, completion: @escaping (BTThreeDSecureResult?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    A BTThreeDSecureRequest request.

    +
    +
    + + completion + + +
    +

    This completion will be invoked exactly once when the 3DS flow is complete or an error occurs.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Creates a stringified JSON object containing the information necessary to perform a lookup.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(prepareLookup:completion:)
+public func prepareLookup(
+    _ request: BTThreeDSecureRequest,
+    completion: @escaping (String?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    The BTThreeDSecureRequest object where prepareLookup was called.

    +
    +
    + + completion + + +
    +

    This completion will be invoked exactly once with the client payload string or an error.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + prepareLookup(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Creates a stringified JSON object containing the information necessary to perform a lookup.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func prepareLookup(_ request: BTThreeDSecureRequest) async throws -> String
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + +
    +

    The BTThreeDSecureRequest object where prepareLookup was called.

    +
    +
    +
    +
    +

    Return Value

    +

    On success, you will receive a client payload string

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Initialize a challenge from a server side lookup call.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initializeChallengeWithLookupResponse:request:completion:)
+public func initializeChallenge(
+    lookupResponse: String,
+    request: BTThreeDSecureRequest,
+    completion: @escaping (BTThreeDSecureResult?, Error?) -> Void
+)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + lookupResponse + + +
    +

    The JSON string returned by the server side lookup.

    +
    +
    + + request + + +
    +

    The BTThreeDSecureRequest object where prepareLookup was called.

    +
    +
    + + completion + + +
    +

    This completion will be invoked exactly once when the payment flow is complete or an error occurs.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + initializeChallenge(lookupResponse:request:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Initialize a challenge from a server side lookup call.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func initializeChallenge(
+    lookupResponse: String,
+    request: BTThreeDSecureRequest
+) async throws -> BTThreeDSecureResult
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + lookupResponse + + +
    +

    The JSON string returned by the server side lookup.

    +
    +
    + + request + + +
    +

    The BTThreeDSecureRequest object where prepareLookup was called.

    +
    +
    +
    +
    +

    Return Value

    +

    On success, you will receive an instance of BTThreeDSecureResult

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureInfo.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureInfo.html new file mode 100644 index 0000000000..bb5366dc0d --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureInfo.html @@ -0,0 +1,913 @@ + + + + BTThreeDSecureInfo Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureInfo Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureInfo

+
+
+ + 
@objcMembers
+public class BTThreeDSecureInfo : NSObject
+ +
+
+

Contains information about the 3D Secure status of a payment method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + acsTransactionID + +
    +
    +
    +
    +
    +
    +

    Unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var acsTransactionID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    On authentication, the transaction status result identifier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationTransactionStatus: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    On authentication, provides additional information as to why the transaction status has the specific value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var authenticationTransactionStatusReason: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cavv + +
    +
    +
    +
    +
    +
    +

    Cardholder authentication verification value or “CAVV” is the main encrypted message issuers and card networks use to verify authentication has occured. +Mastercard uses an “AVV” message which will also be returned in the cavv parameter.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cavv: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + dsTransactionID + +
    +
    +
    +
    +
    +
    +

    Directory Server Transaction ID is an ID used by the card brand’s 3DS directory server.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dsTransactionID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + eciFlag + +
    +
    +
    +
    +
    +
    +

    The ecommerce indicator flag indicates the outcome of the 3DS authentication. +Possible values are 00, 01, and 02 for Mastercard 05, 06, and 07 for all other cardbrands.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var eciFlag: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + enrolled + +
    +
    +
    +
    +
    +
    +

    Indicates whether a card is enrolled in a 3D Secure program or not. Possible values:

    + +
      +
    • Y = Yes
      • +
    • N = No
      • +
    • U = Unavailable
      • +
    • B = Bypass
      • +
    • E = RequestFailure
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var enrolled: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + liabilityShifted + +
    +
    +
    +
    +
    +
    +

    If the 3D Secure liability shift has occurred.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var liabilityShifted: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    If the 3D Secure liability shift is possible.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var liabilityShiftPossible: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    On lookup, the transaction status result identifier.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lookupTransactionStatus: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    On lookup, provides additional information as to why the transaction status has the specific value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lookupTransactionStatusReason: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + paresStatus + +
    +
    +
    +
    +
    +
    +

    The Payer Authentication Response (PARes) Status, a transaction status result identifier. Possible Values:

    + +
      +
    • Y – Successful Authentication
      • +
    • N – Failed Authentication
      • +
    • U – Unable to Complete Authentication
      • +
    • A– Successful Stand-In Attempts Transaction
      • +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paresStatus: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + status + +
    +
    +
    +
    +
    +
    +

    The 3D Secure status value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var status: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unique identifier assigned to the 3D Secure authentication performed for this transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureAuthenticationID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Unique transaction identifier assigned by the 3DS Server to identify a single transaction.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureServerTransactionID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + threeDSecureVersion + +
    +
    +
    +
    +
    +
    +

    The 3DS version used in the authentication, example “1.0.2” or “2.1.0”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureVersion: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + wasVerified + +
    +
    +
    +
    +
    +
    +

    Indicates if the 3D Secure lookup was performed.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var wasVerified: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + xid + +
    +
    +
    +
    +
    +
    +

    Transaction identifier resulting from 3D Secure authentication. Uniquely identifies the transaction and sometimes required in the authorization message. +This field will no longer be used in 3DS 2 authentications.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var xid: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureLookup.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureLookup.html new file mode 100644 index 0000000000..16d7fb7d74 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureLookup.html @@ -0,0 +1,597 @@ + + + + BTThreeDSecureLookup Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureLookup Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureLookup

+
+
+ + 
@objcMembers
+public class BTThreeDSecureLookup : NSObject
+ +
+
+

The result of a 3DS lookup. +Contains liability shift and challenge information.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + paReq + +
    +
    +
    +
    +
    +
    +

    The “PAReq” or “Payment Authentication Request” is the encoded request message used to initiate authentication.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paReq: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + md + +
    +
    +
    +
    +
    +
    +

    The unique 3DS identifier assigned by Braintree to track the 3DS call as it progresses.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var md: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + acsURL + +
    +
    +
    +
    +
    +
    +

    The URL which the customer will be redirected to for a 3DS Interface. +In 3DS 2, the presence of an acsURL indicates there is a challenge as it would otherwise frictionlessly complete without an acsURL.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var acsURL: URL?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + termURL + +
    +
    +
    +
    +
    +
    +

    The termURL is the fully qualified URL that the customer will be redirected to once the authentication completes.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var termURL: URL?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + threeDSecureVersion + +
    +
    +
    +
    +
    +
    +

    The full version string of the 3DS lookup result.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var threeDSecureVersion: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Indicates a 3DS 2 lookup result.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var isThreeDSecureVersion2: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + transactionID + +
    +
    +
    +
    +
    +
    +

    This a secondary unique 3DS identifier assigned by Braintree to track the 3DS call as it progresses.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var transactionID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Indicates that a 3DS challenge is required.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var requiresUserAuthentication: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecurePostalAddress.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecurePostalAddress.html new file mode 100644 index 0000000000..fddad5d70a --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecurePostalAddress.html @@ -0,0 +1,704 @@ + + + + BTThreeDSecurePostalAddress Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecurePostalAddress Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecurePostalAddress

+
+
+ + 
@objcMembers
+public class BTThreeDSecurePostalAddress : NSObject
+
extension BTThreeDSecurePostalAddress: NSCopying
+ +
+
+

Postal address for 3D Secure flows

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + givenName + +
    +
    +
    +
    +
    +
    +

    Optional. Given name associated with the address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var givenName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + surname + +
    +
    +
    +
    +
    +
    +

    Optional. Surname associated with the address

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var surname: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + streetAddress + +
    +
    +
    +
    +
    +
    +

    Optional. Line 1 of the Address (eg. number, street, etc)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var streetAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + extendedAddress + +
    +
    +
    +
    +
    +
    +

    Optional. Line 2 of the Address (eg. suite, apt #, etc.)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var extendedAddress: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + line3 + +
    +
    +
    +
    +
    +
    +

    Optional. Line 3 of the Address (eg. suite, apt #, etc.)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var line3: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + locality + +
    +
    +
    +
    +
    +
    +

    Optional. City name

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var locality: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + region + +
    +
    +
    +
    +
    +
    +

    Optional. Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var region: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + postalCode + +
    +
    +
    +
    +
    +
    +

    Optional. Zip code or equivalent is usually required for countries that have them. +For a list of countries that do not have postal codes please refer to http://en.wikipedia.org/wiki/Postal_code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var postalCode: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + countryCodeAlpha2 + +
    +
    +
    +
    +
    +
    +

    Optional. 2 letter country code

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var countryCodeAlpha2: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    Optional. The phone number associated with the address

    +
    +

    Note

    + Only numbers. Remove dashes, parentheses and other characters + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

NSCopying Protocol Conformance +

+
+
+
    +
  • +
    + + + + copy(with:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func copy(with zone: NSZone? = nil) -> Any
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureRequest.html new file mode 100644 index 0000000000..e6c1d8af6a --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureRequest.html @@ -0,0 +1,824 @@ + + + + BTThreeDSecureRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureRequest Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureRequest

+
+
+ + 
@objcMembers
+public class BTThreeDSecureRequest : NSObject
+ +
+
+

Used to initialize a 3D Secure payment flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + nonce + +
    +
    +
    +
    +
    +
    +

    A nonce to be verified by ThreeDSecure

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var nonce: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + amount + +
    +
    +
    +
    +
    +
    +

    The amount for the transaction

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var amount: NSDecimalNumber?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + accountType + +
    +
    +
    +
    +
    +
    +

    Optional. The account type selected by the cardholder

    +
    +

    Note

    + Some cards can be processed using either a credit or debit account and cardholders have the option to choose which account to use. + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var accountType: BTThreeDSecureAccountType
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billingAddress + +
    +
    +
    +
    +
    +
    +

    Optional. The billing address used for verification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var billingAddress: BTThreeDSecurePostalAddress?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + mobilePhoneNumber + +
    +
    +
    +
    +
    +
    +

    Optional. The mobile phone number used for verification

    +
    +

    Note

    + Only numbers. Remove dashes, parentheses and other characters + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var mobilePhoneNumber: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    Optional. The email used for verification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shippingMethod + +
    +
    +
    +
    +
    +
    +

    Optional. The shipping method chosen for the transaction

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var shippingMethod: BTThreeDSecureShippingMethod
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + additionalInformation + +
    +
    +
    +
    +
    +
    +

    Optional. The additional information used for verification

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var additionalInformation: BTThreeDSecureAdditionalInformation?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + challengeRequested + +
    +
    +
    +
    +
    +
    +

    Optional. If set to true, an authentication challenge will be forced if possible.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var challengeRequested: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + exemptionRequested + +
    +
    +
    +
    +
    +
    +

    Optional. If set to true, an exemption to the authentication challenge will be requested.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var exemptionRequested: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Optional. The exemption type to be requested. If an exemption is requested and the exemption’s conditions are satisfied, then it will be applied.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var requestedExemptionType: BTThreeDSecureRequestedExemptionType
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + dataOnlyRequested + +
    +
    +
    +
    +
    +
    +

    Optional. Indicates whether to use the data only flow. In this flow, frictionless 3DS is ensured for Mastercard cardholders as the card scheme provides a risk score +for the issuer to determine whether to approve. If data only is not supported by the processor, a validation error will be raised. +Non-Mastercard cardholders will fallback to a normal 3DS flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var dataOnlyRequested: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cardAddChallenge + +
    +
    +
    +
    +
    +
    +

    Optional. An authentication created using this property should only be used for adding a payment method to the merchant’s vault and not for creating transactions.

    + +

    Defaults to .unspecified.

    + +

    If set to .challengeRequested, the authentication challenge will be requested from the issuer to confirm adding new card to the merchant’s vault. +If set to .notRequested the authentication challenge will not be requested from the issuer. +If set to .unspecified, when the amount is 0, the authentication challenge will be requested from the issuer. +If set to .unspecified, when the amount is greater than 0, the authentication challenge will not be requested from the issuer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cardAddChallenge: BTThreeDSecureCardAddChallenge
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + v2UICustomization + +
    +
    +
    +
    +
    +
    +

    Optional. UI Customization for 3DS2 challenge views.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var v2UICustomization: BTThreeDSecureV2UICustomization?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    A delegate for receiving information about the ThreeDSecure payment flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public weak var threeDSecureRequestDelegate: BTThreeDSecureRequestDelegate?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureResult.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureResult.html new file mode 100644 index 0000000000..76ee992ae1 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureResult.html @@ -0,0 +1,445 @@ + + + + BTThreeDSecureResult Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureResult Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureResult

+
+
+ + 
@objcMembers
+public class BTThreeDSecureResult : NSObject
+ +
+
+

The result of a 3D Secure payment flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + tokenizedCard + +
    +
    +
    +
    +
    +
    +

    The BTCardNonce resulting from the 3D Secure flow

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var tokenizedCard: BTCardNonce?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lookup + +
    +
    +
    +
    +
    +
    +

    The result of a 3D Secure lookup. Contains liability shift and challenge information.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lookup: BTThreeDSecureLookup?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + errorMessage + +
    +
    +
    +
    +
    +
    +

    The error message when the 3D Secure flow is unsuccessful

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var errorMessage: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2BaseCustomization.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2BaseCustomization.html new file mode 100644 index 0000000000..e70dba50f4 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2BaseCustomization.html @@ -0,0 +1,445 @@ + + + + BTThreeDSecureV2BaseCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2BaseCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2BaseCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2BaseCustomization : NSObject
+ +
+
+

Base customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + textFontName + +
    +
    +
    +
    +
    +
    +

    Font type for the UI element.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var textFontName: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + textColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var textColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + textFontSize + +
    +
    +
    +
    +
    +
    +

    Font size for the UI element.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var textFontSize: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2ButtonCustomization.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2ButtonCustomization.html new file mode 100644 index 0000000000..51c8df58b5 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2ButtonCustomization.html @@ -0,0 +1,457 @@ + + + + BTThreeDSecureV2ButtonCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2ButtonCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2ButtonCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2ButtonCustomization : BTThreeDSecureV2BaseCustomization
+ +
+
+

Button customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + backgroundColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var backgroundColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cornerRadius + +
    +
    +
    +
    +
    +
    +

    Radius (integer value) for the button corners.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cornerRadius: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2LabelCustomization.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2LabelCustomization.html new file mode 100644 index 0000000000..b8a3dbc669 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2LabelCustomization.html @@ -0,0 +1,487 @@ + + + + BTThreeDSecureV2LabelCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2LabelCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2LabelCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2LabelCustomization : BTThreeDSecureV2BaseCustomization
+ +
+
+

Label customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + headingTextColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var headingTextColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + headingTextFontName + +
    +
    +
    +
    +
    +
    +

    Font type for the heading label text.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var headingTextFontName: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + headingTextFontSize + +
    +
    +
    +
    +
    +
    +

    Font size for the heading label text.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var headingTextFontSize: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2TextBoxCustomization.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2TextBoxCustomization.html new file mode 100644 index 0000000000..9c729aee99 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2TextBoxCustomization.html @@ -0,0 +1,487 @@ + + + + BTThreeDSecureV2TextBoxCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2TextBoxCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2TextBoxCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2TextBoxCustomization : BTThreeDSecureV2BaseCustomization
+ +
+
+

Text box customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + borderWidth + +
    +
    +
    +
    +
    +
    +

    Width (integer value) of the text box border.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var borderWidth: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + borderColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var borderColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cornerRadius + +
    +
    +
    +
    +
    +
    +

    Radius (integer value) for the text box corners.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var cornerRadius: Int { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2ToolbarCustomization.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2ToolbarCustomization.html new file mode 100644 index 0000000000..fc78f15988 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2ToolbarCustomization.html @@ -0,0 +1,487 @@ + + + + BTThreeDSecureV2ToolbarCustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2ToolbarCustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2ToolbarCustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2ToolbarCustomization : BTThreeDSecureV2BaseCustomization
+ +
+
+

Toolbar customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + backgroundColor + +
    +
    +
    +
    +
    +
    +

    Color code in Hex format. For example, the color code can be “#999999”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var backgroundColor: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + headerText + +
    +
    +
    +
    +
    +
    +

    Text for the header.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var headerText: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + buttonText + +
    +
    +
    +
    +
    +
    +

    Text for the button. For example, “Cancel”.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var buttonText: String? { get set }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init() + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override init()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2UICustomization.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2UICustomization.html new file mode 100644 index 0000000000..edccc2170e --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTThreeDSecureV2UICustomization.html @@ -0,0 +1,520 @@ + + + + BTThreeDSecureV2UICustomization Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2UICustomization Class Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2UICustomization

+
+
+ + 
@objcMembers
+public class BTThreeDSecureV2UICustomization : NSObject
+ +
+
+

UI customization options for 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+ +
+
+
+ + +
+ +

Public Methods +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTURLUtils.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTURLUtils.html new file mode 100644 index 0000000000..8242bef391 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTURLUtils.html @@ -0,0 +1,435 @@ + + + + BTURLUtils Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTURLUtils Class Reference +

+ +
+ +
+ +
+
+

BTURLUtils

+
+
+ + 
@objc
+public class BTURLUtils : NSObject
+ +
+
+

A helper class for converting URL queries to and from dictionaries

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + queryString(from:) + +
    +
    +
    +
    +
    +
    +

    Converts a key/value dictionary to a valid query string

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(queryStringWithDictionary:)
+public static func queryString(from dict: NSDictionary) -> String
    + +
    +
    +
    +

    Return Value

    +

    A URL encoded query string

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + queryParameters(for:) + +
    +
    +
    +
    +
    +
    +

    Extract query parameters from a URL

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(queryParametersForURL:)
+public static func queryParameters(for url: URL) -> [String : String]
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + url + + +
    +

    URL to parse query paramters from

    +
    +
    +
    +
    +

    Return Value

    +

    Query parameters from the URL in a key/value dictionary

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTVenmoAccountNonce.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTVenmoAccountNonce.html new file mode 100644 index 0000000000..341b8d2648 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTVenmoAccountNonce.html @@ -0,0 +1,535 @@ + + + + BTVenmoAccountNonce Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTVenmoAccountNonce Class Reference +

+ +
+ +
+ +
+
+

BTVenmoAccountNonce

+
+
+ + 
@objcMembers
+public class BTVenmoAccountNonce : BTPaymentMethodNonce
+ +
+
+

Contains information about a Venmo Account payment method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + email + +
    +
    +
    +
    +
    +
    +

    The email associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var email: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + externalID + +
    +
    +
    +
    +
    +
    +

    The external ID associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var externalID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + firstName + +
    +
    +
    +
    +
    +
    +

    The first name associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var firstName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lastName + +
    +
    +
    +
    +
    +
    +

    The last name associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var lastName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + phoneNumber + +
    +
    +
    +
    +
    +
    +

    The phone number associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var phoneNumber: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + username + +
    +
    +
    +
    +
    +
    +

    The username associated with the Venmo account

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var username: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTVenmoClient.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTVenmoClient.html new file mode 100644 index 0000000000..b1ff8873a1 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTVenmoClient.html @@ -0,0 +1,605 @@ + + + + BTVenmoClient Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTVenmoClient Class Reference +

+ +
+ +
+ +
+
+

BTVenmoClient

+
+
+ + 
@objc
+public class BTVenmoClient : NSObject
+
extension BTVenmoClient: BTAppContextSwitchClient
+ +
+
+

Used to process Venmo payments

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Initializer +

+
+
+
    +
  • +
    + + + + init(apiClient:) + +
    +
    +
    +
    +
    +
    +

    Creates an Apple Pay client

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(initWithAPIClient:)
+public init(apiClient: BTAPIClient)
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + apiClient + + +
    +

    An API client

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Public Methods +

+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc(tokenizeWithVenmoRequest:completion:)
+public func tokenize(_ request: BTVenmoRequest, completion: @escaping (BTVenmoAccountNonce?, Error?) -> Void)
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + +
    + + request + + +
    +

    A Venmo request.

    +
    +
    + + completion + + +
    +

    This completion will be invoked when app switch is complete or an error occurs. On success, you will receive +an instance of BTVenmoAccountNonce; on failure, an error; on user cancellation, you will receive nil for both parameters.

    +
    +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tokenize(_:) + + + Asynchronous + +
    +
    +
    +
    +
    +
    +

    Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.

    +
    +

    Throws

    + An Error describing the failure + +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func tokenize(_ request: BTVenmoRequest) async throws -> BTVenmoAccountNonce
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + request + + + +
    +
    +
    +

    Return Value

    +

    On success, you will receive an instance of BTVenmoAccountNonce

    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + isVenmoAppInstalled() + +
    +
    +
    +
    +
    +
    +

    Returns true if the proper Venmo app is installed and configured correctly, returns false otherwise.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func isVenmoAppInstalled() -> Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Switches to the App Store to download the Venmo application.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public func openVenmoAppPageInAppStore()
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTVenmoRequest.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTVenmoRequest.html new file mode 100644 index 0000000000..7163affd5a --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Classes/BTVenmoRequest.html @@ -0,0 +1,544 @@ + + + + BTVenmoRequest Class Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTVenmoRequest Class Reference +

+ +
+ +
+ +
+
+

BTVenmoRequest

+
+
+ + 
@objcMembers
+public class BTVenmoRequest : NSObject
+ +
+
+

A BTVenmoRequest specifies options that contribute to the Venmo flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
+ + +
+ +

Public Properties +

+
+
+
    +
  • +
    + + + + profileID + +
    +
    +
    +
    +
    +
    +

    Optional. The Venmo profile ID to be used during payment authorization. Customers will see the business name and logo associated with this Venmo profile, and it may show up in the +Venmo app as a “Connected Merchant”. Venmo profile IDs can be found in the Braintree Control Panel. Leaving this nil will use the default Venmo profile.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var profileID: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + vault + +
    +
    +
    +
    +
    +
    +

    Whether to automatically vault the Venmo account on the client. For client-side vaulting, you must initialize BTAPIClient with a client token that was created with a customer ID. +Also, paymentMethodUsage on the BTVenmoRequest must be set to .multiUse.

    + +

    If this property is set to false, you can still vault the Venmo account on your server, provided that paymentMethodUsage is not set to .singleUse. +Defaults to false

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var vault: Bool
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + paymentMethodUsage + +
    +
    +
    +
    +
    +
    +

    If set to .multiUse, the Venmo payment will be authorized for future payments and can be vaulted. + If set to .singleUse, the Venmo payment will be authorized for a one-time payment and cannot be vaulted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var paymentMethodUsage: BTVenmoPaymentMethodUsage
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + displayName + +
    +
    +
    +
    +
    +
    +

    Optional. The business name that will be displayed in the Venmo app payment approval screen. Only used by merchants onboarded as PayFast channel partners.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var displayName: String?
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ + +
+ +

Initializer +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums.html new file mode 100644 index 0000000000..04b1d658e8 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums.html @@ -0,0 +1,894 @@ + + + + Enumerations Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Enumerations Reference +

+ +
+ +
+ +
+
+

Enumerations

+

The following enumerations are available globally.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + BTCardNetwork + +
    +
    +
    +
    +
    +
    +

    Card type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTCardNetwork : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Integration Types

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTClientMetadataIntegration : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Source of the metadata

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTClientMetadataSource : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTLogLevel + +
    +
    +
    +
    +
    +
    +

    Log level used to add formatted string to NSLog

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTLogLevel : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Mandate type for the SEPA Direct Debit request.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTSEPADirectDebitMandateType : Int, CustomStringConvertible
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The account type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureAccountType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The card add challenge request

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureCardAddChallenge : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    3D Secure requested exemption type

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureRequestedExemptionType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The shipping method

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureShippingMethod : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Button types that can be customized in 3D Secure 2 flows.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTThreeDSecureV2ButtonType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalRequestIntent + +
    +
    +
    +
    +
    +
    +

    Payment intent.

    +
    +

    Note

    + Must be set to BTPayPalRequestIntentSale for immediate payment, .authorize to authorize a payment for capture later, or .order to create an order. Defaults to .authorize. Only applies to PayPal Checkout. + +
    + +

    Capture payments later reference

    + +

    Create and process orders reference

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalRequestIntent : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    The call-to-action in the PayPal Checkout flow.

    +
    +

    Note

    + By default the final button will show the localized word for “Continue” and implies that the final amount billed is not yet known. +Setting the BTPayPalRequest’s userAction to .payNow changes the button text to “Pay Now”, conveying to +the user that billing will take place immediately. + +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalRequestUserAction : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalLineItemKind + +
    +
    +
    +
    +
    +
    +

    Use this option to specify whether a line item is a debit (sale) or credit (refund) to the customer.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalLineItemKind : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalLocaleCode + +
    +
    +
    +
    +
    +
    +

    A locale code to use for a transaction.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalLocaleCode : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + BTPayPalPaymentType + +
    +
    +
    +
    +
    +
    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalPaymentType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Use this option to specify the PayPal page to display when a user lands on the PayPal site to complete the payment.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTPayPalRequestLandingPageType : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Usage type for the tokenized Venmo account

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+public enum BTVenmoPaymentMethodUsage : Int
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTCardNetwork.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTCardNetwork.html new file mode 100644 index 0000000000..5702224ab5 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTCardNetwork.html @@ -0,0 +1,796 @@ + + + + BTCardNetwork Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTCardNetwork Enumeration Reference +

+ +
+ +
+ +
+
+

BTCardNetwork

+
+
+ + 
@objc
+public enum BTCardNetwork : Int
+ +
+
+

Card type

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    +

    Unknown card

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unknown
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + AMEX + +
    +
    +
    +
    +
    +
    +

    American Express

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case AMEX
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + dinersClub + +
    +
    +
    +
    +
    +
    +

    Diners Club

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dinersClub
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + discover + +
    +
    +
    +
    +
    +
    +

    Discover

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case discover
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + masterCard + +
    +
    +
    +
    +
    +
    +

    Mastercard

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case masterCard
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + visa + +
    +
    +
    +
    +
    +
    +

    Visa

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case visa
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + JCB + +
    +
    +
    +
    +
    +
    +

    JCB

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case JCB
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + laser + +
    +
    +
    +
    +
    +
    +

    Laser

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case laser
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + maestro + +
    +
    +
    +
    +
    +
    +

    Maestro

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case maestro
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + unionPay + +
    +
    +
    +
    +
    +
    +

    Union Pay

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unionPay
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + hiper + +
    +
    +
    +
    +
    +
    +

    Hiper

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case hiper
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + hipercard + +
    +
    +
    +
    +
    +
    +

    Hipercard

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case hipercard
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + solo + +
    +
    +
    +
    +
    +
    +

    Solo

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case solo
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + switch + +
    +
    +
    +
    +
    +
    +

    Switch

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case `switch`
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ukMaestro + +
    +
    +
    +
    +
    +
    +

    UK Maestro

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ukMaestro
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTClientMetadataIntegration.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTClientMetadataIntegration.html new file mode 100644 index 0000000000..5c876658a8 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTClientMetadataIntegration.html @@ -0,0 +1,406 @@ + + + + BTClientMetadataIntegration Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTClientMetadataIntegration Enumeration Reference +

+ +
+ +
+ +
+
+

BTClientMetadataIntegration

+
+
+ + 
@objc
+public enum BTClientMetadataIntegration : Int
+ +
+
+

Integration Types

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + custom + +
    +
    +
    +
    +
    +
    +

    Custom

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case custom
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + dropIn + +
    +
    +
    +
    +
    +
    +

    Drop-in

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case dropIn
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTClientMetadataSource.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTClientMetadataSource.html new file mode 100644 index 0000000000..48b111a1e0 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTClientMetadataSource.html @@ -0,0 +1,496 @@ + + + + BTClientMetadataSource Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTClientMetadataSource Enumeration Reference +

+ +
+ +
+ +
+
+

BTClientMetadataSource

+
+
+ + 
@objc
+public enum BTClientMetadataSource : Int
+ +
+
+

Source of the metadata

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unknown + +
    +
    +
    +
    +
    +
    +

    Unknown source

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unknown
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payPalApp + +
    +
    +
    +
    +
    +
    +

    PayPal app

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payPalApp
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payPalBrowser + +
    +
    +
    +
    +
    +
    +

    PayPal browser

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payPalBrowser
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + venmoApp + +
    +
    +
    +
    +
    +
    +

    Venmo app

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case venmoApp
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + form + +
    +
    +
    +
    +
    +
    +

    Form

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case form
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTLogLevel.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTLogLevel.html new file mode 100644 index 0000000000..d8846381c9 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTLogLevel.html @@ -0,0 +1,496 @@ + + + + BTLogLevel Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLogLevel Enumeration Reference +

+ +
+ +
+ +
+
+

BTLogLevel

+
+
+ + 
@objc
+public enum BTLogLevel : Int
+ +
+
+

Log level used to add formatted string to NSLog

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + critical + +
    +
    +
    +
    +
    +
    +

    Only log critical issues (e.g. irrecoverable errors)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case critical
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + error + +
    +
    +
    +
    +
    +
    +

    Log errors (e.g. expected or recoverable errors)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case error
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + warning + +
    +
    +
    +
    +
    +
    +

    Log warnings (e.g. use of pre-release features)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case warning
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + info + +
    +
    +
    +
    +
    +
    +

    Log basic information (e.g. state changes, network activity)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case info
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + debug + +
    +
    +
    +
    +
    +
    +

    Log debugging statements (anything and everything)

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case debug
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalLineItemKind.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalLineItemKind.html new file mode 100644 index 0000000000..af6ecbecd7 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalLineItemKind.html @@ -0,0 +1,406 @@ + + + + BTPayPalLineItemKind Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalLineItemKind Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalLineItemKind

+
+
+ + 
@objc
+public enum BTPayPalLineItemKind : Int
+ +
+
+

Use this option to specify whether a line item is a debit (sale) or credit (refund) to the customer.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + debit + +
    +
    +
    +
    +
    +
    +

    Debit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case debit
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + credit + +
    +
    +
    +
    +
    +
    +

    Credit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case credit
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalLocaleCode.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalLocaleCode.html new file mode 100644 index 0000000000..89f3c16c35 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalLocaleCode.html @@ -0,0 +1,1158 @@ + + + + BTPayPalLocaleCode Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalLocaleCode Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalLocaleCode

+
+
+ + 
@objc
+public enum BTPayPalLocaleCode : Int
+ +
+
+

A locale code to use for a transaction.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case none
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + da_DK + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case da_DK
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + de_DE + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case de_DE
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + en_AU + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case en_AU
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + en_GB + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case en_GB
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + en_US + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case en_US
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + es_ES + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case es_ES
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + es_XC + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case es_XC
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + fr_CA + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fr_CA
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + fr_FR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fr_FR
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + fr_XC + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case fr_XC
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + id_ID + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case id_ID
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + it_IT + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case it_IT
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ja_JP + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ja_JP
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ko_KR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ko_KR
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + nl_NL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case nl_NL
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + no_NO + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case no_NO
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + pl_PL + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pl_PL
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + pt_BR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pt_BR
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + pt_PT + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case pt_PT
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ru_RU + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ru_RU
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sv_SE + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case sv_SE
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + th_TH + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case th_TH
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + tr_TR + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case tr_TR
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + zh_CN + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case zh_CN
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + zh_HK + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case zh_HK
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + zh_TW + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case zh_TW
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + zh_XC + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case zh_XC
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalPaymentType.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalPaymentType.html new file mode 100644 index 0000000000..8297bcb516 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalPaymentType.html @@ -0,0 +1,405 @@ + + + + BTPayPalPaymentType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalPaymentType Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalPaymentType

+
+
+ + 
@objc
+public enum BTPayPalPaymentType : Int
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + checkout + +
    +
    +
    +
    +
    +
    +

    Checkout

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case checkout
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + vault + +
    +
    +
    +
    +
    +
    +

    Vault

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case vault
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalRequestIntent.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalRequestIntent.html new file mode 100644 index 0000000000..e2b0e24de6 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalRequestIntent.html @@ -0,0 +1,474 @@ + + + + BTPayPalRequestIntent Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalRequestIntent Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalRequestIntent

+
+
+ + 
@objc
+public enum BTPayPalRequestIntent : Int
+ +
+
+

Payment intent.

+
+

Note

+ Must be set to BTPayPalRequestIntentSale for immediate payment, .authorize to authorize a payment for capture later, or .order to create an order. Defaults to .authorize. Only applies to PayPal Checkout. + +
+ +

Capture payments later reference

+ +

Create and process orders reference

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + authorize + +
    +
    +
    +
    +
    +
    +

    Authorize

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case authorize
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sale + +
    +
    +
    +
    +
    +
    +

    Sale

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case sale
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + order + +
    +
    +
    +
    +
    +
    +

    Order

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case order
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + stringValue + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var stringValue: String { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalRequestLandingPageType.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalRequestLandingPageType.html new file mode 100644 index 0000000000..a63ea5ba6a --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalRequestLandingPageType.html @@ -0,0 +1,436 @@ + + + + BTPayPalRequestLandingPageType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalRequestLandingPageType Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalRequestLandingPageType

+
+
+ + 
@objc
+public enum BTPayPalRequestLandingPageType : Int
+ +
+
+

Use this option to specify the PayPal page to display when a user lands on the PayPal site to complete the payment.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    +

    Default

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case none
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + login + +
    +
    +
    +
    +
    +
    +

    Login

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case login
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + billing + +
    +
    +
    +
    +
    +
    +

    Billing

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case billing
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalRequestUserAction.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalRequestUserAction.html new file mode 100644 index 0000000000..b6dc8c8c79 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTPayPalRequestUserAction.html @@ -0,0 +1,413 @@ + + + + BTPayPalRequestUserAction Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTPayPalRequestUserAction Enumeration Reference +

+ +
+ +
+ +
+
+

BTPayPalRequestUserAction

+
+
+ + 
@objc
+public enum BTPayPalRequestUserAction : Int
+ +
+
+

The call-to-action in the PayPal Checkout flow.

+
+

Note

+ By default the final button will show the localized word for “Continue” and implies that the final amount billed is not yet known. +Setting the BTPayPalRequest’s userAction to .payNow changes the button text to “Pay Now”, conveying to +the user that billing will take place immediately. + +
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + none + +
    +
    +
    +
    +
    +
    +

    Default

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case none
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + payNow + +
    +
    +
    +
    +
    +
    +

    Pay Now

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case payNow
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTSEPADirectDebitMandateType.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTSEPADirectDebitMandateType.html new file mode 100644 index 0000000000..2a08ee7794 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTSEPADirectDebitMandateType.html @@ -0,0 +1,433 @@ + + + + BTSEPADirectDebitMandateType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTSEPADirectDebitMandateType Enumeration Reference +

+ +
+ +
+ +
+
+

BTSEPADirectDebitMandateType

+
+
+ + 
@objc
+public enum BTSEPADirectDebitMandateType : Int, CustomStringConvertible
+ +
+
+

Mandate type for the SEPA Direct Debit request.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + oneOff + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case oneOff
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + recurrent + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case recurrent
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + description + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public var description: String { get }
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureAccountType.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureAccountType.html new file mode 100644 index 0000000000..4bcfa584d7 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureAccountType.html @@ -0,0 +1,436 @@ + + + + BTThreeDSecureAccountType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureAccountType Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureAccountType

+
+
+ + 
@objc
+public enum BTThreeDSecureAccountType : Int
+ +
+
+

The account type

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unspecified + +
    +
    +
    +
    +
    +
    +

    Unspecified

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unspecified
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + credit + +
    +
    +
    +
    +
    +
    +

    Credit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case credit
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + debit + +
    +
    +
    +
    +
    +
    +

    Debit

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case debit
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureCardAddChallenge.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureCardAddChallenge.html new file mode 100644 index 0000000000..15be0b2557 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureCardAddChallenge.html @@ -0,0 +1,436 @@ + + + + BTThreeDSecureCardAddChallenge Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureCardAddChallenge Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureCardAddChallenge

+
+
+ + 
@objc
+public enum BTThreeDSecureCardAddChallenge : Int
+ +
+
+

The card add challenge request

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unspecified + +
    +
    +
    +
    +
    +
    +

    Unspecified

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unspecified
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + requested + +
    +
    +
    +
    +
    +
    +

    Requested

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case requested
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + notRequested + +
    +
    +
    +
    +
    +
    +

    Not Requested

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case notRequested
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureRequestedExemptionType.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureRequestedExemptionType.html new file mode 100644 index 0000000000..2a947502a0 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureRequestedExemptionType.html @@ -0,0 +1,496 @@ + + + + BTThreeDSecureRequestedExemptionType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureRequestedExemptionType Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureRequestedExemptionType

+
+
+ + 
@objc
+public enum BTThreeDSecureRequestedExemptionType : Int
+ +
+
+

3D Secure requested exemption type

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unspecified + +
    +
    +
    +
    +
    +
    +

    Unspecified

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unspecified
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + lowValue + +
    +
    +
    +
    +
    +
    +

    Low value

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case lowValue
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + secureCorporate + +
    +
    +
    +
    +
    +
    +

    Secure corporate

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case secureCorporate
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + trustedBeneficiary + +
    +
    +
    +
    +
    +
    +

    Trusted beneficiary

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case trustedBeneficiary
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • + +
    +
    +
    +
    +
    +

    Transaction risk analysis

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case transactionRiskAnalysis
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureShippingMethod.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureShippingMethod.html new file mode 100644 index 0000000000..9e4e133d00 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureShippingMethod.html @@ -0,0 +1,556 @@ + + + + BTThreeDSecureShippingMethod Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureShippingMethod Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureShippingMethod

+
+
+ + 
@objc
+public enum BTThreeDSecureShippingMethod : Int
+ +
+
+

The shipping method

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + unspecified + +
    +
    +
    +
    +
    +
    +

    Unspecified

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case unspecified
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + sameDay + +
    +
    +
    +
    +
    +
    +

    Same Day

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case sameDay
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + expedited + +
    +
    +
    +
    +
    +
    +

    Expedited

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case expedited
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + priority + +
    +
    +
    +
    +
    +
    +

    Priority

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case priority
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + ground + +
    +
    +
    +
    +
    +
    +

    Ground

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case ground
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + electronicDelivery + +
    +
    +
    +
    +
    +
    +

    Electronic Delivery

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case electronicDelivery
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + shipToStore + +
    +
    +
    +
    +
    +
    +

    Ship to Store

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case shipToStore
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureV2ButtonType.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureV2ButtonType.html new file mode 100644 index 0000000000..3affd0ef1d --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTThreeDSecureV2ButtonType.html @@ -0,0 +1,496 @@ + + + + BTThreeDSecureV2ButtonType Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2ButtonType Enumeration Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2ButtonType

+
+
+ + 
@objc
+public enum BTThreeDSecureV2ButtonType : Int
+ +
+
+

Button types that can be customized in 3D Secure 2 flows.

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + verify + +
    +
    +
    +
    +
    +
    +

    Verify button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case verify
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + continue + +
    +
    +
    +
    +
    +
    +

    Continue button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case `continue`
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + next + +
    +
    +
    +
    +
    +
    +

    Next button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case next
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + cancel + +
    +
    +
    +
    +
    +
    +

    Cancel button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case cancel
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + resend + +
    +
    +
    +
    +
    +
    +

    Resend button

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case resend
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTVenmoPaymentMethodUsage.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTVenmoPaymentMethodUsage.html new file mode 100644 index 0000000000..77aa72b55a --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Enums/BTVenmoPaymentMethodUsage.html @@ -0,0 +1,406 @@ + + + + BTVenmoPaymentMethodUsage Enumeration Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTVenmoPaymentMethodUsage Enumeration Reference +

+ +
+ +
+ +
+
+

BTVenmoPaymentMethodUsage

+
+
+ + 
@objc
+public enum BTVenmoPaymentMethodUsage : Int
+ +
+
+

Usage type for the tokenized Venmo account

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • +
    + + + + multiUse + +
    +
    +
    +
    +
    +
    +

    The Venmo payment will be authorized for future payments and can be vaulted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case multiUse
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + singleUse + +
    +
    +
    +
    +
    +
    +

    The Venmo payment will be authorized for a one-time payment and cannot be vaulted.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    case singleUse
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Extensions.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Extensions.html new file mode 100644 index 0000000000..a8dd0e2f11 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Extensions.html @@ -0,0 +1,374 @@ + + + + Extensions Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Extensions Reference +

+ +
+ +
+ +
+
+

Extensions

+

The following extensions are available globally.

+ +
+
+ +
+
+
+
+ + +
+ +

CardinalValidationDelegate Protocol Conformance +

+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Extensions/BTThreeDSecureV2Provider.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Extensions/BTThreeDSecureV2Provider.html new file mode 100644 index 0000000000..900332fd47 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Extensions/BTThreeDSecureV2Provider.html @@ -0,0 +1,377 @@ + + + + BTThreeDSecureV2Provider Extension Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureV2Provider Extension Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureV2Provider

+
+
+ + 
extension BTThreeDSecureV2Provider: CardinalValidationDelegate
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Protocols.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Protocols.html new file mode 100644 index 0000000000..d45bb4552c --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Protocols.html @@ -0,0 +1,398 @@ + + + + Protocols Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Protocols Reference +

+ +
+ +
+ +
+
+

Protocols

+

The following protocols are available globally.

+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Protocols/BTLocalPaymentRequestDelegate.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Protocols/BTLocalPaymentRequestDelegate.html new file mode 100644 index 0000000000..5ac0180daa --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Protocols/BTLocalPaymentRequestDelegate.html @@ -0,0 +1,378 @@ + + + + BTLocalPaymentRequestDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTLocalPaymentRequestDelegate Protocol Reference +

+ +
+ +
+ +
+
+

BTLocalPaymentRequestDelegate

+
+
+ + 
@objc
+public protocol BTLocalPaymentRequestDelegate
+ +
+
+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Required delegate method which returns the payment ID before the flow starts.

    + +

    Use this to do any preprocessing and setup for webhooks. Use the start() callback to continue the flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+func localPaymentStarted(_ request: BTLocalPaymentRequest, paymentID: String, start: @escaping () -> Void)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Protocols/BTThreeDSecureRequestDelegate.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Protocols/BTThreeDSecureRequestDelegate.html new file mode 100644 index 0000000000..bfc1c6d90a --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/Protocols/BTThreeDSecureRequestDelegate.html @@ -0,0 +1,378 @@ + + + + BTThreeDSecureRequestDelegate Protocol Reference + + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + BTThreeDSecureRequestDelegate Protocol Reference +

+ +
+ +
+ +
+
+

BTThreeDSecureRequestDelegate

+
+
+ + 
@objc
+public protocol BTThreeDSecureRequestDelegate
+ +
+
+

Protocol for ThreeDSecure Request flow

+ +
+ Show on GitHub +
+
+
+ +
+
+
+
    +
  • + +
    +
    +
    +
    +
    +

    Required delegate method which returns the ThreeDSecure lookup result before the flow continues. + Use this to do any UI preparation or custom lookup result handling. Use the next() callback to continue the flow.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    @objc
+func onLookupComplete(_ request: BTThreeDSecureRequest, lookupResult: BTThreeDSecureResult, next: @escaping () -> Void)
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
+
+
+
+ +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/css/highlight.css b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/css/highlight.css new file mode 100644 index 0000000000..c170357ce7 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/css/highlight.css @@ -0,0 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +/* Credit to https://gist.github.com/wataru420/2048287 */ +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/css/jazzy.css b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/css/jazzy.css new file mode 100644 index 0000000000..c7bb9fe22f --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/css/jazzy.css @@ -0,0 +1,404 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ +*, *:before, *:after { + box-sizing: inherit; } + +body { + margin: 0; + background: #fff; + color: #333; + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + letter-spacing: .2px; + -webkit-font-smoothing: antialiased; + box-sizing: border-box; } + +h1 { + font-size: 2rem; + font-weight: 700; + margin: 1.275em 0 0.6em; } + +h2 { + font-size: 1.75rem; + font-weight: 700; + margin: 1.275em 0 0.3em; } + +h3 { + font-size: 1.5rem; + font-weight: 700; + margin: 1em 0 0.3em; } + +h4 { + font-size: 1.25rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h5 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; } + +h6 { + font-size: 1rem; + font-weight: 700; + margin: 1.275em 0 0.85em; + color: #777; } + +p { + margin: 0 0 1em; } + +ul, ol { + padding: 0 0 0 2em; + margin: 0 0 0.85em; } + +blockquote { + margin: 0 0 0.85em; + padding: 0 15px; + color: #858585; + border-left: 4px solid #e5e5e5; } + +img { + max-width: 100%; } + +a { + color: #4183c4; + text-decoration: none; } + a:hover, a:focus { + outline: 0; + text-decoration: underline; } + a.discouraged { + text-decoration: line-through; } + a.discouraged:hover, a.discouraged:focus { + text-decoration: underline line-through; } + +table { + background: #fff; + width: 100%; + border-collapse: collapse; + border-spacing: 0; + overflow: auto; + margin: 0 0 0.85em; } + +tr:nth-child(2n) { + background-color: #fbfbfb; } + +th, td { + padding: 6px 13px; + border: 1px solid #ddd; } + +hr { + height: 1px; + border: none; + background-color: #ddd; } + +pre { + margin: 0 0 1.275em; + padding: .85em 1em; + overflow: auto; + background: #f7f7f7; + font-size: .85em; + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +code { + font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace; } + +.item-container p > code, .item-container li > code, .top-matter p > code, .top-matter li > code { + background: #f7f7f7; + padding: .2em; } + .item-container p > code:before, .item-container p > code:after, .item-container li > code:before, .item-container li > code:after, .top-matter p > code:before, .top-matter p > code:after, .top-matter li > code:before, .top-matter li > code:after { + letter-spacing: -.2em; + content: "\00a0"; } + +pre code { + padding: 0; + white-space: pre; } + +.content-wrapper { + display: flex; + flex-direction: column; } + @media (min-width: 768px) { + .content-wrapper { + flex-direction: row; } } +.header { + display: flex; + padding: 8px; + font-size: 0.875em; + background: #444; + color: #999; } + +.header-col { + margin: 0; + padding: 0 8px; } + +.header-col--primary { + flex: 1; } + +.header-link { + color: #fff; } + +.header-icon { + padding-right: 2px; + vertical-align: -3px; + height: 16px; } + +.breadcrumbs { + font-size: 0.875em; + padding: 8px 16px; + margin: 0; + background: #fbfbfb; + border-bottom: 1px solid #ddd; } + +.carat { + height: 10px; + margin: 0 5px; } + +.navigation { + order: 2; } + @media (min-width: 768px) { + .navigation { + order: 1; + width: 25%; + max-width: 300px; + padding-bottom: 64px; + overflow: hidden; + word-wrap: normal; + background: #fbfbfb; + border-right: 1px solid #ddd; } } +.nav-groups { + list-style-type: none; + padding-left: 0; } + +.nav-group-name { + border-bottom: 1px solid #ddd; + padding: 8px 0 8px 16px; } + +.nav-group-name-link { + color: #333; } + +.nav-group-tasks { + margin: 8px 0; + padding: 0 0 0 8px; } + +.nav-group-task { + font-size: 1em; + list-style-type: none; + white-space: nowrap; } + +.nav-group-task-link { + color: #808080; } + +.main-content { + order: 1; } + @media (min-width: 768px) { + .main-content { + order: 2; + flex: 1; + padding-bottom: 60px; } } +.section { + padding: 0 32px; + border-bottom: 1px solid #ddd; } + +.section-content { + max-width: 834px; + margin: 0 auto; + padding: 16px 0; } + +.section-name { + color: #666; + display: block; } + .section-name p { + margin-bottom: inherit; } + +.declaration .highlight { + overflow-x: initial; + padding: 8px 0; + margin: 0; + background-color: transparent; + border: none; } + +.task-group-section { + border-top: 1px solid #ddd; } + +.task-group { + padding-top: 0px; } + +.task-name-container a[name]:before { + content: ""; + display: block; } + +.section-name-container { + position: relative; } + .section-name-container .section-name-link { + position: absolute; + top: 0; + left: 0; + bottom: 0; + right: 0; + margin-bottom: 0; } + .section-name-container .section-name { + position: relative; + pointer-events: none; + z-index: 1; } + .section-name-container .section-name a { + pointer-events: auto; } + +.item-container { + padding: 0; } + +.item { + padding-top: 8px; + width: 100%; + list-style-type: none; } + .item a[name]:before { + content: ""; + display: block; } + .item .token, .item .direct-link { + display: inline-block; + text-indent: -20px; + padding-left: 3px; + margin-left: 20px; + font-size: 1rem; } + .item .declaration-note { + font-size: .85em; + color: #808080; + font-style: italic; } + +.pointer-container { + border-bottom: 1px solid #ddd; + left: -23px; + padding-bottom: 13px; + position: relative; + width: 110%; } + +.pointer { + left: 21px; + top: 7px; + display: block; + position: absolute; + width: 12px; + height: 12px; + border-left: 1px solid #ddd; + border-top: 1px solid #ddd; + background: #fff; + transform: rotate(45deg); } + +.height-container { + display: none; + position: relative; + width: 100%; + overflow: hidden; } + .height-container .section { + background: #fff; + border: 1px solid #ddd; + border-top-width: 0; + padding-top: 10px; + padding-bottom: 5px; + padding: 8px 16px; } + +.aside, .language { + padding: 6px 12px; + margin: 12px 0; + border-left: 5px solid #dddddd; + overflow-y: hidden; } + .aside .aside-title, .language .aside-title { + font-size: 9px; + letter-spacing: 2px; + text-transform: uppercase; + padding-bottom: 0; + margin: 0; + color: #aaa; + -webkit-user-select: none; } + .aside p:last-child, .language p:last-child { + margin-bottom: 0; } + +.language { + border-left: 5px solid #cde9f4; } + .language .aside-title { + color: #4183c4; } + +.aside-warning, .aside-deprecated, .aside-unavailable { + border-left: 5px solid #ff6666; } + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { + color: #ff0000; } + +.graybox { + border-collapse: collapse; + width: 100%; } + .graybox p { + margin: 0; + word-break: break-word; + min-width: 50px; } + .graybox td { + border: 1px solid #ddd; + padding: 5px 25px 5px 10px; + vertical-align: middle; } + .graybox tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; } + +.slightly-smaller { + font-size: 0.9em; } + +.footer { + padding: 8px 16px; + background: #444; + color: #ddd; + font-size: 0.8em; } + .footer p { + margin: 8px 0; } + .footer a { + color: #fff; } + +html.dash .header, html.dash .breadcrumbs, html.dash .navigation { + display: none; } + +html.dash .height-container { + display: block; } + +form[role=search] input { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + font-size: 14px; + line-height: 24px; + padding: 0 10px; + margin: 0; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + +form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fbfbfb; + color: #333; + border: 1px solid #ddd; } + +form[role=search] .tt-highlight { + font-weight: bold; } + +form[role=search] .tt-suggestion { + font: 16px/1.7 "Helvetica Neue", Helvetica, Arial, sans-serif; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + +form[role=search] .tt-suggestion:hover, +form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + +form[role=search] .tt-suggestion:hover .doc-parent-name, +form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/carat.png b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/carat.png new file mode 100755 index 0000000000..29d2f7fd49 Binary files /dev/null and b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/carat.png differ diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/dash.png b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/dash.png new file mode 100755 index 0000000000..6f694c7a01 Binary files /dev/null and b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/dash.png differ diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/gh.png b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/gh.png new file mode 100755 index 0000000000..628da97c70 Binary files /dev/null and b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/gh.png differ diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/spinner.gif b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/spinner.gif new file mode 100644 index 0000000000..e3038d0a42 Binary files /dev/null and b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/img/spinner.gif differ diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/index.html b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/index.html new file mode 100644 index 0000000000..5d0c498a9b --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/index.html @@ -0,0 +1,463 @@ + + + + Braintree Reference + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Braintree Reference +

+ +
+ +
+ +
+
+ +

Braintree iOS SDK

+ +

CocoaPods compatible +Swift Package Manager compatible +Carthage compatible

+ +

GitHub Actions Tests

+ +

Welcome to Braintree’s iOS SDK. This library will help you accept card and alternative payments in your iOS app.

+ +

v6 is the latest major version of Braintree iOS and is currently in Beta. For stable releases, please point to v5 of the SDK. While preparing for general availability, we expect to make breaking changes in the beta releases. To update from v5, see the v6 migration guide.

+ +

The Braintree iOS SDK permits a deployment target of iOS 14.0 or higher. It requires Xcode 14.3+ and Swift 5.8+.

+

Supported Payment Methods

+ + +

Installation

+ +

We recommend using Swift Package Manager, CocoaPods, or Carthage to integrate the Braintree SDK with your project.

+

Swift Package Manager

+ +

This feature is only available in v5+.

+ +

To add the Braintree package to your Xcode project, select File > Swift Packages > Add Package Dependency and enter https://github.com/braintree/braintree_ios as the repository URL. Tick the checkboxes for the specific Braintree libraries you wish to include.

+ +

If you look at your app target, you will see that the Braintree libraries you chose are automatically linked as a frameworks to your app (see General > Frameworks, Libraries, and Embedded Content).

+ +

BraintreePayPal and BraintreePaymentFlow also require the inclusion of the PayPalDataCollector module.

+ +

In your app’s source code files, use the following import syntax to include Braintree’s libraries:

+
import BraintreeCore
+import BraintreeCard
+import BraintreeApplePay
+import BraintreePayPal
+
+

CocoaPods

+
# Includes Cards and PayPal
+pod 'Braintree'
+
+# Optionally include additional Pods
+pod 'Braintree/DataCollector'
+pod 'Braintree/Venmo'
+
+

Carthage

+ +

Braintree 6.0.0+ requires Carthage 0.38.0+ and the --use-xcframeworks option when running carthage update.

+ +

Add github "braintree/braintree_ios" to your Cartfile, and add the frameworks to your project.

+ +

Note: Long term support for Carthage is not guaranteed. Please update to SPM, if possible. If there are concerns, please comment on this Discussion thread.

+

Documentation

+ +

Start with ‘Hello, Client!’ for instructions on basic setup and usage.

+ +

Next, read the full documentation for information about integrating with additional payment methods, such as PayPal and Venmo, as well as explore our pre-built Drop-In UI offering.

+

Versions

+ +

This SDK abides by our Client SDK Deprecation Policy. For more information on the potential statuses of an SDK check our developer docs.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Major version numberStatusReleasedDeprecatedUnsupported
6.x.xBetaTBATBATBA
5.x.xActiveFebruary 2021TBATBA
4.x.xUnsupportedNovember 2015February 2022February 2023
+ +

Versions 4.9.6 and below use outdated SSL certificates and are unsupported.

+

Demo

+ +
    +
  1. Run pod install + +
      +
    • There is a known M1 mac issue with CocoaPods. See this solution to resolve ffi dependency issues.
      • +
    2. +
  2. Resolve the Swift Package Manager packages if needed: File > Packages > Resolve Package Versions or by running swift package resolve in Terminal
    3. +
  3. Open Braintree.xcworkspace in Xcode
    4. +
  4. Select the Demo scheme, and then run
    5. +
+ +

Xcode 14+ is required to run the demo app.

+

Contributing

+ +

We welcome PRs to this repo. See our development doc.

+

Feedback

+ +

The Braintree iOS SDK is in active development, we welcome your feedback!

+ +

Here are a few ways to get in touch:

+ + +

Help

+ + +

License

+ +

The Braintree iOS SDK is open source and available under the MIT license. See the LICENSE file for more info.

+ +
+
+ + +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/jazzy.js b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/jazzy.js new file mode 100755 index 0000000000..198441660c --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/jazzy.search.js b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/jazzy.search.js new file mode 100644 index 0000000000..359cdbb8b2 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
'; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
'; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/jquery.min.js b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/jquery.min.js new file mode 100644 index 0000000000..2c69bc908b --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/typeahead.jquery.js b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/typeahead.jquery.js new file mode 100644 index 0000000000..3a2d2ab031 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/js/typeahead.jquery.js @@ -0,0 +1,1694 @@ +/*! + * typeahead.js 1.3.1 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
"); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
"); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
"); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
"); + $menu = this.menu.$node || $("
"); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/search.json b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/search.json new file mode 100644 index 0000000000..89a3138fa0 --- /dev/null +++ b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/Documents/search.json @@ -0,0 +1 @@ +{"Protocols/BTThreeDSecureRequestDelegate.html#/c:@M@BraintreeThreeDSecure@objc(pl)BTThreeDSecureRequestDelegate(im)onLookupComplete:lookupResult:next:":{"name":"onLookupComplete(_:lookupResult:next:)","abstract":"

Required delegate method which returns the ThreeDSecure lookup result before the flow continues.","parent_name":"BTThreeDSecureRequestDelegate"},"Protocols/BTLocalPaymentRequestDelegate.html#/c:@M@BraintreeLocalPayment@objc(pl)BTLocalPaymentRequestDelegate(im)localPaymentStarted:paymentID:start:":{"name":"localPaymentStarted(_:paymentID:start:)","abstract":"

Required delegate method which returns the payment ID before the flow starts.

","parent_name":"BTLocalPaymentRequestDelegate"},"Protocols/BTLocalPaymentRequestDelegate.html":{"name":"BTLocalPaymentRequestDelegate"},"Protocols/BTThreeDSecureRequestDelegate.html":{"name":"BTThreeDSecureRequestDelegate","abstract":"

Protocol for ThreeDSecure Request flow

"},"Extensions/BTThreeDSecureV2Provider.html#/s:21BraintreeThreeDSecure07BTThreeC10V2ProviderC15cardinalSessionAD15stepUpValidated9serverJWTySo08CardinalH0CSg_So0N8ResponseCSgSSSgtF":{"name":"cardinalSession(cardinalSession:stepUpValidated:serverJWT:)","parent_name":"BTThreeDSecureV2Provider"},"Extensions/BTThreeDSecureV2Provider.html":{"name":"BTThreeDSecureV2Provider"},"Enums/BTVenmoPaymentMethodUsage.html#/c:@M@BraintreeVenmo@E@BTVenmoPaymentMethodUsage@BTVenmoPaymentMethodUsageMultiUse":{"name":"multiUse","abstract":"

The Venmo payment will be authorized for future payments and can be vaulted.

","parent_name":"BTVenmoPaymentMethodUsage"},"Enums/BTVenmoPaymentMethodUsage.html#/c:@M@BraintreeVenmo@E@BTVenmoPaymentMethodUsage@BTVenmoPaymentMethodUsageSingleUse":{"name":"singleUse","abstract":"

The Venmo payment will be authorized for a one-time payment and cannot be vaulted.

","parent_name":"BTVenmoPaymentMethodUsage"},"Enums/BTPayPalRequestLandingPageType.html#/c:@M@BraintreePayPal@E@BTPayPalRequestLandingPageType@BTPayPalRequestLandingPageTypeNone":{"name":"none","abstract":"

Default

","parent_name":"BTPayPalRequestLandingPageType"},"Enums/BTPayPalRequestLandingPageType.html#/c:@M@BraintreePayPal@E@BTPayPalRequestLandingPageType@BTPayPalRequestLandingPageTypeLogin":{"name":"login","abstract":"

Login

","parent_name":"BTPayPalRequestLandingPageType"},"Enums/BTPayPalRequestLandingPageType.html#/c:@M@BraintreePayPal@E@BTPayPalRequestLandingPageType@BTPayPalRequestLandingPageTypeBilling":{"name":"billing","abstract":"

Billing

","parent_name":"BTPayPalRequestLandingPageType"},"Enums/BTPayPalPaymentType.html#/c:@M@BraintreePayPal@E@BTPayPalPaymentType@BTPayPalPaymentTypeCheckout":{"name":"checkout","abstract":"

Checkout

","parent_name":"BTPayPalPaymentType"},"Enums/BTPayPalPaymentType.html#/c:@M@BraintreePayPal@E@BTPayPalPaymentType@BTPayPalPaymentTypeVault":{"name":"vault","abstract":"

Vault

","parent_name":"BTPayPalPaymentType"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeNone":{"name":"none","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeDa_DK":{"name":"da_DK","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeDe_DE":{"name":"de_DE","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEn_AU":{"name":"en_AU","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEn_GB":{"name":"en_GB","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEn_US":{"name":"en_US","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEs_ES":{"name":"es_ES","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEs_XC":{"name":"es_XC","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeFr_CA":{"name":"fr_CA","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeFr_FR":{"name":"fr_FR","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeFr_XC":{"name":"fr_XC","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeId_ID":{"name":"id_ID","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeIt_IT":{"name":"it_IT","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeJa_JP":{"name":"ja_JP","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeKo_KR":{"name":"ko_KR","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeNl_NL":{"name":"nl_NL","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeNo_NO":{"name":"no_NO","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodePl_PL":{"name":"pl_PL","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodePt_BR":{"name":"pt_BR","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodePt_PT":{"name":"pt_PT","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeRu_RU":{"name":"ru_RU","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeSv_SE":{"name":"sv_SE","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeTh_TH":{"name":"th_TH","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeTr_TR":{"name":"tr_TR","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeZh_CN":{"name":"zh_CN","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeZh_HK":{"name":"zh_HK","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeZh_TW":{"name":"zh_TW","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeZh_XC":{"name":"zh_XC","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLineItemKind.html#/c:@M@BraintreePayPal@E@BTPayPalLineItemKind@BTPayPalLineItemKindDebit":{"name":"debit","abstract":"

Debit

","parent_name":"BTPayPalLineItemKind"},"Enums/BTPayPalLineItemKind.html#/c:@M@BraintreePayPal@E@BTPayPalLineItemKind@BTPayPalLineItemKindCredit":{"name":"credit","abstract":"

Credit

","parent_name":"BTPayPalLineItemKind"},"Enums/BTPayPalRequestUserAction.html#/c:@M@BraintreePayPal@E@BTPayPalRequestUserAction@BTPayPalRequestUserActionNone":{"name":"none","abstract":"

Default

","parent_name":"BTPayPalRequestUserAction"},"Enums/BTPayPalRequestUserAction.html#/c:@M@BraintreePayPal@E@BTPayPalRequestUserAction@BTPayPalRequestUserActionPayNow":{"name":"payNow","abstract":"

Pay Now

","parent_name":"BTPayPalRequestUserAction"},"Enums/BTPayPalRequestIntent.html#/c:@M@BraintreePayPal@E@BTPayPalRequestIntent@BTPayPalRequestIntentAuthorize":{"name":"authorize","abstract":"

Authorize

","parent_name":"BTPayPalRequestIntent"},"Enums/BTPayPalRequestIntent.html#/c:@M@BraintreePayPal@E@BTPayPalRequestIntent@BTPayPalRequestIntentSale":{"name":"sale","abstract":"

Sale

","parent_name":"BTPayPalRequestIntent"},"Enums/BTPayPalRequestIntent.html#/c:@M@BraintreePayPal@E@BTPayPalRequestIntent@BTPayPalRequestIntentOrder":{"name":"order","abstract":"

Order

","parent_name":"BTPayPalRequestIntent"},"Enums/BTPayPalRequestIntent.html#/s:15BraintreePayPal05BTPayC13RequestIntentO11stringValueSSvp":{"name":"stringValue","parent_name":"BTPayPalRequestIntent"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeVerify":{"name":"verify","abstract":"

Verify button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeContinue":{"name":"continue","abstract":"

Continue button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeNext":{"name":"next","abstract":"

Next button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeCancel":{"name":"cancel","abstract":"

Cancel button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeResend":{"name":"resend","abstract":"

Resend button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodUnspecified":{"name":"unspecified","abstract":"

Unspecified

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodSameDay":{"name":"sameDay","abstract":"

Same Day

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodExpedited":{"name":"expedited","abstract":"

Expedited

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodPriority":{"name":"priority","abstract":"

Priority

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodGround":{"name":"ground","abstract":"

Ground

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodElectronicDelivery":{"name":"electronicDelivery","abstract":"

Electronic Delivery

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodShipToStore":{"name":"shipToStore","abstract":"

Ship to Store

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeUnspecified":{"name":"unspecified","abstract":"

Unspecified

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeLowValue":{"name":"lowValue","abstract":"

Low value

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeSecureCorporate":{"name":"secureCorporate","abstract":"

Secure corporate

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeTrustedBeneficiary":{"name":"trustedBeneficiary","abstract":"

Trusted beneficiary

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeTransactionRiskAnalysis":{"name":"transactionRiskAnalysis","abstract":"

Transaction risk analysis

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureCardAddChallenge.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureCardAddChallenge@BTThreeDSecureCardAddChallengeUnspecified":{"name":"unspecified","abstract":"

Unspecified

","parent_name":"BTThreeDSecureCardAddChallenge"},"Enums/BTThreeDSecureCardAddChallenge.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureCardAddChallenge@BTThreeDSecureCardAddChallengeRequested":{"name":"requested","abstract":"

Requested

","parent_name":"BTThreeDSecureCardAddChallenge"},"Enums/BTThreeDSecureCardAddChallenge.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureCardAddChallenge@BTThreeDSecureCardAddChallengeNotRequested":{"name":"notRequested","abstract":"

Not Requested

","parent_name":"BTThreeDSecureCardAddChallenge"},"Enums/BTThreeDSecureAccountType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureAccountType@BTThreeDSecureAccountTypeUnspecified":{"name":"unspecified","abstract":"

Unspecified

","parent_name":"BTThreeDSecureAccountType"},"Enums/BTThreeDSecureAccountType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureAccountType@BTThreeDSecureAccountTypeCredit":{"name":"credit","abstract":"

Credit

","parent_name":"BTThreeDSecureAccountType"},"Enums/BTThreeDSecureAccountType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureAccountType@BTThreeDSecureAccountTypeDebit":{"name":"debit","abstract":"

Debit

","parent_name":"BTThreeDSecureAccountType"},"Enums/BTSEPADirectDebitMandateType.html#/c:@M@BraintreeSEPADirectDebit@E@BTSEPADirectDebitMandateType@BTSEPADirectDebitMandateTypeOneOff":{"name":"oneOff","parent_name":"BTSEPADirectDebitMandateType"},"Enums/BTSEPADirectDebitMandateType.html#/c:@M@BraintreeSEPADirectDebit@E@BTSEPADirectDebitMandateType@BTSEPADirectDebitMandateTypeRecurrent":{"name":"recurrent","parent_name":"BTSEPADirectDebitMandateType"},"Enums/BTSEPADirectDebitMandateType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"BTSEPADirectDebitMandateType"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelCritical":{"name":"critical","abstract":"

Only log critical issues (e.g. irrecoverable errors)

","parent_name":"BTLogLevel"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelError":{"name":"error","abstract":"

Log errors (e.g. expected or recoverable errors)

","parent_name":"BTLogLevel"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelWarning":{"name":"warning","abstract":"

Log warnings (e.g. use of pre-release features)

","parent_name":"BTLogLevel"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelInfo":{"name":"info","abstract":"

Log basic information (e.g. state changes, network activity)

","parent_name":"BTLogLevel"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelDebug":{"name":"debug","abstract":"

Log debugging statements (anything and everything)

","parent_name":"BTLogLevel"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourceUnknown":{"name":"unknown","abstract":"

Unknown source

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourcePayPalApp":{"name":"payPalApp","abstract":"

PayPal app

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourcePayPalBrowser":{"name":"payPalBrowser","abstract":"

PayPal browser

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourceVenmoApp":{"name":"venmoApp","abstract":"

Venmo app

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourceForm":{"name":"form","abstract":"

Form

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataIntegration.html#/c:@M@BraintreeCore@E@BTClientMetadataIntegration@BTClientMetadataIntegrationCustom":{"name":"custom","abstract":"

Custom

","parent_name":"BTClientMetadataIntegration"},"Enums/BTClientMetadataIntegration.html#/c:@M@BraintreeCore@E@BTClientMetadataIntegration@BTClientMetadataIntegrationDropIn":{"name":"dropIn","abstract":"

Drop-in

","parent_name":"BTClientMetadataIntegration"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkUnknown":{"name":"unknown","abstract":"

Unknown card

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkAMEX":{"name":"AMEX","abstract":"

American Express

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkDinersClub":{"name":"dinersClub","abstract":"

Diners Club

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkDiscover":{"name":"discover","abstract":"

Discover

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkMasterCard":{"name":"masterCard","abstract":"

Mastercard

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkVisa":{"name":"visa","abstract":"

Visa

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkJCB":{"name":"JCB","abstract":"

JCB

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkLaser":{"name":"laser","abstract":"

Laser

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkMaestro":{"name":"maestro","abstract":"

Maestro

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkUnionPay":{"name":"unionPay","abstract":"

Union Pay

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkHiper":{"name":"hiper","abstract":"

Hiper

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkHipercard":{"name":"hipercard","abstract":"

Hipercard

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkSolo":{"name":"solo","abstract":"

Solo

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkSwitch":{"name":"switch","abstract":"

Switch

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkUkMaestro":{"name":"ukMaestro","abstract":"

UK Maestro

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html":{"name":"BTCardNetwork","abstract":"

Card type

"},"Enums/BTClientMetadataIntegration.html":{"name":"BTClientMetadataIntegration","abstract":"

Integration Types

"},"Enums/BTClientMetadataSource.html":{"name":"BTClientMetadataSource","abstract":"

Source of the metadata

"},"Enums/BTLogLevel.html":{"name":"BTLogLevel","abstract":"

Log level used to add formatted string to NSLog

"},"Enums/BTSEPADirectDebitMandateType.html":{"name":"BTSEPADirectDebitMandateType","abstract":"

Mandate type for the SEPA Direct Debit request.

"},"Enums/BTThreeDSecureAccountType.html":{"name":"BTThreeDSecureAccountType","abstract":"

The account type

"},"Enums/BTThreeDSecureCardAddChallenge.html":{"name":"BTThreeDSecureCardAddChallenge","abstract":"

The card add challenge request

"},"Enums/BTThreeDSecureRequestedExemptionType.html":{"name":"BTThreeDSecureRequestedExemptionType","abstract":"

3D Secure requested exemption type

"},"Enums/BTThreeDSecureShippingMethod.html":{"name":"BTThreeDSecureShippingMethod","abstract":"

The shipping method

"},"Enums/BTThreeDSecureV2ButtonType.html":{"name":"BTThreeDSecureV2ButtonType","abstract":"

Button types that can be customized in 3D Secure 2 flows.

"},"Enums/BTPayPalRequestIntent.html":{"name":"BTPayPalRequestIntent","abstract":"

Payment intent.

"},"Enums/BTPayPalRequestUserAction.html":{"name":"BTPayPalRequestUserAction","abstract":"

The call-to-action in the PayPal Checkout flow.

"},"Enums/BTPayPalLineItemKind.html":{"name":"BTPayPalLineItemKind","abstract":"

Use this option to specify whether a line item is a debit (sale) or credit (refund) to the customer.

"},"Enums/BTPayPalLocaleCode.html":{"name":"BTPayPalLocaleCode","abstract":"

A locale code to use for a transaction.

"},"Enums/BTPayPalPaymentType.html":{"name":"BTPayPalPaymentType"},"Enums/BTPayPalRequestLandingPageType.html":{"name":"BTPayPalRequestLandingPageType","abstract":"

Use this option to specify the PayPal page to display when a user lands on the PayPal site to complete the payment.

"},"Enums/BTVenmoPaymentMethodUsage.html":{"name":"BTVenmoPaymentMethodUsage","abstract":"

Usage type for the tokenized Venmo account

"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(py)profileID":{"name":"profileID","abstract":"

Optional. The Venmo profile ID to be used during payment authorization. Customers will see the business name and logo associated with this Venmo profile, and it may show up in the","parent_name":"BTVenmoRequest"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(py)vault":{"name":"vault","abstract":"

Whether to automatically vault the Venmo account on the client. For client-side vaulting, you must initialize BTAPIClient with a client token that was created with a customer ID.","parent_name":"BTVenmoRequest"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(py)paymentMethodUsage":{"name":"paymentMethodUsage","abstract":"

If set to .multiUse, the Venmo payment will be authorized for future payments and can be vaulted.","parent_name":"BTVenmoRequest"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(py)displayName":{"name":"displayName","abstract":"

Optional. The business name that will be displayed in the Venmo app payment approval screen. Only used by merchants onboarded as PayFast channel partners.

","parent_name":"BTVenmoRequest"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(im)initWithPaymentMethodUsage:":{"name":"init(paymentMethodUsage:)","abstract":"

Initialize a Venmo request with a payment method usage.

","parent_name":"BTVenmoRequest"},"Classes/BTVenmoClient.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates an Apple Pay client

","parent_name":"BTVenmoClient"},"Classes/BTVenmoClient.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoClient(im)tokenizeWithVenmoRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.

","parent_name":"BTVenmoClient"},"Classes/BTVenmoClient.html#/s:14BraintreeVenmo13BTVenmoClientC8tokenizeyAA0C12AccountNonceCAA0C7RequestCYaKF":{"name":"tokenize(_:)","abstract":"

Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.

","parent_name":"BTVenmoClient"},"Classes/BTVenmoClient.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoClient(im)isVenmoAppInstalled":{"name":"isVenmoAppInstalled()","abstract":"

Returns true if the proper Venmo app is installed and configured correctly, returns false otherwise.

","parent_name":"BTVenmoClient"},"Classes/BTVenmoClient.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoClient(im)openVenmoAppPageInAppStore":{"name":"openVenmoAppPageInAppStore()","abstract":"

Switches to the App Store to download the Venmo application.

","parent_name":"BTVenmoClient"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)email":{"name":"email","abstract":"

The email associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)externalID":{"name":"externalID","abstract":"

The external ID associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)firstName":{"name":"firstName","abstract":"

The first name associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)lastName":{"name":"lastName","abstract":"

The last name associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)phoneNumber":{"name":"phoneNumber","abstract":"

The phone number associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)username":{"name":"username","abstract":"

The username associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTPayPalVaultRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalVaultRequest(py)offerCredit":{"name":"offerCredit","abstract":"

Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

","parent_name":"BTPayPalVaultRequest"},"Classes/BTPayPalVaultRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalVaultRequest(im)initWithOfferCredit:":{"name":"init(offerCredit:)","abstract":"

Initializes a PayPal Native Vault request

","parent_name":"BTPayPalVaultRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)isShippingAddressRequired":{"name":"isShippingAddressRequired","abstract":"

Defaults to false. When set to true, the shipping address selector will be displayed.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)isShippingAddressEditable":{"name":"isShippingAddressEditable","abstract":"

Defaults to false. Set to true to enable user editing of the shipping address.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)localeCode":{"name":"localeCode","abstract":"

Optional: A locale code to use for the transaction.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)shippingAddressOverride":{"name":"shippingAddressOverride","abstract":"

Optional: A valid shipping address to be displayed in the transaction flow. An error will occur if this address is not valid.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)landingPageType":{"name":"landingPageType","abstract":"

Optional: Landing page type. Defaults to .none.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)displayName":{"name":"displayName","abstract":"

Optional: The merchant name displayed inside of the PayPal flow; defaults to the company name on your Braintree account

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)merchantAccountID":{"name":"merchantAccountID","abstract":"

Optional: A non-default merchant account to use for tokenization.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)lineItems":{"name":"lineItems","abstract":"

Optional: The line items for this transaction. It can include up to 249 line items.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)billingAgreementDescription":{"name":"billingAgreementDescription","abstract":"

Optional: Display a custom description to the user for a billing agreement. For Checkout with Vault flows, you must also set","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)riskCorrelationID":{"name":"riskCorrelationID","abstract":"

Optional: A risk correlation ID created with Set Transaction Context on your server.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)quantity":{"name":"quantity","abstract":"

Number of units of the item purchased. This value must be a whole number and can’t be negative or zero.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)unitAmount":{"name":"unitAmount","abstract":"

Per-unit price of the item. Can include up to 2 decimal places. This value can’t be negative or zero.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)name":{"name":"name","abstract":"

Item name. Maximum 127 characters.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)kind":{"name":"kind","abstract":"

Indicates whether the line item is a debit (sale) or credit (refund) to the customer.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)unitTaxAmount":{"name":"unitTaxAmount","abstract":"

Optional: Per-unit tax price of the item. Can include up to 2 decimal places. This value can’t be negative or zero.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)itemDescription":{"name":"itemDescription","abstract":"

Optional: Item description. Maximum 127 characters.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)productCode":{"name":"productCode","abstract":"

Optional: Product or UPC code for the item. Maximum 127 characters.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)url":{"name":"url","abstract":"

Optional: The URL to product information.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(im)initWithQuantity:unitAmount:name:kind:":{"name":"init(quantity:unitAmount:name:kind:)","abstract":"

Initialize a PayPayLineItem

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(im)requestParameters":{"name":"requestParameters()","abstract":"

Returns the line item in a dictionary.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalCreditFinancingAmount.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancingAmount(py)currency":{"name":"currency","abstract":"

3 letter currency code as defined by ISO 4217.

","parent_name":"BTPayPalCreditFinancingAmount"},"Classes/BTPayPalCreditFinancingAmount.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancingAmount(py)value":{"name":"value","abstract":"

An amount defined by ISO 4217 for the given currency.

","parent_name":"BTPayPalCreditFinancingAmount"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)cardAmountImmutable":{"name":"cardAmountImmutable","abstract":"

Indicates whether the card amount is editable after payer’s acceptance on PayPal side.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)monthlyPayment":{"name":"monthlyPayment","abstract":"

Estimated amount per month that the customer will need to pay including fees and interest.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)payerAcceptance":{"name":"payerAcceptance","abstract":"

Status of whether the customer ultimately was approved for and chose to make the payment using the approved installment credit.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)term":{"name":"term","abstract":"

Length of financing terms in months.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)totalCost":{"name":"totalCost","abstract":"

Estimated total payment amount including interest and fees the user will pay during the lifetime of the loan.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)totalInterest":{"name":"totalInterest","abstract":"

Estimated interest or fees amount the payer will have to pay during the lifetime of the loan.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalClient.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initialize a new PayPal client instance.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalClient.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalClient(im)tokenizeWithVaultRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Vault flow.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalClient.html#/s:15BraintreePayPal05BTPayC6ClientC8tokenizeyAA0dC12AccountNonceCAA0dC12VaultRequestCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Vault flow.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalClient.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalClient(im)tokenizeWithCheckoutRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Checkout or Pay Later flow.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalClient.html#/s:15BraintreePayPal05BTPayC6ClientC8tokenizeyAA0dC12AccountNonceCAA0dC15CheckoutRequestCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Checkout or Pay Later flow.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)amount":{"name":"amount","abstract":"

Used for a one-time payment.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)intent":{"name":"intent","abstract":"

Optional: Payment intent. Defaults to .authorize. Only applies to PayPal Checkout.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)userAction":{"name":"userAction","abstract":"

Optional: Changes the call-to-action in the PayPal Checkout flow. Defaults to .none.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)offerPayLater":{"name":"offerPayLater","abstract":"

Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)currencyCode":{"name":"currencyCode","abstract":"

Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)requestBillingAgreement":{"name":"requestBillingAgreement","abstract":"

Optional: If set to true, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement during checkout. Defaults to false.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(im)initWithAmount:intent:userAction:offerPayLater:currencyCode:requestBillingAgreement:":{"name":"init(amount:intent:userAction:offerPayLater:currencyCode:requestBillingAgreement:)","abstract":"

Initializes a PayPal Native Checkout request

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)email":{"name":"email","abstract":"

Payer’s email address.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)firstName":{"name":"firstName","abstract":"

Payer’s first name.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)lastName":{"name":"lastName","abstract":"

Payer’s last name.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)phone":{"name":"phone","abstract":"

Payer’s phone number.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)billingAddress":{"name":"billingAddress","abstract":"

The billing address.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)shippingAddress":{"name":"shippingAddress","abstract":"

The shipping address.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)clientMetadataID":{"name":"clientMetadataID","abstract":"

Client metadata id associated with this transaction.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)payerID":{"name":"payerID","abstract":"

Optional. Payer id associated with this transaction.","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)creditFinancing":{"name":"creditFinancing","abstract":"

Optional. Credit financing details if the customer pays with PayPal Credit.","parent_name":"BTPayPalAccountNonce"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)acsTransactionID":{"name":"acsTransactionID","abstract":"

Unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)authenticationTransactionStatus":{"name":"authenticationTransactionStatus","abstract":"

On authentication, the transaction status result identifier.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)authenticationTransactionStatusReason":{"name":"authenticationTransactionStatusReason","abstract":"

On authentication, provides additional information as to why the transaction status has the specific value.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)cavv":{"name":"cavv","abstract":"

Cardholder authentication verification value or “CAVV” is the main encrypted message issuers and card networks use to verify authentication has occured.","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)dsTransactionID":{"name":"dsTransactionID","abstract":"

Directory Server Transaction ID is an ID used by the card brand’s 3DS directory server.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)eciFlag":{"name":"eciFlag","abstract":"

The ecommerce indicator flag indicates the outcome of the 3DS authentication.","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)enrolled":{"name":"enrolled","abstract":"

Indicates whether a card is enrolled in a 3D Secure program or not. Possible values:

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)liabilityShifted":{"name":"liabilityShifted","abstract":"

If the 3D Secure liability shift has occurred.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)liabilityShiftPossible":{"name":"liabilityShiftPossible","abstract":"

If the 3D Secure liability shift is possible.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)lookupTransactionStatus":{"name":"lookupTransactionStatus","abstract":"

On lookup, the transaction status result identifier.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)lookupTransactionStatusReason":{"name":"lookupTransactionStatusReason","abstract":"

On lookup, provides additional information as to why the transaction status has the specific value.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)paresStatus":{"name":"paresStatus","abstract":"

The Payer Authentication Response (PARes) Status, a transaction status result identifier. Possible Values:

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)status":{"name":"status","abstract":"

The 3D Secure status value.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)threeDSecureAuthenticationID":{"name":"threeDSecureAuthenticationID","abstract":"

Unique identifier assigned to the 3D Secure authentication performed for this transaction.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)threeDSecureServerTransactionID":{"name":"threeDSecureServerTransactionID","abstract":"

Unique transaction identifier assigned by the 3DS Server to identify a single transaction.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)threeDSecureVersion":{"name":"threeDSecureVersion","abstract":"

The 3DS version used in the authentication, example “1.0.2” or “2.1.0”.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)wasVerified":{"name":"wasVerified","abstract":"

Indicates if the 3D Secure lookup was performed.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)xid":{"name":"xid","abstract":"

Transaction identifier resulting from 3D Secure authentication. Uniquely identifies the transaction and sometimes required in the authorization message.","parent_name":"BTThreeDSecureInfo"},"Classes/BTCardRequest.html#/c:@M@BraintreeCard@objc(cs)BTCardRequest(py)card":{"name":"card","abstract":"

The BTCard associated with this instance.

","parent_name":"BTCardRequest"},"Classes/BTCardRequest.html#/c:@M@BraintreeCard@objc(cs)BTCardRequest(im)initWithCard:":{"name":"init(card:)","abstract":"

Initialize a Card request with a BTCard.

","parent_name":"BTCardRequest"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)cardNetwork":{"name":"cardNetwork","abstract":"

The card network.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)expirationMonth":{"name":"expirationMonth","abstract":"

The expiration month of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)expirationYear":{"name":"expirationYear","abstract":"

The expiration year of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)cardholderName":{"name":"cardholderName","abstract":"

The name of the cardholder, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)lastTwo":{"name":"lastTwo","abstract":"

The last two digits of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)lastFour":{"name":"lastFour","abstract":"

The last four digits of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)bin":{"name":"bin","abstract":"

The BIN number of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)binData":{"name":"binData","abstract":"

The BIN data for the card number associated with this nonce.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)threeDSecureInfo":{"name":"threeDSecureInfo","abstract":"

The 3D Secure info for the card number associated with this nonce.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)authenticationInsight":{"name":"authenticationInsight","abstract":"

Details about the regulatory environment and applicable customer authentication regulation for a potential transaction.","parent_name":"BTCardNonce"},"Classes/BTCardClient.html#/c:@M@BraintreeCard@objc(cs)BTCardClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates a card client

","parent_name":"BTCardClient"},"Classes/BTCardClient.html#/c:@M@BraintreeCard@objc(cs)BTCardClient(im)tokenizeCard:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenizes a card

","parent_name":"BTCardClient"},"Classes/BTCardClient.html#/s:13BraintreeCard12BTCardClientC8tokenizeyAA0C5NonceCAA0C0CYaKF":{"name":"tokenize(_:)","abstract":"

Tokenizes a card

","parent_name":"BTCardClient"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)number":{"name":"number","abstract":"

The card number

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)expirationMonth":{"name":"expirationMonth","abstract":"

The expiration month as a one or two-digit number on the Gregorian calendar

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)expirationYear":{"name":"expirationYear","abstract":"

The expiration year as a two or four-digit number on the Gregorian calendar

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)cvv":{"name":"cvv","abstract":"

The card verification code (like CVV or CID).

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)postalCode":{"name":"postalCode","abstract":"

The postal code associated with the card’s billing address

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)cardholderName":{"name":"cardholderName","abstract":"

Optional: the cardholder’s name.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)firstName":{"name":"firstName","abstract":"

Optional: first name on the card.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)lastName":{"name":"lastName","abstract":"

Optional: last name on the card.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)company":{"name":"company","abstract":"

Optional: company name associated with the card.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)streetAddress":{"name":"streetAddress","abstract":"

Optional: the street address associated with the card’s billing address

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)extendedAddress":{"name":"extendedAddress","abstract":"

Optional: the extended address associated with the card’s billing address

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)locality":{"name":"locality","abstract":"

Optional: the city associated with the card’s billing address

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)region":{"name":"region","abstract":"

Optional: either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)countryName":{"name":"countryName","abstract":"

Optional: the country name associated with the card’s billing address.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)countryCodeAlpha2":{"name":"countryCodeAlpha2","abstract":"

Optional: the ISO 3166-1 alpha-2 country code specified in the card’s billing address.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)countryCodeAlpha3":{"name":"countryCodeAlpha3","abstract":"

Optional: the ISO 3166-1 alpha-3 country code specified in the card’s billing address.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)countryCodeNumeric":{"name":"countryCodeNumeric","abstract":"

Optional: The ISO 3166-1 numeric country code specified in the card’s billing address.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)shouldValidate":{"name":"shouldValidate","abstract":"

Controls whether or not to return validations and/or verification results. By default, this is not enabled.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)authenticationInsightRequested":{"name":"authenticationInsightRequested","abstract":"

Optional: If authentication insight is requested. If this property is set to true, a merchantAccountID must be provided. Defaults to false.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)merchantAccountID":{"name":"merchantAccountID","abstract":"

Optional: The merchant account ID.

","parent_name":"BTCard"},"Classes/BTAuthenticationInsight.html#/c:@M@BraintreeCard@objc(cs)BTAuthenticationInsight(py)regulationEnvironment":{"name":"regulationEnvironment","abstract":"

The regulation environment for the associated nonce to help determine the need for 3D Secure.","parent_name":"BTAuthenticationInsight"},"Classes/BTThreeDSecureV2UICustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2UICustomization(py)toolbarCustomization":{"name":"toolbarCustomization","abstract":"

Toolbar customization options for 3D Secure 2 flows.

","parent_name":"BTThreeDSecureV2UICustomization"},"Classes/BTThreeDSecureV2UICustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2UICustomization(py)labelCustomization":{"name":"labelCustomization","abstract":"

Label customization options for 3D Secure 2 flows.

","parent_name":"BTThreeDSecureV2UICustomization"},"Classes/BTThreeDSecureV2UICustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2UICustomization(py)textBoxCustomization":{"name":"textBoxCustomization","abstract":"

Text box customization options for 3D Secure 2 flows.

","parent_name":"BTThreeDSecureV2UICustomization"},"Classes/BTThreeDSecureV2UICustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2UICustomization(im)setButtonCustomization:buttonType:":{"name":"setButton(_:buttonType:)","abstract":"

Set button customization options for 3D Secure 2 flows.

","parent_name":"BTThreeDSecureV2UICustomization"},"Classes/BTThreeDSecureV2ToolbarCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ToolbarCustomization(py)backgroundColor":{"name":"backgroundColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2ToolbarCustomization"},"Classes/BTThreeDSecureV2ToolbarCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ToolbarCustomization(py)headerText":{"name":"headerText","abstract":"

Text for the header.

","parent_name":"BTThreeDSecureV2ToolbarCustomization"},"Classes/BTThreeDSecureV2ToolbarCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ToolbarCustomization(py)buttonText":{"name":"buttonText","abstract":"

Text for the button. For example, “Cancel”.

","parent_name":"BTThreeDSecureV2ToolbarCustomization"},"Classes/BTThreeDSecureV2ToolbarCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ToolbarCustomization(im)init":{"name":"init()","parent_name":"BTThreeDSecureV2ToolbarCustomization"},"Classes/BTThreeDSecureV2TextBoxCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2TextBoxCustomization(py)borderWidth":{"name":"borderWidth","abstract":"

Width (integer value) of the text box border.

","parent_name":"BTThreeDSecureV2TextBoxCustomization"},"Classes/BTThreeDSecureV2TextBoxCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2TextBoxCustomization(py)borderColor":{"name":"borderColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2TextBoxCustomization"},"Classes/BTThreeDSecureV2TextBoxCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2TextBoxCustomization(py)cornerRadius":{"name":"cornerRadius","abstract":"

Radius (integer value) for the text box corners.

","parent_name":"BTThreeDSecureV2TextBoxCustomization"},"Classes/BTThreeDSecureV2TextBoxCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2TextBoxCustomization(im)init":{"name":"init()","parent_name":"BTThreeDSecureV2TextBoxCustomization"},"Classes/BTThreeDSecureV2LabelCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2LabelCustomization(py)headingTextColor":{"name":"headingTextColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2LabelCustomization"},"Classes/BTThreeDSecureV2LabelCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2LabelCustomization(py)headingTextFontName":{"name":"headingTextFontName","abstract":"

Font type for the heading label text.

","parent_name":"BTThreeDSecureV2LabelCustomization"},"Classes/BTThreeDSecureV2LabelCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2LabelCustomization(py)headingTextFontSize":{"name":"headingTextFontSize","abstract":"

Font size for the heading label text.

","parent_name":"BTThreeDSecureV2LabelCustomization"},"Classes/BTThreeDSecureV2LabelCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2LabelCustomization(im)init":{"name":"init()","parent_name":"BTThreeDSecureV2LabelCustomization"},"Classes/BTThreeDSecureV2ButtonCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ButtonCustomization(py)backgroundColor":{"name":"backgroundColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2ButtonCustomization"},"Classes/BTThreeDSecureV2ButtonCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ButtonCustomization(py)cornerRadius":{"name":"cornerRadius","abstract":"

Radius (integer value) for the button corners.

","parent_name":"BTThreeDSecureV2ButtonCustomization"},"Classes/BTThreeDSecureV2ButtonCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ButtonCustomization(im)init":{"name":"init()","parent_name":"BTThreeDSecureV2ButtonCustomization"},"Classes/BTThreeDSecureV2BaseCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2BaseCustomization(py)textFontName":{"name":"textFontName","abstract":"

Font type for the UI element.

","parent_name":"BTThreeDSecureV2BaseCustomization"},"Classes/BTThreeDSecureV2BaseCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2BaseCustomization(py)textColor":{"name":"textColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2BaseCustomization"},"Classes/BTThreeDSecureV2BaseCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2BaseCustomization(py)textFontSize":{"name":"textFontSize","abstract":"

Font size for the UI element.

","parent_name":"BTThreeDSecureV2BaseCustomization"},"Classes/BTThreeDSecureResult.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureResult(py)tokenizedCard":{"name":"tokenizedCard","abstract":"

The BTCardNonce resulting from the 3D Secure flow

","parent_name":"BTThreeDSecureResult"},"Classes/BTThreeDSecureResult.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureResult(py)lookup":{"name":"lookup","abstract":"

The result of a 3D Secure lookup. Contains liability shift and challenge information.

","parent_name":"BTThreeDSecureResult"},"Classes/BTThreeDSecureResult.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureResult(py)errorMessage":{"name":"errorMessage","abstract":"

The error message when the 3D Secure flow is unsuccessful

","parent_name":"BTThreeDSecureResult"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)nonce":{"name":"nonce","abstract":"

A nonce to be verified by ThreeDSecure

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)amount":{"name":"amount","abstract":"

The amount for the transaction

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)accountType":{"name":"accountType","abstract":"

Optional. The account type selected by the cardholder

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)billingAddress":{"name":"billingAddress","abstract":"

Optional. The billing address used for verification

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)mobilePhoneNumber":{"name":"mobilePhoneNumber","abstract":"

Optional. The mobile phone number used for verification

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)email":{"name":"email","abstract":"

Optional. The email used for verification

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)shippingMethod":{"name":"shippingMethod","abstract":"

Optional. The shipping method chosen for the transaction

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)additionalInformation":{"name":"additionalInformation","abstract":"

Optional. The additional information used for verification

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)challengeRequested":{"name":"challengeRequested","abstract":"

Optional. If set to true, an authentication challenge will be forced if possible.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)exemptionRequested":{"name":"exemptionRequested","abstract":"

Optional. If set to true, an exemption to the authentication challenge will be requested.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)requestedExemptionType":{"name":"requestedExemptionType","abstract":"

Optional. The exemption type to be requested. If an exemption is requested and the exemption’s conditions are satisfied, then it will be applied.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)dataOnlyRequested":{"name":"dataOnlyRequested","abstract":"

Optional. Indicates whether to use the data only flow. In this flow, frictionless 3DS is ensured for Mastercard cardholders as the card scheme provides a risk score","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)cardAddChallenge":{"name":"cardAddChallenge","abstract":"

Optional. An authentication created using this property should only be used for adding a payment method to the merchant’s vault and not for creating transactions.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)v2UICustomization":{"name":"v2UICustomization","abstract":"

Optional. UI Customization for 3DS2 challenge views.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)threeDSecureRequestDelegate":{"name":"threeDSecureRequestDelegate","abstract":"

A delegate for receiving information about the ThreeDSecure payment flow.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)givenName":{"name":"givenName","abstract":"

Optional. Given name associated with the address

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)surname":{"name":"surname","abstract":"

Optional. Surname associated with the address

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)streetAddress":{"name":"streetAddress","abstract":"

Optional. Line 1 of the Address (eg. number, street, etc)

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)extendedAddress":{"name":"extendedAddress","abstract":"

Optional. Line 2 of the Address (eg. suite, apt #, etc.)

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)line3":{"name":"line3","abstract":"

Optional. Line 3 of the Address (eg. suite, apt #, etc.)

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)locality":{"name":"locality","abstract":"

Optional. City name

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)region":{"name":"region","abstract":"

Optional. Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)postalCode":{"name":"postalCode","abstract":"

Optional. Zip code or equivalent is usually required for countries that have them.","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)countryCodeAlpha2":{"name":"countryCodeAlpha2","abstract":"

Optional. 2 letter country code

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)phoneNumber":{"name":"phoneNumber","abstract":"

Optional. The phone number associated with the address

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@CM@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(im)copyWithZone:":{"name":"copy(with:)","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)paReq":{"name":"paReq","abstract":"

The “PAReq” or “Payment Authentication Request” is the encoded request message used to initiate authentication.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)md":{"name":"md","abstract":"

The unique 3DS identifier assigned by Braintree to track the 3DS call as it progresses.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)acsURL":{"name":"acsURL","abstract":"

The URL which the customer will be redirected to for a 3DS Interface.","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)termURL":{"name":"termURL","abstract":"

The termURL is the fully qualified URL that the customer will be redirected to once the authentication completes.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)threeDSecureVersion":{"name":"threeDSecureVersion","abstract":"

The full version string of the 3DS lookup result.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)isThreeDSecureVersion2":{"name":"isThreeDSecureVersion2","abstract":"

Indicates a 3DS 2 lookup result.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)transactionID":{"name":"transactionID","abstract":"

This a secondary unique 3DS identifier assigned by Braintree to track the 3DS call as it progresses.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)requiresUserAuthentication":{"name":"requiresUserAuthentication","abstract":"

Indicates that a 3DS challenge is required.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initialize a new BTThreeDSecureClient instance.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)startPaymentFlow:completion:":{"name":"startPaymentFlow(_:completion:)","abstract":"

Starts the 3DS flow using a BTThreeDSecureRequest.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)prepareLookup:completion:":{"name":"prepareLookup(_:completion:)","abstract":"

Creates a stringified JSON object containing the information necessary to perform a lookup.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)prepareLookup:completionHandler:":{"name":"prepareLookup(_:)","abstract":"

Creates a stringified JSON object containing the information necessary to perform a lookup.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)initializeChallengeWithLookupResponse:request:completion:":{"name":"initializeChallenge(lookupResponse:request:completion:)","abstract":"

Initialize a challenge from a server side lookup call.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)initializeChallengeWithLookupResponse:request:completionHandler:":{"name":"initializeChallenge(lookupResponse:request:)","abstract":"

Initialize a challenge from a server side lookup call.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingAddress":{"name":"shippingAddress","abstract":"

Optional. The shipping address used for verification

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingMethodIndicator":{"name":"shippingMethodIndicator","abstract":"

Optional. The 2-digit string indicating the shipping method chosen for the transaction

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)productCode":{"name":"productCode","abstract":"

Optional. The 3-letter string representing the merchant product code

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)deliveryTimeframe":{"name":"deliveryTimeframe","abstract":"

Optional. The 2-digit number indicating the delivery timeframe

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)deliveryEmail":{"name":"deliveryEmail","abstract":"

Optional. For electronic delivery, email address to which the merchandise was delivered

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)reorderIndicator":{"name":"reorderIndicator","abstract":"

Optional. The 2-digit number indicating whether the cardholder is reordering previously purchased merchandise

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)preorderIndicator":{"name":"preorderIndicator","abstract":"

Optional. The 2-digit number indicating whether the cardholder is placing an order with a future availability or release date

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)preorderDate":{"name":"preorderDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating expected date that a pre-ordered purchase will be available

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)giftCardAmount":{"name":"giftCardAmount","abstract":"

Optional. The purchase amount total for prepaid gift cards in major units

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)giftCardCurrencyCode":{"name":"giftCardCurrencyCode","abstract":"

Optional. ISO 4217 currency code for the gift card purchased

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)giftCardCount":{"name":"giftCardCount","abstract":"

Optional. Total count of individual prepaid gift cards purchased

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountAgeIndicator":{"name":"accountAgeIndicator","abstract":"

Optional. The 2-digit value representing the length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountCreateDate":{"name":"accountCreateDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder’s account was last changed.","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountChangeIndicator":{"name":"accountChangeIndicator","abstract":"

Optional. The 2-digit value representing the length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountChangeDate":{"name":"accountChangeDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder’s account was last changed.","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountPwdChangeIndicator":{"name":"accountPwdChangeIndicator","abstract":"

Optional. The 2-digit value representing the length of time since the cardholder changed or reset the password on the account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountPwdChangeDate":{"name":"accountPwdChangeDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder last changed or reset password on account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingAddressUsageIndicator":{"name":"shippingAddressUsageIndicator","abstract":"

Optional. The 2-digit value indicating when the shipping address used for transaction was first used.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingAddressUsageDate":{"name":"shippingAddressUsageDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date when the shipping address used for this transaction was first used.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)transactionCountDay":{"name":"transactionCountDay","abstract":"

Optional. Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)transactionCountYear":{"name":"transactionCountYear","abstract":"

Optional. Number of transactions (successful or abandoned) for this cardholder account within the last year.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)addCardAttempts":{"name":"addCardAttempts","abstract":"

Optional. Number of add card attempts in the last 24 hours.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountPurchases":{"name":"accountPurchases","abstract":"

Optional. Number of purchases with this cardholder account during the previous six months.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)fraudActivity":{"name":"fraudActivity","abstract":"

Optional. The 2-digit value indicating whether the merchant experienced suspicious activity (including previous fraud) on the account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingNameIndicator":{"name":"shippingNameIndicator","abstract":"

Optional. The 2-digit value indicating if the cardholder name on the account is identical to the shipping name used for the transaction.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)paymentAccountIndicator":{"name":"paymentAccountIndicator","abstract":"

Optional. The 2-digit value indicating the length of time that the payment account was enrolled in the merchant account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)paymentAccountAge":{"name":"paymentAccountAge","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date the payment account was added to the cardholder account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)addressMatch":{"name":"addressMatch","abstract":"

Optional. The 1-character value (Y/N) indicating whether cardholder billing and shipping addresses match.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountID":{"name":"accountID","abstract":"

Optional. Additional cardholder account information.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)ipAddress":{"name":"ipAddress","abstract":"

Optional. The IP address of the consumer. IPv4 and IPv6 are supported.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)orderDescription":{"name":"orderDescription","abstract":"

Optional. Brief description of items purchased.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)taxAmount":{"name":"taxAmount","abstract":"

Optional. Unformatted tax amount without any decimalization (ie. $123.67 = 12367).

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)userAgent":{"name":"userAgent","abstract":"

Optional. The exact content of the HTTP user agent header.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)authenticationIndicator":{"name":"authenticationIndicator","abstract":"

Optional. The 2-digit number indicating the type of authentication request.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)installment":{"name":"installment","abstract":"

Optional. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)purchaseDate":{"name":"purchaseDate","abstract":"

Optional. The 14-digit number (format: YYYYMMDDHHMMSS) indicating the date in UTC of original purchase.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)recurringEnd":{"name":"recurringEnd","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date after which no further recurring authorizations should be performed.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)recurringFrequency":{"name":"recurringFrequency","abstract":"

Optional. Integer value indicating the minimum number of days between recurring authorizations.","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)sdkMaxTimeout":{"name":"sdkMaxTimeout","abstract":"

Optional. The 2-digit number of minutes (minimum 05) to set the maximum amount of time for all 3DS 2.0 messages to be communicated between all components.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)workPhoneNumber":{"name":"workPhoneNumber","abstract":"

Optional. The work phone number used for verification. Only numbers; remove dashes, parenthesis and other characters.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)billingAddress":{"name":"billingAddress","abstract":"

The billing address.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)clientMetadataID":{"name":"clientMetadataID","abstract":"

Client Metadata ID associated with this transaction.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)email":{"name":"email","abstract":"

Payer’s email address.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)firstName":{"name":"firstName","abstract":"

Payer’s first name.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)lastName":{"name":"lastName","abstract":"

Payer’s last name.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)nonce":{"name":"nonce","abstract":"

The one-time use payment method nonce.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)payerID":{"name":"payerID","abstract":"

Payer ID associated with this transaction.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)phone":{"name":"phone","abstract":"

Payer’s phone number.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)shippingAddress":{"name":"shippingAddress","abstract":"

The shipping address.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)type":{"name":"type","abstract":"

The type of the tokenized payment.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)paymentType":{"name":"paymentType","abstract":"

The type of payment.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)paymentTypeCountryCode":{"name":"paymentTypeCountryCode","abstract":"

The country code of the local payment.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)merchantAccountID":{"name":"merchantAccountID","abstract":"

Optional: The address of the customer. An error will occur if this address is not valid.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)address":{"name":"address","abstract":"

Optional: The address of the customer. An error will occur if this address is not valid.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)amount":{"name":"amount","abstract":"

The amount for the transaction.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)currencyCode":{"name":"currencyCode","abstract":"

Optional: A valid ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)displayName":{"name":"displayName","abstract":"

Optional: The merchant name displayed inside of the local payment flow.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)email":{"name":"email","abstract":"

Optional: Payer email of the customer.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)givenName":{"name":"givenName","abstract":"

Optional: Given (first) name of the customer.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)surname":{"name":"surname","abstract":"

Optional: Surname (last name) of the customer.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)phone":{"name":"phone","abstract":"

Optional: Phone number of the customer.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)isShippingAddressRequired":{"name":"isShippingAddressRequired","abstract":"

Indicates whether or not the payment needs to be shipped. For digital goods, this should be false. Defaults to false.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)bic":{"name":"bic","abstract":"

Optional: Bank Identification Code of the customer (specific to iDEAL transactions).

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)localPaymentFlowDelegate":{"name":"localPaymentFlowDelegate","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentClient.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initialize a new BTLocalPaymentClient instance.

","parent_name":"BTLocalPaymentClient"},"Classes/BTLocalPaymentClient.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentClient(im)startPaymentFlow:completion:":{"name":"startPaymentFlow(_:completion:)","abstract":"

Starts a payment flow using a BTLocalPaymentRequest

","parent_name":"BTLocalPaymentClient"},"Classes/BTLocalPaymentClient.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentClient(im)startPaymentFlow:completionHandler:":{"name":"startPaymentFlow(_:)","abstract":"

Starts a payment flow using a BTLocalPaymentRequest

","parent_name":"BTLocalPaymentClient"},"Classes/BTApplePayClient.html#/c:@M@BraintreeApplePay@objc(cs)BTApplePayClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates an Apple Pay client

","parent_name":"BTApplePayClient"},"Classes/BTApplePayClient.html#/c:@M@BraintreeApplePay@objc(cs)BTApplePayClient(im)makePaymentRequest:":{"name":"makePaymentRequest(completion:)","abstract":"

Creates a PKPaymentRequest with values from your Braintree Apple Pay configuration.","parent_name":"BTApplePayClient"},"Classes/BTApplePayClient.html#/s:17BraintreeApplePay07BTAppleC6ClientC18makePaymentRequestSo09PKPaymentH0CyYaKF":{"name":"makePaymentRequest()","abstract":"

Creates a PKPaymentRequest with values from your Braintree Apple Pay configuration.","parent_name":"BTApplePayClient"},"Classes/BTApplePayClient.html#/c:@M@BraintreeApplePay@objc(cs)BTApplePayClient(im)tokenizeApplePayPayment:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenizes an Apple Pay payment.

","parent_name":"BTApplePayClient"},"Classes/BTApplePayClient.html#/s:17BraintreeApplePay07BTAppleC6ClientC8tokenizeyAA0dC9CardNonceCSo9PKPaymentCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenizes an Apple Pay payment.

","parent_name":"BTApplePayClient"},"Classes/BTApplePayCardNonce.html#/c:@M@BraintreeApplePay@objc(cs)BTApplePayCardNonce(py)binData":{"name":"binData","abstract":"

The BIN data for the card number associated with this nonce.

","parent_name":"BTApplePayCardNonce"},"Classes/BTDataCollector.html#/c:@M@BraintreeDataCollector@objc(cs)BTDataCollector(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initializes a BTDataCollector instance with a BTAPIClient.

","parent_name":"BTDataCollector"},"Classes/BTDataCollector.html#/c:@M@BraintreeDataCollector@objc(cs)BTDataCollector(im)clientMetadataID:":{"name":"clientMetadataID(_:)","abstract":"

Returns a client metadata ID.

","parent_name":"BTDataCollector"},"Classes/BTDataCollector.html#/c:@M@BraintreeDataCollector@objc(cs)BTDataCollector(im)collectDeviceData:":{"name":"collectDeviceData(_:)","abstract":"

Collects device data based on your merchant configuration.

","parent_name":"BTDataCollector"},"Classes/BTDataCollector.html#/s:22BraintreeDataCollector06BTDataC0C013collectDeviceB0SSyYaKF":{"name":"collectDeviceData()","abstract":"

Collects device data based on your merchant configuration.

","parent_name":"BTDataCollector"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)errorCode":{"name":"errorCode","abstract":"

Optional. An error code when there was an issue fetching the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)errorMessage":{"name":"errorMessage","abstract":"

Optional. An error message when there was an issue fetching the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)conversionRate":{"name":"conversionRate","abstract":"

Optional. The conversion rate associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)currencyAmount":{"name":"currencyAmount","abstract":"

Optional. The currency amount associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)currencyIsoCode":{"name":"currencyIsoCode","abstract":"

Optional. The currency ISO code associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)requestID":{"name":"requestID","abstract":"

Optional. The request ID used when fetching the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)rewardsAmount":{"name":"rewardsAmount","abstract":"

Optional. The rewards amount associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)rewardsUnit":{"name":"rewardsUnit","abstract":"

Optional. The rewards unit associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressClient.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates an American Express client.

","parent_name":"BTAmericanExpressClient"},"Classes/BTAmericanExpressClient.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressClient(im)getRewardsBalanceForNonce:currencyIsoCode:completion:":{"name":"getRewardsBalance(forNonce:currencyISOCode:completion:)","abstract":"

Gets the rewards balance associated with a Braintree nonce. Only for American Express cards.

","parent_name":"BTAmericanExpressClient"},"Classes/BTAmericanExpressClient.html#/s:24BraintreeAmericanExpress010BTAmericanC6ClientC17getRewardsBalance8forNonce15currencyISOCodeAA0dcgH0CSS_SStYaKF":{"name":"getRewardsBalance(forNonce:currencyISOCode:)","abstract":"

Gets the rewards balance associated with a Braintree nonce. Only for American Express cards.

","parent_name":"BTAmericanExpressClient"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)accountHolderName":{"name":"accountHolderName","abstract":"

Required. The account holder name.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)iban":{"name":"iban","abstract":"

Required. The full IBAN.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)customerID":{"name":"customerID","abstract":"

Required. The customer ID.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/s:24BraintreeSEPADirectDebit012BTSEPADirectC7RequestC11mandateTypeAA0dc7MandateG0OSgvp":{"name":"mandateType","abstract":"

Optional. The BTSEPADebitMandateType. If not set, defaults to .oneOff

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)billingAddress":{"name":"billingAddress","abstract":"

Required. The user’s billing address.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)merchantAccountID":{"name":"merchantAccountID","abstract":"

Optional. A non-default merchant account to use for tokenization.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/s:24BraintreeSEPADirectDebit012BTSEPADirectC7RequestC17accountHolderName4iban10customerID11mandateType14billingAddress015merchantAccountK0ACSSSg_A2jA0dc7MandateM0OSg0A4Core08BTPostalO0CSgAJtcfc":{"name":"init(accountHolderName:iban:customerID:mandateType:billingAddress:merchantAccountID:)","abstract":"

Initialize a new SEPA Direct Debit request.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitNonce.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitNonce(py)ibanLastFour":{"name":"ibanLastFour","abstract":"

The IBAN last four characters.

","parent_name":"BTSEPADirectDebitNonce"},"Classes/BTSEPADirectDebitNonce.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitNonce(py)customerID":{"name":"customerID","abstract":"

The customer ID.

","parent_name":"BTSEPADirectDebitNonce"},"Classes/BTSEPADirectDebitNonce.html#/s:24BraintreeSEPADirectDebit012BTSEPADirectC5NonceC11mandateTypeAA0dc7MandateG0OSgvp":{"name":"mandateType","abstract":"

The BTSEPADebitMandateType.

","parent_name":"BTSEPADirectDebitNonce"},"Classes/BTSEPADirectDebitClient.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates a SEPA Direct Debit client.

","parent_name":"BTSEPADirectDebitClient"},"Classes/BTSEPADirectDebitClient.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitClient(im)tokenizeWithSEPADirectDebitRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Initiates an ASWebAuthenticationSession to display a mandate to the user. Upon successful mandate creation, tokenizes the payment method and returns a result

","parent_name":"BTSEPADirectDebitClient"},"Classes/BTSEPADirectDebitClient.html#/s:24BraintreeSEPADirectDebit012BTSEPADirectC6ClientC8tokenizeyAA0dC5NonceCAA0dC7RequestCYaKF":{"name":"tokenize(_:)","abstract":"

Initiates an ASWebAuthenticationSession to display a mandate to the user. Upon successful mandate creation, tokenizes the payment method and returns a result

","parent_name":"BTSEPADirectDebitClient"},"Classes/BTPayPalNativeVaultRequest.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeVaultRequest(im)initWithOfferCredit:billingAgreementDescription:":{"name":"init(offerCredit:billingAgreementDescription:)","abstract":"

Initializes a PayPal Native Vault request

","parent_name":"BTPayPalNativeVaultRequest"},"Classes/BTPayPalNativeCheckoutRequest.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutRequest(im)initWithAmount:intent:offerPayLater:currencyCode:requestBillingAgreement:billingAgreementDescription:":{"name":"init(amount:intent:offerPayLater:currencyCode:requestBillingAgreement:billingAgreementDescription:)","abstract":"

Initializes a PayPal Native Checkout request

","parent_name":"BTPayPalNativeCheckoutRequest"},"Classes/BTPayPalNativeCheckoutClient.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initializes a PayPal Native client.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutClient.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutClient(im)tokenizeWithNativeCheckoutRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Native Checkout flow.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutClient.html#/s:29BraintreePayPalNativeCheckout05BTPaycdE6ClientC8tokenizeyAA0fcdE12AccountNonceCAA0fcdE7RequestCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Native Checkout flow.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutClient.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutClient(im)tokenizeWithNativeVaultRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Native Vault flow.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutClient.html#/s:29BraintreePayPalNativeCheckout05BTPaycdE6ClientC8tokenizeyAA0fcdE12AccountNonceCAA0fcD12VaultRequestCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Native Vault flow.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)email":{"name":"email","abstract":"

Payer’s email address.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)firstName":{"name":"firstName","abstract":"

Payer’s first name.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)lastName":{"name":"lastName","abstract":"

Payer’s last name.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)phone":{"name":"phone","abstract":"

Payer’s phone number.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)billingAddress":{"name":"billingAddress","abstract":"

The billing address.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)shippingAddress":{"name":"shippingAddress","abstract":"

The shipping address.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)clientMetadataID":{"name":"clientMetadataID","abstract":"

Client metadata id associated with this transaction.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)payerID":{"name":"payerID","abstract":"

Optional. Payer id associated with this transaction.","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTURLUtils.html#/c:@M@BraintreeCore@objc(cs)BTURLUtils(cm)queryStringWithDictionary:":{"name":"queryString(from:)","abstract":"

Converts a key/value dictionary to a valid query string

","parent_name":"BTURLUtils"},"Classes/BTURLUtils.html#/c:@M@BraintreeCore@objc(cs)BTURLUtils(cm)queryParametersForURL:":{"name":"queryParameters(for:)","abstract":"

Extract query parameters from a URL

","parent_name":"BTURLUtils"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)recipientName":{"name":"recipientName","abstract":"

Optional. Recipient name for shipping address.

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)streetAddress":{"name":"streetAddress","abstract":"

Line 1 of the Address (eg. number, street, etc).

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)extendedAddress":{"name":"extendedAddress","abstract":"

Optional line 2 of the Address (eg. suite, apt #, etc.).

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)locality":{"name":"locality","abstract":"

City name

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)countryCodeAlpha2":{"name":"countryCodeAlpha2","abstract":"

2 letter country code.

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)postalCode":{"name":"postalCode","abstract":"

Zip code or equivalent is usually required for countries that have them.","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)region":{"name":"region","abstract":"

Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(im)copyWithZone:":{"name":"copy(with:)","parent_name":"BTPostalAddress"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(cpy)sharedParser":{"name":"shared","abstract":"

The singleton instance

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(py)allTypes":{"name":"allTypes","abstract":"

An array of the tokenization types currently registered

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(im)isTypeAvailable:":{"name":"isTypeAvailable(_:)","abstract":"

Indicates whether a tokenization type is currently registered

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(im)registerType:withParsingBlock:":{"name":"registerType(_:withParsingBlock:)","abstract":"

Registers a parsing block for a tokenization type.

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(im)parseJSON:withParsingBlockForType:":{"name":"parseJSON(_:withParsingBlockForType:)","abstract":"

Parses tokenized payment information that has been serialized to JSON, and returns a BTPaymentMethodNonce object.

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(py)nonce":{"name":"nonce","abstract":"

The payment method nonce.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(py)type":{"name":"type","abstract":"

The string identifying the type of the payment method.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(py)isDefault":{"name":"isDefault","abstract":"

The boolean indicating whether this is a default payment method.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(im)initWithNonce:":{"name":"init(nonce:)","abstract":"

Initialize a new Payment Method Nonce.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(im)initWithNonce:type:":{"name":"init(nonce:type:)","abstract":"

Initialize a new Payment Method Nonce.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(im)initWithNonce:type:isDefault:":{"name":"init(nonce:type:isDefault:)","abstract":"

Initialize a new Payment Method Nonce.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTLogLevelDescription.html#/c:@M@BraintreeCore@objc(cs)BTLogLevelDescription(cm)stringFor:":{"name":"string(for:)","parent_name":"BTLogLevelDescription"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)init":{"name":"init()","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)initWithValue:":{"name":"init(value:)","abstract":"

Initialize with a value.

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)initWithData:":{"name":"init(data:)","abstract":"

Initialize with data.

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isString":{"name":"isString","abstract":"

Checks if the BTJSON is a String

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isBool":{"name":"isBool","abstract":"

Checks if the BTJSON is a Bool

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isNumber":{"name":"isNumber","abstract":"

Checks if the BTJSON is a NSNumber

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isArray":{"name":"isArray","abstract":"

Checks if the BTJSON is a [Any]

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isObject":{"name":"isObject","abstract":"

Checks if the BTJSON is a [String: Any]

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isError":{"name":"isError","abstract":"

Checks if the BTJSON is an error.

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isTrue":{"name":"isTrue","abstract":"

Checks if the BTJSON is a value representing true

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isFalse":{"name":"isFalse","abstract":"

Checks if the BTJSON is a value representing false

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isNull":{"name":"isNull","abstract":"

Checks if the BTJSON is a value representing nil

","parent_name":"BTJSON"},"Classes/BTJSON.html#/s:13BraintreeCore6BTJSONCyACSicip":{"name":"subscript(_:)","abstract":"

Indexes into the JSON as if the current value is an object

","parent_name":"BTJSON"},"Classes/BTJSON.html#/s:13BraintreeCore6BTJSONCyACSScip":{"name":"subscript(_:)","abstract":"

Indexes into the JSON as if the current value is an array

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asError":{"name":"asError()","abstract":"

The BTJSON as a NSError.

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asString":{"name":"asString()","abstract":"

The BTJSON as a String

","parent_name":"BTJSON"},"Classes/BTJSON.html#/s:13BraintreeCore6BTJSONC6asBoolSbSgyF":{"name":"asBool()","abstract":"

The BTJSON as a Bool

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asArray":{"name":"asArray()","abstract":"

The BTJSON as a [BTJSON]

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asNumber":{"name":"asNumber()","abstract":"

The BTJSON as a NSNumber

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asURL":{"name":"asURL()","abstract":"

The BTJSON as a URL

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asStringArray":{"name":"asStringArray()","abstract":"

The BTJSON as a [String]

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asDictionary":{"name":"asDictionary()","abstract":"

The BTJSON as a NSDictionary

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asIntegerOrZero":{"name":"asIntegerOrZero()","abstract":"

The BTJSON as a Int

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asEnum:orDefault:":{"name":"asEnum(_:orDefault:)","abstract":"

The BTJSON as an Enum

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asAddress":{"name":"asAddress()","abstract":"

The BTJSON as a BTPostalAddress

","parent_name":"BTJSON"},"Classes/BTConfiguration.html#/c:@M@BraintreeCore@objc(cs)BTConfiguration(py)json":{"name":"json","abstract":"

The merchant account’s configuration as a BTJSON object

","parent_name":"BTConfiguration"},"Classes/BTConfiguration.html#/c:@M@BraintreeCore@objc(cs)BTConfiguration(py)environment":{"name":"environment","abstract":"

The environment (production or sandbox)

","parent_name":"BTConfiguration"},"Classes/BTConfiguration.html#/c:@M@BraintreeCore@objc(cs)BTConfiguration(im)initWithJSON:":{"name":"init(json:)","abstract":"

Used to initialize a BTConfiguration

","parent_name":"BTConfiguration"},"Classes/BTClientToken.html#/c:@M@BraintreeCore@objc(cs)BTClientToken(im)encodeWithCoder:":{"name":"encode(with:)","parent_name":"BTClientToken"},"Classes/BTClientToken.html#/c:@M@BraintreeCore@objc(cs)BTClientToken(im)initWithCoder:":{"name":"init(coder:)","parent_name":"BTClientToken"},"Classes/BTClientToken.html#/c:@M@BraintreeCore@objc(cs)BTClientToken(im)copyWithZone:":{"name":"copy(with:)","parent_name":"BTClientToken"},"Classes/BTClientToken.html#/c:@M@BraintreeCore@objc(cs)BTClientToken(im)isEqual:":{"name":"isEqual(_:)","parent_name":"BTClientToken"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)integration":{"name":"integration","abstract":"

Integration type

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)source":{"name":"source","abstract":"

Integration source

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)sessionID":{"name":"sessionID","abstract":"

Auto-generated UUID

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)integrationString":{"name":"integrationString","abstract":"

String representation of the integration

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)sourceString":{"name":"sourceString","abstract":"

String representation of the source

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)parameters":{"name":"parameters","abstract":"

Additional metadata parameters

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(im)init":{"name":"init()","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(im)mutableCopyWithZone:":{"name":"mutableCopy(with:)","abstract":"

Create a copy as BTMutableClientMetadata

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(im)copyWithZone:":{"name":"copy(with:)","abstract":"

Creates a copy of BTClientMetadata

","parent_name":"BTClientMetadata"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)prepaid":{"name":"prepaid","abstract":"

Whether the card is a prepaid card. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)healthcare":{"name":"healthcare","abstract":"

Whether the card is a healthcare card. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)debit":{"name":"debit","abstract":"

Whether the card is a debit card. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)durbinRegulated":{"name":"durbinRegulated","abstract":"

A value indicating whether the issuing bank’s card range is regulated by the Durbin Amendment due to the bank’s assets. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)commercial":{"name":"commercial","abstract":"

Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)payroll":{"name":"payroll","abstract":"

Whether the card is a payroll card. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)issuingBank":{"name":"issuingBank","abstract":"

The bank that issued the credit card, if available.

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)countryOfIssuance":{"name":"countryOfIssuance","abstract":"

The country that issued the credit card, if available.

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)productID":{"name":"productID","abstract":"

The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)), if available.

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(im)initWithJSON:":{"name":"init(json:)","abstract":"

Create a BTBinData object from JSON.

","parent_name":"BTBinData"},"Classes/BTAppContextSwitcher.html#/c:@M@BraintreeCore@objc(cs)BTAppContextSwitcher(cpy)sharedInstance":{"name":"sharedInstance","abstract":"

Singleton for shared instance of BTAppContextSwitcher

","parent_name":"BTAppContextSwitcher"},"Classes/BTAppContextSwitcher.html#/c:@M@BraintreeCore@objc(cs)BTAppContextSwitcher(py)returnURLScheme":{"name":"returnURLScheme","abstract":"

The URL scheme to return to this app after switching to another app or opening a SFSafariViewController.","parent_name":"BTAppContextSwitcher"},"Classes/BTAppContextSwitcher.html#/c:@M@BraintreeCore@objc(cs)BTAppContextSwitcher(im)registerAppContextSwitchClient:":{"name":"register(_:)","abstract":"

Registers a class Type that can handle a return from app context switch with a static method.

","parent_name":"BTAppContextSwitcher"},"Classes/BTAPIPinnedCertificates.html#/c:@M@BraintreeCore@objc(cs)BTAPIPinnedCertificates(cm)trustedCertificates":{"name":"trustedCertificates()","parent_name":"BTAPIPinnedCertificates"},"Classes/BTAPIClient.html#/s:13BraintreeCore11BTAPIClientC17RequestCompletiona":{"name":"RequestCompletion","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(py)tokenizationKey":{"name":"tokenizationKey","abstract":"

The tokenization key used to authorize the APIClient

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(py)clientToken":{"name":"clientToken","abstract":"

The client token used to authorize the APIClient

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(py)metadata":{"name":"metadata","abstract":"

Client metadata that is used for tracking the client session

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(im)initWithAuthorization:":{"name":"init(authorization:)","abstract":"

Initialize a new API client.

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(im)fetchOrReturnRemoteConfiguration:":{"name":"fetchOrReturnRemoteConfiguration(_:)","abstract":"

Provides configuration data as a BTJSON object.

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(im)fetchPaymentMethodNonces:":{"name":"fetchPaymentMethodNonces(_:)","abstract":"

Fetches a customer’s vaulted payment method nonces.","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(im)fetchPaymentMethodNonces:completion:":{"name":"fetchPaymentMethodNonces(_:completion:)","abstract":"

Fetches a customer’s vaulted payment method nonces.","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html":{"name":"BTAPIClient","abstract":"

This class acts as the entry point for accessing the Braintree APIs via common HTTP methods performed on API endpoints.

"},"Classes/BTAPIPinnedCertificates.html":{"name":"BTAPIPinnedCertificates","abstract":"

THIS CODE IS GENERATED BY codify_certificates.swift"},"Classes/BTAppContextSwitcher.html":{"name":"BTAppContextSwitcher","abstract":"

Handles return URLs when returning from app context switch and routes the return URL to the correct app context switch client class.

"},"Classes/BTBinData.html":{"name":"BTBinData","abstract":"

Contains the bin data associated with a payment method

"},"Classes/BTClientMetadata.html":{"name":"BTClientMetadata","abstract":"

Represents the metadata associated with a session for posting along with payment data during tokenization.

"},"Classes/BTClientToken.html":{"name":"BTClientToken","abstract":"

An authorization string used to initialize the Braintree SDK

"},"Classes/BTConfiguration.html":{"name":"BTConfiguration","abstract":"

Contains information specific to a merchant’s Braintree integration

"},"Classes/BTJSON.html":{"name":"BTJSON","abstract":"

A type-safe wrapper around JSON"},"Classes/BTLogLevelDescription.html":{"name":"BTLogLevelDescription","abstract":"

Wrapper for accessing the string value of the log level

"},"Classes.html#/c:@M@BraintreeCore@objc(cs)BTMutableClientMetadata":{"name":"BTMutableClientMetadata","abstract":"

Required for Objective-C compatibility. Necessary behavior is provided by the swift version.

"},"Classes/BTPaymentMethodNonce.html":{"name":"BTPaymentMethodNonce","abstract":"

BTPaymentMethodNonce is for generic tokenized payment information.

"},"Classes/BTPaymentMethodNonceParser.html":{"name":"BTPaymentMethodNonceParser","abstract":"

A JSON parser that parses BTJSON into concrete BTPaymentMethodNonce objects. It supports registration of parsers at runtime.

"},"Classes/BTPostalAddress.html":{"name":"BTPostalAddress","abstract":"

Generic postal address

"},"Classes/BTURLUtils.html":{"name":"BTURLUtils","abstract":"

A helper class for converting URL queries to and from dictionaries

"},"Classes/BTPayPalNativeCheckoutAccountNonce.html":{"name":"BTPayPalNativeCheckoutAccountNonce","abstract":"

Contains information about a PayPal payment method.

"},"Classes/BTPayPalNativeCheckoutClient.html":{"name":"BTPayPalNativeCheckoutClient","abstract":"

Client used to collect PayPal payment methods. If possible, this client will present a native flow; otherwise, it will fall back to a web flow.

"},"Classes/BTPayPalNativeCheckoutRequest.html":{"name":"BTPayPalNativeCheckoutRequest","abstract":"

Options for the PayPal Checkout flow.

"},"Classes/BTPayPalNativeVaultRequest.html":{"name":"BTPayPalNativeVaultRequest","abstract":"

Options for the PayPal Vault flow.

"},"Classes/BTSEPADirectDebitClient.html":{"name":"BTSEPADirectDebitClient","abstract":"

Used to integrate with SEPA Direct Debit.

"},"Classes/BTSEPADirectDebitNonce.html":{"name":"BTSEPADirectDebitNonce","abstract":"

A payment method nonce representing a SEPA Direct Debit payment.

"},"Classes/BTSEPADirectDebitRequest.html":{"name":"BTSEPADirectDebitRequest","abstract":"

Parameters for creating a SEPA Direct Debit tokenization request.

"},"Classes/BTAmericanExpressClient.html":{"name":"BTAmericanExpressClient","abstract":"

BTAmericanExpressClient enables you to look up the rewards balance of American Express cards.

"},"Classes/BTAmericanExpressRewardsBalance.html":{"name":"BTAmericanExpressRewardsBalance","abstract":"

Contains information about an American Express rewards balance.

"},"Classes/BTDataCollector.html":{"name":"BTDataCollector","abstract":"

Braintree’s advanced fraud protection solution.

"},"Classes/BTApplePayCardNonce.html":{"name":"BTApplePayCardNonce","abstract":"

Contains information about a tokenized Apple Pay card.

"},"Classes/BTApplePayClient.html":{"name":"BTApplePayClient","abstract":"

Used to process Apple Pay payments

"},"Classes/BTLocalPaymentClient.html":{"name":"BTLocalPaymentClient"},"Classes/BTLocalPaymentRequest.html":{"name":"BTLocalPaymentRequest","abstract":"

Used to initialize a local payment flow

"},"Classes/BTLocalPaymentResult.html":{"name":"BTLocalPaymentResult"},"Classes/BTThreeDSecureAdditionalInformation.html":{"name":"BTThreeDSecureAdditionalInformation","abstract":"

Additional information for a 3DS lookup. Used in 3DS 2.0+ flows.

"},"Classes/BTThreeDSecureClient.html":{"name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureLookup.html":{"name":"BTThreeDSecureLookup","abstract":"

The result of a 3DS lookup."},"Classes/BTThreeDSecurePostalAddress.html":{"name":"BTThreeDSecurePostalAddress","abstract":"

Postal address for 3D Secure flows

"},"Classes/BTThreeDSecureRequest.html":{"name":"BTThreeDSecureRequest","abstract":"

Used to initialize a 3D Secure payment flow

"},"Classes/BTThreeDSecureResult.html":{"name":"BTThreeDSecureResult","abstract":"

The result of a 3D Secure payment flow

"},"Classes/BTThreeDSecureV2BaseCustomization.html":{"name":"BTThreeDSecureV2BaseCustomization","abstract":"

Base customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2ButtonCustomization.html":{"name":"BTThreeDSecureV2ButtonCustomization","abstract":"

Button customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2LabelCustomization.html":{"name":"BTThreeDSecureV2LabelCustomization","abstract":"

Label customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2TextBoxCustomization.html":{"name":"BTThreeDSecureV2TextBoxCustomization","abstract":"

Text box customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2ToolbarCustomization.html":{"name":"BTThreeDSecureV2ToolbarCustomization","abstract":"

Toolbar customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2UICustomization.html":{"name":"BTThreeDSecureV2UICustomization","abstract":"

UI customization options for 3D Secure 2 flows.

"},"Classes/BTAuthenticationInsight.html":{"name":"BTAuthenticationInsight","abstract":"

Information pertaining to the regulatory environment for a credit card if authentication insight is requested during tokenization.

"},"Classes/BTCard.html":{"name":"BTCard","abstract":"

The card tokenization request represents raw credit or debit card data provided by the customer."},"Classes/BTCardClient.html":{"name":"BTCardClient","abstract":"

Used to process cards

"},"Classes/BTCardNonce.html":{"name":"BTCardNonce","abstract":"

Contains information about a tokenized card.

"},"Classes/BTCardRequest.html":{"name":"BTCardRequest","abstract":"

Contains information about a card to tokenize

"},"Classes/BTThreeDSecureInfo.html":{"name":"BTThreeDSecureInfo","abstract":"

Contains information about the 3D Secure status of a payment method

"},"Classes/BTPayPalAccountNonce.html":{"name":"BTPayPalAccountNonce","abstract":"

Contains information about a PayPal payment method

"},"Classes/BTPayPalCheckoutRequest.html":{"name":"BTPayPalCheckoutRequest","abstract":"

Options for the PayPal Checkout flow.

"},"Classes/BTPayPalClient.html":{"name":"BTPayPalClient"},"Classes/BTPayPalCreditFinancing.html":{"name":"BTPayPalCreditFinancing","abstract":"

Contains information about a PayPal credit financing option

"},"Classes/BTPayPalCreditFinancingAmount.html":{"name":"BTPayPalCreditFinancingAmount","abstract":"

Contains information about a PayPal credit amount

"},"Classes/BTPayPalLineItem.html":{"name":"BTPayPalLineItem","abstract":"

A PayPal line item to be displayed in the PayPal checkout flow.

"},"Classes/BTPayPalRequest.html":{"name":"BTPayPalRequest","abstract":"

Base options for PayPal Checkout and PayPal Vault flows.

"},"Classes/BTPayPalVaultRequest.html":{"name":"BTPayPalVaultRequest","abstract":"

Options for the PayPal Vault flow.

"},"Classes/BTVenmoAccountNonce.html":{"name":"BTVenmoAccountNonce","abstract":"

Contains information about a Venmo Account payment method

"},"Classes/BTVenmoClient.html":{"name":"BTVenmoClient","abstract":"

Used to process Venmo payments

"},"Classes/BTVenmoRequest.html":{"name":"BTVenmoRequest","abstract":"

A BTVenmoRequest specifies options that contribute to the Venmo flow

"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Extensions.html":{"name":"Extensions","abstract":"

The following extensions are available globally.

"},"Protocols.html":{"name":"Protocols","abstract":"

The following protocols are available globally.

"}} \ No newline at end of file diff --git a/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/docSet.dsidx b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/docSet.dsidx new file mode 100644 index 0000000000..5f40fb88de Binary files /dev/null and b/6.0.0-beta4/docsets/Braintree.docset/Contents/Resources/docSet.dsidx differ diff --git a/6.0.0-beta4/docsets/Braintree.tgz b/6.0.0-beta4/docsets/Braintree.tgz new file mode 100644 index 0000000000..e9fdc89e1f Binary files /dev/null and b/6.0.0-beta4/docsets/Braintree.tgz differ diff --git a/6.0.0-beta4/img/carat.png b/6.0.0-beta4/img/carat.png new file mode 100755 index 0000000000..29d2f7fd49 Binary files /dev/null and b/6.0.0-beta4/img/carat.png differ diff --git a/6.0.0-beta4/img/dash.png b/6.0.0-beta4/img/dash.png new file mode 100755 index 0000000000..6f694c7a01 Binary files /dev/null and b/6.0.0-beta4/img/dash.png differ diff --git a/6.0.0-beta4/img/gh.png b/6.0.0-beta4/img/gh.png new file mode 100755 index 0000000000..628da97c70 Binary files /dev/null and b/6.0.0-beta4/img/gh.png differ diff --git a/6.0.0-beta4/img/spinner.gif b/6.0.0-beta4/img/spinner.gif new file mode 100644 index 0000000000..e3038d0a42 Binary files /dev/null and b/6.0.0-beta4/img/spinner.gif differ diff --git a/6.0.0-beta4/index.html b/6.0.0-beta4/index.html new file mode 100644 index 0000000000..5d0c498a9b --- /dev/null +++ b/6.0.0-beta4/index.html @@ -0,0 +1,463 @@ + + + + Braintree Reference + + + + + + + + + + + + + + + +
+

+ + Braintree 6.0.0-beta4 Docs + + (100% documented) +

+ +
+
+ +
+
+ +

+ + GitHub + View on GitHub + +

+ +
+ +

+ Braintree Reference + + Braintree Reference +

+ +
+ +
+ +
+
+ +

Braintree iOS SDK

+ +

CocoaPods compatible +Swift Package Manager compatible +Carthage compatible

+ +

GitHub Actions Tests

+ +

Welcome to Braintree’s iOS SDK. This library will help you accept card and alternative payments in your iOS app.

+ +

v6 is the latest major version of Braintree iOS and is currently in Beta. For stable releases, please point to v5 of the SDK. While preparing for general availability, we expect to make breaking changes in the beta releases. To update from v5, see the v6 migration guide.

+ +

The Braintree iOS SDK permits a deployment target of iOS 14.0 or higher. It requires Xcode 14.3+ and Swift 5.8+.

+

Supported Payment Methods

+ + +

Installation

+ +

We recommend using Swift Package Manager, CocoaPods, or Carthage to integrate the Braintree SDK with your project.

+

Swift Package Manager

+ +

This feature is only available in v5+.

+ +

To add the Braintree package to your Xcode project, select File > Swift Packages > Add Package Dependency and enter https://github.com/braintree/braintree_ios as the repository URL. Tick the checkboxes for the specific Braintree libraries you wish to include.

+ +

If you look at your app target, you will see that the Braintree libraries you chose are automatically linked as a frameworks to your app (see General > Frameworks, Libraries, and Embedded Content).

+ +

BraintreePayPal and BraintreePaymentFlow also require the inclusion of the PayPalDataCollector module.

+ +

In your app’s source code files, use the following import syntax to include Braintree’s libraries:

+
import BraintreeCore
+import BraintreeCard
+import BraintreeApplePay
+import BraintreePayPal
+
+

CocoaPods

+
# Includes Cards and PayPal
+pod 'Braintree'
+
+# Optionally include additional Pods
+pod 'Braintree/DataCollector'
+pod 'Braintree/Venmo'
+
+

Carthage

+ +

Braintree 6.0.0+ requires Carthage 0.38.0+ and the --use-xcframeworks option when running carthage update.

+ +

Add github "braintree/braintree_ios" to your Cartfile, and add the frameworks to your project.

+ +

Note: Long term support for Carthage is not guaranteed. Please update to SPM, if possible. If there are concerns, please comment on this Discussion thread.

+

Documentation

+ +

Start with ‘Hello, Client!’ for instructions on basic setup and usage.

+ +

Next, read the full documentation for information about integrating with additional payment methods, such as PayPal and Venmo, as well as explore our pre-built Drop-In UI offering.

+

Versions

+ +

This SDK abides by our Client SDK Deprecation Policy. For more information on the potential statuses of an SDK check our developer docs.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Major version numberStatusReleasedDeprecatedUnsupported
6.x.xBetaTBATBATBA
5.x.xActiveFebruary 2021TBATBA
4.x.xUnsupportedNovember 2015February 2022February 2023
+ +

Versions 4.9.6 and below use outdated SSL certificates and are unsupported.

+

Demo

+ +
    +
  1. Run pod install + +
      +
    • There is a known M1 mac issue with CocoaPods. See this solution to resolve ffi dependency issues.
      • +
    2. +
  2. Resolve the Swift Package Manager packages if needed: File > Packages > Resolve Package Versions or by running swift package resolve in Terminal
    3. +
  3. Open Braintree.xcworkspace in Xcode
    4. +
  4. Select the Demo scheme, and then run
    5. +
+ +

Xcode 14+ is required to run the demo app.

+

Contributing

+ +

We welcome PRs to this repo. See our development doc.

+

Feedback

+ +

The Braintree iOS SDK is in active development, we welcome your feedback!

+ +

Here are a few ways to get in touch:

+ + +

Help

+ + +

License

+ +

The Braintree iOS SDK is open source and available under the MIT license. See the LICENSE file for more info.

+ +
+
+ + +
+
+
+

© 2023 Braintree. All rights reserved. (Last updated: 2023-06-01)

+

Generated by jazzy ♪♫ v0.14.3, a Realm project.

+
+ + diff --git a/6.0.0-beta4/js/jazzy.js b/6.0.0-beta4/js/jazzy.js new file mode 100755 index 0000000000..198441660c --- /dev/null +++ b/6.0.0-beta4/js/jazzy.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +window.jazzy = {'docset': false} +if (typeof window.dash != 'undefined') { + document.documentElement.className += ' dash' + window.jazzy.docset = true +} +if (navigator.userAgent.match(/xcode/i)) { + document.documentElement.className += ' xcode' + window.jazzy.docset = true +} + +function toggleItem($link, $content) { + var animationDuration = 300; + $link.toggleClass('token-open'); + $content.slideToggle(animationDuration); +} + +function itemLinkToContent($link) { + return $link.parent().parent().next(); +} + +// On doc load + hash-change, open any targetted item +function openCurrentItemIfClosed() { + if (window.jazzy.docset) { + return; + } + var $link = $(`a[name="${location.hash.substring(1)}"]`).nextAll('.token'); + $content = itemLinkToContent($link); + if ($content.is(':hidden')) { + toggleItem($link, $content); + } +} + +$(openCurrentItemIfClosed); +$(window).on('hashchange', openCurrentItemIfClosed); + +// On item link ('token') click, toggle its discussion +$('.token').on('click', function(event) { + if (window.jazzy.docset) { + return; + } + var $link = $(this); + toggleItem($link, itemLinkToContent($link)); + + // Keeps the document from jumping to the hash. + var href = $link.attr('href'); + if (history.pushState) { + history.pushState({}, '', href); + } else { + location.hash = href; + } + event.preventDefault(); +}); + +// Clicks on links to the current, closed, item need to open the item +$("a:not('.token')").on('click', function() { + if (location == this.href) { + openCurrentItemIfClosed(); + } +}); + +// KaTeX rendering +if ("katex" in window) { + $($('.math').each( (_, element) => { + katex.render(element.textContent, element, { + displayMode: $(element).hasClass('m-block'), + throwOnError: false, + trust: true + }); + })) +} diff --git a/6.0.0-beta4/js/jazzy.search.js b/6.0.0-beta4/js/jazzy.search.js new file mode 100644 index 0000000000..359cdbb8b2 --- /dev/null +++ b/6.0.0-beta4/js/jazzy.search.js @@ -0,0 +1,74 @@ +// Jazzy - https://github.com/realm/jazzy +// Copyright Realm Inc. +// SPDX-License-Identifier: MIT + +$(function(){ + var $typeahead = $('[data-typeahead]'); + var $form = $typeahead.parents('form'); + var searchURL = $form.attr('action'); + + function displayTemplate(result) { + return result.name; + } + + function suggestionTemplate(result) { + var t = '
'; + t += '' + result.name + ''; + if (result.parent_name) { + t += '' + result.parent_name + ''; + } + t += '
'; + return t; + } + + $typeahead.one('focus', function() { + $form.addClass('loading'); + + $.getJSON(searchURL).then(function(searchData) { + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } + }); + + $typeahead.typeahead( + { + highlight: true, + minLength: 3, + autoselect: true + }, + { + limit: 10, + display: displayTemplate, + templates: { suggestion: suggestionTemplate }, + source: function(query, sync) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { + var doc = searchData[result.ref]; + doc.url = result.ref; + return doc; + }); + sync(results); + } + } + ); + $form.removeClass('loading'); + $typeahead.trigger('focus'); + }); + }); + + var baseURL = searchURL.slice(0, -"search.json".length); + + $typeahead.on('typeahead:select', function(e, result) { + window.location = baseURL + result.url; + }); +}); diff --git a/6.0.0-beta4/js/jquery.min.js b/6.0.0-beta4/js/jquery.min.js new file mode 100644 index 0000000000..2c69bc908b --- /dev/null +++ b/6.0.0-beta4/js/jquery.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}(); diff --git a/6.0.0-beta4/js/typeahead.jquery.js b/6.0.0-beta4/js/typeahead.jquery.js new file mode 100644 index 0000000000..3a2d2ab031 --- /dev/null +++ b/6.0.0-beta4/js/typeahead.jquery.js @@ -0,0 +1,1694 @@ +/*! + * typeahead.js 1.3.1 + * https://github.com/corejavascript/typeahead.js + * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT + */ + + +(function(root, factory) { + if (typeof define === "function" && define.amd) { + define([ "jquery" ], function(a0) { + return factory(a0); + }); + } else if (typeof module === "object" && module.exports) { + module.exports = factory(require("jquery")); + } else { + factory(root["jQuery"]); + } +})(this, function($) { + var _ = function() { + "use strict"; + return { + isMsie: function() { + return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false; + }, + isBlankString: function(str) { + return !str || /^\s*$/.test(str); + }, + escapeRegExChars: function(str) { + return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&"); + }, + isString: function(obj) { + return typeof obj === "string"; + }, + isNumber: function(obj) { + return typeof obj === "number"; + }, + isArray: $.isArray, + isFunction: $.isFunction, + isObject: $.isPlainObject, + isUndefined: function(obj) { + return typeof obj === "undefined"; + }, + isElement: function(obj) { + return !!(obj && obj.nodeType === 1); + }, + isJQuery: function(obj) { + return obj instanceof $; + }, + toStr: function toStr(s) { + return _.isUndefined(s) || s === null ? "" : s + ""; + }, + bind: $.proxy, + each: function(collection, cb) { + $.each(collection, reverseArgs); + function reverseArgs(index, value) { + return cb(value, index); + } + }, + map: $.map, + filter: $.grep, + every: function(obj, test) { + var result = true; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (!(result = test.call(null, val, key, obj))) { + return false; + } + }); + return !!result; + }, + some: function(obj, test) { + var result = false; + if (!obj) { + return result; + } + $.each(obj, function(key, val) { + if (result = test.call(null, val, key, obj)) { + return false; + } + }); + return !!result; + }, + mixin: $.extend, + identity: function(x) { + return x; + }, + clone: function(obj) { + return $.extend(true, {}, obj); + }, + getIdGenerator: function() { + var counter = 0; + return function() { + return counter++; + }; + }, + templatify: function templatify(obj) { + return $.isFunction(obj) ? obj : template; + function template() { + return String(obj); + } + }, + defer: function(fn) { + setTimeout(fn, 0); + }, + debounce: function(func, wait, immediate) { + var timeout, result; + return function() { + var context = this, args = arguments, later, callNow; + later = function() { + timeout = null; + if (!immediate) { + result = func.apply(context, args); + } + }; + callNow = immediate && !timeout; + clearTimeout(timeout); + timeout = setTimeout(later, wait); + if (callNow) { + result = func.apply(context, args); + } + return result; + }; + }, + throttle: function(func, wait) { + var context, args, timeout, result, previous, later; + previous = 0; + later = function() { + previous = new Date(); + timeout = null; + result = func.apply(context, args); + }; + return function() { + var now = new Date(), remaining = wait - (now - previous); + context = this; + args = arguments; + if (remaining <= 0) { + clearTimeout(timeout); + timeout = null; + previous = now; + result = func.apply(context, args); + } else if (!timeout) { + timeout = setTimeout(later, remaining); + } + return result; + }; + }, + stringify: function(val) { + return _.isString(val) ? val : JSON.stringify(val); + }, + guid: function() { + function _p8(s) { + var p = (Math.random().toString(16) + "000000000").substr(2, 8); + return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p; + } + return "tt-" + _p8() + _p8(true) + _p8(true) + _p8(); + }, + noop: function() {} + }; + }(); + var WWW = function() { + "use strict"; + var defaultClassNames = { + wrapper: "twitter-typeahead", + input: "tt-input", + hint: "tt-hint", + menu: "tt-menu", + dataset: "tt-dataset", + suggestion: "tt-suggestion", + selectable: "tt-selectable", + empty: "tt-empty", + open: "tt-open", + cursor: "tt-cursor", + highlight: "tt-highlight" + }; + return build; + function build(o) { + var www, classes; + classes = _.mixin({}, defaultClassNames, o); + www = { + css: buildCss(), + classes: classes, + html: buildHtml(classes), + selectors: buildSelectors(classes) + }; + return { + css: www.css, + html: www.html, + classes: www.classes, + selectors: www.selectors, + mixin: function(o) { + _.mixin(o, www); + } + }; + } + function buildHtml(c) { + return { + wrapper: '', + menu: '
' + }; + } + function buildSelectors(classes) { + var selectors = {}; + _.each(classes, function(v, k) { + selectors[k] = "." + v; + }); + return selectors; + } + function buildCss() { + var css = { + wrapper: { + position: "relative", + display: "inline-block" + }, + hint: { + position: "absolute", + top: "0", + left: "0", + borderColor: "transparent", + boxShadow: "none", + opacity: "1" + }, + input: { + position: "relative", + verticalAlign: "top", + backgroundColor: "transparent" + }, + inputWithNoHint: { + position: "relative", + verticalAlign: "top" + }, + menu: { + position: "absolute", + top: "100%", + left: "0", + zIndex: "100", + display: "none" + }, + ltr: { + left: "0", + right: "auto" + }, + rtl: { + left: "auto", + right: " 0" + } + }; + if (_.isMsie()) { + _.mixin(css.input, { + backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)" + }); + } + return css; + } + }(); + var EventBus = function() { + "use strict"; + var namespace, deprecationMap; + namespace = "typeahead:"; + deprecationMap = { + render: "rendered", + cursorchange: "cursorchanged", + select: "selected", + autocomplete: "autocompleted" + }; + function EventBus(o) { + if (!o || !o.el) { + $.error("EventBus initialized without el"); + } + this.$el = $(o.el); + } + _.mixin(EventBus.prototype, { + _trigger: function(type, args) { + var $e = $.Event(namespace + type); + this.$el.trigger.call(this.$el, $e, args || []); + return $e; + }, + before: function(type) { + var args, $e; + args = [].slice.call(arguments, 1); + $e = this._trigger("before" + type, args); + return $e.isDefaultPrevented(); + }, + trigger: function(type) { + var deprecatedType; + this._trigger(type, [].slice.call(arguments, 1)); + if (deprecatedType = deprecationMap[type]) { + this._trigger(deprecatedType, [].slice.call(arguments, 1)); + } + } + }); + return EventBus; + }(); + var EventEmitter = function() { + "use strict"; + var splitter = /\s+/, nextTick = getNextTick(); + return { + onSync: onSync, + onAsync: onAsync, + off: off, + trigger: trigger + }; + function on(method, types, cb, context) { + var type; + if (!cb) { + return this; + } + types = types.split(splitter); + cb = context ? bindContext(cb, context) : cb; + this._callbacks = this._callbacks || {}; + while (type = types.shift()) { + this._callbacks[type] = this._callbacks[type] || { + sync: [], + async: [] + }; + this._callbacks[type][method].push(cb); + } + return this; + } + function onAsync(types, cb, context) { + return on.call(this, "async", types, cb, context); + } + function onSync(types, cb, context) { + return on.call(this, "sync", types, cb, context); + } + function off(types) { + var type; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + while (type = types.shift()) { + delete this._callbacks[type]; + } + return this; + } + function trigger(types) { + var type, callbacks, args, syncFlush, asyncFlush; + if (!this._callbacks) { + return this; + } + types = types.split(splitter); + args = [].slice.call(arguments, 1); + while ((type = types.shift()) && (callbacks = this._callbacks[type])) { + syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args)); + asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args)); + syncFlush() && nextTick(asyncFlush); + } + return this; + } + function getFlush(callbacks, context, args) { + return flush; + function flush() { + var cancelled; + for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) { + cancelled = callbacks[i].apply(context, args) === false; + } + return !cancelled; + } + } + function getNextTick() { + var nextTickFn; + if (window.setImmediate) { + nextTickFn = function nextTickSetImmediate(fn) { + setImmediate(function() { + fn(); + }); + }; + } else { + nextTickFn = function nextTickSetTimeout(fn) { + setTimeout(function() { + fn(); + }, 0); + }; + } + return nextTickFn; + } + function bindContext(fn, context) { + return fn.bind ? fn.bind(context) : function() { + fn.apply(context, [].slice.call(arguments, 0)); + }; + } + }(); + var highlight = function(doc) { + "use strict"; + var defaults = { + node: null, + pattern: null, + tagName: "strong", + className: null, + wordsOnly: false, + caseSensitive: false, + diacriticInsensitive: false + }; + var accented = { + A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]", + B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]", + C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]", + D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]", + E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]", + F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]", + G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]", + H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]", + I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]", + J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]", + K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]", + L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]", + M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]", + N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]", + O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]", + P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]", + Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]", + R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]", + S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]", + T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]", + U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]", + V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]", + W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]", + X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]", + Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]", + Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]" + }; + return function hightlight(o) { + var regex; + o = _.mixin({}, defaults, o); + if (!o.node || !o.pattern) { + return; + } + o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ]; + regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive); + traverse(o.node, hightlightTextNode); + function hightlightTextNode(textNode) { + var match, patternNode, wrapperNode; + if (match = regex.exec(textNode.data)) { + wrapperNode = doc.createElement(o.tagName); + o.className && (wrapperNode.className = o.className); + patternNode = textNode.splitText(match.index); + patternNode.splitText(match[0].length); + wrapperNode.appendChild(patternNode.cloneNode(true)); + textNode.parentNode.replaceChild(wrapperNode, patternNode); + } + return !!match; + } + function traverse(el, hightlightTextNode) { + var childNode, TEXT_NODE_TYPE = 3; + for (var i = 0; i < el.childNodes.length; i++) { + childNode = el.childNodes[i]; + if (childNode.nodeType === TEXT_NODE_TYPE) { + i += hightlightTextNode(childNode) ? 1 : 0; + } else { + traverse(childNode, hightlightTextNode); + } + } + } + }; + function accent_replacer(chr) { + return accented[chr.toUpperCase()] || chr; + } + function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) { + var escapedPatterns = [], regexStr; + for (var i = 0, len = patterns.length; i < len; i++) { + var escapedWord = _.escapeRegExChars(patterns[i]); + if (diacriticInsensitive) { + escapedWord = escapedWord.replace(/\S/g, accent_replacer); + } + escapedPatterns.push(escapedWord); + } + regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")"; + return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i"); + } + }(window.document); + var Input = function() { + "use strict"; + var specialKeyCodeMap; + specialKeyCodeMap = { + 9: "tab", + 27: "esc", + 37: "left", + 39: "right", + 13: "enter", + 38: "up", + 40: "down" + }; + function Input(o, www) { + var id; + o = o || {}; + if (!o.input) { + $.error("input is missing"); + } + www.mixin(this); + this.$hint = $(o.hint); + this.$input = $(o.input); + this.$menu = $(o.menu); + id = this.$input.attr("id") || _.guid(); + this.$menu.attr("id", id + "_listbox"); + this.$hint.attr({ + "aria-hidden": true + }); + this.$input.attr({ + "aria-owns": id + "_listbox", + role: "combobox", + "aria-autocomplete": "list", + "aria-expanded": false + }); + this.query = this.$input.val(); + this.queryWhenFocused = this.hasFocus() ? this.query : null; + this.$overflowHelper = buildOverflowHelper(this.$input); + this._checkLanguageDirection(); + if (this.$hint.length === 0) { + this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop; + } + this.onSync("cursorchange", this._updateDescendent); + } + Input.normalizeQuery = function(str) { + return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " "); + }; + _.mixin(Input.prototype, EventEmitter, { + _onBlur: function onBlur() { + this.resetInputValue(); + this.trigger("blurred"); + }, + _onFocus: function onFocus() { + this.queryWhenFocused = this.query; + this.trigger("focused"); + }, + _onKeydown: function onKeydown($e) { + var keyName = specialKeyCodeMap[$e.which || $e.keyCode]; + this._managePreventDefault(keyName, $e); + if (keyName && this._shouldTrigger(keyName, $e)) { + this.trigger(keyName + "Keyed", $e); + } + }, + _onInput: function onInput() { + this._setQuery(this.getInputValue()); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + _managePreventDefault: function managePreventDefault(keyName, $e) { + var preventDefault; + switch (keyName) { + case "up": + case "down": + preventDefault = !withModifier($e); + break; + + default: + preventDefault = false; + } + preventDefault && $e.preventDefault(); + }, + _shouldTrigger: function shouldTrigger(keyName, $e) { + var trigger; + switch (keyName) { + case "tab": + trigger = !withModifier($e); + break; + + default: + trigger = true; + } + return trigger; + }, + _checkLanguageDirection: function checkLanguageDirection() { + var dir = (this.$input.css("direction") || "ltr").toLowerCase(); + if (this.dir !== dir) { + this.dir = dir; + this.$hint.attr("dir", dir); + this.trigger("langDirChanged", dir); + } + }, + _setQuery: function setQuery(val, silent) { + var areEquivalent, hasDifferentWhitespace; + areEquivalent = areQueriesEquivalent(val, this.query); + hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false; + this.query = val; + if (!silent && !areEquivalent) { + this.trigger("queryChanged", this.query); + } else if (!silent && hasDifferentWhitespace) { + this.trigger("whitespaceChanged", this.query); + } + }, + _updateDescendent: function updateDescendent(event, id) { + this.$input.attr("aria-activedescendant", id); + }, + bind: function() { + var that = this, onBlur, onFocus, onKeydown, onInput; + onBlur = _.bind(this._onBlur, this); + onFocus = _.bind(this._onFocus, this); + onKeydown = _.bind(this._onKeydown, this); + onInput = _.bind(this._onInput, this); + this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown); + if (!_.isMsie() || _.isMsie() > 9) { + this.$input.on("input.tt", onInput); + } else { + this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) { + if (specialKeyCodeMap[$e.which || $e.keyCode]) { + return; + } + _.defer(_.bind(that._onInput, that, $e)); + }); + } + return this; + }, + focus: function focus() { + this.$input.focus(); + }, + blur: function blur() { + this.$input.blur(); + }, + getLangDir: function getLangDir() { + return this.dir; + }, + getQuery: function getQuery() { + return this.query || ""; + }, + setQuery: function setQuery(val, silent) { + this.setInputValue(val); + this._setQuery(val, silent); + }, + hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() { + return this.query !== this.queryWhenFocused; + }, + getInputValue: function getInputValue() { + return this.$input.val(); + }, + setInputValue: function setInputValue(value) { + this.$input.val(value); + this.clearHintIfInvalid(); + this._checkLanguageDirection(); + }, + resetInputValue: function resetInputValue() { + this.setInputValue(this.query); + }, + getHint: function getHint() { + return this.$hint.val(); + }, + setHint: function setHint(value) { + this.$hint.val(value); + }, + clearHint: function clearHint() { + this.setHint(""); + }, + clearHintIfInvalid: function clearHintIfInvalid() { + var val, hint, valIsPrefixOfHint, isValid; + val = this.getInputValue(); + hint = this.getHint(); + valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0; + isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow(); + !isValid && this.clearHint(); + }, + hasFocus: function hasFocus() { + return this.$input.is(":focus"); + }, + hasOverflow: function hasOverflow() { + var constraint = this.$input.width() - 2; + this.$overflowHelper.text(this.getInputValue()); + return this.$overflowHelper.width() >= constraint; + }, + isCursorAtEnd: function() { + var valueLength, selectionStart, range; + valueLength = this.$input.val().length; + selectionStart = this.$input[0].selectionStart; + if (_.isNumber(selectionStart)) { + return selectionStart === valueLength; + } else if (document.selection) { + range = document.selection.createRange(); + range.moveStart("character", -valueLength); + return valueLength === range.text.length; + } + return true; + }, + destroy: function destroy() { + this.$hint.off(".tt"); + this.$input.off(".tt"); + this.$overflowHelper.remove(); + this.$hint = this.$input = this.$overflowHelper = $("
"); + }, + setAriaExpanded: function setAriaExpanded(value) { + this.$input.attr("aria-expanded", value); + } + }); + return Input; + function buildOverflowHelper($input) { + return $('').css({ + position: "absolute", + visibility: "hidden", + whiteSpace: "pre", + fontFamily: $input.css("font-family"), + fontSize: $input.css("font-size"), + fontStyle: $input.css("font-style"), + fontVariant: $input.css("font-variant"), + fontWeight: $input.css("font-weight"), + wordSpacing: $input.css("word-spacing"), + letterSpacing: $input.css("letter-spacing"), + textIndent: $input.css("text-indent"), + textRendering: $input.css("text-rendering"), + textTransform: $input.css("text-transform") + }).insertAfter($input); + } + function areQueriesEquivalent(a, b) { + return Input.normalizeQuery(a) === Input.normalizeQuery(b); + } + function withModifier($e) { + return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey; + } + }(); + var Dataset = function() { + "use strict"; + var keys, nameGenerator; + keys = { + dataset: "tt-selectable-dataset", + val: "tt-selectable-display", + obj: "tt-selectable-object" + }; + nameGenerator = _.getIdGenerator(); + function Dataset(o, www) { + o = o || {}; + o.templates = o.templates || {}; + o.templates.notFound = o.templates.notFound || o.templates.empty; + if (!o.source) { + $.error("missing source"); + } + if (!o.node) { + $.error("missing node"); + } + if (o.name && !isValidName(o.name)) { + $.error("invalid dataset name: " + o.name); + } + www.mixin(this); + this.highlight = !!o.highlight; + this.name = _.toStr(o.name || nameGenerator()); + this.limit = o.limit || 5; + this.displayFn = getDisplayFn(o.display || o.displayKey); + this.templates = getTemplates(o.templates, this.displayFn); + this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source; + this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async; + this._resetLastSuggestion(); + this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name); + } + Dataset.extractData = function extractData(el) { + var $el = $(el); + if ($el.data(keys.obj)) { + return { + dataset: $el.data(keys.dataset) || "", + val: $el.data(keys.val) || "", + obj: $el.data(keys.obj) || null + }; + } + return null; + }; + _.mixin(Dataset.prototype, EventEmitter, { + _overwrite: function overwrite(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (this.async && this.templates.pending) { + this._renderPending(query); + } else if (!this.async && this.templates.notFound) { + this._renderNotFound(query); + } else { + this._empty(); + } + this.trigger("rendered", suggestions, false, this.name); + }, + _append: function append(query, suggestions) { + suggestions = suggestions || []; + if (suggestions.length && this.$lastSuggestion.length) { + this._appendSuggestions(query, suggestions); + } else if (suggestions.length) { + this._renderSuggestions(query, suggestions); + } else if (!this.$lastSuggestion.length && this.templates.notFound) { + this._renderNotFound(query); + } + this.trigger("rendered", suggestions, true, this.name); + }, + _renderSuggestions: function renderSuggestions(query, suggestions) { + var $fragment; + $fragment = this._getSuggestionsFragment(query, suggestions); + this.$lastSuggestion = $fragment.children().last(); + this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions)); + }, + _appendSuggestions: function appendSuggestions(query, suggestions) { + var $fragment, $lastSuggestion; + $fragment = this._getSuggestionsFragment(query, suggestions); + $lastSuggestion = $fragment.children().last(); + this.$lastSuggestion.after($fragment); + this.$lastSuggestion = $lastSuggestion; + }, + _renderPending: function renderPending(query) { + var template = this.templates.pending; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _renderNotFound: function renderNotFound(query) { + var template = this.templates.notFound; + this._resetLastSuggestion(); + template && this.$el.html(template({ + query: query, + dataset: this.name + })); + }, + _empty: function empty() { + this.$el.empty(); + this._resetLastSuggestion(); + }, + _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) { + var that = this, fragment; + fragment = document.createDocumentFragment(); + _.each(suggestions, function getSuggestionNode(suggestion) { + var $el, context; + context = that._injectQuery(query, suggestion); + $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable); + fragment.appendChild($el[0]); + }); + this.highlight && highlight({ + className: this.classes.highlight, + node: fragment, + pattern: query + }); + return $(fragment); + }, + _getFooter: function getFooter(query, suggestions) { + return this.templates.footer ? this.templates.footer({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _getHeader: function getHeader(query, suggestions) { + return this.templates.header ? this.templates.header({ + query: query, + suggestions: suggestions, + dataset: this.name + }) : null; + }, + _resetLastSuggestion: function resetLastSuggestion() { + this.$lastSuggestion = $(); + }, + _injectQuery: function injectQuery(query, obj) { + return _.isObject(obj) ? _.mixin({ + _query: query + }, obj) : obj; + }, + update: function update(query) { + var that = this, canceled = false, syncCalled = false, rendered = 0; + this.cancel(); + this.cancel = function cancel() { + canceled = true; + that.cancel = $.noop; + that.async && that.trigger("asyncCanceled", query, that.name); + }; + this.source(query, sync, async); + !syncCalled && sync([]); + function sync(suggestions) { + if (syncCalled) { + return; + } + syncCalled = true; + suggestions = (suggestions || []).slice(0, that.limit); + rendered = suggestions.length; + that._overwrite(query, suggestions); + if (rendered < that.limit && that.async) { + that.trigger("asyncRequested", query, that.name); + } + } + function async(suggestions) { + suggestions = suggestions || []; + if (!canceled && rendered < that.limit) { + that.cancel = $.noop; + var idx = Math.abs(rendered - that.limit); + rendered += idx; + that._append(query, suggestions.slice(0, idx)); + that.async && that.trigger("asyncReceived", query, that.name); + } + } + }, + cancel: $.noop, + clear: function clear() { + this._empty(); + this.cancel(); + this.trigger("cleared"); + }, + isEmpty: function isEmpty() { + return this.$el.is(":empty"); + }, + destroy: function destroy() { + this.$el = $("
"); + } + }); + return Dataset; + function getDisplayFn(display) { + display = display || _.stringify; + return _.isFunction(display) ? display : displayFn; + function displayFn(obj) { + return obj[display]; + } + } + function getTemplates(templates, displayFn) { + return { + notFound: templates.notFound && _.templatify(templates.notFound), + pending: templates.pending && _.templatify(templates.pending), + header: templates.header && _.templatify(templates.header), + footer: templates.footer && _.templatify(templates.footer), + suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate + }; + function userSuggestionTemplate(context) { + var template = templates.suggestion; + return $(template(context)).attr("id", _.guid()); + } + function suggestionTemplate(context) { + return $('
').attr("id", _.guid()).text(displayFn(context)); + } + } + function isValidName(str) { + return /^[_a-zA-Z0-9-]+$/.test(str); + } + }(); + var Menu = function() { + "use strict"; + function Menu(o, www) { + var that = this; + o = o || {}; + if (!o.node) { + $.error("node is required"); + } + www.mixin(this); + this.$node = $(o.node); + this.query = null; + this.datasets = _.map(o.datasets, initializeDataset); + function initializeDataset(oDataset) { + var node = that.$node.find(oDataset.node).first(); + oDataset.node = node.length ? node : $("
").appendTo(that.$node); + return new Dataset(oDataset, www); + } + } + _.mixin(Menu.prototype, EventEmitter, { + _onSelectableClick: function onSelectableClick($e) { + this.trigger("selectableClicked", $($e.currentTarget)); + }, + _onRendered: function onRendered(type, dataset, suggestions, async) { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetRendered", dataset, suggestions, async); + }, + _onCleared: function onCleared() { + this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty()); + this.trigger("datasetCleared"); + }, + _propagate: function propagate() { + this.trigger.apply(this, arguments); + }, + _allDatasetsEmpty: function allDatasetsEmpty() { + return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) { + var isEmpty = dataset.isEmpty(); + this.$node.attr("aria-expanded", !isEmpty); + return isEmpty; + }, this)); + }, + _getSelectables: function getSelectables() { + return this.$node.find(this.selectors.selectable); + }, + _removeCursor: function _removeCursor() { + var $selectable = this.getActiveSelectable(); + $selectable && $selectable.removeClass(this.classes.cursor); + }, + _ensureVisible: function ensureVisible($el) { + var elTop, elBottom, nodeScrollTop, nodeHeight; + elTop = $el.position().top; + elBottom = elTop + $el.outerHeight(true); + nodeScrollTop = this.$node.scrollTop(); + nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10); + if (elTop < 0) { + this.$node.scrollTop(nodeScrollTop + elTop); + } else if (nodeHeight < elBottom) { + this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight)); + } + }, + bind: function() { + var that = this, onSelectableClick; + onSelectableClick = _.bind(this._onSelectableClick, this); + this.$node.on("click.tt", this.selectors.selectable, onSelectableClick); + this.$node.on("mouseover", this.selectors.selectable, function() { + that.setCursor($(this)); + }); + this.$node.on("mouseleave", function() { + that._removeCursor(); + }); + _.each(this.datasets, function(dataset) { + dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that); + }); + return this; + }, + isOpen: function isOpen() { + return this.$node.hasClass(this.classes.open); + }, + open: function open() { + this.$node.scrollTop(0); + this.$node.addClass(this.classes.open); + }, + close: function close() { + this.$node.attr("aria-expanded", false); + this.$node.removeClass(this.classes.open); + this._removeCursor(); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.attr("dir", dir); + }, + selectableRelativeToCursor: function selectableRelativeToCursor(delta) { + var $selectables, $oldCursor, oldIndex, newIndex; + $oldCursor = this.getActiveSelectable(); + $selectables = this._getSelectables(); + oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1; + newIndex = oldIndex + delta; + newIndex = (newIndex + 1) % ($selectables.length + 1) - 1; + newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex; + return newIndex === -1 ? null : $selectables.eq(newIndex); + }, + setCursor: function setCursor($selectable) { + this._removeCursor(); + if ($selectable = $selectable && $selectable.first()) { + $selectable.addClass(this.classes.cursor); + this._ensureVisible($selectable); + } + }, + getSelectableData: function getSelectableData($el) { + return $el && $el.length ? Dataset.extractData($el) : null; + }, + getActiveSelectable: function getActiveSelectable() { + var $selectable = this._getSelectables().filter(this.selectors.cursor).first(); + return $selectable.length ? $selectable : null; + }, + getTopSelectable: function getTopSelectable() { + var $selectable = this._getSelectables().first(); + return $selectable.length ? $selectable : null; + }, + update: function update(query) { + var isValidUpdate = query !== this.query; + if (isValidUpdate) { + this.query = query; + _.each(this.datasets, updateDataset); + } + return isValidUpdate; + function updateDataset(dataset) { + dataset.update(query); + } + }, + empty: function empty() { + _.each(this.datasets, clearDataset); + this.query = null; + this.$node.addClass(this.classes.empty); + function clearDataset(dataset) { + dataset.clear(); + } + }, + destroy: function destroy() { + this.$node.off(".tt"); + this.$node = $("
"); + _.each(this.datasets, destroyDataset); + function destroyDataset(dataset) { + dataset.destroy(); + } + } + }); + return Menu; + }(); + var Status = function() { + "use strict"; + function Status(options) { + this.$el = $("", { + role: "status", + "aria-live": "polite" + }).css({ + position: "absolute", + padding: "0", + border: "0", + height: "1px", + width: "1px", + "margin-bottom": "-1px", + "margin-right": "-1px", + overflow: "hidden", + clip: "rect(0 0 0 0)", + "white-space": "nowrap" + }); + options.$input.after(this.$el); + _.each(options.menu.datasets, _.bind(function(dataset) { + if (dataset.onSync) { + dataset.onSync("rendered", _.bind(this.update, this)); + dataset.onSync("cleared", _.bind(this.cleared, this)); + } + }, this)); + } + _.mixin(Status.prototype, { + update: function update(event, suggestions) { + var length = suggestions.length; + var words; + if (length === 1) { + words = { + result: "result", + is: "is" + }; + } else { + words = { + result: "results", + is: "are" + }; + } + this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate."); + }, + cleared: function() { + this.$el.text(""); + } + }); + return Status; + }(); + var DefaultMenu = function() { + "use strict"; + var s = Menu.prototype; + function DefaultMenu() { + Menu.apply(this, [].slice.call(arguments, 0)); + } + _.mixin(DefaultMenu.prototype, Menu.prototype, { + open: function open() { + !this._allDatasetsEmpty() && this._show(); + return s.open.apply(this, [].slice.call(arguments, 0)); + }, + close: function close() { + this._hide(); + return s.close.apply(this, [].slice.call(arguments, 0)); + }, + _onRendered: function onRendered() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onRendered.apply(this, [].slice.call(arguments, 0)); + }, + _onCleared: function onCleared() { + if (this._allDatasetsEmpty()) { + this._hide(); + } else { + this.isOpen() && this._show(); + } + return s._onCleared.apply(this, [].slice.call(arguments, 0)); + }, + setLanguageDirection: function setLanguageDirection(dir) { + this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl); + return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0)); + }, + _hide: function hide() { + this.$node.hide(); + }, + _show: function show() { + this.$node.css("display", "block"); + } + }); + return DefaultMenu; + }(); + var Typeahead = function() { + "use strict"; + function Typeahead(o, www) { + var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged; + o = o || {}; + if (!o.input) { + $.error("missing input"); + } + if (!o.menu) { + $.error("missing menu"); + } + if (!o.eventBus) { + $.error("missing event bus"); + } + www.mixin(this); + this.eventBus = o.eventBus; + this.minLength = _.isNumber(o.minLength) ? o.minLength : 1; + this.input = o.input; + this.menu = o.menu; + this.enabled = true; + this.autoselect = !!o.autoselect; + this.active = false; + this.input.hasFocus() && this.activate(); + this.dir = this.input.getLangDir(); + this._hacks(); + this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this); + onFocused = c(this, "activate", "open", "_onFocused"); + onBlurred = c(this, "deactivate", "_onBlurred"); + onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed"); + onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed"); + onEscKeyed = c(this, "isActive", "_onEscKeyed"); + onUpKeyed = c(this, "isActive", "open", "_onUpKeyed"); + onDownKeyed = c(this, "isActive", "open", "_onDownKeyed"); + onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed"); + onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed"); + onQueryChanged = c(this, "_openIfActive", "_onQueryChanged"); + onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged"); + this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this); + } + _.mixin(Typeahead.prototype, { + _hacks: function hacks() { + var $input, $menu; + $input = this.input.$input || $("
"); + $menu = this.menu.$node || $("
"); + $input.on("blur.tt", function($e) { + var active, isActive, hasActive; + active = document.activeElement; + isActive = $menu.is(active); + hasActive = $menu.has(active).length > 0; + if (_.isMsie() && (isActive || hasActive)) { + $e.preventDefault(); + $e.stopImmediatePropagation(); + _.defer(function() { + $input.focus(); + }); + } + }); + $menu.on("mousedown.tt", function($e) { + $e.preventDefault(); + }); + }, + _onSelectableClicked: function onSelectableClicked(type, $el) { + this.select($el); + }, + _onDatasetCleared: function onDatasetCleared() { + this._updateHint(); + }, + _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) { + this._updateHint(); + if (this.autoselect) { + var cursorClass = this.selectors.cursor.substr(1); + this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass); + } + this.eventBus.trigger("render", suggestions, async, dataset); + }, + _onAsyncRequested: function onAsyncRequested(type, dataset, query) { + this.eventBus.trigger("asyncrequest", query, dataset); + }, + _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) { + this.eventBus.trigger("asynccancel", query, dataset); + }, + _onAsyncReceived: function onAsyncReceived(type, dataset, query) { + this.eventBus.trigger("asyncreceive", query, dataset); + }, + _onFocused: function onFocused() { + this._minLengthMet() && this.menu.update(this.input.getQuery()); + }, + _onBlurred: function onBlurred() { + if (this.input.hasQueryChangedSinceLastFocus()) { + this.eventBus.trigger("change", this.input.getQuery()); + } + }, + _onEnterKeyed: function onEnterKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + if (this.select($selectable)) { + $e.preventDefault(); + $e.stopPropagation(); + } + } else if (this.autoselect) { + if (this.select(this.menu.getTopSelectable())) { + $e.preventDefault(); + $e.stopPropagation(); + } + } + }, + _onTabKeyed: function onTabKeyed(type, $e) { + var $selectable; + if ($selectable = this.menu.getActiveSelectable()) { + this.select($selectable) && $e.preventDefault(); + } else if (this.autoselect) { + if ($selectable = this.menu.getTopSelectable()) { + this.autocomplete($selectable) && $e.preventDefault(); + } + } + }, + _onEscKeyed: function onEscKeyed() { + this.close(); + }, + _onUpKeyed: function onUpKeyed() { + this.moveCursor(-1); + }, + _onDownKeyed: function onDownKeyed() { + this.moveCursor(+1); + }, + _onLeftKeyed: function onLeftKeyed() { + if (this.dir === "rtl" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onRightKeyed: function onRightKeyed() { + if (this.dir === "ltr" && this.input.isCursorAtEnd()) { + this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable()); + } + }, + _onQueryChanged: function onQueryChanged(e, query) { + this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty(); + }, + _onWhitespaceChanged: function onWhitespaceChanged() { + this._updateHint(); + }, + _onLangDirChanged: function onLangDirChanged(e, dir) { + if (this.dir !== dir) { + this.dir = dir; + this.menu.setLanguageDirection(dir); + } + }, + _openIfActive: function openIfActive() { + this.isActive() && this.open(); + }, + _minLengthMet: function minLengthMet(query) { + query = _.isString(query) ? query : this.input.getQuery() || ""; + return query.length >= this.minLength; + }, + _updateHint: function updateHint() { + var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match; + $selectable = this.menu.getTopSelectable(); + data = this.menu.getSelectableData($selectable); + val = this.input.getInputValue(); + if (data && !_.isBlankString(val) && !this.input.hasOverflow()) { + query = Input.normalizeQuery(val); + escapedQuery = _.escapeRegExChars(query); + frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i"); + match = frontMatchRegEx.exec(data.val); + match && this.input.setHint(val + match[1]); + } else { + this.input.clearHint(); + } + }, + isEnabled: function isEnabled() { + return this.enabled; + }, + enable: function enable() { + this.enabled = true; + }, + disable: function disable() { + this.enabled = false; + }, + isActive: function isActive() { + return this.active; + }, + activate: function activate() { + if (this.isActive()) { + return true; + } else if (!this.isEnabled() || this.eventBus.before("active")) { + return false; + } else { + this.active = true; + this.eventBus.trigger("active"); + return true; + } + }, + deactivate: function deactivate() { + if (!this.isActive()) { + return true; + } else if (this.eventBus.before("idle")) { + return false; + } else { + this.active = false; + this.close(); + this.eventBus.trigger("idle"); + return true; + } + }, + isOpen: function isOpen() { + return this.menu.isOpen(); + }, + open: function open() { + if (!this.isOpen() && !this.eventBus.before("open")) { + this.input.setAriaExpanded(true); + this.menu.open(); + this._updateHint(); + this.eventBus.trigger("open"); + } + return this.isOpen(); + }, + close: function close() { + if (this.isOpen() && !this.eventBus.before("close")) { + this.input.setAriaExpanded(false); + this.menu.close(); + this.input.clearHint(); + this.input.resetInputValue(); + this.eventBus.trigger("close"); + } + return !this.isOpen(); + }, + setVal: function setVal(val) { + this.input.setQuery(_.toStr(val)); + }, + getVal: function getVal() { + return this.input.getQuery(); + }, + select: function select($selectable) { + var data = this.menu.getSelectableData($selectable); + if (data && !this.eventBus.before("select", data.obj, data.dataset)) { + this.input.setQuery(data.val, true); + this.eventBus.trigger("select", data.obj, data.dataset); + this.close(); + return true; + } + return false; + }, + autocomplete: function autocomplete($selectable) { + var query, data, isValid; + query = this.input.getQuery(); + data = this.menu.getSelectableData($selectable); + isValid = data && query !== data.val; + if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) { + this.input.setQuery(data.val); + this.eventBus.trigger("autocomplete", data.obj, data.dataset); + return true; + } + return false; + }, + moveCursor: function moveCursor(delta) { + var query, $candidate, data, suggestion, datasetName, cancelMove, id; + query = this.input.getQuery(); + $candidate = this.menu.selectableRelativeToCursor(delta); + data = this.menu.getSelectableData($candidate); + suggestion = data ? data.obj : null; + datasetName = data ? data.dataset : null; + id = $candidate ? $candidate.attr("id") : null; + this.input.trigger("cursorchange", id); + cancelMove = this._minLengthMet() && this.menu.update(query); + if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) { + this.menu.setCursor($candidate); + if (data) { + if (typeof data.val === "string") { + this.input.setInputValue(data.val); + } + } else { + this.input.resetInputValue(); + this._updateHint(); + } + this.eventBus.trigger("cursorchange", suggestion, datasetName); + return true; + } + return false; + }, + destroy: function destroy() { + this.input.destroy(); + this.menu.destroy(); + } + }); + return Typeahead; + function c(ctx) { + var methods = [].slice.call(arguments, 1); + return function() { + var args = [].slice.call(arguments); + _.each(methods, function(method) { + return ctx[method].apply(ctx, args); + }); + }; + } + }(); + (function() { + "use strict"; + var old, keys, methods; + old = $.fn.typeahead; + keys = { + www: "tt-www", + attrs: "tt-attrs", + typeahead: "tt-typeahead" + }; + methods = { + initialize: function initialize(o, datasets) { + var www; + datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1); + o = o || {}; + www = WWW(o.classNames); + return this.each(attach); + function attach() { + var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor; + _.each(datasets, function(d) { + d.highlight = !!o.highlight; + }); + $input = $(this); + $wrapper = $(www.html.wrapper); + $hint = $elOrNull(o.hint); + $menu = $elOrNull(o.menu); + defaultHint = o.hint !== false && !$hint; + defaultMenu = o.menu !== false && !$menu; + defaultHint && ($hint = buildHintFromInput($input, www)); + defaultMenu && ($menu = $(www.html.menu).css(www.css.menu)); + $hint && $hint.val(""); + $input = prepInput($input, www); + if (defaultHint || defaultMenu) { + $wrapper.css(www.css.wrapper); + $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint); + $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null); + } + MenuConstructor = defaultMenu ? DefaultMenu : Menu; + eventBus = new EventBus({ + el: $input + }); + input = new Input({ + hint: $hint, + input: $input, + menu: $menu + }, www); + menu = new MenuConstructor({ + node: $menu, + datasets: datasets + }, www); + status = new Status({ + $input: $input, + menu: menu + }); + typeahead = new Typeahead({ + input: input, + menu: menu, + eventBus: eventBus, + minLength: o.minLength, + autoselect: o.autoselect + }, www); + $input.data(keys.www, www); + $input.data(keys.typeahead, typeahead); + } + }, + isEnabled: function isEnabled() { + var enabled; + ttEach(this.first(), function(t) { + enabled = t.isEnabled(); + }); + return enabled; + }, + enable: function enable() { + ttEach(this, function(t) { + t.enable(); + }); + return this; + }, + disable: function disable() { + ttEach(this, function(t) { + t.disable(); + }); + return this; + }, + isActive: function isActive() { + var active; + ttEach(this.first(), function(t) { + active = t.isActive(); + }); + return active; + }, + activate: function activate() { + ttEach(this, function(t) { + t.activate(); + }); + return this; + }, + deactivate: function deactivate() { + ttEach(this, function(t) { + t.deactivate(); + }); + return this; + }, + isOpen: function isOpen() { + var open; + ttEach(this.first(), function(t) { + open = t.isOpen(); + }); + return open; + }, + open: function open() { + ttEach(this, function(t) { + t.open(); + }); + return this; + }, + close: function close() { + ttEach(this, function(t) { + t.close(); + }); + return this; + }, + select: function select(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.select($el); + }); + return success; + }, + autocomplete: function autocomplete(el) { + var success = false, $el = $(el); + ttEach(this.first(), function(t) { + success = t.autocomplete($el); + }); + return success; + }, + moveCursor: function moveCursoe(delta) { + var success = false; + ttEach(this.first(), function(t) { + success = t.moveCursor(delta); + }); + return success; + }, + val: function val(newVal) { + var query; + if (!arguments.length) { + ttEach(this.first(), function(t) { + query = t.getVal(); + }); + return query; + } else { + ttEach(this, function(t) { + t.setVal(_.toStr(newVal)); + }); + return this; + } + }, + destroy: function destroy() { + ttEach(this, function(typeahead, $input) { + revert($input); + typeahead.destroy(); + }); + return this; + } + }; + $.fn.typeahead = function(method) { + if (methods[method]) { + return methods[method].apply(this, [].slice.call(arguments, 1)); + } else { + return methods.initialize.apply(this, arguments); + } + }; + $.fn.typeahead.noConflict = function noConflict() { + $.fn.typeahead = old; + return this; + }; + function ttEach($els, fn) { + $els.each(function() { + var $input = $(this), typeahead; + (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input); + }); + } + function buildHintFromInput($input, www) { + return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({ + readonly: true, + required: false + }).removeAttr("id name placeholder").removeClass("required").attr({ + spellcheck: "false", + tabindex: -1 + }); + } + function prepInput($input, www) { + $input.data(keys.attrs, { + dir: $input.attr("dir"), + autocomplete: $input.attr("autocomplete"), + spellcheck: $input.attr("spellcheck"), + style: $input.attr("style") + }); + $input.addClass(www.classes.input).attr({ + spellcheck: false + }); + try { + !$input.attr("dir") && $input.attr("dir", "auto"); + } catch (e) {} + return $input; + } + function getBackgroundStyles($el) { + return { + backgroundAttachment: $el.css("background-attachment"), + backgroundClip: $el.css("background-clip"), + backgroundColor: $el.css("background-color"), + backgroundImage: $el.css("background-image"), + backgroundOrigin: $el.css("background-origin"), + backgroundPosition: $el.css("background-position"), + backgroundRepeat: $el.css("background-repeat"), + backgroundSize: $el.css("background-size") + }; + } + function revert($input) { + var www, $wrapper; + www = $input.data(keys.www); + $wrapper = $input.parent().filter(www.selectors.wrapper); + _.each($input.data(keys.attrs), function(val, key) { + _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val); + }); + $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input); + if ($wrapper.length) { + $input.detach().insertAfter($wrapper); + $wrapper.remove(); + } + } + function $elOrNull(obj) { + var isValid, $el; + isValid = _.isJQuery(obj) || _.isElement(obj); + $el = isValid ? $(obj).first() : []; + return $el.length ? $el : null; + } + })(); +}); \ No newline at end of file diff --git a/6.0.0-beta4/search.json b/6.0.0-beta4/search.json new file mode 100644 index 0000000000..89a3138fa0 --- /dev/null +++ b/6.0.0-beta4/search.json @@ -0,0 +1 @@ +{"Protocols/BTThreeDSecureRequestDelegate.html#/c:@M@BraintreeThreeDSecure@objc(pl)BTThreeDSecureRequestDelegate(im)onLookupComplete:lookupResult:next:":{"name":"onLookupComplete(_:lookupResult:next:)","abstract":"

Required delegate method which returns the ThreeDSecure lookup result before the flow continues.","parent_name":"BTThreeDSecureRequestDelegate"},"Protocols/BTLocalPaymentRequestDelegate.html#/c:@M@BraintreeLocalPayment@objc(pl)BTLocalPaymentRequestDelegate(im)localPaymentStarted:paymentID:start:":{"name":"localPaymentStarted(_:paymentID:start:)","abstract":"

Required delegate method which returns the payment ID before the flow starts.

","parent_name":"BTLocalPaymentRequestDelegate"},"Protocols/BTLocalPaymentRequestDelegate.html":{"name":"BTLocalPaymentRequestDelegate"},"Protocols/BTThreeDSecureRequestDelegate.html":{"name":"BTThreeDSecureRequestDelegate","abstract":"

Protocol for ThreeDSecure Request flow

"},"Extensions/BTThreeDSecureV2Provider.html#/s:21BraintreeThreeDSecure07BTThreeC10V2ProviderC15cardinalSessionAD15stepUpValidated9serverJWTySo08CardinalH0CSg_So0N8ResponseCSgSSSgtF":{"name":"cardinalSession(cardinalSession:stepUpValidated:serverJWT:)","parent_name":"BTThreeDSecureV2Provider"},"Extensions/BTThreeDSecureV2Provider.html":{"name":"BTThreeDSecureV2Provider"},"Enums/BTVenmoPaymentMethodUsage.html#/c:@M@BraintreeVenmo@E@BTVenmoPaymentMethodUsage@BTVenmoPaymentMethodUsageMultiUse":{"name":"multiUse","abstract":"

The Venmo payment will be authorized for future payments and can be vaulted.

","parent_name":"BTVenmoPaymentMethodUsage"},"Enums/BTVenmoPaymentMethodUsage.html#/c:@M@BraintreeVenmo@E@BTVenmoPaymentMethodUsage@BTVenmoPaymentMethodUsageSingleUse":{"name":"singleUse","abstract":"

The Venmo payment will be authorized for a one-time payment and cannot be vaulted.

","parent_name":"BTVenmoPaymentMethodUsage"},"Enums/BTPayPalRequestLandingPageType.html#/c:@M@BraintreePayPal@E@BTPayPalRequestLandingPageType@BTPayPalRequestLandingPageTypeNone":{"name":"none","abstract":"

Default

","parent_name":"BTPayPalRequestLandingPageType"},"Enums/BTPayPalRequestLandingPageType.html#/c:@M@BraintreePayPal@E@BTPayPalRequestLandingPageType@BTPayPalRequestLandingPageTypeLogin":{"name":"login","abstract":"

Login

","parent_name":"BTPayPalRequestLandingPageType"},"Enums/BTPayPalRequestLandingPageType.html#/c:@M@BraintreePayPal@E@BTPayPalRequestLandingPageType@BTPayPalRequestLandingPageTypeBilling":{"name":"billing","abstract":"

Billing

","parent_name":"BTPayPalRequestLandingPageType"},"Enums/BTPayPalPaymentType.html#/c:@M@BraintreePayPal@E@BTPayPalPaymentType@BTPayPalPaymentTypeCheckout":{"name":"checkout","abstract":"

Checkout

","parent_name":"BTPayPalPaymentType"},"Enums/BTPayPalPaymentType.html#/c:@M@BraintreePayPal@E@BTPayPalPaymentType@BTPayPalPaymentTypeVault":{"name":"vault","abstract":"

Vault

","parent_name":"BTPayPalPaymentType"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeNone":{"name":"none","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeDa_DK":{"name":"da_DK","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeDe_DE":{"name":"de_DE","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEn_AU":{"name":"en_AU","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEn_GB":{"name":"en_GB","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEn_US":{"name":"en_US","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEs_ES":{"name":"es_ES","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeEs_XC":{"name":"es_XC","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeFr_CA":{"name":"fr_CA","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeFr_FR":{"name":"fr_FR","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeFr_XC":{"name":"fr_XC","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeId_ID":{"name":"id_ID","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeIt_IT":{"name":"it_IT","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeJa_JP":{"name":"ja_JP","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeKo_KR":{"name":"ko_KR","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeNl_NL":{"name":"nl_NL","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeNo_NO":{"name":"no_NO","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodePl_PL":{"name":"pl_PL","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodePt_BR":{"name":"pt_BR","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodePt_PT":{"name":"pt_PT","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeRu_RU":{"name":"ru_RU","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeSv_SE":{"name":"sv_SE","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeTh_TH":{"name":"th_TH","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeTr_TR":{"name":"tr_TR","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeZh_CN":{"name":"zh_CN","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeZh_HK":{"name":"zh_HK","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeZh_TW":{"name":"zh_TW","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLocaleCode.html#/c:@M@BraintreePayPal@E@BTPayPalLocaleCode@BTPayPalLocaleCodeZh_XC":{"name":"zh_XC","parent_name":"BTPayPalLocaleCode"},"Enums/BTPayPalLineItemKind.html#/c:@M@BraintreePayPal@E@BTPayPalLineItemKind@BTPayPalLineItemKindDebit":{"name":"debit","abstract":"

Debit

","parent_name":"BTPayPalLineItemKind"},"Enums/BTPayPalLineItemKind.html#/c:@M@BraintreePayPal@E@BTPayPalLineItemKind@BTPayPalLineItemKindCredit":{"name":"credit","abstract":"

Credit

","parent_name":"BTPayPalLineItemKind"},"Enums/BTPayPalRequestUserAction.html#/c:@M@BraintreePayPal@E@BTPayPalRequestUserAction@BTPayPalRequestUserActionNone":{"name":"none","abstract":"

Default

","parent_name":"BTPayPalRequestUserAction"},"Enums/BTPayPalRequestUserAction.html#/c:@M@BraintreePayPal@E@BTPayPalRequestUserAction@BTPayPalRequestUserActionPayNow":{"name":"payNow","abstract":"

Pay Now

","parent_name":"BTPayPalRequestUserAction"},"Enums/BTPayPalRequestIntent.html#/c:@M@BraintreePayPal@E@BTPayPalRequestIntent@BTPayPalRequestIntentAuthorize":{"name":"authorize","abstract":"

Authorize

","parent_name":"BTPayPalRequestIntent"},"Enums/BTPayPalRequestIntent.html#/c:@M@BraintreePayPal@E@BTPayPalRequestIntent@BTPayPalRequestIntentSale":{"name":"sale","abstract":"

Sale

","parent_name":"BTPayPalRequestIntent"},"Enums/BTPayPalRequestIntent.html#/c:@M@BraintreePayPal@E@BTPayPalRequestIntent@BTPayPalRequestIntentOrder":{"name":"order","abstract":"

Order

","parent_name":"BTPayPalRequestIntent"},"Enums/BTPayPalRequestIntent.html#/s:15BraintreePayPal05BTPayC13RequestIntentO11stringValueSSvp":{"name":"stringValue","parent_name":"BTPayPalRequestIntent"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeVerify":{"name":"verify","abstract":"

Verify button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeContinue":{"name":"continue","abstract":"

Continue button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeNext":{"name":"next","abstract":"

Next button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeCancel":{"name":"cancel","abstract":"

Cancel button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureV2ButtonType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureV2ButtonType@BTThreeDSecureV2ButtonTypeResend":{"name":"resend","abstract":"

Resend button

","parent_name":"BTThreeDSecureV2ButtonType"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodUnspecified":{"name":"unspecified","abstract":"

Unspecified

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodSameDay":{"name":"sameDay","abstract":"

Same Day

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodExpedited":{"name":"expedited","abstract":"

Expedited

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodPriority":{"name":"priority","abstract":"

Priority

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodGround":{"name":"ground","abstract":"

Ground

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodElectronicDelivery":{"name":"electronicDelivery","abstract":"

Electronic Delivery

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureShippingMethod.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureShippingMethod@BTThreeDSecureShippingMethodShipToStore":{"name":"shipToStore","abstract":"

Ship to Store

","parent_name":"BTThreeDSecureShippingMethod"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeUnspecified":{"name":"unspecified","abstract":"

Unspecified

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeLowValue":{"name":"lowValue","abstract":"

Low value

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeSecureCorporate":{"name":"secureCorporate","abstract":"

Secure corporate

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeTrustedBeneficiary":{"name":"trustedBeneficiary","abstract":"

Trusted beneficiary

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureRequestedExemptionType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureRequestedExemptionType@BTThreeDSecureRequestedExemptionTypeTransactionRiskAnalysis":{"name":"transactionRiskAnalysis","abstract":"

Transaction risk analysis

","parent_name":"BTThreeDSecureRequestedExemptionType"},"Enums/BTThreeDSecureCardAddChallenge.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureCardAddChallenge@BTThreeDSecureCardAddChallengeUnspecified":{"name":"unspecified","abstract":"

Unspecified

","parent_name":"BTThreeDSecureCardAddChallenge"},"Enums/BTThreeDSecureCardAddChallenge.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureCardAddChallenge@BTThreeDSecureCardAddChallengeRequested":{"name":"requested","abstract":"

Requested

","parent_name":"BTThreeDSecureCardAddChallenge"},"Enums/BTThreeDSecureCardAddChallenge.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureCardAddChallenge@BTThreeDSecureCardAddChallengeNotRequested":{"name":"notRequested","abstract":"

Not Requested

","parent_name":"BTThreeDSecureCardAddChallenge"},"Enums/BTThreeDSecureAccountType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureAccountType@BTThreeDSecureAccountTypeUnspecified":{"name":"unspecified","abstract":"

Unspecified

","parent_name":"BTThreeDSecureAccountType"},"Enums/BTThreeDSecureAccountType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureAccountType@BTThreeDSecureAccountTypeCredit":{"name":"credit","abstract":"

Credit

","parent_name":"BTThreeDSecureAccountType"},"Enums/BTThreeDSecureAccountType.html#/c:@M@BraintreeThreeDSecure@E@BTThreeDSecureAccountType@BTThreeDSecureAccountTypeDebit":{"name":"debit","abstract":"

Debit

","parent_name":"BTThreeDSecureAccountType"},"Enums/BTSEPADirectDebitMandateType.html#/c:@M@BraintreeSEPADirectDebit@E@BTSEPADirectDebitMandateType@BTSEPADirectDebitMandateTypeOneOff":{"name":"oneOff","parent_name":"BTSEPADirectDebitMandateType"},"Enums/BTSEPADirectDebitMandateType.html#/c:@M@BraintreeSEPADirectDebit@E@BTSEPADirectDebitMandateType@BTSEPADirectDebitMandateTypeRecurrent":{"name":"recurrent","parent_name":"BTSEPADirectDebitMandateType"},"Enums/BTSEPADirectDebitMandateType.html#/s:s23CustomStringConvertibleP11descriptionSSvp":{"name":"description","parent_name":"BTSEPADirectDebitMandateType"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelCritical":{"name":"critical","abstract":"

Only log critical issues (e.g. irrecoverable errors)

","parent_name":"BTLogLevel"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelError":{"name":"error","abstract":"

Log errors (e.g. expected or recoverable errors)

","parent_name":"BTLogLevel"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelWarning":{"name":"warning","abstract":"

Log warnings (e.g. use of pre-release features)

","parent_name":"BTLogLevel"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelInfo":{"name":"info","abstract":"

Log basic information (e.g. state changes, network activity)

","parent_name":"BTLogLevel"},"Enums/BTLogLevel.html#/c:@M@BraintreeCore@E@BTLogLevel@BTLogLevelDebug":{"name":"debug","abstract":"

Log debugging statements (anything and everything)

","parent_name":"BTLogLevel"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourceUnknown":{"name":"unknown","abstract":"

Unknown source

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourcePayPalApp":{"name":"payPalApp","abstract":"

PayPal app

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourcePayPalBrowser":{"name":"payPalBrowser","abstract":"

PayPal browser

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourceVenmoApp":{"name":"venmoApp","abstract":"

Venmo app

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataSource.html#/c:@M@BraintreeCore@E@BTClientMetadataSource@BTClientMetadataSourceForm":{"name":"form","abstract":"

Form

","parent_name":"BTClientMetadataSource"},"Enums/BTClientMetadataIntegration.html#/c:@M@BraintreeCore@E@BTClientMetadataIntegration@BTClientMetadataIntegrationCustom":{"name":"custom","abstract":"

Custom

","parent_name":"BTClientMetadataIntegration"},"Enums/BTClientMetadataIntegration.html#/c:@M@BraintreeCore@E@BTClientMetadataIntegration@BTClientMetadataIntegrationDropIn":{"name":"dropIn","abstract":"

Drop-in

","parent_name":"BTClientMetadataIntegration"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkUnknown":{"name":"unknown","abstract":"

Unknown card

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkAMEX":{"name":"AMEX","abstract":"

American Express

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkDinersClub":{"name":"dinersClub","abstract":"

Diners Club

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkDiscover":{"name":"discover","abstract":"

Discover

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkMasterCard":{"name":"masterCard","abstract":"

Mastercard

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkVisa":{"name":"visa","abstract":"

Visa

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkJCB":{"name":"JCB","abstract":"

JCB

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkLaser":{"name":"laser","abstract":"

Laser

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkMaestro":{"name":"maestro","abstract":"

Maestro

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkUnionPay":{"name":"unionPay","abstract":"

Union Pay

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkHiper":{"name":"hiper","abstract":"

Hiper

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkHipercard":{"name":"hipercard","abstract":"

Hipercard

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkSolo":{"name":"solo","abstract":"

Solo

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkSwitch":{"name":"switch","abstract":"

Switch

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html#/c:@M@BraintreeCore@E@BTCardNetwork@BTCardNetworkUkMaestro":{"name":"ukMaestro","abstract":"

UK Maestro

","parent_name":"BTCardNetwork"},"Enums/BTCardNetwork.html":{"name":"BTCardNetwork","abstract":"

Card type

"},"Enums/BTClientMetadataIntegration.html":{"name":"BTClientMetadataIntegration","abstract":"

Integration Types

"},"Enums/BTClientMetadataSource.html":{"name":"BTClientMetadataSource","abstract":"

Source of the metadata

"},"Enums/BTLogLevel.html":{"name":"BTLogLevel","abstract":"

Log level used to add formatted string to NSLog

"},"Enums/BTSEPADirectDebitMandateType.html":{"name":"BTSEPADirectDebitMandateType","abstract":"

Mandate type for the SEPA Direct Debit request.

"},"Enums/BTThreeDSecureAccountType.html":{"name":"BTThreeDSecureAccountType","abstract":"

The account type

"},"Enums/BTThreeDSecureCardAddChallenge.html":{"name":"BTThreeDSecureCardAddChallenge","abstract":"

The card add challenge request

"},"Enums/BTThreeDSecureRequestedExemptionType.html":{"name":"BTThreeDSecureRequestedExemptionType","abstract":"

3D Secure requested exemption type

"},"Enums/BTThreeDSecureShippingMethod.html":{"name":"BTThreeDSecureShippingMethod","abstract":"

The shipping method

"},"Enums/BTThreeDSecureV2ButtonType.html":{"name":"BTThreeDSecureV2ButtonType","abstract":"

Button types that can be customized in 3D Secure 2 flows.

"},"Enums/BTPayPalRequestIntent.html":{"name":"BTPayPalRequestIntent","abstract":"

Payment intent.

"},"Enums/BTPayPalRequestUserAction.html":{"name":"BTPayPalRequestUserAction","abstract":"

The call-to-action in the PayPal Checkout flow.

"},"Enums/BTPayPalLineItemKind.html":{"name":"BTPayPalLineItemKind","abstract":"

Use this option to specify whether a line item is a debit (sale) or credit (refund) to the customer.

"},"Enums/BTPayPalLocaleCode.html":{"name":"BTPayPalLocaleCode","abstract":"

A locale code to use for a transaction.

"},"Enums/BTPayPalPaymentType.html":{"name":"BTPayPalPaymentType"},"Enums/BTPayPalRequestLandingPageType.html":{"name":"BTPayPalRequestLandingPageType","abstract":"

Use this option to specify the PayPal page to display when a user lands on the PayPal site to complete the payment.

"},"Enums/BTVenmoPaymentMethodUsage.html":{"name":"BTVenmoPaymentMethodUsage","abstract":"

Usage type for the tokenized Venmo account

"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(py)profileID":{"name":"profileID","abstract":"

Optional. The Venmo profile ID to be used during payment authorization. Customers will see the business name and logo associated with this Venmo profile, and it may show up in the","parent_name":"BTVenmoRequest"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(py)vault":{"name":"vault","abstract":"

Whether to automatically vault the Venmo account on the client. For client-side vaulting, you must initialize BTAPIClient with a client token that was created with a customer ID.","parent_name":"BTVenmoRequest"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(py)paymentMethodUsage":{"name":"paymentMethodUsage","abstract":"

If set to .multiUse, the Venmo payment will be authorized for future payments and can be vaulted.","parent_name":"BTVenmoRequest"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(py)displayName":{"name":"displayName","abstract":"

Optional. The business name that will be displayed in the Venmo app payment approval screen. Only used by merchants onboarded as PayFast channel partners.

","parent_name":"BTVenmoRequest"},"Classes/BTVenmoRequest.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoRequest(im)initWithPaymentMethodUsage:":{"name":"init(paymentMethodUsage:)","abstract":"

Initialize a Venmo request with a payment method usage.

","parent_name":"BTVenmoRequest"},"Classes/BTVenmoClient.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates an Apple Pay client

","parent_name":"BTVenmoClient"},"Classes/BTVenmoClient.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoClient(im)tokenizeWithVenmoRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.

","parent_name":"BTVenmoClient"},"Classes/BTVenmoClient.html#/s:14BraintreeVenmo13BTVenmoClientC8tokenizeyAA0C12AccountNonceCAA0C7RequestCYaKF":{"name":"tokenize(_:)","abstract":"

Initiates Venmo login via app switch, which returns a BTVenmoAccountNonce when successful.

","parent_name":"BTVenmoClient"},"Classes/BTVenmoClient.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoClient(im)isVenmoAppInstalled":{"name":"isVenmoAppInstalled()","abstract":"

Returns true if the proper Venmo app is installed and configured correctly, returns false otherwise.

","parent_name":"BTVenmoClient"},"Classes/BTVenmoClient.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoClient(im)openVenmoAppPageInAppStore":{"name":"openVenmoAppPageInAppStore()","abstract":"

Switches to the App Store to download the Venmo application.

","parent_name":"BTVenmoClient"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)email":{"name":"email","abstract":"

The email associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)externalID":{"name":"externalID","abstract":"

The external ID associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)firstName":{"name":"firstName","abstract":"

The first name associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)lastName":{"name":"lastName","abstract":"

The last name associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)phoneNumber":{"name":"phoneNumber","abstract":"

The phone number associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTVenmoAccountNonce.html#/c:@M@BraintreeVenmo@objc(cs)BTVenmoAccountNonce(py)username":{"name":"username","abstract":"

The username associated with the Venmo account

","parent_name":"BTVenmoAccountNonce"},"Classes/BTPayPalVaultRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalVaultRequest(py)offerCredit":{"name":"offerCredit","abstract":"

Optional: Offers PayPal Credit if the customer qualifies. Defaults to false.

","parent_name":"BTPayPalVaultRequest"},"Classes/BTPayPalVaultRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalVaultRequest(im)initWithOfferCredit:":{"name":"init(offerCredit:)","abstract":"

Initializes a PayPal Native Vault request

","parent_name":"BTPayPalVaultRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)isShippingAddressRequired":{"name":"isShippingAddressRequired","abstract":"

Defaults to false. When set to true, the shipping address selector will be displayed.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)isShippingAddressEditable":{"name":"isShippingAddressEditable","abstract":"

Defaults to false. Set to true to enable user editing of the shipping address.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)localeCode":{"name":"localeCode","abstract":"

Optional: A locale code to use for the transaction.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)shippingAddressOverride":{"name":"shippingAddressOverride","abstract":"

Optional: A valid shipping address to be displayed in the transaction flow. An error will occur if this address is not valid.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)landingPageType":{"name":"landingPageType","abstract":"

Optional: Landing page type. Defaults to .none.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)displayName":{"name":"displayName","abstract":"

Optional: The merchant name displayed inside of the PayPal flow; defaults to the company name on your Braintree account

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)merchantAccountID":{"name":"merchantAccountID","abstract":"

Optional: A non-default merchant account to use for tokenization.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)lineItems":{"name":"lineItems","abstract":"

Optional: The line items for this transaction. It can include up to 249 line items.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)billingAgreementDescription":{"name":"billingAgreementDescription","abstract":"

Optional: Display a custom description to the user for a billing agreement. For Checkout with Vault flows, you must also set","parent_name":"BTPayPalRequest"},"Classes/BTPayPalRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalRequest(py)riskCorrelationID":{"name":"riskCorrelationID","abstract":"

Optional: A risk correlation ID created with Set Transaction Context on your server.

","parent_name":"BTPayPalRequest"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)quantity":{"name":"quantity","abstract":"

Number of units of the item purchased. This value must be a whole number and can’t be negative or zero.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)unitAmount":{"name":"unitAmount","abstract":"

Per-unit price of the item. Can include up to 2 decimal places. This value can’t be negative or zero.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)name":{"name":"name","abstract":"

Item name. Maximum 127 characters.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)kind":{"name":"kind","abstract":"

Indicates whether the line item is a debit (sale) or credit (refund) to the customer.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)unitTaxAmount":{"name":"unitTaxAmount","abstract":"

Optional: Per-unit tax price of the item. Can include up to 2 decimal places. This value can’t be negative or zero.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)itemDescription":{"name":"itemDescription","abstract":"

Optional: Item description. Maximum 127 characters.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)productCode":{"name":"productCode","abstract":"

Optional: Product or UPC code for the item. Maximum 127 characters.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(py)url":{"name":"url","abstract":"

Optional: The URL to product information.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(im)initWithQuantity:unitAmount:name:kind:":{"name":"init(quantity:unitAmount:name:kind:)","abstract":"

Initialize a PayPayLineItem

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalLineItem.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalLineItem(im)requestParameters":{"name":"requestParameters()","abstract":"

Returns the line item in a dictionary.

","parent_name":"BTPayPalLineItem"},"Classes/BTPayPalCreditFinancingAmount.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancingAmount(py)currency":{"name":"currency","abstract":"

3 letter currency code as defined by ISO 4217.

","parent_name":"BTPayPalCreditFinancingAmount"},"Classes/BTPayPalCreditFinancingAmount.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancingAmount(py)value":{"name":"value","abstract":"

An amount defined by ISO 4217 for the given currency.

","parent_name":"BTPayPalCreditFinancingAmount"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)cardAmountImmutable":{"name":"cardAmountImmutable","abstract":"

Indicates whether the card amount is editable after payer’s acceptance on PayPal side.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)monthlyPayment":{"name":"monthlyPayment","abstract":"

Estimated amount per month that the customer will need to pay including fees and interest.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)payerAcceptance":{"name":"payerAcceptance","abstract":"

Status of whether the customer ultimately was approved for and chose to make the payment using the approved installment credit.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)term":{"name":"term","abstract":"

Length of financing terms in months.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)totalCost":{"name":"totalCost","abstract":"

Estimated total payment amount including interest and fees the user will pay during the lifetime of the loan.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalCreditFinancing.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCreditFinancing(py)totalInterest":{"name":"totalInterest","abstract":"

Estimated interest or fees amount the payer will have to pay during the lifetime of the loan.

","parent_name":"BTPayPalCreditFinancing"},"Classes/BTPayPalClient.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initialize a new PayPal client instance.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalClient.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalClient(im)tokenizeWithVaultRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Vault flow.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalClient.html#/s:15BraintreePayPal05BTPayC6ClientC8tokenizeyAA0dC12AccountNonceCAA0dC12VaultRequestCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Vault flow.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalClient.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalClient(im)tokenizeWithCheckoutRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Checkout or Pay Later flow.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalClient.html#/s:15BraintreePayPal05BTPayC6ClientC8tokenizeyAA0dC12AccountNonceCAA0dC15CheckoutRequestCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Checkout or Pay Later flow.

","parent_name":"BTPayPalClient"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)amount":{"name":"amount","abstract":"

Used for a one-time payment.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)intent":{"name":"intent","abstract":"

Optional: Payment intent. Defaults to .authorize. Only applies to PayPal Checkout.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)userAction":{"name":"userAction","abstract":"

Optional: Changes the call-to-action in the PayPal Checkout flow. Defaults to .none.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)offerPayLater":{"name":"offerPayLater","abstract":"

Optional: Offers PayPal Pay Later if the customer qualifies. Defaults to false. Only available with PayPal Checkout.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)currencyCode":{"name":"currencyCode","abstract":"

Optional: A three-character ISO-4217 ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(py)requestBillingAgreement":{"name":"requestBillingAgreement","abstract":"

Optional: If set to true, this enables the Checkout with Vault flow, where the customer will be prompted to consent to a billing agreement during checkout. Defaults to false.

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalCheckoutRequest.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalCheckoutRequest(im)initWithAmount:intent:userAction:offerPayLater:currencyCode:requestBillingAgreement:":{"name":"init(amount:intent:userAction:offerPayLater:currencyCode:requestBillingAgreement:)","abstract":"

Initializes a PayPal Native Checkout request

","parent_name":"BTPayPalCheckoutRequest"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)email":{"name":"email","abstract":"

Payer’s email address.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)firstName":{"name":"firstName","abstract":"

Payer’s first name.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)lastName":{"name":"lastName","abstract":"

Payer’s last name.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)phone":{"name":"phone","abstract":"

Payer’s phone number.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)billingAddress":{"name":"billingAddress","abstract":"

The billing address.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)shippingAddress":{"name":"shippingAddress","abstract":"

The shipping address.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)clientMetadataID":{"name":"clientMetadataID","abstract":"

Client metadata id associated with this transaction.

","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)payerID":{"name":"payerID","abstract":"

Optional. Payer id associated with this transaction.","parent_name":"BTPayPalAccountNonce"},"Classes/BTPayPalAccountNonce.html#/c:@M@BraintreePayPal@objc(cs)BTPayPalAccountNonce(py)creditFinancing":{"name":"creditFinancing","abstract":"

Optional. Credit financing details if the customer pays with PayPal Credit.","parent_name":"BTPayPalAccountNonce"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)acsTransactionID":{"name":"acsTransactionID","abstract":"

Unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)authenticationTransactionStatus":{"name":"authenticationTransactionStatus","abstract":"

On authentication, the transaction status result identifier.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)authenticationTransactionStatusReason":{"name":"authenticationTransactionStatusReason","abstract":"

On authentication, provides additional information as to why the transaction status has the specific value.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)cavv":{"name":"cavv","abstract":"

Cardholder authentication verification value or “CAVV” is the main encrypted message issuers and card networks use to verify authentication has occured.","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)dsTransactionID":{"name":"dsTransactionID","abstract":"

Directory Server Transaction ID is an ID used by the card brand’s 3DS directory server.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)eciFlag":{"name":"eciFlag","abstract":"

The ecommerce indicator flag indicates the outcome of the 3DS authentication.","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)enrolled":{"name":"enrolled","abstract":"

Indicates whether a card is enrolled in a 3D Secure program or not. Possible values:

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)liabilityShifted":{"name":"liabilityShifted","abstract":"

If the 3D Secure liability shift has occurred.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)liabilityShiftPossible":{"name":"liabilityShiftPossible","abstract":"

If the 3D Secure liability shift is possible.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)lookupTransactionStatus":{"name":"lookupTransactionStatus","abstract":"

On lookup, the transaction status result identifier.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)lookupTransactionStatusReason":{"name":"lookupTransactionStatusReason","abstract":"

On lookup, provides additional information as to why the transaction status has the specific value.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)paresStatus":{"name":"paresStatus","abstract":"

The Payer Authentication Response (PARes) Status, a transaction status result identifier. Possible Values:

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)status":{"name":"status","abstract":"

The 3D Secure status value.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)threeDSecureAuthenticationID":{"name":"threeDSecureAuthenticationID","abstract":"

Unique identifier assigned to the 3D Secure authentication performed for this transaction.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)threeDSecureServerTransactionID":{"name":"threeDSecureServerTransactionID","abstract":"

Unique transaction identifier assigned by the 3DS Server to identify a single transaction.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)threeDSecureVersion":{"name":"threeDSecureVersion","abstract":"

The 3DS version used in the authentication, example “1.0.2” or “2.1.0”.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)wasVerified":{"name":"wasVerified","abstract":"

Indicates if the 3D Secure lookup was performed.

","parent_name":"BTThreeDSecureInfo"},"Classes/BTThreeDSecureInfo.html#/c:@M@BraintreeCard@objc(cs)BTThreeDSecureInfo(py)xid":{"name":"xid","abstract":"

Transaction identifier resulting from 3D Secure authentication. Uniquely identifies the transaction and sometimes required in the authorization message.","parent_name":"BTThreeDSecureInfo"},"Classes/BTCardRequest.html#/c:@M@BraintreeCard@objc(cs)BTCardRequest(py)card":{"name":"card","abstract":"

The BTCard associated with this instance.

","parent_name":"BTCardRequest"},"Classes/BTCardRequest.html#/c:@M@BraintreeCard@objc(cs)BTCardRequest(im)initWithCard:":{"name":"init(card:)","abstract":"

Initialize a Card request with a BTCard.

","parent_name":"BTCardRequest"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)cardNetwork":{"name":"cardNetwork","abstract":"

The card network.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)expirationMonth":{"name":"expirationMonth","abstract":"

The expiration month of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)expirationYear":{"name":"expirationYear","abstract":"

The expiration year of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)cardholderName":{"name":"cardholderName","abstract":"

The name of the cardholder, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)lastTwo":{"name":"lastTwo","abstract":"

The last two digits of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)lastFour":{"name":"lastFour","abstract":"

The last four digits of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)bin":{"name":"bin","abstract":"

The BIN number of the card, if available.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)binData":{"name":"binData","abstract":"

The BIN data for the card number associated with this nonce.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)threeDSecureInfo":{"name":"threeDSecureInfo","abstract":"

The 3D Secure info for the card number associated with this nonce.

","parent_name":"BTCardNonce"},"Classes/BTCardNonce.html#/c:@M@BraintreeCard@objc(cs)BTCardNonce(py)authenticationInsight":{"name":"authenticationInsight","abstract":"

Details about the regulatory environment and applicable customer authentication regulation for a potential transaction.","parent_name":"BTCardNonce"},"Classes/BTCardClient.html#/c:@M@BraintreeCard@objc(cs)BTCardClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates a card client

","parent_name":"BTCardClient"},"Classes/BTCardClient.html#/c:@M@BraintreeCard@objc(cs)BTCardClient(im)tokenizeCard:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenizes a card

","parent_name":"BTCardClient"},"Classes/BTCardClient.html#/s:13BraintreeCard12BTCardClientC8tokenizeyAA0C5NonceCAA0C0CYaKF":{"name":"tokenize(_:)","abstract":"

Tokenizes a card

","parent_name":"BTCardClient"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)number":{"name":"number","abstract":"

The card number

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)expirationMonth":{"name":"expirationMonth","abstract":"

The expiration month as a one or two-digit number on the Gregorian calendar

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)expirationYear":{"name":"expirationYear","abstract":"

The expiration year as a two or four-digit number on the Gregorian calendar

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)cvv":{"name":"cvv","abstract":"

The card verification code (like CVV or CID).

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)postalCode":{"name":"postalCode","abstract":"

The postal code associated with the card’s billing address

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)cardholderName":{"name":"cardholderName","abstract":"

Optional: the cardholder’s name.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)firstName":{"name":"firstName","abstract":"

Optional: first name on the card.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)lastName":{"name":"lastName","abstract":"

Optional: last name on the card.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)company":{"name":"company","abstract":"

Optional: company name associated with the card.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)streetAddress":{"name":"streetAddress","abstract":"

Optional: the street address associated with the card’s billing address

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)extendedAddress":{"name":"extendedAddress","abstract":"

Optional: the extended address associated with the card’s billing address

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)locality":{"name":"locality","abstract":"

Optional: the city associated with the card’s billing address

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)region":{"name":"region","abstract":"

Optional: either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)countryName":{"name":"countryName","abstract":"

Optional: the country name associated with the card’s billing address.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)countryCodeAlpha2":{"name":"countryCodeAlpha2","abstract":"

Optional: the ISO 3166-1 alpha-2 country code specified in the card’s billing address.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)countryCodeAlpha3":{"name":"countryCodeAlpha3","abstract":"

Optional: the ISO 3166-1 alpha-3 country code specified in the card’s billing address.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)countryCodeNumeric":{"name":"countryCodeNumeric","abstract":"

Optional: The ISO 3166-1 numeric country code specified in the card’s billing address.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)shouldValidate":{"name":"shouldValidate","abstract":"

Controls whether or not to return validations and/or verification results. By default, this is not enabled.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)authenticationInsightRequested":{"name":"authenticationInsightRequested","abstract":"

Optional: If authentication insight is requested. If this property is set to true, a merchantAccountID must be provided. Defaults to false.

","parent_name":"BTCard"},"Classes/BTCard.html#/c:@M@BraintreeCard@objc(cs)BTCard(py)merchantAccountID":{"name":"merchantAccountID","abstract":"

Optional: The merchant account ID.

","parent_name":"BTCard"},"Classes/BTAuthenticationInsight.html#/c:@M@BraintreeCard@objc(cs)BTAuthenticationInsight(py)regulationEnvironment":{"name":"regulationEnvironment","abstract":"

The regulation environment for the associated nonce to help determine the need for 3D Secure.","parent_name":"BTAuthenticationInsight"},"Classes/BTThreeDSecureV2UICustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2UICustomization(py)toolbarCustomization":{"name":"toolbarCustomization","abstract":"

Toolbar customization options for 3D Secure 2 flows.

","parent_name":"BTThreeDSecureV2UICustomization"},"Classes/BTThreeDSecureV2UICustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2UICustomization(py)labelCustomization":{"name":"labelCustomization","abstract":"

Label customization options for 3D Secure 2 flows.

","parent_name":"BTThreeDSecureV2UICustomization"},"Classes/BTThreeDSecureV2UICustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2UICustomization(py)textBoxCustomization":{"name":"textBoxCustomization","abstract":"

Text box customization options for 3D Secure 2 flows.

","parent_name":"BTThreeDSecureV2UICustomization"},"Classes/BTThreeDSecureV2UICustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2UICustomization(im)setButtonCustomization:buttonType:":{"name":"setButton(_:buttonType:)","abstract":"

Set button customization options for 3D Secure 2 flows.

","parent_name":"BTThreeDSecureV2UICustomization"},"Classes/BTThreeDSecureV2ToolbarCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ToolbarCustomization(py)backgroundColor":{"name":"backgroundColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2ToolbarCustomization"},"Classes/BTThreeDSecureV2ToolbarCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ToolbarCustomization(py)headerText":{"name":"headerText","abstract":"

Text for the header.

","parent_name":"BTThreeDSecureV2ToolbarCustomization"},"Classes/BTThreeDSecureV2ToolbarCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ToolbarCustomization(py)buttonText":{"name":"buttonText","abstract":"

Text for the button. For example, “Cancel”.

","parent_name":"BTThreeDSecureV2ToolbarCustomization"},"Classes/BTThreeDSecureV2ToolbarCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ToolbarCustomization(im)init":{"name":"init()","parent_name":"BTThreeDSecureV2ToolbarCustomization"},"Classes/BTThreeDSecureV2TextBoxCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2TextBoxCustomization(py)borderWidth":{"name":"borderWidth","abstract":"

Width (integer value) of the text box border.

","parent_name":"BTThreeDSecureV2TextBoxCustomization"},"Classes/BTThreeDSecureV2TextBoxCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2TextBoxCustomization(py)borderColor":{"name":"borderColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2TextBoxCustomization"},"Classes/BTThreeDSecureV2TextBoxCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2TextBoxCustomization(py)cornerRadius":{"name":"cornerRadius","abstract":"

Radius (integer value) for the text box corners.

","parent_name":"BTThreeDSecureV2TextBoxCustomization"},"Classes/BTThreeDSecureV2TextBoxCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2TextBoxCustomization(im)init":{"name":"init()","parent_name":"BTThreeDSecureV2TextBoxCustomization"},"Classes/BTThreeDSecureV2LabelCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2LabelCustomization(py)headingTextColor":{"name":"headingTextColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2LabelCustomization"},"Classes/BTThreeDSecureV2LabelCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2LabelCustomization(py)headingTextFontName":{"name":"headingTextFontName","abstract":"

Font type for the heading label text.

","parent_name":"BTThreeDSecureV2LabelCustomization"},"Classes/BTThreeDSecureV2LabelCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2LabelCustomization(py)headingTextFontSize":{"name":"headingTextFontSize","abstract":"

Font size for the heading label text.

","parent_name":"BTThreeDSecureV2LabelCustomization"},"Classes/BTThreeDSecureV2LabelCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2LabelCustomization(im)init":{"name":"init()","parent_name":"BTThreeDSecureV2LabelCustomization"},"Classes/BTThreeDSecureV2ButtonCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ButtonCustomization(py)backgroundColor":{"name":"backgroundColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2ButtonCustomization"},"Classes/BTThreeDSecureV2ButtonCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ButtonCustomization(py)cornerRadius":{"name":"cornerRadius","abstract":"

Radius (integer value) for the button corners.

","parent_name":"BTThreeDSecureV2ButtonCustomization"},"Classes/BTThreeDSecureV2ButtonCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2ButtonCustomization(im)init":{"name":"init()","parent_name":"BTThreeDSecureV2ButtonCustomization"},"Classes/BTThreeDSecureV2BaseCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2BaseCustomization(py)textFontName":{"name":"textFontName","abstract":"

Font type for the UI element.

","parent_name":"BTThreeDSecureV2BaseCustomization"},"Classes/BTThreeDSecureV2BaseCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2BaseCustomization(py)textColor":{"name":"textColor","abstract":"

Color code in Hex format. For example, the color code can be “#999999”.

","parent_name":"BTThreeDSecureV2BaseCustomization"},"Classes/BTThreeDSecureV2BaseCustomization.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureV2BaseCustomization(py)textFontSize":{"name":"textFontSize","abstract":"

Font size for the UI element.

","parent_name":"BTThreeDSecureV2BaseCustomization"},"Classes/BTThreeDSecureResult.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureResult(py)tokenizedCard":{"name":"tokenizedCard","abstract":"

The BTCardNonce resulting from the 3D Secure flow

","parent_name":"BTThreeDSecureResult"},"Classes/BTThreeDSecureResult.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureResult(py)lookup":{"name":"lookup","abstract":"

The result of a 3D Secure lookup. Contains liability shift and challenge information.

","parent_name":"BTThreeDSecureResult"},"Classes/BTThreeDSecureResult.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureResult(py)errorMessage":{"name":"errorMessage","abstract":"

The error message when the 3D Secure flow is unsuccessful

","parent_name":"BTThreeDSecureResult"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)nonce":{"name":"nonce","abstract":"

A nonce to be verified by ThreeDSecure

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)amount":{"name":"amount","abstract":"

The amount for the transaction

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)accountType":{"name":"accountType","abstract":"

Optional. The account type selected by the cardholder

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)billingAddress":{"name":"billingAddress","abstract":"

Optional. The billing address used for verification

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)mobilePhoneNumber":{"name":"mobilePhoneNumber","abstract":"

Optional. The mobile phone number used for verification

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)email":{"name":"email","abstract":"

Optional. The email used for verification

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)shippingMethod":{"name":"shippingMethod","abstract":"

Optional. The shipping method chosen for the transaction

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)additionalInformation":{"name":"additionalInformation","abstract":"

Optional. The additional information used for verification

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)challengeRequested":{"name":"challengeRequested","abstract":"

Optional. If set to true, an authentication challenge will be forced if possible.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)exemptionRequested":{"name":"exemptionRequested","abstract":"

Optional. If set to true, an exemption to the authentication challenge will be requested.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)requestedExemptionType":{"name":"requestedExemptionType","abstract":"

Optional. The exemption type to be requested. If an exemption is requested and the exemption’s conditions are satisfied, then it will be applied.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)dataOnlyRequested":{"name":"dataOnlyRequested","abstract":"

Optional. Indicates whether to use the data only flow. In this flow, frictionless 3DS is ensured for Mastercard cardholders as the card scheme provides a risk score","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)cardAddChallenge":{"name":"cardAddChallenge","abstract":"

Optional. An authentication created using this property should only be used for adding a payment method to the merchant’s vault and not for creating transactions.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)v2UICustomization":{"name":"v2UICustomization","abstract":"

Optional. UI Customization for 3DS2 challenge views.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecureRequest.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureRequest(py)threeDSecureRequestDelegate":{"name":"threeDSecureRequestDelegate","abstract":"

A delegate for receiving information about the ThreeDSecure payment flow.

","parent_name":"BTThreeDSecureRequest"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)givenName":{"name":"givenName","abstract":"

Optional. Given name associated with the address

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)surname":{"name":"surname","abstract":"

Optional. Surname associated with the address

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)streetAddress":{"name":"streetAddress","abstract":"

Optional. Line 1 of the Address (eg. number, street, etc)

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)extendedAddress":{"name":"extendedAddress","abstract":"

Optional. Line 2 of the Address (eg. suite, apt #, etc.)

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)line3":{"name":"line3","abstract":"

Optional. Line 3 of the Address (eg. suite, apt #, etc.)

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)locality":{"name":"locality","abstract":"

Optional. City name

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)region":{"name":"region","abstract":"

Optional. Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)postalCode":{"name":"postalCode","abstract":"

Optional. Zip code or equivalent is usually required for countries that have them.","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)countryCodeAlpha2":{"name":"countryCodeAlpha2","abstract":"

Optional. 2 letter country code

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(py)phoneNumber":{"name":"phoneNumber","abstract":"

Optional. The phone number associated with the address

","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecurePostalAddress.html#/c:@CM@BraintreeThreeDSecure@objc(cs)BTThreeDSecurePostalAddress(im)copyWithZone:":{"name":"copy(with:)","parent_name":"BTThreeDSecurePostalAddress"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)paReq":{"name":"paReq","abstract":"

The “PAReq” or “Payment Authentication Request” is the encoded request message used to initiate authentication.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)md":{"name":"md","abstract":"

The unique 3DS identifier assigned by Braintree to track the 3DS call as it progresses.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)acsURL":{"name":"acsURL","abstract":"

The URL which the customer will be redirected to for a 3DS Interface.","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)termURL":{"name":"termURL","abstract":"

The termURL is the fully qualified URL that the customer will be redirected to once the authentication completes.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)threeDSecureVersion":{"name":"threeDSecureVersion","abstract":"

The full version string of the 3DS lookup result.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)isThreeDSecureVersion2":{"name":"isThreeDSecureVersion2","abstract":"

Indicates a 3DS 2 lookup result.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)transactionID":{"name":"transactionID","abstract":"

This a secondary unique 3DS identifier assigned by Braintree to track the 3DS call as it progresses.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureLookup.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureLookup(py)requiresUserAuthentication":{"name":"requiresUserAuthentication","abstract":"

Indicates that a 3DS challenge is required.

","parent_name":"BTThreeDSecureLookup"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initialize a new BTThreeDSecureClient instance.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)startPaymentFlow:completion:":{"name":"startPaymentFlow(_:completion:)","abstract":"

Starts the 3DS flow using a BTThreeDSecureRequest.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)prepareLookup:completion:":{"name":"prepareLookup(_:completion:)","abstract":"

Creates a stringified JSON object containing the information necessary to perform a lookup.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)prepareLookup:completionHandler:":{"name":"prepareLookup(_:)","abstract":"

Creates a stringified JSON object containing the information necessary to perform a lookup.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)initializeChallengeWithLookupResponse:request:completion:":{"name":"initializeChallenge(lookupResponse:request:completion:)","abstract":"

Initialize a challenge from a server side lookup call.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureClient.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureClient(im)initializeChallengeWithLookupResponse:request:completionHandler:":{"name":"initializeChallenge(lookupResponse:request:)","abstract":"

Initialize a challenge from a server side lookup call.

","parent_name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingAddress":{"name":"shippingAddress","abstract":"

Optional. The shipping address used for verification

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingMethodIndicator":{"name":"shippingMethodIndicator","abstract":"

Optional. The 2-digit string indicating the shipping method chosen for the transaction

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)productCode":{"name":"productCode","abstract":"

Optional. The 3-letter string representing the merchant product code

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)deliveryTimeframe":{"name":"deliveryTimeframe","abstract":"

Optional. The 2-digit number indicating the delivery timeframe

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)deliveryEmail":{"name":"deliveryEmail","abstract":"

Optional. For electronic delivery, email address to which the merchandise was delivered

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)reorderIndicator":{"name":"reorderIndicator","abstract":"

Optional. The 2-digit number indicating whether the cardholder is reordering previously purchased merchandise

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)preorderIndicator":{"name":"preorderIndicator","abstract":"

Optional. The 2-digit number indicating whether the cardholder is placing an order with a future availability or release date

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)preorderDate":{"name":"preorderDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating expected date that a pre-ordered purchase will be available

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)giftCardAmount":{"name":"giftCardAmount","abstract":"

Optional. The purchase amount total for prepaid gift cards in major units

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)giftCardCurrencyCode":{"name":"giftCardCurrencyCode","abstract":"

Optional. ISO 4217 currency code for the gift card purchased

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)giftCardCount":{"name":"giftCardCount","abstract":"

Optional. Total count of individual prepaid gift cards purchased

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountAgeIndicator":{"name":"accountAgeIndicator","abstract":"

Optional. The 2-digit value representing the length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountCreateDate":{"name":"accountCreateDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder’s account was last changed.","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountChangeIndicator":{"name":"accountChangeIndicator","abstract":"

Optional. The 2-digit value representing the length of time since the last change to the cardholder account. This includes shipping address, new payment account or new user added.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountChangeDate":{"name":"accountChangeDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder’s account was last changed.","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountPwdChangeIndicator":{"name":"accountPwdChangeIndicator","abstract":"

Optional. The 2-digit value representing the length of time since the cardholder changed or reset the password on the account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountPwdChangeDate":{"name":"accountPwdChangeDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date the cardholder last changed or reset password on account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingAddressUsageIndicator":{"name":"shippingAddressUsageIndicator","abstract":"

Optional. The 2-digit value indicating when the shipping address used for transaction was first used.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingAddressUsageDate":{"name":"shippingAddressUsageDate","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date when the shipping address used for this transaction was first used.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)transactionCountDay":{"name":"transactionCountDay","abstract":"

Optional. Number of transactions (successful or abandoned) for this cardholder account within the last 24 hours.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)transactionCountYear":{"name":"transactionCountYear","abstract":"

Optional. Number of transactions (successful or abandoned) for this cardholder account within the last year.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)addCardAttempts":{"name":"addCardAttempts","abstract":"

Optional. Number of add card attempts in the last 24 hours.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountPurchases":{"name":"accountPurchases","abstract":"

Optional. Number of purchases with this cardholder account during the previous six months.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)fraudActivity":{"name":"fraudActivity","abstract":"

Optional. The 2-digit value indicating whether the merchant experienced suspicious activity (including previous fraud) on the account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)shippingNameIndicator":{"name":"shippingNameIndicator","abstract":"

Optional. The 2-digit value indicating if the cardholder name on the account is identical to the shipping name used for the transaction.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)paymentAccountIndicator":{"name":"paymentAccountIndicator","abstract":"

Optional. The 2-digit value indicating the length of time that the payment account was enrolled in the merchant account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)paymentAccountAge":{"name":"paymentAccountAge","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date the payment account was added to the cardholder account.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)addressMatch":{"name":"addressMatch","abstract":"

Optional. The 1-character value (Y/N) indicating whether cardholder billing and shipping addresses match.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)accountID":{"name":"accountID","abstract":"

Optional. Additional cardholder account information.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)ipAddress":{"name":"ipAddress","abstract":"

Optional. The IP address of the consumer. IPv4 and IPv6 are supported.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)orderDescription":{"name":"orderDescription","abstract":"

Optional. Brief description of items purchased.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)taxAmount":{"name":"taxAmount","abstract":"

Optional. Unformatted tax amount without any decimalization (ie. $123.67 = 12367).

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)userAgent":{"name":"userAgent","abstract":"

Optional. The exact content of the HTTP user agent header.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)authenticationIndicator":{"name":"authenticationIndicator","abstract":"

Optional. The 2-digit number indicating the type of authentication request.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)installment":{"name":"installment","abstract":"

Optional. An integer value greater than 1 indicating the maximum number of permitted authorizations for installment payments.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)purchaseDate":{"name":"purchaseDate","abstract":"

Optional. The 14-digit number (format: YYYYMMDDHHMMSS) indicating the date in UTC of original purchase.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)recurringEnd":{"name":"recurringEnd","abstract":"

Optional. The 8-digit number (format: YYYYMMDD) indicating the date after which no further recurring authorizations should be performed.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)recurringFrequency":{"name":"recurringFrequency","abstract":"

Optional. Integer value indicating the minimum number of days between recurring authorizations.","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)sdkMaxTimeout":{"name":"sdkMaxTimeout","abstract":"

Optional. The 2-digit number of minutes (minimum 05) to set the maximum amount of time for all 3DS 2.0 messages to be communicated between all components.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTThreeDSecureAdditionalInformation.html#/c:@M@BraintreeThreeDSecure@objc(cs)BTThreeDSecureAdditionalInformation(py)workPhoneNumber":{"name":"workPhoneNumber","abstract":"

Optional. The work phone number used for verification. Only numbers; remove dashes, parenthesis and other characters.

","parent_name":"BTThreeDSecureAdditionalInformation"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)billingAddress":{"name":"billingAddress","abstract":"

The billing address.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)clientMetadataID":{"name":"clientMetadataID","abstract":"

Client Metadata ID associated with this transaction.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)email":{"name":"email","abstract":"

Payer’s email address.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)firstName":{"name":"firstName","abstract":"

Payer’s first name.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)lastName":{"name":"lastName","abstract":"

Payer’s last name.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)nonce":{"name":"nonce","abstract":"

The one-time use payment method nonce.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)payerID":{"name":"payerID","abstract":"

Payer ID associated with this transaction.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)phone":{"name":"phone","abstract":"

Payer’s phone number.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)shippingAddress":{"name":"shippingAddress","abstract":"

The shipping address.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentResult.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentResult(py)type":{"name":"type","abstract":"

The type of the tokenized payment.

","parent_name":"BTLocalPaymentResult"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)paymentType":{"name":"paymentType","abstract":"

The type of payment.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)paymentTypeCountryCode":{"name":"paymentTypeCountryCode","abstract":"

The country code of the local payment.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)merchantAccountID":{"name":"merchantAccountID","abstract":"

Optional: The address of the customer. An error will occur if this address is not valid.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)address":{"name":"address","abstract":"

Optional: The address of the customer. An error will occur if this address is not valid.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)amount":{"name":"amount","abstract":"

The amount for the transaction.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)currencyCode":{"name":"currencyCode","abstract":"

Optional: A valid ISO currency code to use for the transaction. Defaults to merchant currency code if not set.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)displayName":{"name":"displayName","abstract":"

Optional: The merchant name displayed inside of the local payment flow.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)email":{"name":"email","abstract":"

Optional: Payer email of the customer.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)givenName":{"name":"givenName","abstract":"

Optional: Given (first) name of the customer.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)surname":{"name":"surname","abstract":"

Optional: Surname (last name) of the customer.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)phone":{"name":"phone","abstract":"

Optional: Phone number of the customer.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)isShippingAddressRequired":{"name":"isShippingAddressRequired","abstract":"

Indicates whether or not the payment needs to be shipped. For digital goods, this should be false. Defaults to false.

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)bic":{"name":"bic","abstract":"

Optional: Bank Identification Code of the customer (specific to iDEAL transactions).

","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentRequest.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentRequest(py)localPaymentFlowDelegate":{"name":"localPaymentFlowDelegate","parent_name":"BTLocalPaymentRequest"},"Classes/BTLocalPaymentClient.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initialize a new BTLocalPaymentClient instance.

","parent_name":"BTLocalPaymentClient"},"Classes/BTLocalPaymentClient.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentClient(im)startPaymentFlow:completion:":{"name":"startPaymentFlow(_:completion:)","abstract":"

Starts a payment flow using a BTLocalPaymentRequest

","parent_name":"BTLocalPaymentClient"},"Classes/BTLocalPaymentClient.html#/c:@M@BraintreeLocalPayment@objc(cs)BTLocalPaymentClient(im)startPaymentFlow:completionHandler:":{"name":"startPaymentFlow(_:)","abstract":"

Starts a payment flow using a BTLocalPaymentRequest

","parent_name":"BTLocalPaymentClient"},"Classes/BTApplePayClient.html#/c:@M@BraintreeApplePay@objc(cs)BTApplePayClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates an Apple Pay client

","parent_name":"BTApplePayClient"},"Classes/BTApplePayClient.html#/c:@M@BraintreeApplePay@objc(cs)BTApplePayClient(im)makePaymentRequest:":{"name":"makePaymentRequest(completion:)","abstract":"

Creates a PKPaymentRequest with values from your Braintree Apple Pay configuration.","parent_name":"BTApplePayClient"},"Classes/BTApplePayClient.html#/s:17BraintreeApplePay07BTAppleC6ClientC18makePaymentRequestSo09PKPaymentH0CyYaKF":{"name":"makePaymentRequest()","abstract":"

Creates a PKPaymentRequest with values from your Braintree Apple Pay configuration.","parent_name":"BTApplePayClient"},"Classes/BTApplePayClient.html#/c:@M@BraintreeApplePay@objc(cs)BTApplePayClient(im)tokenizeApplePayPayment:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenizes an Apple Pay payment.

","parent_name":"BTApplePayClient"},"Classes/BTApplePayClient.html#/s:17BraintreeApplePay07BTAppleC6ClientC8tokenizeyAA0dC9CardNonceCSo9PKPaymentCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenizes an Apple Pay payment.

","parent_name":"BTApplePayClient"},"Classes/BTApplePayCardNonce.html#/c:@M@BraintreeApplePay@objc(cs)BTApplePayCardNonce(py)binData":{"name":"binData","abstract":"

The BIN data for the card number associated with this nonce.

","parent_name":"BTApplePayCardNonce"},"Classes/BTDataCollector.html#/c:@M@BraintreeDataCollector@objc(cs)BTDataCollector(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initializes a BTDataCollector instance with a BTAPIClient.

","parent_name":"BTDataCollector"},"Classes/BTDataCollector.html#/c:@M@BraintreeDataCollector@objc(cs)BTDataCollector(im)clientMetadataID:":{"name":"clientMetadataID(_:)","abstract":"

Returns a client metadata ID.

","parent_name":"BTDataCollector"},"Classes/BTDataCollector.html#/c:@M@BraintreeDataCollector@objc(cs)BTDataCollector(im)collectDeviceData:":{"name":"collectDeviceData(_:)","abstract":"

Collects device data based on your merchant configuration.

","parent_name":"BTDataCollector"},"Classes/BTDataCollector.html#/s:22BraintreeDataCollector06BTDataC0C013collectDeviceB0SSyYaKF":{"name":"collectDeviceData()","abstract":"

Collects device data based on your merchant configuration.

","parent_name":"BTDataCollector"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)errorCode":{"name":"errorCode","abstract":"

Optional. An error code when there was an issue fetching the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)errorMessage":{"name":"errorMessage","abstract":"

Optional. An error message when there was an issue fetching the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)conversionRate":{"name":"conversionRate","abstract":"

Optional. The conversion rate associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)currencyAmount":{"name":"currencyAmount","abstract":"

Optional. The currency amount associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)currencyIsoCode":{"name":"currencyIsoCode","abstract":"

Optional. The currency ISO code associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)requestID":{"name":"requestID","abstract":"

Optional. The request ID used when fetching the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)rewardsAmount":{"name":"rewardsAmount","abstract":"

Optional. The rewards amount associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressRewardsBalance.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressRewardsBalance(py)rewardsUnit":{"name":"rewardsUnit","abstract":"

Optional. The rewards unit associated with the rewards balance

","parent_name":"BTAmericanExpressRewardsBalance"},"Classes/BTAmericanExpressClient.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates an American Express client.

","parent_name":"BTAmericanExpressClient"},"Classes/BTAmericanExpressClient.html#/c:@M@BraintreeAmericanExpress@objc(cs)BTAmericanExpressClient(im)getRewardsBalanceForNonce:currencyIsoCode:completion:":{"name":"getRewardsBalance(forNonce:currencyISOCode:completion:)","abstract":"

Gets the rewards balance associated with a Braintree nonce. Only for American Express cards.

","parent_name":"BTAmericanExpressClient"},"Classes/BTAmericanExpressClient.html#/s:24BraintreeAmericanExpress010BTAmericanC6ClientC17getRewardsBalance8forNonce15currencyISOCodeAA0dcgH0CSS_SStYaKF":{"name":"getRewardsBalance(forNonce:currencyISOCode:)","abstract":"

Gets the rewards balance associated with a Braintree nonce. Only for American Express cards.

","parent_name":"BTAmericanExpressClient"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)accountHolderName":{"name":"accountHolderName","abstract":"

Required. The account holder name.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)iban":{"name":"iban","abstract":"

Required. The full IBAN.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)customerID":{"name":"customerID","abstract":"

Required. The customer ID.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/s:24BraintreeSEPADirectDebit012BTSEPADirectC7RequestC11mandateTypeAA0dc7MandateG0OSgvp":{"name":"mandateType","abstract":"

Optional. The BTSEPADebitMandateType. If not set, defaults to .oneOff

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)billingAddress":{"name":"billingAddress","abstract":"

Required. The user’s billing address.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitRequest(py)merchantAccountID":{"name":"merchantAccountID","abstract":"

Optional. A non-default merchant account to use for tokenization.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitRequest.html#/s:24BraintreeSEPADirectDebit012BTSEPADirectC7RequestC17accountHolderName4iban10customerID11mandateType14billingAddress015merchantAccountK0ACSSSg_A2jA0dc7MandateM0OSg0A4Core08BTPostalO0CSgAJtcfc":{"name":"init(accountHolderName:iban:customerID:mandateType:billingAddress:merchantAccountID:)","abstract":"

Initialize a new SEPA Direct Debit request.

","parent_name":"BTSEPADirectDebitRequest"},"Classes/BTSEPADirectDebitNonce.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitNonce(py)ibanLastFour":{"name":"ibanLastFour","abstract":"

The IBAN last four characters.

","parent_name":"BTSEPADirectDebitNonce"},"Classes/BTSEPADirectDebitNonce.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitNonce(py)customerID":{"name":"customerID","abstract":"

The customer ID.

","parent_name":"BTSEPADirectDebitNonce"},"Classes/BTSEPADirectDebitNonce.html#/s:24BraintreeSEPADirectDebit012BTSEPADirectC5NonceC11mandateTypeAA0dc7MandateG0OSgvp":{"name":"mandateType","abstract":"

The BTSEPADebitMandateType.

","parent_name":"BTSEPADirectDebitNonce"},"Classes/BTSEPADirectDebitClient.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Creates a SEPA Direct Debit client.

","parent_name":"BTSEPADirectDebitClient"},"Classes/BTSEPADirectDebitClient.html#/c:@M@BraintreeSEPADirectDebit@objc(cs)BTSEPADirectDebitClient(im)tokenizeWithSEPADirectDebitRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Initiates an ASWebAuthenticationSession to display a mandate to the user. Upon successful mandate creation, tokenizes the payment method and returns a result

","parent_name":"BTSEPADirectDebitClient"},"Classes/BTSEPADirectDebitClient.html#/s:24BraintreeSEPADirectDebit012BTSEPADirectC6ClientC8tokenizeyAA0dC5NonceCAA0dC7RequestCYaKF":{"name":"tokenize(_:)","abstract":"

Initiates an ASWebAuthenticationSession to display a mandate to the user. Upon successful mandate creation, tokenizes the payment method and returns a result

","parent_name":"BTSEPADirectDebitClient"},"Classes/BTPayPalNativeVaultRequest.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeVaultRequest(im)initWithOfferCredit:billingAgreementDescription:":{"name":"init(offerCredit:billingAgreementDescription:)","abstract":"

Initializes a PayPal Native Vault request

","parent_name":"BTPayPalNativeVaultRequest"},"Classes/BTPayPalNativeCheckoutRequest.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutRequest(im)initWithAmount:intent:offerPayLater:currencyCode:requestBillingAgreement:billingAgreementDescription:":{"name":"init(amount:intent:offerPayLater:currencyCode:requestBillingAgreement:billingAgreementDescription:)","abstract":"

Initializes a PayPal Native Checkout request

","parent_name":"BTPayPalNativeCheckoutRequest"},"Classes/BTPayPalNativeCheckoutClient.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutClient(im)initWithAPIClient:":{"name":"init(apiClient:)","abstract":"

Initializes a PayPal Native client.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutClient.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutClient(im)tokenizeWithNativeCheckoutRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Native Checkout flow.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutClient.html#/s:29BraintreePayPalNativeCheckout05BTPaycdE6ClientC8tokenizeyAA0fcdE12AccountNonceCAA0fcdE7RequestCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Native Checkout flow.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutClient.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutClient(im)tokenizeWithNativeVaultRequest:completion:":{"name":"tokenize(_:completion:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Native Vault flow.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutClient.html#/s:29BraintreePayPalNativeCheckout05BTPaycdE6ClientC8tokenizeyAA0fcdE12AccountNonceCAA0fcD12VaultRequestCYaKF":{"name":"tokenize(_:)","abstract":"

Tokenize a PayPal request to be used with the PayPal Native Vault flow.

","parent_name":"BTPayPalNativeCheckoutClient"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)email":{"name":"email","abstract":"

Payer’s email address.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)firstName":{"name":"firstName","abstract":"

Payer’s first name.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)lastName":{"name":"lastName","abstract":"

Payer’s last name.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)phone":{"name":"phone","abstract":"

Payer’s phone number.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)billingAddress":{"name":"billingAddress","abstract":"

The billing address.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)shippingAddress":{"name":"shippingAddress","abstract":"

The shipping address.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)clientMetadataID":{"name":"clientMetadataID","abstract":"

Client metadata id associated with this transaction.

","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTPayPalNativeCheckoutAccountNonce.html#/c:@M@BraintreePayPalNativeCheckout@objc(cs)BTPayPalNativeCheckoutAccountNonce(py)payerID":{"name":"payerID","abstract":"

Optional. Payer id associated with this transaction.","parent_name":"BTPayPalNativeCheckoutAccountNonce"},"Classes/BTURLUtils.html#/c:@M@BraintreeCore@objc(cs)BTURLUtils(cm)queryStringWithDictionary:":{"name":"queryString(from:)","abstract":"

Converts a key/value dictionary to a valid query string

","parent_name":"BTURLUtils"},"Classes/BTURLUtils.html#/c:@M@BraintreeCore@objc(cs)BTURLUtils(cm)queryParametersForURL:":{"name":"queryParameters(for:)","abstract":"

Extract query parameters from a URL

","parent_name":"BTURLUtils"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)recipientName":{"name":"recipientName","abstract":"

Optional. Recipient name for shipping address.

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)streetAddress":{"name":"streetAddress","abstract":"

Line 1 of the Address (eg. number, street, etc).

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)extendedAddress":{"name":"extendedAddress","abstract":"

Optional line 2 of the Address (eg. suite, apt #, etc.).

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)locality":{"name":"locality","abstract":"

City name

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)countryCodeAlpha2":{"name":"countryCodeAlpha2","abstract":"

2 letter country code.

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)postalCode":{"name":"postalCode","abstract":"

Zip code or equivalent is usually required for countries that have them.","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(py)region":{"name":"region","abstract":"

Either a two-letter state code (for the US), or an ISO-3166-2 country subdivision code of up to three letters.

","parent_name":"BTPostalAddress"},"Classes/BTPostalAddress.html#/c:@M@BraintreeCore@objc(cs)BTPostalAddress(im)copyWithZone:":{"name":"copy(with:)","parent_name":"BTPostalAddress"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(cpy)sharedParser":{"name":"shared","abstract":"

The singleton instance

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(py)allTypes":{"name":"allTypes","abstract":"

An array of the tokenization types currently registered

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(im)isTypeAvailable:":{"name":"isTypeAvailable(_:)","abstract":"

Indicates whether a tokenization type is currently registered

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(im)registerType:withParsingBlock:":{"name":"registerType(_:withParsingBlock:)","abstract":"

Registers a parsing block for a tokenization type.

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonceParser.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonceParser(im)parseJSON:withParsingBlockForType:":{"name":"parseJSON(_:withParsingBlockForType:)","abstract":"

Parses tokenized payment information that has been serialized to JSON, and returns a BTPaymentMethodNonce object.

","parent_name":"BTPaymentMethodNonceParser"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(py)nonce":{"name":"nonce","abstract":"

The payment method nonce.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(py)type":{"name":"type","abstract":"

The string identifying the type of the payment method.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(py)isDefault":{"name":"isDefault","abstract":"

The boolean indicating whether this is a default payment method.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(im)initWithNonce:":{"name":"init(nonce:)","abstract":"

Initialize a new Payment Method Nonce.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(im)initWithNonce:type:":{"name":"init(nonce:type:)","abstract":"

Initialize a new Payment Method Nonce.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTPaymentMethodNonce.html#/c:@M@BraintreeCore@objc(cs)BTPaymentMethodNonce(im)initWithNonce:type:isDefault:":{"name":"init(nonce:type:isDefault:)","abstract":"

Initialize a new Payment Method Nonce.

","parent_name":"BTPaymentMethodNonce"},"Classes/BTLogLevelDescription.html#/c:@M@BraintreeCore@objc(cs)BTLogLevelDescription(cm)stringFor:":{"name":"string(for:)","parent_name":"BTLogLevelDescription"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)init":{"name":"init()","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)initWithValue:":{"name":"init(value:)","abstract":"

Initialize with a value.

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)initWithData:":{"name":"init(data:)","abstract":"

Initialize with data.

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isString":{"name":"isString","abstract":"

Checks if the BTJSON is a String

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isBool":{"name":"isBool","abstract":"

Checks if the BTJSON is a Bool

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isNumber":{"name":"isNumber","abstract":"

Checks if the BTJSON is a NSNumber

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isArray":{"name":"isArray","abstract":"

Checks if the BTJSON is a [Any]

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isObject":{"name":"isObject","abstract":"

Checks if the BTJSON is a [String: Any]

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isError":{"name":"isError","abstract":"

Checks if the BTJSON is an error.

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isTrue":{"name":"isTrue","abstract":"

Checks if the BTJSON is a value representing true

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isFalse":{"name":"isFalse","abstract":"

Checks if the BTJSON is a value representing false

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(py)isNull":{"name":"isNull","abstract":"

Checks if the BTJSON is a value representing nil

","parent_name":"BTJSON"},"Classes/BTJSON.html#/s:13BraintreeCore6BTJSONCyACSicip":{"name":"subscript(_:)","abstract":"

Indexes into the JSON as if the current value is an object

","parent_name":"BTJSON"},"Classes/BTJSON.html#/s:13BraintreeCore6BTJSONCyACSScip":{"name":"subscript(_:)","abstract":"

Indexes into the JSON as if the current value is an array

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asError":{"name":"asError()","abstract":"

The BTJSON as a NSError.

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asString":{"name":"asString()","abstract":"

The BTJSON as a String

","parent_name":"BTJSON"},"Classes/BTJSON.html#/s:13BraintreeCore6BTJSONC6asBoolSbSgyF":{"name":"asBool()","abstract":"

The BTJSON as a Bool

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asArray":{"name":"asArray()","abstract":"

The BTJSON as a [BTJSON]

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asNumber":{"name":"asNumber()","abstract":"

The BTJSON as a NSNumber

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asURL":{"name":"asURL()","abstract":"

The BTJSON as a URL

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asStringArray":{"name":"asStringArray()","abstract":"

The BTJSON as a [String]

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asDictionary":{"name":"asDictionary()","abstract":"

The BTJSON as a NSDictionary

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asIntegerOrZero":{"name":"asIntegerOrZero()","abstract":"

The BTJSON as a Int

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asEnum:orDefault:":{"name":"asEnum(_:orDefault:)","abstract":"

The BTJSON as an Enum

","parent_name":"BTJSON"},"Classes/BTJSON.html#/c:@M@BraintreeCore@objc(cs)BTJSON(im)asAddress":{"name":"asAddress()","abstract":"

The BTJSON as a BTPostalAddress

","parent_name":"BTJSON"},"Classes/BTConfiguration.html#/c:@M@BraintreeCore@objc(cs)BTConfiguration(py)json":{"name":"json","abstract":"

The merchant account’s configuration as a BTJSON object

","parent_name":"BTConfiguration"},"Classes/BTConfiguration.html#/c:@M@BraintreeCore@objc(cs)BTConfiguration(py)environment":{"name":"environment","abstract":"

The environment (production or sandbox)

","parent_name":"BTConfiguration"},"Classes/BTConfiguration.html#/c:@M@BraintreeCore@objc(cs)BTConfiguration(im)initWithJSON:":{"name":"init(json:)","abstract":"

Used to initialize a BTConfiguration

","parent_name":"BTConfiguration"},"Classes/BTClientToken.html#/c:@M@BraintreeCore@objc(cs)BTClientToken(im)encodeWithCoder:":{"name":"encode(with:)","parent_name":"BTClientToken"},"Classes/BTClientToken.html#/c:@M@BraintreeCore@objc(cs)BTClientToken(im)initWithCoder:":{"name":"init(coder:)","parent_name":"BTClientToken"},"Classes/BTClientToken.html#/c:@M@BraintreeCore@objc(cs)BTClientToken(im)copyWithZone:":{"name":"copy(with:)","parent_name":"BTClientToken"},"Classes/BTClientToken.html#/c:@M@BraintreeCore@objc(cs)BTClientToken(im)isEqual:":{"name":"isEqual(_:)","parent_name":"BTClientToken"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)integration":{"name":"integration","abstract":"

Integration type

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)source":{"name":"source","abstract":"

Integration source

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)sessionID":{"name":"sessionID","abstract":"

Auto-generated UUID

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)integrationString":{"name":"integrationString","abstract":"

String representation of the integration

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)sourceString":{"name":"sourceString","abstract":"

String representation of the source

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(py)parameters":{"name":"parameters","abstract":"

Additional metadata parameters

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(im)init":{"name":"init()","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(im)mutableCopyWithZone:":{"name":"mutableCopy(with:)","abstract":"

Create a copy as BTMutableClientMetadata

","parent_name":"BTClientMetadata"},"Classes/BTClientMetadata.html#/c:@M@BraintreeCore@objc(cs)BTClientMetadata(im)copyWithZone:":{"name":"copy(with:)","abstract":"

Creates a copy of BTClientMetadata

","parent_name":"BTClientMetadata"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)prepaid":{"name":"prepaid","abstract":"

Whether the card is a prepaid card. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)healthcare":{"name":"healthcare","abstract":"

Whether the card is a healthcare card. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)debit":{"name":"debit","abstract":"

Whether the card is a debit card. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)durbinRegulated":{"name":"durbinRegulated","abstract":"

A value indicating whether the issuing bank’s card range is regulated by the Durbin Amendment due to the bank’s assets. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)commercial":{"name":"commercial","abstract":"

Whether the card type is a commercial card and is capable of processing Level 2 transactions. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)payroll":{"name":"payroll","abstract":"

Whether the card is a payroll card. Possible values: Yes/No/Unknown

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)issuingBank":{"name":"issuingBank","abstract":"

The bank that issued the credit card, if available.

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)countryOfIssuance":{"name":"countryOfIssuance","abstract":"

The country that issued the credit card, if available.

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(py)productID":{"name":"productID","abstract":"

The code for the product type of the card (e.g. D (Visa Signature Preferred), G (Visa Business)), if available.

","parent_name":"BTBinData"},"Classes/BTBinData.html#/c:@M@BraintreeCore@objc(cs)BTBinData(im)initWithJSON:":{"name":"init(json:)","abstract":"

Create a BTBinData object from JSON.

","parent_name":"BTBinData"},"Classes/BTAppContextSwitcher.html#/c:@M@BraintreeCore@objc(cs)BTAppContextSwitcher(cpy)sharedInstance":{"name":"sharedInstance","abstract":"

Singleton for shared instance of BTAppContextSwitcher

","parent_name":"BTAppContextSwitcher"},"Classes/BTAppContextSwitcher.html#/c:@M@BraintreeCore@objc(cs)BTAppContextSwitcher(py)returnURLScheme":{"name":"returnURLScheme","abstract":"

The URL scheme to return to this app after switching to another app or opening a SFSafariViewController.","parent_name":"BTAppContextSwitcher"},"Classes/BTAppContextSwitcher.html#/c:@M@BraintreeCore@objc(cs)BTAppContextSwitcher(im)registerAppContextSwitchClient:":{"name":"register(_:)","abstract":"

Registers a class Type that can handle a return from app context switch with a static method.

","parent_name":"BTAppContextSwitcher"},"Classes/BTAPIPinnedCertificates.html#/c:@M@BraintreeCore@objc(cs)BTAPIPinnedCertificates(cm)trustedCertificates":{"name":"trustedCertificates()","parent_name":"BTAPIPinnedCertificates"},"Classes/BTAPIClient.html#/s:13BraintreeCore11BTAPIClientC17RequestCompletiona":{"name":"RequestCompletion","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(py)tokenizationKey":{"name":"tokenizationKey","abstract":"

The tokenization key used to authorize the APIClient

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(py)clientToken":{"name":"clientToken","abstract":"

The client token used to authorize the APIClient

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(py)metadata":{"name":"metadata","abstract":"

Client metadata that is used for tracking the client session

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(im)initWithAuthorization:":{"name":"init(authorization:)","abstract":"

Initialize a new API client.

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(im)fetchOrReturnRemoteConfiguration:":{"name":"fetchOrReturnRemoteConfiguration(_:)","abstract":"

Provides configuration data as a BTJSON object.

","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(im)fetchPaymentMethodNonces:":{"name":"fetchPaymentMethodNonces(_:)","abstract":"

Fetches a customer’s vaulted payment method nonces.","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html#/c:@M@BraintreeCore@objc(cs)BTAPIClient(im)fetchPaymentMethodNonces:completion:":{"name":"fetchPaymentMethodNonces(_:completion:)","abstract":"

Fetches a customer’s vaulted payment method nonces.","parent_name":"BTAPIClient"},"Classes/BTAPIClient.html":{"name":"BTAPIClient","abstract":"

This class acts as the entry point for accessing the Braintree APIs via common HTTP methods performed on API endpoints.

"},"Classes/BTAPIPinnedCertificates.html":{"name":"BTAPIPinnedCertificates","abstract":"

THIS CODE IS GENERATED BY codify_certificates.swift"},"Classes/BTAppContextSwitcher.html":{"name":"BTAppContextSwitcher","abstract":"

Handles return URLs when returning from app context switch and routes the return URL to the correct app context switch client class.

"},"Classes/BTBinData.html":{"name":"BTBinData","abstract":"

Contains the bin data associated with a payment method

"},"Classes/BTClientMetadata.html":{"name":"BTClientMetadata","abstract":"

Represents the metadata associated with a session for posting along with payment data during tokenization.

"},"Classes/BTClientToken.html":{"name":"BTClientToken","abstract":"

An authorization string used to initialize the Braintree SDK

"},"Classes/BTConfiguration.html":{"name":"BTConfiguration","abstract":"

Contains information specific to a merchant’s Braintree integration

"},"Classes/BTJSON.html":{"name":"BTJSON","abstract":"

A type-safe wrapper around JSON"},"Classes/BTLogLevelDescription.html":{"name":"BTLogLevelDescription","abstract":"

Wrapper for accessing the string value of the log level

"},"Classes.html#/c:@M@BraintreeCore@objc(cs)BTMutableClientMetadata":{"name":"BTMutableClientMetadata","abstract":"

Required for Objective-C compatibility. Necessary behavior is provided by the swift version.

"},"Classes/BTPaymentMethodNonce.html":{"name":"BTPaymentMethodNonce","abstract":"

BTPaymentMethodNonce is for generic tokenized payment information.

"},"Classes/BTPaymentMethodNonceParser.html":{"name":"BTPaymentMethodNonceParser","abstract":"

A JSON parser that parses BTJSON into concrete BTPaymentMethodNonce objects. It supports registration of parsers at runtime.

"},"Classes/BTPostalAddress.html":{"name":"BTPostalAddress","abstract":"

Generic postal address

"},"Classes/BTURLUtils.html":{"name":"BTURLUtils","abstract":"

A helper class for converting URL queries to and from dictionaries

"},"Classes/BTPayPalNativeCheckoutAccountNonce.html":{"name":"BTPayPalNativeCheckoutAccountNonce","abstract":"

Contains information about a PayPal payment method.

"},"Classes/BTPayPalNativeCheckoutClient.html":{"name":"BTPayPalNativeCheckoutClient","abstract":"

Client used to collect PayPal payment methods. If possible, this client will present a native flow; otherwise, it will fall back to a web flow.

"},"Classes/BTPayPalNativeCheckoutRequest.html":{"name":"BTPayPalNativeCheckoutRequest","abstract":"

Options for the PayPal Checkout flow.

"},"Classes/BTPayPalNativeVaultRequest.html":{"name":"BTPayPalNativeVaultRequest","abstract":"

Options for the PayPal Vault flow.

"},"Classes/BTSEPADirectDebitClient.html":{"name":"BTSEPADirectDebitClient","abstract":"

Used to integrate with SEPA Direct Debit.

"},"Classes/BTSEPADirectDebitNonce.html":{"name":"BTSEPADirectDebitNonce","abstract":"

A payment method nonce representing a SEPA Direct Debit payment.

"},"Classes/BTSEPADirectDebitRequest.html":{"name":"BTSEPADirectDebitRequest","abstract":"

Parameters for creating a SEPA Direct Debit tokenization request.

"},"Classes/BTAmericanExpressClient.html":{"name":"BTAmericanExpressClient","abstract":"

BTAmericanExpressClient enables you to look up the rewards balance of American Express cards.

"},"Classes/BTAmericanExpressRewardsBalance.html":{"name":"BTAmericanExpressRewardsBalance","abstract":"

Contains information about an American Express rewards balance.

"},"Classes/BTDataCollector.html":{"name":"BTDataCollector","abstract":"

Braintree’s advanced fraud protection solution.

"},"Classes/BTApplePayCardNonce.html":{"name":"BTApplePayCardNonce","abstract":"

Contains information about a tokenized Apple Pay card.

"},"Classes/BTApplePayClient.html":{"name":"BTApplePayClient","abstract":"

Used to process Apple Pay payments

"},"Classes/BTLocalPaymentClient.html":{"name":"BTLocalPaymentClient"},"Classes/BTLocalPaymentRequest.html":{"name":"BTLocalPaymentRequest","abstract":"

Used to initialize a local payment flow

"},"Classes/BTLocalPaymentResult.html":{"name":"BTLocalPaymentResult"},"Classes/BTThreeDSecureAdditionalInformation.html":{"name":"BTThreeDSecureAdditionalInformation","abstract":"

Additional information for a 3DS lookup. Used in 3DS 2.0+ flows.

"},"Classes/BTThreeDSecureClient.html":{"name":"BTThreeDSecureClient"},"Classes/BTThreeDSecureLookup.html":{"name":"BTThreeDSecureLookup","abstract":"

The result of a 3DS lookup."},"Classes/BTThreeDSecurePostalAddress.html":{"name":"BTThreeDSecurePostalAddress","abstract":"

Postal address for 3D Secure flows

"},"Classes/BTThreeDSecureRequest.html":{"name":"BTThreeDSecureRequest","abstract":"

Used to initialize a 3D Secure payment flow

"},"Classes/BTThreeDSecureResult.html":{"name":"BTThreeDSecureResult","abstract":"

The result of a 3D Secure payment flow

"},"Classes/BTThreeDSecureV2BaseCustomization.html":{"name":"BTThreeDSecureV2BaseCustomization","abstract":"

Base customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2ButtonCustomization.html":{"name":"BTThreeDSecureV2ButtonCustomization","abstract":"

Button customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2LabelCustomization.html":{"name":"BTThreeDSecureV2LabelCustomization","abstract":"

Label customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2TextBoxCustomization.html":{"name":"BTThreeDSecureV2TextBoxCustomization","abstract":"

Text box customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2ToolbarCustomization.html":{"name":"BTThreeDSecureV2ToolbarCustomization","abstract":"

Toolbar customization options for 3D Secure 2 flows.

"},"Classes/BTThreeDSecureV2UICustomization.html":{"name":"BTThreeDSecureV2UICustomization","abstract":"

UI customization options for 3D Secure 2 flows.

"},"Classes/BTAuthenticationInsight.html":{"name":"BTAuthenticationInsight","abstract":"

Information pertaining to the regulatory environment for a credit card if authentication insight is requested during tokenization.

"},"Classes/BTCard.html":{"name":"BTCard","abstract":"

The card tokenization request represents raw credit or debit card data provided by the customer."},"Classes/BTCardClient.html":{"name":"BTCardClient","abstract":"

Used to process cards

"},"Classes/BTCardNonce.html":{"name":"BTCardNonce","abstract":"

Contains information about a tokenized card.

"},"Classes/BTCardRequest.html":{"name":"BTCardRequest","abstract":"

Contains information about a card to tokenize

"},"Classes/BTThreeDSecureInfo.html":{"name":"BTThreeDSecureInfo","abstract":"

Contains information about the 3D Secure status of a payment method

"},"Classes/BTPayPalAccountNonce.html":{"name":"BTPayPalAccountNonce","abstract":"

Contains information about a PayPal payment method

"},"Classes/BTPayPalCheckoutRequest.html":{"name":"BTPayPalCheckoutRequest","abstract":"

Options for the PayPal Checkout flow.

"},"Classes/BTPayPalClient.html":{"name":"BTPayPalClient"},"Classes/BTPayPalCreditFinancing.html":{"name":"BTPayPalCreditFinancing","abstract":"

Contains information about a PayPal credit financing option

"},"Classes/BTPayPalCreditFinancingAmount.html":{"name":"BTPayPalCreditFinancingAmount","abstract":"

Contains information about a PayPal credit amount

"},"Classes/BTPayPalLineItem.html":{"name":"BTPayPalLineItem","abstract":"

A PayPal line item to be displayed in the PayPal checkout flow.

"},"Classes/BTPayPalRequest.html":{"name":"BTPayPalRequest","abstract":"

Base options for PayPal Checkout and PayPal Vault flows.

"},"Classes/BTPayPalVaultRequest.html":{"name":"BTPayPalVaultRequest","abstract":"

Options for the PayPal Vault flow.

"},"Classes/BTVenmoAccountNonce.html":{"name":"BTVenmoAccountNonce","abstract":"

Contains information about a Venmo Account payment method

"},"Classes/BTVenmoClient.html":{"name":"BTVenmoClient","abstract":"

Used to process Venmo payments

"},"Classes/BTVenmoRequest.html":{"name":"BTVenmoRequest","abstract":"

A BTVenmoRequest specifies options that contribute to the Venmo flow

"},"Classes.html":{"name":"Classes","abstract":"

The following classes are available globally.

"},"Enums.html":{"name":"Enumerations","abstract":"

The following enumerations are available globally.

"},"Extensions.html":{"name":"Extensions","abstract":"

The following extensions are available globally.

"},"Protocols.html":{"name":"Protocols","abstract":"

The following protocols are available globally.

"}} \ No newline at end of file diff --git a/6.0.0-beta4/undocumented.json b/6.0.0-beta4/undocumented.json new file mode 100644 index 0000000000..929858ab22 --- /dev/null +++ b/6.0.0-beta4/undocumented.json @@ -0,0 +1,6 @@ +{ + "warnings": [ + + ], + "source_directory": "/Users/scannillo/bt/braintree_ios" +} \ No newline at end of file diff --git a/current b/current index 8776aa28f4..efe67c02e6 120000 --- a/current +++ b/current @@ -1 +1 @@ -6.0.0-beta3 \ No newline at end of file +6.0.0-beta4 \ No newline at end of file