apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/transaction_rule_create_request.rb

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

data/lib/mx_platform_api/models/transaction_rule_create_request_body.rb

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

data/lib/mx_platform_api/models/transaction_rule_response.rb

@@ -0,0 +1,152 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # TransactionRuleResponse Model.
+  class TransactionRuleResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the category. Defined by MX.
+    # @return [String]
+    attr_accessor :category_guid
+
+    # The date and time the resource was created, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The matched transaction's `description` will be updated to the string
+    # provided here.
+    # @return [String]
+    attr_accessor :description
+
+    # A unique identifier for the `transaction_rule`. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # A string used to find a transaction to which the rule will be applied.
+    # Transaction matching is based on a comparison of `match_description` to a
+    # transaction's cleansed description.
+    # @return [String]
+    attr_accessor :match_description
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['category_guid'] = 'category_guid'
+      @_hash['created_at'] = 'created_at'
+      @_hash['description'] = 'description'
+      @_hash['guid'] = 'guid'
+      @_hash['match_description'] = 'match_description'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category_guid
+        created_at
+        description
+        guid
+        match_description
+        updated_at
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        category_guid
+        created_at
+        description
+        guid
+        match_description
+        updated_at
+        user_guid
+      ]
+    end
+
+    def initialize(category_guid: SKIP, created_at: SKIP, description: SKIP,
+                   guid: SKIP, match_description: SKIP, updated_at: SKIP,
+                   user_guid: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @category_guid = category_guid unless category_guid == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @description = description unless description == SKIP
+      @guid = guid unless guid == SKIP
+      @match_description = match_description unless match_description == SKIP
+      @updated_at = updated_at unless updated_at == SKIP
+      @user_guid = user_guid unless user_guid == 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.
+      category_guid = hash.key?('category_guid') ? hash['category_guid'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      match_description =
+        hash.key?('match_description') ? hash['match_description'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : SKIP
+      user_guid = hash.key?('user_guid') ? hash['user_guid'] : 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.
+      TransactionRuleResponse.new(category_guid: category_guid,
+                                  created_at: created_at,
+                                  description: description,
+                                  guid: guid,
+                                  match_description: match_description,
+                                  updated_at: updated_at,
+                                  user_guid: user_guid,
+                                  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} category_guid: #{@category_guid}, created_at: #{@created_at}, description:"\
+      " #{@description}, guid: #{@guid}, match_description: #{@match_description}, updated_at:"\
+      " #{@updated_at}, user_guid: #{@user_guid}, 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} category_guid: #{@category_guid.inspect}, created_at:"\
+      " #{@created_at.inspect}, description: #{@description.inspect}, guid: #{@guid.inspect},"\
+      " match_description: #{@match_description.inspect}, updated_at: #{@updated_at.inspect},"\
+      " user_guid: #{@user_guid.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/transaction_rule_response_body.rb

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

data/lib/mx_platform_api/models/transaction_rule_update_request.rb

@@ -0,0 +1,103 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # TransactionRuleUpdateRequest Model.
+  class TransactionRuleUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the category. Defined by MX.
+    # @return [String]
+    attr_accessor :category_guid
+
+    # The matched transaction's `description` will be updated to the string
+    # provided here.
+    # @return [String]
+    attr_accessor :description
+
+    # A string used to find a transaction to which the rule will be applied.
+    # Transaction matching is based on a comparison of `match_description` to a
+    # transaction's cleansed description.
+    # @return [String]
+    attr_accessor :match_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['category_guid'] = 'category_guid'
+      @_hash['description'] = 'description'
+      @_hash['match_description'] = 'match_description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        category_guid
+        description
+        match_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        category_guid
+      ]
+    end
+
+    def initialize(category_guid: SKIP, description: SKIP,
+                   match_description: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @category_guid = category_guid unless category_guid == SKIP
+      @description = description unless description == SKIP
+      @match_description = match_description unless match_description == 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.
+      category_guid = hash.key?('category_guid') ? hash['category_guid'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      match_description =
+        hash.key?('match_description') ? hash['match_description'] : 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.
+      TransactionRuleUpdateRequest.new(category_guid: category_guid,
+                                       description: description,
+                                       match_description: match_description,
+                                       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} category_guid: #{@category_guid}, description: #{@description},"\
+      " match_description: #{@match_description}, 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} category_guid: #{@category_guid.inspect}, description:"\
+      " #{@description.inspect}, match_description: #{@match_description.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/mx_platform_api/models/transaction_rule_update_request_body.rb

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

data/lib/mx_platform_api/models/transaction_rules_response_body.rb

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