Class: Phrase::WebhooksApi
- Inherits:
-
Object
- Object
- Phrase::WebhooksApi
- Defined in:
- lib/phrase/api/webhooks_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ WebhooksApi
constructor
A new instance of WebhooksApi.
-
#webhook_create(project_id, webhook_create_parameters, opts = {}) ⇒ Webhook
Create a webhook Create a new webhook.
-
#webhook_create_with_http_info(project_id, webhook_create_parameters, opts = {}) ⇒ Array<(Response<(Webhook)>, Integer, Hash)>
Create a webhook Create a new webhook.
-
#webhook_delete(project_id, id, opts = {}) ⇒ nil
Delete a webhook Delete an existing webhook.
-
#webhook_delete_with_http_info(project_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>
Delete a webhook Delete an existing webhook.
-
#webhook_show(project_id, id, opts = {}) ⇒ Webhook
Get a single webhook Get details on a single webhook.
-
#webhook_show_with_http_info(project_id, id, opts = {}) ⇒ Array<(Response<(Webhook)>, Integer, Hash)>
Get a single webhook Get details on a single webhook.
-
#webhook_test(project_id, id, opts = {}) ⇒ nil
Test a webhook Perform a test request for a webhook.
-
#webhook_test_with_http_info(project_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>
Test a webhook Perform a test request for a webhook.
-
#webhook_update(project_id, id, webhook_update_parameters, opts = {}) ⇒ Webhook
Update a webhook Update an existing webhook.
-
#webhook_update_with_http_info(project_id, id, webhook_update_parameters, opts = {}) ⇒ Array<(Response<(Webhook)>, Integer, Hash)>
Update a webhook Update an existing webhook.
-
#webhooks_list(project_id, opts = {}) ⇒ Array<Webhook>
List webhooks List all webhooks for the given project.
-
#webhooks_list_with_http_info(project_id, opts = {}) ⇒ Array<(Response<(Array<Webhook>)>, Integer, Hash)>
List webhooks List all webhooks for the given project.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ WebhooksApi
Returns a new instance of WebhooksApi.
7 8 9 |
# File 'lib/phrase/api/webhooks_api.rb', line 7 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
5 6 7 |
# File 'lib/phrase/api/webhooks_api.rb', line 5 def api_client @api_client end |
Instance Method Details
#webhook_create(project_id, webhook_create_parameters, opts = {}) ⇒ Webhook
Create a webhook Create a new webhook.
17 18 19 20 |
# File 'lib/phrase/api/webhooks_api.rb', line 17 def webhook_create(project_id, webhook_create_parameters, opts = {}) data, _status_code, _headers = webhook_create_with_http_info(project_id, webhook_create_parameters, opts) data end |
#webhook_create_with_http_info(project_id, webhook_create_parameters, opts = {}) ⇒ Array<(Response<(Webhook)>, Integer, Hash)>
Create a webhook Create a new webhook.
29 30 31 32 33 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 80 81 82 |
# File 'lib/phrase/api/webhooks_api.rb', line 29 def webhook_create_with_http_info(project_id, webhook_create_parameters, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_create ...' end # verify the required parameter 'project_id' is set if @api_client.config.client_side_validation && project_id.nil? fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_create" end # verify the required parameter 'webhook_create_parameters' is set if @api_client.config.client_side_validation && webhook_create_parameters.nil? fail ArgumentError, "Missing the required parameter 'webhook_create_parameters' when calling WebhooksApi.webhook_create" end # resource path local_var_path = '/projects/{project_id}/webhooks'.sub('{' + 'project_id' + '}', CGI.escape(project_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']) header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(webhook_create_parameters) # return_type return_type = opts[:return_type] || 'Webhook' # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = 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(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksApi#webhook_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#webhook_delete(project_id, id, opts = {}) ⇒ nil
Delete a webhook Delete an existing webhook.
91 92 93 94 |
# File 'lib/phrase/api/webhooks_api.rb', line 91 def webhook_delete(project_id, id, opts = {}) data, _status_code, _headers = webhook_delete_with_http_info(project_id, id, opts) data end |
#webhook_delete_with_http_info(project_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>
Delete a webhook Delete an existing webhook.
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 146 147 148 149 150 151 152 |
# File 'lib/phrase/api/webhooks_api.rb', line 103 def webhook_delete_with_http_info(project_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_delete ...' end # verify the required parameter 'project_id' is set if @api_client.config.client_side_validation && project_id.nil? fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_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 WebhooksApi.webhook_delete" end # resource path local_var_path = '/projects/{project_id}/webhooks/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # 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] || ['Basic', 'Token'] = 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: WebhooksApi#webhook_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#webhook_show(project_id, id, opts = {}) ⇒ Webhook
Get a single webhook Get details on a single webhook.
161 162 163 164 |
# File 'lib/phrase/api/webhooks_api.rb', line 161 def webhook_show(project_id, id, opts = {}) data, _status_code, _headers = webhook_show_with_http_info(project_id, id, opts) data end |
#webhook_show_with_http_info(project_id, id, opts = {}) ⇒ Array<(Response<(Webhook)>, Integer, Hash)>
Get a single webhook Get details on a single webhook.
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 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 |
# File 'lib/phrase/api/webhooks_api.rb', line 173 def webhook_show_with_http_info(project_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_show ...' end # verify the required parameter 'project_id' is set if @api_client.config.client_side_validation && project_id.nil? fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_show" 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.webhook_show" end # resource path local_var_path = '/projects/{project_id}/webhooks/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).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']) header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Webhook' # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = 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: WebhooksApi#webhook_show\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#webhook_test(project_id, id, opts = {}) ⇒ nil
Test a webhook Perform a test request for a webhook.
233 234 235 236 |
# File 'lib/phrase/api/webhooks_api.rb', line 233 def webhook_test(project_id, id, opts = {}) data, _status_code, _headers = webhook_test_with_http_info(project_id, id, opts) data end |
#webhook_test_with_http_info(project_id, id, opts = {}) ⇒ Array<(Response, Integer, Hash)>
Test a webhook Perform a test request for a webhook.
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 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/phrase/api/webhooks_api.rb', line 245 def webhook_test_with_http_info(project_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_test ...' end # verify the required parameter 'project_id' is set if @api_client.config.client_side_validation && project_id.nil? fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_test" 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.webhook_test" end # resource path local_var_path = '/projects/{project_id}/webhooks/{id}/test'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # 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] || ['Basic', 'Token'] = 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(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksApi#webhook_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#webhook_update(project_id, id, webhook_update_parameters, opts = {}) ⇒ Webhook
Update a webhook Update an existing webhook.
304 305 306 307 |
# File 'lib/phrase/api/webhooks_api.rb', line 304 def webhook_update(project_id, id, webhook_update_parameters, opts = {}) data, _status_code, _headers = webhook_update_with_http_info(project_id, id, webhook_update_parameters, opts) data end |
#webhook_update_with_http_info(project_id, id, webhook_update_parameters, opts = {}) ⇒ Array<(Response<(Webhook)>, Integer, Hash)>
Update a webhook Update an existing webhook.
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 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/phrase/api/webhooks_api.rb', line 317 def webhook_update_with_http_info(project_id, id, webhook_update_parameters, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.webhook_update ...' end # verify the required parameter 'project_id' is set if @api_client.config.client_side_validation && project_id.nil? fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhook_update" 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.webhook_update" end # verify the required parameter 'webhook_update_parameters' is set if @api_client.config.client_side_validation && webhook_update_parameters.nil? fail ArgumentError, "Missing the required parameter 'webhook_update_parameters' when calling WebhooksApi.webhook_update" end # resource path local_var_path = '/projects/{project_id}/webhooks/{id}'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)).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' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(webhook_update_parameters) # return_type return_type = opts[:return_type] || 'Webhook' # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = 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(:PATCH, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksApi#webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |
#webhooks_list(project_id, opts = {}) ⇒ Array<Webhook>
List webhooks List all webhooks for the given project.
384 385 386 387 |
# File 'lib/phrase/api/webhooks_api.rb', line 384 def webhooks_list(project_id, opts = {}) data, _status_code, _headers = webhooks_list_with_http_info(project_id, opts) data end |
#webhooks_list_with_http_info(project_id, opts = {}) ⇒ Array<(Response<(Array<Webhook>)>, Integer, Hash)>
List webhooks List all webhooks for the given project.
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 |
# File 'lib/phrase/api/webhooks_api.rb', line 397 def webhooks_list_with_http_info(project_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_list ...' end # verify the required parameter 'project_id' is set if @api_client.config.client_side_validation && project_id.nil? fail ArgumentError, "Missing the required parameter 'project_id' when calling WebhooksApi.webhooks_list" end # resource path local_var_path = '/projects/{project_id}/webhooks'.sub('{' + 'project_id' + '}', CGI.escape(project_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'X-PhraseApp-OTP'] = opts[:'x_phrase_app_otp'] if !opts[:'x_phrase_app_otp'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Array<Webhook>' # auth_names auth_names = opts[:auth_names] || ['Basic', 'Token'] = 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: WebhooksApi#webhooks_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end response = ::Phrase::Response.new(data, headers) return response, status_code, headers end |