mx-platform-ruby 0.39.0 → 0.40.0

data/lib/mx-platform-ruby/api/mx_platform_api.rb

@@ -7439,6 +7439,284 @@ module MxPlatformRuby
       return data, status_code, headers
     end
 
+    # Read monthly cash flow profile
+    # @param user_guid [String] The unique identifier for the user.
+    # @param [Hash] opts the optional parameters
+    # @return [MonthlyCashFlowResponseBody]
+    def users_user_guid_monthly_cash_flow_profile_get(user_guid, opts = {})
+      data, _status_code, _headers = users_user_guid_monthly_cash_flow_profile_get_with_http_info(user_guid, opts)
+      data
+    end
+
+    # Read monthly cash flow profile
+    # @param user_guid [String] The unique identifier for the user.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MonthlyCashFlowResponseBody, Integer, Hash)>] MonthlyCashFlowResponseBody data, response status code and response headers
+    def users_user_guid_monthly_cash_flow_profile_get_with_http_info(user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MxPlatformApi.users_user_guid_monthly_cash_flow_profile_get ...'
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.users_user_guid_monthly_cash_flow_profile_get"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/monthly_cash_flow_profile'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MonthlyCashFlowResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MxPlatformApi.users_user_guid_monthly_cash_flow_profile_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MxPlatformApi#users_user_guid_monthly_cash_flow_profile_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update monthly cash flow profile
+    # Use this endpoint to update the attributes of a `monthly_cash_flow_profile`.
+    # @param user_guid [String] The unique identifier for the user.
+    # @param monthly_cash_flow_profile_request_body [MonthlyCashFlowProfileRequestBody] 
+    # @param [Hash] opts the optional parameters
+    # @return [MonthlyCashFlowResponseBody]
+    def users_user_guid_monthly_cash_flow_profile_put(user_guid, monthly_cash_flow_profile_request_body, opts = {})
+      data, _status_code, _headers = users_user_guid_monthly_cash_flow_profile_put_with_http_info(user_guid, monthly_cash_flow_profile_request_body, opts)
+      data
+    end
+
+    # Update monthly cash flow profile
+    # Use this endpoint to update the attributes of a &#x60;monthly_cash_flow_profile&#x60;.
+    # @param user_guid [String] The unique identifier for the user.
+    # @param monthly_cash_flow_profile_request_body [MonthlyCashFlowProfileRequestBody] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MonthlyCashFlowResponseBody, Integer, Hash)>] MonthlyCashFlowResponseBody data, response status code and response headers
+    def users_user_guid_monthly_cash_flow_profile_put_with_http_info(user_guid, monthly_cash_flow_profile_request_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MxPlatformApi.users_user_guid_monthly_cash_flow_profile_put ...'
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.users_user_guid_monthly_cash_flow_profile_put"
+      end
+      # verify the required parameter 'monthly_cash_flow_profile_request_body' is set
+      if @api_client.config.client_side_validation && monthly_cash_flow_profile_request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'monthly_cash_flow_profile_request_body' when calling MxPlatformApi.users_user_guid_monthly_cash_flow_profile_put"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/monthly_cash_flow_profile'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(monthly_cash_flow_profile_request_body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MonthlyCashFlowResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MxPlatformApi.users_user_guid_monthly_cash_flow_profile_put",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MxPlatformApi#users_user_guid_monthly_cash_flow_profile_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete split transactions
+    # This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction's has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.
+    # @param transaction_guid [String] The unique id for a &#x60;transaction&#x60;.
+    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def users_user_guid_transactions_transaction_guid_split_delete(transaction_guid, user_guid, opts = {})
+      users_user_guid_transactions_transaction_guid_split_delete_with_http_info(transaction_guid, user_guid, opts)
+      nil
+    end
+
+    # Delete split transactions
+    # This endpoint deletes all split transactions linked to a parent transaction, but it leaves the parent transaction active. This request will also update the parent transaction&#39;s has_been_split field to false. This endpoint accepts the optional MX-Skip-Webhook header.
+    # @param transaction_guid [String] The unique id for a &#x60;transaction&#x60;.
+    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def users_user_guid_transactions_transaction_guid_split_delete_with_http_info(transaction_guid, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MxPlatformApi.users_user_guid_transactions_transaction_guid_split_delete ...'
+      end
+      # verify the required parameter 'transaction_guid' is set
+      if @api_client.config.client_side_validation && transaction_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.users_user_guid_transactions_transaction_guid_split_delete"
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.users_user_guid_transactions_transaction_guid_split_delete"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/transactions/{transaction_guid}/split'.sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MxPlatformApi.users_user_guid_transactions_transaction_guid_split_delete",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MxPlatformApi#users_user_guid_transactions_transaction_guid_split_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create split transactions
+    # This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction.  When a split transaction is created, the parent transaction's `has_been_split` field will automatically be updated to true and the child transactions' `parent_guid` will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can't be split again.    In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction's `has_been_split` field to false. You can then re-split the parent transaction by calling Create Split Transaction again.
+    # @param user_guid [String] The unique identifier for the user. Defined by MX.
+    # @param transaction_guid [String] The unique identifier for the transaction. Defined by MX.
+    # @param [Hash] opts the optional parameters
+    # @option opts [SplitTransactionRequestBody] :split_transaction_request_body 
+    # @return [SplitTransactionsResponseBody]
+    def users_user_guid_transactions_transaction_guid_split_post(user_guid, transaction_guid, opts = {})
+      data, _status_code, _headers = users_user_guid_transactions_transaction_guid_split_post_with_http_info(user_guid, transaction_guid, opts)
+      data
+    end
+
+    # Create split transactions
+    # This endpoint creates two or more child transactions that are branched from a previous transaction. This endpoint allows you to link multiple categories, descriptions, and amounts to a parent transaction.  When a split transaction is created, the parent transaction&#39;s &#x60;has_been_split&#x60; field will automatically be updated to true and the child transactions&#39; &#x60;parent_guid&#x60; will have the transaction guid of the parent. The total amount of the child transactions must equal the amount of the parent transaction. Once a transaction has been split it can&#39;t be split again.    In order to re-split a transaction, it must first be un-split. This can be done by calling the Delete Split Transactions endpoint. Calling this endpoint will delete the existing child transactions and update the parent transaction&#39;s &#x60;has_been_split&#x60; field to false. You can then re-split the parent transaction by calling Create Split Transaction again.
+    # @param user_guid [String] The unique identifier for the user. Defined by MX.
+    # @param transaction_guid [String] The unique identifier for the transaction. Defined by MX.
+    # @param [Hash] opts the optional parameters
+    # @option opts [SplitTransactionRequestBody] :split_transaction_request_body 
+    # @return [Array<(SplitTransactionsResponseBody, Integer, Hash)>] SplitTransactionsResponseBody data, response status code and response headers
+    def users_user_guid_transactions_transaction_guid_split_post_with_http_info(user_guid, transaction_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MxPlatformApi.users_user_guid_transactions_transaction_guid_split_post ...'
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.users_user_guid_transactions_transaction_guid_split_post"
+      end
+      # verify the required parameter 'transaction_guid' is set
+      if @api_client.config.client_side_validation && transaction_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'transaction_guid' when calling MxPlatformApi.users_user_guid_transactions_transaction_guid_split_post"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/transactions/{transaction_guid}/split'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'transaction_guid' + '}', CGI.escape(transaction_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'split_transaction_request_body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SplitTransactionsResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MxPlatformApi.users_user_guid_transactions_transaction_guid_split_post",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MxPlatformApi#users_user_guid_transactions_transaction_guid_split_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Verify member
     # The verify endpoint begins a verification process for a member.
     # @param member_guid [String] The unique id for a &#x60;member&#x60;.

data/lib/mx-platform-ruby/models/budget_create_request.rb

@@ -0,0 +1,269 @@
+=begin
+#MX Platform API
+
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MxPlatformRuby
+  class BudgetCreateRequest
+    # Unique identifier of the category.
+    attr_accessor :category_guid
+
+    # Unique identifier of the parent budget. This is only required when creating a budget on a sub-category.
+    attr_accessor :parent_guid
+
+    # Amount of the budget.
+    attr_accessor :amount
+
+    # Additional information a partner can store on the budget.
+    attr_accessor :metadata
+
+    # When set to true, this parameter will prevent a webhook from being triggered by the request.
+    attr_accessor :skip_webhook
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'category_guid' => :'category_guid',
+        :'parent_guid' => :'parent_guid',
+        :'amount' => :'amount',
+        :'metadata' => :'metadata',
+        :'skip_webhook' => :'skip_webhook'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'category_guid' => :'String',
+        :'parent_guid' => :'String',
+        :'amount' => :'Integer',
+        :'metadata' => :'String',
+        :'skip_webhook' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::BudgetCreateRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MxPlatformRuby::BudgetCreateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'category_guid')
+        self.category_guid = attributes[:'category_guid']
+      else
+        self.category_guid = nil
+      end
+
+      if attributes.key?(:'parent_guid')
+        self.parent_guid = attributes[:'parent_guid']
+      else
+        self.parent_guid = nil
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'skip_webhook')
+        self.skip_webhook = attributes[:'skip_webhook']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @category_guid.nil?
+        invalid_properties.push('invalid value for "category_guid", category_guid cannot be nil.')
+      end
+
+      if @parent_guid.nil?
+        invalid_properties.push('invalid value for "parent_guid", parent_guid cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @category_guid.nil?
+      return false if @parent_guid.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          category_guid == o.category_guid &&
+          parent_guid == o.parent_guid &&
+          amount == o.amount &&
+          metadata == o.metadata &&
+          skip_webhook == o.skip_webhook
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [category_guid, parent_guid, amount, metadata, skip_webhook].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = MxPlatformRuby.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end