hooksniff 0.1.0 → 0.3.0

data/lib/openapi_client/api/webhooks_api.rb

@@ -0,0 +1,534 @@
+=begin
+#HookSniff API
+
+#Webhook delivery, monitoring, and management API. All endpoints under `/v1` require authentication via `Authorization: Bearer <api_key>` header unless marked as **Public**. 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@hooksniff.vercel.app
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'cgi'
+
+module OpenapiClient
+  class WebhooksApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Send multiple webhooks in batch
+    # @param batch_webhook_request [BatchWebhookRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BatchResponse]
+    def webhooks_batch_post(batch_webhook_request, opts = {})
+      data, _status_code, _headers = webhooks_batch_post_with_http_info(batch_webhook_request, opts)
+      data
+    end
+
+    # Send multiple webhooks in batch
+    # @param batch_webhook_request [BatchWebhookRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BatchResponse, Integer, Hash)>] BatchResponse data, response status code and response headers
+    def webhooks_batch_post_with_http_info(batch_webhook_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_batch_post ...'
+      end
+      # verify the required parameter 'batch_webhook_request' is set
+      if @api_client.config.client_side_validation && batch_webhook_request.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_webhook_request' when calling WebhooksApi.webhooks_batch_post"
+      end
+      # resource path
+      local_var_path = '/webhooks/batch'
+
+      # 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']) unless header_params['Accept']
+      # 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(batch_webhook_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BatchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.webhooks_batch_post",
+        :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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhooksApi#webhooks_batch_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Replay multiple deliveries by ID
+    # @param batch_replay_request [BatchReplayRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def webhooks_batch_replay_post(batch_replay_request, opts = {})
+      webhooks_batch_replay_post_with_http_info(batch_replay_request, opts)
+      nil
+    end
+
+    # Replay multiple deliveries by ID
+    # @param batch_replay_request [BatchReplayRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def webhooks_batch_replay_post_with_http_info(batch_replay_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_batch_replay_post ...'
+      end
+      # verify the required parameter 'batch_replay_request' is set
+      if @api_client.config.client_side_validation && batch_replay_request.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_replay_request' when calling WebhooksApi.webhooks_batch_replay_post"
+      end
+      # resource path
+      local_var_path = '/webhooks/batch/replay'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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(batch_replay_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.webhooks_batch_replay_post",
+        :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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhooksApi#webhooks_batch_replay_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Export deliveries as CSV
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :range  (default to '7d')
+    # @return [String]
+    def webhooks_export_get(opts = {})
+      data, _status_code, _headers = webhooks_export_get_with_http_info(opts)
+      data
+    end
+
+    # Export deliveries as CSV
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :range  (default to '7d')
+    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    def webhooks_export_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_export_get ...'
+      end
+      allowable_values = ["24h", "7d", "30d"]
+      if @api_client.config.client_side_validation && opts[:'range'] && !allowable_values.include?(opts[:'range'])
+        fail ArgumentError, "invalid value for \"range\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/webhooks/export'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'range'] = opts[:'range'] if !opts[:'range'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['text/csv']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'String'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.webhooks_export_get",
+        :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: WebhooksApi#webhooks_export_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List webhook deliveries
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 20)
+    # @option opts [String] :status 
+    # @option opts [String] :endpoint_id 
+    # @return [DeliveryListResponse]
+    def webhooks_get(opts = {})
+      data, _status_code, _headers = webhooks_get_with_http_info(opts)
+      data
+    end
+
+    # List webhook deliveries
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :per_page  (default to 20)
+    # @option opts [String] :status 
+    # @option opts [String] :endpoint_id 
+    # @return [Array<(DeliveryListResponse, Integer, Hash)>] DeliveryListResponse data, response status code and response headers
+    def webhooks_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_get ...'
+      end
+      allowable_values = ["pending", "processing", "delivered", "failed"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/webhooks'
+
+      # 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?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'endpoint_id'] = opts[:'endpoint_id'] if !opts[:'endpoint_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DeliveryListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.webhooks_get",
+        :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: WebhooksApi#webhooks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get delivery attempts
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<DeliveryAttempt>]
+    def webhooks_id_attempts_get(id, opts = {})
+      data, _status_code, _headers = webhooks_id_attempts_get_with_http_info(id, opts)
+      data
+    end
+
+    # Get delivery attempts
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<DeliveryAttempt>, Integer, Hash)>] Array<DeliveryAttempt> data, response status code and response headers
+    def webhooks_id_attempts_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_id_attempts_get ...'
+      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.webhooks_id_attempts_get"
+      end
+      # resource path
+      local_var_path = '/webhooks/{id}/attempts'.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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<DeliveryAttempt>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.webhooks_id_attempts_get",
+        :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: WebhooksApi#webhooks_id_attempts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get delivery by ID
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Delivery]
+    def webhooks_id_get(id, opts = {})
+      data, _status_code, _headers = webhooks_id_get_with_http_info(id, opts)
+      data
+    end
+
+    # Get delivery by ID
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Delivery, Integer, Hash)>] Delivery data, response status code and response headers
+    def webhooks_id_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_id_get ...'
+      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.webhooks_id_get"
+      end
+      # resource path
+      local_var_path = '/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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Delivery'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.webhooks_id_get",
+        :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: WebhooksApi#webhooks_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Replay a single delivery
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Delivery]
+    def webhooks_id_replay_post(id, opts = {})
+      data, _status_code, _headers = webhooks_id_replay_post_with_http_info(id, opts)
+      data
+    end
+
+    # Replay a single delivery
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Delivery, Integer, Hash)>] Delivery data, response status code and response headers
+    def webhooks_id_replay_post_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_id_replay_post ...'
+      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.webhooks_id_replay_post"
+      end
+      # resource path
+      local_var_path = '/webhooks/{id}/replay'.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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Delivery'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.webhooks_id_replay_post",
+        :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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhooksApi#webhooks_id_replay_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send a webhook
+    # @param create_webhook_request [CreateWebhookRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Delivery]
+    def webhooks_post(create_webhook_request, opts = {})
+      data, _status_code, _headers = webhooks_post_with_http_info(create_webhook_request, opts)
+      data
+    end
+
+    # Send a webhook
+    # @param create_webhook_request [CreateWebhookRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Delivery, Integer, Hash)>] Delivery data, response status code and response headers
+    def webhooks_post_with_http_info(create_webhook_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.webhooks_post ...'
+      end
+      # verify the required parameter 'create_webhook_request' is set
+      if @api_client.config.client_side_validation && create_webhook_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_webhook_request' when calling WebhooksApi.webhooks_post"
+      end
+      # resource path
+      local_var_path = '/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']) unless header_params['Accept']
+      # 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(create_webhook_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Delivery'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.webhooks_post",
+        :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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhooksApi#webhooks_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end