paypal-server-sdk 1.1.0 → 2.1.0

data/lib/paypal_server_sdk/models/authorization_status.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 status for the authorized payment.
@@ -37,5 +37,22 @@ 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 'captured' then CAPTURED
+      when 'denied' then DENIED
+      when 'partially_captured' then PARTIALLY_CAPTURED
+      when 'voided' then VOIDED
+      when 'pending' then PENDING
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/authorization_status_details.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 details of the authorized payment status.

data/lib/paypal_server_sdk/models/authorization_status_with_details.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 status fields and status details for an authorized payment.

data/lib/paypal_server_sdk/models/authorization_with_additional_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
   # The authorization with additional payment details, such as risk assessment
@@ -41,7 +41,7 @@ module PaypalServerSdk
     attr_accessor :custom_id
 
     # Reference values used by the card network to identify a transaction.
-    # @return [NetworkTransactionReference]
+    # @return [NetworkTransaction]
     attr_accessor :network_transaction_reference
 
     # The level of protection offered as defined by [PayPal Seller Protection
@@ -162,7 +162,7 @@ module PaypalServerSdk
       invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
       custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
       if hash['network_transaction_reference']
-        network_transaction_reference = NetworkTransactionReference.from_hash(hash['network_transaction_reference'])
+        network_transaction_reference = NetworkTransaction.from_hash(hash['network_transaction_reference'])
       end
       seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
         hash['seller_protection']

data/lib/paypal_server_sdk/models/avs_code.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 address verification code for Visa, Discover, Mastercard, or American
@@ -117,5 +117,40 @@ module PaypalServerSdk
 
       true
     end
+
+    def self.from_value(value, default_value = AVS_A)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'avs_a' then AVS_A
+      when 'avs_b' then AVS_B
+      when 'avs_c' then AVS_C
+      when 'avs_d' then AVS_D
+      when 'avs_e' then AVS_E
+      when 'avs_f' then AVS_F
+      when 'avs_g' then AVS_G
+      when 'avs_i' then AVS_I
+      when 'avs_m' then AVS_M
+      when 'avs_n' then AVS_N
+      when 'avs_p' then AVS_P
+      when 'avs_r' then AVS_R
+      when 'avs_s' then AVS_S
+      when 'avs_u' then AVS_U
+      when 'avs_w' then AVS_W
+      when 'avs_x' then AVS_X
+      when 'avs_y' then AVS_Y
+      when 'avs_z' then AVS_Z
+      when 'avs_null' then AVS_NULL
+      when 'avs_0' then AVS_0
+      when 'avs_1' then AVS_1
+      when 'avs_2' then AVS_2
+      when 'avs_3' then AVS_3
+      when 'avs_4' then AVS_4
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/paypal_server_sdk/models/balance_information.rb

@@ -0,0 +1,106 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The Balance information.
+  class BalanceInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The [three-character ISO-4217 currency
+    # code](/docs/integration/direct/rest/currency-codes/) that identifies the
+    # currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # Optional field representing if the currency is primary currency or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :primary
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :total_balance
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :available_balance
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :withheld_balance
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['primary'] = 'primary'
+      @_hash['total_balance'] = 'total_balance'
+      @_hash['available_balance'] = 'available_balance'
+      @_hash['withheld_balance'] = 'withheld_balance'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        primary
+        available_balance
+        withheld_balance
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency:, total_balance:, primary: SKIP,
+                   available_balance: SKIP, withheld_balance: SKIP)
+      @currency = currency
+      @primary = primary unless primary == SKIP
+      @total_balance = total_balance
+      @available_balance = available_balance unless available_balance == SKIP
+      @withheld_balance = withheld_balance unless withheld_balance == 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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      total_balance = Money.from_hash(hash['total_balance']) if hash['total_balance']
+      primary = hash.key?('primary') ? hash['primary'] : SKIP
+      available_balance = Money.from_hash(hash['available_balance']) if hash['available_balance']
+      withheld_balance = Money.from_hash(hash['withheld_balance']) if hash['withheld_balance']
+
+      # Create object from extracted values.
+      BalanceInformation.new(currency: currency,
+                             total_balance: total_balance,
+                             primary: primary,
+                             available_balance: available_balance,
+                             withheld_balance: withheld_balance)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, primary: #{@primary}, total_balance:"\
+      " #{@total_balance}, available_balance: #{@available_balance}, withheld_balance:"\
+      " #{@withheld_balance}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, primary: #{@primary.inspect},"\
+      " total_balance: #{@total_balance.inspect}, available_balance:"\
+      " #{@available_balance.inspect}, withheld_balance: #{@withheld_balance.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/balances_response.rb

@@ -0,0 +1,111 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The balances response information.
+  class BalancesResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of balance detail objects.
+    # @return [Array[BalanceInformation]]
+    attr_accessor :balances
+
+    # The PayPal payer ID, which is a masked version of the PayPal account
+    # number intended for use with third parties. The account number is
+    # reversibly encrypted and a proprietary variant of Base32 is used to encode
+    # the result.
+    # @return [String]
+    attr_accessor :account_id
+
+    # 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. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @return [String]
+    attr_accessor :as_of_time
+
+    # 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. Note: The regular
+    # expression provides guidance but does not reject all invalid dates.
+    # @return [String]
+    attr_accessor :last_refresh_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['balances'] = 'balances'
+      @_hash['account_id'] = 'account_id'
+      @_hash['as_of_time'] = 'as_of_time'
+      @_hash['last_refresh_time'] = 'last_refresh_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        balances
+        account_id
+        as_of_time
+        last_refresh_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(balances: SKIP, account_id: SKIP, as_of_time: SKIP,
+                   last_refresh_time: SKIP)
+      @balances = balances unless balances == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @as_of_time = as_of_time unless as_of_time == SKIP
+      @last_refresh_time = last_refresh_time unless last_refresh_time == 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.
+      # Parameter is an array, so we need to iterate through it
+      balances = nil
+      unless hash['balances'].nil?
+        balances = []
+        hash['balances'].each do |structure|
+          balances << (BalanceInformation.from_hash(structure) if structure)
+        end
+      end
+
+      balances = SKIP unless hash.key?('balances')
+      account_id = hash.key?('account_id') ? hash['account_id'] : SKIP
+      as_of_time = hash.key?('as_of_time') ? hash['as_of_time'] : SKIP
+      last_refresh_time =
+        hash.key?('last_refresh_time') ? hash['last_refresh_time'] : SKIP
+
+      # Create object from extracted values.
+      BalancesResponse.new(balances: balances,
+                           account_id: account_id,
+                           as_of_time: as_of_time,
+                           last_refresh_time: last_refresh_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} balances: #{@balances}, account_id: #{@account_id}, as_of_time:"\
+      " #{@as_of_time}, last_refresh_time: #{@last_refresh_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} balances: #{@balances.inspect}, account_id: #{@account_id.inspect},"\
+      " as_of_time: #{@as_of_time.inspect}, last_refresh_time: #{@last_refresh_time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/bancontact_payment_object.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
   # Information used to pay Bancontact.

data/lib/paypal_server_sdk/models/bancontact_payment_request.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
   # Information needed to pay using Bancontact.

data/lib/paypal_server_sdk/models/bank_request.rb

@@ -0,0 +1,71 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A Resource representing a request to vault a Bank used for ACH Debit.
+  class BankRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A Resource representing a request to vault a ACH Debit.
+    # @return [Object]
+    attr_accessor :ach_debit
+
+    # An API resource denoting a request to securely store a SEPA Debit.
+    # @return [SepaDebitRequest]
+    attr_accessor :sepa_debit
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ach_debit'] = 'ach_debit'
+      @_hash['sepa_debit'] = 'sepa_debit'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ach_debit
+        sepa_debit
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ach_debit: SKIP, sepa_debit: SKIP)
+      @ach_debit = ach_debit unless ach_debit == SKIP
+      @sepa_debit = sepa_debit unless sepa_debit == 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.
+      ach_debit = hash.key?('ach_debit') ? hash['ach_debit'] : SKIP
+      sepa_debit = SepaDebitRequest.from_hash(hash['sepa_debit']) if hash['sepa_debit']
+
+      # Create object from extracted values.
+      BankRequest.new(ach_debit: ach_debit,
+                      sepa_debit: sepa_debit)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ach_debit: #{@ach_debit}, sepa_debit: #{@sepa_debit}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} ach_debit: #{@ach_debit.inspect}, sepa_debit: #{@sepa_debit.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/base_model.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
   # Base model.

data/lib/paypal_server_sdk/models/billing_cycle.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 billing cycle providing details of the billing frequency, amount,
@@ -22,10 +22,6 @@ module PaypalServerSdk
     # @return [PricingScheme]
     attr_accessor :pricing_scheme
 
-    # The frequency details for this billing cycle.
-    # @return [Object]
-    attr_accessor :frequency
-
     # The number of times this billing cycle gets executed. Trial billing cycles
     # can only be executed a finite number of times (value between 1 and 999 for
     # total_cycles). Regular billing cycles can be executed infinite times
@@ -55,7 +51,6 @@ module PaypalServerSdk
       @_hash = {} if @_hash.nil?
       @_hash['tenure_type'] = 'tenure_type'
       @_hash['pricing_scheme'] = 'pricing_scheme'
-      @_hash['frequency'] = 'frequency'
       @_hash['total_cycles'] = 'total_cycles'
       @_hash['sequence'] = 'sequence'
       @_hash['start_date'] = 'start_date'
@@ -66,7 +61,6 @@ module PaypalServerSdk
     def self.optionals
       %w[
         pricing_scheme
-        frequency
         total_cycles
         sequence
         start_date
@@ -78,11 +72,10 @@ module PaypalServerSdk
       []
     end
 
-    def initialize(tenure_type:, pricing_scheme: SKIP, frequency: SKIP,
-                   total_cycles: 1, sequence: 1, start_date: SKIP)
+    def initialize(tenure_type:, pricing_scheme: SKIP, total_cycles: 1,
+                   sequence: 1, start_date: SKIP)
       @tenure_type = tenure_type
       @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
-      @frequency = frequency unless frequency == SKIP
       @total_cycles = total_cycles unless total_cycles == SKIP
       @sequence = sequence unless sequence == SKIP
       @start_date = start_date unless start_date == SKIP
@@ -95,7 +88,6 @@ module PaypalServerSdk
       # Extract variables from the hash.
       tenure_type = hash.key?('tenure_type') ? hash['tenure_type'] : nil
       pricing_scheme = PricingScheme.from_hash(hash['pricing_scheme']) if hash['pricing_scheme']
-      frequency = hash.key?('frequency') ? hash['frequency'] : SKIP
       total_cycles = hash['total_cycles'] ||= 1
       sequence = hash['sequence'] ||= 1
       start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
@@ -103,7 +95,6 @@ module PaypalServerSdk
       # Create object from extracted values.
       BillingCycle.new(tenure_type: tenure_type,
                        pricing_scheme: pricing_scheme,
-                       frequency: frequency,
                        total_cycles: total_cycles,
                        sequence: sequence,
                        start_date: start_date)
@@ -113,17 +104,15 @@ module PaypalServerSdk
     def to_s
       class_name = self.class.name.split('::').last
       "<#{class_name} tenure_type: #{@tenure_type}, pricing_scheme: #{@pricing_scheme},"\
-      " frequency: #{@frequency}, total_cycles: #{@total_cycles}, sequence: #{@sequence},"\
-      " start_date: #{@start_date}>"
+      " total_cycles: #{@total_cycles}, sequence: #{@sequence}, start_date: #{@start_date}>"
     end
 
     # Provides a debugging-friendly string with detailed object information.
     def inspect
       class_name = self.class.name.split('::').last
       "<#{class_name} tenure_type: #{@tenure_type.inspect}, pricing_scheme:"\
-      " #{@pricing_scheme.inspect}, frequency: #{@frequency.inspect}, total_cycles:"\
-      " #{@total_cycles.inspect}, sequence: #{@sequence.inspect}, start_date:"\
-      " #{@start_date.inspect}>"
+      " #{@pricing_scheme.inspect}, total_cycles: #{@total_cycles.inspect}, sequence:"\
+      " #{@sequence.inspect}, start_date: #{@start_date.inspect}>"
     end
   end
 end

data/lib/paypal_server_sdk/models/billing_cycle_override.rb

@@ -0,0 +1,91 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The billing cycle details to override at subscription level. The
+  # subscription billing cycle definition has to adhere to the plan billing
+  # cycle definition.
+  class BillingCycleOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pricing scheme details.
+    # @return [SubscriptionPricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The order in which this cycle is to run among other billing cycles. For
+    # example, a trial billing cycle has a `sequence` of `1` while a regular
+    # billing cycle has a `sequence` of `2`, so that trial cycle runs before the
+    # regular cycle.
+    # @return [Integer]
+    attr_accessor :sequence
+
+    # The number of times this billing cycle gets executed. Trial billing cycles
+    # can only be executed a finite number of times (value between 1 and 999 for
+    # total_cycles). Regular billing cycles can be executed infinite times
+    # (value of 0 for total_cycles) or a finite number of times (value between 1
+    # and 999 for total_cycles).
+    # @return [Integer]
+    attr_accessor :total_cycles
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['sequence'] = 'sequence'
+      @_hash['total_cycles'] = 'total_cycles'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pricing_scheme
+        total_cycles
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sequence:, pricing_scheme: SKIP, total_cycles: SKIP)
+      @pricing_scheme = pricing_scheme unless pricing_scheme == SKIP
+      @sequence = sequence
+      @total_cycles = total_cycles unless total_cycles == 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.
+      sequence = hash.key?('sequence') ? hash['sequence'] : nil
+      pricing_scheme = SubscriptionPricingScheme.from_hash(hash['pricing_scheme']) if
+        hash['pricing_scheme']
+      total_cycles = hash.key?('total_cycles') ? hash['total_cycles'] : SKIP
+
+      # Create object from extracted values.
+      BillingCycleOverride.new(sequence: sequence,
+                               pricing_scheme: pricing_scheme,
+                               total_cycles: total_cycles)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_scheme: #{@pricing_scheme}, sequence: #{@sequence}, total_cycles:"\
+      " #{@total_cycles}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pricing_scheme: #{@pricing_scheme.inspect}, sequence: #{@sequence.inspect},"\
+      " total_cycles: #{@total_cycles.inspect}>"
+    end
+  end
+end