apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/models/authorization_code_response.rb

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

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

data/lib/mx_platform_api/models/base_model.rb

@@ -0,0 +1,110 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/mx_platform_api/models/budget_create_request.rb

@@ -0,0 +1,115 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # BudgetCreateRequest Model.
+  class BudgetCreateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier for the category.
+    # @return [String]
+    attr_accessor :category_guid
+
+    # Unique identifier of the parent budget. This is only required when
+    # creating a budget on a sub-category.
+    # @return [String]
+    attr_accessor :parent_guid
+
+    # 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['category_guid'] = 'category_guid'
+      @_hash['parent_guid'] = 'parent_guid'
+      @_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(category_guid:, parent_guid:, amount: SKIP, metadata: SKIP,
+                   skip_webhook: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @category_guid = category_guid
+      @parent_guid = parent_guid
+      @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.
+      category_guid = hash.key?('category_guid') ? hash['category_guid'] : nil
+      parent_guid = hash.key?('parent_guid') ? hash['parent_guid'] : nil
+      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.
+      BudgetCreateRequest.new(category_guid: category_guid,
+                              parent_guid: parent_guid,
+                              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} category_guid: #{@category_guid}, parent_guid: #{@parent_guid}, 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} category_guid: #{@category_guid.inspect}, parent_guid:"\
+      " #{@parent_guid.inspect}, 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_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
+  # BudgetCreateRequestBody Model.
+  class BudgetCreateRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [BudgetCreateRequest]
+    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 = BudgetCreateRequest.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.
+      BudgetCreateRequestBody.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_response.rb

@@ -0,0 +1,246 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # BudgetResponse Model.
+  class BudgetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A goal amount set by the user for a category's transaction total during a
+    # month.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The unique identifier for the category. Defined by MX.
+    # @return [String]
+    attr_accessor :category_guid
+
+    # The date and time the budget was created, represented in ISO 8601 format
+    # with a timestamp.
+    # @return [String]
+    attr_accessor :created_at
+
+    # Unique identifier for the `budget`. Defined by MX.
+    # @return [String]
+    attr_accessor :guid
+
+    # If the budget has been exceeded, this field will be true. Otherwise, this
+    # field will be false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_exceeded
+
+    # If the budget is off track, this field will be true. Otherwise, this field
+    # will be false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_off_track
+
+    # Additional information you stored about the `budget`.
+    # @return [String]
+    attr_accessor :metadata
+
+    # The name of the budget that is visible to the user (ie "Food", "Bills",
+    # "Entertainment", etc).
+    # @return [String]
+    attr_accessor :name
+
+    # The percentage amount of off track spending. (Deprecated).
+    # @return [Float]
+    attr_accessor :off_track_percentage
+
+    # Unique identifier for the parent budget. Defined by MX.
+    # @return [String]
+    attr_accessor :parent_guid
+
+    # The percentage of a budget that has been spent during the current calendar
+    # month Calculated as the transaction total divided by the amount and then
+    # multiplied by 100.A value of zero will be returned when `amount` is zero.
+    # @return [Float]
+    attr_accessor :percent_spent
+
+    # The projected amount of spending for the budget.
+    # @return [Float]
+    attr_accessor :projected_spending
+
+    # The revision number of this budget record.
+    # @return [Integer]
+    attr_accessor :revision
+
+    # The cumulative amount of all transactions under the budget.
+    # @return [Object]
+    attr_accessor :transaction_total
+
+    # Date and time the budget was updated, represented in ISO 8601 format with
+    # timestamp.
+    # @return [Object]
+    attr_accessor :updated_at
+
+    # Unique identifier for the user. Defined by MX.
+    # @return [Object]
+    attr_accessor :user_guid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['category_guid'] = 'category_guid'
+      @_hash['created_at'] = 'created_at'
+      @_hash['guid'] = 'guid'
+      @_hash['is_exceeded'] = 'is_exceeded'
+      @_hash['is_off_track'] = 'is_off_track'
+      @_hash['metadata'] = 'metadata'
+      @_hash['name'] = 'name'
+      @_hash['off_track_percentage'] = 'off_track_percentage'
+      @_hash['parent_guid'] = 'parent_guid'
+      @_hash['percent_spent'] = 'percent_spent'
+      @_hash['projected_spending'] = 'projected_spending'
+      @_hash['revision'] = 'revision'
+      @_hash['transaction_total'] = 'transaction_total'
+      @_hash['updated_at'] = 'updated_at'
+      @_hash['user_guid'] = 'user_guid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        category_guid
+        created_at
+        guid
+        is_exceeded
+        is_off_track
+        metadata
+        name
+        off_track_percentage
+        parent_guid
+        percent_spent
+        projected_spending
+        revision
+        transaction_total
+        updated_at
+        user_guid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        name
+        off_track_percentage
+        parent_guid
+        percent_spent
+      ]
+    end
+
+    def initialize(amount: SKIP, category_guid: SKIP, created_at: SKIP,
+                   guid: SKIP, is_exceeded: SKIP, is_off_track: SKIP,
+                   metadata: SKIP, name: SKIP, off_track_percentage: SKIP,
+                   parent_guid: SKIP, percent_spent: SKIP,
+                   projected_spending: SKIP, revision: SKIP,
+                   transaction_total: SKIP, updated_at: SKIP, user_guid: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount unless amount == SKIP
+      @category_guid = category_guid unless category_guid == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @guid = guid unless guid == SKIP
+      @is_exceeded = is_exceeded unless is_exceeded == SKIP
+      @is_off_track = is_off_track unless is_off_track == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @name = name unless name == SKIP
+      @off_track_percentage = off_track_percentage unless off_track_percentage == SKIP
+      @parent_guid = parent_guid unless parent_guid == SKIP
+      @percent_spent = percent_spent unless percent_spent == SKIP
+      @projected_spending = projected_spending unless projected_spending == SKIP
+      @revision = revision unless revision == SKIP
+      @transaction_total = transaction_total unless transaction_total == 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.
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      category_guid = hash.key?('category_guid') ? hash['category_guid'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      guid = hash.key?('guid') ? hash['guid'] : SKIP
+      is_exceeded = hash.key?('is_exceeded') ? hash['is_exceeded'] : SKIP
+      is_off_track = hash.key?('is_off_track') ? hash['is_off_track'] : SKIP
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      off_track_percentage =
+        hash.key?('off_track_percentage') ? hash['off_track_percentage'] : SKIP
+      parent_guid = hash.key?('parent_guid') ? hash['parent_guid'] : SKIP
+      percent_spent = hash.key?('percent_spent') ? hash['percent_spent'] : SKIP
+      projected_spending =
+        hash.key?('projected_spending') ? hash['projected_spending'] : SKIP
+      revision = hash.key?('revision') ? hash['revision'] : SKIP
+      transaction_total =
+        hash.key?('transaction_total') ? hash['transaction_total'] : 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.
+      BudgetResponse.new(amount: amount,
+                         category_guid: category_guid,
+                         created_at: created_at,
+                         guid: guid,
+                         is_exceeded: is_exceeded,
+                         is_off_track: is_off_track,
+                         metadata: metadata,
+                         name: name,
+                         off_track_percentage: off_track_percentage,
+                         parent_guid: parent_guid,
+                         percent_spent: percent_spent,
+                         projected_spending: projected_spending,
+                         revision: revision,
+                         transaction_total: transaction_total,
+                         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} amount: #{@amount}, category_guid: #{@category_guid}, created_at:"\
+      " #{@created_at}, guid: #{@guid}, is_exceeded: #{@is_exceeded}, is_off_track:"\
+      " #{@is_off_track}, metadata: #{@metadata}, name: #{@name}, off_track_percentage:"\
+      " #{@off_track_percentage}, parent_guid: #{@parent_guid}, percent_spent: #{@percent_spent},"\
+      " projected_spending: #{@projected_spending}, revision: #{@revision}, transaction_total:"\
+      " #{@transaction_total}, 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} amount: #{@amount.inspect}, category_guid: #{@category_guid.inspect},"\
+      " created_at: #{@created_at.inspect}, guid: #{@guid.inspect}, is_exceeded:"\
+      " #{@is_exceeded.inspect}, is_off_track: #{@is_off_track.inspect}, metadata:"\
+      " #{@metadata.inspect}, name: #{@name.inspect}, off_track_percentage:"\
+      " #{@off_track_percentage.inspect}, parent_guid: #{@parent_guid.inspect}, percent_spent:"\
+      " #{@percent_spent.inspect}, projected_spending: #{@projected_spending.inspect}, revision:"\
+      " #{@revision.inspect}, transaction_total: #{@transaction_total.inspect}, updated_at:"\
+      " #{@updated_at.inspect}, user_guid: #{@user_guid.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end