fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/sms_blacklist.rb

@@ -0,0 +1,105 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Sms Blacklist Information on `expand`
+  class SmsBlacklist < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Blacklist ID
+    # @return [String]
+    attr_accessor :id
+
+    # isBlacklisted
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_blacklisted
+
+    # Contact Id
+    # @return [TrueClass | FalseClass]
+    attr_accessor :detail
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['is_blacklisted'] = 'isBlacklisted'
+      @_hash['detail'] = 'detail'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        is_blacklisted
+        detail
+        created_ts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        id
+        created_ts
+      ]
+    end
+
+    def initialize(id = SKIP, is_blacklisted = SKIP, detail = SKIP,
+                   created_ts = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @id = id unless id == SKIP
+      @is_blacklisted = is_blacklisted unless is_blacklisted == SKIP
+      @detail = detail unless detail == SKIP
+      @created_ts = created_ts unless created_ts == 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
+      is_blacklisted = hash.key?('isBlacklisted') ? hash['isBlacklisted'] : SKIP
+      detail = hash.key?('detail') ? hash['detail'] : SKIP
+      created_ts = hash.key?('created_ts') ? hash['created_ts'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      SmsBlacklist.new(id,
+                       is_blacklisted,
+                       detail,
+                       created_ts,
+                       additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, is_blacklisted: #{@is_blacklisted}, detail: #{@detail},"\
+      " created_ts: #{@created_ts}, additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, is_blacklisted: #{@is_blacklisted.inspect}, detail:"\
+      " #{@detail.inspect}, created_ts: #{@created_ts.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/sms_enum.rb

@@ -0,0 +1,42 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Resend SMS
+  class SmsEnum
+    SMS_ENUM = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = 0,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SMS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_0)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if SMS_ENUM.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'enum_0' then ENUM_0
+      when 'enum_1' then ENUM_1
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/sort.rb

@@ -0,0 +1,91 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Sort information used on the results
+  class Sort < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Object type
+    # @return [Type4Enum]
+    attr_accessor :type
+
+    # [object Object]
+    # @return [Array[Field]]
+    attr_accessor :fields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['fields'] = 'fields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, fields = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @type = type unless type == SKIP
+      @fields = fields unless fields == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      fields = nil
+      unless hash['fields'].nil?
+        fields = []
+        hash['fields'].each do |structure|
+          fields << (Field.from_hash(structure) if structure)
+        end
+      end
+
+      fields = SKIP unless hash.key?('fields')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Sort.new(type,
+               fields,
+               additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, fields: #{@fields}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, fields: #{@fields.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/source_enum.rb

@@ -0,0 +1,41 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Indicates the source of the broadcasted information. This field is required.
+  # >01 - 3DS Server > >02 - DS > >03 - ACS >
+  class SourceEnum
+    SOURCE_ENUM = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze,
+
+      # TODO: Write general description for ENUM_03
+      ENUM_03 = '03'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SOURCE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_01)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_01' then ENUM_01
+      when 'enum_02' then ENUM_02
+      when 'enum_03' then ENUM_03
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/stack_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Stack
+  class StackEnum
+    STACK_ENUM = [
+      # TODO: Write general description for HORIZONTAL
+      HORIZONTAL = 'horizontal'.freeze,
+
+      # TODO: Write general description for VERTICAL
+      VERTICAL = 'vertical'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STACK_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = HORIZONTAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'horizontal' then HORIZONTAL
+      when 'vertical' then VERTICAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/status11.rb

@@ -0,0 +1,84 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Status Information on `expand`
+  class Status11 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID
+    # @return [Integer]
+    attr_accessor :id
+
+    # Title
+    # @return [String]
+    attr_accessor :title
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['title'] = 'title'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        title
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        id
+      ]
+    end
+
+    def initialize(id = SKIP, title = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @id = id unless id == SKIP
+      @title = title unless title == 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
+      title = hash.key?('title') ? hash['title'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Status11.new(id,
+                   title,
+                   additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, title: #{@title}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, title: #{@title.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/status3_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Status
+  class Status3Enum
+    STATUS3_ENUM = [
+      # TODO: Write general description for PAID
+      PAID = 'paid'.freeze,
+
+      # TODO: Write general description for UNPAID
+      UNPAID = 'unpaid'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS3_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = PAID)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'paid' then PAID
+      when 'unpaid' then UNPAID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/status5.rb

@@ -0,0 +1,73 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Status5 Model.
+  class Status5 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Response code for API response.
+    # @return [String]
+    attr_accessor :response_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response_code'] = 'response_code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response_code = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @response_code = response_code unless response_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.
+      response_code = hash.key?('response_code') ? hash['response_code'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Status5.new(response_code,
+                  additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response_code: #{@response_code}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response_code: #{@response_code.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/status_code12_enum.rb

@@ -0,0 +1,42 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # The various statuses of the paylink.  0=Unpaid | 1=Paid
+  class StatusCode12Enum
+    STATUS_CODE12_ENUM = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = 0,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS_CODE12_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_0)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if STATUS_CODE12_ENUM.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'enum_0' then ENUM_0
+      when 'enum_1' then ENUM_1
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/status_code14_enum.rb

@@ -0,0 +1,42 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Status Code
+  class StatusCode14Enum
+    STATUS_CODE14_ENUM = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = 0,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS_CODE14_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_0)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if STATUS_CODE14_ENUM.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'enum_0' then ENUM_0
+      when 'enum_1' then ENUM_1
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/status_code17_enum.rb

@@ -0,0 +1,89 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Status ID - See status id section for more detail >101 - Sale cc Approved >
+  # >102 - Sale cc AuthOnly > >111 - Refund cc Refunded > >121 -
+  # Credit/Debit/Refund cc AvsOnly > >131 - Credit/Debit/Refund ach Pending
+  # Origination > >132 - Credit/Debit/Refund ach Originating > >133 -
+  # Credit/Debit/Refund ach Originated > >134 - Credit/Debit/Refund ach Settled
+  # > >191 - Settled (depracated - batches are now settled on the
+  # /v2/transactionbatches endpoint) > >201 - All cc/ach Voided > >301 - All
+  # cc/ach Declined > >331 - Credit/Debit/Refund ach Charged Back >
+  class StatusCode17Enum
+    STATUS_CODE17_ENUM = [
+      # TODO: Write general description for ENUM_101
+      ENUM_101 = 101,
+
+      # TODO: Write general description for ENUM_102
+      ENUM_102 = 102,
+
+      # TODO: Write general description for ENUM_111
+      ENUM_111 = 111,
+
+      # TODO: Write general description for ENUM_121
+      ENUM_121 = 121,
+
+      # TODO: Write general description for ENUM_131
+      ENUM_131 = 131,
+
+      # TODO: Write general description for ENUM_132
+      ENUM_132 = 132,
+
+      # TODO: Write general description for ENUM_133
+      ENUM_133 = 133,
+
+      # TODO: Write general description for ENUM_134
+      ENUM_134 = 134,
+
+      # TODO: Write general description for ENUM_191
+      ENUM_191 = 191,
+
+      # TODO: Write general description for ENUM_201
+      ENUM_201 = 201,
+
+      # TODO: Write general description for ENUM_301
+      ENUM_301 = 301,
+
+      # TODO: Write general description for ENUM_331
+      ENUM_331 = 331
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS_CODE17_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_101)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+      if str.match?(/\A\d+\z/)
+        num = str.to_i
+        return num if STATUS_CODE17_ENUM.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'enum_101' then ENUM_101
+      when 'enum_102' then ENUM_102
+      when 'enum_111' then ENUM_111
+      when 'enum_121' then ENUM_121
+      when 'enum_131' then ENUM_131
+      when 'enum_132' then ENUM_132
+      when 'enum_133' then ENUM_133
+      when 'enum_134' then ENUM_134
+      when 'enum_191' then ENUM_191
+      when 'enum_201' then ENUM_201
+      when 'enum_301' then ENUM_301
+      when 'enum_331' then ENUM_331
+      else
+        default_value
+      end
+    end
+  end
+end