apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/notifications_response_body.rb

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

data/lib/mx_platform_api/models/oauth_window_response.rb

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

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

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

data/lib/mx_platform_api/models/pagination_response.rb

@@ -0,0 +1,106 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # PaginationResponse Model.
+  class PaginationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The page delivered by the current response.
+    # @return [Integer]
+    attr_accessor :current_page
+
+    # The number of records delivered with each page.
+    # @return [Integer]
+    attr_accessor :per_page
+
+    # The total number of records available.
+    # @return [Integer]
+    attr_accessor :total_entries
+
+    # The total number of pages available.
+    # @return [Integer]
+    attr_accessor :total_pages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['current_page'] = 'current_page'
+      @_hash['per_page'] = 'per_page'
+      @_hash['total_entries'] = 'total_entries'
+      @_hash['total_pages'] = 'total_pages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        current_page
+        per_page
+        total_entries
+        total_pages
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(current_page: SKIP, per_page: SKIP, total_entries: SKIP,
+                   total_pages: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @current_page = current_page unless current_page == SKIP
+      @per_page = per_page unless per_page == SKIP
+      @total_entries = total_entries unless total_entries == SKIP
+      @total_pages = total_pages unless total_pages == 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.
+      current_page = hash.key?('current_page') ? hash['current_page'] : SKIP
+      per_page = hash.key?('per_page') ? hash['per_page'] : SKIP
+      total_entries = hash.key?('total_entries') ? hash['total_entries'] : SKIP
+      total_pages = hash.key?('total_pages') ? hash['total_pages'] : 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.
+      PaginationResponse.new(current_page: current_page,
+                             per_page: per_page,
+                             total_entries: total_entries,
+                             total_pages: total_pages,
+                             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} current_page: #{@current_page}, per_page: #{@per_page}, total_entries:"\
+      " #{@total_entries}, total_pages: #{@total_pages}, 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} current_page: #{@current_page.inspect}, per_page: #{@per_page.inspect},"\
+      " total_entries: #{@total_entries.inspect}, total_pages: #{@total_pages.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/parent_class.rb

@@ -0,0 +1,84 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # ParentClass.
+  class ParentClass
+    PARENT_CLASS = [
+      # TODO: Write general description for PAYROLL
+      PAYROLL = 'Payroll'.freeze,
+
+      # TODO: Write general description for DEPOSIT
+      DEPOSIT = 'Deposit'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'Savings'.freeze,
+
+      # TODO: Write general description for TRANSFER
+      TRANSFER = 'Transfer'.freeze,
+
+      # TODO: Write general description for REFUNDS
+      REFUNDS = 'Refunds'.freeze,
+
+      # TODO: Write general description for SPEND
+      SPEND = 'Spend'.freeze,
+
+      # TODO: Write general description for INVESTMENT
+      INVESTMENT = 'Investment'.freeze,
+
+      # TODO: Write general description for BUY
+      BUY = 'Buy'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'Sell'.freeze,
+
+      # TODO: Write general description for INCOME
+      INCOME = 'Income'.freeze,
+
+      # TODO: Write general description for FEES
+      FEES = 'Fees'.freeze,
+
+      # TODO: Write general description for EXPENSES
+      EXPENSES = 'Expenses'.freeze,
+
+      # TODO: Write general description for ENUM_CORPORATE_ACTIONS
+      ENUM_CORPORATE_ACTIONS = 'Corporate Actions'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'Other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PARENT_CLASS.include?(value)
+    end
+
+    def self.from_value(value, default_value = PAYROLL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'payroll' then PAYROLL
+      when 'deposit' then DEPOSIT
+      when 'savings' then SAVINGS
+      when 'transfer' then TRANSFER
+      when 'refunds' then REFUNDS
+      when 'spend' then SPEND
+      when 'investment' then INVESTMENT
+      when 'buy' then BUY
+      when 'sell' then SELL
+      when 'income' then INCOME
+      when 'fees' then FEES
+      when 'expenses' then EXPENSES
+      when 'enum_corporate_actions' then ENUM_CORPORATE_ACTIONS
+      when 'other' then OTHER
+      else
+        default_value
+      end
+    end
+  end
+end