apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/institution_response.rb

@@ -0,0 +1,290 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # InstitutionResponse Model.
+  class InstitutionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The code identifying a financial institution.
+    # @return [String]
+    attr_accessor :code
+
+    # The date and time the institution was created, represented in ISO 8601
+    # format with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # URL for the forgot password page of the institution.
+    # @return [String]
+    attr_accessor :forgot_password_url
+
+    # URL for the forgot username page of the institution.
+    # @return [String]
+    attr_accessor :forgot_username_url
+
+    # The unique identifier for the institution. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # Render this text when end users are asked for their credentials, as it
+    # helps end users provide the correct credentials when creating a new
+    # member. May contain `<a></a>` tags to link to explanatory material.
+    # @return [String]
+    attr_accessor :instructional_text
+
+    # An array of instructional steps that may contain html elements.
+    # @return [Array[String]]
+    attr_accessor :instructional_text_steps
+
+    # Indicates whether the institution is disabled by the client.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_disabled_by_client
+
+    # If the institution is available for creating new member connections, this
+    # field will be `false`. Otherwise, this field will be `true`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_hidden
+
+    # The ISO country code associated with the institution.
+    # @return [IsoCountryCode]
+    attr_accessor :iso_country_code
+
+    # The URL for a 100px X 100px logo for each `institution`. A generic logo is
+    # returned for institutions that don't have one.
+    # @return [String]
+    attr_accessor :medium_logo_url
+
+    # The name of the institution.
+    # @return [String]
+    attr_accessor :name
+
+    # The URL for a 50px X 50px logo for each `institution`. A generic logo is
+    # returned for institutions that don't have one.
+    # @return [String]
+    attr_accessor :small_logo_url
+
+    # The URL for a 50px X 50px logo for each `institution`. A generic logo is
+    # returned for institutions that don't have one.
+    # @return [Array[SupportedProduct]]
+    attr_accessor :supported_products
+
+    # If true, this indicates that the institution supports OAuth and that you
+    # have been properly registered for OAuth with that institution.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_oauth
+
+    # This indicates whether the institution supports tax documents.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :supports_tax_document
+
+    # The URL of the institution for helping users troubleshoot any other
+    # sign-in issue.
+    # @return [String]
+    attr_accessor :trouble_signing_in_url
+
+    # The URL for an institution's website.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['created_at'] = 'created_at'
+      @_hash['forgot_password_url'] = 'forgot_password_url'
+      @_hash['forgot_username_url'] = 'forgot_username_url'
+      @_hash['guid'] = 'guid'
+      @_hash['instructional_text'] = 'instructional_text'
+      @_hash['instructional_text_steps'] = 'instructional_text_steps'
+      @_hash['is_disabled_by_client'] = 'is_disabled_by_client'
+      @_hash['is_hidden'] = 'is_hidden'
+      @_hash['iso_country_code'] = 'iso_country_code'
+      @_hash['medium_logo_url'] = 'medium_logo_url'
+      @_hash['name'] = 'name'
+      @_hash['small_logo_url'] = 'small_logo_url'
+      @_hash['supported_products'] = 'supported_products'
+      @_hash['supports_oauth'] = 'supports_oauth'
+      @_hash['supports_tax_document'] = 'supports_tax_document'
+      @_hash['trouble_signing_in_url'] = 'trouble_signing_in_url'
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        created_at
+        forgot_password_url
+        forgot_username_url
+        guid
+        instructional_text
+        instructional_text_steps
+        is_disabled_by_client
+        is_hidden
+        iso_country_code
+        medium_logo_url
+        name
+        small_logo_url
+        supported_products
+        supports_oauth
+        supports_tax_document
+        trouble_signing_in_url
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        code
+        forgot_password_url
+        forgot_username_url
+        instructional_text
+        instructional_text_steps
+        is_disabled_by_client
+        medium_logo_url
+        name
+        small_logo_url
+        supports_oauth
+        supports_tax_document
+        trouble_signing_in_url
+        url
+      ]
+    end
+
+    def initialize(code: SKIP, created_at: SKIP, forgot_password_url: SKIP,
+                   forgot_username_url: SKIP, guid: SKIP,
+                   instructional_text: SKIP, instructional_text_steps: SKIP,
+                   is_disabled_by_client: SKIP, is_hidden: SKIP,
+                   iso_country_code: SKIP, medium_logo_url: SKIP, name: SKIP,
+                   small_logo_url: SKIP, supported_products: SKIP,
+                   supports_oauth: SKIP, supports_tax_document: SKIP,
+                   trouble_signing_in_url: SKIP, url: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @forgot_password_url = forgot_password_url unless forgot_password_url == SKIP
+      @forgot_username_url = forgot_username_url unless forgot_username_url == SKIP
+      @guid = guid unless guid == SKIP
+      @instructional_text = instructional_text unless instructional_text == SKIP
+      @instructional_text_steps = instructional_text_steps unless instructional_text_steps == SKIP
+      @is_disabled_by_client = is_disabled_by_client unless is_disabled_by_client == SKIP
+      @is_hidden = is_hidden unless is_hidden == SKIP
+      @iso_country_code = iso_country_code unless iso_country_code == SKIP
+      @medium_logo_url = medium_logo_url unless medium_logo_url == SKIP
+      @name = name unless name == SKIP
+      @small_logo_url = small_logo_url unless small_logo_url == SKIP
+      @supported_products = supported_products unless supported_products == SKIP
+      @supports_oauth = supports_oauth unless supports_oauth == SKIP
+      @supports_tax_document = supports_tax_document unless supports_tax_document == SKIP
+      @trouble_signing_in_url = trouble_signing_in_url unless trouble_signing_in_url == SKIP
+      @url = url unless url == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      forgot_password_url =
+        hash.key?('forgot_password_url') ? hash['forgot_password_url'] : SKIP
+      forgot_username_url =
+        hash.key?('forgot_username_url') ? hash['forgot_username_url'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      instructional_text =
+        hash.key?('instructional_text') ? hash['instructional_text'] : SKIP
+      instructional_text_steps =
+        hash.key?('instructional_text_steps') ? hash['instructional_text_steps'] : SKIP
+      is_disabled_by_client =
+        hash.key?('is_disabled_by_client') ? hash['is_disabled_by_client'] : SKIP
+      is_hidden = hash.key?('is_hidden') ? hash['is_hidden'] : SKIP
+      iso_country_code =
+        hash.key?('iso_country_code') ? hash['iso_country_code'] : SKIP
+      medium_logo_url =
+        hash.key?('medium_logo_url') ? hash['medium_logo_url'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      small_logo_url =
+        hash.key?('small_logo_url') ? hash['small_logo_url'] : SKIP
+      supported_products =
+        hash.key?('supported_products') ? hash['supported_products'] : SKIP
+      supports_oauth =
+        hash.key?('supports_oauth') ? hash['supports_oauth'] : SKIP
+      supports_tax_document =
+        hash.key?('supports_tax_document') ? hash['supports_tax_document'] : SKIP
+      trouble_signing_in_url =
+        hash.key?('trouble_signing_in_url') ? hash['trouble_signing_in_url'] : SKIP
+      url = hash.key?('url') ? hash['url'] : 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.
+      InstitutionResponse.new(code: code,
+                              created_at: created_at,
+                              forgot_password_url: forgot_password_url,
+                              forgot_username_url: forgot_username_url,
+                              guid: guid,
+                              instructional_text: instructional_text,
+                              instructional_text_steps: instructional_text_steps,
+                              is_disabled_by_client: is_disabled_by_client,
+                              is_hidden: is_hidden,
+                              iso_country_code: iso_country_code,
+                              medium_logo_url: medium_logo_url,
+                              name: name,
+                              small_logo_url: small_logo_url,
+                              supported_products: supported_products,
+                              supports_oauth: supports_oauth,
+                              supports_tax_document: supports_tax_document,
+                              trouble_signing_in_url: trouble_signing_in_url,
+                              url: url,
+                              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} code: #{@code}, created_at: #{@created_at}, forgot_password_url:"\
+      " #{@forgot_password_url}, forgot_username_url: #{@forgot_username_url}, guid: #{@guid},"\
+      " instructional_text: #{@instructional_text}, instructional_text_steps:"\
+      " #{@instructional_text_steps}, is_disabled_by_client: #{@is_disabled_by_client}, is_hidden:"\
+      " #{@is_hidden}, iso_country_code: #{@iso_country_code}, medium_logo_url:"\
+      " #{@medium_logo_url}, name: #{@name}, small_logo_url: #{@small_logo_url},"\
+      " supported_products: #{@supported_products}, supports_oauth: #{@supports_oauth},"\
+      " supports_tax_document: #{@supports_tax_document}, trouble_signing_in_url:"\
+      " #{@trouble_signing_in_url}, url: #{@url}, 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} code: #{@code.inspect}, created_at: #{@created_at.inspect},"\
+      " forgot_password_url: #{@forgot_password_url.inspect}, forgot_username_url:"\
+      " #{@forgot_username_url.inspect}, guid: #{@guid.inspect}, instructional_text:"\
+      " #{@instructional_text.inspect}, instructional_text_steps:"\
+      " #{@instructional_text_steps.inspect}, is_disabled_by_client:"\
+      " #{@is_disabled_by_client.inspect}, is_hidden: #{@is_hidden.inspect}, iso_country_code:"\
+      " #{@iso_country_code.inspect}, medium_logo_url: #{@medium_logo_url.inspect}, name:"\
+      " #{@name.inspect}, small_logo_url: #{@small_logo_url.inspect}, supported_products:"\
+      " #{@supported_products.inspect}, supports_oauth: #{@supports_oauth.inspect},"\
+      " supports_tax_document: #{@supports_tax_document.inspect}, trouble_signing_in_url:"\
+      " #{@trouble_signing_in_url.inspect}, url: #{@url.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/institution_response_body.rb

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

data/lib/mx_platform_api/models/institutions_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
+  # InstitutionsResponseBody Model.
+  class InstitutionsResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[InstitutionResponse]]
+    attr_accessor :institutions
+
+    # 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['institutions'] = 'institutions'
+      @_hash['pagination'] = 'pagination'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        institutions
+        pagination
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(institutions: SKIP, pagination: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @institutions = institutions unless institutions == 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
+      institutions = nil
+      unless hash['institutions'].nil?
+        institutions = []
+        hash['institutions'].each do |structure|
+          institutions << (InstitutionResponse.from_hash(structure) if structure)
+        end
+      end
+
+      institutions = SKIP unless hash.key?('institutions')
+      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.
+      InstitutionsResponseBody.new(institutions: institutions,
+                                   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} institutions: #{@institutions}, 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} institutions: #{@institutions.inspect}, pagination: #{@pagination.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end