cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/mybank_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 MyBank.
+  class MybankPaymentRequest < 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.
+      MybankPaymentRequest.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/name.rb

@@ -0,0 +1,73 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The name of the party.
+  class Name < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the party is a person, the party's given, or first, name.
+    # @return [String]
+    attr_accessor :given_name
+
+    # When the party is a person, the party's surname or family name. Also known
+    # as the last name. Required when the party is a person. Use also to store
+    # multiple surnames including the matronymic, or mother's, surname.
+    # @return [String]
+    attr_accessor :surname
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['given_name'] = 'given_name'
+      @_hash['surname'] = 'surname'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        given_name
+        surname
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(given_name: SKIP, surname: SKIP)
+      @given_name = given_name unless given_name == SKIP
+      @surname = surname unless surname == 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.
+      given_name = hash.key?('given_name') ? hash['given_name'] : SKIP
+      surname = hash.key?('surname') ? hash['surname'] : SKIP
+
+      # Create object from extracted values.
+      Name.new(given_name: given_name,
+               surname: surname)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} given_name: #{@given_name}, surname: #{@surname}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} given_name: #{@given_name.inspect}, surname: #{@surname.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/native_app_context.rb

@@ -0,0 +1,72 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Merchant provided, buyer's native app preferences to app switch to the
+  # PayPal consumer app.
+  class NativeAppContext < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Operating System type of the device that the buyer is using.
+    # @return [OsType]
+    attr_accessor :os_type
+
+    # Operating System version of the device that the buyer is using.
+    # @return [String]
+    attr_accessor :os_version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['os_type'] = 'os_type'
+      @_hash['os_version'] = 'os_version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        os_type
+        os_version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(os_type: SKIP, os_version: SKIP)
+      @os_type = os_type unless os_type == SKIP
+      @os_version = os_version unless os_version == 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.
+      os_type = hash.key?('os_type') ? hash['os_type'] : SKIP
+      os_version = hash.key?('os_version') ? hash['os_version'] : SKIP
+
+      # Create object from extracted values.
+      NativeAppContext.new(os_type: os_type,
+                           os_version: os_version)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} os_type: #{@os_type}, os_version: #{@os_version}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} os_type: #{@os_type.inspect}, os_version: #{@os_version.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/net_amount_breakdown_item.rb

@@ -0,0 +1,87 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The net amount. Returned when the currency of the refund is different from
+  # the currency of the PayPal account where the merchant holds their funds.
+  class NetAmountBreakdownItem < 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 :payable_amount
+
+    # The currency and amount for a financial transaction, such as a balance or
+    # payment due.
+    # @return [Money]
+    attr_accessor :converted_amount
+
+    # The exchange rate that determines the amount to convert from one currency
+    # to another currency.
+    # @return [ExchangeRate]
+    attr_accessor :exchange_rate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payable_amount'] = 'payable_amount'
+      @_hash['converted_amount'] = 'converted_amount'
+      @_hash['exchange_rate'] = 'exchange_rate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payable_amount
+        converted_amount
+        exchange_rate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payable_amount: SKIP, converted_amount: SKIP,
+                   exchange_rate: SKIP)
+      @payable_amount = payable_amount unless payable_amount == SKIP
+      @converted_amount = converted_amount unless converted_amount == SKIP
+      @exchange_rate = exchange_rate unless exchange_rate == 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.
+      payable_amount = Money.from_hash(hash['payable_amount']) if hash['payable_amount']
+      converted_amount = Money.from_hash(hash['converted_amount']) if hash['converted_amount']
+      exchange_rate = ExchangeRate.from_hash(hash['exchange_rate']) if hash['exchange_rate']
+
+      # Create object from extracted values.
+      NetAmountBreakdownItem.new(payable_amount: payable_amount,
+                                 converted_amount: converted_amount,
+                                 exchange_rate: exchange_rate)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payable_amount: #{@payable_amount}, converted_amount: #{@converted_amount},"\
+      " exchange_rate: #{@exchange_rate}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payable_amount: #{@payable_amount.inspect}, converted_amount:"\
+      " #{@converted_amount.inspect}, exchange_rate: #{@exchange_rate.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/network_token.rb

@@ -0,0 +1,110 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The Third Party Network token used to fund a payment.
+  class NetworkToken < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Third party network token number.
+    # @return [String]
+    attr_accessor :number
+
+    # The year and month, in ISO-8601 `YYYY-MM` date format. See [Internet date
+    # and time format](https://tools.ietf.org/html/rfc3339#section-5.6).
+    # @return [String]
+    attr_accessor :expiry
+
+    # An Encrypted one-time use value that's sent along with Network Token. This
+    # field is not required to be present for recurring transactions.
+    # @return [String]
+    attr_accessor :cryptogram
+
+    # Electronic Commerce Indicator (ECI). The ECI value is part of the 2 data
+    # elements that indicate the transaction was processed electronically. This
+    # should be passed on the authorization transaction to the
+    # Gateway/Processor.
+    # @return [EciFlag]
+    attr_accessor :eci_flag
+
+    # A TRID, or a Token Requestor ID, is an identifier used by merchants to
+    # request network tokens from card networks. A TRID is a precursor to
+    # obtaining a network token for a credit card primary account number (PAN),
+    # and will aid in enabling secure card on file (COF) payments and reducing
+    # fraud.
+    # @return [String]
+    attr_accessor :token_requestor_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['expiry'] = 'expiry'
+      @_hash['cryptogram'] = 'cryptogram'
+      @_hash['eci_flag'] = 'eci_flag'
+      @_hash['token_requestor_id'] = 'token_requestor_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cryptogram
+        eci_flag
+        token_requestor_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number:, expiry:, cryptogram: SKIP, eci_flag: SKIP,
+                   token_requestor_id: SKIP)
+      @number = number
+      @expiry = expiry
+      @cryptogram = cryptogram unless cryptogram == SKIP
+      @eci_flag = eci_flag unless eci_flag == SKIP
+      @token_requestor_id = token_requestor_id unless token_requestor_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.
+      number = hash.key?('number') ? hash['number'] : nil
+      expiry = hash.key?('expiry') ? hash['expiry'] : nil
+      cryptogram = hash.key?('cryptogram') ? hash['cryptogram'] : SKIP
+      eci_flag = hash.key?('eci_flag') ? hash['eci_flag'] : SKIP
+      token_requestor_id =
+        hash.key?('token_requestor_id') ? hash['token_requestor_id'] : SKIP
+
+      # Create object from extracted values.
+      NetworkToken.new(number: number,
+                       expiry: expiry,
+                       cryptogram: cryptogram,
+                       eci_flag: eci_flag,
+                       token_requestor_id: token_requestor_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number}, expiry: #{@expiry}, cryptogram: #{@cryptogram},"\
+      " eci_flag: #{@eci_flag}, token_requestor_id: #{@token_requestor_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, expiry: #{@expiry.inspect}, cryptogram:"\
+      " #{@cryptogram.inspect}, eci_flag: #{@eci_flag.inspect}, token_requestor_id:"\
+      " #{@token_requestor_id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/network_transaction.rb

@@ -0,0 +1,107 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Reference values used by the card network to identify a transaction.
+  class NetworkTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction reference id returned by the scheme. For Visa and Amex, this
+    # is the "Tran id" field in response. For MasterCard, this is the "BankNet
+    # reference id" field in response. For Discover, this is the "NRID" field in
+    # response. The pattern we expect for this field from Visa/Amex/CB/Discover
+    # is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric
+    # with special character -.
+    # @return [String]
+    attr_accessor :id
+
+    # The date that the transaction was authorized by the scheme. This field may
+    # not be returned for all networks. MasterCard refers to this field as
+    # "BankNet reference date". For some specific networks, such as MasterCard
+    # and Discover, this date field is mandatory when the
+    # `previous_network_transaction_reference_id` is passed.
+    # @return [String]
+    attr_accessor :date
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :network
+
+    # Reference ID issued for the card transaction. This ID can be used to track
+    # the transaction across processors, card brands and issuing banks.
+    # @return [String]
+    attr_accessor :acquirer_reference_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['date'] = 'date'
+      @_hash['network'] = 'network'
+      @_hash['acquirer_reference_number'] = 'acquirer_reference_number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        date
+        network
+        acquirer_reference_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, date: SKIP, network: SKIP,
+                   acquirer_reference_number: SKIP)
+      @id = id unless id == SKIP
+      @date = date unless date == SKIP
+      @network = network unless network == SKIP
+      unless acquirer_reference_number == SKIP
+        @acquirer_reference_number =
+          acquirer_reference_number
+      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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      date = hash.key?('date') ? hash['date'] : SKIP
+      network = hash.key?('network') ? hash['network'] : SKIP
+      acquirer_reference_number =
+        hash.key?('acquirer_reference_number') ? hash['acquirer_reference_number'] : SKIP
+
+      # Create object from extracted values.
+      NetworkTransaction.new(id: id,
+                             date: date,
+                             network: network,
+                             acquirer_reference_number: acquirer_reference_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, date: #{@date}, network: #{@network},"\
+      " acquirer_reference_number: #{@acquirer_reference_number}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, date: #{@date.inspect}, network: #{@network.inspect},"\
+      " acquirer_reference_number: #{@acquirer_reference_number.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/network_transaction_reference_entity.rb

@@ -0,0 +1,100 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Previous network transaction reference including id and network.
+  class NetworkTransactionReferenceEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Transaction reference id returned by the scheme. For Visa and Amex, this
+    # is the "Tran id" field in response. For MasterCard, this is the "BankNet
+    # reference id" field in response. For Discover, this is the "NRID" field in
+    # response. The pattern we expect for this field from Visa/Amex/CB/Discover
+    # is numeric, Mastercard/BNPP is alphanumeric and Paysecure is alphanumeric
+    # with special character -.
+    # @return [String]
+    attr_accessor :id
+
+    # The date that the transaction was authorized by the scheme. This field may
+    # not be returned for all networks. MasterCard refers to this field as
+    # "BankNet reference date.
+    # @return [String]
+    attr_accessor :date
+
+    # The card network or brand. Applies to credit, debit, gift, and payment
+    # cards.
+    # @return [CardBrand]
+    attr_accessor :network
+
+    # 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 :time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['date'] = 'date'
+      @_hash['network'] = 'network'
+      @_hash['time'] = 'time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date
+        network
+        time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, date: SKIP, network: SKIP, time: SKIP)
+      @id = id
+      @date = date unless date == SKIP
+      @network = network unless network == SKIP
+      @time = time unless 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      date = hash.key?('date') ? hash['date'] : SKIP
+      network = hash.key?('network') ? hash['network'] : SKIP
+      time = hash.key?('time') ? hash['time'] : SKIP
+
+      # Create object from extracted values.
+      NetworkTransactionReferenceEntity.new(id: id,
+                                            date: date,
+                                            network: network,
+                                            time: time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, date: #{@date}, network: #{@network}, time: #{@time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, date: #{@date.inspect}, network: #{@network.inspect},"\
+      " time: #{@time.inspect}>"
+    end
+  end
+end