cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/assurance_details.rb

@@ -0,0 +1,82 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information about cardholder possession validation and cardholder
+  # identification and verifications (ID&V).
+  class AssuranceDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If true, indicates that Cardholder possession validation has been
+    # performed on returned payment credential.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :account_verified
+
+    # If true, indicates that identification and verifications (ID&V) was
+    # performed on the returned payment credential.If false, the same risk-based
+    # authentication can be performed as you would for card transactions. This
+    # risk-based authentication can include, but not limited to, step-up with 3D
+    # Secure protocol if applicable.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :card_holder_authenticated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_verified'] = 'account_verified'
+      @_hash['card_holder_authenticated'] = 'card_holder_authenticated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_verified
+        card_holder_authenticated
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_verified: false, card_holder_authenticated: false)
+      @account_verified = account_verified unless account_verified == SKIP
+      unless card_holder_authenticated == SKIP
+        @card_holder_authenticated =
+          card_holder_authenticated
+      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.
+      account_verified = hash['account_verified'] ||= false
+      card_holder_authenticated = hash['card_holder_authenticated'] ||= false
+
+      # Create object from extracted values.
+      AssuranceDetails.new(account_verified: account_verified,
+                           card_holder_authenticated: card_holder_authenticated)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_verified: #{@account_verified}, card_holder_authenticated:"\
+      " #{@card_holder_authenticated}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_verified: #{@account_verified.inspect}, card_holder_authenticated:"\
+      " #{@card_holder_authenticated.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/auction_information.rb

@@ -0,0 +1,100 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The auction information.
+  class AuctionInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the auction site.
+    # @return [String]
+    attr_accessor :auction_site
+
+    # The auction site URL.
+    # @return [String]
+    attr_accessor :auction_item_site
+
+    # The ID of the buyer who makes the purchase in the auction. This ID might
+    # be different from the payer ID provided for the payment.
+    # @return [String]
+    attr_accessor :auction_buyer_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 :auction_closing_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auction_site'] = 'auction_site'
+      @_hash['auction_item_site'] = 'auction_item_site'
+      @_hash['auction_buyer_id'] = 'auction_buyer_id'
+      @_hash['auction_closing_date'] = 'auction_closing_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        auction_site
+        auction_item_site
+        auction_buyer_id
+        auction_closing_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auction_site: SKIP, auction_item_site: SKIP,
+                   auction_buyer_id: SKIP, auction_closing_date: SKIP)
+      @auction_site = auction_site unless auction_site == SKIP
+      @auction_item_site = auction_item_site unless auction_item_site == SKIP
+      @auction_buyer_id = auction_buyer_id unless auction_buyer_id == SKIP
+      @auction_closing_date = auction_closing_date unless auction_closing_date == 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.
+      auction_site = hash.key?('auction_site') ? hash['auction_site'] : SKIP
+      auction_item_site =
+        hash.key?('auction_item_site') ? hash['auction_item_site'] : SKIP
+      auction_buyer_id =
+        hash.key?('auction_buyer_id') ? hash['auction_buyer_id'] : SKIP
+      auction_closing_date =
+        hash.key?('auction_closing_date') ? hash['auction_closing_date'] : SKIP
+
+      # Create object from extracted values.
+      AuctionInformation.new(auction_site: auction_site,
+                             auction_item_site: auction_item_site,
+                             auction_buyer_id: auction_buyer_id,
+                             auction_closing_date: auction_closing_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auction_site: #{@auction_site}, auction_item_site: #{@auction_item_site},"\
+      " auction_buyer_id: #{@auction_buyer_id}, auction_closing_date: #{@auction_closing_date}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auction_site: #{@auction_site.inspect}, auction_item_site:"\
+      " #{@auction_item_site.inspect}, auction_buyer_id: #{@auction_buyer_id.inspect},"\
+      " auction_closing_date: #{@auction_closing_date.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authentication_response.rb

@@ -0,0 +1,74 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Results of Authentication such as 3D Secure.
+  class AuthenticationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Liability shift indicator. The outcome of the issuer's authentication.
+    # @return [LiabilityShiftIndicator]
+    attr_accessor :liability_shift
+
+    # Results of 3D Secure Authentication.
+    # @return [ThreeDSecureAuthenticationResponse]
+    attr_accessor :three_d_secure
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['liability_shift'] = 'liability_shift'
+      @_hash['three_d_secure'] = 'three_d_secure'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        liability_shift
+        three_d_secure
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(liability_shift: SKIP, three_d_secure: SKIP)
+      @liability_shift = liability_shift unless liability_shift == 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.
+      liability_shift =
+        hash.key?('liability_shift') ? hash['liability_shift'] : SKIP
+      three_d_secure = ThreeDSecureAuthenticationResponse.from_hash(hash['three_d_secure']) if
+        hash['three_d_secure']
+
+      # Create object from extracted values.
+      AuthenticationResponse.new(liability_shift: liability_shift,
+                                 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} liability_shift: #{@liability_shift}, 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} liability_shift: #{@liability_shift.inspect}, three_d_secure:"\
+      " #{@three_d_secure.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authorization.rb

@@ -0,0 +1,211 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The authorized payment transaction.
+  class Authorization < 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
+
+    # 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
+    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
+      ]
+    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)
+      @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
+    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
+
+      # Create object from extracted values.
+      Authorization.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)
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authorization_incomplete_reason.rb

@@ -0,0 +1,36 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The reason why the authorized status is `PENDING`.
+  class AuthorizationIncompleteReason
+    AUTHORIZATION_INCOMPLETE_REASON = [
+      # Authorization is pending manual review.
+      PENDING_REVIEW = 'PENDING_REVIEW'.freeze,
+
+      # Risk Filter set by the payee failed for the transaction.
+      DECLINED_BY_RISK_FRAUD_FILTERS = 'DECLINED_BY_RISK_FRAUD_FILTERS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PENDING_REVIEW)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pending_review' then PENDING_REVIEW
+      when 'declined_by_risk_fraud_filters' then DECLINED_BY_RISK_FRAUD_FILTERS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authorization_status.rb

@@ -0,0 +1,58 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The status for the authorized payment.
+  class AuthorizationStatus
+    AUTHORIZATION_STATUS = [
+      # The authorized payment is created. No captured payments have been made
+      # for this authorized payment.
+      CREATED = 'CREATED'.freeze,
+
+      # The authorized payment has one or more captures against it. The sum of
+      # these captured payments is greater than the amount of the original
+      # authorized payment.
+      CAPTURED = 'CAPTURED'.freeze,
+
+      # PayPal cannot authorize funds for this authorized payment.
+      DENIED = 'DENIED'.freeze,
+
+      # A captured payment was made for the authorized payment for an amount
+      # that is less than the amount of the original authorized payment.
+      PARTIALLY_CAPTURED = 'PARTIALLY_CAPTURED'.freeze,
+
+      # The authorized payment was voided. No more captured payments can be made
+      # against this authorized payment.
+      VOIDED = 'VOIDED'.freeze,
+
+      # The created authorization is in pending state. For more information, see
+      # status.details.
+      PENDING = 'PENDING'.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 'captured' then CAPTURED
+      when 'denied' then DENIED
+      when 'partially_captured' then PARTIALLY_CAPTURED
+      when 'voided' then VOIDED
+      when 'pending' then PENDING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/authorization_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 authorized payment status.
+  class AuthorizationStatusDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason why the authorized status is `PENDING`.
+    # @return [AuthorizationIncompleteReason]
+    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.
+      AuthorizationStatusDetails.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/authorization_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 status fields and status details for an authorized payment.
+  class AuthorizationStatusWithDetails < 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
+
+    # 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 = AuthorizationStatusDetails.from_hash(hash['status_details']) if
+        hash['status_details']
+
+      # Create object from extracted values.
+      AuthorizationStatusWithDetails.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