apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/screen.rb

@@ -0,0 +1,97 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Buyer screen data.
+  class Screen < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total width of the buyer's device screen in pixels.
+    # This should be obtained by using the browser's `screen.width` property.
+    # @return [Integer]
+    attr_accessor :screen_width
+
+    # The total height of the buyer's device screen in pixels.
+    # This should be obtained by using the browser's `screen.height` property.
+    # @return [Integer]
+    attr_accessor :screen_height
+
+    # The color depth of the buyer's browser in bits per pixel.
+    # This should be obtained by using the browser's `screen.colorDepth`
+    # property.
+    # Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth."
+    # @return [Integer]
+    attr_accessor :color_depth
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['screen_width'] = 'screenWidth'
+      @_hash['screen_height'] = 'screenHeight'
+      @_hash['color_depth'] = 'colorDepth'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(screen_width:, screen_height:, color_depth:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @screen_width = screen_width
+      @screen_height = screen_height
+      @color_depth = color_depth
+      @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.
+      screen_width = hash.key?('screenWidth') ? hash['screenWidth'] : nil
+      screen_height = hash.key?('screenHeight') ? hash['screenHeight'] : nil
+      color_depth = hash.key?('colorDepth') ? hash['colorDepth'] : 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.
+      Screen.new(screen_width: screen_width,
+                 screen_height: screen_height,
+                 color_depth: color_depth,
+                 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} screen_width: #{@screen_width}, screen_height: #{@screen_height},"\
+      " color_depth: #{@color_depth}, 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} screen_width: #{@screen_width.inspect}, screen_height:"\
+      " #{@screen_height.inspect}, color_depth: #{@color_depth.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/search_vouchers_request.rb

@@ -0,0 +1,119 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Search vouchers request.
+  class SearchVouchersRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Identifier for an order.
+    # @return [String]
+    attr_accessor :order_id
+
+    # List of owners with issued vouchers
+    # @return [Array[PersonName]]
+    attr_accessor :owners
+
+    # Issuer of the voucher
+    # @return [String]
+    attr_reader :issuer
+
+    # Type of voucher
+    # @return [VoucherType]
+    attr_accessor :voucher_type
+
+    # Reference for identifying an order.
+    # @return [String]
+    attr_accessor :merchant_order_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'orderId'
+      @_hash['owners'] = 'owners'
+      @_hash['issuer'] = 'issuer'
+      @_hash['voucher_type'] = 'voucherType'
+      @_hash['merchant_order_reference'] = 'merchantOrderReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(owners:, voucher_type:, merchant_order_reference:,
+                   order_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @order_id = order_id unless order_id == SKIP
+      @owners = owners
+      @issuer = 'SWAV_PAYMENT_GATEWAY'
+      @voucher_type = voucher_type
+      @merchant_order_reference = merchant_order_reference
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      owners = nil
+      unless hash['owners'].nil?
+        owners = []
+        hash['owners'].each do |structure|
+          owners << (PersonName.from_hash(structure) if structure)
+        end
+      end
+
+      owners = nil unless hash.key?('owners')
+      voucher_type = hash.key?('voucherType') ? hash['voucherType'] : nil
+      merchant_order_reference =
+        hash.key?('merchantOrderReference') ? hash['merchantOrderReference'] : nil
+      order_id = hash.key?('orderId') ? hash['orderId'] : 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.
+      SearchVouchersRequest.new(owners: owners,
+                                voucher_type: voucher_type,
+                                merchant_order_reference: merchant_order_reference,
+                                order_id: order_id,
+                                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} order_id: #{@order_id}, owners: #{@owners}, issuer: #{@issuer},"\
+      " voucher_type: #{@voucher_type}, merchant_order_reference: #{@merchant_order_reference},"\
+      " 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} order_id: #{@order_id.inspect}, owners: #{@owners.inspect}, issuer:"\
+      " #{@issuer.inspect}, voucher_type: #{@voucher_type.inspect}, merchant_order_reference:"\
+      " #{@merchant_order_reference.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/security_code.rb

@@ -0,0 +1,83 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Configuration related to card security codes (e.g. CVVs).
+  class SecurityCode < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Exact number of digts that the security code should be.
+    # @return [Integer]
+    attr_accessor :digits
+
+    # If the card's security code is required. 
+    # Some card schemes, like UATP do not use security codes.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :required
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['digits'] = 'digits'
+      @_hash['required'] = 'required'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(digits:, required:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @digits = digits
+      @required = required
+      @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.
+      digits = hash.key?('digits') ? hash['digits'] : nil
+      required = hash.key?('required') ? hash['required'] : 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.
+      SecurityCode.new(digits: digits,
+                       required: required,
+                       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} digits: #{@digits}, required: #{@required}, 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} digits: #{@digits.inspect}, required: #{@required.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/security_code_match_status.rb

@@ -0,0 +1,50 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Security Code Status <table> <thead>   <tr>     <th>Security Code
+  # Status</th>     <th>Description</th>   </tr> </thead> <tbody>   <tr>
+  # <td>MATCH</td>     <td>Provided Security Code matches expected value.</td>
+  # </tr>   <tr>     <td>NOT_PROVIDED</td>     <td>Security Code not
+  # provided.</td>   </tr>   <tr>     <td>FAILURE</td>     <td>Security Code
+  # does not match expected value.</td>   </tr>   <tr>     <td>UNAVAILABLE</td>
+  #    <td>Security Code check not available.</td>   </tr> </tbody> </table>
+  class SecurityCodeMatchStatus
+    SECURITY_CODE_MATCH_STATUS = [
+      # TODO: Write general description for MATCH
+      MATCH = 'MATCH'.freeze,
+
+      # TODO: Write general description for NOT_PROVIDED
+      NOT_PROVIDED = 'NOT_PROVIDED'.freeze,
+
+      # TODO: Write general description for FAILURE
+      FAILURE = 'FAILURE'.freeze,
+
+      # TODO: Write general description for UNAVAILABLE
+      UNAVAILABLE = 'UNAVAILABLE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SECURITY_CODE_MATCH_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = MATCH)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'match' then MATCH
+      when 'not_provided' then NOT_PROVIDED
+      when 'failure' then FAILURE
+      when 'unavailable' then UNAVAILABLE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/status.rb

@@ -0,0 +1,43 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Status of this breadcrumb item, so we can show it properly. Options:   -
+  # `DONE`: Buyer has already completed this step.   - `IN_PROGRESS`: Buyer is
+  # currently on this step.   - `PENDING`: Buyer has yet to get to this step, it
+  # is in the future.
+  class Status
+    STATUS = [
+      # TODO: Write general description for DONE
+      DONE = 'DONE'.freeze,
+
+      # TODO: Write general description for IN_PROGRESS
+      IN_PROGRESS = 'IN_PROGRESS'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = DONE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'done' then DONE
+      when 'in_progress' then IN_PROGRESS
+      when 'pending' then PENDING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/status1.rb

@@ -0,0 +1,52 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # The status of the fraud assessment.
+  class Status1
+    STATUS1 = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'ACCEPTED'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'REJECTED'.freeze,
+
+      # TODO: Write general description for IN_REVIEW
+      IN_REVIEW = 'IN_REVIEW'.freeze,
+
+      # TODO: Write general description for REVIEW_ACCEPTED
+      REVIEW_ACCEPTED = 'REVIEW_ACCEPTED'.freeze,
+
+      # TODO: Write general description for REVIEW_REJECTED
+      REVIEW_REJECTED = 'REVIEW_REJECTED'.freeze,
+
+      # TODO: Write general description for ERROR
+      ERROR = 'ERROR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS1.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCEPTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accepted' then ACCEPTED
+      when 'rejected' then REJECTED
+      when 'in_review' then IN_REVIEW
+      when 'review_accepted' then REVIEW_ACCEPTED
+      when 'review_rejected' then REVIEW_REJECTED
+      when 'error' then ERROR
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/summary.rb

@@ -0,0 +1,82 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Summary of the results of the bulk payment.
+  class Summary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[TransactionActionResult]]
+    attr_accessor :results
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['results'] = 'results'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(results:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @results = results
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      results = nil
+      unless hash['results'].nil?
+        results = []
+        hash['results'].each do |structure|
+          results << (TransactionActionResult.from_hash(structure) if structure)
+        end
+      end
+
+      results = nil unless hash.key?('results')
+
+      # 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.
+      Summary.new(results: results,
+                  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} results: #{@results}, 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} results: #{@results.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/tax.rb

@@ -0,0 +1,134 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Tax.
+  class Tax < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # What should be shown as the title of the line item on a receipt or billing
+    # summary.
+    # @return [String]
+    attr_accessor :title
+
+    # Code defined by government entity to identify a particular type of tax.
+    # @return [String]
+    attr_accessor :code
+
+    # An amount that is a nonnegative number, i.e. {0, 1, 2, 3, 4, 5,…}
+    # @return [NonNegativeAmount]
+    attr_accessor :price
+
+    # AuthorizationGroup that the line item should be part of for splitting
+    # authorizations for Aggregate Payments.
+    # If this is set, there must be a matching AuthorizationGroup created in the
+    # PriceSummary.
+    # > NOTE: Items within a Bundle should not have an `authorizationGroupId`,
+    # they will use the same `authorizationGroupId` as the top-level bundle.
+    # @return [String]
+    attr_accessor :authorization_group_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['title'] = 'title'
+      @_hash['code'] = 'code'
+      @_hash['price'] = 'price'
+      @_hash['authorization_group_id'] = 'authorizationGroupId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        authorization_group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(title:, price:, code: SKIP, authorization_group_id: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @title = title
+      @code = code unless code == SKIP
+      @price = price
+      @authorization_group_id = authorization_group_id unless authorization_group_id == 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.
+      title = hash.key?('title') ? hash['title'] : nil
+      price = NonNegativeAmount.from_hash(hash['price']) if hash['price']
+      code = hash.key?('code') ? hash['code'] : SKIP
+      authorization_group_id =
+        hash.key?('authorizationGroupId') ? hash['authorizationGroupId'] : 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.
+      Tax.new(title: title,
+              price: price,
+              code: code,
+              authorization_group_id: authorization_group_id,
+              additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Tax | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.title,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.price,
+                                  ->(val) { NonNegativeAmount.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['title'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['price'],
+                                ->(val) { NonNegativeAmount.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} title: #{@title}, code: #{@code}, price: #{@price}, authorization_group_id:"\
+      " #{@authorization_group_id}, 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} title: #{@title.inspect}, code: #{@code.inspect}, price: #{@price.inspect},"\
+      " authorization_group_id: #{@authorization_group_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end