mx-platform-ruby 1.10.0 → 1.10.1

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

@@ -1,9 +1,9 @@
 =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 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.  Just getting started? See our [use case guides](/use-cases/). 
 
-The version of the OpenAPI document: 0.1.0
+The version of the OpenAPI document: 20111101
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.8.0
@@ -21,7 +21,7 @@ module MxPlatformRuby
     end
     # Create spending plan
     # This endpoint creates a new `spending_plan` for the user.
-    # @param user_guid [String] The unique id for a `user`.
+    # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
     # @param [Hash] opts the optional parameters
     # @return [SpendingPlanResponse]
     def create_spending_plan(user_guid, opts = {})
@@ -31,7 +31,7 @@ module MxPlatformRuby
 
     # Create spending plan
     # This endpoint creates a new `spending_plan` for the user.
-    # @param user_guid [String] The unique id for a `user`.
+    # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
     # @param [Hash] opts the optional parameters
     # @return [Array<(SpendingPlanResponse, Integer, Hash)>] SpendingPlanResponse data, response status code and response headers
     def create_spending_plan_with_http_info(user_guid, opts = {})
@@ -85,7 +85,7 @@ module MxPlatformRuby
     # Create spending plan iteration item
     # This endpoint creates a new `spending_plan_iteration_item`.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_iteration_item_create_request_body [SpendingPlanIterationItemCreateRequestBody] Iteration item to be created with required parameter (planned_amount)
     # @param [Hash] opts the optional parameters
     # @return [SpendingPlanIterationItemResponse]
@@ -97,7 +97,7 @@ module MxPlatformRuby
     # Create spending plan iteration item
     # This endpoint creates a new &#x60;spending_plan_iteration_item&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_iteration_item_create_request_body [SpendingPlanIterationItemCreateRequestBody] Iteration item to be created with required parameter (planned_amount)
     # @param [Hash] opts the optional parameters
     # @return [Array<(SpendingPlanIterationItemResponse, Integer, Hash)>] SpendingPlanIterationItemResponse data, response status code and response headers
@@ -164,7 +164,7 @@ module MxPlatformRuby
 
     # Delete spending plan
     # Use this endpoint to delete a user's `spending_plan`.
-    # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -175,7 +175,7 @@ module MxPlatformRuby
 
     # Delete spending plan
     # Use this endpoint to delete a user&#39;s &#x60;spending_plan&#x60;.
-    # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -231,7 +231,7 @@ module MxPlatformRuby
 
     # Delete spending plan account
     # Use this endpoint to delete a `spending_plan_account`.
-    # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param spending_plan_account_guid [String] The unique ID for the specified account.
     # @param [Hash] opts the optional parameters
@@ -243,7 +243,7 @@ module MxPlatformRuby
 
     # Delete spending plan account
     # Use this endpoint to delete a &#x60;spending_plan_account&#x60;.
-    # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param spending_plan_account_guid [String] The unique ID for the specified account.
     # @param [Hash] opts the optional parameters
@@ -304,7 +304,7 @@ module MxPlatformRuby
 
     # Delete spending plan iteration item
     # Use this endpoint to delete a spending plan `iteration_item`.
-    # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
     # @param [Hash] opts the optional parameters
@@ -316,7 +316,7 @@ module MxPlatformRuby
 
     # Delete spending plan iteration item
     # Use this endpoint to delete a spending plan &#x60;iteration_item&#x60;.
-    # @param user_guid [String] The unique ID for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
     # @param [Hash] opts the optional parameters
@@ -377,11 +377,11 @@ module MxPlatformRuby
 
     # List spending plan accounts
     # Use this endpoint to list all the spending plan accounts associated with the spending plan.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [SpendingPlanAccountsResponse]
     def list_spending_plan_accounts(user_guid, spending_plan_guid, opts = {})
       data, _status_code, _headers = list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, opts)
@@ -390,11 +390,11 @@ module MxPlatformRuby
 
     # List spending plan accounts
     # Use this endpoint to list all the spending plan accounts associated with the spending plan.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [Array<(SpendingPlanAccountsResponse, Integer, Hash)>] SpendingPlanAccountsResponse data, response status code and response headers
     def list_spending_plan_accounts_with_http_info(user_guid, spending_plan_guid, opts = {})
       if @api_client.config.debugging
@@ -452,11 +452,11 @@ module MxPlatformRuby
 
     # List spending plan iteration items
     # Use this endpoint to list all the spending plan `iteration_items` associated with the `iteration`.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [SpendingPlanIterationItemsResponseBody]
     def list_spending_plan_iteration_items(user_guid, spending_plan_guid, opts = {})
       data, _status_code, _headers = list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, opts)
@@ -465,11 +465,11 @@ module MxPlatformRuby
 
     # List spending plan iteration items
     # Use this endpoint to list all the spending plan &#x60;iteration_items&#x60; associated with the &#x60;iteration&#x60;.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [Array<(SpendingPlanIterationItemsResponseBody, Integer, Hash)>] SpendingPlanIterationItemsResponseBody data, response status code and response headers
     def list_spending_plan_iteration_items_with_http_info(user_guid, spending_plan_guid, opts = {})
       if @api_client.config.debugging
@@ -527,11 +527,11 @@ module MxPlatformRuby
 
     # List spending plan iterations
     # Use this endpoint to list all the spending plan `iterations` associated with the `spending_plan`.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [SpendingPlanIterationsResponse]
     def list_spending_plan_iterations(user_guid, spending_plan_guid, opts = {})
       data, _status_code, _headers = list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, opts)
@@ -540,11 +540,11 @@ module MxPlatformRuby
 
     # List spending plan iterations
     # Use this endpoint to list all the spending plan &#x60;iterations&#x60; associated with the &#x60;spending_plan&#x60;.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [Array<(SpendingPlanIterationsResponse, Integer, Hash)>] SpendingPlanIterationsResponse data, response status code and response headers
     def list_spending_plan_iterations_with_http_info(user_guid, spending_plan_guid, opts = {})
       if @api_client.config.debugging
@@ -602,10 +602,10 @@ module MxPlatformRuby
 
     # List spending plans
     # Use this endpoint to list all the spending plans associated with the user.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [SpendingPlansResponseBody]
     def list_spending_plans(user_guid, opts = {})
       data, _status_code, _headers = list_spending_plans_with_http_info(user_guid, opts)
@@ -614,10 +614,10 @@ module MxPlatformRuby
 
     # List spending plans
     # Use this endpoint to list all the spending plans associated with the user.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [Array<(SpendingPlansResponseBody, Integer, Hash)>] SpendingPlansResponseBody data, response status code and response headers
     def list_spending_plans_with_http_info(user_guid, opts = {})
       if @api_client.config.debugging
@@ -669,14 +669,89 @@ module MxPlatformRuby
       return data, status_code, headers
     end
 
+    # Read current spending plan iteration
+    # Use this endpoint to read the attributes of the current spending plan `iteration`.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
+    # @return [SpendingPlanIterationResponse]
+    def read_current_spending_plan_iteration(user_guid, spending_plan_guid, opts = {})
+      data, _status_code, _headers = read_current_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, opts)
+      data
+    end
+
+    # Read current spending plan iteration
+    # Use this endpoint to read the attributes of the current spending plan &#x60;iteration&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
+    # @return [Array<(SpendingPlanIterationResponse, Integer, Hash)>] SpendingPlanIterationResponse data, response status code and response headers
+    def read_current_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SpendingPlanApi.read_current_spending_plan_iteration ...'
+      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 SpendingPlanApi.read_current_spending_plan_iteration"
+      end
+      # verify the required parameter 'spending_plan_guid' is set
+      if @api_client.config.client_side_validation && spending_plan_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'spending_plan_guid' when calling SpendingPlanApi.read_current_spending_plan_iteration"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/spending_plans/{spending_plan_guid}/iterations/current'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s)).sub('{' + 'spending_plan_guid' + '}', CGI.escape(spending_plan_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SpendingPlanIterationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"SpendingPlanApi.read_current_spending_plan_iteration",
+        :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: SpendingPlanApi#read_current_spending_plan_iteration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Read spending plan account
     # Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param spending_plan_account_guid [String] The unique ID for the specified account.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [SpendingPlanAccountResponse]
     def read_spending_plan_account(user_guid, spending_plan_guid, spending_plan_account_guid, opts = {})
       data, _status_code, _headers = read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts)
@@ -685,12 +760,12 @@ module MxPlatformRuby
 
     # Read spending plan account
     # Use this endpoint to read the attributes of a specific spending plan account according to its unique GUID.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param spending_plan_account_guid [String] The unique ID for the specified account.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [Array<(SpendingPlanAccountResponse, Integer, Hash)>] SpendingPlanAccountResponse data, response status code and response headers
     def read_spending_plan_account_with_http_info(user_guid, spending_plan_guid, spending_plan_account_guid, opts = {})
       if @api_client.config.debugging
@@ -752,12 +827,12 @@ module MxPlatformRuby
 
     # Read a spending plan iteration
     # Use this endpoint to read the attributes of a specific spending plan `iteration` according to its `iteration_number`.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
-    # @param iteration_number [Integer] The current iteration number for the spending plan &#x60;iteration&#x60;&#x60;.
+    # @param iteration_number [Integer] The current iteration number for the spending plan &#x60;iteration&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [SpendingPlanIterationResponse]
     def read_spending_plan_iteration(user_guid, spending_plan_guid, iteration_number, opts = {})
       data, _status_code, _headers = read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, opts)
@@ -766,12 +841,12 @@ module MxPlatformRuby
 
     # Read a spending plan iteration
     # Use this endpoint to read the attributes of a specific spending plan &#x60;iteration&#x60; according to its &#x60;iteration_number&#x60;.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
-    # @param iteration_number [Integer] The current iteration number for the spending plan &#x60;iteration&#x60;&#x60;.
+    # @param iteration_number [Integer] The current iteration number for the spending plan &#x60;iteration&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [Array<(SpendingPlanIterationResponse, Integer, Hash)>] SpendingPlanIterationResponse data, response status code and response headers
     def read_spending_plan_iteration_with_http_info(user_guid, spending_plan_guid, iteration_number, opts = {})
       if @api_client.config.debugging
@@ -833,12 +908,12 @@ module MxPlatformRuby
 
     # Read a spending plan iteration item
     # Use this endpoint to read the attributes of a specific spending plan `iteration_item` according to its unique GUID.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [SpendingPlanIterationItemResponse]
     def read_spending_plan_iteration_item(user_guid, spending_plan_guid, iteration_item_guid, opts = {})
       data, _status_code, _headers = read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts)
@@ -847,12 +922,12 @@ module MxPlatformRuby
 
     # Read a spending plan iteration item
     # Use this endpoint to read the attributes of a specific spending plan &#x60;iteration_item&#x60; according to its unique GUID.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [Array<(SpendingPlanIterationItemResponse, Integer, Hash)>] SpendingPlanIterationItemResponse data, response status code and response headers
     def read_spending_plan_iteration_item_with_http_info(user_guid, spending_plan_guid, iteration_item_guid, opts = {})
       if @api_client.config.debugging
@@ -914,11 +989,11 @@ module MxPlatformRuby
 
     # Read a spending plan for a user
     # Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [SpendingPlanResponse]
     def read_spending_plan_user(user_guid, spending_plan_guid, opts = {})
       data, _status_code, _headers = read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, opts)
@@ -927,11 +1002,11 @@ module MxPlatformRuby
 
     # Read a spending plan for a user
     # Use this endpoint to read the attributes of a specific spending plan according to its unique GUID.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page Specify current page.
-    # @option opts [Integer] :records_per_page Specify records per page.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
     # @return [Array<(SpendingPlanResponse, Integer, Hash)>] SpendingPlanResponse data, response status code and response headers
     def read_spending_plan_user_with_http_info(user_guid, spending_plan_guid, opts = {})
       if @api_client.config.debugging
@@ -989,7 +1064,7 @@ module MxPlatformRuby
 
     # Update a spending plan iteration item
     # Use this endpoint to update an existing `spending_plan_iteration_item`.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
     # @param spending_plan_iteration_item_create_request_body [SpendingPlanIterationItemCreateRequestBody] Iteration item to be updated with required parameter (planned_amount)
@@ -1002,7 +1077,7 @@ module MxPlatformRuby
 
     # Update a spending plan iteration item
     # Use this endpoint to update an existing &#x60;spending_plan_iteration_item&#x60;.
-    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
     # @param spending_plan_guid [String] The unique ID for the &#x60;spending_plan&#x60;.
     # @param iteration_item_guid [String] The unique ID for the &#x60;iteration_item&#x60;.
     # @param spending_plan_iteration_item_create_request_body [SpendingPlanIterationItemCreateRequestBody] Iteration item to be updated with required parameter (planned_amount)