cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/refund.rb

@@ -0,0 +1,214 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The refund information.
+  class Refund < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the refund.
+    # @return [RefundStatus]
+    attr_accessor :status
+
+    # The details of the refund status.
+    # @return [RefundStatusDetails]
+    attr_accessor :status_details
+
+    # The PayPal-generated ID for the refund.
+    # @return [String]
+    attr_accessor :id
+
+    # 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 invoice number for this order. Appears in
+    # both the payer's transaction history and the emails that the payer
+    # receives.
+    # @return [String]
+    attr_accessor :invoice_id
+
+    # The API caller-provided external ID. Used to reconcile API
+    # caller-initiated transactions with PayPal transactions. Appears in
+    # transaction and settlement reports.
+    # @return [String]
+    attr_accessor :custom_id
+
+    # Reference ID issued for the card transaction. This ID can be used to track
+    # the transaction across processors, card brands and issuing banks.
+    # @return [String]
+    attr_accessor :acquirer_reference_number
+
+    # The reason for the refund. Appears in both the payer's transaction history
+    # and the emails that the payer receives.
+    # @return [String]
+    attr_accessor :note_to_payer
+
+    # The breakdown of the refund.
+    # @return [SellerPayableBreakdown]
+    attr_accessor :seller_payable_breakdown
+
+    # The details for the merchant who receives the funds and fulfills the
+    # order. The merchant is also known as the payee.
+    # @return [PayeeBase]
+    attr_accessor :payer
+
+    # An array of related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # 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 :create_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 :update_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['status_details'] = 'status_details'
+      @_hash['id'] = 'id'
+      @_hash['amount'] = 'amount'
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['custom_id'] = 'custom_id'
+      @_hash['acquirer_reference_number'] = 'acquirer_reference_number'
+      @_hash['note_to_payer'] = 'note_to_payer'
+      @_hash['seller_payable_breakdown'] = 'seller_payable_breakdown'
+      @_hash['payer'] = 'payer'
+      @_hash['links'] = 'links'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        status_details
+        id
+        amount
+        invoice_id
+        custom_id
+        acquirer_reference_number
+        note_to_payer
+        seller_payable_breakdown
+        payer
+        links
+        create_time
+        update_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, status_details: SKIP, id: SKIP, amount: SKIP,
+                   invoice_id: SKIP, custom_id: SKIP,
+                   acquirer_reference_number: SKIP, note_to_payer: SKIP,
+                   seller_payable_breakdown: SKIP, payer: SKIP, links: SKIP,
+                   create_time: SKIP, update_time: SKIP)
+      @status = status unless status == SKIP
+      @status_details = status_details unless status_details == SKIP
+      @id = id unless id == SKIP
+      @amount = amount unless amount == SKIP
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @custom_id = custom_id unless custom_id == SKIP
+      unless acquirer_reference_number == SKIP
+        @acquirer_reference_number =
+          acquirer_reference_number
+      end
+      @note_to_payer = note_to_payer unless note_to_payer == SKIP
+      @seller_payable_breakdown = seller_payable_breakdown unless seller_payable_breakdown == SKIP
+      @payer = payer unless payer == SKIP
+      @links = links unless links == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_details = RefundStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
+      acquirer_reference_number =
+        hash.key?('acquirer_reference_number') ? hash['acquirer_reference_number'] : SKIP
+      note_to_payer = hash.key?('note_to_payer') ? hash['note_to_payer'] : SKIP
+      if hash['seller_payable_breakdown']
+        seller_payable_breakdown = SellerPayableBreakdown.from_hash(hash['seller_payable_breakdown'])
+      end
+      payer = PayeeBase.from_hash(hash['payer']) if hash['payer']
+      # 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')
+      create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
+      update_time = hash.key?('update_time') ? hash['update_time'] : SKIP
+
+      # Create object from extracted values.
+      Refund.new(status: status,
+                 status_details: status_details,
+                 id: id,
+                 amount: amount,
+                 invoice_id: invoice_id,
+                 custom_id: custom_id,
+                 acquirer_reference_number: acquirer_reference_number,
+                 note_to_payer: note_to_payer,
+                 seller_payable_breakdown: seller_payable_breakdown,
+                 payer: payer,
+                 links: links,
+                 create_time: create_time,
+                 update_time: update_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_details: #{@status_details}, id: #{@id}, amount:"\
+      " #{@amount}, invoice_id: #{@invoice_id}, custom_id: #{@custom_id},"\
+      " acquirer_reference_number: #{@acquirer_reference_number}, note_to_payer:"\
+      " #{@note_to_payer}, seller_payable_breakdown: #{@seller_payable_breakdown}, payer:"\
+      " #{@payer}, links: #{@links}, create_time: #{@create_time}, update_time: #{@update_time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}, id:"\
+      " #{@id.inspect}, amount: #{@amount.inspect}, invoice_id: #{@invoice_id.inspect}, custom_id:"\
+      " #{@custom_id.inspect}, acquirer_reference_number: #{@acquirer_reference_number.inspect},"\
+      " note_to_payer: #{@note_to_payer.inspect}, seller_payable_breakdown:"\
+      " #{@seller_payable_breakdown.inspect}, payer: #{@payer.inspect}, links: #{@links.inspect},"\
+      " create_time: #{@create_time.inspect}, update_time: #{@update_time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_incomplete_reason.rb

@@ -0,0 +1,27 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The reason why the refund has the `PENDING` or `FAILED` status.
+  class RefundIncompleteReason
+    REFUND_INCOMPLETE_REASON = [
+      # The customer's account is funded through an eCheck, which has not yet
+      # cleared.
+      ECHECK = 'ECHECK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ECHECK)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_payment_instruction.rb

@@ -0,0 +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

data/lib/paypal_server_sdk/models/refund_platform_fee.rb

@@ -0,0 +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

data/lib/paypal_server_sdk/models/refund_request.rb

@@ -0,0 +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

data/lib/paypal_server_sdk/models/refund_status.rb

@@ -0,0 +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)
+      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
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/refund_status_details.rb

@@ -0,0 +1,62 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details of the refund status.
+  class RefundStatusDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason why the refund has the `PENDING` or `FAILED` status.
+    # @return [RefundIncompleteReason]
+    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
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason: SKIP)
+      @reason = reason unless reason == 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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      RefundStatusDetails.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/refund_status_with_details.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The refund status with details.
+  class RefundStatusWithDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the refund.
+    # @return [RefundStatus]
+    attr_accessor :status
+
+    # The details of the refund status.
+    # @return [RefundStatusDetails]
+    attr_accessor :status_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['status_details'] = 'status_details'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        status_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, status_details: SKIP)
+      @status = status unless status == SKIP
+      @status_details = status_details unless status_details == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_details = RefundStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+
+      # Create object from extracted values.
+      RefundStatusWithDetails.new(status: status,
+                                  status_details: status_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, status_details: #{@status_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, status_details: #{@status_details.inspect}>"
+    end
+  end
+end