paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/setup_token_request.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Setup Token Request where the `source` defines the type of instrument to be
+  # stored.
+  class SetupTokenRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Customer in merchant's or partner's system of records.
+    # @return [CustomerRequest]
+    attr_accessor :customer
+
+    # The payment method to vault with the instrument details.
+    # @return [SetupTokenRequestPaymentSource]
+    attr_accessor :payment_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer'] = 'customer'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_source:, customer: SKIP)
+      @customer = customer unless customer == SKIP
+      @payment_source = payment_source
+    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_source = SetupTokenRequestPaymentSource.from_hash(hash['payment_source']) if
+        hash['payment_source']
+      customer = CustomerRequest.from_hash(hash['customer']) if hash['customer']
+
+      # Create object from extracted values.
+      SetupTokenRequest.new(payment_source: payment_source,
+                            customer: customer)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_request_card.rb

@@ -0,0 +1,141 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # A Resource representing a request to vault a Card.
+  class SetupTokenRequestCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The primary account number (PAN) for the payment card.
+    # @return [String]
+    attr_accessor :number
+
+    # 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
+
+    # The three- or four-digit security code of the card. Also known as the CVV,
+    # CVC, CVN, CVE, or CID. This parameter cannot be present in the request
+    # when `payment_initiator=MERCHANT`.
+    # @return [String]
+    attr_accessor :security_code
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :brand
+
+    # 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 verification method of the card.
+    # @return [String]
+    attr_accessor :verification_method
+
+    # Customizes the Vault creation flow experience for your customers.
+    # @return [SetupTokenCardExperienceContext]
+    attr_accessor :experience_context
+
+    # Customizes the Vault creation flow experience for your customers.
+    # @return [Object]
+    attr_accessor :network_transaction_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['number'] = 'number'
+      @_hash['expiry'] = 'expiry'
+      @_hash['security_code'] = 'security_code'
+      @_hash['brand'] = 'brand'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['verification_method'] = 'verification_method'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash['network_transaction_reference'] =
+        'network_transaction_reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        number
+        expiry
+        security_code
+        brand
+        billing_address
+        verification_method
+        experience_context
+        network_transaction_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, number: SKIP, expiry: SKIP, security_code: SKIP,
+                   brand: SKIP, billing_address: SKIP,
+                   verification_method: SKIP, experience_context: SKIP,
+                   network_transaction_reference: SKIP)
+      @name = name unless name == SKIP
+      @number = number unless number == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @security_code = security_code unless security_code == SKIP
+      @brand = brand unless brand == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @verification_method = verification_method unless verification_method == SKIP
+      @experience_context = experience_context unless experience_context == SKIP
+      unless network_transaction_reference == SKIP
+        @network_transaction_reference =
+          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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      security_code = hash.key?('security_code') ? hash['security_code'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+      verification_method =
+        hash.key?('verification_method') ? hash['verification_method'] : SKIP
+      experience_context = SetupTokenCardExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+      network_transaction_reference =
+        hash.key?('network_transaction_reference') ? hash['network_transaction_reference'] : SKIP
+
+      # Create object from extracted values.
+      SetupTokenRequestCard.new(name: name,
+                                number: number,
+                                expiry: expiry,
+                                security_code: security_code,
+                                brand: brand,
+                                billing_address: billing_address,
+                                verification_method: verification_method,
+                                experience_context: experience_context,
+                                network_transaction_reference: network_transaction_reference)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_request_payment_source.rb

@@ -0,0 +1,77 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The payment method to vault with the instrument details.
+  class SetupTokenRequestPaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A Resource representing a request to vault a Card.
+    # @return [SetupTokenRequestCard]
+    attr_accessor :card
+
+    # A resource representing a request to vault PayPal Wallet.
+    # @return [VaultPayPalWalletRequest]
+    attr_accessor :paypal
+
+    # A resource representing a request to vault PayPal Wallet.
+    # @return [VaultVenmoRequest]
+    attr_accessor :venmo
+
+    # The Tokenized Payment Source representing a Request to Vault a Token.
+    # @return [VaultTokenRequest]
+    attr_accessor :token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['paypal'] = 'paypal'
+      @_hash['venmo'] = 'venmo'
+      @_hash['token'] = 'token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        paypal
+        venmo
+        token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, paypal: SKIP, venmo: SKIP, token: SKIP)
+      @card = card unless card == SKIP
+      @paypal = paypal unless paypal == SKIP
+      @venmo = venmo unless venmo == SKIP
+      @token = token unless token == 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 = SetupTokenRequestCard.from_hash(hash['card']) if hash['card']
+      paypal = VaultPayPalWalletRequest.from_hash(hash['paypal']) if hash['paypal']
+      venmo = VaultVenmoRequest.from_hash(hash['venmo']) if hash['venmo']
+      token = VaultTokenRequest.from_hash(hash['token']) if hash['token']
+
+      # Create object from extracted values.
+      SetupTokenRequestPaymentSource.new(card: card,
+                                         paypal: paypal,
+                                         venmo: venmo,
+                                         token: token)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_response.rb

@@ -0,0 +1,106 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Minimal representation of a cached setup token.
+  class SetupTokenResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal-generated ID for the vault token.
+    # @return [String]
+    attr_accessor :id
+
+    # Ordinal number for sorting.
+    # @return [Integer]
+    attr_accessor :ordinal
+
+    # Customer in merchant's or partner's system of records.
+    # @return [CustomerRequest]
+    attr_accessor :customer
+
+    # The status of the payment token.
+    # @return [String]
+    attr_accessor :status
+
+    # The setup payment method details.
+    # @return [SetupTokenResponsePaymentSource]
+    attr_accessor :payment_source
+
+    # An array of related [HATEOAS links](/api/rest/responses/#hateoas).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['ordinal'] = 'ordinal'
+      @_hash['customer'] = 'customer'
+      @_hash['status'] = 'status'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        ordinal
+        customer
+        status
+        payment_source
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, ordinal: SKIP, customer: SKIP, status: 'CREATED',
+                   payment_source: SKIP, links: SKIP)
+      @id = id unless id == SKIP
+      @ordinal = ordinal unless ordinal == SKIP
+      @customer = customer unless customer == SKIP
+      @status = status unless status == SKIP
+      @payment_source = payment_source unless payment_source == SKIP
+      @links = links unless links == 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
+      ordinal = hash.key?('ordinal') ? hash['ordinal'] : SKIP
+      customer = CustomerRequest.from_hash(hash['customer']) if hash['customer']
+      status = hash['status'] ||= 'CREATED'
+      payment_source = SetupTokenResponsePaymentSource.from_hash(hash['payment_source']) if
+        hash['payment_source']
+      # 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')
+
+      # Create object from extracted values.
+      SetupTokenResponse.new(id: id,
+                             ordinal: ordinal,
+                             customer: customer,
+                             status: status,
+                             payment_source: payment_source,
+                             links: links)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_response_card.rb

@@ -0,0 +1,156 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # SetupTokenResponseCard Model.
+  class SetupTokenResponseCard < 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
+
+    # 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
+
+    # Address request details.
+    # @return [AddressDetails]
+    attr_accessor :billing_address
+
+    # Verification status of Card.
+    # @return [String]
+    attr_accessor :verification_status
+
+    # Card Verification details including the authorization details and 3D
+    # SECURE details.
+    # @return [CardVerificationDetails]
+    attr_accessor :verification
+
+    # Previous network transaction reference including id in response.
+    # @return [NetworkTransactionReferenceEntity]
+    attr_accessor :network_transaction_reference
+
+    # Results of Authentication such as 3D Secure.
+    # @return [CardAuthenticationResponse]
+    attr_accessor :authentication_result
+
+    # Bank Identification Number (BIN) details used to fund a payment.
+    # @return [BinDetails]
+    attr_accessor :bin_details
+
+    # Type of card. i.e Credit, Debit and so on.
+    # @return [CardType]
+    attr_accessor :type
+
+    # 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['expiry'] = 'expiry'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['verification_status'] = 'verification_status'
+      @_hash['verification'] = 'verification'
+      @_hash['network_transaction_reference'] =
+        'network_transaction_reference'
+      @_hash['authentication_result'] = 'authentication_result'
+      @_hash['bin_details'] = 'bin_details'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        last_digits
+        brand
+        expiry
+        billing_address
+        verification_status
+        verification
+        network_transaction_reference
+        authentication_result
+        bin_details
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, last_digits: SKIP, brand: SKIP, expiry: SKIP,
+                   billing_address: SKIP, verification_status: SKIP,
+                   verification: SKIP, network_transaction_reference: SKIP,
+                   authentication_result: SKIP, bin_details: SKIP, type: SKIP)
+      @name = name unless name == SKIP
+      @last_digits = last_digits unless last_digits == SKIP
+      @brand = brand unless brand == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @verification_status = verification_status unless verification_status == SKIP
+      @verification = verification unless verification == SKIP
+      unless network_transaction_reference == SKIP
+        @network_transaction_reference =
+          network_transaction_reference
+      end
+      @authentication_result = authentication_result unless authentication_result == SKIP
+      @bin_details = bin_details unless bin_details == SKIP
+      @type = type unless type == 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
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      billing_address = AddressDetails.from_hash(hash['billing_address']) if
+        hash['billing_address']
+      verification_status =
+        hash.key?('verification_status') ? hash['verification_status'] : SKIP
+      verification = CardVerificationDetails.from_hash(hash['verification']) if
+        hash['verification']
+      if hash['network_transaction_reference']
+        network_transaction_reference = NetworkTransactionReferenceEntity.from_hash(hash['network_transaction_reference'])
+      end
+      authentication_result = CardAuthenticationResponse.from_hash(hash['authentication_result']) if
+        hash['authentication_result']
+      bin_details = BinDetails.from_hash(hash['bin_details']) if hash['bin_details']
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      SetupTokenResponseCard.new(name: name,
+                                 last_digits: last_digits,
+                                 brand: brand,
+                                 expiry: expiry,
+                                 billing_address: billing_address,
+                                 verification_status: verification_status,
+                                 verification: verification,
+                                 network_transaction_reference: network_transaction_reference,
+                                 authentication_result: authentication_result,
+                                 bin_details: bin_details,
+                                 type: type)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/setup_token_response_payment_source.rb

@@ -0,0 +1,68 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The setup payment method details.
+  class SetupTokenResponsePaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SetupTokenResponseCard]
+    attr_accessor :card
+
+    # TODO: Write general description for this method
+    # @return [PayPalPaymentToken]
+    attr_accessor :paypal
+
+    # TODO: Write general description for this method
+    # @return [VenmoPaymentToken]
+    attr_accessor :venmo
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['paypal'] = 'paypal'
+      @_hash['venmo'] = 'venmo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        paypal
+        venmo
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, paypal: SKIP, venmo: SKIP)
+      @card = card unless card == SKIP
+      @paypal = paypal unless paypal == SKIP
+      @venmo = venmo unless venmo == 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 = SetupTokenResponseCard.from_hash(hash['card']) if hash['card']
+      paypal = PayPalPaymentToken.from_hash(hash['paypal']) if hash['paypal']
+      venmo = VenmoPaymentToken.from_hash(hash['venmo']) if hash['venmo']
+
+      # Create object from extracted values.
+      SetupTokenResponsePaymentSource.new(card: card,
+                                          paypal: paypal,
+                                          venmo: venmo)
+    end
+  end
+end