censys 1.0.36

data/lib/censys/api/collections_api.rb

@@ -0,0 +1,677 @@
+=begin
+#Censys Platform API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.36
+Contact: support@censys.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module CensysApi
+  class CollectionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a collection
+    # Create a new collection.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @option opts [CrudCreateInputBody] :crud_create_input_body 
+    # @return [ResponseEnvelopeCollection]
+    def v3_collections_crud_create(organization_id, opts = {})
+      data, _status_code, _headers = v3_collections_crud_create_with_http_info(organization_id, opts)
+      data
+    end
+
+    # Create a collection
+    # Create a new collection.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @option opts [CrudCreateInputBody] :crud_create_input_body 
+    # @return [Array<(ResponseEnvelopeCollection, Integer, Hash)>] ResponseEnvelopeCollection data, response status code and response headers
+    def v3_collections_crud_create_with_http_info(organization_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CollectionsApi.v3_collections_crud_create ...'
+      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 CollectionsApi.v3_collections_crud_create"
+      end
+      # resource path
+      local_var_path = '/v3/collections'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'organization_id'] = organization_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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
+      header_params[:'X-Organization-ID'] = opts[:'x_organization_id'] if !opts[:'x_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'crud_create_input_body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResponseEnvelopeCollection'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PersonalAccessToken']
+
+      new_options = opts.merge(
+        :operation => :"CollectionsApi.v3_collections_crud_create",
+        :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: CollectionsApi#v3_collections_crud_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a collection
+    # Delete a collection.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @return [nil]
+    def v3_collections_crud_delete(organization_id, collection_uid, opts = {})
+      v3_collections_crud_delete_with_http_info(organization_id, collection_uid, opts)
+      nil
+    end
+
+    # Delete a collection
+    # Delete a collection.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def v3_collections_crud_delete_with_http_info(organization_id, collection_uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CollectionsApi.v3_collections_crud_delete ...'
+      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 CollectionsApi.v3_collections_crud_delete"
+      end
+      # verify the required parameter 'collection_uid' is set
+      if @api_client.config.client_side_validation && collection_uid.nil?
+        fail ArgumentError, "Missing the required parameter 'collection_uid' when calling CollectionsApi.v3_collections_crud_delete"
+      end
+      # resource path
+      local_var_path = '/v3/collections/{collection_uid}'.sub('{' + 'collection_uid' + '}', CGI.escape(collection_uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'organization_id'] = organization_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/problem+json']) unless header_params['Accept']
+      header_params[:'X-Organization-ID'] = opts[:'x_organization_id'] if !opts[:'x_organization_id'].nil?
+
+      # 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] || ['PersonalAccessToken']
+
+      new_options = opts.merge(
+        :operation => :"CollectionsApi.v3_collections_crud_delete",
+        :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, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CollectionsApi#v3_collections_crud_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a collection
+    # Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @return [ResponseEnvelopeCollection]
+    def v3_collections_crud_get(organization_id, collection_uid, opts = {})
+      data, _status_code, _headers = v3_collections_crud_get_with_http_info(organization_id, collection_uid, opts)
+      data
+    end
+
+    # Get a collection
+    # Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @return [Array<(ResponseEnvelopeCollection, Integer, Hash)>] ResponseEnvelopeCollection data, response status code and response headers
+    def v3_collections_crud_get_with_http_info(organization_id, collection_uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CollectionsApi.v3_collections_crud_get ...'
+      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 CollectionsApi.v3_collections_crud_get"
+      end
+      # verify the required parameter 'collection_uid' is set
+      if @api_client.config.client_side_validation && collection_uid.nil?
+        fail ArgumentError, "Missing the required parameter 'collection_uid' when calling CollectionsApi.v3_collections_crud_get"
+      end
+      # resource path
+      local_var_path = '/v3/collections/{collection_uid}'.sub('{' + 'collection_uid' + '}', CGI.escape(collection_uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'organization_id'] = organization_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
+      header_params[:'X-Organization-ID'] = opts[:'x_organization_id'] if !opts[:'x_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResponseEnvelopeCollection'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PersonalAccessToken']
+
+      new_options = opts.merge(
+        :operation => :"CollectionsApi.v3_collections_crud_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: CollectionsApi#v3_collections_crud_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List collections
+    # List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @option opts [String] :page_token page token for the requested page of collection results
+    # @option opts [Integer] :page_size amount of results to return per page
+    # @return [ResponseEnvelopeListCollectionsResponseV1]
+    def v3_collections_crud_list(organization_id, opts = {})
+      data, _status_code, _headers = v3_collections_crud_list_with_http_info(organization_id, opts)
+      data
+    end
+
+    # List collections
+    # List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @option opts [String] :page_token page token for the requested page of collection results
+    # @option opts [Integer] :page_size amount of results to return per page
+    # @return [Array<(ResponseEnvelopeListCollectionsResponseV1, Integer, Hash)>] ResponseEnvelopeListCollectionsResponseV1 data, response status code and response headers
+    def v3_collections_crud_list_with_http_info(organization_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CollectionsApi.v3_collections_crud_list ...'
+      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 CollectionsApi.v3_collections_crud_list"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CollectionsApi.v3_collections_crud_list, must be greater than or equal to 0.'
+      end
+
+      # resource path
+      local_var_path = '/v3/collections'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'organization_id'] = organization_id
+      query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
+      header_params[:'X-Organization-ID'] = opts[:'x_organization_id'] if !opts[:'x_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResponseEnvelopeListCollectionsResponseV1'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PersonalAccessToken']
+
+      new_options = opts.merge(
+        :operation => :"CollectionsApi.v3_collections_crud_list",
+        :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: CollectionsApi#v3_collections_crud_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a collection
+    # Update a collection's name, description, and/or query.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @option opts [CrudUpdateInputBody] :crud_update_input_body 
+    # @return [ResponseEnvelopeCollection]
+    def v3_collections_crud_update(organization_id, collection_uid, opts = {})
+      data, _status_code, _headers = v3_collections_crud_update_with_http_info(organization_id, collection_uid, opts)
+      data
+    end
+
+    # Update a collection
+    # Update a collection&#39;s name, description, and/or query.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @option opts [CrudUpdateInputBody] :crud_update_input_body 
+    # @return [Array<(ResponseEnvelopeCollection, Integer, Hash)>] ResponseEnvelopeCollection data, response status code and response headers
+    def v3_collections_crud_update_with_http_info(organization_id, collection_uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CollectionsApi.v3_collections_crud_update ...'
+      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 CollectionsApi.v3_collections_crud_update"
+      end
+      # verify the required parameter 'collection_uid' is set
+      if @api_client.config.client_side_validation && collection_uid.nil?
+        fail ArgumentError, "Missing the required parameter 'collection_uid' when calling CollectionsApi.v3_collections_crud_update"
+      end
+      # resource path
+      local_var_path = '/v3/collections/{collection_uid}'.sub('{' + 'collection_uid' + '}', CGI.escape(collection_uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'organization_id'] = organization_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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
+      header_params[:'X-Organization-ID'] = opts[:'x_organization_id'] if !opts[:'x_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'crud_update_input_body'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResponseEnvelopeCollection'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PersonalAccessToken']
+
+      new_options = opts.merge(
+        :operation => :"CollectionsApi.v3_collections_crud_update",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CollectionsApi#v3_collections_crud_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a collection's events
+    # Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @option opts [Integer] :page_size Amount of results to return per page.
+    # @option opts [String] :page_token Page token for the requested page of collection results.
+    # @option opts [Array<String>] :change_types Change types
+    # @option opts [Array<String>] :asset_change_types Asset change types
+    # @option opts [Array<String>] :status_change_types Status change types
+    # @option opts [Time] :start_time Start time of the host timeline
+    # @option opts [Time] :end_time End time of the host timeline
+    # @return [ResponseEnvelopeCollectionEventsResponse]
+    def v3_collections_list_events(organization_id, collection_uid, opts = {})
+      data, _status_code, _headers = v3_collections_list_events_with_http_info(organization_id, collection_uid, opts)
+      data
+    end
+
+    # Get a collection&#39;s events
+    # Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @option opts [Integer] :page_size Amount of results to return per page.
+    # @option opts [String] :page_token Page token for the requested page of collection results.
+    # @option opts [Array<String>] :change_types Change types
+    # @option opts [Array<String>] :asset_change_types Asset change types
+    # @option opts [Array<String>] :status_change_types Status change types
+    # @option opts [Time] :start_time Start time of the host timeline
+    # @option opts [Time] :end_time End time of the host timeline
+    # @return [Array<(ResponseEnvelopeCollectionEventsResponse, Integer, Hash)>] ResponseEnvelopeCollectionEventsResponse data, response status code and response headers
+    def v3_collections_list_events_with_http_info(organization_id, collection_uid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CollectionsApi.v3_collections_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 CollectionsApi.v3_collections_list_events"
+      end
+      # verify the required parameter 'collection_uid' is set
+      if @api_client.config.client_side_validation && collection_uid.nil?
+        fail ArgumentError, "Missing the required parameter 'collection_uid' when calling CollectionsApi.v3_collections_list_events"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CollectionsApi.v3_collections_list_events, must be greater than or equal to 0.'
+      end
+
+      allowable_values = ["asset", "status"]
+      if @api_client.config.client_side_validation && opts[:'change_types'] && !opts[:'change_types'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"change_types\", must include one of #{allowable_values}"
+      end
+      allowable_values = ["added", "removed"]
+      if @api_client.config.client_side_validation && opts[:'asset_change_types'] && !opts[:'asset_change_types'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"asset_change_types\", must include one of #{allowable_values}"
+      end
+      allowable_values = ["active", "archived", "paused", "populating"]
+      if @api_client.config.client_side_validation && opts[:'status_change_types'] && !opts[:'status_change_types'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"status_change_types\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v3/collections/{collection_uid}/events'.sub('{' + 'collection_uid' + '}', CGI.escape(collection_uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'organization_id'] = organization_id
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?
+      query_params[:'change_types'] = @api_client.build_collection_param(opts[:'change_types'], :csv) if !opts[:'change_types'].nil?
+      query_params[:'asset_change_types'] = @api_client.build_collection_param(opts[:'asset_change_types'], :csv) if !opts[:'asset_change_types'].nil?
+      query_params[:'status_change_types'] = @api_client.build_collection_param(opts[:'status_change_types'], :csv) if !opts[:'status_change_types'].nil?
+      query_params[:'start_time'] = opts[:'start_time'] if !opts[:'start_time'].nil?
+      query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) unless header_params['Accept']
+      header_params[:'X-Organization-ID'] = opts[:'x_organization_id'] if !opts[:'x_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResponseEnvelopeCollectionEventsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PersonalAccessToken']
+
+      new_options = opts.merge(
+        :operation => :"CollectionsApi.v3_collections_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: CollectionsApi#v3_collections_list_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Aggregate results for a search query within a collection
+    # Aggregate results for a Platform search query that targets a collection's assets. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console.
+    # @param search_aggregate_input_body [SearchAggregateInputBody] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @return [ResponseEnvelopeSearchAggregateResponse]
+    def v3_collections_search_aggregate(organization_id, collection_uid, search_aggregate_input_body, opts = {})
+      data, _status_code, _headers = v3_collections_search_aggregate_with_http_info(organization_id, collection_uid, search_aggregate_input_body, opts)
+      data
+    end
+
+    # Aggregate results for a search query within a collection
+    # Aggregate results for a Platform search query that targets a collection&#39;s assets. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection. Obtain the collection ID using the [list collections endpoint](https://docs.censys.com/reference/v3-collections-crud-list#/) or via the collection URL when using the web console.
+    # @param search_aggregate_input_body [SearchAggregateInputBody] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @return [Array<(ResponseEnvelopeSearchAggregateResponse, Integer, Hash)>] ResponseEnvelopeSearchAggregateResponse data, response status code and response headers
+    def v3_collections_search_aggregate_with_http_info(organization_id, collection_uid, search_aggregate_input_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CollectionsApi.v3_collections_search_aggregate ...'
+      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 CollectionsApi.v3_collections_search_aggregate"
+      end
+      # verify the required parameter 'collection_uid' is set
+      if @api_client.config.client_side_validation && collection_uid.nil?
+        fail ArgumentError, "Missing the required parameter 'collection_uid' when calling CollectionsApi.v3_collections_search_aggregate"
+      end
+      # verify the required parameter 'search_aggregate_input_body' is set
+      if @api_client.config.client_side_validation && search_aggregate_input_body.nil?
+        fail ArgumentError, "Missing the required parameter 'search_aggregate_input_body' when calling CollectionsApi.v3_collections_search_aggregate"
+      end
+      # resource path
+      local_var_path = '/v3/collections/{collection_uid}/search/aggregate'.sub('{' + 'collection_uid' + '}', CGI.escape(collection_uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'organization_id'] = organization_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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
+      header_params[:'X-Organization-ID'] = opts[:'x_organization_id'] if !opts[:'x_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(search_aggregate_input_body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResponseEnvelopeSearchAggregateResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PersonalAccessToken']
+
+      new_options = opts.merge(
+        :operation => :"CollectionsApi.v3_collections_search_aggregate",
+        :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: CollectionsApi#v3_collections_search_aggregate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Run a search query within a collection
+    # Run a search query across a collection's assets. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection
+    # @param search_query_input_body [SearchQueryInputBody] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @return [ResponseEnvelopeSearchQueryResponse]
+    def v3_collections_search_query(organization_id, collection_uid, search_query_input_body, opts = {})
+      data, _status_code, _headers = v3_collections_search_query_with_http_info(organization_id, collection_uid, search_query_input_body, opts)
+      data
+    end
+
+    # Run a search query within a collection
+    # Run a search query across a collection&#39;s assets. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax.
+    # @param organization_id [String] The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+    # @param collection_uid [String] The UID for the collection
+    # @param search_query_input_body [SearchQueryInputBody] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_organization_id The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+    # @return [Array<(ResponseEnvelopeSearchQueryResponse, Integer, Hash)>] ResponseEnvelopeSearchQueryResponse data, response status code and response headers
+    def v3_collections_search_query_with_http_info(organization_id, collection_uid, search_query_input_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CollectionsApi.v3_collections_search_query ...'
+      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 CollectionsApi.v3_collections_search_query"
+      end
+      # verify the required parameter 'collection_uid' is set
+      if @api_client.config.client_side_validation && collection_uid.nil?
+        fail ArgumentError, "Missing the required parameter 'collection_uid' when calling CollectionsApi.v3_collections_search_query"
+      end
+      # verify the required parameter 'search_query_input_body' is set
+      if @api_client.config.client_side_validation && search_query_input_body.nil?
+        fail ArgumentError, "Missing the required parameter 'search_query_input_body' when calling CollectionsApi.v3_collections_search_query"
+      end
+      # resource path
+      local_var_path = '/v3/collections/{collection_uid}/search/query'.sub('{' + 'collection_uid' + '}', CGI.escape(collection_uid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'organization_id'] = organization_id
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+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
+      header_params[:'X-Organization-ID'] = opts[:'x_organization_id'] if !opts[:'x_organization_id'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(search_query_input_body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ResponseEnvelopeSearchQueryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['PersonalAccessToken']
+
+      new_options = opts.merge(
+        :operation => :"CollectionsApi.v3_collections_search_query",
+        :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: CollectionsApi#v3_collections_search_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end