apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/use_case.rb

@@ -0,0 +1,36 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # UseCase.
+  class UseCase
+    USE_CASE = [
+      # TODO: Write general description for MONEY_MOVEMENT
+      MONEY_MOVEMENT = 'MONEY_MOVEMENT'.freeze,
+
+      # TODO: Write general description for PFM
+      PFM = 'PFM'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      USE_CASE.include?(value)
+    end
+
+    def self.from_value(value, default_value = MONEY_MOVEMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'money_movement' then MONEY_MOVEMENT
+      when 'pfm' then PFM
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/mx_platform_api/models/user_create_request.rb

@@ -0,0 +1,105 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # UserCreateRequest Model.
+  class UserCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The email address associated with the account.
+    # @return [String]
+    attr_accessor :email
+
+    # The unique partner-defined identifier for the user.
+    # @return [String]
+    attr_accessor :id
+
+    # Indicates whether the user has been disabled. Defaults to `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_disabled
+
+    # Additional information you can store about the `user`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['id'] = 'id'
+      @_hash['is_disabled'] = 'is_disabled'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email
+        id
+        is_disabled
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email: SKIP, id: SKIP, is_disabled: SKIP, metadata: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @email = email unless email == SKIP
+      @id = id unless id == SKIP
+      @is_disabled = is_disabled unless is_disabled == SKIP
+      @metadata = metadata unless metadata == 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.
+      email = hash.key?('email') ? hash['email'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      is_disabled = hash.key?('is_disabled') ? hash['is_disabled'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : 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.
+      UserCreateRequest.new(email: email,
+                            id: id,
+                            is_disabled: is_disabled,
+                            metadata: metadata,
+                            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} email: #{@email}, id: #{@id}, is_disabled: #{@is_disabled}, metadata:"\
+      " #{@metadata}, 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} email: #{@email.inspect}, id: #{@id.inspect}, is_disabled:"\
+      " #{@is_disabled.inspect}, metadata: #{@metadata.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/user_create_request_body.rb

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

data/lib/mx_platform_api/models/user_response.rb

@@ -0,0 +1,119 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # UserResponse Model.
+  class UserResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The email address associated with the account.
+    # @return [String]
+    attr_accessor :email
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The unique partner-defined identifier for the user.
+    # @return [String]
+    attr_accessor :id
+
+    # Indicates whether the user has been disabled. Defaults to `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_disabled
+
+    # Additional information you stored about the `user`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['guid'] = 'guid'
+      @_hash['id'] = 'id'
+      @_hash['is_disabled'] = 'is_disabled'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email
+        guid
+        id
+        is_disabled
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        guid
+        id
+        is_disabled
+        metadata
+      ]
+    end
+
+    def initialize(email: SKIP, guid: SKIP, id: SKIP, is_disabled: SKIP,
+                   metadata: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @email = email unless email == SKIP
+      @guid = guid unless guid == SKIP
+      @id = id unless id == SKIP
+      @is_disabled = is_disabled unless is_disabled == SKIP
+      @metadata = metadata unless metadata == 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.
+      email = hash.key?('email') ? hash['email'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      is_disabled = hash.key?('is_disabled') ? hash['is_disabled'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : 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.
+      UserResponse.new(email: email,
+                       guid: guid,
+                       id: id,
+                       is_disabled: is_disabled,
+                       metadata: metadata,
+                       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} email: #{@email}, guid: #{@guid}, id: #{@id}, is_disabled: #{@is_disabled},"\
+      " metadata: #{@metadata}, 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} email: #{@email.inspect}, guid: #{@guid.inspect}, id: #{@id.inspect},"\
+      " is_disabled: #{@is_disabled.inspect}, metadata: #{@metadata.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/user_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
+  # UserResponseBody Model.
+  class UserResponseBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [UserResponse]
+    attr_accessor :user
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user'] = 'user'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user = user unless user == 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.
+      user = UserResponse.from_hash(hash['user']) if hash['user']
+
+      # 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.
+      UserResponseBody.new(user: user,
+                           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} user: #{@user}, 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} user: #{@user.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/user_update_request.rb

@@ -0,0 +1,105 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # UserUpdateRequest Model.
+  class UserUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The email address associated with the account.
+    # @return [String]
+    attr_accessor :email
+
+    # The unique partner-defined identifier for the user.
+    # @return [String]
+    attr_accessor :id
+
+    # Indicates whether the user has been disabled. Defaults to `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_disabled
+
+    # Additional information you can store about the `user`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email'] = 'email'
+      @_hash['id'] = 'id'
+      @_hash['is_disabled'] = 'is_disabled'
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        email
+        id
+        is_disabled
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(email: SKIP, id: SKIP, is_disabled: SKIP, metadata: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @email = email unless email == SKIP
+      @id = id unless id == SKIP
+      @is_disabled = is_disabled unless is_disabled == SKIP
+      @metadata = metadata unless metadata == 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.
+      email = hash.key?('email') ? hash['email'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      is_disabled = hash.key?('is_disabled') ? hash['is_disabled'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : 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.
+      UserUpdateRequest.new(email: email,
+                            id: id,
+                            is_disabled: is_disabled,
+                            metadata: metadata,
+                            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} email: #{@email}, id: #{@id}, is_disabled: #{@is_disabled}, metadata:"\
+      " #{@metadata}, 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} email: #{@email.inspect}, id: #{@id.inspect}, is_disabled:"\
+      " #{@is_disabled.inspect}, metadata: #{@metadata.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/user_update_request_body.rb

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

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