mx-platform-ruby 1.10.0 → 1.10.1

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

@@ -0,0 +1,388 @@
+=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.  Just getting started? See our [use case guides](/use-cases/). 
+
+The version of the OpenAPI document: 20111101
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'cgi'
+
+module MxPlatformRuby
+  class TagsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create tag
+    # Use this endpoint to create a new custom tag.
+    # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
+    # @param tag_create_request_body [TagCreateRequestBody] Tag object to be created with required parameters (tag_guid)
+    # @param [Hash] opts the optional parameters
+    # @return [TagResponseBody]
+    def create_tag(user_guid, tag_create_request_body, opts = {})
+      data, _status_code, _headers = create_tag_with_http_info(user_guid, tag_create_request_body, opts)
+      data
+    end
+
+    # Create tag
+    # Use this endpoint to create a new custom tag.
+    # @param user_guid [String] The unique identifier for a `user`, beginning with the prefix `USR-`.
+    # @param tag_create_request_body [TagCreateRequestBody] Tag object to be created with required parameters (tag_guid)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TagResponseBody, Integer, Hash)>] TagResponseBody data, response status code and response headers
+    def create_tag_with_http_info(user_guid, tag_create_request_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagsApi.create_tag ...'
+      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 TagsApi.create_tag"
+      end
+      # verify the required parameter 'tag_create_request_body' is set
+      if @api_client.config.client_side_validation && tag_create_request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'tag_create_request_body' when calling TagsApi.create_tag"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/tags'.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/vnd.mx.api.v1+json']) unless header_params['Accept']
+      # 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(tag_create_request_body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TagResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"TagsApi.create_tag",
+        :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: TagsApi#create_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete tag
+    # Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of `204 No Content`.
+    # @param tag_guid [String] The unique id for a &#x60;tag&#x60;.
+    # @param accept [String] Specifies the media type expected in the response.
+    # @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
+    # @return [nil]
+    def delete_tag(tag_guid, accept, user_guid, opts = {})
+      delete_tag_with_http_info(tag_guid, accept, user_guid, opts)
+      nil
+    end
+
+    # Delete tag
+    # Use this endpoint to permanently delete a specific tag based on its unique GUID. If successful, the API will respond with status of &#x60;204 No Content&#x60;.
+    # @param tag_guid [String] The unique id for a &#x60;tag&#x60;.
+    # @param accept [String] Specifies the media type expected in the response.
+    # @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
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_tag_with_http_info(tag_guid, accept, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagsApi.delete_tag ...'
+      end
+      # verify the required parameter 'tag_guid' is set
+      if @api_client.config.client_side_validation && tag_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'tag_guid' when calling TagsApi.delete_tag"
+      end
+      # verify the required parameter 'accept' is set
+      if @api_client.config.client_side_validation && accept.nil?
+        fail ArgumentError, "Missing the required parameter 'accept' when calling TagsApi.delete_tag"
+      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 TagsApi.delete_tag"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/tags/{tag_guid}'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_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] || {}
+      header_params[:'Accept'] = accept
+
+      # 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 => :"TagsApi.delete_tag",
+        :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: TagsApi#delete_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List tags
+    # Use this endpoint to list all tags associated with the specified `user`. Each user includes the `Business` tag by default.
+    # @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 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 [TagsResponseBody]
+    def list_tags(user_guid, opts = {})
+      data, _status_code, _headers = list_tags_with_http_info(user_guid, opts)
+      data
+    end
+
+    # List tags
+    # Use this endpoint to list all tags associated with the specified &#x60;user&#x60;. Each user includes the &#x60;Business&#x60; tag by default.
+    # @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 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<(TagsResponseBody, Integer, Hash)>] TagsResponseBody data, response status code and response headers
+    def list_tags_with_http_info(user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagsApi.list_tags ...'
+      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 TagsApi.list_tags"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/tags'.sub('{' + 'user_guid' + '}', CGI.escape(user_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] || 'TagsResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"TagsApi.list_tags",
+        :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: TagsApi#list_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read tag
+    # Use this endpoint to read the attributes of a particular tag according to its unique GUID.
+    # @param tag_guid [String] The unique id for a &#x60;tag&#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
+    # @return [TagResponseBody]
+    def read_tag(tag_guid, user_guid, opts = {})
+      data, _status_code, _headers = read_tag_with_http_info(tag_guid, user_guid, opts)
+      data
+    end
+
+    # Read tag
+    # Use this endpoint to read the attributes of a particular tag according to its unique GUID.
+    # @param tag_guid [String] The unique id for a &#x60;tag&#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
+    # @return [Array<(TagResponseBody, Integer, Hash)>] TagResponseBody data, response status code and response headers
+    def read_tag_with_http_info(tag_guid, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagsApi.read_tag ...'
+      end
+      # verify the required parameter 'tag_guid' is set
+      if @api_client.config.client_side_validation && tag_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'tag_guid' when calling TagsApi.read_tag"
+      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 TagsApi.read_tag"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/tags/{tag_guid}'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_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] || {}
+      # 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] || 'TagResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"TagsApi.read_tag",
+        :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: TagsApi#read_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update tag
+    # Use this endpoint to update the name of a specific tag according to its unique GUID.
+    # @param tag_guid [String] The unique id for a &#x60;tag&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param tag_update_request_body [TagUpdateRequestBody] Tag object to be updated with required parameter (tag_guid)
+    # @param [Hash] opts the optional parameters
+    # @return [TagResponseBody]
+    def update_tag(tag_guid, user_guid, tag_update_request_body, opts = {})
+      data, _status_code, _headers = update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body, opts)
+      data
+    end
+
+    # Update tag
+    # Use this endpoint to update the name of a specific tag according to its unique GUID.
+    # @param tag_guid [String] The unique id for a &#x60;tag&#x60;.
+    # @param user_guid [String] The unique identifier for a &#x60;user&#x60;, beginning with the prefix &#x60;USR-&#x60;.
+    # @param tag_update_request_body [TagUpdateRequestBody] Tag object to be updated with required parameter (tag_guid)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TagResponseBody, Integer, Hash)>] TagResponseBody data, response status code and response headers
+    def update_tag_with_http_info(tag_guid, user_guid, tag_update_request_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TagsApi.update_tag ...'
+      end
+      # verify the required parameter 'tag_guid' is set
+      if @api_client.config.client_side_validation && tag_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'tag_guid' when calling TagsApi.update_tag"
+      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 TagsApi.update_tag"
+      end
+      # verify the required parameter 'tag_update_request_body' is set
+      if @api_client.config.client_side_validation && tag_update_request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'tag_update_request_body' when calling TagsApi.update_tag"
+      end
+      # resource path
+      local_var_path = '/users/{user_guid}/tags/{tag_guid}'.sub('{' + 'tag_guid' + '}', CGI.escape(tag_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] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json']) unless header_params['Accept']
+      # 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(tag_update_request_body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TagResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"TagsApi.update_tag",
+        :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: TagsApi#update_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end