apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/monthly_cash_flow_response.rb

@@ -0,0 +1,157 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # MonthlyCashFlowResponse Model.
+  class MonthlyCashFlowResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the monthly cash flow profile. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # Unique identifier for the user the monthly cash flow profile is attached
+    # to. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # The amount of the budgeted income for the user.
+    # @return [Float]
+    attr_accessor :budgeted_income
+
+    # The amount of the budgeted expenses for the user.
+    # @return [Float]
+    attr_accessor :budgeted_expenses
+
+    # The monthly dollar amount allocated for goals.
+    # @return [Float]
+    attr_accessor :goals_contribution
+
+    # The estimated monthly dollar amount allocated for goals calculated from
+    # income and budgets.
+    # @return [Float]
+    attr_accessor :estimated_goals_contribution
+
+    # Indicates if the user uses estimated goals contribution.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :uses_estimated_goals_contribution
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['guid'] = 'guid'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash['budgeted_income'] = 'budgeted_income'
+      @_hash['budgeted_expenses'] = 'budgeted_expenses'
+      @_hash['goals_contribution'] = 'goals_contribution'
+      @_hash['estimated_goals_contribution'] = 'estimated_goals_contribution'
+      @_hash['uses_estimated_goals_contribution'] =
+        'uses_estimated_goals_contribution'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        guid
+        user_guid
+        budgeted_income
+        budgeted_expenses
+        goals_contribution
+        estimated_goals_contribution
+        uses_estimated_goals_contribution
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        estimated_goals_contribution
+      ]
+    end
+
+    def initialize(guid: SKIP, user_guid: SKIP, budgeted_income: SKIP,
+                   budgeted_expenses: SKIP, goals_contribution: SKIP,
+                   estimated_goals_contribution: SKIP,
+                   uses_estimated_goals_contribution: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @guid = guid unless guid == SKIP
+      @user_guid = user_guid unless user_guid == SKIP
+      @budgeted_income = budgeted_income unless budgeted_income == SKIP
+      @budgeted_expenses = budgeted_expenses unless budgeted_expenses == SKIP
+      @goals_contribution = goals_contribution unless goals_contribution == SKIP
+      unless estimated_goals_contribution == SKIP
+        @estimated_goals_contribution =
+          estimated_goals_contribution
+      end
+      unless uses_estimated_goals_contribution == SKIP
+        @uses_estimated_goals_contribution =
+          uses_estimated_goals_contribution
+      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.
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : SKIP
+      budgeted_income =
+        hash.key?('budgeted_income') ? hash['budgeted_income'] : SKIP
+      budgeted_expenses =
+        hash.key?('budgeted_expenses') ? hash['budgeted_expenses'] : SKIP
+      goals_contribution =
+        hash.key?('goals_contribution') ? hash['goals_contribution'] : SKIP
+      estimated_goals_contribution =
+        hash.key?('estimated_goals_contribution') ? hash['estimated_goals_contribution'] : SKIP
+      uses_estimated_goals_contribution =
+        hash.key?('uses_estimated_goals_contribution') ? hash['uses_estimated_goals_contribution'] : 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.
+      MonthlyCashFlowResponse.new(guid: guid,
+                                  user_guid: user_guid,
+                                  budgeted_income: budgeted_income,
+                                  budgeted_expenses: budgeted_expenses,
+                                  goals_contribution: goals_contribution,
+                                  estimated_goals_contribution: estimated_goals_contribution,
+                                  uses_estimated_goals_contribution: uses_estimated_goals_contribution,
+                                  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}, user_guid: #{@user_guid}, budgeted_income:"\
+      " #{@budgeted_income}, budgeted_expenses: #{@budgeted_expenses}, goals_contribution:"\
+      " #{@goals_contribution}, estimated_goals_contribution: #{@estimated_goals_contribution},"\
+      " uses_estimated_goals_contribution: #{@uses_estimated_goals_contribution},"\
+      " 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}, user_guid: #{@user_guid.inspect}, budgeted_income:"\
+      " #{@budgeted_income.inspect}, budgeted_expenses: #{@budgeted_expenses.inspect},"\
+      " goals_contribution: #{@goals_contribution.inspect}, estimated_goals_contribution:"\
+      " #{@estimated_goals_contribution.inspect}, uses_estimated_goals_contribution:"\
+      " #{@uses_estimated_goals_contribution.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/monthly_cash_flow_response_body.rb

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

data/lib/mx_platform_api/models/notification_request.rb

@@ -0,0 +1,83 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # NotificationRequest Model.
+  class NotificationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The main body of the notification text sent to the user.
+    # @return [String]
+    attr_accessor :content
+
+    # The notification summary text. Usually the same text used for “in-app” or
+    # SMS notifications.
+    # @return [String]
+    attr_accessor :subject
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content'] = 'content'
+      @_hash['subject'] = 'subject'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(content:, subject:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @content = content
+      @subject = subject
+      @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.
+      content = hash.key?('content') ? hash['content'] : nil
+      subject = hash.key?('subject') ? hash['subject'] : nil
+
+      # 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.
+      NotificationRequest.new(content: content,
+                              subject: subject,
+                              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} content: #{@content}, subject: #{@subject}, 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} content: #{@content.inspect}, subject: #{@subject.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/notification_request_body.rb

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

data/lib/mx_platform_api/models/notification_response.rb

@@ -0,0 +1,204 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # NotificationResponse Model.
+  class NotificationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The way the notification will be delivered to the user.
+    # All notifications created through the API will be of notification type
+    # `API_NOTIFICATION`, channel `PUSH`, and will not be associated to an
+    # entity. No other channels are supported.
+    # @return [Channel]
+    attr_accessor :channel
+
+    # The main body of the notification text sent to the user.
+    # @return [String]
+    attr_accessor :content
+
+    # The date and time the notification was created, represented in ISO 8601
+    # format with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The unique identifier for objects that directly trigger a notification.
+    # For example, `TRANSACTION_FEE_CHARGE` and `TRANSACTION_EXPENSE_LARGE`
+    # notification types will have a transaction guid in this field.
+    # @return [Object]
+    attr_accessor :deep_link_guid
+
+    # Date and time the notification was delivered, represented in ISO 8601
+    # format with timestamp.
+    # @return [Object]
+    attr_accessor :delivered_at
+
+    # The unique identifier of the entity that the notification is attached to.
+    # @return [Object]
+    attr_accessor :entity_guid
+
+    # Unique identifier for the notification. Defined by MX.
+    # @return [Object]
+    attr_accessor :guid
+
+    # Indicates if the notification has been delivered to the user.
+    # @return [Object]
+    attr_accessor :has_been_delivered
+
+    # Indicates if the notification has been viewed by the user.
+    # @return [Object]
+    attr_accessor :has_been_viewed
+
+    # The type of notification. See [Notification
+    # Types](/api-reference/platform-api/reference/notifications-fields#notifica
+    # tion-types).
+    # @return [Object]
+    attr_accessor :notification_type
+
+    # The notification summary text. Usually the same text used for “in-app” or
+    # SMS notifications.
+    # @return [Object]
+    attr_accessor :subject
+
+    # The notification summary text. Usually the same text used for “in-app” or
+    # SMS notifications.
+    # @return [Object]
+    attr_accessor :threshold
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['channel'] = 'channel'
+      @_hash['content'] = 'content'
+      @_hash['created_at'] = 'created_at'
+      @_hash['deep_link_guid'] = 'deep_link_guid'
+      @_hash['delivered_at'] = 'delivered_at'
+      @_hash['entity_guid'] = 'entity_guid'
+      @_hash['guid'] = 'guid'
+      @_hash['has_been_delivered'] = 'has_been_delivered'
+      @_hash['has_been_viewed'] = 'has_been_viewed'
+      @_hash['notification_type'] = 'notification_type'
+      @_hash['subject'] = 'subject'
+      @_hash['threshold'] = 'threshold'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        channel
+        content
+        created_at
+        deep_link_guid
+        delivered_at
+        entity_guid
+        guid
+        has_been_delivered
+        has_been_viewed
+        notification_type
+        subject
+        threshold
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        channel
+      ]
+    end
+
+    def initialize(channel: SKIP, content: SKIP, created_at: SKIP,
+                   deep_link_guid: SKIP, delivered_at: SKIP, entity_guid: SKIP,
+                   guid: SKIP, has_been_delivered: SKIP, has_been_viewed: SKIP,
+                   notification_type: SKIP, subject: SKIP, threshold: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @channel = channel unless channel == SKIP
+      @content = content unless content == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @deep_link_guid = deep_link_guid unless deep_link_guid == SKIP
+      @delivered_at = delivered_at unless delivered_at == SKIP
+      @entity_guid = entity_guid unless entity_guid == SKIP
+      @guid = guid unless guid == SKIP
+      @has_been_delivered = has_been_delivered unless has_been_delivered == SKIP
+      @has_been_viewed = has_been_viewed unless has_been_viewed == SKIP
+      @notification_type = notification_type unless notification_type == SKIP
+      @subject = subject unless subject == SKIP
+      @threshold = threshold unless threshold == 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.
+      channel = hash.key?('channel') ? hash['channel'] : SKIP
+      content = hash.key?('content') ? hash['content'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      deep_link_guid =
+        hash.key?('deep_link_guid') ? hash['deep_link_guid'] : SKIP
+      delivered_at = hash.key?('delivered_at') ? hash['delivered_at'] : SKIP
+      entity_guid = hash.key?('entity_guid') ? hash['entity_guid'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      has_been_delivered =
+        hash.key?('has_been_delivered') ? hash['has_been_delivered'] : SKIP
+      has_been_viewed =
+        hash.key?('has_been_viewed') ? hash['has_been_viewed'] : SKIP
+      notification_type =
+        hash.key?('notification_type') ? hash['notification_type'] : SKIP
+      subject = hash.key?('subject') ? hash['subject'] : SKIP
+      threshold = hash.key?('threshold') ? hash['threshold'] : 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.
+      NotificationResponse.new(channel: channel,
+                               content: content,
+                               created_at: created_at,
+                               deep_link_guid: deep_link_guid,
+                               delivered_at: delivered_at,
+                               entity_guid: entity_guid,
+                               guid: guid,
+                               has_been_delivered: has_been_delivered,
+                               has_been_viewed: has_been_viewed,
+                               notification_type: notification_type,
+                               subject: subject,
+                               threshold: threshold,
+                               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} channel: #{@channel}, content: #{@content}, created_at: #{@created_at},"\
+      " deep_link_guid: #{@deep_link_guid}, delivered_at: #{@delivered_at}, entity_guid:"\
+      " #{@entity_guid}, guid: #{@guid}, has_been_delivered: #{@has_been_delivered},"\
+      " has_been_viewed: #{@has_been_viewed}, notification_type: #{@notification_type}, subject:"\
+      " #{@subject}, threshold: #{@threshold}, 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} channel: #{@channel.inspect}, content: #{@content.inspect}, created_at:"\
+      " #{@created_at.inspect}, deep_link_guid: #{@deep_link_guid.inspect}, delivered_at:"\
+      " #{@delivered_at.inspect}, entity_guid: #{@entity_guid.inspect}, guid: #{@guid.inspect},"\
+      " has_been_delivered: #{@has_been_delivered.inspect}, has_been_viewed:"\
+      " #{@has_been_viewed.inspect}, notification_type: #{@notification_type.inspect}, subject:"\
+      " #{@subject.inspect}, threshold: #{@threshold.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/notification_response_body.rb

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