paypal-server-sdk 1.1.0 → 2.1.0

data/lib/paypal_server_sdk/models/subscriptions_card_brand.rb

@@ -0,0 +1,133 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The card network or brand. Applies to credit, debit, gift, and payment
+  # cards.
+  class SubscriptionsCardBrand
+    SUBSCRIPTIONS_CARD_BRAND = [
+      # Visa card.
+      VISA = 'VISA'.freeze,
+
+      # Mastercard card.
+      MASTERCARD = 'MASTERCARD'.freeze,
+
+      # Discover card.
+      DISCOVER = 'DISCOVER'.freeze,
+
+      # American Express card.
+      AMEX = 'AMEX'.freeze,
+
+      # Solo debit card.
+      SOLO = 'SOLO'.freeze,
+
+      # Japan Credit Bureau card.
+      JCB = 'JCB'.freeze,
+
+      # Military Star card.
+      STAR = 'STAR'.freeze,
+
+      # Delta Airlines card.
+      DELTA = 'DELTA'.freeze,
+
+      # Switch credit card.
+      SWITCH = 'SWITCH'.freeze,
+
+      # Maestro credit card.
+      MAESTRO = 'MAESTRO'.freeze,
+
+      # Carte Bancaire (CB) credit card.
+      CB_NATIONALE = 'CB_NATIONALE'.freeze,
+
+      # Configoga credit card.
+      CONFIGOGA = 'CONFIGOGA'.freeze,
+
+      # Confidis credit card.
+      CONFIDIS = 'CONFIDIS'.freeze,
+
+      # Visa Electron credit card.
+      ELECTRON = 'ELECTRON'.freeze,
+
+      # Cetelem credit card.
+      CETELEM = 'CETELEM'.freeze,
+
+      # China union pay credit card.
+      CHINA_UNION_PAY = 'CHINA_UNION_PAY'.freeze,
+
+      # The Diners Club International banking and payment services capability
+      # network owned by Discover Financial Services (DFS), one of the most
+      # recognized brands in US financial services.
+      DINERS = 'DINERS'.freeze,
+
+      # The Brazilian Elo card payment network.
+      ELO = 'ELO'.freeze,
+
+      # The Hiper - Ingenico ePayment network.
+      HIPER = 'HIPER'.freeze,
+
+      # The Brazilian Hipercard payment network that's widely accepted in the
+      # retail market.
+      HIPERCARD = 'HIPERCARD'.freeze,
+
+      # The RuPay payment network.
+      RUPAY = 'RUPAY'.freeze,
+
+      # The GE Credit Union 3Point card payment network.
+      GE = 'GE'.freeze,
+
+      # The Synchrony Financial (SYF) payment network.
+      SYNCHRONY = 'SYNCHRONY'.freeze,
+
+      # The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment
+      # network.
+      EFTPOS = 'EFTPOS'.freeze,
+
+      # UNKNOWN payment network.
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      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/supplementary_data.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Supplementary data about a payment. This object passes information that can

data/lib/paypal_server_sdk/models/suspend_subscription.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The suspend subscription request details.
+  class SuspendSubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for suspension of the Subscription.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason:)
+      @reason = reason
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      reason = hash.key?('reason') ? hash['reason'] : nil
+
+      # Create object from extracted values.
+      SuspendSubscription.new(reason: reason)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/tax_amount.rb

@@ -0,0 +1,63 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The tax levied by a government on the purchase of goods or services.
+  class TaxAmount < 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 :tax_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_amount: SKIP)
+      @tax_amount = tax_amount unless tax_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.
+      tax_amount = Money.from_hash(hash['tax_amount']) if hash['tax_amount']
+
+      # Create object from extracted values.
+      TaxAmount.new(tax_amount: tax_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tax_amount: #{@tax_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tax_amount: #{@tax_amount.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/tax_id_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The customer's tax ID type.
@@ -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/tax_info.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The tax ID of the customer. The customer is also known as the payer. Both

data/lib/paypal_server_sdk/models/taxes.rb

@@ -0,0 +1,71 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The tax details.
+  class Taxes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The percentage, as a fixed-point, signed decimal number. For example,
+    # define a 19.99% interest rate as `19.99`.
+    # @return [String]
+    attr_accessor :percentage
+
+    # Indicates whether the tax was already included in the billing amount.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :inclusive
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['percentage'] = 'percentage'
+      @_hash['inclusive'] = 'inclusive'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        inclusive
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(percentage:, inclusive: true)
+      @percentage = percentage
+      @inclusive = inclusive unless inclusive == 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.
+      percentage = hash.key?('percentage') ? hash['percentage'] : nil
+      inclusive = hash['inclusive'] ||= true
+
+      # Create object from extracted values.
+      Taxes.new(percentage: percentage,
+                inclusive: inclusive)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percentage: #{@percentage}, inclusive: #{@inclusive}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percentage: #{@percentage.inspect}, inclusive: #{@inclusive.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/taxes_override.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The tax details.
+  class TaxesOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The percentage, as a fixed-point, signed decimal number. For example,
+    # define a 19.99% interest rate as `19.99`.
+    # @return [String]
+    attr_accessor :percentage
+
+    # Indicates whether the tax was already included in the billing amount.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :inclusive
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['percentage'] = 'percentage'
+      @_hash['inclusive'] = 'inclusive'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        percentage
+        inclusive
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(percentage: SKIP, inclusive: SKIP)
+      @percentage = percentage unless percentage == SKIP
+      @inclusive = inclusive unless inclusive == 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.
+      percentage = hash.key?('percentage') ? hash['percentage'] : SKIP
+      inclusive = hash.key?('inclusive') ? hash['inclusive'] : SKIP
+
+      # Create object from extracted values.
+      TaxesOverride.new(percentage: percentage,
+                        inclusive: inclusive)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percentage: #{@percentage}, inclusive: #{@inclusive}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percentage: #{@percentage.inspect}, inclusive: #{@inclusive.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/tenure_type.rb

@@ -1,11 +1,13 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The tenure type of the billing cycle identifies if the billing cycle is a
-  # trial(free or discounted) or regular billing cycle.
+  # trial(free or discounted) or regular billing cycle., The tenure type of the
+  # billing cycle. In case of a plan having trial cycle, only 2 trial cycles are
+  # allowed per plan., The type of the billing cycle.
   class TenureType
     TENURE_TYPE = [
       # A regular billing cycle to identify recurring charges for the billing
@@ -24,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/three_d_secure_authentication_response.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Results of 3D Secure Authentication.

data/lib/paypal_server_sdk/models/three_d_secure_card_authentication_response.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # Results of 3D Secure Authentication.

data/lib/paypal_server_sdk/models/token.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The tokenized payment source to fund a payment.

data/lib/paypal_server_sdk/models/token_type.rb

@@ -1,7 +1,7 @@
 # paypal_server_sdk
 #
-# This file was automatically generated by APIMATIC v2.0
-# ( https://apimatic.io ).
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
 
 module PaypalServerSdk
   # The tokenization method that generated the ID.
@@ -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/transaction_details.rb

@@ -0,0 +1,126 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The transaction details.
+  class TransactionDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The transaction information.
+    # @return [TransactionInformation]
+    attr_accessor :transaction_info
+
+    # The payer information.
+    # @return [PayerInformation]
+    attr_accessor :payer_info
+
+    # The shipping information.
+    # @return [ShippingInformation]
+    attr_accessor :shipping_info
+
+    # The cart information.
+    # @return [CartInformation]
+    attr_accessor :cart_info
+
+    # The store information.
+    # @return [StoreInformation]
+    attr_accessor :store_info
+
+    # The auction information.
+    # @return [AuctionInformation]
+    attr_accessor :auction_info
+
+    # The incentive details.
+    # @return [IncentiveInformation]
+    attr_accessor :incentive_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_info'] = 'transaction_info'
+      @_hash['payer_info'] = 'payer_info'
+      @_hash['shipping_info'] = 'shipping_info'
+      @_hash['cart_info'] = 'cart_info'
+      @_hash['store_info'] = 'store_info'
+      @_hash['auction_info'] = 'auction_info'
+      @_hash['incentive_info'] = 'incentive_info'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_info
+        payer_info
+        shipping_info
+        cart_info
+        store_info
+        auction_info
+        incentive_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_info: SKIP, payer_info: SKIP,
+                   shipping_info: SKIP, cart_info: SKIP, store_info: SKIP,
+                   auction_info: SKIP, incentive_info: SKIP)
+      @transaction_info = transaction_info unless transaction_info == SKIP
+      @payer_info = payer_info unless payer_info == SKIP
+      @shipping_info = shipping_info unless shipping_info == SKIP
+      @cart_info = cart_info unless cart_info == SKIP
+      @store_info = store_info unless store_info == SKIP
+      @auction_info = auction_info unless auction_info == SKIP
+      @incentive_info = incentive_info unless incentive_info == 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.
+      transaction_info = TransactionInformation.from_hash(hash['transaction_info']) if
+        hash['transaction_info']
+      payer_info = PayerInformation.from_hash(hash['payer_info']) if hash['payer_info']
+      shipping_info = ShippingInformation.from_hash(hash['shipping_info']) if
+        hash['shipping_info']
+      cart_info = CartInformation.from_hash(hash['cart_info']) if hash['cart_info']
+      store_info = StoreInformation.from_hash(hash['store_info']) if hash['store_info']
+      auction_info = AuctionInformation.from_hash(hash['auction_info']) if hash['auction_info']
+      incentive_info = IncentiveInformation.from_hash(hash['incentive_info']) if
+        hash['incentive_info']
+
+      # Create object from extracted values.
+      TransactionDetails.new(transaction_info: transaction_info,
+                             payer_info: payer_info,
+                             shipping_info: shipping_info,
+                             cart_info: cart_info,
+                             store_info: store_info,
+                             auction_info: auction_info,
+                             incentive_info: incentive_info)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_info: #{@transaction_info}, payer_info: #{@payer_info},"\
+      " shipping_info: #{@shipping_info}, cart_info: #{@cart_info}, store_info: #{@store_info},"\
+      " auction_info: #{@auction_info}, incentive_info: #{@incentive_info}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_info: #{@transaction_info.inspect}, payer_info:"\
+      " #{@payer_info.inspect}, shipping_info: #{@shipping_info.inspect}, cart_info:"\
+      " #{@cart_info.inspect}, store_info: #{@store_info.inspect}, auction_info:"\
+      " #{@auction_info.inspect}, incentive_info: #{@incentive_info.inspect}>"
+    end
+  end
+end