class Hubspot::Crm::Extensions::Videoconferencing::SettingsApi
Attributes
Public Class Methods
# File lib/hubspot/codegen/crm/extensions/videoconferencing/api/settings_api.rb, line 22 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete settings Deletes the settings for a video conference application with the specified ID. @param app_id [Integer] The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal. @param [Hash] opts the optional parameters @return [nil]
# File lib/hubspot/codegen/crm/extensions/videoconferencing/api/settings_api.rb, line 30 def archive(app_id, opts = {}) archive_with_http_info(app_id, opts) nil end
Delete settings Deletes the settings for a video conference application with the specified ID. @param app_id [Integer] The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/hubspot/codegen/crm/extensions/videoconferencing/api/settings_api.rb, line 40 def archive_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.archive ...' 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.archive" end # resource path local_var_path = '/crm/v3/extensions/videoconferencing/settings/{appId}'.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#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get settings Return the settings for a video conference application with the specified ID. @param app_id [Integer] The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal. @param [Hash] opts the optional parameters @return [ExternalSettings]
# File lib/hubspot/codegen/crm/extensions/videoconferencing/api/settings_api.rb, line 92 def get_by_id(app_id, opts = {}) data, _status_code, _headers = get_by_id_with_http_info(app_id, opts) data end
Get settings Return the settings for a video conference application with the specified ID. @param app_id [Integer] The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal. @param [Hash] opts the optional parameters @return [Array<(ExternalSettings
, Integer, Hash)>] ExternalSettings
data, response status code and response headers
# File lib/hubspot/codegen/crm/extensions/videoconferencing/api/settings_api.rb, line 102 def get_by_id_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.get_by_id ...' 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_by_id" end # resource path local_var_path = '/crm/v3/extensions/videoconferencing/settings/{appId}'.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] || 'ExternalSettings' # 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_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update settings Updates the settings for a video conference application with the specified ID. @param app_id [Integer] The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal. @param external_settings [ExternalSettings] @param [Hash] opts the optional parameters @return [ExternalSettings]
# File lib/hubspot/codegen/crm/extensions/videoconferencing/api/settings_api.rb, line 155 def replace(app_id, external_settings, opts = {}) data, _status_code, _headers = replace_with_http_info(app_id, external_settings, opts) data end
Update settings Updates the settings for a video conference application with the specified ID. @param app_id [Integer] The ID of the video conference application. This is the identifier of the application created in your HubSpot developer portal. @param external_settings [ExternalSettings] @param [Hash] opts the optional parameters @return [Array<(ExternalSettings
, Integer, Hash)>] ExternalSettings
data, response status code and response headers
# File lib/hubspot/codegen/crm/extensions/videoconferencing/api/settings_api.rb, line 166 def replace_with_http_info(app_id, external_settings, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.replace ...' 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.replace" end # verify the required parameter 'external_settings' is set if @api_client.config.client_side_validation && external_settings.nil? fail ArgumentError, "Missing the required parameter 'external_settings' when calling SettingsApi.replace" end # resource path local_var_path = '/crm/v3/extensions/videoconferencing/settings/{appId}'.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(external_settings) # return_type return_type = opts[:return_type] || 'ExternalSettings' # 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#replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end