cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/related_identifiers.rb

@@ -0,0 +1,83 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Identifiers related to a specific resource.
+  class RelatedIdentifiers < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Order ID related to the resource.
+    # @return [String]
+    attr_accessor :order_id
+
+    # Authorization ID related to the resource.
+    # @return [String]
+    attr_accessor :authorization_id
+
+    # Capture ID related to the resource.
+    # @return [String]
+    attr_accessor :capture_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'order_id'
+      @_hash['authorization_id'] = 'authorization_id'
+      @_hash['capture_id'] = 'capture_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        authorization_id
+        capture_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id: SKIP, authorization_id: SKIP, capture_id: SKIP)
+      @order_id = order_id unless order_id == SKIP
+      @authorization_id = authorization_id unless authorization_id == SKIP
+      @capture_id = capture_id unless capture_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.
+      order_id = hash.key?('order_id') ? hash['order_id'] : SKIP
+      authorization_id =
+        hash.key?('authorization_id') ? hash['authorization_id'] : SKIP
+      capture_id = hash.key?('capture_id') ? hash['capture_id'] : SKIP
+
+      # Create object from extracted values.
+      RelatedIdentifiers.new(order_id: order_id,
+                             authorization_id: authorization_id,
+                             capture_id: capture_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id}, authorization_id: #{@authorization_id}, capture_id:"\
+      " #{@capture_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id.inspect}, authorization_id:"\
+      " #{@authorization_id.inspect}, capture_id: #{@capture_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/return_flow.rb

@@ -0,0 +1,41 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Merchant preference on how the buyer can navigate back to merchant website
+  # post approving the transaction on the Venmo App.
+  class ReturnFlow
+    RETURN_FLOW = [
+      # After payment approval in the PayPal App, buyer will automatically be
+      # redirected to the merchant website.
+      AUTO = 'AUTO'.freeze,
+
+      # After payment approval in the PayPal App, buyer will be asked to
+      # manually navigate back to the merchant website where they started the
+      # transaction from. The buyer is shown a message like 'Return to Merchant'
+      # to return to the source where the transaction actually started.
+      MANUAL = 'MANUAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = AUTO)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'auto' then AUTO
+      when 'manual' then MANUAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/risk_supplementary_data.rb

@@ -0,0 +1,63 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Additional information necessary to evaluate the risk profile of a
+  # transaction.
+  class RiskSupplementaryData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Profile information of the sender or receiver.
+    # @return [ParticipantMetadata]
+    attr_accessor :customer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer'] = 'customer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer: SKIP)
+      @customer = customer unless customer == 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.
+      customer = ParticipantMetadata.from_hash(hash['customer']) if hash['customer']
+
+      # Create object from extracted values.
+      RiskSupplementaryData.new(customer: customer)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/search_response.rb

@@ -0,0 +1,176 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The search response information.
+  class SearchResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of transaction detail objects.
+    # @return [Array[TransactionDetails]]
+    attr_accessor :transaction_details
+
+    # The merchant account number.
+    # @return [String]
+    attr_accessor :account_number
+
+    # 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 :start_date
+
+    # 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 :end_date
+
+    # 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_refreshed_datetime
+
+    # A zero-relative index of transactions.
+    # @return [Integer]
+    attr_accessor :page
+
+    # The total number of transactions as an integer beginning with the
+    # specified `page` in the full result and not just in this response.
+    # @return [Integer]
+    attr_accessor :total_items
+
+    # The total number of pages, as an `integer`, when the `total_items` is
+    # divided into pages of the specified `page_size`.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # An array of request-related [HATEOAS
+    # links](https://developer.paypal.com/api/rest/responses/#hateoas-links).
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_details'] = 'transaction_details'
+      @_hash['account_number'] = 'account_number'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['last_refreshed_datetime'] = 'last_refreshed_datetime'
+      @_hash['page'] = 'page'
+      @_hash['total_items'] = 'total_items'
+      @_hash['total_pages'] = 'total_pages'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_details
+        account_number
+        start_date
+        end_date
+        last_refreshed_datetime
+        page
+        total_items
+        total_pages
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_details: SKIP, account_number: SKIP,
+                   start_date: SKIP, end_date: SKIP,
+                   last_refreshed_datetime: SKIP, page: SKIP, total_items: SKIP,
+                   total_pages: SKIP, links: SKIP)
+      @transaction_details = transaction_details unless transaction_details == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @last_refreshed_datetime = last_refreshed_datetime unless last_refreshed_datetime == SKIP
+      @page = page unless page == SKIP
+      @total_items = total_items unless total_items == SKIP
+      @total_pages = total_pages unless total_pages == 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.
+      # Parameter is an array, so we need to iterate through it
+      transaction_details = nil
+      unless hash['transaction_details'].nil?
+        transaction_details = []
+        hash['transaction_details'].each do |structure|
+          transaction_details << (TransactionDetails.from_hash(structure) if structure)
+        end
+      end
+
+      transaction_details = SKIP unless hash.key?('transaction_details')
+      account_number =
+        hash.key?('account_number') ? hash['account_number'] : SKIP
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      last_refreshed_datetime =
+        hash.key?('last_refreshed_datetime') ? hash['last_refreshed_datetime'] : SKIP
+      page = hash.key?('page') ? hash['page'] : SKIP
+      total_items = hash.key?('total_items') ? hash['total_items'] : SKIP
+      total_pages = hash.key?('total_pages') ? hash['total_pages'] : 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 object from extracted values.
+      SearchResponse.new(transaction_details: transaction_details,
+                         account_number: account_number,
+                         start_date: start_date,
+                         end_date: end_date,
+                         last_refreshed_datetime: last_refreshed_datetime,
+                         page: page,
+                         total_items: total_items,
+                         total_pages: total_pages,
+                         links: links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_details: #{@transaction_details}, account_number:"\
+      " #{@account_number}, start_date: #{@start_date}, end_date: #{@end_date},"\
+      " last_refreshed_datetime: #{@last_refreshed_datetime}, page: #{@page}, total_items:"\
+      " #{@total_items}, total_pages: #{@total_pages}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_details: #{@transaction_details.inspect}, account_number:"\
+      " #{@account_number.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, last_refreshed_datetime: #{@last_refreshed_datetime.inspect}, page:"\
+      " #{@page.inspect}, total_items: #{@total_items.inspect}, total_pages:"\
+      " #{@total_pages.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/seller_payable_breakdown.rb

@@ -0,0 +1,177 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The breakdown of the refund.
+  class SellerPayableBreakdown < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :gross_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :paypal_fee
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :paypal_fee_in_receivable_currency
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :net_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :net_amount_in_receivable_currency
+
+    # An array of platform or partner fees, commissions, or brokerage fees for
+    # the refund.
+    # @return [Array[PlatformFee]]
+    attr_accessor :platform_fees
+
+    # An array of breakdown values for the net amount. Returned when the
+    # currency of the refund is different from the currency of the PayPal
+    # account where the payee holds their funds.
+    # @return [Array[NetAmountBreakdownItem]]
+    attr_accessor :net_amount_breakdown
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :total_refunded_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['gross_amount'] = 'gross_amount'
+      @_hash['paypal_fee'] = 'paypal_fee'
+      @_hash['paypal_fee_in_receivable_currency'] =
+        'paypal_fee_in_receivable_currency'
+      @_hash['net_amount'] = 'net_amount'
+      @_hash['net_amount_in_receivable_currency'] =
+        'net_amount_in_receivable_currency'
+      @_hash['platform_fees'] = 'platform_fees'
+      @_hash['net_amount_breakdown'] = 'net_amount_breakdown'
+      @_hash['total_refunded_amount'] = 'total_refunded_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        gross_amount
+        paypal_fee
+        paypal_fee_in_receivable_currency
+        net_amount
+        net_amount_in_receivable_currency
+        platform_fees
+        net_amount_breakdown
+        total_refunded_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(gross_amount: SKIP, paypal_fee: SKIP,
+                   paypal_fee_in_receivable_currency: SKIP, net_amount: SKIP,
+                   net_amount_in_receivable_currency: SKIP, platform_fees: SKIP,
+                   net_amount_breakdown: SKIP, total_refunded_amount: SKIP)
+      @gross_amount = gross_amount unless gross_amount == SKIP
+      @paypal_fee = paypal_fee unless paypal_fee == SKIP
+      unless paypal_fee_in_receivable_currency == SKIP
+        @paypal_fee_in_receivable_currency =
+          paypal_fee_in_receivable_currency
+      end
+      @net_amount = net_amount unless net_amount == SKIP
+      unless net_amount_in_receivable_currency == SKIP
+        @net_amount_in_receivable_currency =
+          net_amount_in_receivable_currency
+      end
+      @platform_fees = platform_fees unless platform_fees == SKIP
+      @net_amount_breakdown = net_amount_breakdown unless net_amount_breakdown == SKIP
+      @total_refunded_amount = total_refunded_amount unless total_refunded_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.
+      gross_amount = Money.from_hash(hash['gross_amount']) if hash['gross_amount']
+      paypal_fee = Money.from_hash(hash['paypal_fee']) if hash['paypal_fee']
+      if hash['paypal_fee_in_receivable_currency']
+        paypal_fee_in_receivable_currency = Money.from_hash(hash['paypal_fee_in_receivable_currency'])
+      end
+      net_amount = Money.from_hash(hash['net_amount']) if hash['net_amount']
+      if hash['net_amount_in_receivable_currency']
+        net_amount_in_receivable_currency = Money.from_hash(hash['net_amount_in_receivable_currency'])
+      end
+      # Parameter is an array, so we need to iterate through it
+      platform_fees = nil
+      unless hash['platform_fees'].nil?
+        platform_fees = []
+        hash['platform_fees'].each do |structure|
+          platform_fees << (PlatformFee.from_hash(structure) if structure)
+        end
+      end
+
+      platform_fees = SKIP unless hash.key?('platform_fees')
+      # Parameter is an array, so we need to iterate through it
+      net_amount_breakdown = nil
+      unless hash['net_amount_breakdown'].nil?
+        net_amount_breakdown = []
+        hash['net_amount_breakdown'].each do |structure|
+          net_amount_breakdown << (NetAmountBreakdownItem.from_hash(structure) if structure)
+        end
+      end
+
+      net_amount_breakdown = SKIP unless hash.key?('net_amount_breakdown')
+      total_refunded_amount = Money.from_hash(hash['total_refunded_amount']) if
+        hash['total_refunded_amount']
+
+      # Create object from extracted values.
+      SellerPayableBreakdown.new(gross_amount: gross_amount,
+                                 paypal_fee: paypal_fee,
+                                 paypal_fee_in_receivable_currency: paypal_fee_in_receivable_currency,
+                                 net_amount: net_amount,
+                                 net_amount_in_receivable_currency: net_amount_in_receivable_currency,
+                                 platform_fees: platform_fees,
+                                 net_amount_breakdown: net_amount_breakdown,
+                                 total_refunded_amount: total_refunded_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} gross_amount: #{@gross_amount}, paypal_fee: #{@paypal_fee},"\
+      " paypal_fee_in_receivable_currency: #{@paypal_fee_in_receivable_currency}, net_amount:"\
+      " #{@net_amount}, net_amount_in_receivable_currency: #{@net_amount_in_receivable_currency},"\
+      " platform_fees: #{@platform_fees}, net_amount_breakdown: #{@net_amount_breakdown},"\
+      " total_refunded_amount: #{@total_refunded_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} gross_amount: #{@gross_amount.inspect}, paypal_fee: #{@paypal_fee.inspect},"\
+      " paypal_fee_in_receivable_currency: #{@paypal_fee_in_receivable_currency.inspect},"\
+      " net_amount: #{@net_amount.inspect}, net_amount_in_receivable_currency:"\
+      " #{@net_amount_in_receivable_currency.inspect}, platform_fees: #{@platform_fees.inspect},"\
+      " net_amount_breakdown: #{@net_amount_breakdown.inspect}, total_refunded_amount:"\
+      " #{@total_refunded_amount.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/seller_protection.rb

@@ -0,0 +1,78 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The level of protection offered as defined by [PayPal Seller Protection for
+  # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection)
+  # .
+  class SellerProtection < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether the transaction is eligible for seller protection. For
+    # information, see [PayPal Seller Protection for
+    # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protectio
+    # n).
+    # @return [SellerProtectionStatus]
+    attr_accessor :status
+
+    # An array of conditions that are covered for the transaction.
+    # @return [Array[DisputeCategory]]
+    attr_accessor :dispute_categories
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['dispute_categories'] = 'dispute_categories'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        dispute_categories
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status: SKIP, dispute_categories: SKIP)
+      @status = status unless status == SKIP
+      @dispute_categories = dispute_categories unless dispute_categories == 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
+      dispute_categories =
+        hash.key?('dispute_categories') ? hash['dispute_categories'] : SKIP
+
+      # Create object from extracted values.
+      SellerProtection.new(status: status,
+                           dispute_categories: dispute_categories)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, dispute_categories: #{@dispute_categories}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, dispute_categories:"\
+      " #{@dispute_categories.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/seller_protection_status.rb

@@ -0,0 +1,46 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Indicates whether the transaction is eligible for seller protection. For
+  # information, see [PayPal Seller Protection for
+  # Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection)
+  # .
+  class SellerProtectionStatus
+    SELLER_PROTECTION_STATUS = [
+      # Your PayPal balance remains intact if the customer claims that they did
+      # not receive an item or the account holder claims that they did not
+      # authorize the payment.
+      ELIGIBLE = 'ELIGIBLE'.freeze,
+
+      # Your PayPal balance remains intact if the customer claims that they did
+      # not receive an item.
+      PARTIALLY_ELIGIBLE = 'PARTIALLY_ELIGIBLE'.freeze,
+
+      # This transaction is not eligible for seller protection.
+      NOT_ELIGIBLE = 'NOT_ELIGIBLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ELIGIBLE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'eligible' then ELIGIBLE
+      when 'partially_eligible' then PARTIALLY_ELIGIBLE
+      when 'not_eligible' then NOT_ELIGIBLE
+      else
+        default_value
+      end
+    end
+  end
+end