cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/simple_postal_address_coarse_grained.rb

@@ -0,0 +1,130 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # A simple postal address with coarse-grained fields. Do not use for an
+  # international address. Use for backward compatibility only. Does not contain
+  # phone.
+  class SimplePostalAddressCoarseGrained < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first line of the address. For example, number or street.
+    # @return [String]
+    attr_accessor :line1
+
+    # The second line of the address. For example, suite or apartment number.
+    # @return [String]
+    attr_accessor :line2
+
+    # The city name.
+    # @return [String]
+    attr_accessor :city
+
+    # The [code](/docs/api/reference/state-codes/) for a US state or the
+    # equivalent for other countries. Required for transactions if the address
+    # is in one of these countries:
+    # [Argentina](/docs/api/reference/state-codes/#argentina),
+    # [Brazil](/docs/api/reference/state-codes/#brazil),
+    # [Canada](/docs/api/reference/state-codes/#canada),
+    # [China](/docs/api/reference/state-codes/#china),
+    # [India](/docs/api/reference/state-codes/#india),
+    # [Italy](/docs/api/reference/state-codes/#italy),
+    # [Japan](/docs/api/reference/state-codes/#japan),
+    # [Mexico](/docs/api/reference/state-codes/#mexico),
+    # [Thailand](/docs/api/reference/state-codes/#thailand), or [United
+    # States](/docs/api/reference/state-codes/#usa). Maximum length is 40
+    # single-byte characters.
+    # @return [String]
+    attr_accessor :state
+
+    # The [two-character ISO 3166-1
+    # code](/docs/integration/direct/rest/country-codes/) that identifies the
+    # country or region. Note: The country code for Great Britain is GB and not
+    # UK as used in the top-level domain names for that country. Use the `C2`
+    # country code for China worldwide for comparable uncontrolled price (CUP)
+    # method, bank card, and cross-border transactions.
+    # @return [String]
+    attr_accessor :country_code
+
+    # The postal code, which is the zip code or equivalent. Typically required
+    # for countries with a postal code or an equivalent. See [postal
+    # code](https://en.wikipedia.org/wiki/Postal_code).
+    # @return [String]
+    attr_accessor :postal_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['country_code'] = 'country_code'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line2
+        state
+        postal_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1:, city:, country_code:, line2: SKIP, state: SKIP,
+                   postal_code: SKIP)
+      @line1 = line1
+      @line2 = line2 unless line2 == SKIP
+      @city = city
+      @state = state unless state == SKIP
+      @country_code = country_code
+      @postal_code = postal_code unless postal_code == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      line1 = hash.key?('line1') ? hash['line1'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+
+      # Create object from extracted values.
+      SimplePostalAddressCoarseGrained.new(line1: line1,
+                                           city: city,
+                                           country_code: country_code,
+                                           line2: line2,
+                                           state: state,
+                                           postal_code: postal_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1}, line2: #{@line2}, city: #{@city}, state: #{@state},"\
+      " country_code: #{@country_code}, postal_code: #{@postal_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1.inspect}, line2: #{@line2.inspect}, city: #{@city.inspect},"\
+      " state: #{@state.inspect}, country_code: #{@country_code.inspect}, postal_code:"\
+      " #{@postal_code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/sofort_payment_object.rb

@@ -0,0 +1,99 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information used to pay using Sofort.
+  class SofortPaymentObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) that
+    # identifies the country or region. Note: The country code for Great Britain
+    # is GB and not UK as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.
+    # @return [String]
+    attr_accessor :country_code
+
+    # The business identification code (BIC). In payments systems, a BIC is used
+    # to identify a specific business, most commonly a bank.
+    # @return [String]
+    attr_accessor :bic
+
+    # The last characters of the IBAN used to pay.
+    # @return [String]
+    attr_accessor :iban_last_chars
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['bic'] = 'bic'
+      @_hash['iban_last_chars'] = 'iban_last_chars'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        country_code
+        bic
+        iban_last_chars
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, country_code: SKIP, bic: SKIP,
+                   iban_last_chars: SKIP)
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @bic = bic unless bic == SKIP
+      @iban_last_chars = iban_last_chars unless iban_last_chars == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      country_code = hash.key?('country_code') ? hash['country_code'] : SKIP
+      bic = hash.key?('bic') ? hash['bic'] : SKIP
+      iban_last_chars =
+        hash.key?('iban_last_chars') ? hash['iban_last_chars'] : SKIP
+
+      # Create object from extracted values.
+      SofortPaymentObject.new(name: name,
+                              country_code: country_code,
+                              bic: bic,
+                              iban_last_chars: iban_last_chars)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, country_code: #{@country_code}, bic: #{@bic},"\
+      " iban_last_chars: #{@iban_last_chars}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, country_code: #{@country_code.inspect}, bic:"\
+      " #{@bic.inspect}, iban_last_chars: #{@iban_last_chars.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/sofort_payment_request.rb

@@ -0,0 +1,87 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Information needed to pay using Sofort.
+  class SofortPaymentRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The full name representation like Mr J Smith.
+    # @return [String]
+    attr_accessor :name
+
+    # The [two-character ISO 3166-1
+    # code](https://developer.paypal.com/api/rest/reference/country-codes/) that
+    # identifies the country or region. Note: The country code for Great Britain
+    # is GB and not UK as used in the top-level domain names for that country.
+    # Use the `C2` country code for China worldwide for comparable uncontrolled
+    # price (CUP) method, bank card, and cross-border transactions.
+    # @return [String]
+    attr_accessor :country_code
+
+    # Customizes the payer experience during the approval process for the
+    # payment.
+    # @return [ExperienceContext]
+    attr_accessor :experience_context
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'country_code'
+      @_hash['experience_context'] = 'experience_context'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        experience_context
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, country_code:, experience_context: SKIP)
+      @name = name
+      @country_code = country_code
+      @experience_context = experience_context unless experience_context == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      experience_context = ExperienceContext.from_hash(hash['experience_context']) if
+        hash['experience_context']
+
+      # Create object from extracted values.
+      SofortPaymentRequest.new(name: name,
+                               country_code: country_code,
+                               experience_context: experience_context)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, country_code: #{@country_code}, experience_context:"\
+      " #{@experience_context}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, country_code: #{@country_code.inspect},"\
+      " experience_context: #{@experience_context.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/standard_entry_class_code.rb

@@ -0,0 +1,59 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # NACHA (the regulatory body governing the ACH network) requires that API
+  # callers (merchants, partners) obtain the consumer’s explicit authorization
+  # before initiating a transaction. To stay compliant, you’ll need to make sure
+  # that you retain a compliant authorization for each transaction that you
+  # originate to the ACH Network using this API. ACH transactions are
+  # categorized (using SEC codes) by how you capture authorization from the
+  # Receiver (the person whose bank account is being debited or credited).
+  # PayPal supports the following SEC codes.
+  class StandardEntryClassCode
+    STANDARD_ENTRY_CLASS_CODE = [
+      # The API caller (merchant/partner) accepts authorization and payment
+      # information from a consumer over the telephone.
+      TEL = 'TEL'.freeze,
+
+      # The API caller (merchant/partner) accepts Debit transactions from a
+      # consumer on their website.
+      WEB = 'WEB'.freeze,
+
+      # Cash concentration and disbursement for corporate debit transaction.
+      # Used to disburse or consolidate funds. Entries are usually Optional
+      # high-dollar, low-volume, and time-critical. (e.g. intra-company
+      # transfers or invoice payments to suppliers).
+      CCD = 'CCD'.freeze,
+
+      # Prearranged payment and deposit entries. Used for debit payments
+      # authorized by a consumer account holder, and usually initiated by a
+      # company. These are usually recurring debits (such as insurance
+      # premiums).
+      PPD = 'PPD'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = TEL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'tel' then TEL
+      when 'web' then WEB
+      when 'ccd' then CCD
+      when 'ppd' then PPD
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/store_in_vault_instruction.rb

@@ -0,0 +1,27 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Defines how and when the payment source gets vaulted.
+  class StoreInVaultInstruction
+    STORE_IN_VAULT_INSTRUCTION = [
+      # Defines that the payment_source will be vaulted only when at least one
+      # authorization or capture using that payment_source is successful.
+      ON_SUCCESS = 'ON_SUCCESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ON_SUCCESS)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/paypal_server_sdk/models/store_information.rb

@@ -0,0 +1,71 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The store information.
+  class StoreInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of a store for a merchant in the system of record.
+    # @return [String]
+    attr_accessor :store_id
+
+    # The terminal ID for the checkout stand in a merchant store.
+    # @return [String]
+    attr_accessor :terminal_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['store_id'] = 'store_id'
+      @_hash['terminal_id'] = 'terminal_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        store_id
+        terminal_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(store_id: SKIP, terminal_id: SKIP)
+      @store_id = store_id unless store_id == SKIP
+      @terminal_id = terminal_id unless terminal_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.
+      store_id = hash.key?('store_id') ? hash['store_id'] : SKIP
+      terminal_id = hash.key?('terminal_id') ? hash['terminal_id'] : SKIP
+
+      # Create object from extracted values.
+      StoreInformation.new(store_id: store_id,
+                           terminal_id: terminal_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_id: #{@store_id}, terminal_id: #{@terminal_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} store_id: #{@store_id.inspect}, terminal_id: #{@terminal_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/stored_payment_source.rb

@@ -0,0 +1,111 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Provides additional details to process a payment using a `payment_source`
+  # that has been stored or is intended to be stored (also referred to as
+  # stored_credential or card-on-file). Parameter compatibility:
+  # `payment_type=ONE_TIME` is compatible only with
+  # `payment_initiator=CUSTOMER`. `usage=FIRST` is compatible only with
+  # `payment_initiator=CUSTOMER`. `previous_transaction_reference` or
+  # `previous_network_transaction_reference` is compatible only with
+  # `payment_initiator=MERCHANT`. Only one of the parameters -
+  # `previous_transaction_reference` and
+  # `previous_network_transaction_reference` - can be present in the request.
+  class StoredPaymentSource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The person or party who initiated or triggered the payment.
+    # @return [PaymentInitiator]
+    attr_accessor :payment_initiator
+
+    # Indicates the type of the stored payment_source payment.
+    # @return [StoredPaymentSourcePaymentType]
+    attr_accessor :payment_type
+
+    # Indicates if this is a `first` or `subsequent` payment using a stored
+    # payment source (also referred to as stored credential or card on file).
+    # @return [StoredPaymentSourceUsageType]
+    attr_accessor :usage
+
+    # Reference values used by the card network to identify a transaction.
+    # @return [NetworkTransaction]
+    attr_accessor :previous_network_transaction_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_initiator'] = 'payment_initiator'
+      @_hash['payment_type'] = 'payment_type'
+      @_hash['usage'] = 'usage'
+      @_hash['previous_network_transaction_reference'] =
+        'previous_network_transaction_reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        usage
+        previous_network_transaction_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_initiator:, payment_type:,
+                   usage: StoredPaymentSourceUsageType::DERIVED,
+                   previous_network_transaction_reference: SKIP)
+      @payment_initiator = payment_initiator
+      @payment_type = payment_type
+      @usage = usage unless usage == SKIP
+      unless previous_network_transaction_reference == SKIP
+        @previous_network_transaction_reference =
+          previous_network_transaction_reference
+      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.
+      payment_initiator =
+        hash.key?('payment_initiator') ? hash['payment_initiator'] : nil
+      payment_type = hash.key?('payment_type') ? hash['payment_type'] : nil
+      usage = hash['usage'] ||= StoredPaymentSourceUsageType::DERIVED
+      if hash['previous_network_transaction_reference']
+        previous_network_transaction_reference = NetworkTransaction.from_hash(hash['previous_network_transaction_reference'])
+      end
+
+      # Create object from extracted values.
+      StoredPaymentSource.new(payment_initiator: payment_initiator,
+                              payment_type: payment_type,
+                              usage: usage,
+                              previous_network_transaction_reference: previous_network_transaction_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_initiator: #{@payment_initiator}, payment_type: #{@payment_type},"\
+      " usage: #{@usage}, previous_network_transaction_reference:"\
+      " #{@previous_network_transaction_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payment_initiator: #{@payment_initiator.inspect}, payment_type:"\
+      " #{@payment_type.inspect}, usage: #{@usage.inspect},"\
+      ' previous_network_transaction_reference:'\
+      " #{@previous_network_transaction_reference.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/stored_payment_source_payment_type.rb

@@ -0,0 +1,43 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Indicates the type of the stored payment_source payment.
+  class StoredPaymentSourcePaymentType
+    STORED_PAYMENT_SOURCE_PAYMENT_TYPE = [
+      # One Time payment such as online purchase or donation. (e.g. Checkout
+      # with one-click).
+      ONE_TIME = 'ONE_TIME'.freeze,
+
+      # Payment which is part of a series of payments with fixed or variable
+      # amounts, following a fixed time interval. (e.g. Subscription payments).
+      RECURRING = 'RECURRING'.freeze,
+
+      # Payment which is part of a series of payments that occur on a non-fixed
+      # schedule and/or have variable amounts. (e.g. Account Topup payments).
+      UNSCHEDULED = 'UNSCHEDULED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ONE_TIME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'one_time' then ONE_TIME
+      when 'recurring' then RECURRING
+      when 'unscheduled' then UNSCHEDULED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/stored_payment_source_usage_type.rb

@@ -0,0 +1,44 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Indicates if this is a `first` or `subsequent` payment using a stored
+  # payment source (also referred to as stored credential or card on file).
+  class StoredPaymentSourceUsageType
+    STORED_PAYMENT_SOURCE_USAGE_TYPE = [
+      # Indicates the Initial/First payment with a payment_source that is
+      # intended to be stored upon successful processing of the payment.
+      FIRST = 'FIRST'.freeze,
+
+      # Indicates a payment using a stored payment_source which has been
+      # successfully used previously for a payment.
+      SUBSEQUENT = 'SUBSEQUENT'.freeze,
+
+      # Indicates that PayPal will derive the value of `FIRST` or `SUBSEQUENT`
+      # based on data available to PayPal.
+      DERIVED = 'DERIVED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = FIRST)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'first' then FIRST
+      when 'subsequent' then SUBSEQUENT
+      when 'derived' then DERIVED
+      else
+        default_value
+      end
+    end
+  end
+end