class Wire4Client::WebhooksApi
Attributes
Public Class Methods
# File lib/wire4_client/api/webhooks_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Consulta de Webhook
Obtiene un webhook registrado en la plataforma mediante su identificador. @param authorization Header para token @param webhook_id Es el identificador del webhook. Ejemplo: wh_54a932866f784b439bc625c0f4e04e12 @param [Hash] opts the optional parameters @return [WebhookResponse]
# File lib/wire4_client/api/webhooks_api.rb, line 28 def get_webhook(authorization, webhook_id, opts = {}) data, _status_code, _headers = get_webhook_with_http_info(authorization, webhook_id, opts) data end
Consulta de Webhook
Obtiene un webhook registrado en la plataforma mediante su identificador. @param authorization Header para token @param webhook_id Es el identificador del webhook. Ejemplo: wh_54a932866f784b439bc625c0f4e04e12 @param [Hash] opts the optional parameters @return [Array<(WebhookResponse
, Fixnum, Hash)>] WebhookResponse
data, response status code and response headers
# File lib/wire4_client/api/webhooks_api.rb, line 39 def get_webhook_with_http_info(authorization, webhook_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook ...' end # verify the required parameter 'authorization' is set if @api_client.config.client_side_validation && authorization.nil? fail ArgumentError, "Missing the required parameter 'authorization' when calling WebhooksApi.get_webhook" end # verify the required parameter 'webhook_id' is set if @api_client.config.client_side_validation && webhook_id.nil? fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.get_webhook" end # resource path local_var_path = '/webhooks/{webhook_id}'.sub('{' + 'webhook_id' + '}', webhook_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'Authorization'] = authorization # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'WebhookResponse') 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
Consulta la lista de Webhooks Obtiene una lista de los webhooks registrados en la plataforma que tengan el estado (estatus) Activo (ACTIVE) e Inactivo (INACTIVE). @param authorization Header para token @param [Hash] opts the optional parameters @return [WebhooksList]
# File lib/wire4_client/api/webhooks_api.rb, line 86 def get_webhooks(authorization, opts = {}) data, _status_code, _headers = get_webhooks_with_http_info(authorization, opts) data end
Consulta la lista de Webhooks Obtiene una lista de los webhooks registrados en la plataforma que tengan el estado (estatus) Activo (ACTIVE) e Inactivo (INACTIVE). @param authorization Header para token @param [Hash] opts the optional parameters @return [Array<(WebhooksList
, Fixnum, Hash)>] WebhooksList
data, response status code and response headers
# File lib/wire4_client/api/webhooks_api.rb, line 96 def get_webhooks_with_http_info(authorization, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhooks ...' end # verify the required parameter 'authorization' is set if @api_client.config.client_side_validation && authorization.nil? fail ArgumentError, "Missing the required parameter 'authorization' when calling WebhooksApi.get_webhooks" end # resource path local_var_path = '/webhooks' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'Authorization'] = authorization # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'WebhooksList') if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksApi#get_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Alta de Webhook
Registra un webhook en la plataforma para su uso como notificador de eventos, cuándo estos ocurran. @param authorization Header para token @param webhook_request Información para registrar un Webhook
@param [Hash] opts the optional parameters @return [WebhookResponse]
# File lib/wire4_client/api/webhooks_api.rb, line 140 def register_webhook(authorization, webhook_request, opts = {}) data, _status_code, _headers = register_webhook_with_http_info(authorization, webhook_request, opts) data end
Alta de Webhook
Registra un webhook en la plataforma para su uso como notificador de eventos, cuándo estos ocurran. @param authorization Header para token @param webhook_request Información para registrar un Webhook
@param [Hash] opts the optional parameters @return [Array<(WebhookResponse
, Fixnum, Hash)>] WebhookResponse
data, response status code and response headers
# File lib/wire4_client/api/webhooks_api.rb, line 151 def register_webhook_with_http_info(authorization, webhook_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WebhooksApi.register_webhook ...' end # verify the required parameter 'authorization' is set if @api_client.config.client_side_validation && authorization.nil? fail ArgumentError, "Missing the required parameter 'authorization' when calling WebhooksApi.register_webhook" end # verify the required parameter 'webhook_request' is set if @api_client.config.client_side_validation && webhook_request.nil? fail ArgumentError, "Missing the required parameter 'webhook_request' when calling WebhooksApi.register_webhook" end # resource path local_var_path = '/webhooks' # query parameters query_params = {} # header parameters 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[:'Authorization'] = authorization # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(webhook_request) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'WebhookResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: WebhooksApi#register_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end