apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/tagging_update_request_body.rb

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

data/lib/mx_platform_api/models/taggings_response_body.rb

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

data/lib/mx_platform_api/models/tags_response_body.rb

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

data/lib/mx_platform_api/models/token_request_body.rb

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

data/lib/mx_platform_api/models/token_response.rb

@@ -0,0 +1,114 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # TokenResponse Model.
+  class TokenResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the payment processor. Defined by MX.
+    # @return [String]
+    attr_accessor :payment_processor_guid
+
+    # The date and time the access token expires in ISO 8601 format with a
+    # timestamp.
+    # @return [String]
+    attr_accessor :expires_at
+
+    # The access token you'll use to retrieve data. Every `access_token` expires
+    # after 60 days. To get a new token after an old one has expired, you must
+    # get a new code from the client. See [How-to Guide for
+    # Processors](/products/connectivity/instant-account-verification/processor-
+    # token/processor-guide/#1-request-an-access-token).
+    # @return [String]
+    attr_accessor :access_token
+
+    # Indicates whether the token is active.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_processor_guid'] = 'payment_processor_guid'
+      @_hash['expires_at'] = 'expires_at'
+      @_hash['access_token'] = 'access_token'
+      @_hash['active'] = 'active'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payment_processor_guid
+        expires_at
+        access_token
+        active
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        access_token
+      ]
+    end
+
+    def initialize(payment_processor_guid: SKIP, expires_at: SKIP,
+                   access_token: SKIP, active: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payment_processor_guid = payment_processor_guid unless payment_processor_guid == SKIP
+      @expires_at = expires_at unless expires_at == SKIP
+      @access_token = access_token unless access_token == SKIP
+      @active = active unless active == 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.
+      payment_processor_guid =
+        hash.key?('payment_processor_guid') ? hash['payment_processor_guid'] : SKIP
+      expires_at = hash.key?('expires_at') ? hash['expires_at'] : SKIP
+      access_token = hash.key?('access_token') ? hash['access_token'] : SKIP
+      active = hash.key?('active') ? hash['active'] : 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.
+      TokenResponse.new(payment_processor_guid: payment_processor_guid,
+                        expires_at: expires_at,
+                        access_token: access_token,
+                        active: active,
+                        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} payment_processor_guid: #{@payment_processor_guid}, expires_at:"\
+      " #{@expires_at}, access_token: #{@access_token}, active: #{@active}, 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} payment_processor_guid: #{@payment_processor_guid.inspect}, expires_at:"\
+      " #{@expires_at.inspect}, access_token: #{@access_token.inspect}, active:"\
+      " #{@active.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/token_response_body.rb

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

data/lib/mx_platform_api/models/track_type_name.rb

@@ -0,0 +1,44 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The track of the `goal`.
+  class TrackTypeName
+    TRACK_TYPE_NAME = [
+      # TODO: Write general description for DEBT_TRACK
+      DEBT_TRACK = 'DEBT_TRACK'.freeze,
+
+      # TODO: Write general description for SAVINGS_TRACK
+      SAVINGS_TRACK = 'SAVINGS_TRACK'.freeze,
+
+      # TODO: Write general description for RETIREMENT_TRACK
+      RETIREMENT_TRACK = 'RETIREMENT_TRACK'.freeze,
+
+      # TODO: Write general description for EMERGENCY_FUND_TRACK
+      EMERGENCY_FUND_TRACK = 'EMERGENCY_FUND_TRACK'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRACK_TYPE_NAME.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEBT_TRACK)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'debt_track' then DEBT_TRACK
+      when 'savings_track' then SAVINGS_TRACK
+      when 'retirement_track' then RETIREMENT_TRACK
+      when 'emergency_fund_track' then EMERGENCY_FUND_TRACK
+      else
+        default_value
+      end
+    end
+  end
+end