paypal-server-sdk 0.5.0

data/lib/paypal_server_sdk/models/capture.rb

@@ -0,0 +1,228 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # A captured payment.
+  class Capture < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the captured payment.
+    # @return [CaptureStatus]
+    attr_accessor :status
+
+    # The details of the captured payment status.
+    # @return [CaptureStatusDetails]
+    attr_accessor :status_details
+
+    # The PayPal-generated ID for the captured payment.
+    # @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 values used by the card network to identify a transaction.
+    # @return [NetworkTransactionReference]
+    attr_accessor :network_transaction_reference
+
+    # The level of protection offered as defined by [PayPal Seller Protection
+    # for
+    # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protectio
+    # n).
+    # @return [SellerProtection]
+    attr_accessor :seller_protection
+
+    # Indicates whether you can make additional captures against the authorized
+    # payment. Set to `true` if you do not intend to capture additional payments
+    # against the authorization. Set to `false` if you intend to capture
+    # additional payments against the authorization.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :final_capture
+
+    # The detailed breakdown of the capture activity. This is not available for
+    # transactions that are in pending state.
+    # @return [SellerReceivableBreakdown]
+    attr_accessor :seller_receivable_breakdown
+
+    # The funds that are held on behalf of the merchant.
+    # @return [DisbursementMode]
+    attr_accessor :disbursement_mode
+
+    # An array of related [HATEOAS
+    # links](/docs/api/reference/api-responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # The processor response information for payment requests, such as direct
+    # credit card transactions.
+    # @return [ProcessorResponse]
+    attr_accessor :processor_response
+
+    # 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.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @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.<blockquote><strong>Note:</strong> The regular expression
+    # provides guidance but does not reject all invalid dates.</blockquote>
+    # @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['network_transaction_reference'] =
+        'network_transaction_reference'
+      @_hash['seller_protection'] = 'seller_protection'
+      @_hash['final_capture'] = 'final_capture'
+      @_hash['seller_receivable_breakdown'] = 'seller_receivable_breakdown'
+      @_hash['disbursement_mode'] = 'disbursement_mode'
+      @_hash['links'] = 'links'
+      @_hash['processor_response'] = 'processor_response'
+      @_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
+        network_transaction_reference
+        seller_protection
+        final_capture
+        seller_receivable_breakdown
+        disbursement_mode
+        links
+        processor_response
+        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,
+                   network_transaction_reference: SKIP, seller_protection: SKIP,
+                   final_capture: false, seller_receivable_breakdown: SKIP,
+                   disbursement_mode: DisbursementMode::INSTANT, links: SKIP,
+                   processor_response: 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 network_transaction_reference == SKIP
+        @network_transaction_reference =
+          network_transaction_reference
+      end
+      @seller_protection = seller_protection unless seller_protection == SKIP
+      @final_capture = final_capture unless final_capture == SKIP
+      unless seller_receivable_breakdown == SKIP
+        @seller_receivable_breakdown =
+          seller_receivable_breakdown
+      end
+      @disbursement_mode = disbursement_mode unless disbursement_mode == SKIP
+      @links = links unless links == SKIP
+      @processor_response = processor_response unless processor_response == 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 = CaptureStatusDetails.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
+      if hash['network_transaction_reference']
+        network_transaction_reference = NetworkTransactionReference.from_hash(hash['network_transaction_reference'])
+      end
+      seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
+        hash['seller_protection']
+      final_capture = hash['final_capture'] ||= false
+      if hash['seller_receivable_breakdown']
+        seller_receivable_breakdown = SellerReceivableBreakdown.from_hash(hash['seller_receivable_breakdown'])
+      end
+      disbursement_mode =
+        hash['disbursement_mode'] ||= DisbursementMode::INSTANT
+      # 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')
+      processor_response = ProcessorResponse.from_hash(hash['processor_response']) if
+        hash['processor_response']
+      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.
+      Capture.new(status: status,
+                  status_details: status_details,
+                  id: id,
+                  amount: amount,
+                  invoice_id: invoice_id,
+                  custom_id: custom_id,
+                  network_transaction_reference: network_transaction_reference,
+                  seller_protection: seller_protection,
+                  final_capture: final_capture,
+                  seller_receivable_breakdown: seller_receivable_breakdown,
+                  disbursement_mode: disbursement_mode,
+                  links: links,
+                  processor_response: processor_response,
+                  create_time: create_time,
+                  update_time: update_time)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_incomplete_reason.rb

@@ -0,0 +1,55 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The reason why the captured payment status is `PENDING` or `DENIED`.
+  class CaptureIncompleteReason
+    CAPTURE_INCOMPLETE_REASON = [
+      # TODO: Write general description for BUYER_COMPLAINT
+      BUYER_COMPLAINT = 'BUYER_COMPLAINT'.freeze,
+
+      # TODO: Write general description for CHARGEBACK
+      CHARGEBACK = 'CHARGEBACK'.freeze,
+
+      # TODO: Write general description for ECHECK
+      ECHECK = 'ECHECK'.freeze,
+
+      # TODO: Write general description for INTERNATIONAL_WITHDRAWAL
+      INTERNATIONAL_WITHDRAWAL = 'INTERNATIONAL_WITHDRAWAL'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for PENDING_REVIEW
+      PENDING_REVIEW = 'PENDING_REVIEW'.freeze,
+
+      # TODO: Write general description for
+      # RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION
+      RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION = 'RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION'.freeze,
+
+      # TODO: Write general description for REFUNDED
+      REFUNDED = 'REFUNDED'.freeze,
+
+      # TODO: Write general description for
+      # TRANSACTION_APPROVED_AWAITING_FUNDING
+      TRANSACTION_APPROVED_AWAITING_FUNDING = 'TRANSACTION_APPROVED_AWAITING_FUNDING'.freeze,
+
+      # TODO: Write general description for UNILATERAL
+      UNILATERAL = 'UNILATERAL'.freeze,
+
+      # TODO: Write general description for VERIFICATION_REQUIRED
+      VERIFICATION_REQUIRED = 'VERIFICATION_REQUIRED'.freeze,
+
+      # TODO: Write general description for DECLINED_BY_RISK_FRAUD_FILTERS
+      DECLINED_BY_RISK_FRAUD_FILTERS = 'DECLINED_BY_RISK_FRAUD_FILTERS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_payment_instruction.rb

@@ -0,0 +1,89 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # Any additional payment instructions to be consider during payment
+  # processing. This processing instruction is applicable for Capturing an order
+  # or Authorizing an Order.
+  class CapturePaymentInstruction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of platform or partner fees, commissions, or brokerage fees that
+    # associated with the captured payment.
+    # @return [Array[PlatformFee]]
+    attr_accessor :platform_fees
+
+    # The funds that are held on behalf of the merchant.
+    # @return [DisbursementMode]
+    attr_accessor :disbursement_mode
+
+    # FX identifier generated returned by PayPal to be used for payment
+    # processing in order to honor FX rate (for eligible integrations) to be
+    # used when amount is settled/received into the payee account.
+    # @return [String]
+    attr_accessor :payee_receivable_fx_rate_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['platform_fees'] = 'platform_fees'
+      @_hash['disbursement_mode'] = 'disbursement_mode'
+      @_hash['payee_receivable_fx_rate_id'] = 'payee_receivable_fx_rate_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        platform_fees
+        disbursement_mode
+        payee_receivable_fx_rate_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(platform_fees: SKIP,
+                   disbursement_mode: DisbursementMode::INSTANT,
+                   payee_receivable_fx_rate_id: SKIP)
+      @platform_fees = platform_fees unless platform_fees == SKIP
+      @disbursement_mode = disbursement_mode unless disbursement_mode == SKIP
+      unless payee_receivable_fx_rate_id == SKIP
+        @payee_receivable_fx_rate_id =
+          payee_receivable_fx_rate_id
+      end
+    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 << (PlatformFee.from_hash(structure) if structure)
+        end
+      end
+
+      platform_fees = SKIP unless hash.key?('platform_fees')
+      disbursement_mode =
+        hash['disbursement_mode'] ||= DisbursementMode::INSTANT
+      payee_receivable_fx_rate_id =
+        hash.key?('payee_receivable_fx_rate_id') ? hash['payee_receivable_fx_rate_id'] : SKIP
+
+      # Create object from extracted values.
+      CapturePaymentInstruction.new(platform_fees: platform_fees,
+                                    disbursement_mode: disbursement_mode,
+                                    payee_receivable_fx_rate_id: payee_receivable_fx_rate_id)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_request.rb

@@ -0,0 +1,108 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # CaptureRequest Model.
+  class CaptureRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # An informational note about this settlement. Appears in both the payer's
+    # transaction history and the emails that the payer receives.
+    # @return [String]
+    attr_accessor :note_to_payer
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # Indicates whether you can make additional captures against the authorized
+    # payment. Set to `true` if you do not intend to capture additional payments
+    # against the authorization. Set to `false` if you intend to capture
+    # additional payments against the authorization.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :final_capture
+
+    # Any additional payment instructions to be consider during payment
+    # processing. This processing instruction is applicable for Capturing an
+    # order or Authorizing an Order.
+    # @return [CapturePaymentInstruction]
+    attr_accessor :payment_instruction
+
+    # The payment descriptor on the payer's account statement.
+    # @return [String]
+    attr_accessor :soft_descriptor
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_id'] = 'invoice_id'
+      @_hash['note_to_payer'] = 'note_to_payer'
+      @_hash['amount'] = 'amount'
+      @_hash['final_capture'] = 'final_capture'
+      @_hash['payment_instruction'] = 'payment_instruction'
+      @_hash['soft_descriptor'] = 'soft_descriptor'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        invoice_id
+        note_to_payer
+        amount
+        final_capture
+        payment_instruction
+        soft_descriptor
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_id: SKIP, note_to_payer: SKIP, amount: SKIP,
+                   final_capture: false, payment_instruction: SKIP,
+                   soft_descriptor: SKIP)
+      @invoice_id = invoice_id unless invoice_id == SKIP
+      @note_to_payer = note_to_payer unless note_to_payer == SKIP
+      @amount = amount unless amount == SKIP
+      @final_capture = final_capture unless final_capture == SKIP
+      @payment_instruction = payment_instruction unless payment_instruction == SKIP
+      @soft_descriptor = soft_descriptor unless soft_descriptor == 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.
+      invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
+      note_to_payer = hash.key?('note_to_payer') ? hash['note_to_payer'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      final_capture = hash['final_capture'] ||= false
+      payment_instruction = CapturePaymentInstruction.from_hash(hash['payment_instruction']) if
+        hash['payment_instruction']
+      soft_descriptor =
+        hash.key?('soft_descriptor') ? hash['soft_descriptor'] : SKIP
+
+      # Create object from extracted values.
+      CaptureRequest.new(invoice_id: invoice_id,
+                         note_to_payer: note_to_payer,
+                         amount: amount,
+                         final_capture: final_capture,
+                         payment_instruction: payment_instruction,
+                         soft_descriptor: soft_descriptor)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_status.rb

@@ -0,0 +1,35 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The status of the captured payment.
+  class CaptureStatus
+    CAPTURE_STATUS = [
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'COMPLETED'.freeze,
+
+      # TODO: Write general description for DECLINED
+      DECLINED = 'DECLINED'.freeze,
+
+      # TODO: Write general description for PARTIALLY_REFUNDED
+      PARTIALLY_REFUNDED = 'PARTIALLY_REFUNDED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for REFUNDED
+      REFUNDED = 'REFUNDED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_status_details.rb

@@ -0,0 +1,50 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The details of the captured payment status.
+  class CaptureStatusDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason why the captured payment status is `PENDING` or `DENIED`.
+    # @return [CaptureIncompleteReason]
+    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.
+      CaptureStatusDetails.new(reason: reason)
+    end
+  end
+end

data/lib/paypal_server_sdk/models/capture_status_with_details.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module PaypalServerSdk
+  # The status and status details of a captured payment.
+  class CaptureStatusWithDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the captured payment.
+    # @return [CaptureStatus]
+    attr_accessor :status
+
+    # The details of the captured payment status.
+    # @return [CaptureStatusDetails]
+    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 = CaptureStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+
+      # Create object from extracted values.
+      CaptureStatusWithDetails.new(status: status,
+                                   status_details: status_details)
+    end
+  end
+end