apimatic-mx-apis-sdk 0.0.1

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

data/lib/mx_platform_api/models/budget_update_request.rb

@@ -0,0 +1,96 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # BudgetUpdateRequest Model.
+  class BudgetUpdateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of the budget.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Additional information you can store on the `budget`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # When set to true, this parameter will prevent a webhook from being
+    # triggered by the request.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_webhook
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['metadata'] = 'metadata'
+      @_hash['skip_webhook'] = 'skip_webhook'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        metadata
+        skip_webhook
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount: SKIP, metadata: SKIP, skip_webhook: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @skip_webhook = skip_webhook unless skip_webhook == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      skip_webhook = hash.key?('skip_webhook') ? hash['skip_webhook'] : 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.
+      BudgetUpdateRequest.new(amount: amount,
+                              metadata: metadata,
+                              skip_webhook: skip_webhook,
+                              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} amount: #{@amount}, metadata: #{@metadata}, skip_webhook: #{@skip_webhook},"\
+      " 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} amount: #{@amount.inspect}, metadata: #{@metadata.inspect}, skip_webhook:"\
+      " #{@skip_webhook.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

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

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

data/lib/mx_platform_api/models/category_create_request.rb

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

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

data/lib/mx_platform_api/models/category_response.rb

@@ -0,0 +1,160 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # CategoryResponse Model.
+  class CategoryResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time the category was created, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The unique identifier for the category. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # Indicates whether the category is an MX-created default category. This
+    # will always be `false` for custom categories.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_default
+
+    # Indicates whether the transaction is income.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_income
+
+    # Additional information you stored on the `category`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # The name of the category.
+    # @return [String]
+    attr_accessor :name
+
+    # The unique identifier for the parent category. Defined by MX.
+    # @return [String]
+    attr_accessor :parent_guid
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'created_at'
+      @_hash['guid'] = 'guid'
+      @_hash['is_default'] = 'is_default'
+      @_hash['is_income'] = 'is_income'
+      @_hash['metadata'] = 'metadata'
+      @_hash['name'] = 'name'
+      @_hash['parent_guid'] = 'parent_guid'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        guid
+        is_default
+        is_income
+        metadata
+        name
+        parent_guid
+        updated_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        created_at
+        guid
+        is_default
+        is_income
+        metadata
+        name
+        parent_guid
+        updated_at
+      ]
+    end
+
+    def initialize(created_at: SKIP, guid: SKIP, is_default: SKIP,
+                   is_income: SKIP, metadata: SKIP, name: SKIP,
+                   parent_guid: SKIP, updated_at: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @created_at = created_at unless created_at == SKIP
+      @guid = guid unless guid == SKIP
+      @is_default = is_default unless is_default == SKIP
+      @is_income = is_income unless is_income == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @name = name unless name == SKIP
+      @parent_guid = parent_guid unless parent_guid == SKIP
+      @updated_at = updated_at unless updated_at == 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.
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      is_default = hash.key?('is_default') ? hash['is_default'] : SKIP
+      is_income = hash.key?('is_income') ? hash['is_income'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      parent_guid = hash.key?('parent_guid') ? hash['parent_guid'] : SKIP
+      updated_at = hash.key?('updated_at') ? hash['updated_at'] : 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.
+      CategoryResponse.new(created_at: created_at,
+                           guid: guid,
+                           is_default: is_default,
+                           is_income: is_income,
+                           metadata: metadata,
+                           name: name,
+                           parent_guid: parent_guid,
+                           updated_at: updated_at,
+                           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} created_at: #{@created_at}, guid: #{@guid}, is_default: #{@is_default},"\
+      " is_income: #{@is_income}, metadata: #{@metadata}, name: #{@name}, parent_guid:"\
+      " #{@parent_guid}, updated_at: #{@updated_at}, 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} created_at: #{@created_at.inspect}, guid: #{@guid.inspect}, is_default:"\
+      " #{@is_default.inspect}, is_income: #{@is_income.inspect}, metadata: #{@metadata.inspect},"\
+      " name: #{@name.inspect}, parent_guid: #{@parent_guid.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end