paypal-server-sdk 2.2.0 → 2.4.0

data/lib/paypal_server_sdk/models/refund_payment_instruction.rb

@@ -1,80 +1,80 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # Any additional payments instructions during refund payment processing. This
-  # object is only applicable to merchants that have been enabled for PayPal
-  # Commerce Platform for Marketplaces and Platforms capability. Please speak to
-  # your account manager if you want to use this capability.
-  class RefundPaymentInstruction < BaseModel
-    SKIP = Object.new
-    private_constant :SKIP
-
-    # Specifies the amount that the API caller will contribute to the refund
-    # being processed. The amount needs to be lower than platform_fees amount
-    # originally captured or the amount that is remaining if multiple refunds
-    # have been processed. This field is only applicable to merchants that have
-    # been enabled for PayPal Commerce Platform for Marketplaces and Platforms
-    # capability. Please speak to your account manager if you want to use this
-    # capability.
-    # @return [Array[RefundPlatformFee]]
-    attr_accessor :platform_fees
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['platform_fees'] = 'platform_fees'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        platform_fees
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(platform_fees: SKIP)
-      @platform_fees = platform_fees unless platform_fees == 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
-      platform_fees = nil
-      unless hash['platform_fees'].nil?
-        platform_fees = []
-        hash['platform_fees'].each do |structure|
-          platform_fees << (RefundPlatformFee.from_hash(structure) if structure)
-        end
-      end
-
-      platform_fees = SKIP unless hash.key?('platform_fees')
-
-      # Create object from extracted values.
-      RefundPaymentInstruction.new(platform_fees: platform_fees)
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} platform_fees: #{@platform_fees}>"
-    end
-
-    # Provides a debugging-friendly string with detailed object information.
-    def inspect
-      class_name = self.class.name.split('::').last
-      "<#{class_name} platform_fees: #{@platform_fees.inspect}>"
-    end
-  end
-end
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Any additional payments instructions during refund payment processing. This
+  # object is only applicable to merchants that have been enabled for PayPal
+  # Commerce Platform for Marketplaces and Platforms capability. Please speak to
+  # your account manager if you want to use this capability.
+  class RefundPaymentInstruction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies the amount that the API caller will contribute to the refund
+    # being processed. The amount needs to be lower than platform_fees amount
+    # originally captured or the amount that is remaining if multiple refunds
+    # have been processed. This field is only applicable to merchants that have
+    # been enabled for PayPal Commerce Platform for Marketplaces and Platforms
+    # capability. Please speak to your account manager if you want to use this
+    # capability.
+    # @return [Array[RefundPlatformFee]]
+    attr_accessor :platform_fees
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['platform_fees'] = 'platform_fees'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        platform_fees
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(platform_fees: SKIP)
+      @platform_fees = platform_fees unless platform_fees == 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
+      platform_fees = nil
+      unless hash['platform_fees'].nil?
+        platform_fees = []
+        hash['platform_fees'].each do |structure|
+          platform_fees << (RefundPlatformFee.from_hash(structure) if structure)
+        end
+      end
+
+      platform_fees = SKIP unless hash.key?('platform_fees')
+
+      # Create object from extracted values.
+      RefundPaymentInstruction.new(platform_fees: platform_fees)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} platform_fees: #{@platform_fees}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} platform_fees: #{@platform_fees.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_platform_fee.rb

@@ -1,64 +1,64 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # The platform or partner fee, commission, or brokerage fee that is associated
-  # with the transaction. Not a separate or isolated transaction leg from the
-  # external perspective. The platform fee is limited in scope and is always
-  # associated with the original payment for the purchase unit.
-  class RefundPlatformFee < 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 :amount
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['amount'] = 'amount'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      []
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(amount:)
-      @amount = amount
-    end
-
-    # Creates an instance of the object from a hash.
-    def self.from_hash(hash)
-      return nil unless hash
-
-      # Extract variables from the hash.
-      amount = Money.from_hash(hash['amount']) if hash['amount']
-
-      # Create object from extracted values.
-      RefundPlatformFee.new(amount: amount)
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} amount: #{@amount}>"
-    end
-
-    # Provides a debugging-friendly string with detailed object information.
-    def inspect
-      class_name = self.class.name.split('::').last
-      "<#{class_name} amount: #{@amount.inspect}>"
-    end
-  end
-end
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The platform or partner fee, commission, or brokerage fee that is associated
+  # with the transaction. Not a separate or isolated transaction leg from the
+  # external perspective. The platform fee is limited in scope and is always
+  # associated with the original payment for the purchase unit.
+  class RefundPlatformFee < 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 :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:)
+      @amount = amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      RefundPlatformFee.new(amount: amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_request.rb

@@ -1,115 +1,115 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # Refunds a captured payment, by ID. For a full refund, include an empty
-  # request body. For a partial refund, include an amount object in the request
-  # body.
-  class RefundRequest < 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 :amount
-
-    # The API caller-provided external ID. Used to reconcile API
-    # caller-initiated transactions with PayPal transactions. Appears in
-    # transaction and settlement reports. The pattern is defined by an external
-    # party and supports Unicode.
-    # @return [String]
-    attr_accessor :custom_id
-
-    # The API caller-provided external invoice ID for this order. The pattern is
-    # defined by an external party and supports Unicode.
-    # @return [String]
-    attr_accessor :invoice_id
-
-    # The reason for the refund. Appears in both the payer's transaction history
-    # and the emails that the payer receives. The pattern is defined by an
-    # external party and supports Unicode.
-    # @return [String]
-    attr_accessor :note_to_payer
-
-    # Any additional payments instructions during refund payment processing.
-    # This object is only applicable to merchants that have been enabled for
-    # PayPal Commerce Platform for Marketplaces and Platforms capability. Please
-    # speak to your account manager if you want to use this capability.
-    # @return [RefundPaymentInstruction]
-    attr_accessor :payment_instruction
-
-    # A mapping from model property names to API property names.
-    def self.names
-      @_hash = {} if @_hash.nil?
-      @_hash['amount'] = 'amount'
-      @_hash['custom_id'] = 'custom_id'
-      @_hash['invoice_id'] = 'invoice_id'
-      @_hash['note_to_payer'] = 'note_to_payer'
-      @_hash['payment_instruction'] = 'payment_instruction'
-      @_hash
-    end
-
-    # An array for optional fields
-    def self.optionals
-      %w[
-        amount
-        custom_id
-        invoice_id
-        note_to_payer
-        payment_instruction
-      ]
-    end
-
-    # An array for nullable fields
-    def self.nullables
-      []
-    end
-
-    def initialize(amount: SKIP, custom_id: SKIP, invoice_id: SKIP,
-                   note_to_payer: SKIP, payment_instruction: SKIP)
-      @amount = amount unless amount == SKIP
-      @custom_id = custom_id unless custom_id == SKIP
-      @invoice_id = invoice_id unless invoice_id == SKIP
-      @note_to_payer = note_to_payer unless note_to_payer == SKIP
-      @payment_instruction = payment_instruction unless payment_instruction == 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.
-      amount = Money.from_hash(hash['amount']) if hash['amount']
-      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
-      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
-      note_to_payer = hash.key?('note_to_payer') ? hash['note_to_payer'] : SKIP
-      payment_instruction = RefundPaymentInstruction.from_hash(hash['payment_instruction']) if
-        hash['payment_instruction']
-
-      # Create object from extracted values.
-      RefundRequest.new(amount: amount,
-                        custom_id: custom_id,
-                        invoice_id: invoice_id,
-                        note_to_payer: note_to_payer,
-                        payment_instruction: payment_instruction)
-    end
-
-    # Provides a human-readable string representation of the object.
-    def to_s
-      class_name = self.class.name.split('::').last
-      "<#{class_name} amount: #{@amount}, custom_id: #{@custom_id}, invoice_id: #{@invoice_id},"\
-      " note_to_payer: #{@note_to_payer}, payment_instruction: #{@payment_instruction}>"
-    end
-
-    # Provides a debugging-friendly string with detailed object information.
-    def inspect
-      class_name = self.class.name.split('::').last
-      "<#{class_name} amount: #{@amount.inspect}, custom_id: #{@custom_id.inspect}, invoice_id:"\
-      " #{@invoice_id.inspect}, note_to_payer: #{@note_to_payer.inspect}, payment_instruction:"\
-      " #{@payment_instruction.inspect}>"
-    end
-  end
-end
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Refunds a captured payment, by ID. For a full refund, include an empty
+  # request body. For a partial refund, include an amount object in the request
+  # body.
+  class RefundRequest < 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 :amount
+
+    # The API caller-provided external ID. Used to reconcile API
+    # caller-initiated transactions with PayPal transactions. Appears in
+    # transaction and settlement reports. The pattern is defined by an external
+    # party and supports Unicode.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # The API caller-provided external invoice ID for this order. The pattern is
+    # defined by an external party and supports Unicode.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # The reason for the refund. Appears in both the payer's transaction history
+    # and the emails that the payer receives. The pattern is defined by an
+    # external party and supports Unicode.
+    # @return [String]
+    attr_accessor :note_to_payer
+
+    # Any additional payments instructions during refund payment processing.
+    # This object is only applicable to merchants that have been enabled for
+    # PayPal Commerce Platform for Marketplaces and Platforms capability. Please
+    # speak to your account manager if you want to use this capability.
+    # @return [RefundPaymentInstruction]
+    attr_accessor :payment_instruction
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['note_to_payer'] = 'note_to_payer'
+      @_hash['payment_instruction'] = 'payment_instruction'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        custom_id
+        invoice_id
+        note_to_payer
+        payment_instruction
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, custom_id: SKIP, invoice_id: SKIP,
+                   note_to_payer: SKIP, payment_instruction: SKIP)
+      @amount = amount unless amount == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @note_to_payer = note_to_payer unless note_to_payer == SKIP
+      @payment_instruction = payment_instruction unless payment_instruction == 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.
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      note_to_payer = hash.key?('note_to_payer') ? hash['note_to_payer'] : SKIP
+      payment_instruction = RefundPaymentInstruction.from_hash(hash['payment_instruction']) if
+        hash['payment_instruction']
+
+      # Create object from extracted values.
+      RefundRequest.new(amount: amount,
+                        custom_id: custom_id,
+                        invoice_id: invoice_id,
+                        note_to_payer: note_to_payer,
+                        payment_instruction: payment_instruction)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, custom_id: #{@custom_id}, invoice_id: #{@invoice_id},"\
+      " note_to_payer: #{@note_to_payer}, payment_instruction: #{@payment_instruction}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, custom_id: #{@custom_id.inspect}, invoice_id:"\
+      " #{@invoice_id.inspect}, note_to_payer: #{@note_to_payer.inspect}, payment_instruction:"\
+      " #{@payment_instruction.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_status.rb

@@ -1,44 +1,44 @@
-# paypal_server_sdk
-#
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
-
-module PaypalServerSdk
-  # The status of the refund.
-  class RefundStatus
-    REFUND_STATUS = [
-      # The refund was cancelled.
-      CANCELLED = 'CANCELLED'.freeze,
-
-      # The refund could not be processed.
-      FAILED = 'FAILED'.freeze,
-
-      # The refund is pending. For more information, see status_details.reason.
-      PENDING = 'PENDING'.freeze,
-
-      # The funds for this transaction were debited to the customer's account.
-      COMPLETED = 'COMPLETED'.freeze
-    ].freeze
-
-    def self.validate(value)
-      return false if value.nil?
-
-      true
-    end
-
-    def self.from_value(value, default_value = CANCELLED)
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The status of the refund.
+  class RefundStatus
+    REFUND_STATUS = [
+      # The refund was cancelled.
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # The refund could not be processed.
+      FAILED = 'FAILED'.freeze,
+
+      # The refund is pending. For more information, see status_details.reason.
+      PENDING = 'PENDING'.freeze,
+
+      # The funds for this transaction were debited to the customer's account.
+      COMPLETED = 'COMPLETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CANCELLED)
       return default_value if value.nil?
-
-      str = value.to_s.strip
-
-      case str.downcase
-      when 'cancelled' then CANCELLED
-      when 'failed' then FAILED
-      when 'pending' then PENDING
-      when 'completed' then COMPLETED
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'cancelled' then CANCELLED
+      when 'failed' then FAILED
+      when 'pending' then PENDING
+      when 'completed' then COMPLETED
       else
         default_value
       end
-    end
-  end
-end
+    end
+  end
+end