=begin #API Reference #Review our [API Introduction](../api-introduction) to get started. OpenAPI spec version: 1.0 Generated by: https://github.com/swagger-api/swagger-codegen.git =end module TurnkeyClient class UserTagsApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create User Tag # Create a user tag and add it to users. # @param body # @param [Hash] opts the optional parameters # @return [ActivityResponse] def create_user_tag(body, opts = {}) data, _status_code, _headers = create_user_tag_with_http_info(body, opts) data end # Create User Tag # Create a user tag and add it to users. # @param body # @param [Hash] opts the optional parameters # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers def create_user_tag_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserTagsApi.create_user_tag ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UserTagsApi.create_user_tag" end # resource path local_var_path = '/public/v1/submit/create_user_tag' # 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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'ActivityResponse' auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: UserTagsApi#create_user_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Delete User Tags # Delete User Tags within an Organization # @param body # @param [Hash] opts the optional parameters # @return [ActivityResponse] def delete_user_tags(body, opts = {}) data, _status_code, _headers = delete_user_tags_with_http_info(body, opts) data end # Delete User Tags # Delete User Tags within an Organization # @param body # @param [Hash] opts the optional parameters # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers def delete_user_tags_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserTagsApi.delete_user_tags ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UserTagsApi.delete_user_tags" end # resource path local_var_path = '/public/v1/submit/delete_user_tags' # 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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'ActivityResponse' auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: UserTagsApi#delete_user_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # List User Tags # List all User Tags within an Organization # @param body # @param [Hash] opts the optional parameters # @return [ListUserTagsResponse] def list_user_tags(body, opts = {}) data, _status_code, _headers = list_user_tags_with_http_info(body, opts) data end # List User Tags # List all User Tags within an Organization # @param body # @param [Hash] opts the optional parameters # @return [Array<(ListUserTagsResponse, Integer, Hash)>] ListUserTagsResponse data, response status code and response headers def list_user_tags_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserTagsApi.list_user_tags ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UserTagsApi.list_user_tags" end # resource path local_var_path = '/public/v1/query/list_user_tags' # 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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'ListUserTagsResponse' auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: UserTagsApi#list_user_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update User Tag # Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail. # @param body # @param [Hash] opts the optional parameters # @return [ActivityResponse] def update_user_tag(body, opts = {}) data, _status_code, _headers = update_user_tag_with_http_info(body, opts) data end # Update User Tag # Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail. # @param body # @param [Hash] opts the optional parameters # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers def update_user_tag_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UserTagsApi.update_user_tag ...' end # verify the required parameter 'body' is set if @api_client.config.client_side_validation && body.nil? fail ArgumentError, "Missing the required parameter 'body' when calling UserTagsApi.update_user_tag" end # resource path local_var_path = '/public/v1/submit/update_user_tag' # 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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(body) return_type = opts[:return_type] || 'ActivityResponse' auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type) if @api_client.config.debugging @api_client.config.logger.debug "API called: UserTagsApi#update_user_tag\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end