class Pipedrive::GlobalMessagesApi
Attributes
Public Class Methods
# File lib/pipedrive-openapi-client/api/global_messages_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get global messages Returns data about global messages to display for the authorized user. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of messages to get from 1 to 100. The message number 1 is returned by default. (default to 1) @return [GlobalMessageGet]
# File lib/pipedrive-openapi-client/api/global_messages_api.rb, line 27 def global_messages_get(opts = {}) data, _status_code, _headers = global_messages_get_with_http_info(opts) data end
Get global messages Returns data about global messages to display for the authorized user. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of messages to get from 1 to 100. The message number 1 is returned by default. @return [Array<(GlobalMessageGet
, Integer, Hash)>] GlobalMessageGet
data, response status code and response headers
# File lib/pipedrive-openapi-client/api/global_messages_api.rb, line 37 def global_messages_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: GlobalMessagesApi.global_messages_get ...' end # resource path local_var_path = '/globalMessages' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # 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[:body] # return_type return_type = opts[:return_type] || 'GlobalMessageGet' # auth_names auth_names = opts[:auth_names] || ['api_key'] new_options = opts.merge( :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: GlobalMessagesApi#global_messages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Dismiss a global message Removes global message from being shown, if message is dismissible @param id [Integer] ID of global message to be dismissed. @param [Hash] opts the optional parameters @return [GlobalMessageDelete]
# File lib/pipedrive-openapi-client/api/global_messages_api.rb, line 86 def global_messages_id_delete(id, opts = {}) data, _status_code, _headers = global_messages_id_delete_with_http_info(id, opts) data end
Dismiss a global message Removes global message from being shown, if message is dismissible @param id [Integer] ID of global message to be dismissed. @param [Hash] opts the optional parameters @return [Array<(GlobalMessageDelete
, Integer, Hash)>] GlobalMessageDelete
data, response status code and response headers
# File lib/pipedrive-openapi-client/api/global_messages_api.rb, line 96 def global_messages_id_delete_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: GlobalMessagesApi.global_messages_id_delete ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling GlobalMessagesApi.global_messages_id_delete" end # resource path local_var_path = '/globalMessages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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[:body] # return_type return_type = opts[:return_type] || 'GlobalMessageDelete' # auth_names auth_names = opts[:auth_names] || ['api_key'] new_options = opts.merge( :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: GlobalMessagesApi#global_messages_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end