Class: LaunchDarklyApi::WebhooksApi
- Inherits:
-
Object
- Object
- LaunchDarklyApi::WebhooksApi
- Defined in:
- lib/launchdarkly_api/api/webhooks_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_webhook(id, opts = {}) ⇒ nil
Delete webhook Delete a webhook by ID.
-
#delete_webhook_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete webhook Delete a webhook by ID.
-
#get_all_webhooks(opts = {}) ⇒ Webhooks
List webhooks Fetch a list of all webhooks.
-
#get_all_webhooks_with_http_info(opts = {}) ⇒ Array<(Webhooks, Integer, Hash)>
List webhooks Fetch a list of all webhooks.
-
#get_webhook(id, opts = {}) ⇒ Webhook
Get webhook Get a single webhook by ID.
-
#get_webhook_with_http_info(id, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>
Get webhook Get a single webhook by ID.
-
#initialize(api_client = ApiClient.default) ⇒ WebhooksApi
constructor
A new instance of WebhooksApi.
-
#patch_webhook(id, patch_operation, opts = {}) ⇒ Webhook
Update webhook Update a webhook’s settings.
-
#patch_webhook_with_http_info(id, patch_operation, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>
Update webhook Update a webhook's settings.
-
#post_webhook(webhook_post, opts = {}) ⇒ Webhook
Creates a webhook Create a new webhook.
-
#post_webhook_with_http_info(webhook_post, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>
Creates a webhook Create a new webhook.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ WebhooksApi
Returns a new instance of WebhooksApi.
19 20 21 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#delete_webhook(id, opts = {}) ⇒ nil
Delete webhook Delete a webhook by ID.
27 28 29 30 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 27 def delete_webhook(id, opts = {}) delete_webhook_with_http_info(id, opts) nil end |
#delete_webhook_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete webhook Delete a webhook by ID.
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 80 81 82 83 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 37 def delete_webhook_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.delete_webhook ...' 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 WebhooksApi.delete_webhook" end # resource path local_var_path = '/api/v2/webhooks/{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[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"WebhooksApi.delete_webhook", :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: WebhooksApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_all_webhooks(opts = {}) ⇒ Webhooks
List webhooks Fetch a list of all webhooks.
89 90 91 92 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 89 def get_all_webhooks(opts = {}) data, _status_code, _headers = get_all_webhooks_with_http_info(opts) data end |
#get_all_webhooks_with_http_info(opts = {}) ⇒ Array<(Webhooks, Integer, Hash)>
List webhooks Fetch a list of all webhooks.
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 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 98 def get_all_webhooks_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.get_all_webhooks ...' end # resource path local_var_path = '/api/v2/webhooks' # 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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Webhooks' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"WebhooksApi.get_all_webhooks", :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: WebhooksApi#get_all_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_webhook(id, opts = {}) ⇒ Webhook
Get webhook Get a single webhook by ID.
147 148 149 150 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 147 def get_webhook(id, opts = {}) data, _status_code, _headers = get_webhook_with_http_info(id, opts) data end |
#get_webhook_with_http_info(id, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>
Get webhook Get a single webhook by ID.
157 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/launchdarkly_api/api/webhooks_api.rb', line 157 def get_webhook_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook ...' 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 WebhooksApi.get_webhook" end # resource path local_var_path = '/api/v2/webhooks/{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[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Webhook' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"WebhooksApi.get_webhook", :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: WebhooksApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#patch_webhook(id, patch_operation, opts = {}) ⇒ Webhook
Update webhook Update a webhook’s settings. The request should be a valid JSON Patch document describing the changes to be made to the webhook.
211 212 213 214 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 211 def patch_webhook(id, patch_operation, opts = {}) data, _status_code, _headers = patch_webhook_with_http_info(id, patch_operation, opts) data end |
#patch_webhook_with_http_info(id, patch_operation, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>
Update webhook Update a webhook's settings. The request should be a valid JSON Patch document describing the changes to be made to the webhook.
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 222 def patch_webhook_with_http_info(id, patch_operation, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.patch_webhook ...' 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 WebhooksApi.patch_webhook" end # verify the required parameter 'patch_operation' is set if @api_client.config.client_side_validation && patch_operation.nil? fail ArgumentError, "Missing the required parameter 'patch_operation' when calling WebhooksApi.patch_webhook" end # resource path local_var_path = '/api/v2/webhooks/{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']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_operation) # return_type return_type = opts[:debug_return_type] || 'Webhook' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"WebhooksApi.patch_webhook", :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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksApi#patch_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_webhook(webhook_post, opts = {}) ⇒ Webhook
Creates a webhook Create a new webhook
284 285 286 287 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 284 def post_webhook(webhook_post, opts = {}) data, _status_code, _headers = post_webhook_with_http_info(webhook_post, opts) data end |
#post_webhook_with_http_info(webhook_post, opts = {}) ⇒ Array<(Webhook, Integer, Hash)>
Creates a webhook Create a new webhook
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/launchdarkly_api/api/webhooks_api.rb', line 294 def post_webhook_with_http_info(webhook_post, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.post_webhook ...' end # verify the required parameter 'webhook_post' is set if @api_client.config.client_side_validation && webhook_post.nil? fail ArgumentError, "Missing the required parameter 'webhook_post' when calling WebhooksApi.post_webhook" end # resource path local_var_path = '/api/v2/webhooks' # 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' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_post) # return_type return_type = opts[:debug_return_type] || 'Webhook' # auth_names auth_names = opts[:debug_auth_names] || ['ApiKey'] = opts.merge( :operation => :"WebhooksApi.post_webhook", :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(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksApi#post_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |