fortis-apimatic-sdk 1.0.0

data/lib/fortis_api/models/file5.rb

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

data/lib/fortis_api/models/filter_by.rb

@@ -0,0 +1,120 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # FilterBy Model.
+  class FilterBy < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Resource key to filter by
+    # @return [String]
+    attr_accessor :key
+
+    # Filter operand.  Please note `=` does not imply a strict equality check.  
+    # Only time fields support the `<=` and `>=` operators.
+    # @return [Object]
+    attr_accessor :operator
+
+    # Filter value.  
+    # For time fields, `value` must be sent in Unix format: `946702799`
+    # @return [Object]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash['operator'] = 'operator'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = nil, operator = nil, value = nil,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @key = key
+      @operator = operator
+      @value = value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      key = hash.key?('key') ? hash['key'] : nil
+      operator = hash.key?('operator') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FilterByOperator), hash['operator']
+      ) : nil
+      value = hash.key?('value') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FilterByValue), hash['value']
+      ) : nil
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      FilterBy.new(key,
+                   operator,
+                   value,
+                   additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FilterBy | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.key,
+                                ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:FilterByOperator)
+                           .validate(value.operator) and
+            UnionTypeLookUp.get(:FilterByValue)
+                           .validate(value.value)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['key'],
+                              ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:FilterByOperator)
+                         .validate(value['operator']) and
+          UnionTypeLookUp.get(:FilterByValue)
+                         .validate(value['value'])
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key}, operator: #{@operator}, value: #{@value},"\
+      " 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} key: #{@key.inspect}, operator: #{@operator.inspect}, value:"\
+      " #{@value.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/footer.rb

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

data/lib/fortis_api/models/forecast.rb

@@ -0,0 +1,139 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Forecast Information on `expand`
+  class Forecast < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID
+    # @return [String]
+    attr_accessor :id
+
+    # Recurring ID
+    # @return [String]
+    attr_accessor :recurring_id
+
+    # Recurring Type
+    # @return [Float]
+    attr_accessor :recurring_type
+
+    # Amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Month
+    # @return [String]
+    attr_accessor :month
+
+    # Created Time Stamp
+    # @return [Integer]
+    attr_accessor :created_ts
+
+    # Modified Time Stamp
+    # @return [Integer]
+    attr_accessor :modified_ts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['recurring_id'] = 'recurring_id'
+      @_hash['recurring_type'] = 'recurring_type'
+      @_hash['amount'] = 'amount'
+      @_hash['month'] = 'month'
+      @_hash['created_ts'] = 'created_ts'
+      @_hash['modified_ts'] = 'modified_ts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        recurring_id
+        recurring_type
+        amount
+        month
+        created_ts
+        modified_ts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        recurring_type
+        amount
+        month
+        created_ts
+        modified_ts
+      ]
+    end
+
+    def initialize(id = SKIP, recurring_id = SKIP, recurring_type = SKIP,
+                   amount = SKIP, month = SKIP, created_ts = SKIP,
+                   modified_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
+      @recurring_id = recurring_id unless recurring_id == SKIP
+      @recurring_type = recurring_type unless recurring_type == SKIP
+      @amount = amount unless amount == SKIP
+      @month = month unless month == SKIP
+      @created_ts = created_ts unless created_ts == SKIP
+      @modified_ts = modified_ts unless modified_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
+      recurring_id = hash.key?('recurring_id') ? hash['recurring_id'] : SKIP
+      recurring_type =
+        hash.key?('recurring_type') ? hash['recurring_type'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      month = hash.key?('month') ? hash['month'] : SKIP
+      created_ts = hash.key?('created_ts') ? hash['created_ts'] : SKIP
+      modified_ts = hash.key?('modified_ts') ? hash['modified_ts'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Forecast.new(id,
+                   recurring_id,
+                   recurring_type,
+                   amount,
+                   month,
+                   created_ts,
+                   modified_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}, recurring_id: #{@recurring_id}, recurring_type:"\
+      " #{@recurring_type}, amount: #{@amount}, month: #{@month}, created_ts: #{@created_ts},"\
+      " modified_ts: #{@modified_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}, recurring_id: #{@recurring_id.inspect}, recurring_type:"\
+      " #{@recurring_type.inspect}, amount: #{@amount.inspect}, month: #{@month.inspect},"\
+      " created_ts: #{@created_ts.inspect}, modified_ts: #{@modified_ts.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/fortis_api/models/format1_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Reporting format, valid values: csv, tsv
+  class Format1Enum
+    FORMAT1_ENUM = [
+      # TODO: Write general description for CSV
+      CSV = 'csv'.freeze,
+
+      # TODO: Write general description for TSV
+      TSV = 'tsv'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FORMAT1_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = CSV)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'csv' then CSV
+      when 'tsv' then TSV
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/format_enum.rb

@@ -0,0 +1,36 @@
+# fortis_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FortisApi
+  # Options include: api-default
+  class FormatEnum
+    FORMAT_ENUM = [
+      # TODO: Write general description for APIDEFAULT
+      APIDEFAULT = 'api-default'.freeze,
+
+      # TODO: Write general description for PARTNER
+      PARTNER = 'partner'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FORMAT_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = APIDEFAULT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'apidefault' then APIDEFAULT
+      when 'partner' then PARTNER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fortis_api/models/header.rb

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