apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/member_status_response.rb

@@ -0,0 +1,236 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MemberStatusResponse Model.
+  class MemberStatusResponse < 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
+
+    # 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 [Array[ChallengeResponse]]
+    attr_accessor :challenges
+
+    # 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
+
+    # The unique identifier for the member. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # Indicates whether the member has processed account numbers.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_processed_account_numbers
+
+    # Indicates whether the member has processed accounts.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_processed_accounts
+
+    # Indicates whether the member has processed transactions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_processed_transactions
+
+    # Indicates whether the member has processed transactions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_authenticated
+
+    # Indicates whether the member has processed transactions.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_being_aggregated
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['aggregated_at'] = 'aggregated_at'
+      @_hash['challenges'] = 'challenges'
+      @_hash['connection_status'] = 'connection_status'
+      @_hash['guid'] = 'guid'
+      @_hash['has_processed_account_numbers'] =
+        'has_processed_account_numbers'
+      @_hash['has_processed_accounts'] = 'has_processed_accounts'
+      @_hash['has_processed_transactions'] = 'has_processed_transactions'
+      @_hash['is_authenticated'] = 'is_authenticated'
+      @_hash['is_being_aggregated'] = 'is_being_aggregated'
+      @_hash['successfully_aggregated_at'] = 'successfully_aggregated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        aggregated_at
+        challenges
+        connection_status
+        guid
+        has_processed_account_numbers
+        has_processed_accounts
+        has_processed_transactions
+        is_authenticated
+        is_being_aggregated
+        successfully_aggregated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        aggregated_at
+        connection_status
+        guid
+        has_processed_account_numbers
+        has_processed_accounts
+        has_processed_transactions
+        is_authenticated
+        is_being_aggregated
+        successfully_aggregated_at
+      ]
+    end
+
+    def initialize(aggregated_at: SKIP, challenges: SKIP,
+                   connection_status: SKIP, guid: SKIP,
+                   has_processed_account_numbers: SKIP,
+                   has_processed_accounts: SKIP,
+                   has_processed_transactions: SKIP, is_authenticated: SKIP,
+                   is_being_aggregated: SKIP, successfully_aggregated_at: 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
+      @challenges = challenges unless challenges == SKIP
+      @connection_status = connection_status unless connection_status == SKIP
+      @guid = guid unless guid == SKIP
+      unless has_processed_account_numbers == SKIP
+        @has_processed_account_numbers =
+          has_processed_account_numbers
+      end
+      @has_processed_accounts = has_processed_accounts unless has_processed_accounts == SKIP
+      unless has_processed_transactions == SKIP
+        @has_processed_transactions =
+          has_processed_transactions
+      end
+      @is_authenticated = is_authenticated unless is_authenticated == SKIP
+      @is_being_aggregated = is_being_aggregated unless is_being_aggregated == SKIP
+      unless successfully_aggregated_at == SKIP
+        @successfully_aggregated_at =
+          successfully_aggregated_at
+      end
+      @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
+      # Parameter is an array, so we need to iterate through it
+      challenges = nil
+      unless hash['challenges'].nil?
+        challenges = []
+        hash['challenges'].each do |structure|
+          challenges << (ChallengeResponse.from_hash(structure) if structure)
+        end
+      end
+
+      challenges = SKIP unless hash.key?('challenges')
+      connection_status =
+        hash.key?('connection_status') ? hash['connection_status'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      has_processed_account_numbers =
+        hash.key?('has_processed_account_numbers') ? hash['has_processed_account_numbers'] : SKIP
+      has_processed_accounts =
+        hash.key?('has_processed_accounts') ? hash['has_processed_accounts'] : SKIP
+      has_processed_transactions =
+        hash.key?('has_processed_transactions') ? hash['has_processed_transactions'] : SKIP
+      is_authenticated =
+        hash.key?('is_authenticated') ? hash['is_authenticated'] : SKIP
+      is_being_aggregated =
+        hash.key?('is_being_aggregated') ? hash['is_being_aggregated'] : SKIP
+      successfully_aggregated_at =
+        hash.key?('successfully_aggregated_at') ? hash['successfully_aggregated_at'] : 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.
+      MemberStatusResponse.new(aggregated_at: aggregated_at,
+                               challenges: challenges,
+                               connection_status: connection_status,
+                               guid: guid,
+                               has_processed_account_numbers: has_processed_account_numbers,
+                               has_processed_accounts: has_processed_accounts,
+                               has_processed_transactions: has_processed_transactions,
+                               is_authenticated: is_authenticated,
+                               is_being_aggregated: is_being_aggregated,
+                               successfully_aggregated_at: successfully_aggregated_at,
+                               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}, challenges: #{@challenges},"\
+      " connection_status: #{@connection_status}, guid: #{@guid}, has_processed_account_numbers:"\
+      " #{@has_processed_account_numbers}, has_processed_accounts: #{@has_processed_accounts},"\
+      " has_processed_transactions: #{@has_processed_transactions}, is_authenticated:"\
+      " #{@is_authenticated}, is_being_aggregated: #{@is_being_aggregated},"\
+      " successfully_aggregated_at: #{@successfully_aggregated_at}, 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}, challenges:"\
+      " #{@challenges.inspect}, connection_status: #{@connection_status.inspect}, guid:"\
+      " #{@guid.inspect}, has_processed_account_numbers:"\
+      " #{@has_processed_account_numbers.inspect}, has_processed_accounts:"\
+      " #{@has_processed_accounts.inspect}, has_processed_transactions:"\
+      " #{@has_processed_transactions.inspect}, is_authenticated: #{@is_authenticated.inspect},"\
+      " is_being_aggregated: #{@is_being_aggregated.inspect}, successfully_aggregated_at:"\
+      " #{@successfully_aggregated_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/member_status_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
+  # MemberStatusResponseBody Model.
+  class MemberStatusResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MemberStatusResponse]
+    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 = MemberStatusResponse.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.
+      MemberStatusResponseBody.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

data/lib/mx_platform_api/models/member_update_request.rb

@@ -0,0 +1,133 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MemberUpdateRequest Model.
+  class MemberUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether background aggregation is disabled for the `member`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :background_aggregation_is_disabled
+
+    # Indicates whether background aggregation is disabled for the `member`.
+    # @return [Array[CredentialRequest]]
+    attr_accessor :credentials
+
+    # The unique partner-defined identifier for the member.
+    # @return [String]
+    attr_accessor :id
+
+    # Additional information you can store about the `member`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['background_aggregation_is_disabled'] =
+        'background_aggregation_is_disabled'
+      @_hash['credentials'] = 'credentials'
+      @_hash['id'] = 'id'
+      @_hash['metadata'] = 'metadata'
+      @_hash['use_cases'] = 'use_cases'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        background_aggregation_is_disabled
+        credentials
+        id
+        metadata
+        use_cases
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(background_aggregation_is_disabled: SKIP, credentials: SKIP,
+                   id: SKIP, metadata: SKIP, use_cases: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless background_aggregation_is_disabled == SKIP
+        @background_aggregation_is_disabled =
+          background_aggregation_is_disabled
+      end
+      @credentials = credentials unless credentials == SKIP
+      @id = id unless id == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @use_cases = use_cases unless use_cases == 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.
+      background_aggregation_is_disabled =
+        hash.key?('background_aggregation_is_disabled') ? hash['background_aggregation_is_disabled'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      credentials = nil
+      unless hash['credentials'].nil?
+        credentials = []
+        hash['credentials'].each do |structure|
+          credentials << (CredentialRequest.from_hash(structure) if structure)
+        end
+      end
+
+      credentials = SKIP unless hash.key?('credentials')
+      id = hash.key?('id') ? hash['id'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      use_cases = hash.key?('use_cases') ? hash['use_cases'] : 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.
+      MemberUpdateRequest.new(background_aggregation_is_disabled: background_aggregation_is_disabled,
+                              credentials: credentials,
+                              id: id,
+                              metadata: metadata,
+                              use_cases: use_cases,
+                              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} background_aggregation_is_disabled: #{@background_aggregation_is_disabled},"\
+      " credentials: #{@credentials}, id: #{@id}, metadata: #{@metadata}, use_cases:"\
+      " #{@use_cases}, 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} background_aggregation_is_disabled:"\
+      " #{@background_aggregation_is_disabled.inspect}, credentials: #{@credentials.inspect}, id:"\
+      " #{@id.inspect}, metadata: #{@metadata.inspect}, use_cases: #{@use_cases.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/member_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
+  # MemberUpdateRequestBody Model.
+  class MemberUpdateRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MemberUpdateRequest]
+    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 = MemberUpdateRequest.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.
+      MemberUpdateRequestBody.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

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