cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/card_verification_details.rb

@@ -0,0 +1,140 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Card Verification details including the authorization details and 3D SECURE
+  # details.
+  class CardVerificationDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # DEPRECATED. This field is DEPRECATED. Please find the network transaction
+    # id data in the 'id' field under the 'network_transaction_reference' object
+    # instead of the 'verification' object.
+    # @return [String]
+    attr_accessor :network_transaction_id
+
+    # DEPRECATED. This field is DEPRECATED. Please find the date data in the
+    # 'date' field under the 'network_transaction_reference' object instead of
+    # the 'verification' object.
+    # @return [String]
+    attr_accessor :date
+
+    # DEPRECATED. This field is DEPRECATED. Please find the network data in the
+    # 'network' field under the 'network_transaction_reference' object instead
+    # of the 'verification' object.
+    # @return [CardBrand]
+    attr_accessor :network
+
+    # DEPRECATED. This field is DEPRECATED. Please find the time data in the
+    # 'time' field under the 'network_transaction_reference' object instead of
+    # the 'verification' object.
+    # @return [String]
+    attr_accessor :time
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :amount
+
+    # The processor response information for payment requests, such as direct
+    # credit card transactions.
+    # @return [CardVerificationProcessorResponse]
+    attr_accessor :processor_response
+
+    # DEPRECATED. This field is DEPRECATED. Please find the 3D secure
+    # authentication data in the 'three_d_secure' object under the
+    # 'authentication_result' object instead of the 'verification' object.
+    # @return [Object]
+    attr_accessor :three_d_secure
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['network_transaction_id'] = 'network_transaction_id'
+      @_hash['date'] = 'date'
+      @_hash['network'] = 'network'
+      @_hash['time'] = 'time'
+      @_hash['amount'] = 'amount'
+      @_hash['processor_response'] = 'processor_response'
+      @_hash['three_d_secure'] = 'three_d_secure'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        network_transaction_id
+        date
+        network
+        time
+        amount
+        processor_response
+        three_d_secure
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(network_transaction_id: SKIP, date: SKIP, network: SKIP,
+                   time: SKIP, amount: SKIP, processor_response: SKIP,
+                   three_d_secure: SKIP)
+      @network_transaction_id = network_transaction_id unless network_transaction_id == SKIP
+      @date = date unless date == SKIP
+      @network = network unless network == SKIP
+      @time = time unless time == SKIP
+      @amount = amount unless amount == SKIP
+      @processor_response = processor_response unless processor_response == SKIP
+      @three_d_secure = three_d_secure unless three_d_secure == 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.
+      network_transaction_id =
+        hash.key?('network_transaction_id') ? hash['network_transaction_id'] : SKIP
+      date = hash.key?('date') ? hash['date'] : SKIP
+      network = hash.key?('network') ? hash['network'] : SKIP
+      time = hash.key?('time') ? hash['time'] : SKIP
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+      if hash['processor_response']
+        processor_response = CardVerificationProcessorResponse.from_hash(hash['processor_response'])
+      end
+      three_d_secure =
+        hash.key?('three_d_secure') ? hash['three_d_secure'] : SKIP
+
+      # Create object from extracted values.
+      CardVerificationDetails.new(network_transaction_id: network_transaction_id,
+                                  date: date,
+                                  network: network,
+                                  time: time,
+                                  amount: amount,
+                                  processor_response: processor_response,
+                                  three_d_secure: three_d_secure)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} network_transaction_id: #{@network_transaction_id}, date: #{@date},"\
+      " network: #{@network}, time: #{@time}, amount: #{@amount}, processor_response:"\
+      " #{@processor_response}, three_d_secure: #{@three_d_secure}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} network_transaction_id: #{@network_transaction_id.inspect}, date:"\
+      " #{@date.inspect}, network: #{@network.inspect}, time: #{@time.inspect}, amount:"\
+      " #{@amount.inspect}, processor_response: #{@processor_response.inspect}, three_d_secure:"\
+      " #{@three_d_secure.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_verification_processor_response.rb

@@ -0,0 +1,74 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The processor response information for payment requests, such as direct
+  # credit card transactions.
+  class CardVerificationProcessorResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The address verification code for Visa, Discover, Mastercard, or American
+    # Express transactions.
+    # @return [AvsCode]
+    attr_accessor :avs_code
+
+    # The card verification value code for for Visa, Discover, Mastercard, or
+    # American Express.
+    # @return [CvvCode]
+    attr_accessor :cvv_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['avs_code'] = 'avs_code'
+      @_hash['cvv_code'] = 'cvv_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        avs_code
+        cvv_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(avs_code: SKIP, cvv_code: SKIP)
+      @avs_code = avs_code unless avs_code == SKIP
+      @cvv_code = cvv_code unless cvv_code == 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.
+      avs_code = hash.key?('avs_code') ? hash['avs_code'] : SKIP
+      cvv_code = hash.key?('cvv_code') ? hash['cvv_code'] : SKIP
+
+      # Create object from extracted values.
+      CardVerificationProcessorResponse.new(avs_code: avs_code,
+                                            cvv_code: cvv_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avs_code: #{@avs_code}, cvv_code: #{@cvv_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} avs_code: #{@avs_code.inspect}, cvv_code: #{@cvv_code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_verification_status.rb

@@ -0,0 +1,36 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Verification status of Card.
+  class CardVerificationStatus
+    CARD_VERIFICATION_STATUS = [
+      # Card has been verified
+      VERIFIED = 'VERIFIED'.freeze,
+
+      # Card verification has failed
+      FAILED = 'FAILED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = VERIFIED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'verified' then VERIFIED
+      when 'failed' then FAILED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/cart_information.rb

@@ -0,0 +1,94 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The cart information.
+  class CartInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of item details.
+    # @return [Array[ItemDetails]]
+    attr_accessor :item_details
+
+    # Indicates whether the item amount or the shipping amount already includes
+    # tax.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_inclusive
+
+    # The ID of the invoice. Appears for only PayPal-generated invoices.
+    # @return [String]
+    attr_accessor :paypal_invoice_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['item_details'] = 'item_details'
+      @_hash['tax_inclusive'] = 'tax_inclusive'
+      @_hash['paypal_invoice_id'] = 'paypal_invoice_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        item_details
+        tax_inclusive
+        paypal_invoice_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(item_details: SKIP, tax_inclusive: false,
+                   paypal_invoice_id: SKIP)
+      @item_details = item_details unless item_details == SKIP
+      @tax_inclusive = tax_inclusive unless tax_inclusive == SKIP
+      @paypal_invoice_id = paypal_invoice_id unless paypal_invoice_id == 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
+      item_details = nil
+      unless hash['item_details'].nil?
+        item_details = []
+        hash['item_details'].each do |structure|
+          item_details << (ItemDetails.from_hash(structure) if structure)
+        end
+      end
+
+      item_details = SKIP unless hash.key?('item_details')
+      tax_inclusive = hash['tax_inclusive'] ||= false
+      paypal_invoice_id =
+        hash.key?('paypal_invoice_id') ? hash['paypal_invoice_id'] : SKIP
+
+      # Create object from extracted values.
+      CartInformation.new(item_details: item_details,
+                          tax_inclusive: tax_inclusive,
+                          paypal_invoice_id: paypal_invoice_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_details: #{@item_details}, tax_inclusive: #{@tax_inclusive},"\
+      " paypal_invoice_id: #{@paypal_invoice_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} item_details: #{@item_details.inspect}, tax_inclusive:"\
+      " #{@tax_inclusive.inspect}, paypal_invoice_id: #{@paypal_invoice_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/checkout_option.rb

@@ -0,0 +1,77 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A checkout option as a name-and-value pair.
+  class CheckoutOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The checkout option name, such as `color` or `texture`.
+    # @return [String]
+    attr_accessor :checkout_option_name
+
+    # The checkout option value. For example, the checkout option `color` might
+    # be `blue` or `red` while the checkout option `texture` might be `smooth`
+    # or `rippled`.
+    # @return [String]
+    attr_accessor :checkout_option_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['checkout_option_name'] = 'checkout_option_name'
+      @_hash['checkout_option_value'] = 'checkout_option_value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        checkout_option_name
+        checkout_option_value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(checkout_option_name: SKIP, checkout_option_value: SKIP)
+      @checkout_option_name = checkout_option_name unless checkout_option_name == SKIP
+      @checkout_option_value = checkout_option_value unless checkout_option_value == 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.
+      checkout_option_name =
+        hash.key?('checkout_option_name') ? hash['checkout_option_name'] : SKIP
+      checkout_option_value =
+        hash.key?('checkout_option_value') ? hash['checkout_option_value'] : SKIP
+
+      # Create object from extracted values.
+      CheckoutOption.new(checkout_option_name: checkout_option_name,
+                         checkout_option_value: checkout_option_value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} checkout_option_name: #{@checkout_option_name}, checkout_option_value:"\
+      " #{@checkout_option_value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} checkout_option_name: #{@checkout_option_name.inspect},"\
+      " checkout_option_value: #{@checkout_option_value.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/checkout_payment_intent.rb

@@ -0,0 +1,45 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The intent to either capture payment immediately or authorize a payment for
+  # an order after order creation.
+  class CheckoutPaymentIntent
+    CHECKOUT_PAYMENT_INTENT = [
+      # The merchant intends to capture payment immediately after the customer
+      # makes a payment.
+      CAPTURE = 'CAPTURE'.freeze,
+
+      # The merchant intends to authorize a payment and place funds on hold
+      # after the customer makes a payment. Authorized payments are best
+      # captured within three days of authorization but are available to capture
+      # for up to 29 days. After the three-day honor period, the original
+      # authorized payment expires and you must re-authorize the payment. You
+      # must make a separate request to capture payments on demand. This intent
+      # is not supported when you have more than one `purchase_unit` within your
+      # order.
+      AUTHORIZE = 'AUTHORIZE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CAPTURE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'capture' then CAPTURE
+      when 'authorize' then AUTHORIZE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/cobranded_card.rb

@@ -0,0 +1,83 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Details about the merchant cobranded card used for order purchase.
+  class CobrandedCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of labels for the cobranded card.
+    # @return [Array[String]]
+    attr_accessor :labels
+
+    # 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 :payee
+
+    # 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['labels'] = 'labels'
+      @_hash['payee'] = 'payee'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        labels
+        payee
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(labels: SKIP, payee: SKIP, amount: SKIP)
+      @labels = labels unless labels == SKIP
+      @payee = payee unless payee == SKIP
+      @amount = amount unless amount == 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.
+      labels = hash.key?('labels') ? hash['labels'] : SKIP
+      payee = PayeeBase.from_hash(hash['payee']) if hash['payee']
+      amount = Money.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      CobrandedCard.new(labels: labels,
+                        payee: payee,
+                        amount: amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} labels: #{@labels}, payee: #{@payee}, amount: #{@amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} labels: #{@labels.inspect}, payee: #{@payee.inspect}, amount:"\
+      " #{@amount.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/confirm_order_request.rb

@@ -0,0 +1,85 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Payer confirms the intent to pay for the Order using the provided payment
+  # source.
+  class ConfirmOrderRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The payment source definition.
+    # @return [PaymentSource]
+    attr_accessor :payment_source
+
+    # The instruction to process an order.
+    # @return [ProcessingInstruction]
+    attr_accessor :processing_instruction
+
+    # Customizes the payer confirmation experience.
+    # @return [OrderConfirmApplicationContext]
+    attr_accessor :application_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_source'] = 'payment_source'
+      @_hash['processing_instruction'] = 'processing_instruction'
+      @_hash['application_context'] = 'application_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        processing_instruction
+        application_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_source:, processing_instruction: SKIP,
+                   application_context: SKIP)
+      @payment_source = payment_source
+      @processing_instruction = processing_instruction unless processing_instruction == SKIP
+      @application_context = application_context unless application_context == 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.
+      payment_source = PaymentSource.from_hash(hash['payment_source']) if hash['payment_source']
+      processing_instruction =
+        hash.key?('processing_instruction') ? hash['processing_instruction'] : SKIP
+      application_context = OrderConfirmApplicationContext.from_hash(hash['application_context']) if
+        hash['application_context']
+
+      # Create object from extracted values.
+      ConfirmOrderRequest.new(payment_source: payment_source,
+                              processing_instruction: processing_instruction,
+                              application_context: application_context)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_source: #{@payment_source}, processing_instruction:"\
+      " #{@processing_instruction}, application_context: #{@application_context}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_source: #{@payment_source.inspect}, processing_instruction:"\
+      " #{@processing_instruction.inspect}, application_context: #{@application_context.inspect}>"
+    end
+  end
+end