paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/card_stored_credential.rb

@@ -0,0 +1,95 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # 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>
+  class CardStoredCredential < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The person or party who initiated or triggered the payment.
+    # @return [PaymentInitiator]
+    attr_accessor :payment_initiator
+
+    # Indicates the type of the stored payment_source payment.
+    # @return [StoredPaymentSourcePaymentType]
+    attr_accessor :payment_type
+
+    # Indicates if this is a `first` or `subsequent` payment using a stored
+    # payment source (also referred to as stored credential or card on file).
+    # @return [StoredPaymentSourceUsageType]
+    attr_accessor :usage
+
+    # Reference values used by the card network to identify a transaction.
+    # @return [NetworkTransactionReference]
+    attr_accessor :previous_network_transaction_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_initiator'] = 'payment_initiator'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['usage'] = 'usage'
+      @_hash['previous_network_transaction_reference'] =
+        'previous_network_transaction_reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        usage
+        previous_network_transaction_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_initiator:, payment_type:,
+                   usage: StoredPaymentSourceUsageType::DERIVED,
+                   previous_network_transaction_reference: SKIP)
+      @payment_initiator = payment_initiator
+      @payment_type = payment_type
+      @usage = usage unless usage == SKIP
+      unless previous_network_transaction_reference == SKIP
+        @previous_network_transaction_reference =
+          previous_network_transaction_reference
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment_initiator =
+        hash.key?('payment_initiator') ? hash['payment_initiator'] : nil
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : nil
+      usage = hash['usage'] ||= StoredPaymentSourceUsageType::DERIVED
+      if hash['previous_network_transaction_reference']
+        previous_network_transaction_reference = NetworkTransactionReference.from_hash(hash['previous_network_transaction_reference'])
+      end
+
+      # Create object from extracted values.
+      CardStoredCredential.new(payment_initiator: payment_initiator,
+                               payment_type: payment_type,
+                               usage: usage,
+                               previous_network_transaction_reference: previous_network_transaction_reference)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_supplementary_data.rb

@@ -0,0 +1,71 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Merchants and partners can add Level 2 and 3 data to payments to reduce risk
+  # and payment processing costs. For more information about processing
+  # payments, see <a
+  # href="https://developer.paypal.com/docs/checkout/advanced/processing/">check
+  # out</a> or <a
+  # href="https://developer.paypal.com/docs/multiparty/checkout/advanced/process
+  # ing/">multiparty checkout</a>.
+  class CardSupplementaryData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The level 2 card processing data collections. If your merchant account has
+    # been configured for Level 2 processing this field will be passed to the
+    # processor on your behalf. Please contact your PayPal Technical Account
+    # Manager to define level 2 data for your business.
+    # @return [Level2CardProcessingData]
+    attr_accessor :level_2
+
+    # The level 3 card processing data collections, If your merchant account has
+    # been configured for Level 3 processing this field will be passed to the
+    # processor on your behalf. Please contact your PayPal Technical Account
+    # Manager to define level 3 data for your business.
+    # @return [Level3CardProcessingData]
+    attr_accessor :level_3
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['level_2'] = 'level_2'
+      @_hash['level_3'] = 'level_3'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        level_2
+        level_3
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(level_2: SKIP, level_3: SKIP)
+      @level_2 = level_2 unless level_2 == SKIP
+      @level_3 = level_3 unless level_3 == 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.
+      level_2 = Level2CardProcessingData.from_hash(hash['level_2']) if hash['level_2']
+      level_3 = Level3CardProcessingData.from_hash(hash['level_3']) if hash['level_3']
+
+      # Create object from extracted values.
+      CardSupplementaryData.new(level_2: level_2,
+                                level_3: level_3)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_type.rb

@@ -0,0 +1,32 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Type of card. i.e Credit, Debit and so on.
+  class CardType
+    CARD_TYPE = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'CREDIT'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'DEBIT'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'PREPAID'.freeze,
+
+      # TODO: Write general description for STORE
+      STORE = 'STORE'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_vault_response.rb

@@ -0,0 +1,86 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a saved Card payment source.
+  class CardVaultResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal-generated ID for the saved payment source.
+    # @return [String]
+    attr_accessor :id
+
+    # The vault status.
+    # @return [VaultStatus]
+    attr_accessor :status
+
+    # An array of request-related HATEOAS links.
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # The details about a customer in PayPal's system of record.
+    # @return [CardCustomerInformation]
+    attr_accessor :customer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['links'] = 'links'
+      @_hash['customer'] = 'customer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        status
+        links
+        customer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, status: SKIP, links: SKIP, customer: SKIP)
+      @id = id unless id == SKIP
+      @status = status unless status == SKIP
+      @links = links unless links == SKIP
+      @customer = customer unless customer == 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
+      status = hash.key?('status') ? hash['status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (LinkDescription.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      customer = CardCustomerInformation.from_hash(hash['customer']) if hash['customer']
+
+      # Create object from extracted values.
+      CardVaultResponse.new(id: id,
+                            status: status,
+                            links: links,
+                            customer: customer)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_verification.rb

@@ -0,0 +1,51 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The API caller can opt in to verify the card through PayPal offered
+  # verification services (e.g. Smart Dollar Auth, 3DS).
+  class CardVerification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The method used for card verification.
+    # @return [CardVerificationMethod]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(method: CardVerificationMethod::SCA_WHEN_REQUIRED)
+      @method = method unless method == 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.
+      method = hash['method'] ||= CardVerificationMethod::SCA_WHEN_REQUIRED
+
+      # Create object from extracted values.
+      CardVerification.new(method: method)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_verification_details.rb

@@ -0,0 +1,111 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Card Verification details including the authorization details and 3D SECURE
+  # details.
+  class CardVerificationDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction Identifier as given by the network to indicate a previously
+    # executed CIT authorization. Only present when authorization is successful
+    # for a verification.
+    # @return [String]
+    attr_accessor :network_transaction_id
+
+    # The date that the transaction was authorized by the scheme. This field may
+    # not be returned for all networks. MasterCard refers to this field as
+    # "BankNet reference date".
+    # @return [String]
+    attr_accessor :date
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :network
+
+    # The date and time, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are
+    # required while fractional seconds are
+    # optional.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @return [String]
+    attr_accessor :time
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # The processor response information for payment requests, such as direct
+    # credit card transactions.
+    # @return [CardVerificationProcessorResponse]
+    attr_accessor :processor_response
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['network_transaction_id'] = 'network_transaction_id'
+      @_hash['date'] = 'date'
+      @_hash['network'] = 'network'
+      @_hash['time'] = 'time'
+      @_hash['amount'] = 'amount'
+      @_hash['processor_response'] = 'processor_response'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        network_transaction_id
+        date
+        network
+        time
+        amount
+        processor_response
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(network_transaction_id: SKIP, date: SKIP, network: SKIP,
+                   time: SKIP, amount: SKIP, processor_response: SKIP)
+      @network_transaction_id = network_transaction_id unless network_transaction_id == SKIP
+      @date = date unless date == SKIP
+      @network = network unless network == SKIP
+      @time = time unless time == SKIP
+      @amount = amount unless amount == SKIP
+      @processor_response = processor_response unless processor_response == 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.
+      network_transaction_id =
+        hash.key?('network_transaction_id') ? hash['network_transaction_id'] : SKIP
+      date = hash.key?('date') ? hash['date'] : SKIP
+      network = hash.key?('network') ? hash['network'] : SKIP
+      time = hash.key?('time') ? hash['time'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      if hash['processor_response']
+        processor_response = CardVerificationProcessorResponse.from_hash(hash['processor_response'])
+      end
+
+      # Create object from extracted values.
+      CardVerificationDetails.new(network_transaction_id: network_transaction_id,
+                                  date: date,
+                                  network: network,
+                                  time: time,
+                                  amount: amount,
+                                  processor_response: processor_response)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_verification_method.rb

@@ -0,0 +1,29 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The method used for card verification.
+  class CardVerificationMethod
+    CARD_VERIFICATION_METHOD = [
+      # TODO: Write general description for SCA_ALWAYS
+      SCA_ALWAYS = 'SCA_ALWAYS'.freeze,
+
+      # TODO: Write general description for SCA_WHEN_REQUIRED
+      SCA_WHEN_REQUIRED = 'SCA_WHEN_REQUIRED'.freeze,
+
+      # TODO: Write general description for ENUM_3D_SECURE
+      ENUM_3D_SECURE = '3D_SECURE'.freeze,
+
+      # TODO: Write general description for AVS_CVV
+      AVS_CVV = 'AVS_CVV'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_verification_processor_response.rb

@@ -0,0 +1,62 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The processor response information for payment requests, such as direct
+  # credit card transactions.
+  class CardVerificationProcessorResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The address verification code for Visa, Discover, Mastercard, or American
+    # Express transactions.
+    # @return [AVSCode]
+    attr_accessor :avs_code
+
+    # The card verification value code for for Visa, Discover, Mastercard, or
+    # American Express.
+    # @return [CVVCode]
+    attr_accessor :cvv_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['avs_code'] = 'avs_code'
+      @_hash['cvv_code'] = 'cvv_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        avs_code
+        cvv_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(avs_code: SKIP, cvv_code: SKIP)
+      @avs_code = avs_code unless avs_code == SKIP
+      @cvv_code = cvv_code unless cvv_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.
+      avs_code = hash.key?('avs_code') ? hash['avs_code'] : SKIP
+      cvv_code = hash.key?('cvv_code') ? hash['cvv_code'] : SKIP
+
+      # Create object from extracted values.
+      CardVerificationProcessorResponse.new(avs_code: avs_code,
+                                            cvv_code: cvv_code)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/checkout_payment_intent.rb

@@ -0,0 +1,24 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The intent to either capture payment immediately or authorize a payment for
+  # an order after order creation.
+  class CheckoutPaymentIntent
+    CHECKOUT_PAYMENT_INTENT = [
+      # TODO: Write general description for CAPTURE
+      CAPTURE = 'CAPTURE'.freeze,
+
+      # TODO: Write general description for AUTHORIZE
+      AUTHORIZE = 'AUTHORIZE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/cobranded_card.rb

@@ -0,0 +1,70 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Details about the merchant cobranded card used for order purchase.
+  class CobrandedCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of labels for the cobranded card.
+    # @return [Array[String]]
+    attr_accessor :labels
+
+    # The details for the merchant who receives the funds and fulfills the
+    # order. The merchant is also known as the payee.
+    # @return [PayeeBase]
+    attr_accessor :payee
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['labels'] = 'labels'
+      @_hash['payee'] = 'payee'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        labels
+        payee
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(labels: SKIP, payee: SKIP, amount: SKIP)
+      @labels = labels unless labels == SKIP
+      @payee = payee unless payee == SKIP
+      @amount = amount unless amount == 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.
+      labels = hash.key?('labels') ? hash['labels'] : SKIP
+      payee = PayeeBase.from_hash(hash['payee']) if hash['payee']
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      CobrandedCard.new(labels: labels,
+                        payee: payee,
+                        amount: amount)
+    end
+  end
+end