Enumerations
The following enumerations are available globally.
-
An enumeration of all potential API status calls returned when returned in body
See moreDeclaration
Swift
enum APICallStatus
extension APICallStatus : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
An enumeration containing the accessibility identifiers for the UI elements of the SDK. This enum is a safe way to identify elements without relying on literal strings.
See moreDeclaration
Swift
enum AccessibilityIdentifier
extension AccessibilityIdentifier : Equatable, Hashable, RawRepresentable
-
An enumeration of types that an Address can be
See moreDeclaration
Swift
enum AddressType
extension AddressType : Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
An enumeration object that indicates whether an address is valid or not.
See moreDeclaration
Swift
enum AddressValidationResult
-
This is the main point of entry for analytics, as it keeps track of things And wrappers around the actual calls. For further wrapping, see TrackApp and TrackUser
Declaration
Swift
enum Analytics
-
The intent of an order.
authorize
: The merchant intends to authorize a payment and place funds on hold after the customer makes a payment.capture
: The merchant intends to capture payment immediately after the customer makes a payment.order
: The merchant intends to save an order, then authorize to place funds on hold after the customer makes a payment.
Intent enum documentation guide
See moreDeclaration
Swift
@objc(PPCApprovalOrderIntent) enum ApprovalOrderIntent
extension ApprovalOrderIntent : Equatable, Hashable, RawRepresentable
-
Custom Background Configuration for first party consumers.
See moreDeclaration
Swift
enum BackgroundConfig
extension BackgroundConfig : Comparable, Equatable
-
An enumeration of bank types that a bank account can identify with Reference: https://ppaas/api/3719176155268854#apiReference
See moreDeclaration
Swift
enum BankAccountType
extension BankAccountType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
Enumeration to identify different billing types
See moreDeclaration
Swift
enum BillingType
extension BillingType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
An enum to represent the keys for the additional button states other than primary
See moreDeclaration
Swift
enum ButtonStateKey
extension ButtonStateKey : Equatable, Hashable
-
An enumeration of credit card issuers that a card can have. VISA, MASTER_CARD, AMEX, etc
See moreDeclaration
Swift
enum CardIssuer
extension CardIssuer : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
Information about the channel used to start the checkout flow
See moreDeclaration
Swift
@objc(PPCChannel) enum Channel
extension Channel : CaseIterable, CustomStringConvertible, Equatable, Hashable, RawRepresentable
-
The type of a checkout session
See moreDeclaration
Swift
enum CheckoutSessionType
extension CheckoutSessionType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
The state of a checkout session
See moreDeclaration
Swift
enum CheckoutState
extension CheckoutState : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
The ColorType enum allows methods that configure the various default components such as labels and the like throughout the codebase to easily reference groupings of colors for foregrounds and background.
See moreDeclaration
Swift
enum ColorType
extension ColorType : Equatable, Hashable
-
ContentLayout enums are designed to describe how to handle a ContentPage’s header and footer views but may be reused in other places. The default is always vertically stacked but other layouts might make sense from time to time.
See moreDeclaration
Swift
enum ContentLayout
-
Undocumented
See moreDeclaration
Swift
enum ContentSection
extension ContentSection : Equatable, Hashable, Identifiable, RawRepresentable
-
An enumeration for Credit offer presentation types
See moreDeclaration
Swift
enum CreditOfferType
extension CreditOfferType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
An enum of the possible values to be passed as the curency code. Currency code enum documentation guide
See moreDeclaration
Swift
@objc(PPCCurrencyCode) enum CurrencyCode
extension CurrencyCode : CaseIterable, Equatable, Hashable, RawRepresentable
-
The currency conversion type to use
See moreDeclaration
Swift
enum CurrencyConversionType
extension CurrencyConversionType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
Used to determine which endpoints to target for interactions with the PayPal API.
See moreDeclaration
Swift
@objc(PPCEnvironment) enum Environment
extension Environment : CaseIterable, Equatable, Hashable, RawRepresentable
-
When events are fired, their payloads are captured. When an event type is listened to, previous events can be replayed such that if data recently came in before the listener was added. In such cases the code adding the listener can opt to replay previous events.
See moreDeclaration
Swift
enum EventPlayback
extension EventPlayback : CaseIterable, Equatable, Hashable
-
As new event types are identified, a new enum case should be defined here so that it can be listened to and fired.
See moreDeclaration
Swift
enum EventType
extension EventType : CaseIterable, CustomStringConvertible, Equatable, Hashable, RawRepresentable
-
As new event types are identified, a new enum case should be defined here so that it can be listened to and fired.
See moreDeclaration
Swift
enum EventTypeData
-
FPTI can be used to track many different event types based on user actions.
See moreDeclaration
Swift
enum FPTIEventType
-
When we need to fallback, there can be several cases. All of these fallback scenarios were imported from Android
See moreDeclaration
Swift
enum FallbackType
extension FallbackType : Equatable, Hashable, RawRepresentable
-
A funding instrument’s method type
See moreDeclaration
Swift
enum FundingInstrumentMethodType
extension FundingInstrumentMethodType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
A funding instrument’s sub type
See moreDeclaration
Swift
enum FundingInstrumentSubType
extension FundingInstrumentSubType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
The funding instrument type to use
See moreDeclaration
Swift
enum FundingInstrumentType
extension FundingInstrumentType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
Undocumented
See moreDeclaration
Swift
enum FundingProvider
extension FundingProvider : Equatable, Hashable, RawRepresentable
-
An enumeration of types that HTTPMethod can have. GET, POST, PUT, DELETE, etc.
See moreDeclaration
Swift
enum HTTPMethod
extension HTTPMethod : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
A quick enum that indicates state when a height change has occurred.
See moreDeclaration
Swift
enum HeightChange
extension HeightChange : Equatable, Hashable
-
A 1:1 mapping to extracted and translated
Strings
. Open questions here are what happens when the user changes languages mid usage.To do
Check to see what happens when language changes midstreamDeclaration
Swift
enum I18n
-
Currently we are mimicking the five most common log levels seen in work environments. The LogLevel defines different hierarchical categories that we can use to filter some of the output
See moreDeclaration
Swift
enum LogLevel
extension LogLevel : Equatable, Hashable, RawRepresentable
-
Undocumented
See moreDeclaration
Swift
enum NetworkActionType
extension NetworkActionType : CaseIterable, Equatable, Hashable
-
Right now NetworkInput input can come in two non-customized types; either mapped data, think Dictionaries, or ordered data, think Arrays. This enum type specifies whether the input is in a known expected format or whether or not it is set to unknown.
See moreDeclaration
Swift
enum NetworkInputType
extension NetworkInputType : Equatable, Hashable
-
Enum describing the various states a NetworkOperation can be in
See moreDeclaration
Swift
enum NetworkStatus
extension NetworkStatus : Equatable, Hashable
-
An enum that describes whether a network is synchronous or asynchronous
See moreDeclaration
Swift
enum NetworkSynchronicity
extension NetworkSynchronicity : Equatable, Hashable
-
An enum of the possible values to be passed as the intent of an order. Possible vales are:
See moreauthorize
andcapture
Intent enum documentation guideDeclaration
Swift
@objc(PPCOrderIntent) enum OrderIntent
extension OrderIntent : Equatable, Hashable, RawRepresentable
-
The Smart Payment Button type, this will adjust our images, colors, sizes, etc.
See moreDeclaration
Swift
@objc(PPCPaymentButtonColor) enum PaymentButtonColor
extension PaymentButtonColor : CaseIterable, CustomStringConvertible, Equatable, Hashable, RawRepresentable
-
Edges for the Smart Payment Button, these affect the corner radius.
See moreDeclaration
Swift
@objc(PPCPaymentButtonEdges) enum PaymentButtonEdges
extension PaymentButtonEdges : CaseIterable, CustomStringConvertible, Equatable, Hashable, RawRepresentable
-
Status of PaymentButton’s eligibility
See moreDeclaration
Swift
@objc(PPCPaymentButtonEligibilityStatus) enum PaymentButtonEligibilityStatus
extension PaymentButtonEligibilityStatus : Equatable, Hashable, RawRepresentable
-
The funding source to be used when checkout with PaymentButton
See moreDeclaration
Swift
@objc(PPCPaymentButtonFundingSource) enum PaymentButtonFundingSource
extension PaymentButtonFundingSource : CaseIterable, CustomStringConvertible, Equatable, Hashable, RawRepresentable
-
The label displayed next to PaymentButton’s logo.
See moreDeclaration
Swift
@objc(PPCPaymentButtonLabel) enum PaymentButtonLabel
extension PaymentButtonLabel : Equatable, Hashable, RawRepresentable
-
The size category which determines how the button is shown.
See moreDeclaration
Swift
@objc(PPCPaymentButtonSize) enum PaymentButtonSize
extension PaymentButtonSize : CaseIterable, CustomStringConvertible, Equatable, Hashable, RawRepresentable
-
Presentation mode defines how pay sheet will be presented in the host app
See moreDeclaration
Swift
enum PresentationMode
extension PresentationMode : Equatable, Hashable
-
An enum representing priority for a listener
See moreDeclaration
Swift
enum Priority
extension Priority : Comparable, Equatable, Hashable, RawRepresentable
-
An enum of the possible values to be passed as the instruction to process an order. Possible vales are:
See moreORDER_SAVED_EXPLICITLY
,ORDER_SAVED_ON_BUYER_APPROVAL
,ORDER_COMPLETE_ON_PAYMENT_APPROVAL
,NO_INSTRUCTION
Processing instruction enum documentation guideDeclaration
Swift
@objc(PPCOrderProcessingInstruction) enum ProcessingInstruction
extension ProcessingInstruction : Equatable, Hashable, RawRepresentable
-
The Errors associated with a request
See moreDeclaration
Swift
enum RequestError
extension RequestError : Error, LocalizedError, Sendable
-
Response to request to resolve contingencies that a 1st or 2nd party consumer sends back to our SDK.
See moreDeclaration
Swift
enum ResolveContingenciesResponse
-
Used to identify if a certain
See moreTextInput
just became or resigned first responder.Declaration
Swift
enum ResponderStatus
extension ResponderStatus : Equatable, Hashable
-
Container type for all UI that is shared between different content pages
Declaration
Swift
enum SharedUI
-
This class is responsible for letting our SDK know about the state of shipping changes.
See moreDeclaration
Swift
@objc(PPCShippingChangeState) enum ShippingChangeState
extension ShippingChangeState : Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
The type of shipping change.
See moreDeclaration
Swift
@objc(PPCShippingChangeType) enum ShippingChangeType
extension ShippingChangeType : Equatable, Hashable, RawRepresentable
-
The method by which the payer wants to get their items.
See moreDeclaration
Swift
@objc(PPCShippingType) enum ShippingType
extension ShippingType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
Determine the state of shutdown
See moreDeclaration
Swift
enum ShutdownState
extension ShutdownState : Equatable
-
The state of the
See moreTextInput
view.Declaration
Swift
enum TextInputState
extension TextInputState : Equatable, Hashable
-
Describes the context associated with a 3DS resolution flow
See moreDeclaration
Swift
enum ThreeDSContext
extension ThreeDSContext : Equatable, Hashable
-
Undocumented
See moreDeclaration
Swift
enum ThreeDSContingencyReasonType
extension ThreeDSContingencyReasonType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
Undocumented
See moreDeclaration
Swift
enum ThreeDSContingencySourceType
extension ThreeDSContingencySourceType : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
List of supported experiences for 3DS verification
See moreDeclaration
Swift
enum ThreeDSPaymentExperience
extension ThreeDSPaymentExperience : CaseIterable, Decodable, Encodable, Equatable, Hashable, RawRepresentable
-
Provides a standardized way to define transitions via a static instantiation.
See moreDeclaration
Swift
enum Transition
-
Undocumented
See moreDeclaration
Swift
@objc(PPCUserAction) enum UserAction
extension UserAction : Equatable, Hashable, RawRepresentable
-
We build URLs for each route
See moreDeclaration
Swift
enum WebRoute
extension WebRoute : CustomStringConvertible