cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/subscriptions_card_attributes.rb

@@ -0,0 +1,83 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Additional attributes associated with the use of this card.
+  class SubscriptionsCardAttributes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The details about a customer in PayPal's system of record.
+    # @return [CardCustomer]
+    attr_accessor :customer
+
+    # Basic vault instruction specification that can be extended by specific
+    # payment sources that supports vaulting.
+    # @return [VaultInstructionBase]
+    attr_accessor :vault
+
+    # The API caller can opt in to verify the card through PayPal offered
+    # verification services (e.g. Smart Dollar Auth, 3DS).
+    # @return [CardVerification]
+    attr_accessor :verification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer'] = 'customer'
+      @_hash['vault'] = 'vault'
+      @_hash['verification'] = 'verification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer
+        vault
+        verification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer: SKIP, vault: SKIP, verification: SKIP)
+      @customer = customer unless customer == SKIP
+      @vault = vault unless vault == SKIP
+      @verification = verification unless verification == 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 = CardCustomer.from_hash(hash['customer']) if hash['customer']
+      vault = VaultInstructionBase.from_hash(hash['vault']) if hash['vault']
+      verification = CardVerification.from_hash(hash['verification']) if hash['verification']
+
+      # Create object from extracted values.
+      SubscriptionsCardAttributes.new(customer: customer,
+                                      vault: vault,
+                                      verification: verification)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer}, vault: #{@vault}, verification: #{@verification}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer.inspect}, vault: #{@vault.inspect}, verification:"\
+      " #{@verification.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/subscriptions_card_brand.rb

@@ -0,0 +1,133 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The card network or brand. Applies to credit, debit, gift, and payment
+  # cards.
+  class SubscriptionsCardBrand
+    SUBSCRIPTIONS_CARD_BRAND = [
+      # Visa card.
+      VISA = 'VISA'.freeze,
+
+      # Mastercard card.
+      MASTERCARD = 'MASTERCARD'.freeze,
+
+      # Discover card.
+      DISCOVER = 'DISCOVER'.freeze,
+
+      # American Express card.
+      AMEX = 'AMEX'.freeze,
+
+      # Solo debit card.
+      SOLO = 'SOLO'.freeze,
+
+      # Japan Credit Bureau card.
+      JCB = 'JCB'.freeze,
+
+      # Military Star card.
+      STAR = 'STAR'.freeze,
+
+      # Delta Airlines card.
+      DELTA = 'DELTA'.freeze,
+
+      # Switch credit card.
+      SWITCH = 'SWITCH'.freeze,
+
+      # Maestro credit card.
+      MAESTRO = 'MAESTRO'.freeze,
+
+      # Carte Bancaire (CB) credit card.
+      CB_NATIONALE = 'CB_NATIONALE'.freeze,
+
+      # Configoga credit card.
+      CONFIGOGA = 'CONFIGOGA'.freeze,
+
+      # Confidis credit card.
+      CONFIDIS = 'CONFIDIS'.freeze,
+
+      # Visa Electron credit card.
+      ELECTRON = 'ELECTRON'.freeze,
+
+      # Cetelem credit card.
+      CETELEM = 'CETELEM'.freeze,
+
+      # China union pay credit card.
+      CHINA_UNION_PAY = 'CHINA_UNION_PAY'.freeze,
+
+      # The Diners Club International banking and payment services capability
+      # network owned by Discover Financial Services (DFS), one of the most
+      # recognized brands in US financial services.
+      DINERS = 'DINERS'.freeze,
+
+      # The Brazilian Elo card payment network.
+      ELO = 'ELO'.freeze,
+
+      # The Hiper - Ingenico ePayment network.
+      HIPER = 'HIPER'.freeze,
+
+      # The Brazilian Hipercard payment network that's widely accepted in the
+      # retail market.
+      HIPERCARD = 'HIPERCARD'.freeze,
+
+      # The RuPay payment network.
+      RUPAY = 'RUPAY'.freeze,
+
+      # The GE Credit Union 3Point card payment network.
+      GE = 'GE'.freeze,
+
+      # The Synchrony Financial (SYF) payment network.
+      SYNCHRONY = 'SYNCHRONY'.freeze,
+
+      # The Electronic Fund Transfer At Point of Sale(EFTPOS) Debit card payment
+      # network.
+      EFTPOS = 'EFTPOS'.freeze,
+
+      # UNKNOWN payment network.
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = VISA)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'visa' then VISA
+      when 'mastercard' then MASTERCARD
+      when 'discover' then DISCOVER
+      when 'amex' then AMEX
+      when 'solo' then SOLO
+      when 'jcb' then JCB
+      when 'star' then STAR
+      when 'delta' then DELTA
+      when 'switch' then SWITCH
+      when 'maestro' then MAESTRO
+      when 'cb_nationale' then CB_NATIONALE
+      when 'configoga' then CONFIGOGA
+      when 'confidis' then CONFIDIS
+      when 'electron' then ELECTRON
+      when 'cetelem' then CETELEM
+      when 'china_union_pay' then CHINA_UNION_PAY
+      when 'diners' then DINERS
+      when 'elo' then ELO
+      when 'hiper' then HIPER
+      when 'hipercard' then HIPERCARD
+      when 'rupay' then RUPAY
+      when 'ge' then GE
+      when 'synchrony' then SYNCHRONY
+      when 'eftpos' then EFTPOS
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/supplementary_data.rb

@@ -0,0 +1,76 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Supplementary data about a payment. This object passes information that can
+  # be used to improve risk assessments and processing costs, for example, by
+  # providing Level 2 and Level 3 payment data.
+  class SupplementaryData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchants and partners can add Level 2 and 3 data to payments to reduce
+    # risk and payment processing costs. For more information about processing
+    # payments, see checkout or multiparty checkout.
+    # @return [CardSupplementaryData]
+    attr_accessor :card
+
+    # Additional information necessary to evaluate the risk profile of a
+    # transaction.
+    # @return [RiskSupplementaryData]
+    attr_accessor :risk
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card'] = 'card'
+      @_hash['risk'] = 'risk'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card
+        risk
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card: SKIP, risk: SKIP)
+      @card = card unless card == SKIP
+      @risk = risk unless risk == 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 = CardSupplementaryData.from_hash(hash['card']) if hash['card']
+      risk = RiskSupplementaryData.from_hash(hash['risk']) if hash['risk']
+
+      # Create object from extracted values.
+      SupplementaryData.new(card: card,
+                            risk: risk)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card}, risk: #{@risk}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card: #{@card.inspect}, risk: #{@risk.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/suspend_subscription.rb

@@ -0,0 +1,60 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The suspend subscription request details.
+  class SuspendSubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for suspension of the Subscription.
+    # @return [String]
+    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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason:)
+      @reason = reason
+    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'] : nil
+
+      # Create object from extracted values.
+      SuspendSubscription.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/tax_amount.rb

@@ -0,0 +1,63 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The tax levied by a government on the purchase of goods or services.
+  class TaxAmount < 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 :tax_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_amount: SKIP)
+      @tax_amount = tax_amount unless tax_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.
+      tax_amount = Money.from_hash(hash['tax_amount']) if hash['tax_amount']
+
+      # Create object from extracted values.
+      TaxAmount.new(tax_amount: tax_amount)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tax_amount: #{@tax_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tax_amount: #{@tax_amount.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/tax_id_type.rb

@@ -0,0 +1,36 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The customer's tax ID type.
+  class TaxIdType
+    TAX_ID_TYPE = [
+      # The individual tax ID type, typically is 11 characters long.
+      BR_CPF = 'BR_CPF'.freeze,
+
+      # The business tax ID type, typically is 14 characters long.
+      BR_CNPJ = 'BR_CNPJ'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = BR_CPF)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'br_cpf' then BR_CPF
+      when 'br_cnpj' then BR_CNPJ
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/tax_info.rb

@@ -0,0 +1,69 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The tax ID of the customer. The customer is also known as the payer. Both
+  # `tax_id` and `tax_id_type` are required.
+  class TaxInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The customer's tax ID value.
+    # @return [String]
+    attr_accessor :tax_id
+
+    # The customer's tax ID type.
+    # @return [TaxIdType]
+    attr_accessor :tax_id_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_id'] = 'tax_id'
+      @_hash['tax_id_type'] = 'tax_id_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_id:, tax_id_type:)
+      @tax_id = tax_id
+      @tax_id_type = tax_id_type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      tax_id = hash.key?('tax_id') ? hash['tax_id'] : nil
+      tax_id_type = hash.key?('tax_id_type') ? hash['tax_id_type'] : nil
+
+      # Create object from extracted values.
+      TaxInfo.new(tax_id: tax_id,
+                  tax_id_type: tax_id_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tax_id: #{@tax_id}, tax_id_type: #{@tax_id_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} tax_id: #{@tax_id.inspect}, tax_id_type: #{@tax_id_type.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/taxes.rb

@@ -0,0 +1,71 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The tax details.
+  class Taxes < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The percentage, as a fixed-point, signed decimal number. For example,
+    # define a 19.99% interest rate as `19.99`.
+    # @return [String]
+    attr_accessor :percentage
+
+    # Indicates whether the tax was already included in the billing amount.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :inclusive
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['percentage'] = 'percentage'
+      @_hash['inclusive'] = 'inclusive'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        inclusive
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(percentage:, inclusive: true)
+      @percentage = percentage
+      @inclusive = inclusive unless inclusive == 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.
+      percentage = hash.key?('percentage') ? hash['percentage'] : nil
+      inclusive = hash['inclusive'] ||= true
+
+      # Create object from extracted values.
+      Taxes.new(percentage: percentage,
+                inclusive: inclusive)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percentage: #{@percentage}, inclusive: #{@inclusive}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percentage: #{@percentage.inspect}, inclusive: #{@inclusive.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/taxes_override.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The tax details.
+  class TaxesOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The percentage, as a fixed-point, signed decimal number. For example,
+    # define a 19.99% interest rate as `19.99`.
+    # @return [String]
+    attr_accessor :percentage
+
+    # Indicates whether the tax was already included in the billing amount.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :inclusive
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['percentage'] = 'percentage'
+      @_hash['inclusive'] = 'inclusive'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        percentage
+        inclusive
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(percentage: SKIP, inclusive: SKIP)
+      @percentage = percentage unless percentage == SKIP
+      @inclusive = inclusive unless inclusive == 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.
+      percentage = hash.key?('percentage') ? hash['percentage'] : SKIP
+      inclusive = hash.key?('inclusive') ? hash['inclusive'] : SKIP
+
+      # Create object from extracted values.
+      TaxesOverride.new(percentage: percentage,
+                        inclusive: inclusive)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percentage: #{@percentage}, inclusive: #{@inclusive}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} percentage: #{@percentage.inspect}, inclusive: #{@inclusive.inspect}>"
+    end
+  end
+end