apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/repeating_transaction_response.rb

@@ -0,0 +1,203 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # RepeatingTransactionResponse Model.
+  class RepeatingTransactionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for an account. Defined by MX.
+    # @return [String]
+    attr_accessor :account_guid
+
+    # The monetary amount of the `transaction`.
+    # @return [Float]
+    attr_accessor :amount
+
+    # Merchant or bill description.
+    # @return [String]
+    attr_accessor :description
+
+    # The unique identifier for the repeating transaction. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # The unique identifier for the member. Defined by MX.
+    # @return [String]
+    attr_accessor :member_guid
+
+    # The unique identifier for the merchant. Defined by MX.
+    # @return [String]
+    attr_accessor :merchant_guid
+
+    # Last occurrence date.
+    # @return [String]
+    attr_accessor :last_posted_date
+
+    # Predicted next occurrence.
+    # @return [String]
+    attr_accessor :predicted_occurs_on
+
+    # The frequency at which a transaction is expected to repeat based on
+    # historical patterns. See [Supported Recurrence
+    # Types](/api-reference/platform-api/reference/transactions-overview#support
+    # ed-recurrence-types) for full list. This field appears on transaction
+    # endpoints where the optional query parameter is defined.
+    # @return [String]
+    attr_accessor :recurrence_type
+
+    # The unique identifier for the user. Defined by MX.
+    # @return [String]
+    attr_accessor :user_guid
+
+    # The type of repeating transaction.
+    # @return [RepeatingTransactionType]
+    attr_accessor :repeating_transaction_type
+
+    # The type of transaction. Can be either `CREDIT` or `DEBIT`.
+    # @return [TransactionType]
+    attr_accessor :transaction_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_guid'] = 'account_guid'
+      @_hash['amount'] = 'amount'
+      @_hash['description'] = 'description'
+      @_hash['guid'] = 'guid'
+      @_hash['member_guid'] = 'member_guid'
+      @_hash['merchant_guid'] = 'merchant_guid'
+      @_hash['last_posted_date'] = 'last_posted_date'
+      @_hash['predicted_occurs_on'] = 'predicted_occurs_on'
+      @_hash['recurrence_type'] = 'recurrence_type'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash['repeating_transaction_type'] = 'repeating_transaction_type'
+      @_hash['transaction_type'] = 'transaction_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_guid
+        amount
+        description
+        guid
+        member_guid
+        merchant_guid
+        last_posted_date
+        predicted_occurs_on
+        recurrence_type
+        user_guid
+        repeating_transaction_type
+        transaction_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        amount
+      ]
+    end
+
+    def initialize(account_guid: SKIP, amount: SKIP, description: SKIP,
+                   guid: SKIP, member_guid: SKIP, merchant_guid: SKIP,
+                   last_posted_date: SKIP, predicted_occurs_on: SKIP,
+                   recurrence_type: SKIP, user_guid: SKIP,
+                   repeating_transaction_type: SKIP, transaction_type: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @account_guid = account_guid unless account_guid == SKIP
+      @amount = amount unless amount == SKIP
+      @description = description unless description == SKIP
+      @guid = guid unless guid == SKIP
+      @member_guid = member_guid unless member_guid == SKIP
+      @merchant_guid = merchant_guid unless merchant_guid == SKIP
+      @last_posted_date = last_posted_date unless last_posted_date == SKIP
+      @predicted_occurs_on = predicted_occurs_on unless predicted_occurs_on == SKIP
+      @recurrence_type = recurrence_type unless recurrence_type == SKIP
+      @user_guid = user_guid unless user_guid == SKIP
+      unless repeating_transaction_type == SKIP
+        @repeating_transaction_type =
+          repeating_transaction_type
+      end
+      @transaction_type = transaction_type unless transaction_type == 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.
+      account_guid = hash.key?('account_guid') ? hash['account_guid'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      member_guid = hash.key?('member_guid') ? hash['member_guid'] : SKIP
+      merchant_guid = hash.key?('merchant_guid') ? hash['merchant_guid'] : SKIP
+      last_posted_date =
+        hash.key?('last_posted_date') ? hash['last_posted_date'] : SKIP
+      predicted_occurs_on =
+        hash.key?('predicted_occurs_on') ? hash['predicted_occurs_on'] : SKIP
+      recurrence_type =
+        hash.key?('recurrence_type') ? hash['recurrence_type'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : SKIP
+      repeating_transaction_type =
+        hash.key?('repeating_transaction_type') ? hash['repeating_transaction_type'] : SKIP
+      transaction_type =
+        hash.key?('transaction_type') ? hash['transaction_type'] : 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.
+      RepeatingTransactionResponse.new(account_guid: account_guid,
+                                       amount: amount,
+                                       description: description,
+                                       guid: guid,
+                                       member_guid: member_guid,
+                                       merchant_guid: merchant_guid,
+                                       last_posted_date: last_posted_date,
+                                       predicted_occurs_on: predicted_occurs_on,
+                                       recurrence_type: recurrence_type,
+                                       user_guid: user_guid,
+                                       repeating_transaction_type: repeating_transaction_type,
+                                       transaction_type: transaction_type,
+                                       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} account_guid: #{@account_guid}, amount: #{@amount}, description:"\
+      " #{@description}, guid: #{@guid}, member_guid: #{@member_guid}, merchant_guid:"\
+      " #{@merchant_guid}, last_posted_date: #{@last_posted_date}, predicted_occurs_on:"\
+      " #{@predicted_occurs_on}, recurrence_type: #{@recurrence_type}, user_guid: #{@user_guid},"\
+      " repeating_transaction_type: #{@repeating_transaction_type}, transaction_type:"\
+      " #{@transaction_type}, 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} account_guid: #{@account_guid.inspect}, amount: #{@amount.inspect},"\
+      " description: #{@description.inspect}, guid: #{@guid.inspect}, member_guid:"\
+      " #{@member_guid.inspect}, merchant_guid: #{@merchant_guid.inspect}, last_posted_date:"\
+      " #{@last_posted_date.inspect}, predicted_occurs_on: #{@predicted_occurs_on.inspect},"\
+      " recurrence_type: #{@recurrence_type.inspect}, user_guid: #{@user_guid.inspect},"\
+      " repeating_transaction_type: #{@repeating_transaction_type.inspect}, transaction_type:"\
+      " #{@transaction_type.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/repeating_transaction_type.rb

@@ -0,0 +1,44 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # The type of repeating transaction.
+  class RepeatingTransactionType
+    REPEATING_TRANSACTION_TYPE = [
+      # TODO: Write general description for BILL
+      BILL = 'BILL'.freeze,
+
+      # TODO: Write general description for SUBSCRIPTION
+      SUBSCRIPTION = 'SUBSCRIPTION'.freeze,
+
+      # TODO: Write general description for INCOME
+      INCOME = 'INCOME'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REPEATING_TRANSACTION_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = BILL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'bill' then BILL
+      when 'subscription' then SUBSCRIPTION
+      when 'income' then INCOME
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

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

data/lib/mx_platform_api/models/reposition_request.rb

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

data/lib/mx_platform_api/models/reposition_request_body.rb

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

data/lib/mx_platform_api/models/reposition_response_body.rb

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