paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/pay_pal_wallet_vault_instruction.rb

@@ -0,0 +1,115 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # PayPalWalletVaultInstruction Model.
+  class PayPalWalletVaultInstruction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Defines how and when the payment source gets vaulted.
+    # @return [StoreInVaultInstruction]
+    attr_accessor :store_in_vault
+
+    # The description displayed to PayPal consumer on the approval flow for
+    # PayPal, as well as on the PayPal payment token management experience on
+    # PayPal.com.
+    # @return [String]
+    attr_accessor :description
+
+    # Expected business/pricing model for the billing agreement.
+    # @return [PayPalPaymentTokenUsagePattern]
+    attr_accessor :usage_pattern
+
+    # The usage type associated with the PayPal payment token.
+    # @return [PayPalPaymentTokenUsageType]
+    attr_accessor :usage_type
+
+    # The customer type associated with the PayPal payment token. This is to
+    # indicate whether the customer acting on the merchant / platform is either
+    # a business or a consumer.
+    # @return [PayPalPaymentTokenCustomerType]
+    attr_accessor :customer_type
+
+    # Create multiple payment tokens for the same payer, merchant/platform
+    # combination. Use this when the customer has not logged in at
+    # merchant/platform. The payment token thus generated, can then also be used
+    # to create the customer account at merchant/platform. Use this also when
+    # multiple payment tokens are required for the same payer, different
+    # customer at merchant/platform. This helps to identify customers distinctly
+    # even though they may share the same PayPal account. This only applies to
+    # PayPal payment source.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :permit_multiple_payment_tokens
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['store_in_vault'] = 'store_in_vault'
+      @_hash['description'] = 'description'
+      @_hash['usage_pattern'] = 'usage_pattern'
+      @_hash['usage_type'] = 'usage_type'
+      @_hash['customer_type'] = 'customer_type'
+      @_hash['permit_multiple_payment_tokens'] =
+        'permit_multiple_payment_tokens'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        store_in_vault
+        description
+        usage_pattern
+        customer_type
+        permit_multiple_payment_tokens
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(usage_type:, store_in_vault: SKIP, description: SKIP,
+                   usage_pattern: SKIP,
+                   customer_type: PayPalPaymentTokenCustomerType::CONSUMER,
+                   permit_multiple_payment_tokens: false)
+      @store_in_vault = store_in_vault unless store_in_vault == SKIP
+      @description = description unless description == SKIP
+      @usage_pattern = usage_pattern unless usage_pattern == SKIP
+      @usage_type = usage_type
+      @customer_type = customer_type unless customer_type == SKIP
+      unless permit_multiple_payment_tokens == SKIP
+        @permit_multiple_payment_tokens =
+          permit_multiple_payment_tokens
+      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.
+      usage_type = hash.key?('usage_type') ? hash['usage_type'] : nil
+      store_in_vault =
+        hash.key?('store_in_vault') ? hash['store_in_vault'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      usage_pattern = hash.key?('usage_pattern') ? hash['usage_pattern'] : SKIP
+      customer_type =
+        hash['customer_type'] ||= PayPalPaymentTokenCustomerType::CONSUMER
+      permit_multiple_payment_tokens =
+        hash['permit_multiple_payment_tokens'] ||= false
+
+      # Create object from extracted values.
+      PayPalWalletVaultInstruction.new(usage_type: usage_type,
+                                       store_in_vault: store_in_vault,
+                                       description: description,
+                                       usage_pattern: usage_pattern,
+                                       customer_type: customer_type,
+                                       permit_multiple_payment_tokens: permit_multiple_payment_tokens)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_wallet_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 PayPal Wallet payment source.
+  class PayPalWalletVaultResponse < 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 [PayPalWalletVaultStatus]
+    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 [PayPalWalletCustomer]
+    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 = PayPalWalletCustomer.from_hash(hash['customer']) if hash['customer']
+
+      # Create object from extracted values.
+      PayPalWalletVaultResponse.new(id: id,
+                                    status: status,
+                                    links: links,
+                                    customer: customer)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/pay_pal_wallet_vault_status.rb

@@ -0,0 +1,26 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The vault status.
+  class PayPalWalletVaultStatus
+    PAY_PAL_WALLET_VAULT_STATUS = [
+      # TODO: Write general description for VAULTED
+      VAULTED = 'VAULTED'.freeze,
+
+      # TODO: Write general description for CREATED
+      CREATED = 'CREATED'.freeze,
+
+      # TODO: Write general description for APPROVED
+      APPROVED = 'APPROVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payee.rb

@@ -0,0 +1,65 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The merchant who receives the funds and fulfills the order. The merchant is
+  # also known as the payee., The details for the merchant who receives the
+  # funds and fulfills the order. The merchant is also known as the payee.
+  class Payee < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 account identifier for a PayPal account.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'email_address'
+      @_hash['merchant_id'] = 'merchant_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address
+        merchant_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email_address: SKIP, merchant_id: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @merchant_id = merchant_id unless merchant_id == 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.
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      merchant_id = hash.key?('merchant_id') ? hash['merchant_id'] : SKIP
+
+      # Create object from extracted values.
+      Payee.new(email_address: email_address,
+                merchant_id: merchant_id)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payee_base.rb

@@ -0,0 +1,64 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details for the merchant who receives the funds and fulfills the order.
+  # The merchant is also known as the payee.
+  class PayeeBase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 account identifier for a PayPal account.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'email_address'
+      @_hash['merchant_id'] = 'merchant_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address
+        merchant_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email_address: SKIP, merchant_id: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @merchant_id = merchant_id unless merchant_id == 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.
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      merchant_id = hash.key?('merchant_id') ? hash['merchant_id'] : SKIP
+
+      # Create object from extracted values.
+      PayeeBase.new(email_address: email_address,
+                    merchant_id: merchant_id)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payee_payment_method_preference.rb

@@ -0,0 +1,23 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The merchant-preferred payment methods.
+  class PayeePaymentMethodPreference
+    PAYEE_PAYMENT_METHOD_PREFERENCE = [
+      # TODO: Write general description for UNRESTRICTED
+      UNRESTRICTED = 'UNRESTRICTED'.freeze,
+
+      # TODO: Write general description for IMMEDIATE_PAYMENT_REQUIRED
+      IMMEDIATE_PAYMENT_REQUIRED = 'IMMEDIATE_PAYMENT_REQUIRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payer.rb

@@ -0,0 +1,120 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Payer Model.
+  class Payer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 account identifier for a PayPal account.
+    # @return [String]
+    attr_accessor :payer_id
+
+    # The name of the party.
+    # @return [Name]
+    attr_accessor :name
+
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
+    # The stand-alone date, in [Internet date and time
+    # format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent
+    # special legal values, such as a date of birth, you should use dates with
+    # no associated time or time-zone data. Whenever possible, use the standard
+    # `date_time` type. This regular expression does not validate all dates. For
+    # example, February 31 is valid and nothing is known about leap years.
+    # @return [String]
+    attr_accessor :birth_date
+
+    # The tax ID of the customer. The customer is also known as the payer. Both
+    # `tax_id` and `tax_id_type` are required.
+    # @return [TaxInfo]
+    attr_accessor :tax_info
+
+    # 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 :address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'email_address'
+      @_hash['payer_id'] = 'payer_id'
+      @_hash['name'] = 'name'
+      @_hash['phone'] = 'phone'
+      @_hash['birth_date'] = 'birth_date'
+      @_hash['tax_info'] = 'tax_info'
+      @_hash['address'] = 'address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address
+        payer_id
+        name
+        phone
+        birth_date
+        tax_info
+        address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email_address: SKIP, payer_id: SKIP, name: SKIP, phone: SKIP,
+                   birth_date: SKIP, tax_info: SKIP, address: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @name = name unless name == SKIP
+      @phone = phone unless phone == SKIP
+      @birth_date = birth_date unless birth_date == SKIP
+      @tax_info = tax_info unless tax_info == SKIP
+      @address = address unless address == 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.
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
+      name = Name.from_hash(hash['name']) if hash['name']
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
+      birth_date = hash.key?('birth_date') ? hash['birth_date'] : SKIP
+      tax_info = TaxInfo.from_hash(hash['tax_info']) if hash['tax_info']
+      address = Address.from_hash(hash['address']) if hash['address']
+
+      # Create object from extracted values.
+      Payer.new(email_address: email_address,
+                payer_id: payer_id,
+                name: name,
+                phone: phone,
+                birth_date: birth_date,
+                tax_info: tax_info,
+                address: address)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payer_base.rb

@@ -0,0 +1,64 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The customer who approves and pays for the order. The customer is also known
+  # as the payer.
+  class PayerBase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 account identifier for a PayPal account.
+    # @return [String]
+    attr_accessor :payer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'email_address'
+      @_hash['payer_id'] = 'payer_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address
+        payer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email_address: SKIP, payer_id: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @payer_id = payer_id unless payer_id == 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.
+      email_address = hash.key?('email_address') ? hash['email_address'] : SKIP
+      payer_id = hash.key?('payer_id') ? hash['payer_id'] : SKIP
+
+      # Create object from extracted values.
+      PayerBase.new(email_address: email_address,
+                    payer_id: payer_id)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_advice_code.rb

@@ -0,0 +1,30 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The declined payment transactions might have payment advice codes. The card
+  # networks, like Visa and Mastercard, return payment advice codes.
+  class PaymentAdviceCode
+    PAYMENT_ADVICE_CODE = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze,
+
+      # TODO: Write general description for ENUM_03
+      ENUM_03 = '03'.freeze,
+
+      # TODO: Write general description for ENUM_21
+      ENUM_21 = '21'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end