Class: Hubspot::Webhooks::SettingsApi
- Inherits:
-
Object
- Object
- Hubspot::Webhooks::SettingsApi
- Defined in:
- lib/hubspot/codegen/webhooks/api/settings_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
- #clear(app_id, opts = {}) ⇒ nil
-
#clear_with_http_info(app_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Nil, response status code and response headers.
- #configure(app_id, settings_change_request, opts = {}) ⇒ SettingsResponse
-
#configure_with_http_info(app_id, settings_change_request, opts = {}) ⇒ Array<(SettingsResponse, Integer, Hash)>
SettingsResponse data, response status code and response headers.
- #get_all(app_id, opts = {}) ⇒ SettingsResponse
-
#get_all_with_http_info(app_id, opts = {}) ⇒ Array<(SettingsResponse, Integer, Hash)>
SettingsResponse data, response status code and response headers.
-
#initialize(api_client = ApiClient.default) ⇒ SettingsApi
constructor
A new instance of SettingsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ SettingsApi
Returns a new instance of SettingsApi.
20 21 22 |
# File 'lib/hubspot/codegen/webhooks/api/settings_api.rb', line 20 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
18 19 20 |
# File 'lib/hubspot/codegen/webhooks/api/settings_api.rb', line 18 def api_client @api_client end |
Instance Method Details
#clear(app_id, opts = {}) ⇒ nil
26 27 28 29 |
# File 'lib/hubspot/codegen/webhooks/api/settings_api.rb', line 26 def clear(app_id, opts = {}) clear_with_http_info(app_id, opts) nil end |
#clear_with_http_info(app_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Returns nil, response status code and response headers.
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/hubspot/codegen/webhooks/api/settings_api.rb', line 34 def clear_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.clear ...' 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" 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] || ['developer_hapikey'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SettingsApi#clear\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#configure(app_id, settings_change_request, opts = {}) ⇒ SettingsResponse
85 86 87 88 |
# File 'lib/hubspot/codegen/webhooks/api/settings_api.rb', line 85 def configure(app_id, settings_change_request, opts = {}) data, _status_code, _headers = configure_with_http_info(app_id, settings_change_request, opts) data end |
#configure_with_http_info(app_id, settings_change_request, opts = {}) ⇒ Array<(SettingsResponse, Integer, Hash)>
Returns SettingsResponse data, response status code and response headers.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/hubspot/codegen/webhooks/api/settings_api.rb', line 94 def configure_with_http_info(app_id, settings_change_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.configure ...' 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" end # verify the required parameter 'settings_change_request' is set if @api_client.config.client_side_validation && settings_change_request.nil? fail ArgumentError, "Missing the required parameter 'settings_change_request' when calling SettingsApi.configure" 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(settings_change_request) # return_type return_type = opts[:return_type] || 'SettingsResponse' # auth_names auth_names = opts[:auth_names] || ['developer_hapikey'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SettingsApi#configure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all(app_id, opts = {}) ⇒ SettingsResponse
150 151 152 153 |
# File 'lib/hubspot/codegen/webhooks/api/settings_api.rb', line 150 def get_all(app_id, opts = {}) data, _status_code, _headers = get_all_with_http_info(app_id, opts) data end |
#get_all_with_http_info(app_id, opts = {}) ⇒ Array<(SettingsResponse, Integer, Hash)>
Returns SettingsResponse data, response status code and response headers.
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/hubspot/codegen/webhooks/api/settings_api.rb', line 158 def get_all_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.get_all ...' 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_all" 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] || ['developer_hapikey'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SettingsApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |