paypal-server-sdk 2.0.0 → 2.2.0

data/lib/paypal_server_sdk/models/shipping_type.rb

@@ -33,5 +33,20 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = SHIPPING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'shipping' then SHIPPING
+      when 'pickup' then PICKUP
+      when 'pickup_in_store' then PICKUP_IN_STORE
+      when 'pickup_from_person' then PICKUP_FROM_PERSON
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/standard_entry_class_code.rb

@@ -40,5 +40,20 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = TEL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'tel' then TEL
+      when 'web' then WEB
+      when 'ccd' then CCD
+      when 'ppd' then PPD
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/store_in_vault_instruction.rb

@@ -17,5 +17,11 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = ON_SUCCESS)
+      return default_value if value.nil?
+
+      default_value
+    end
   end
 end

data/lib/paypal_server_sdk/models/stored_payment_source_payment_type.rb

@@ -25,5 +25,19 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = ONE_TIME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'one_time' then ONE_TIME
+      when 'recurring' then RECURRING
+      when 'unscheduled' then UNSCHEDULED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/stored_payment_source_usage_type.rb

@@ -26,5 +26,19 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = FIRST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'first' then FIRST
+      when 'subsequent' then SUBSEQUENT
+      when 'derived' then DERIVED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/subscriber.rb

@@ -9,6 +9,17 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
+    # The internationalized email address. Note: Up to 64 characters are allowed
+    # before and 255 characters are allowed after the @ sign. However, the
+    # generally accepted maximum length for an email address is 254 characters.
+    # The pattern verifies that an unquoted @ sign exists.
+    # @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
@@ -24,6 +35,8 @@ module PaypalServerSdk
     # 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['shipping_address'] = 'shipping_address'
       @_hash['payment_source'] = 'payment_source'
@@ -33,6 +46,8 @@ module PaypalServerSdk
     # An array for optional fields
     def self.optionals
       %w[
+        email_address
+        payer_id
         name
         shipping_address
         payment_source
@@ -44,7 +59,10 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(name: SKIP, shipping_address: SKIP, payment_source: SKIP)
+    def initialize(email_address: SKIP, payer_id: SKIP, name: SKIP,
+                   shipping_address: SKIP, payment_source: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
       @name = name unless name == SKIP
       @shipping_address = shipping_address unless shipping_address == SKIP
       @payment_source = payment_source unless payment_source == SKIP
@@ -55,6 +73,8 @@ module PaypalServerSdk
       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']
       shipping_address = ShippingDetails.from_hash(hash['shipping_address']) if
         hash['shipping_address']
@@ -62,7 +82,9 @@ module PaypalServerSdk
         hash['payment_source']
 
       # Create object from extracted values.
-      Subscriber.new(name: name,
+      Subscriber.new(email_address: email_address,
+                     payer_id: payer_id,
+                     name: name,
                      shipping_address: shipping_address,
                      payment_source: payment_source)
     end
@@ -70,15 +92,16 @@ module PaypalServerSdk
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name}, shipping_address: #{@shipping_address}, payment_source:"\
-      " #{@payment_source}>"
+      "<#{class_name} email_address: #{@email_address}, payer_id: #{@payer_id}, name: #{@name},"\
+      " shipping_address: #{@shipping_address}, payment_source: #{@payment_source}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name.inspect}, shipping_address: #{@shipping_address.inspect},"\
-      " payment_source: #{@payment_source.inspect}>"
+      "<#{class_name} email_address: #{@email_address.inspect}, payer_id: #{@payer_id.inspect},"\
+      " name: #{@name.inspect}, shipping_address: #{@shipping_address.inspect}, payment_source:"\
+      " #{@payment_source.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/subscriber_request.rb

@@ -9,14 +9,21 @@ module PaypalServerSdk
     SKIP = Object.new
     private_constant :SKIP
 
+    # The internationalized email address. Note: Up to 64 characters are allowed
+    # before and 255 characters are allowed after the @ sign. However, the
+    # generally accepted maximum length for an email address is 254 characters.
+    # The pattern verifies that an unquoted @ sign exists.
+    # @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 shipping details.
     # @return [ShippingDetails]
     attr_accessor :shipping_address
@@ -28,23 +35,31 @@ module PaypalServerSdk
     # @return [SubscriptionPaymentSource]
     attr_accessor :payment_source
 
+    # The phone information.
+    # @return [PhoneWithType]
+    attr_accessor :phone
+
     # 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['shipping_address'] = 'shipping_address'
       @_hash['payment_source'] = 'payment_source'
+      @_hash['phone'] = 'phone'
       @_hash
     end
 
     # An array for optional fields
     def self.optionals
       %w[
+        email_address
+        payer_id
         name
-        phone
         shipping_address
         payment_source
+        phone
       ]
     end
 
@@ -53,12 +68,14 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(name: SKIP, phone: SKIP, shipping_address: SKIP,
-                   payment_source: SKIP)
+    def initialize(email_address: SKIP, payer_id: SKIP, name: SKIP,
+                   shipping_address: SKIP, payment_source: SKIP, phone: 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
       @shipping_address = shipping_address unless shipping_address == SKIP
       @payment_source = payment_source unless payment_source == SKIP
+      @phone = phone unless phone == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -66,32 +83,38 @@ module PaypalServerSdk
       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']
       shipping_address = ShippingDetails.from_hash(hash['shipping_address']) if
         hash['shipping_address']
       payment_source = SubscriptionPaymentSource.from_hash(hash['payment_source']) if
         hash['payment_source']
+      phone = PhoneWithType.from_hash(hash['phone']) if hash['phone']
 
       # Create object from extracted values.
-      SubscriberRequest.new(name: name,
-                            phone: phone,
+      SubscriberRequest.new(email_address: email_address,
+                            payer_id: payer_id,
+                            name: name,
                             shipping_address: shipping_address,
-                            payment_source: payment_source)
+                            payment_source: payment_source,
+                            phone: phone)
     end
 
     # Provides a human-readable string representation of the object.
     def to_s
       class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name}, phone: #{@phone}, shipping_address: #{@shipping_address},"\
-      " payment_source: #{@payment_source}>"
+      "<#{class_name} email_address: #{@email_address}, payer_id: #{@payer_id}, name: #{@name},"\
+      " shipping_address: #{@shipping_address}, payment_source: #{@payment_source}, phone:"\
+      " #{@phone}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
-      "<#{class_name} name: #{@name.inspect}, phone: #{@phone.inspect}, shipping_address:"\
-      " #{@shipping_address.inspect}, payment_source: #{@payment_source.inspect}>"
+      "<#{class_name} email_address: #{@email_address.inspect}, payer_id: #{@payer_id.inspect},"\
+      " name: #{@name.inspect}, shipping_address: #{@shipping_address.inspect}, payment_source:"\
+      " #{@payment_source.inspect}, phone: #{@phone.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/subscription_payer.rb

@@ -0,0 +1,85 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The customer who approves and pays for the order. The customer is also known
+  # as the payer.
+  class SubscriptionPayer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The internationalized email address. Note: Up to 64 characters are allowed
+    # before and 255 characters are allowed after the @ sign. However, the
+    # generally accepted maximum length for an email address is 254 characters.
+    # The pattern verifies that an unquoted @ sign exists.
+    # @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
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email_address
+        payer_id
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email_address: SKIP, payer_id: SKIP, name: SKIP)
+      @email_address = email_address unless email_address == SKIP
+      @payer_id = payer_id unless payer_id == SKIP
+      @name = name unless name == 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']
+
+      # Create object from extracted values.
+      SubscriptionPayer.new(email_address: email_address,
+                            payer_id: payer_id,
+                            name: name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address}, payer_id: #{@payer_id}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} email_address: #{@email_address.inspect}, payer_id: #{@payer_id.inspect},"\
+      " name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscription_plan_status.rb

@@ -24,5 +24,19 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = CREATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created' then CREATED
+      when 'inactive' then INACTIVE
+      when 'active' then ACTIVE
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/subscription_pricing_model.rb

@@ -19,5 +19,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = VOLUME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'volume' then VOLUME
+      when 'tiered' then TIERED
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/subscriptions_card_brand.rb

@@ -93,5 +93,41 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = VISA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'visa' then VISA
+      when 'mastercard' then MASTERCARD
+      when 'discover' then DISCOVER
+      when 'amex' then AMEX
+      when 'solo' then SOLO
+      when 'jcb' then JCB
+      when 'star' then STAR
+      when 'delta' then DELTA
+      when 'switch' then SWITCH
+      when 'maestro' then MAESTRO
+      when 'cb_nationale' then CB_NATIONALE
+      when 'configoga' then CONFIGOGA
+      when 'confidis' then CONFIDIS
+      when 'electron' then ELECTRON
+      when 'cetelem' then CETELEM
+      when 'china_union_pay' then CHINA_UNION_PAY
+      when 'diners' then DINERS
+      when 'elo' then ELO
+      when 'hiper' then HIPER
+      when 'hipercard' then HIPERCARD
+      when 'rupay' then RUPAY
+      when 'ge' then GE
+      when 'synchrony' then SYNCHRONY
+      when 'eftpos' then EFTPOS
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/tax_id_type.rb

@@ -19,5 +19,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = BR_CPF)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'br_cpf' then BR_CPF
+      when 'br_cnpj' then BR_CNPJ
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/tenure_type.rb

@@ -26,5 +26,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = REGULAR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'regular' then REGULAR
+      when 'trial' then TRIAL
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/token_type.rb

@@ -17,5 +17,11 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = BILLING_AGREEMENT)
+      return default_value if value.nil?
+
+      default_value
+    end
   end
 end

data/lib/paypal_server_sdk/models/upc_type.rb

@@ -34,5 +34,23 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = UPC_A)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'upc_a' then UPC_A
+      when 'upc_b' then UPC_B
+      when 'upc_c' then UPC_C
+      when 'upc_d' then UPC_D
+      when 'upc_e' then UPC_E
+      when 'upc_2' then UPC_2
+      when 'upc_5' then UPC_5
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/usage_pattern.rb

@@ -68,5 +68,28 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = IMMEDIATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'immediate' then IMMEDIATE
+      when 'deferred' then DEFERRED
+      when 'recurring_prepaid' then RECURRING_PREPAID
+      when 'recurring_postpaid' then RECURRING_POSTPAID
+      when 'threshold_prepaid' then THRESHOLD_PREPAID
+      when 'threshold_postpaid' then THRESHOLD_POSTPAID
+      when 'subscription_prepaid' then SUBSCRIPTION_PREPAID
+      when 'subscription_postpaid' then SUBSCRIPTION_POSTPAID
+      when 'unscheduled_prepaid' then UNSCHEDULED_PREPAID
+      when 'unscheduled_postpaid' then UNSCHEDULED_POSTPAID
+      when 'installment_prepaid' then INSTALLMENT_PREPAID
+      when 'installment_postpaid' then INSTALLMENT_POSTPAID
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/usage_type.rb

@@ -0,0 +1,39 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The usage type associated with the PayPal payment token.
+  class UsageType
+    USAGE_TYPE = [
+      # The PayPal Payment Token will be used for future transaction directly
+      # with a merchant.
+      MERCHANT = 'MERCHANT'.freeze,
+
+      # The PayPal Payment Token will be used for future transaction on a
+      # platform. A platform is typically a marketplace or a channel that a
+      # payer can purchase goods and services from multiple merchants.
+      PLATFORM = 'PLATFORM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = MERCHANT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'merchant' then MERCHANT
+      when 'platform' then PLATFORM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/vault_card_verification_method.rb

@@ -35,5 +35,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = SCA_WHEN_REQUIRED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'sca_when_required' then SCA_WHEN_REQUIRED
+      when 'sca_always' then SCA_ALWAYS
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/vault_instruction_action.rb

@@ -22,5 +22,18 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = ON_CREATE_PAYMENT_TOKENS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'on_create_payment_tokens' then ON_CREATE_PAYMENT_TOKENS
+      when 'on_payer_approval' then ON_PAYER_APPROVAL
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/vault_status.rb

@@ -27,5 +27,19 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = VAULTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'vaulted' then VAULTED
+      when 'created' then CREATED
+      when 'approved' then APPROVED
+      else
+        default_value
+      end
+    end
   end
 end