apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/card_instrument_card_node.rb

@@ -0,0 +1,232 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Card that was used in the payment.
+  class CardInstrumentCardNode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card token identifier. Used for both cards and Apple Pay.
+    # @return [String]
+    attr_accessor :token
+
+    # Card token identifier. Used for both cards and Apple Pay.
+    # @return [Object]
+    attr_accessor :scheme
+
+    # Full name of the cardholder. As per IEC 7813, between 2-26 characters and
+    # using the T.50 character set.
+    # @return [String]
+    attr_accessor :cardholder_full_name
+
+    # Masked Payment Card Number (PAN). As per IEC 7813, up to 19 digits.
+    # At most the last four digits will be visible, and at least 6 digits will
+    # be replaced with '*'s.
+    # @return [String]
+    attr_accessor :masked_number
+
+    # Display Payment Card Name.
+    # A string, suitable for display, that describes the card.
+    # For debit and credit cards, the display name often includes the card brand
+    # and the last four digits of the credit card number when available, for
+    # example: “************0492”, “Visa 1233”, “MasterCard 5678”, “AmEx 9876”.
+    # For Apple Pay Cash cards, the display name is “Apple Pay Cash”. However,
+    # there is no guarantee about the display name’s content or format.
+    # To protect the user’s privacy, Apple Pay sets the display name only after
+    # the user authorizes the purchase.
+    # @return [String]
+    attr_accessor :display_name
+
+    # Display Payment Card Name.
+    # A string, suitable for display, that describes the card.
+    # For debit and credit cards, the display name often includes the card brand
+    # and the last four digits of the credit card number when available, for
+    # example: “************0492”, “Visa 1233”, “MasterCard 5678”, “AmEx 9876”.
+    # For Apple Pay Cash cards, the display name is “Apple Pay Cash”. However,
+    # there is no guarantee about the display name’s content or format.
+    # To protect the user’s privacy, Apple Pay sets the display name only after
+    # the user authorizes the purchase.
+    # @return [FundingType]
+    attr_accessor :funding_type
+
+    # Display Payment Card Name.
+    # A string, suitable for display, that describes the card.
+    # For debit and credit cards, the display name often includes the card brand
+    # and the last four digits of the credit card number when available, for
+    # example: “************0492”, “Visa 1233”, “MasterCard 5678”, “AmEx 9876”.
+    # For Apple Pay Cash cards, the display name is “Apple Pay Cash”. However,
+    # there is no guarantee about the display name’s content or format.
+    # To protect the user’s privacy, Apple Pay sets the display name only after
+    # the user authorizes the purchase.
+    # @return [String]
+    attr_accessor :country
+
+    # Display Payment Card Name.
+    # A string, suitable for display, that describes the card.
+    # For debit and credit cards, the display name often includes the card brand
+    # and the last four digits of the credit card number when available, for
+    # example: “************0492”, “Visa 1233”, “MasterCard 5678”, “AmEx 9876”.
+    # For Apple Pay Cash cards, the display name is “Apple Pay Cash”. However,
+    # there is no guarantee about the display name’s content or format.
+    # To protect the user’s privacy, Apple Pay sets the display name only after
+    # the user authorizes the purchase.
+    # @return [String]
+    attr_accessor :issuing_bank
+
+    # Display Payment Card Name.
+    # A string, suitable for display, that describes the card.
+    # For debit and credit cards, the display name often includes the card brand
+    # and the last four digits of the credit card number when available, for
+    # example: “************0492”, “Visa 1233”, “MasterCard 5678”, “AmEx 9876”.
+    # For Apple Pay Cash cards, the display name is “Apple Pay Cash”. However,
+    # there is no guarantee about the display name’s content or format.
+    # To protect the user’s privacy, Apple Pay sets the display name only after
+    # the user authorizes the purchase.
+    # @return [Category]
+    attr_accessor :category
+
+    # Display Payment Card Name.
+    # A string, suitable for display, that describes the card.
+    # For debit and credit cards, the display name often includes the card brand
+    # and the last four digits of the credit card number when available, for
+    # example: “************0492”, “Visa 1233”, “MasterCard 5678”, “AmEx 9876”.
+    # For Apple Pay Cash cards, the display name is “Apple Pay Cash”. However,
+    # there is no guarantee about the display name’s content or format.
+    # To protect the user’s privacy, Apple Pay sets the display name only after
+    # the user authorizes the purchase.
+    # @return [String]
+    attr_accessor :level
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['token'] = 'token'
+      @_hash['scheme'] = 'scheme'
+      @_hash['cardholder_full_name'] = 'cardholderFullName'
+      @_hash['masked_number'] = 'maskedNumber'
+      @_hash['display_name'] = 'displayName'
+      @_hash['funding_type'] = 'fundingType'
+      @_hash['country'] = 'country'
+      @_hash['issuing_bank'] = 'issuingBank'
+      @_hash['category'] = 'category'
+      @_hash['level'] = 'level'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        scheme
+        cardholder_full_name
+        masked_number
+        display_name
+        funding_type
+        country
+        issuing_bank
+        category
+        level
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(token:, scheme: SKIP, cardholder_full_name: SKIP,
+                   masked_number: SKIP, display_name: SKIP, funding_type: SKIP,
+                   country: SKIP, issuing_bank: SKIP, category: SKIP,
+                   level: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @token = token
+      @scheme = scheme unless scheme == SKIP
+      @cardholder_full_name = cardholder_full_name unless cardholder_full_name == SKIP
+      @masked_number = masked_number unless masked_number == SKIP
+      @display_name = display_name unless display_name == SKIP
+      @funding_type = funding_type unless funding_type == SKIP
+      @country = country unless country == SKIP
+      @issuing_bank = issuing_bank unless issuing_bank == SKIP
+      @category = category unless category == SKIP
+      @level = level unless level == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      token = hash.key?('token') ? hash['token'] : nil
+      scheme = hash.key?('scheme') ? hash['scheme'] : SKIP
+      cardholder_full_name =
+        hash.key?('cardholderFullName') ? hash['cardholderFullName'] : SKIP
+      masked_number = hash.key?('maskedNumber') ? hash['maskedNumber'] : SKIP
+      display_name = hash.key?('displayName') ? hash['displayName'] : SKIP
+      funding_type = hash.key?('fundingType') ? hash['fundingType'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      issuing_bank = hash.key?('issuingBank') ? hash['issuingBank'] : SKIP
+      category = hash.key?('category') ? hash['category'] : SKIP
+      level = hash.key?('level') ? hash['level'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CardInstrumentCardNode.new(token: token,
+                                 scheme: scheme,
+                                 cardholder_full_name: cardholder_full_name,
+                                 masked_number: masked_number,
+                                 display_name: display_name,
+                                 funding_type: funding_type,
+                                 country: country,
+                                 issuing_bank: issuing_bank,
+                                 category: category,
+                                 level: level,
+                                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CardInstrumentCardNode | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.token,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['token'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token}, scheme: #{@scheme}, cardholder_full_name:"\
+      " #{@cardholder_full_name}, masked_number: #{@masked_number}, display_name:"\
+      " #{@display_name}, funding_type: #{@funding_type}, country: #{@country}, issuing_bank:"\
+      " #{@issuing_bank}, category: #{@category}, level: #{@level}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token.inspect}, scheme: #{@scheme.inspect}, cardholder_full_name:"\
+      " #{@cardholder_full_name.inspect}, masked_number: #{@masked_number.inspect}, display_name:"\
+      " #{@display_name.inspect}, funding_type: #{@funding_type.inspect}, country:"\
+      " #{@country.inspect}, issuing_bank: #{@issuing_bank.inspect}, category:"\
+      " #{@category.inspect}, level: #{@level.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/card_number.rb

@@ -0,0 +1,122 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # CardNumber Model.
+  class CardNumber < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Minimum number of digits allowable for the card number.
+    # @return [Integer]
+    attr_accessor :minimum_digits
+
+    # Maximum number of digits allowable for the card number.
+    # @return [Integer]
+    attr_accessor :maximum_digits
+
+    # How the card number should be visually displayed for a given number of
+    # digits.
+    # Example: 
+    #   ```
+    #     "16": "4,4,4,4"
+    #   ```
+    #   Would say that for card numbers with 16 digts, show the numbers in
+    # 4,4,4,4 chunks.
+    #   So the number 1234123412341234 should show as:
+    #     1234-1234-1234-1234
+    # @return [Hash[String, String]]
+    attr_accessor :visual_formats
+
+    # Location of file to retrieve bin ranges for this card scheme.
+    # These bin ranges can be used to identify the card.
+    # @return [String]
+    attr_accessor :bin_ranges
+
+    # If numbers for this card scheme are verifiable using Luhn's algorithm or
+    # not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :luhn_verifiable
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['minimum_digits'] = 'minimumDigits'
+      @_hash['maximum_digits'] = 'maximumDigits'
+      @_hash['visual_formats'] = 'visualFormats'
+      @_hash['bin_ranges'] = 'binRanges'
+      @_hash['luhn_verifiable'] = 'luhnVerifiable'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(minimum_digits:, maximum_digits:, visual_formats:,
+                   bin_ranges:, luhn_verifiable:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @minimum_digits = minimum_digits
+      @maximum_digits = maximum_digits
+      @visual_formats = visual_formats
+      @bin_ranges = bin_ranges
+      @luhn_verifiable = luhn_verifiable
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      minimum_digits = hash.key?('minimumDigits') ? hash['minimumDigits'] : nil
+      maximum_digits = hash.key?('maximumDigits') ? hash['maximumDigits'] : nil
+      visual_formats = hash.key?('visualFormats') ? hash['visualFormats'] : nil
+      bin_ranges = hash.key?('binRanges') ? hash['binRanges'] : nil
+      luhn_verifiable =
+        hash.key?('luhnVerifiable') ? hash['luhnVerifiable'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CardNumber.new(minimum_digits: minimum_digits,
+                     maximum_digits: maximum_digits,
+                     visual_formats: visual_formats,
+                     bin_ranges: bin_ranges,
+                     luhn_verifiable: luhn_verifiable,
+                     additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} minimum_digits: #{@minimum_digits}, maximum_digits: #{@maximum_digits},"\
+      " visual_formats: #{@visual_formats}, bin_ranges: #{@bin_ranges}, luhn_verifiable:"\
+      " #{@luhn_verifiable}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} minimum_digits: #{@minimum_digits.inspect}, maximum_digits:"\
+      " #{@maximum_digits.inspect}, visual_formats: #{@visual_formats.inspect}, bin_ranges:"\
+      " #{@bin_ranges.inspect}, luhn_verifiable: #{@luhn_verifiable.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/card_payment_instrument.rb

@@ -0,0 +1,136 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # The card payment instrument.
+  class CardPaymentInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Payment method type.
+    # @return [PaymentMethod]
+    attr_accessor :method
+
+    # Card that was used in the payment.
+    # @return [CardInstrumentCardNode]
+    attr_accessor :card
+
+    # A mailing address.
+    # @return [PostalAddress]
+    attr_accessor :billing_address
+
+    # Telephone number.
+    # @return [Phone]
+    attr_accessor :phone
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash['card'] = 'card'
+      @_hash['billing_address'] = 'billingAddress'
+      @_hash['phone'] = 'phone'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(method:, card:, billing_address:, phone:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @method = method
+      @card = card
+      @billing_address = billing_address
+      @phone = phone
+      @additional_properties = additional_properties
+    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.key?('method') ? hash['method'] : nil
+      card = CardInstrumentCardNode.from_hash(hash['card']) if hash['card']
+      billing_address = PostalAddress.from_hash(hash['billingAddress']) if hash['billingAddress']
+      phone = Phone.from_hash(hash['phone']) if hash['phone']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CardPaymentInstrument.new(method: method,
+                                card: card,
+                                billing_address: billing_address,
+                                phone: phone,
+                                additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CardPaymentInstrument | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.method,
+                                ->(val) { PaymentMethod.validate(val) }) and
+            APIHelper.valid_type?(value.card,
+                                  ->(val) { CardInstrumentCardNode.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.billing_address,
+                                  ->(val) { PostalAddress.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.phone,
+                                  ->(val) { Phone.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['method'],
+                              ->(val) { PaymentMethod.validate(val) }) and
+          APIHelper.valid_type?(value['card'],
+                                ->(val) { CardInstrumentCardNode.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['billingAddress'],
+                                ->(val) { PostalAddress.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['phone'],
+                                ->(val) { Phone.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method}, card: #{@card}, billing_address: #{@billing_address},"\
+      " phone: #{@phone}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method.inspect}, card: #{@card.inspect}, billing_address:"\
+      " #{@billing_address.inspect}, phone: #{@phone.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/card_scheme.rb

@@ -0,0 +1,63 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Card Scheme networks connects acquiring banks to issuing banks so that a
+  # customer transaction can be verified. Is a middle man that also provide
+  # additional services, such as data processing, international transactions,
+  # etc.
+  class CardScheme
+    CARD_SCHEME = [
+      # TODO: Write general description for AMERICAN_EXPRESS
+      AMERICAN_EXPRESS = 'AMERICAN_EXPRESS'.freeze,
+
+      # TODO: Write general description for DINERS
+      DINERS = 'DINERS'.freeze,
+
+      # TODO: Write general description for DISCOVER
+      DISCOVER = 'DISCOVER'.freeze,
+
+      # TODO: Write general description for JCB
+      JCB = 'JCB'.freeze,
+
+      # TODO: Write general description for MASTERCARD
+      MASTERCARD = 'MASTERCARD'.freeze,
+
+      # TODO: Write general description for UATP
+      UATP = 'UATP'.freeze,
+
+      # TODO: Write general description for UNION_PAY
+      UNION_PAY = 'UNION_PAY'.freeze,
+
+      # TODO: Write general description for VISA
+      VISA = 'VISA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_SCHEME.include?(value)
+    end
+
+    def self.from_value(value, default_value = AMERICAN_EXPRESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'american_express' then AMERICAN_EXPRESS
+      when 'diners' then DINERS
+      when 'discover' then DISCOVER
+      when 'jcb' then JCB
+      when 'mastercard' then MASTERCARD
+      when 'uatp' then UATP
+      when 'union_pay' then UNION_PAY
+      when 'visa' then VISA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/card_scheme_configuration.rb

@@ -0,0 +1,87 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # How to configure a given card scheme.
+  class CardSchemeConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Card Scheme networks connects acquiring banks to issuing banks so that a
+    # customer transaction can be verified.
+    # Is a middle man that also provide additional services, such as data
+    # processing, international transactions, etc.
+    # @return [CardScheme]
+    attr_accessor :scheme
+
+    # How to configure a given card scheme.
+    # @return [Configuration]
+    attr_accessor :configuration
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scheme'] = 'scheme'
+      @_hash['configuration'] = 'configuration'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        configuration
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(scheme:, configuration: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @scheme = scheme
+      @configuration = configuration unless configuration == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      scheme = hash.key?('scheme') ? hash['scheme'] : nil
+      configuration = Configuration.from_hash(hash['configuration']) if hash['configuration']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CardSchemeConfiguration.new(scheme: scheme,
+                                  configuration: configuration,
+                                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme: #{@scheme}, configuration: #{@configuration},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme: #{@scheme.inspect}, configuration: #{@configuration.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end