agent_push_kit 0.1.0

data/lib/agent_push_kit/api/events_api.rb

@@ -0,0 +1,520 @@
+=begin
+#Agent Push Kit API
+
+#The complete Agent Push Kit REST API. Application event ingestion uses an organization key beginning with `apk_`. Authenticated user operations accept either an Agent Push Kit login JWT or an agent access token beginning with `apt_`.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module AgentPushKit
+  class EventsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get one event including metadata
+    # @param organization_id [String] 
+    # @param event_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [EventDetail]
+    def get_event(organization_id, event_id, opts = {})
+      data, _status_code, _headers = get_event_with_http_info(organization_id, event_id, opts)
+      data
+    end
+
+    # Get one event including metadata
+    # @param organization_id [String] 
+    # @param event_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EventDetail, Integer, Hash)>] EventDetail data, response status code and response headers
+    def get_event_with_http_info(organization_id, event_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_event ...'
+      end
+      # verify the required parameter 'organization_id' is set
+      if @api_client.config.client_side_validation && organization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'organization_id' when calling EventsApi.get_event"
+      end
+      # verify the required parameter 'event_id' is set
+      if @api_client.config.client_side_validation && event_id.nil?
+        fail ArgumentError, "Missing the required parameter 'event_id' when calling EventsApi.get_event"
+      end
+      # resource path
+      local_var_path = '/organizations/{organizationId}/events/{eventId}'.sub('{organizationId}', CGI.escape(organization_id.to_s)).sub('{eventId}', CGI.escape(event_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] || 'EventDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.get_event",
+        :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: EventsApi#get_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List a paginated inbox
+    # @param organization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :service 
+    # @option opts [String] :type 
+    # @option opts [String] :search 
+    # @option opts [String] :cursor 
+    # @option opts [Integer] :limit  (default to 50)
+    # @return [EventPage]
+    def list_events(organization_id, opts = {})
+      data, _status_code, _headers = list_events_with_http_info(organization_id, opts)
+      data
+    end
+
+    # List a paginated inbox
+    # @param organization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :service 
+    # @option opts [String] :type 
+    # @option opts [String] :search 
+    # @option opts [String] :cursor 
+    # @option opts [Integer] :limit  (default to 50)
+    # @return [Array<(EventPage, Integer, Hash)>] EventPage data, response status code and response headers
+    def list_events_with_http_info(organization_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.list_events ...'
+      end
+      # verify the required parameter 'organization_id' is set
+      if @api_client.config.client_side_validation && organization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'organization_id' when calling EventsApi.list_events"
+      end
+      if @api_client.config.client_side_validation && !opts[:'service'].nil? && opts[:'service'].to_s.length > 120
+        fail ArgumentError, 'invalid value for "opts[:"service"]" when calling EventsApi.list_events, the character length must be smaller than or equal to 120.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'type'].nil? && opts[:'type'].to_s.length > 120
+        fail ArgumentError, 'invalid value for "opts[:"type"]" when calling EventsApi.list_events, the character length must be smaller than or equal to 120.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 200
+        fail ArgumentError, 'invalid value for "opts[:"search"]" when calling EventsApi.list_events, the character length must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EventsApi.list_events, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EventsApi.list_events, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/organizations/{organizationId}/events'.sub('{organizationId}', CGI.escape(organization_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'service'] = opts[:'service'] if !opts[:'service'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'EventPage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.list_events",
+        :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: EventsApi#list_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List distinct notification types
+    # @param organization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :service_id Optionally restrict types to one service ID.
+    # @return [Array<String>]
+    def list_notification_types(organization_id, opts = {})
+      data, _status_code, _headers = list_notification_types_with_http_info(organization_id, opts)
+      data
+    end
+
+    # List distinct notification types
+    # @param organization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :service_id Optionally restrict types to one service ID.
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def list_notification_types_with_http_info(organization_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.list_notification_types ...'
+      end
+      # verify the required parameter 'organization_id' is set
+      if @api_client.config.client_side_validation && organization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'organization_id' when calling EventsApi.list_notification_types"
+      end
+      # resource path
+      local_var_path = '/organizations/{organizationId}/types'.sub('{organizationId}', CGI.escape(organization_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'serviceId'] = opts[:'service_id'] if !opts[:'service_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] || 'Array<String>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.list_notification_types",
+        :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: EventsApi#list_notification_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List services discovered from ingested events
+    # @param organization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Service>]
+    def list_services(organization_id, opts = {})
+      data, _status_code, _headers = list_services_with_http_info(organization_id, opts)
+      data
+    end
+
+    # List services discovered from ingested events
+    # @param organization_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Service>, Integer, Hash)>] Array<Service> data, response status code and response headers
+    def list_services_with_http_info(organization_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.list_services ...'
+      end
+      # verify the required parameter 'organization_id' is set
+      if @api_client.config.client_side_validation && organization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'organization_id' when calling EventsApi.list_services"
+      end
+      # resource path
+      local_var_path = '/organizations/{organizationId}/services'.sub('{organizationId}', CGI.escape(organization_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<Service>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.list_services",
+        :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: EventsApi#list_services\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search events with a validated Boolean filter tree
+    # @param organization_id [String] 
+    # @param search_events_input [SearchEventsInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [EventPage]
+    def search_events(organization_id, search_events_input, opts = {})
+      data, _status_code, _headers = search_events_with_http_info(organization_id, search_events_input, opts)
+      data
+    end
+
+    # Search events with a validated Boolean filter tree
+    # @param organization_id [String] 
+    # @param search_events_input [SearchEventsInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EventPage, Integer, Hash)>] EventPage data, response status code and response headers
+    def search_events_with_http_info(organization_id, search_events_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.search_events ...'
+      end
+      # verify the required parameter 'organization_id' is set
+      if @api_client.config.client_side_validation && organization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'organization_id' when calling EventsApi.search_events"
+      end
+      # verify the required parameter 'search_events_input' is set
+      if @api_client.config.client_side_validation && search_events_input.nil?
+        fail ArgumentError, "Missing the required parameter 'search_events_input' when calling EventsApi.search_events"
+      end
+      # resource path
+      local_var_path = '/organizations/{organizationId}/events/search'.sub('{organizationId}', CGI.escape(organization_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']
+      # 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(search_events_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EventPage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.search_events",
+        :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: EventsApi#search_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send an event using an application ingestion key
+    # @param send_event_input [SendEventInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [IngestionResult]
+    def send_event(send_event_input, opts = {})
+      data, _status_code, _headers = send_event_with_http_info(send_event_input, opts)
+      data
+    end
+
+    # Send an event using an application ingestion key
+    # @param send_event_input [SendEventInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IngestionResult, Integer, Hash)>] IngestionResult data, response status code and response headers
+    def send_event_with_http_info(send_event_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.send_event ...'
+      end
+      # verify the required parameter 'send_event_input' is set
+      if @api_client.config.client_side_validation && send_event_input.nil?
+        fail ArgumentError, "Missing the required parameter 'send_event_input' when calling EventsApi.send_event"
+      end
+      # resource path
+      local_var_path = '/events'
+
+      # 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(send_event_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IngestionResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OrganizationApiKey']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.send_event",
+        :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: EventsApi#send_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send an event as an authenticated user or agent
+    # @param organization_id [String] 
+    # @param send_event_input [SendEventInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [IngestionResult]
+    def send_event_as_user(organization_id, send_event_input, opts = {})
+      data, _status_code, _headers = send_event_as_user_with_http_info(organization_id, send_event_input, opts)
+      data
+    end
+
+    # Send an event as an authenticated user or agent
+    # @param organization_id [String] 
+    # @param send_event_input [SendEventInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IngestionResult, Integer, Hash)>] IngestionResult data, response status code and response headers
+    def send_event_as_user_with_http_info(organization_id, send_event_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.send_event_as_user ...'
+      end
+      # verify the required parameter 'organization_id' is set
+      if @api_client.config.client_side_validation && organization_id.nil?
+        fail ArgumentError, "Missing the required parameter 'organization_id' when calling EventsApi.send_event_as_user"
+      end
+      # verify the required parameter 'send_event_input' is set
+      if @api_client.config.client_side_validation && send_event_input.nil?
+        fail ArgumentError, "Missing the required parameter 'send_event_input' when calling EventsApi.send_event_as_user"
+      end
+      # resource path
+      local_var_path = '/organizations/{organizationId}/events'.sub('{organizationId}', CGI.escape(organization_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']
+      # 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(send_event_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IngestionResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserOrAgent']
+
+      new_options = opts.merge(
+        :operation => :"EventsApi.send_event_as_user",
+        :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: EventsApi#send_event_as_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/agent_push_kit/api/health_api.rb

@@ -0,0 +1,77 @@
+=begin
+#Agent Push Kit API
+
+#The complete Agent Push Kit REST API. Application event ingestion uses an organization key beginning with `apk_`. Authenticated user operations accept either an Agent Push Kit login JWT or an agent access token beginning with `apt_`.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module AgentPushKit
+  class HealthApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Check Agent Push Kit API health
+    # @param [Hash] opts the optional parameters
+    # @return [HealthResponse]
+    def get_health(opts = {})
+      data, _status_code, _headers = get_health_with_http_info(opts)
+      data
+    end
+
+    # Check Agent Push Kit API health
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(HealthResponse, Integer, Hash)>] HealthResponse data, response status code and response headers
+    def get_health_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HealthApi.get_health ...'
+      end
+      # resource path
+      local_var_path = '/health'
+
+      # 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] || 'HealthResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"HealthApi.get_health",
+        :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: HealthApi#get_health\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end