apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/member_elements.rb

@@ -0,0 +1,96 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MemberElements Model.
+  class MemberElements < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # The unique identifier for the member. Defined by MX.
+    # @return [String]
+    attr_accessor :member_guid
+
+    # The unique identifier for the user. 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['account_guid'] = 'account_guid'
+      @_hash['member_guid'] = 'member_guid'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        member_guid
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_guid: SKIP, member_guid: SKIP, user_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid unless account_guid == SKIP
+      @member_guid = member_guid unless member_guid == 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.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      member_guid = hash.key?('member_guid') ? hash['member_guid'] : 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.
+      MemberElements.new(account_guid: account_guid,
+                         member_guid: member_guid,
+                         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} account_guid: #{@account_guid}, member_guid: #{@member_guid}, 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} account_guid: #{@account_guid.inspect}, member_guid:"\
+      " #{@member_guid.inspect}, user_guid: #{@user_guid.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/member_response.rb

@@ -0,0 +1,406 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MemberResponse Model.
+  class MemberResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the most recent aggregation-type job was started, given
+    # in ISO 8601 format with a time component.
+    # A job will automatically be started when a member is created or its
+    # credentials are updated, unless the `skip_aggregation` parameter is used.
+    # Jobs can also be started via manual aggregations, background aggregations,
+    # API endpoints, or when opening an MX widget.
+    # A job can be a normal aggregation, or a premium job such as
+    # identification, verification, fetching statements, or fetching an extended
+    # transaction history.
+    # If a member is deleted and then re-created with the `skip_aggregation`
+    # parameter set to `true` or if it is re-created within the throttle window
+    # (typically three hours), the previous value will be returned.
+    # @return [String]
+    attr_accessor :aggregated_at
+
+    # Indicates whether background aggregation is disabled for the `member`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :background_aggregation_is_disabled
+
+    # The status of a user's connection to an institution. See [Member
+    # Connection
+    # Status](/api-reference/platform-api/reference/members#member-connection-st
+    # atuses).
+    # @return [ConnectionStatus]
+    attr_accessor :connection_status
+
+    # A human-readable message describing the connection status. See [Member
+    # Connection
+    # Status](/api-reference/platform-api/reference/members#member-connection-st
+    # atuses).
+    # @return [String]
+    attr_accessor :connection_status_message
+
+    # A human-readable message describing the connection status. See [Member
+    # Connection
+    # Status](/api-reference/platform-api/reference/members#member-connection-st
+    # atuses).
+    # @return [Object]
+    attr_accessor :error
+
+    # The unique identifier for the member. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The unique partner-defined identifier for the member.
+    # @return [String]
+    attr_accessor :id
+
+    # The code identifying a financial institution.
+    # @return [String]
+    attr_accessor :institution_code
+
+    # The unique identifier for the institution. Defined by MX.
+    # @return [String]
+    attr_accessor :institution_guid
+
+    # Indicates whether the member was being aggregated at the time of the
+    # request.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_being_aggregated
+
+    # Indicates whether the member is managed by the user or the MX partner.
+    # Members created with the managed member feature will have this field set
+    # to `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_managed_by_user
+
+    # Indicates whether the transaction was manually created or belongs to a
+    # manual account.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_manual
+
+    # Indicates whether the member uses OAuth to authenticate. Defaults to
+    # `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_oauth
+
+    # Additional information you stored about the `member`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # (Deprecated) This field is no longer used and will be removed at a future
+    # date.
+    # @return [Integer]
+    attr_accessor :most_recent_job_detail_code
+
+    # (Deprecated) This field is no longer used and will be removed at a future
+    # date.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :most_recent_job_detail_text
+
+    # The unique identifier for the most recent job. Defined by MX.
+    # @return [String]
+    attr_accessor :most_recent_job_guid
+
+    # The name of the `member`.
+    # @return [String]
+    attr_accessor :name
+
+    # Internal field used by MX in some circumstances. When set to `true`, MX
+    # will not attempt to aggregate the member. It will be set to `false`
+    # automatically when the member's credentials are updated.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :needs_updated_credentials
+
+    # When connecting a member using OAuth, this field will contain the URL to
+    # send the user to in order to authenticate, otherwise it will be blank.
+    # @return [String]
+    attr_accessor :oauth_window_uri
+
+    # The date and time when the member was last successfully aggregated,
+    # represented in ISO 8601 format with a timestamp.
+    # @return [String]
+    attr_accessor :successfully_aggregated_at
+
+    # The use case associated with the member. Valid values are `PFM` and/or
+    # `MONEY_MOVEMENT`. Only set this if you've met with MX and have opted in to
+    # using this field.
+    # @return [Array[UseCase]]
+    attr_accessor :use_cases
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # The unique partner-defined identifier for the user.
+    # @return [String]
+    attr_accessor :user_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['aggregated_at'] = 'aggregated_at'
+      @_hash['background_aggregation_is_disabled'] =
+        'background_aggregation_is_disabled'
+      @_hash['connection_status'] = 'connection_status'
+      @_hash['connection_status_message'] = 'connection_status_message'
+      @_hash['error'] = 'error'
+      @_hash['guid'] = 'guid'
+      @_hash['id'] = 'id'
+      @_hash['institution_code'] = 'institution_code'
+      @_hash['institution_guid'] = 'institution_guid'
+      @_hash['is_being_aggregated'] = 'is_being_aggregated'
+      @_hash['is_managed_by_user'] = 'is_managed_by_user'
+      @_hash['is_manual'] = 'is_manual'
+      @_hash['is_oauth'] = 'is_oauth'
+      @_hash['metadata'] = 'metadata'
+      @_hash['most_recent_job_detail_code'] = 'most_recent_job_detail_code'
+      @_hash['most_recent_job_detail_text'] = 'most_recent_job_detail_text'
+      @_hash['most_recent_job_guid'] = 'most_recent_job_guid'
+      @_hash['name'] = 'name'
+      @_hash['needs_updated_credentials'] = 'needs_updated_credentials'
+      @_hash['oauth_window_uri'] = 'oauth_window_uri'
+      @_hash['successfully_aggregated_at'] = 'successfully_aggregated_at'
+      @_hash['use_cases'] = 'use_cases'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash['user_id'] = 'user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        aggregated_at
+        background_aggregation_is_disabled
+        connection_status
+        connection_status_message
+        error
+        guid
+        id
+        institution_code
+        institution_guid
+        is_being_aggregated
+        is_managed_by_user
+        is_manual
+        is_oauth
+        metadata
+        most_recent_job_detail_code
+        most_recent_job_detail_text
+        most_recent_job_guid
+        name
+        needs_updated_credentials
+        oauth_window_uri
+        successfully_aggregated_at
+        use_cases
+        user_guid
+        user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        aggregated_at
+        connection_status
+        connection_status_message
+        error
+        guid
+        id
+        institution_code
+        is_being_aggregated
+        is_managed_by_user
+        is_manual
+        is_oauth
+        metadata
+        most_recent_job_detail_code
+        most_recent_job_detail_text
+        most_recent_job_guid
+        name
+        needs_updated_credentials
+        oauth_window_uri
+        successfully_aggregated_at
+        user_guid
+        user_id
+      ]
+    end
+
+    def initialize(aggregated_at: SKIP,
+                   background_aggregation_is_disabled: SKIP,
+                   connection_status: SKIP, connection_status_message: SKIP,
+                   error: SKIP, guid: SKIP, id: SKIP, institution_code: SKIP,
+                   institution_guid: SKIP, is_being_aggregated: SKIP,
+                   is_managed_by_user: SKIP, is_manual: SKIP, is_oauth: SKIP,
+                   metadata: SKIP, most_recent_job_detail_code: SKIP,
+                   most_recent_job_detail_text: SKIP,
+                   most_recent_job_guid: SKIP, name: SKIP,
+                   needs_updated_credentials: SKIP, oauth_window_uri: SKIP,
+                   successfully_aggregated_at: SKIP, use_cases: SKIP,
+                   user_guid: SKIP, user_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @aggregated_at = aggregated_at unless aggregated_at == SKIP
+      unless background_aggregation_is_disabled == SKIP
+        @background_aggregation_is_disabled =
+          background_aggregation_is_disabled
+      end
+      @connection_status = connection_status unless connection_status == SKIP
+      unless connection_status_message == SKIP
+        @connection_status_message =
+          connection_status_message
+      end
+      @error = error unless error == SKIP
+      @guid = guid unless guid == SKIP
+      @id = id unless id == SKIP
+      @institution_code = institution_code unless institution_code == SKIP
+      @institution_guid = institution_guid unless institution_guid == SKIP
+      @is_being_aggregated = is_being_aggregated unless is_being_aggregated == SKIP
+      @is_managed_by_user = is_managed_by_user unless is_managed_by_user == SKIP
+      @is_manual = is_manual unless is_manual == SKIP
+      @is_oauth = is_oauth unless is_oauth == SKIP
+      @metadata = metadata unless metadata == SKIP
+      unless most_recent_job_detail_code == SKIP
+        @most_recent_job_detail_code =
+          most_recent_job_detail_code
+      end
+      unless most_recent_job_detail_text == SKIP
+        @most_recent_job_detail_text =
+          most_recent_job_detail_text
+      end
+      @most_recent_job_guid = most_recent_job_guid unless most_recent_job_guid == SKIP
+      @name = name unless name == SKIP
+      unless needs_updated_credentials == SKIP
+        @needs_updated_credentials =
+          needs_updated_credentials
+      end
+      @oauth_window_uri = oauth_window_uri unless oauth_window_uri == SKIP
+      unless successfully_aggregated_at == SKIP
+        @successfully_aggregated_at =
+          successfully_aggregated_at
+      end
+      @use_cases = use_cases unless use_cases == SKIP
+      @user_guid = user_guid unless user_guid == SKIP
+      @user_id = user_id unless user_id == 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.
+      aggregated_at = hash.key?('aggregated_at') ? hash['aggregated_at'] : SKIP
+      background_aggregation_is_disabled =
+        hash.key?('background_aggregation_is_disabled') ? hash['background_aggregation_is_disabled'] : SKIP
+      connection_status =
+        hash.key?('connection_status') ? hash['connection_status'] : SKIP
+      connection_status_message =
+        hash.key?('connection_status_message') ? hash['connection_status_message'] : SKIP
+      error = hash.key?('error') ? hash['error'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      institution_code =
+        hash.key?('institution_code') ? hash['institution_code'] : SKIP
+      institution_guid =
+        hash.key?('institution_guid') ? hash['institution_guid'] : SKIP
+      is_being_aggregated =
+        hash.key?('is_being_aggregated') ? hash['is_being_aggregated'] : SKIP
+      is_managed_by_user =
+        hash.key?('is_managed_by_user') ? hash['is_managed_by_user'] : SKIP
+      is_manual = hash.key?('is_manual') ? hash['is_manual'] : SKIP
+      is_oauth = hash.key?('is_oauth') ? hash['is_oauth'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      most_recent_job_detail_code =
+        hash.key?('most_recent_job_detail_code') ? hash['most_recent_job_detail_code'] : SKIP
+      most_recent_job_detail_text =
+        hash.key?('most_recent_job_detail_text') ? hash['most_recent_job_detail_text'] : SKIP
+      most_recent_job_guid =
+        hash.key?('most_recent_job_guid') ? hash['most_recent_job_guid'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      needs_updated_credentials =
+        hash.key?('needs_updated_credentials') ? hash['needs_updated_credentials'] : SKIP
+      oauth_window_uri =
+        hash.key?('oauth_window_uri') ? hash['oauth_window_uri'] : SKIP
+      successfully_aggregated_at =
+        hash.key?('successfully_aggregated_at') ? hash['successfully_aggregated_at'] : SKIP
+      use_cases = hash.key?('use_cases') ? hash['use_cases'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : SKIP
+      user_id = hash.key?('user_id') ? hash['user_id'] : 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.
+      MemberResponse.new(aggregated_at: aggregated_at,
+                         background_aggregation_is_disabled: background_aggregation_is_disabled,
+                         connection_status: connection_status,
+                         connection_status_message: connection_status_message,
+                         error: error,
+                         guid: guid,
+                         id: id,
+                         institution_code: institution_code,
+                         institution_guid: institution_guid,
+                         is_being_aggregated: is_being_aggregated,
+                         is_managed_by_user: is_managed_by_user,
+                         is_manual: is_manual,
+                         is_oauth: is_oauth,
+                         metadata: metadata,
+                         most_recent_job_detail_code: most_recent_job_detail_code,
+                         most_recent_job_detail_text: most_recent_job_detail_text,
+                         most_recent_job_guid: most_recent_job_guid,
+                         name: name,
+                         needs_updated_credentials: needs_updated_credentials,
+                         oauth_window_uri: oauth_window_uri,
+                         successfully_aggregated_at: successfully_aggregated_at,
+                         use_cases: use_cases,
+                         user_guid: user_guid,
+                         user_id: user_id,
+                         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} aggregated_at: #{@aggregated_at}, background_aggregation_is_disabled:"\
+      " #{@background_aggregation_is_disabled}, connection_status: #{@connection_status},"\
+      " connection_status_message: #{@connection_status_message}, error: #{@error}, guid:"\
+      " #{@guid}, id: #{@id}, institution_code: #{@institution_code}, institution_guid:"\
+      " #{@institution_guid}, is_being_aggregated: #{@is_being_aggregated}, is_managed_by_user:"\
+      " #{@is_managed_by_user}, is_manual: #{@is_manual}, is_oauth: #{@is_oauth}, metadata:"\
+      " #{@metadata}, most_recent_job_detail_code: #{@most_recent_job_detail_code},"\
+      " most_recent_job_detail_text: #{@most_recent_job_detail_text}, most_recent_job_guid:"\
+      " #{@most_recent_job_guid}, name: #{@name}, needs_updated_credentials:"\
+      " #{@needs_updated_credentials}, oauth_window_uri: #{@oauth_window_uri},"\
+      " successfully_aggregated_at: #{@successfully_aggregated_at}, use_cases: #{@use_cases},"\
+      " user_guid: #{@user_guid}, user_id: #{@user_id}, 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} aggregated_at: #{@aggregated_at.inspect},"\
+      " background_aggregation_is_disabled: #{@background_aggregation_is_disabled.inspect},"\
+      " connection_status: #{@connection_status.inspect}, connection_status_message:"\
+      " #{@connection_status_message.inspect}, error: #{@error.inspect}, guid: #{@guid.inspect},"\
+      " id: #{@id.inspect}, institution_code: #{@institution_code.inspect}, institution_guid:"\
+      " #{@institution_guid.inspect}, is_being_aggregated: #{@is_being_aggregated.inspect},"\
+      " is_managed_by_user: #{@is_managed_by_user.inspect}, is_manual: #{@is_manual.inspect},"\
+      " is_oauth: #{@is_oauth.inspect}, metadata: #{@metadata.inspect},"\
+      " most_recent_job_detail_code: #{@most_recent_job_detail_code.inspect},"\
+      " most_recent_job_detail_text: #{@most_recent_job_detail_text.inspect},"\
+      " most_recent_job_guid: #{@most_recent_job_guid.inspect}, name: #{@name.inspect},"\
+      " needs_updated_credentials: #{@needs_updated_credentials.inspect}, oauth_window_uri:"\
+      " #{@oauth_window_uri.inspect}, successfully_aggregated_at:"\
+      " #{@successfully_aggregated_at.inspect}, use_cases: #{@use_cases.inspect}, user_guid:"\
+      " #{@user_guid.inspect}, user_id: #{@user_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/member_response_body.rb

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