apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/insight_response.rb

@@ -0,0 +1,338 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # InsightResponse Model.
+  class InsightResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time when the insight was activated, represented in ISO 8601
+    # format with a timestamp.
+    # @return [String]
+    attr_accessor :active_at
+
+    # The unique identifier for the client associated with the insight. Defined
+    # by MX.
+    # @return [String]
+    attr_accessor :client_guid
+
+    # The date and time the insight was created, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The date and time when a call-to-action was clicked, represented in ISO
+    # 8601 format with a timestamp.
+    # @return [String]
+    attr_accessor :cta_clicked_at
+
+    # The human-readable information being delivered to the end user.
+    # @return [String]
+    attr_accessor :description
+
+    # The unique identifier for the `insight`. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # Indicates whether there are accounts associated with the insight.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_associated_accounts
+
+    # Indicates whether there are categories associated with the insight.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_associated_categories
+
+    # Indicates whether there are merchants associated with the insight.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_associated_merchants
+
+    # Indicates whether there are scheduled payments associated with the
+    # insight.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_associated_scheduled_payments
+
+    # Indicates whether there are transactions associated with the insight.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_associated_transactions
+
+    # Indicates whether the insight has been shown to the end user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_been_displayed
+
+    # Indicates whether the insight has been dismissed by the user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_dismissed
+
+    # A short call-to-action text for prompting user engagement.
+    # @return [String]
+    attr_accessor :micro_call_to_action
+
+    # A shorter version (300 characters or less) of `description`. This is the
+    # insight's description we display to the end user in the Micro Widget
+    # @return [String]
+    attr_accessor :micro_description
+
+    # A shorter version (60 characters or less) of `title`. This is the
+    # insight's title we display to the end user in the Micro Widget. For
+    # example, `Price Increase` or `Paycheck Deposit`.
+    # @return [String]
+    attr_accessor :micro_title
+
+    # A short label for the type of `insight` being delivered, for example,
+    # `SubscriptionPriceIncrease` or `MonthlyCategoryTotal`.
+    # @return [String]
+    attr_accessor :template
+
+    # The title for the specific `insight`, for example, `Price Increase` or
+    # `Paycheck Deposit`.
+    # @return [String]
+    attr_accessor :title
+
+    # The date and time the resource was last updated in ISO 8601 format with a
+    # timestamp.
+    # For categories, this field will always be `null` when `is_default` is
+    # `true`.
+    # @return [String]
+    attr_accessor :updated_at
+
+    # 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['active_at'] = 'active_at'
+      @_hash['client_guid'] = 'client_guid'
+      @_hash['created_at'] = 'created_at'
+      @_hash['cta_clicked_at'] = 'cta_clicked_at'
+      @_hash['description'] = 'description'
+      @_hash['guid'] = 'guid'
+      @_hash['has_associated_accounts'] = 'has_associated_accounts'
+      @_hash['has_associated_categories'] = 'has_associated_categories'
+      @_hash['has_associated_merchants'] = 'has_associated_merchants'
+      @_hash['has_associated_scheduled_payments'] =
+        'has_associated_scheduled_payments'
+      @_hash['has_associated_transactions'] = 'has_associated_transactions'
+      @_hash['has_been_displayed'] = 'has_been_displayed'
+      @_hash['is_dismissed'] = 'is_dismissed'
+      @_hash['micro_call_to_action'] = 'micro_call_to_action'
+      @_hash['micro_description'] = 'micro_description'
+      @_hash['micro_title'] = 'micro_title'
+      @_hash['template'] = 'template'
+      @_hash['title'] = 'title'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash['user_id'] = 'user_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        active_at
+        client_guid
+        created_at
+        cta_clicked_at
+        description
+        guid
+        has_associated_accounts
+        has_associated_categories
+        has_associated_merchants
+        has_associated_scheduled_payments
+        has_associated_transactions
+        has_been_displayed
+        is_dismissed
+        micro_call_to_action
+        micro_description
+        micro_title
+        template
+        title
+        updated_at
+        user_guid
+        user_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        active_at
+        created_at
+        cta_clicked_at
+        description
+        guid
+        has_associated_accounts
+        has_associated_categories
+        has_associated_merchants
+        has_associated_scheduled_payments
+        has_associated_transactions
+        has_been_displayed
+        is_dismissed
+        micro_call_to_action
+        micro_description
+        micro_title
+        template
+        title
+        updated_at
+      ]
+    end
+
+    def initialize(active_at: SKIP, client_guid: SKIP, created_at: SKIP,
+                   cta_clicked_at: SKIP, description: SKIP, guid: SKIP,
+                   has_associated_accounts: SKIP,
+                   has_associated_categories: SKIP,
+                   has_associated_merchants: SKIP,
+                   has_associated_scheduled_payments: SKIP,
+                   has_associated_transactions: SKIP, has_been_displayed: SKIP,
+                   is_dismissed: SKIP, micro_call_to_action: SKIP,
+                   micro_description: SKIP, micro_title: SKIP, template: SKIP,
+                   title: SKIP, updated_at: SKIP, user_guid: SKIP,
+                   user_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @active_at = active_at unless active_at == SKIP
+      @client_guid = client_guid unless client_guid == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @cta_clicked_at = cta_clicked_at unless cta_clicked_at == SKIP
+      @description = description unless description == SKIP
+      @guid = guid unless guid == SKIP
+      @has_associated_accounts = has_associated_accounts unless has_associated_accounts == SKIP
+      unless has_associated_categories == SKIP
+        @has_associated_categories =
+          has_associated_categories
+      end
+      @has_associated_merchants = has_associated_merchants unless has_associated_merchants == SKIP
+      unless has_associated_scheduled_payments == SKIP
+        @has_associated_scheduled_payments =
+          has_associated_scheduled_payments
+      end
+      unless has_associated_transactions == SKIP
+        @has_associated_transactions =
+          has_associated_transactions
+      end
+      @has_been_displayed = has_been_displayed unless has_been_displayed == SKIP
+      @is_dismissed = is_dismissed unless is_dismissed == SKIP
+      @micro_call_to_action = micro_call_to_action unless micro_call_to_action == SKIP
+      @micro_description = micro_description unless micro_description == SKIP
+      @micro_title = micro_title unless micro_title == SKIP
+      @template = template unless template == SKIP
+      @title = title unless title == SKIP
+      @updated_at = updated_at unless updated_at == 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.
+      active_at = hash.key?('active_at') ? hash['active_at'] : SKIP
+      client_guid = hash.key?('client_guid') ? hash['client_guid'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      cta_clicked_at =
+        hash.key?('cta_clicked_at') ? hash['cta_clicked_at'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      has_associated_accounts =
+        hash.key?('has_associated_accounts') ? hash['has_associated_accounts'] : SKIP
+      has_associated_categories =
+        hash.key?('has_associated_categories') ? hash['has_associated_categories'] : SKIP
+      has_associated_merchants =
+        hash.key?('has_associated_merchants') ? hash['has_associated_merchants'] : SKIP
+      has_associated_scheduled_payments =
+        hash.key?('has_associated_scheduled_payments') ? hash['has_associated_scheduled_payments'] : SKIP
+      has_associated_transactions =
+        hash.key?('has_associated_transactions') ? hash['has_associated_transactions'] : SKIP
+      has_been_displayed =
+        hash.key?('has_been_displayed') ? hash['has_been_displayed'] : SKIP
+      is_dismissed = hash.key?('is_dismissed') ? hash['is_dismissed'] : SKIP
+      micro_call_to_action =
+        hash.key?('micro_call_to_action') ? hash['micro_call_to_action'] : SKIP
+      micro_description =
+        hash.key?('micro_description') ? hash['micro_description'] : SKIP
+      micro_title = hash.key?('micro_title') ? hash['micro_title'] : SKIP
+      template = hash.key?('template') ? hash['template'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : 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.
+      InsightResponse.new(active_at: active_at,
+                          client_guid: client_guid,
+                          created_at: created_at,
+                          cta_clicked_at: cta_clicked_at,
+                          description: description,
+                          guid: guid,
+                          has_associated_accounts: has_associated_accounts,
+                          has_associated_categories: has_associated_categories,
+                          has_associated_merchants: has_associated_merchants,
+                          has_associated_scheduled_payments: has_associated_scheduled_payments,
+                          has_associated_transactions: has_associated_transactions,
+                          has_been_displayed: has_been_displayed,
+                          is_dismissed: is_dismissed,
+                          micro_call_to_action: micro_call_to_action,
+                          micro_description: micro_description,
+                          micro_title: micro_title,
+                          template: template,
+                          title: title,
+                          updated_at: updated_at,
+                          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} active_at: #{@active_at}, client_guid: #{@client_guid}, created_at:"\
+      " #{@created_at}, cta_clicked_at: #{@cta_clicked_at}, description: #{@description}, guid:"\
+      " #{@guid}, has_associated_accounts: #{@has_associated_accounts}, has_associated_categories:"\
+      " #{@has_associated_categories}, has_associated_merchants: #{@has_associated_merchants},"\
+      " has_associated_scheduled_payments: #{@has_associated_scheduled_payments},"\
+      " has_associated_transactions: #{@has_associated_transactions}, has_been_displayed:"\
+      " #{@has_been_displayed}, is_dismissed: #{@is_dismissed}, micro_call_to_action:"\
+      " #{@micro_call_to_action}, micro_description: #{@micro_description}, micro_title:"\
+      " #{@micro_title}, template: #{@template}, title: #{@title}, updated_at: #{@updated_at},"\
+      " 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} active_at: #{@active_at.inspect}, client_guid: #{@client_guid.inspect},"\
+      " created_at: #{@created_at.inspect}, cta_clicked_at: #{@cta_clicked_at.inspect},"\
+      " description: #{@description.inspect}, guid: #{@guid.inspect}, has_associated_accounts:"\
+      " #{@has_associated_accounts.inspect}, has_associated_categories:"\
+      " #{@has_associated_categories.inspect}, has_associated_merchants:"\
+      " #{@has_associated_merchants.inspect}, has_associated_scheduled_payments:"\
+      " #{@has_associated_scheduled_payments.inspect}, has_associated_transactions:"\
+      " #{@has_associated_transactions.inspect}, has_been_displayed:"\
+      " #{@has_been_displayed.inspect}, is_dismissed: #{@is_dismissed.inspect},"\
+      " micro_call_to_action: #{@micro_call_to_action.inspect}, micro_description:"\
+      " #{@micro_description.inspect}, micro_title: #{@micro_title.inspect}, template:"\
+      " #{@template.inspect}, title: #{@title.inspect}, updated_at: #{@updated_at.inspect},"\
+      " user_guid: #{@user_guid.inspect}, user_id: #{@user_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

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

data/lib/mx_platform_api/models/insight_update_request.rb

@@ -0,0 +1,87 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # InsightUpdateRequest Model.
+  class InsightUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether the insight has been shown to the end user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_been_displayed
+
+    # Indicates whether the insight has been dismissed by the user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_dismissed
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['has_been_displayed'] = 'has_been_displayed'
+      @_hash['is_dismissed'] = 'is_dismissed'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        has_been_displayed
+        is_dismissed
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(has_been_displayed: SKIP, is_dismissed: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @has_been_displayed = has_been_displayed unless has_been_displayed == SKIP
+      @is_dismissed = is_dismissed unless is_dismissed == 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.
+      has_been_displayed =
+        hash.key?('has_been_displayed') ? hash['has_been_displayed'] : SKIP
+      is_dismissed = hash.key?('is_dismissed') ? hash['is_dismissed'] : 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.
+      InsightUpdateRequest.new(has_been_displayed: has_been_displayed,
+                               is_dismissed: is_dismissed,
+                               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} has_been_displayed: #{@has_been_displayed}, is_dismissed: #{@is_dismissed},"\
+      " 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} has_been_displayed: #{@has_been_displayed.inspect}, is_dismissed:"\
+      " #{@is_dismissed.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

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

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