class Hubspot::Webhooks::SettingsApi
Attributes
Public Class Methods
# File lib/hubspot/codegen/webhooks/api/settings_api.rb, line 20 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Clear webhook settings Resets webhook target URL to empty, and max concurrency limit to `0` for the given app. This will effectively pause all webhook subscriptions until new settings are provided. @param app_id [Integer] The ID of the target app. @param [Hash] opts the optional parameters @return [nil]
# File lib/hubspot/codegen/webhooks/api/settings_api.rb, line 28 def clear_settings(app_id, opts = {}) clear_settings_with_http_info(app_id, opts) nil end
Clear webhook settings Resets webhook target URL to empty, and max concurrency limit to `0` for the given app. This will effectively pause all webhook subscriptions until new settings are provided. @param app_id [Integer] The ID of the target app. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/hubspot/codegen/webhooks/api/settings_api.rb, line 38 def clear_settings_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.clear_settings ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.clear_settings" end # resource path local_var_path = '/webhooks/v3/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_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(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['hapikey'] 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: SettingsApi#clear_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Configure webhook settings Used to set the webhook target URL and max concurrency limit for the given app. @param app_id [Integer] The ID of the target app. @param [Hash] opts the optional parameters @option opts [SettingsChangeRequest] :settings_change_request Settings state to create new with or replace existing settings with. @return [SettingsResponse]
# File lib/hubspot/codegen/webhooks/api/settings_api.rb, line 91 def configure_settings(app_id, opts = {}) data, _status_code, _headers = configure_settings_with_http_info(app_id, opts) data end
Configure webhook settings Used to set the webhook target URL and max concurrency limit for the given app. @param app_id [Integer] The ID of the target app. @param [Hash] opts the optional parameters @option opts [SettingsChangeRequest] :settings_change_request Settings state to create new with or replace existing settings with. @return [Array<(SettingsResponse
, Integer, Hash)>] SettingsResponse
data, response status code and response headers
# File lib/hubspot/codegen/webhooks/api/settings_api.rb, line 102 def configure_settings_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.configure_settings ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.configure_settings" end # resource path local_var_path = '/webhooks/v3/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_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', '*/*']) # 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(opts[:'settings_change_request']) # return_type return_type = opts[:return_type] || 'SettingsResponse' # auth_names auth_names = opts[:auth_names] || ['hapikey'] 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(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: SettingsApi#configure_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get webhook settings Returns the current state of webhook settings for the given app. These settings include the app's configured target URL and max concurrency limit. @param app_id [Integer] The ID of the target app. @param [Hash] opts the optional parameters @return [SettingsResponse]
# File lib/hubspot/codegen/webhooks/api/settings_api.rb, line 156 def get_settings(app_id, opts = {}) data, _status_code, _headers = get_settings_with_http_info(app_id, opts) data end
Get webhook settings Returns the current state of webhook settings for the given app. These settings include the app's configured target URL and max concurrency limit. @param app_id [Integer] The ID of the target app. @param [Hash] opts the optional parameters @return [Array<(SettingsResponse
, Integer, Hash)>] SettingsResponse
data, response status code and response headers
# File lib/hubspot/codegen/webhooks/api/settings_api.rb, line 166 def get_settings_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.get_settings ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.get_settings" end # resource path local_var_path = '/webhooks/v3/{appId}/settings'.sub('{' + 'appId' + '}', CGI.escape(app_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] || 'SettingsResponse' # auth_names auth_names = opts[:auth_names] || ['hapikey'] 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: SettingsApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end