paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/apple_pay_card_response.rb

@@ -0,0 +1,167 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The Card from Apple Pay Wallet used to fund the payment.
+  class ApplePayCardResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The last digits of the payment card.
+    # @return [String]
+    attr_accessor :last_digits
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :brand
+
+    # Array of brands or networks associated with the card.
+    # @return [Array[CardBrand]]
+    attr_accessor :available_networks
+
+    # Type of card. i.e Credit, Debit and so on.
+    # @return [CardType]
+    attr_accessor :type
+
+    # Results of Authentication such as 3D Secure.
+    # @return [AuthenticationResponse]
+    attr_accessor :authentication_result
+
+    # Additional attributes associated with the use of this card.
+    # @return [CardAttributesResponse]
+    attr_accessor :attributes
+
+    # Representation of card details as received in the request.
+    # @return [CardFromRequest]
+    attr_accessor :from_request
+
+    # The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date
+    # and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
+    # @return [String]
+    attr_accessor :expiry
+
+    # Bank Identification Number (BIN) details used to fund a payment.
+    # @return [BinDetails]
+    attr_accessor :bin_details
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :billing_address
+
+    # The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/)
+    # that identifies the country or region.<blockquote><strong>Note:</strong>
+    # The country code for Great Britain is <code>GB</code> and not
+    # <code>UK</code> as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.</blockquote>
+    # @return [String]
+    attr_accessor :country_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['last_digits'] = 'last_digits'
+      @_hash['brand'] = 'brand'
+      @_hash['available_networks'] = 'available_networks'
+      @_hash['type'] = 'type'
+      @_hash['authentication_result'] = 'authentication_result'
+      @_hash['attributes'] = 'attributes'
+      @_hash['from_request'] = 'from_request'
+      @_hash['expiry'] = 'expiry'
+      @_hash['bin_details'] = 'bin_details'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['country_code'] = 'country_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        last_digits
+        brand
+        available_networks
+        type
+        authentication_result
+        attributes
+        from_request
+        expiry
+        bin_details
+        billing_address
+        country_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, last_digits: SKIP, brand: SKIP,
+                   available_networks: SKIP, type: SKIP,
+                   authentication_result: SKIP, attributes: SKIP,
+                   from_request: SKIP, expiry: SKIP, bin_details: SKIP,
+                   billing_address: SKIP, country_code: SKIP)
+      @name = name unless name == SKIP
+      @last_digits = last_digits unless last_digits == SKIP
+      @brand = brand unless brand == SKIP
+      @available_networks = available_networks unless available_networks == SKIP
+      @type = type unless type == SKIP
+      @authentication_result = authentication_result unless authentication_result == SKIP
+      @attributes = attributes unless attributes == SKIP
+      @from_request = from_request unless from_request == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @bin_details = bin_details unless bin_details == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @country_code = country_code unless country_code == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      last_digits = hash.key?('last_digits') ? hash['last_digits'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      available_networks =
+        hash.key?('available_networks') ? hash['available_networks'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      authentication_result = AuthenticationResponse.from_hash(hash['authentication_result']) if
+        hash['authentication_result']
+      attributes = CardAttributesResponse.from_hash(hash['attributes']) if hash['attributes']
+      from_request = CardFromRequest.from_hash(hash['from_request']) if hash['from_request']
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      bin_details = BinDetails.from_hash(hash['bin_details']) if hash['bin_details']
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+
+      # Create object from extracted values.
+      ApplePayCardResponse.new(name: name,
+                               last_digits: last_digits,
+                               brand: brand,
+                               available_networks: available_networks,
+                               type: type,
+                               authentication_result: authentication_result,
+                               attributes: attributes,
+                               from_request: from_request,
+                               expiry: expiry,
+                               bin_details: bin_details,
+                               billing_address: billing_address,
+                               country_code: country_code)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_decrypted_token_data.rb

@@ -0,0 +1,95 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information about the Payment data obtained by decrypting Apple Pay token.
+  class ApplePayDecryptedTokenData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :transaction_amount
+
+    # The payment card to use to fund a payment. Can be a credit or debit card.
+    # @return [ApplePayTokenizedCard]
+    attr_accessor :tokenized_card
+
+    # Apple Pay Hex-encoded device manufacturer identifier. The pattern is
+    # defined by an external party and supports Unicode.
+    # @return [String]
+    attr_accessor :device_manufacturer_id
+
+    # Indicates the type of payment data passed, in case of Non China the
+    # payment data is 3DSECURE and for China it is EMV.
+    # @return [ApplePayPaymentDataType]
+    attr_accessor :payment_data_type
+
+    # Information about the decrypted apple pay payment data for the token like
+    # cryptogram, eci indicator.
+    # @return [ApplePayPaymentData]
+    attr_accessor :payment_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_amount'] = 'transaction_amount'
+      @_hash['tokenized_card'] = 'tokenized_card'
+      @_hash['device_manufacturer_id'] = 'device_manufacturer_id'
+      @_hash['payment_data_type'] = 'payment_data_type'
+      @_hash['payment_data'] = 'payment_data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_amount
+        device_manufacturer_id
+        payment_data_type
+        payment_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tokenized_card:, transaction_amount: SKIP,
+                   device_manufacturer_id: SKIP, payment_data_type: SKIP,
+                   payment_data: SKIP)
+      @transaction_amount = transaction_amount unless transaction_amount == SKIP
+      @tokenized_card = tokenized_card
+      @device_manufacturer_id = device_manufacturer_id unless device_manufacturer_id == SKIP
+      @payment_data_type = payment_data_type unless payment_data_type == SKIP
+      @payment_data = payment_data unless payment_data == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      tokenized_card = ApplePayTokenizedCard.from_hash(hash['tokenized_card']) if
+        hash['tokenized_card']
+      transaction_amount = Money.from_hash(hash['transaction_amount']) if
+        hash['transaction_amount']
+      device_manufacturer_id =
+        hash.key?('device_manufacturer_id') ? hash['device_manufacturer_id'] : SKIP
+      payment_data_type =
+        hash.key?('payment_data_type') ? hash['payment_data_type'] : SKIP
+      payment_data = ApplePayPaymentData.from_hash(hash['payment_data']) if hash['payment_data']
+
+      # Create object from extracted values.
+      ApplePayDecryptedTokenData.new(tokenized_card: tokenized_card,
+                                     transaction_amount: transaction_amount,
+                                     device_manufacturer_id: device_manufacturer_id,
+                                     payment_data_type: payment_data_type,
+                                     payment_data: payment_data)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_payment_data.rb

@@ -0,0 +1,83 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information about the decrypted apple pay payment data for the token like
+  # cryptogram, eci indicator.
+  class ApplePayPaymentData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Online payment cryptogram, as defined by 3D Secure. The pattern is defined
+    # by an external party and supports Unicode.
+    # @return [String]
+    attr_accessor :cryptogram
+
+    # ECI indicator, as defined by 3- Secure. The pattern is defined by an
+    # external party and supports Unicode.
+    # @return [String]
+    attr_accessor :eci_indicator
+
+    # Encoded Apple Pay EMV Payment Structure used for payments in China. The
+    # pattern is defined by an external party and supports Unicode.
+    # @return [String]
+    attr_accessor :emv_data
+
+    # Bank Key encrypted Apple Pay PIN. The pattern is defined by an external
+    # party and supports Unicode.
+    # @return [String]
+    attr_accessor :pin
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cryptogram'] = 'cryptogram'
+      @_hash['eci_indicator'] = 'eci_indicator'
+      @_hash['emv_data'] = 'emv_data'
+      @_hash['pin'] = 'pin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cryptogram
+        eci_indicator
+        emv_data
+        pin
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cryptogram: SKIP, eci_indicator: SKIP, emv_data: SKIP,
+                   pin: SKIP)
+      @cryptogram = cryptogram unless cryptogram == SKIP
+      @eci_indicator = eci_indicator unless eci_indicator == SKIP
+      @emv_data = emv_data unless emv_data == SKIP
+      @pin = pin unless pin == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      cryptogram = hash.key?('cryptogram') ? hash['cryptogram'] : SKIP
+      eci_indicator = hash.key?('eci_indicator') ? hash['eci_indicator'] : SKIP
+      emv_data = hash.key?('emv_data') ? hash['emv_data'] : SKIP
+      pin = hash.key?('pin') ? hash['pin'] : SKIP
+
+      # Create object from extracted values.
+      ApplePayPaymentData.new(cryptogram: cryptogram,
+                              eci_indicator: eci_indicator,
+                              emv_data: emv_data,
+                              pin: pin)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_payment_data_type.rb

@@ -0,0 +1,24 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Indicates the type of payment data passed, in case of Non China the payment
+  # data is 3DSECURE and for China it is EMV.
+  class ApplePayPaymentDataType
+    APPLE_PAY_PAYMENT_DATA_TYPE = [
+      # TODO: Write general description for ENUM_3DSECURE
+      ENUM_3DSECURE = '3DSECURE'.freeze,
+
+      # TODO: Write general description for EMV
+      EMV = 'EMV'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_payment_object.rb

@@ -0,0 +1,114 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using ApplePay.
+  class ApplePayPaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ApplePay transaction identifier, this will be the unique identifier for
+    # this transaction provided by Apple. The pattern is defined by an external
+    # party and supports Unicode.
+    # @return [String]
+    attr_accessor :id
+
+    # Encrypted ApplePay token, containing card information. This token would be
+    # base64encoded. The pattern is defined by an external party and supports
+    # Unicode.
+    # @return [String]
+    attr_accessor :token
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The internationalized email address.<blockquote><strong>Note:</strong> Up
+    # to 64 characters are allowed before and 255 characters are allowed after
+    # the <code>@</code> sign. However, the generally accepted maximum length
+    # for an email address is 254 characters. The pattern verifies that an
+    # unquoted <code>@</code> sign exists.</blockquote>
+    # @return [String]
+    attr_accessor :email_address
+
+    # The phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumber]
+    attr_accessor :phone_number
+
+    # The Card from Apple Pay Wallet used to fund the payment.
+    # @return [ApplePayCardResponse]
+    attr_accessor :card
+
+    # Additional attributes associated with the use of Apple Pay.
+    # @return [ApplePayAttributesResponse]
+    attr_accessor :attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['token'] = 'token'
+      @_hash['name'] = 'name'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['card'] = 'card'
+      @_hash['attributes'] = 'attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        token
+        name
+        email_address
+        phone_number
+        card
+        attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, token: SKIP, name: SKIP, email_address: SKIP,
+                   phone_number: SKIP, card: SKIP, attributes: SKIP)
+      @id = id unless id == SKIP
+      @token = token unless token == SKIP
+      @name = name unless name == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @card = card unless card == SKIP
+      @attributes = attributes unless attributes == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      token = hash.key?('token') ? hash['token'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone_number = PhoneNumber.from_hash(hash['phone_number']) if hash['phone_number']
+      card = ApplePayCardResponse.from_hash(hash['card']) if hash['card']
+      attributes = ApplePayAttributesResponse.from_hash(hash['attributes']) if hash['attributes']
+
+      # Create object from extracted values.
+      ApplePayPaymentObject.new(id: id,
+                                token: token,
+                                name: name,
+                                email_address: email_address,
+                                phone_number: phone_number,
+                                card: card,
+                                attributes: attributes)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_payment_token.rb

@@ -0,0 +1,51 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # A resource representing a response for Apple Pay.
+  class ApplePayPaymentToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment card to be used to fund a payment. Can be a credit or debit
+    # card.
+    # @return [ApplePayCard]
+    attr_accessor :card
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP)
+      @card = card unless card == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      card = ApplePayCard.from_hash(hash['card']) if hash['card']
+
+      # Create object from extracted values.
+      ApplePayPaymentToken.new(card: card)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/apple_pay_request.rb

@@ -0,0 +1,137 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using ApplePay.
+  class ApplePayRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ApplePay transaction identifier, this will be the unique identifier for
+    # this transaction provided by Apple. The pattern is defined by an external
+    # party and supports Unicode.
+    # @return [String]
+    attr_accessor :id
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The internationalized email address.<blockquote><strong>Note:</strong> Up
+    # to 64 characters are allowed before and 255 characters are allowed after
+    # the <code>@</code> sign. However, the generally accepted maximum length
+    # for an email address is 254 characters. The pattern verifies that an
+    # unquoted <code>@</code> sign exists.</blockquote>
+    # @return [String]
+    attr_accessor :email_address
+
+    # The phone number in its canonical international [E.164 numbering plan
+    # format](https://www.itu.int/rec/T-REC-E.164/en).
+    # @return [PhoneNumber]
+    attr_accessor :phone_number
+
+    # Information about the Payment data obtained by decrypting Apple Pay token.
+    # @return [ApplePayDecryptedTokenData]
+    attr_accessor :decrypted_token
+
+    # Provides additional details to process a payment using a `card` that has
+    # been stored or is intended to be stored (also referred to as
+    # stored_credential or card-on-file).<br/>Parameter
+    # compatibility:<br/><ul><li>`payment_type=ONE_TIME` is compatible only with
+    # `payment_initiator=CUSTOMER`.</li><li>`usage=FIRST` is compatible only
+    # with
+    # `payment_initiator=CUSTOMER`.</li><li>`previous_transaction_reference` or
+    # `previous_network_transaction_reference` is compatible only with
+    # `payment_initiator=MERCHANT`.</li><li>Only one of the parameters -
+    # `previous_transaction_reference` and
+    # `previous_network_transaction_reference` - can be present in the
+    # request.</li></ul>
+    # @return [CardStoredCredential]
+    attr_accessor :stored_credential
+
+    # The PayPal-generated ID for the vaulted payment source. This ID should be
+    # stored on the merchant's server so the saved payment source can be used
+    # for future transactions.
+    # @return [String]
+    attr_accessor :vault_id
+
+    # Additional attributes associated with apple pay.
+    # @return [ApplePayAttributes]
+    attr_accessor :attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['email_address'] = 'email_address'
+      @_hash['phone_number'] = 'phone_number'
+      @_hash['decrypted_token'] = 'decrypted_token'
+      @_hash['stored_credential'] = 'stored_credential'
+      @_hash['vault_id'] = 'vault_id'
+      @_hash['attributes'] = 'attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        email_address
+        phone_number
+        decrypted_token
+        stored_credential
+        vault_id
+        attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, name: SKIP, email_address: SKIP,
+                   phone_number: SKIP, decrypted_token: SKIP,
+                   stored_credential: SKIP, vault_id: SKIP, attributes: SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @email_address = email_address unless email_address == SKIP
+      @phone_number = phone_number unless phone_number == SKIP
+      @decrypted_token = decrypted_token unless decrypted_token == SKIP
+      @stored_credential = stored_credential unless stored_credential == SKIP
+      @vault_id = vault_id unless vault_id == SKIP
+      @attributes = attributes unless attributes == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      phone_number = PhoneNumber.from_hash(hash['phone_number']) if hash['phone_number']
+      decrypted_token = ApplePayDecryptedTokenData.from_hash(hash['decrypted_token']) if
+        hash['decrypted_token']
+      stored_credential = CardStoredCredential.from_hash(hash['stored_credential']) if
+        hash['stored_credential']
+      vault_id = hash.key?('vault_id') ? hash['vault_id'] : SKIP
+      attributes = ApplePayAttributes.from_hash(hash['attributes']) if hash['attributes']
+
+      # Create object from extracted values.
+      ApplePayRequest.new(id: id,
+                          name: name,
+                          email_address: email_address,
+                          phone_number: phone_number,
+                          decrypted_token: decrypted_token,
+                          stored_credential: stored_credential,
+                          vault_id: vault_id,
+                          attributes: attributes)
+    end
+  end
+end