cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/payment_token_request_payment_source.rb

@@ -0,0 +1,71 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment method to vault with the instrument details.
+  class PaymentTokenRequestPaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A Resource representing a request to vault a Card.
+    # @return [PaymentTokenRequestCard]
+    attr_accessor :card
+
+    # The Tokenized Payment Source representing a Request to Vault a Token.
+    # @return [VaultTokenRequest]
+    attr_accessor :token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['token'] = 'token'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        token
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, token: SKIP)
+      @card = card unless card == SKIP
+      @token = token unless token == 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.
+      card = PaymentTokenRequestCard.from_hash(hash['card']) if hash['card']
+      token = VaultTokenRequest.from_hash(hash['token']) if hash['token']
+
+      # Create object from extracted values.
+      PaymentTokenRequestPaymentSource.new(card: card,
+                                           token: token)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}, token: #{@token}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}, token: #{@token.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_token_response.rb

@@ -0,0 +1,104 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Full representation of a saved payment token.
+  class PaymentTokenResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal-generated ID for the vaulted payment source. This ID should be
+    # stored on the merchant's server so the saved payment source can be used
+    # for future transactions.
+    # @return [String]
+    attr_accessor :id
+
+    # Customer in merchant's or partner's system of records.
+    # @return [CustomerResponse]
+    attr_accessor :customer
+
+    # The vaulted payment method details.
+    # @return [PaymentTokenResponsePaymentSource]
+    attr_accessor :payment_source
+
+    # An array of related [HATEOAS
+    # links](https://developer.paypal.com/api/rest/responses/#hateoas).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['customer'] = 'customer'
+      @_hash['payment_source'] = 'payment_source'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        customer
+        payment_source
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, customer: SKIP, payment_source: SKIP, links: SKIP)
+      @id = id unless id == SKIP
+      @customer = customer unless customer == SKIP
+      @payment_source = payment_source unless payment_source == SKIP
+      @links = links unless links == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      customer = CustomerResponse.from_hash(hash['customer']) if hash['customer']
+      payment_source = PaymentTokenResponsePaymentSource.from_hash(hash['payment_source']) if
+        hash['payment_source']
+      # 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 object from extracted values.
+      PaymentTokenResponse.new(id: id,
+                               customer: customer,
+                               payment_source: payment_source,
+                               links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, customer: #{@customer}, payment_source: #{@payment_source},"\
+      " links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, customer: #{@customer.inspect}, payment_source:"\
+      " #{@payment_source.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_token_response_payment_source.rb

@@ -0,0 +1,91 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The vaulted payment method details.
+  class PaymentTokenResponsePaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Full representation of a Card Payment Token including network token.
+    # @return [CardPaymentTokenEntity]
+    attr_accessor :card
+
+    # Full representation of a PayPal Payment Token.
+    # @return [PaypalPaymentToken]
+    attr_accessor :paypal
+
+    # Full representation of a Venmo Payment Token.
+    # @return [VenmoPaymentToken]
+    attr_accessor :venmo
+
+    # A resource representing a response for Apple Pay.
+    # @return [ApplePayPaymentToken]
+    attr_accessor :apple_pay
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['paypal'] = 'paypal'
+      @_hash['venmo'] = 'venmo'
+      @_hash['apple_pay'] = 'apple_pay'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        paypal
+        venmo
+        apple_pay
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, paypal: SKIP, venmo: SKIP, apple_pay: SKIP)
+      @card = card unless card == SKIP
+      @paypal = paypal unless paypal == SKIP
+      @venmo = venmo unless venmo == SKIP
+      @apple_pay = apple_pay unless apple_pay == 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.
+      card = CardPaymentTokenEntity.from_hash(hash['card']) if hash['card']
+      paypal = PaypalPaymentToken.from_hash(hash['paypal']) if hash['paypal']
+      venmo = VenmoPaymentToken.from_hash(hash['venmo']) if hash['venmo']
+      apple_pay = ApplePayPaymentToken.from_hash(hash['apple_pay']) if hash['apple_pay']
+
+      # Create object from extracted values.
+      PaymentTokenResponsePaymentSource.new(card: card,
+                                            paypal: paypal,
+                                            venmo: venmo,
+                                            apple_pay: apple_pay)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}, paypal: #{@paypal}, venmo: #{@venmo}, apple_pay:"\
+      " #{@apple_pay}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}, paypal: #{@paypal.inspect}, venmo:"\
+      " #{@venmo.inspect}, apple_pay: #{@apple_pay.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payment_token_status.rb

@@ -0,0 +1,52 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The status of the payment token.
+  class PaymentTokenStatus
+    PAYMENT_TOKEN_STATUS = [
+      # A setup token is initialized with minimal information, more data must be
+      # added to the setup-token to be vaulted
+      CREATED = 'CREATED'.freeze,
+
+      # A contingency on payer approval is required before the payment method
+      # can be saved.
+      PAYER_ACTION_REQUIRED = 'PAYER_ACTION_REQUIRED'.freeze,
+
+      # Setup token is ready to be vaulted. If a buyer approval contigency was
+      # returned, it is has been approved.
+      APPROVED = 'APPROVED'.freeze,
+
+      # The payment token has been vaulted.
+      VAULTED = 'VAULTED'.freeze,
+
+      # A vaulted payment method token has been tokenized for short term (one
+      # time) use.
+      TOKENIZED = 'TOKENIZED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CREATED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'created' then CREATED
+      when 'payer_action_required' then PAYER_ACTION_REQUIRED
+      when 'approved' then APPROVED
+      when 'vaulted' then VAULTED
+      when 'tokenized' then TOKENIZED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/payments_capture.rb

@@ -0,0 +1,252 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A captured payment.
+  class PaymentsCapture < 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 [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
+
+    # 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. 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['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 = NetworkTransaction.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.
+      PaymentsCapture.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
+
+    # 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}, 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
+
+    # 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}, final_capture: #{@final_capture.inspect},"\
+      " seller_receivable_breakdown: #{@seller_receivable_breakdown.inspect}, disbursement_mode:"\
+      " #{@disbursement_mode.inspect}, links: #{@links.inspect}, processor_response:"\
+      " #{@processor_response.inspect}, create_time: #{@create_time.inspect}, update_time:"\
+      " #{@update_time.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_experience_landing_page.rb

@@ -0,0 +1,56 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The type of landing page to show on the PayPal site for customer checkout.
+  class PaypalExperienceLandingPage
+    PAYPAL_EXPERIENCE_LANDING_PAGE = [
+      # When the customer clicks PayPal Checkout, the customer is redirected to
+      # a page to log in to PayPal and approve the payment.
+      LOGIN = 'LOGIN'.freeze,
+
+      # When the customer clicks PayPal Checkout, the customer is redirected to
+      # a page to enter credit or debit card and other relevant billing
+      # information required to complete the purchase. This option has
+      # previously been also called as 'BILLING'
+      GUEST_CHECKOUT = 'GUEST_CHECKOUT'.freeze,
+
+      # When the customer clicks PayPal Checkout, the customer is redirected to
+      # either a page to log in to PayPal and approve the payment or to a page
+      # to enter credit or debit card and other relevant billing information
+      # required to complete the purchase, depending on their previous
+      # interaction with PayPal.
+      NO_PREFERENCE = 'NO_PREFERENCE'.freeze,
+
+      # DEPRECATED - please use GUEST_CHECKOUT. All implementations of 'BILLING'
+      # will be routed to 'GUEST_CHECKOUT'. When the customer clicks PayPal
+      # Checkout, the customer is redirected to a page to enter credit or debit
+      # card and other relevant billing information required to complete the
+      # purchase.
+      BILLING = 'BILLING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = LOGIN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'login' then LOGIN
+      when 'guest_checkout' then GUEST_CHECKOUT
+      when 'no_preference' then NO_PREFERENCE
+      when 'billing' then BILLING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/paypal_experience_user_action.rb

@@ -0,0 +1,42 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Configures a Continue or Pay Now checkout flow.
+  class PaypalExperienceUserAction
+    PAYPAL_EXPERIENCE_USER_ACTION = [
+      # After you redirect the customer to the PayPal payment page, a Continue
+      # button appears. Use this option when the final amount is not known when
+      # the checkout flow is initiated and you want to redirect the customer to
+      # the merchant page without processing the payment.
+      CONTINUE = 'CONTINUE'.freeze,
+
+      # After you redirect the customer to the PayPal payment page, a Pay Now
+      # button appears. Use this option when the final amount is known when the
+      # checkout is initiated and you want to process the payment immediately
+      # when the customer clicks Pay Now.
+      PAY_NOW = 'PAY_NOW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CONTINUE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'continue' then CONTINUE
+      when 'pay_now' then PAY_NOW
+      else
+        default_value
+      end
+    end
+  end
+end