cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/authorization_with_additional_data.rb

@@ -0,0 +1,225 @@
+# paypal_server_sdk
+#
+# 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
+  # and processor response. These details are populated only for certain payment
+  # methods.
+  class AuthorizationWithAdditionalData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status for the authorized payment.
+    # @return [AuthorizationStatus]
+    attr_accessor :status
+
+    # The details of the authorized payment status.
+    # @return [AuthorizationStatusDetails]
+    attr_accessor :status_details
+
+    # The PayPal-generated ID for the authorized 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 [NetworkTransaction]
+    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
+
+    # 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 :expiration_time
+
+    # 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
+
+    # The processor response information for payment requests, such as direct
+    # credit card transactions.
+    # @return [ProcessorResponse]
+    attr_accessor :processor_response
+
+    # 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['expiration_time'] = 'expiration_time'
+      @_hash['links'] = 'links'
+      @_hash['create_time'] = 'create_time'
+      @_hash['update_time'] = 'update_time'
+      @_hash['processor_response'] = 'processor_response'
+      @_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
+        expiration_time
+        links
+        create_time
+        update_time
+        processor_response
+      ]
+    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,
+                   expiration_time: SKIP, links: SKIP, create_time: SKIP,
+                   update_time: SKIP, processor_response: 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
+      @expiration_time = expiration_time unless expiration_time == SKIP
+      @links = links unless links == SKIP
+      @create_time = create_time unless create_time == SKIP
+      @update_time = update_time unless update_time == SKIP
+      @processor_response = processor_response unless processor_response == 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 = AuthorizationStatusDetails.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 = NetworkTransaction.from_hash(hash['network_transaction_reference'])
+      end
+      seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
+        hash['seller_protection']
+      expiration_time =
+        hash.key?('expiration_time') ? hash['expiration_time'] : SKIP
+      # 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
+      processor_response = ProcessorResponse.from_hash(hash['processor_response']) if
+        hash['processor_response']
+
+      # Create object from extracted values.
+      AuthorizationWithAdditionalData.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,
+                                          expiration_time: expiration_time,
+                                          links: links,
+                                          create_time: create_time,
+                                          update_time: update_time,
+                                          processor_response: processor_response)
+    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},"\
+      " network_transaction_reference: #{@network_transaction_reference}, seller_protection:"\
+      " #{@seller_protection}, expiration_time: #{@expiration_time}, links: #{@links},"\
+      " create_time: #{@create_time}, update_time: #{@update_time}, processor_response:"\
+      " #{@processor_response}>"
+    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}, network_transaction_reference:"\
+      " #{@network_transaction_reference.inspect}, seller_protection:"\
+      " #{@seller_protection.inspect}, expiration_time: #{@expiration_time.inspect}, links:"\
+      " #{@links.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}, processor_response: #{@processor_response.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/avs_code.rb

@@ -0,0 +1,156 @@
+# paypal_server_sdk
+#
+# 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
+  # Express transactions.
+  class AvsCode
+    AVS_CODE = [
+      # For Visa, Mastercard, or Discover transactions, the address matches but
+      # the zip code does not match. For American Express transactions, the card
+      # holder address is correct.
+      AVS_A = 'A'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address matches.
+      # International A.
+      AVS_B = 'B'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, no values match.
+      # International N.
+      AVS_C = 'C'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address and postal
+      # code match. International X.
+      AVS_D = 'D'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, not allowed for Internet
+      # or phone transactions. For American Express card holder, the name is
+      # incorrect but the address and postal code match.
+      AVS_E = 'E'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address and postal
+      # code match. UK-specific X. For American Express card holder, the name is
+      # incorrect but the address matches.
+      AVS_F = 'F'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, global is unavailable.
+      # Nothing matches.
+      AVS_G = 'G'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, international is
+      # unavailable. Not applicable.
+      AVS_I = 'I'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address and postal
+      # code match. For American Express card holder, the name, address, and
+      # postal code match.
+      AVS_M = 'M'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, nothing matches. For
+      # American Express card holder, the address and postal code are both
+      # incorrect.
+      AVS_N = 'N'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, postal international Z.
+      # Postal code only.
+      AVS_P = 'P'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, re-try the request. For
+      # American Express, the system is unavailable.
+      AVS_R = 'R'.freeze,
+
+      # For Visa, Mastercard, Discover, or American Express, the service is not
+      # supported.
+      AVS_S = 'S'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the service is
+      # unavailable. For American Express, information is not available. For
+      # Maestro, the address is not checked or the acquirer had no response. The
+      # service is not available.
+      AVS_U = 'U'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, whole ZIP code. For
+      # American Express, the card holder name, address, and postal code are all
+      # incorrect.
+      AVS_W = 'W'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, exact match of the
+      # address and the nine-digit ZIP code. For American Express, the card
+      # holder name, address, and postal code are all incorrect.
+      AVS_X = 'X'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the address and
+      # five-digit ZIP code match. For American Express, the card holder address
+      # and postal code are both correct.
+      AVS_Y = 'Y'.freeze,
+
+      # For Visa, Mastercard, or Discover transactions, the five-digit ZIP code
+      # matches but no address. For American Express, only the card holder
+      # postal code is correct.
+      AVS_Z = 'Z'.freeze,
+
+      # For Maestro, no AVS response was obtained.
+      AVS_NULL = 'Null'.freeze,
+
+      # For Maestro, all address information matches.
+      AVS_0 = '0'.freeze,
+
+      # For Maestro, none of the address information matches.
+      AVS_1 = '1'.freeze,
+
+      # For Maestro, part of the address information matches.
+      AVS_2 = '2'.freeze,
+
+      # For Maestro, the merchant did not provide AVS information. It was not
+      # processed.
+      AVS_3 = '3'.freeze,
+
+      # For Maestro, the address was not checked or the acquirer had no
+      # response. The service is not available.
+      AVS_4 = '4'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      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