apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/investment_holdings_response_body.rb

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

data/lib/mx_platform_api/models/iso_country_code.rb

@@ -0,0 +1,36 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The ISO country code associated with the institution.
+  class IsoCountryCode
+    ISO_COUNTRY_CODE = [
+      # TODO: Write general description for US
+      US = 'US'.freeze,
+
+      # TODO: Write general description for CA
+      CA = 'CA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ISO_COUNTRY_CODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = US)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'us' then US
+      when 'ca' then CA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mx_platform_api/models/item_type.rb

@@ -0,0 +1,52 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The type of transaction grouping for the spending plan `iteration_item` (0 =
+  # `RECURRING_EXPENSE`, 1 = `PLANNED_EXPENSE`, 2 = `OTHER_EXPENSE`, 3 =
+  # `INCOME`).
+  class ItemType
+    ITEM_TYPE = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = 0,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = 1,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = 2,
+
+      # TODO: Write general description for ENUM_3
+      ENUM_3 = 3
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ITEM_TYPE.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 ITEM_TYPE.include?(num)
+
+        return default_value
+      end
+
+      case str.downcase
+      when 'enum_0' then ENUM_0
+      when 'enum_1' then ENUM_1
+      when 'enum_2' then ENUM_2
+      when 'enum_3' then ENUM_3
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mx_platform_api/models/job_response.rb

@@ -0,0 +1,203 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # JobResponse Model.
+  class JobResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the institution was created, represented in ISO 8601
+    # format with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # If the job returns an error, this field will contain the message of the
+    # error.
+    # @return [String]
+    attr_accessor :error_message
+
+    # Date and time the job finished, represented in ISO 8601 format with
+    # timestamp.
+    # @return [String]
+    attr_accessor :error_message_code
+
+    # The date and time the job finished, represented in ISO 8601 format with a
+    # timestamp.
+    # @return [String]
+    attr_accessor :finished_at
+
+    # Unique identifier for the institution the job is attached to. Defined by
+    # MX.
+    # @return [String]
+    attr_accessor :institution_guid
+
+    # If the member's credentials have been authenticated, this field will be
+    # true. Otherwise, this field will be false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_authenticated
+
+    # Unique identifier for the member the job is attached to. Defined by MX.
+    # @return [String]
+    attr_accessor :member_guid
+
+    # Date and time the job started, represented in ISO 8601 format with
+    # timestamp.
+    # @return [String]
+    attr_accessor :started_at
+
+    # The status of the job.
+    # @return [Integer]
+    attr_accessor :status
+
+    # The name of the status.
+    # @return [Object]
+    attr_accessor :status_name
+
+    # Date and time the job was updated, represented in ISO 8601 format with
+    # timestamp.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # Unique identifier for the user the job is attached to. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['error_message'] = 'error_message'
+      @_hash['error_message_code'] = 'error_message_code'
+      @_hash['finished_at'] = 'finished_at'
+      @_hash['institution_guid'] = 'institution_guid'
+      @_hash['is_authenticated'] = 'is_authenticated'
+      @_hash['member_guid'] = 'member_guid'
+      @_hash['started_at'] = 'started_at'
+      @_hash['status'] = 'status'
+      @_hash['status_name'] = 'status_name'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        error_message
+        error_message_code
+        finished_at
+        institution_guid
+        is_authenticated
+        member_guid
+        started_at
+        status
+        status_name
+        updated_at
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        error_message
+        error_message_code
+      ]
+    end
+
+    def initialize(created_at: SKIP, error_message: SKIP,
+                   error_message_code: SKIP, finished_at: SKIP,
+                   institution_guid: SKIP, is_authenticated: SKIP,
+                   member_guid: SKIP, started_at: SKIP, status: SKIP,
+                   status_name: SKIP, updated_at: SKIP, user_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_at = created_at unless created_at == SKIP
+      @error_message = error_message unless error_message == SKIP
+      @error_message_code = error_message_code unless error_message_code == SKIP
+      @finished_at = finished_at unless finished_at == SKIP
+      @institution_guid = institution_guid unless institution_guid == SKIP
+      @is_authenticated = is_authenticated unless is_authenticated == SKIP
+      @member_guid = member_guid unless member_guid == SKIP
+      @started_at = started_at unless started_at == SKIP
+      @status = status unless status == SKIP
+      @status_name = status_name unless status_name == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @user_guid = user_guid unless user_guid == 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.
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      error_message = hash.key?('error_message') ? hash['error_message'] : SKIP
+      error_message_code =
+        hash.key?('error_message_code') ? hash['error_message_code'] : SKIP
+      finished_at = hash.key?('finished_at') ? hash['finished_at'] : SKIP
+      institution_guid =
+        hash.key?('institution_guid') ? hash['institution_guid'] : SKIP
+      is_authenticated =
+        hash.key?('is_authenticated') ? hash['is_authenticated'] : SKIP
+      member_guid = hash.key?('member_guid') ? hash['member_guid'] : SKIP
+      started_at = hash.key?('started_at') ? hash['started_at'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      status_name = hash.key?('status_name') ? hash['status_name'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : 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.
+      JobResponse.new(created_at: created_at,
+                      error_message: error_message,
+                      error_message_code: error_message_code,
+                      finished_at: finished_at,
+                      institution_guid: institution_guid,
+                      is_authenticated: is_authenticated,
+                      member_guid: member_guid,
+                      started_at: started_at,
+                      status: status,
+                      status_name: status_name,
+                      updated_at: updated_at,
+                      user_guid: user_guid,
+                      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} created_at: #{@created_at}, error_message: #{@error_message},"\
+      " error_message_code: #{@error_message_code}, finished_at: #{@finished_at},"\
+      " institution_guid: #{@institution_guid}, is_authenticated: #{@is_authenticated},"\
+      " member_guid: #{@member_guid}, started_at: #{@started_at}, status: #{@status}, status_name:"\
+      " #{@status_name}, updated_at: #{@updated_at}, user_guid: #{@user_guid},"\
+      " 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} created_at: #{@created_at.inspect}, error_message:"\
+      " #{@error_message.inspect}, error_message_code: #{@error_message_code.inspect},"\
+      " finished_at: #{@finished_at.inspect}, institution_guid: #{@institution_guid.inspect},"\
+      " is_authenticated: #{@is_authenticated.inspect}, member_guid: #{@member_guid.inspect},"\
+      " started_at: #{@started_at.inspect}, status: #{@status.inspect}, status_name:"\
+      " #{@status_name.inspect}, updated_at: #{@updated_at.inspect}, user_guid:"\
+      " #{@user_guid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/job_response_body.rb

@@ -0,0 +1,74 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # JobResponseBody Model.
+  class JobResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [JobResponse]
+    attr_accessor :job
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['job'] = 'job'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        job
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(job: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @job = job unless job == 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.
+      job = JobResponse.from_hash(hash['job']) if hash['job']
+
+      # 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.
+      JobResponseBody.new(job: job,
+                          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} job: #{@job}, 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} job: #{@job.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end