cli-sdk 1.0.0 → 10.0.1

data/lib/paypal_server_sdk/models/card_response_address.rb

@@ -0,0 +1,137 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Address request details.
+  class CardResponseAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first line of the address, such as number and street, for example,
+    # `173 Drury Lane`. Needed for data entry, and Compliance and Risk checks.
+    # This field needs to pass the full address.
+    # @return [String]
+    attr_accessor :address_line_1
+
+    # The second line of the address, for example, a suite or apartment number.
+    # @return [String]
+    attr_accessor :address_line_2
+
+    # A city, town, or village. Smaller than `admin_area_level_1`.
+    # @return [String]
+    attr_accessor :admin_area_2
+
+    # The highest-level sub-division in a country, which is usually a province,
+    # state, or ISO-3166-2 subdivision. This data is formatted for postal
+    # delivery, for example, `CA` and not `California`. Value, by country, is:
+    # UK. A county. US. A state. Canada. A province. Japan. A prefecture.
+    # Switzerland. A *kanton*.
+    # @return [String]
+    attr_accessor :admin_area_1
+
+    # 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
+
+    # The [2-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 resource ID of the address.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_line_1'] = 'address_line_1'
+      @_hash['address_line_2'] = 'address_line_2'
+      @_hash['admin_area_2'] = 'admin_area_2'
+      @_hash['admin_area_1'] = 'admin_area_1'
+      @_hash['postal_code'] = 'postal_code'
+      @_hash['country_code'] = 'country_code'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address_line_1
+        address_line_2
+        admin_area_2
+        admin_area_1
+        postal_code
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code:, address_line_1: SKIP, address_line_2: SKIP,
+                   admin_area_2: SKIP, admin_area_1: SKIP, postal_code: SKIP,
+                   id: SKIP)
+      @address_line_1 = address_line_1 unless address_line_1 == SKIP
+      @address_line_2 = address_line_2 unless address_line_2 == SKIP
+      @admin_area_2 = admin_area_2 unless admin_area_2 == SKIP
+      @admin_area_1 = admin_area_1 unless admin_area_1 == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country_code = country_code
+      @id = id unless 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.
+      country_code = hash.key?('country_code') ? hash['country_code'] : nil
+      address_line_1 =
+        hash.key?('address_line_1') ? hash['address_line_1'] : SKIP
+      address_line_2 =
+        hash.key?('address_line_2') ? hash['address_line_2'] : SKIP
+      admin_area_2 = hash.key?('admin_area_2') ? hash['admin_area_2'] : SKIP
+      admin_area_1 = hash.key?('admin_area_1') ? hash['admin_area_1'] : SKIP
+      postal_code = hash.key?('postal_code') ? hash['postal_code'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      CardResponseAddress.new(country_code: country_code,
+                              address_line_1: address_line_1,
+                              address_line_2: address_line_2,
+                              admin_area_2: admin_area_2,
+                              admin_area_1: admin_area_1,
+                              postal_code: postal_code,
+                              id: id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address_line_1: #{@address_line_1}, address_line_2: #{@address_line_2},"\
+      " admin_area_2: #{@admin_area_2}, admin_area_1: #{@admin_area_1}, postal_code:"\
+      " #{@postal_code}, country_code: #{@country_code}, id: #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address_line_1: #{@address_line_1.inspect}, address_line_2:"\
+      " #{@address_line_2.inspect}, admin_area_2: #{@admin_area_2.inspect}, admin_area_1:"\
+      " #{@admin_area_1.inspect}, postal_code: #{@postal_code.inspect}, country_code:"\
+      " #{@country_code.inspect}, id: #{@id.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_response_with_billing_address.rb

@@ -0,0 +1,101 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The payment card used to fund the payment. Card can be a credit or debit
+  # card.
+  class CardResponseWithBillingAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card holder's name as it appears on the card.
+    # @return [String]
+    attr_accessor :name
+
+    # The portable international postal address. Maps to
+    # [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/
+    # wiki/AddressValidationMetadata) and HTML 5.1 [Autofilling form controls:
+    # the autocomplete
+    # attribute](https://www.w3.org/TR/html51/sec-forms.html#autofilling-form-co
+    # ntrols-the-autocomplete-attribute).
+    # @return [Address]
+    attr_accessor :billing_address
+
+    # 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
+
+    # The [three-character ISO-4217 currency
+    # code](https://developer.paypal.com/api/rest/reference/currency-codes/)
+    # that identifies the currency.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['expiry'] = 'expiry'
+      @_hash['currency_code'] = 'currency_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        billing_address
+        expiry
+        currency_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, billing_address: SKIP, expiry: SKIP,
+                   currency_code: SKIP)
+      @name = name unless name == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @expiry = expiry unless expiry == SKIP
+      @currency_code = currency_code unless currency_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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      billing_address = Address.from_hash(hash['billing_address']) if hash['billing_address']
+      expiry = hash.key?('expiry') ? hash['expiry'] : SKIP
+      currency_code = hash.key?('currency_code') ? hash['currency_code'] : SKIP
+
+      # Create object from extracted values.
+      CardResponseWithBillingAddress.new(name: name,
+                                         billing_address: billing_address,
+                                         expiry: expiry,
+                                         currency_code: currency_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, billing_address: #{@billing_address}, expiry: #{@expiry},"\
+      " currency_code: #{@currency_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, billing_address: #{@billing_address.inspect},"\
+      " expiry: #{@expiry.inspect}, currency_code: #{@currency_code.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_stored_credential.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 `card` 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 CardStoredCredential < 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.
+      CardStoredCredential.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/card_supplementary_data.rb

@@ -0,0 +1,79 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # 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.
+  class CardSupplementaryData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The level 2 card processing data collections. If your merchant account has
+    # been configured for Level 2 processing this field will be passed to the
+    # processor on your behalf. Please contact your PayPal Technical Account
+    # Manager to define level 2 data for your business.
+    # @return [Level2CardProcessingData]
+    attr_accessor :level_2
+
+    # The level 3 card processing data collections, If your merchant account has
+    # been configured for Level 3 processing this field will be passed to the
+    # processor on your behalf. Please contact your PayPal Technical Account
+    # Manager to define level 3 data for your business.
+    # @return [Level3CardProcessingData]
+    attr_accessor :level_3
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['level_2'] = 'level_2'
+      @_hash['level_3'] = 'level_3'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        level_2
+        level_3
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(level_2: SKIP, level_3: SKIP)
+      @level_2 = level_2 unless level_2 == SKIP
+      @level_3 = level_3 unless level_3 == 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.
+      level_2 = Level2CardProcessingData.from_hash(hash['level_2']) if hash['level_2']
+      level_3 = Level3CardProcessingData.from_hash(hash['level_3']) if hash['level_3']
+
+      # Create object from extracted values.
+      CardSupplementaryData.new(level_2: level_2,
+                                level_3: level_3)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} level_2: #{@level_2}, level_3: #{@level_3}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} level_2: #{@level_2.inspect}, level_3: #{@level_3.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_type.rb

@@ -0,0 +1,48 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # Type of card. i.e Credit, Debit and so on.
+  class CardType
+    CARD_TYPE = [
+      # A credit card.
+      CREDIT = 'CREDIT'.freeze,
+
+      # A debit card.
+      DEBIT = 'DEBIT'.freeze,
+
+      # A Prepaid card.
+      PREPAID = 'PREPAID'.freeze,
+
+      # A store card.
+      STORE = 'STORE'.freeze,
+
+      # Card type cannot be determined.
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      when 'prepaid' then PREPAID
+      when 'store' then STORE
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_vault_response.rb

@@ -0,0 +1,99 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The details about a saved Card payment source.
+  class CardVaultResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The PayPal-generated ID for the saved payment source.
+    # @return [String]
+    attr_accessor :id
+
+    # The vault status.
+    # @return [VaultStatus]
+    attr_accessor :status
+
+    # An array of request-related HATEOAS links.
+    # @return [Array[LinkDescription]]
+    attr_accessor :links
+
+    # The details about a customer in PayPal's system of record.
+    # @return [CardCustomerInformation]
+    attr_accessor :customer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['status'] = 'status'
+      @_hash['links'] = 'links'
+      @_hash['customer'] = 'customer'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        status
+        links
+        customer
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, status: SKIP, links: SKIP, customer: SKIP)
+      @id = id unless id == SKIP
+      @status = status unless status == SKIP
+      @links = links unless links == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      status = hash.key?('status') ? hash['status'] : 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')
+      customer = CardCustomerInformation.from_hash(hash['customer']) if hash['customer']
+
+      # Create object from extracted values.
+      CardVaultResponse.new(id: id,
+                            status: status,
+                            links: links,
+                            customer: customer)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, status: #{@status}, links: #{@links}, customer: #{@customer}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, status: #{@status.inspect}, links: #{@links.inspect},"\
+      " customer: #{@customer.inspect}>"
+    end
+  end
+end

data/lib/paypal_server_sdk/models/card_verification.rb

@@ -0,0 +1,64 @@
+# paypal_server_sdk
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module PaypalServerSdk
+  # The API caller can opt in to verify the card through PayPal offered
+  # verification services (e.g. Smart Dollar Auth, 3DS).
+  class CardVerification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The method used for card verification.
+    # @return [OrdersCardVerificationMethod]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(method: OrdersCardVerificationMethod::SCA_WHEN_REQUIRED)
+      @method = method unless method == 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.
+      method =
+        hash['method'] ||= OrdersCardVerificationMethod::SCA_WHEN_REQUIRED
+
+      # Create object from extracted values.
+      CardVerification.new(method: method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method.inspect}>"
+    end
+  end
+end