censys 1.0.36

data/docs/CollectionsApi.md

@@ -0,0 +1,636 @@
+# CensysApi::CollectionsApi
+
+All URIs are relative to *https://api.platform.censys.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v3_collections_crud_create**](CollectionsApi.md#v3_collections_crud_create) | **POST** /v3/collections | Create a collection |
+| [**v3_collections_crud_delete**](CollectionsApi.md#v3_collections_crud_delete) | **DELETE** /v3/collections/{collection_uid} | Delete a collection |
+| [**v3_collections_crud_get**](CollectionsApi.md#v3_collections_crud_get) | **GET** /v3/collections/{collection_uid} | Get a collection |
+| [**v3_collections_crud_list**](CollectionsApi.md#v3_collections_crud_list) | **GET** /v3/collections | List collections |
+| [**v3_collections_crud_update**](CollectionsApi.md#v3_collections_crud_update) | **PUT** /v3/collections/{collection_uid} | Update a collection |
+| [**v3_collections_list_events**](CollectionsApi.md#v3_collections_list_events) | **GET** /v3/collections/{collection_uid}/events | Get a collection's events |
+| [**v3_collections_search_aggregate**](CollectionsApi.md#v3_collections_search_aggregate) | **POST** /v3/collections/{collection_uid}/search/aggregate | Aggregate results for a search query within a collection |
+| [**v3_collections_search_query**](CollectionsApi.md#v3_collections_search_query) | **POST** /v3/collections/{collection_uid}/search/query | Run a search query within a collection |
+
+
+## v3_collections_crud_create
+
+> <ResponseEnvelopeCollection> v3_collections_crud_create(organization_id, opts)
+
+Create a collection
+
+Create a new collection.
+
+### Examples
+
+```ruby
+require 'time'
+require 'censys'
+# setup authorization
+CensysApi.configure do |config|
+  # Configure Bearer authorization: PersonalAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = CensysApi::CollectionsApi.new
+organization_id = '11111111-2222-3333-4444-555555555555' # 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.
+opts = {
+  x_organization_id: '11111111-2222-3333-4444-555555555555', # 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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+  crud_create_input_body: CensysApi::CrudCreateInputBody.new({name: 'name_example', query: 'query_example'}) # CrudCreateInputBody | 
+}
+
+begin
+  # Create a collection
+  result = api_instance.v3_collections_crud_create(organization_id, opts)
+  p result
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_create: #{e}"
+end
+```
+
+#### Using the v3_collections_crud_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEnvelopeCollection>, Integer, Hash)> v3_collections_crud_create_with_http_info(organization_id, opts)
+
+```ruby
+begin
+  # Create a collection
+  data, status_code, headers = api_instance.v3_collections_crud_create_with_http_info(organization_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEnvelopeCollection>
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **x_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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead. | [optional] |
+| **crud_create_input_body** | [**CrudCreateInputBody**](CrudCreateInputBody.md) |  | [optional] |
+
+### Return type
+
+[**ResponseEnvelopeCollection**](ResponseEnvelopeCollection.md)
+
+### Authorization
+
+[PersonalAccessToken](../README.md#PersonalAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## v3_collections_crud_delete
+
+> v3_collections_crud_delete(organization_id, collection_uid, opts)
+
+Delete a collection
+
+Delete a collection.
+
+### Examples
+
+```ruby
+require 'time'
+require 'censys'
+# setup authorization
+CensysApi.configure do |config|
+  # Configure Bearer authorization: PersonalAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = CensysApi::CollectionsApi.new
+organization_id = '11111111-2222-3333-4444-555555555555' # 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.
+collection_uid = '11111111-2222-3333-4444-555555555555' # 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.
+opts = {
+  x_organization_id: '11111111-2222-3333-4444-555555555555' # 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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+}
+
+begin
+  # Delete a collection
+  api_instance.v3_collections_crud_delete(organization_id, collection_uid, opts)
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_delete: #{e}"
+end
+```
+
+#### Using the v3_collections_crud_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> v3_collections_crud_delete_with_http_info(organization_id, collection_uid, opts)
+
+```ruby
+begin
+  # Delete a collection
+  data, status_code, headers = api_instance.v3_collections_crud_delete_with_http_info(organization_id, collection_uid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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. |  |
+| **x_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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead. | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[PersonalAccessToken](../README.md#PersonalAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## v3_collections_crud_get
+
+> <ResponseEnvelopeCollection> v3_collections_crud_get(organization_id, collection_uid, opts)
+
+Get a collection
+
+Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
+
+### Examples
+
+```ruby
+require 'time'
+require 'censys'
+# setup authorization
+CensysApi.configure do |config|
+  # Configure Bearer authorization: PersonalAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = CensysApi::CollectionsApi.new
+organization_id = '11111111-2222-3333-4444-555555555555' # 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.
+collection_uid = '11111111-2222-3333-4444-555555555555' # 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.
+opts = {
+  x_organization_id: '11111111-2222-3333-4444-555555555555' # 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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+}
+
+begin
+  # Get a collection
+  result = api_instance.v3_collections_crud_get(organization_id, collection_uid, opts)
+  p result
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_get: #{e}"
+end
+```
+
+#### Using the v3_collections_crud_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEnvelopeCollection>, Integer, Hash)> v3_collections_crud_get_with_http_info(organization_id, collection_uid, opts)
+
+```ruby
+begin
+  # Get a collection
+  data, status_code, headers = api_instance.v3_collections_crud_get_with_http_info(organization_id, collection_uid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEnvelopeCollection>
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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. |  |
+| **x_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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead. | [optional] |
+
+### Return type
+
+[**ResponseEnvelopeCollection**](ResponseEnvelopeCollection.md)
+
+### Authorization
+
+[PersonalAccessToken](../README.md#PersonalAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v3_collections_crud_list
+
+> <ResponseEnvelopeListCollectionsResponseV1> v3_collections_crud_list(organization_id, opts)
+
+List collections
+
+List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
+
+### Examples
+
+```ruby
+require 'time'
+require 'censys'
+# setup authorization
+CensysApi.configure do |config|
+  # Configure Bearer authorization: PersonalAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = CensysApi::CollectionsApi.new
+organization_id = '11111111-2222-3333-4444-555555555555' # 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.
+opts = {
+  x_organization_id: '11111111-2222-3333-4444-555555555555', # 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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+  page_token: 'page_token_example', # String | page token for the requested page of collection results
+  page_size: 1 # Integer | amount of results to return per page
+}
+
+begin
+  # List collections
+  result = api_instance.v3_collections_crud_list(organization_id, opts)
+  p result
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_list: #{e}"
+end
+```
+
+#### Using the v3_collections_crud_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEnvelopeListCollectionsResponseV1>, Integer, Hash)> v3_collections_crud_list_with_http_info(organization_id, opts)
+
+```ruby
+begin
+  # List collections
+  data, status_code, headers = api_instance.v3_collections_crud_list_with_http_info(organization_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEnvelopeListCollectionsResponseV1>
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **x_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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead. | [optional] |
+| **page_token** | **String** | page token for the requested page of collection results | [optional] |
+| **page_size** | **Integer** | amount of results to return per page | [optional] |
+
+### Return type
+
+[**ResponseEnvelopeListCollectionsResponseV1**](ResponseEnvelopeListCollectionsResponseV1.md)
+
+### Authorization
+
+[PersonalAccessToken](../README.md#PersonalAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v3_collections_crud_update
+
+> <ResponseEnvelopeCollection> v3_collections_crud_update(organization_id, collection_uid, opts)
+
+Update a collection
+
+Update a collection's name, description, and/or query.
+
+### Examples
+
+```ruby
+require 'time'
+require 'censys'
+# setup authorization
+CensysApi.configure do |config|
+  # Configure Bearer authorization: PersonalAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = CensysApi::CollectionsApi.new
+organization_id = '11111111-2222-3333-4444-555555555555' # 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.
+collection_uid = '11111111-2222-3333-4444-555555555555' # String | The UID for the collection
+opts = {
+  x_organization_id: '11111111-2222-3333-4444-555555555555', # 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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+  crud_update_input_body: CensysApi::CrudUpdateInputBody.new({name: 'name_example', query: 'query_example'}) # CrudUpdateInputBody | 
+}
+
+begin
+  # Update a collection
+  result = api_instance.v3_collections_crud_update(organization_id, collection_uid, opts)
+  p result
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_update: #{e}"
+end
+```
+
+#### Using the v3_collections_crud_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEnvelopeCollection>, Integer, Hash)> v3_collections_crud_update_with_http_info(organization_id, collection_uid, opts)
+
+```ruby
+begin
+  # Update a collection
+  data, status_code, headers = api_instance.v3_collections_crud_update_with_http_info(organization_id, collection_uid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEnvelopeCollection>
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_crud_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **collection_uid** | **String** | The UID for the collection |  |
+| **x_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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead. | [optional] |
+| **crud_update_input_body** | [**CrudUpdateInputBody**](CrudUpdateInputBody.md) |  | [optional] |
+
+### Return type
+
+[**ResponseEnvelopeCollection**](ResponseEnvelopeCollection.md)
+
+### Authorization
+
+[PersonalAccessToken](../README.md#PersonalAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## v3_collections_list_events
+
+> <ResponseEnvelopeCollectionEventsResponse> v3_collections_list_events(organization_id, collection_uid, opts)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'censys'
+# setup authorization
+CensysApi.configure do |config|
+  # Configure Bearer authorization: PersonalAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = CensysApi::CollectionsApi.new
+organization_id = '11111111-2222-3333-4444-555555555555' # 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.
+collection_uid = '11111111-2222-3333-4444-555555555555' # 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.
+opts = {
+  x_organization_id: '11111111-2222-3333-4444-555555555555', # 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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+  page_size: 1, # Integer | Amount of results to return per page.
+  page_token: 'page_token_example', # String | Page token for the requested page of collection results.
+  change_types: ['asset'], # Array<String> | Change types
+  asset_change_types: ['added'], # Array<String> | Asset change types
+  status_change_types: ['active'], # Array<String> | Status change types
+  start_time: Time.parse('2025-01-01T00:00:00Z'), # Time | Start time of the host timeline
+  end_time: Time.parse('2025-01-02T00:00:00Z') # Time | End time of the host timeline
+}
+
+begin
+  # Get a collection's events
+  result = api_instance.v3_collections_list_events(organization_id, collection_uid, opts)
+  p result
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_list_events: #{e}"
+end
+```
+
+#### Using the v3_collections_list_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEnvelopeCollectionEventsResponse>, Integer, Hash)> v3_collections_list_events_with_http_info(organization_id, collection_uid, opts)
+
+```ruby
+begin
+  # Get a collection's events
+  data, status_code, headers = api_instance.v3_collections_list_events_with_http_info(organization_id, collection_uid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEnvelopeCollectionEventsResponse>
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_list_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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. |  |
+| **x_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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead. | [optional] |
+| **page_size** | **Integer** | Amount of results to return per page. | [optional] |
+| **page_token** | **String** | Page token for the requested page of collection results. | [optional] |
+| **change_types** | [**Array&lt;String&gt;**](String.md) | Change types | [optional] |
+| **asset_change_types** | [**Array&lt;String&gt;**](String.md) | Asset change types | [optional] |
+| **status_change_types** | [**Array&lt;String&gt;**](String.md) | Status change types | [optional] |
+| **start_time** | **Time** | Start time of the host timeline | [optional] |
+| **end_time** | **Time** | End time of the host timeline | [optional] |
+
+### Return type
+
+[**ResponseEnvelopeCollectionEventsResponse**](ResponseEnvelopeCollectionEventsResponse.md)
+
+### Authorization
+
+[PersonalAccessToken](../README.md#PersonalAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v3_collections_search_aggregate
+
+> <ResponseEnvelopeSearchAggregateResponse> v3_collections_search_aggregate(organization_id, collection_uid, search_aggregate_input_body, opts)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'censys'
+# setup authorization
+CensysApi.configure do |config|
+  # Configure Bearer authorization: PersonalAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = CensysApi::CollectionsApi.new
+organization_id = '11111111-2222-3333-4444-555555555555' # 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.
+collection_uid = '11111111-2222-3333-4444-555555555555' # 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.
+search_aggregate_input_body = CensysApi::SearchAggregateInputBody.new({field: 'field_example', number_of_buckets: 3.56, query: 'query_example'}) # SearchAggregateInputBody | 
+opts = {
+  x_organization_id: '11111111-2222-3333-4444-555555555555' # 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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+}
+
+begin
+  # Aggregate results for a search query within a collection
+  result = api_instance.v3_collections_search_aggregate(organization_id, collection_uid, search_aggregate_input_body, opts)
+  p result
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_search_aggregate: #{e}"
+end
+```
+
+#### Using the v3_collections_search_aggregate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEnvelopeSearchAggregateResponse>, Integer, Hash)> v3_collections_search_aggregate_with_http_info(organization_id, collection_uid, search_aggregate_input_body, opts)
+
+```ruby
+begin
+  # Aggregate results for a search query within a collection
+  data, status_code, headers = api_instance.v3_collections_search_aggregate_with_http_info(organization_id, collection_uid, search_aggregate_input_body, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEnvelopeSearchAggregateResponse>
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_search_aggregate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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. |  |
+| **search_aggregate_input_body** | [**SearchAggregateInputBody**](SearchAggregateInputBody.md) |  |  |
+| **x_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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead. | [optional] |
+
+### Return type
+
+[**ResponseEnvelopeSearchAggregateResponse**](ResponseEnvelopeSearchAggregateResponse.md)
+
+### Authorization
+
+[PersonalAccessToken](../README.md#PersonalAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## v3_collections_search_query
+
+> <ResponseEnvelopeSearchQueryResponse> v3_collections_search_query(organization_id, collection_uid, search_query_input_body, opts)
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'censys'
+# setup authorization
+CensysApi.configure do |config|
+  # Configure Bearer authorization: PersonalAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = CensysApi::CollectionsApi.new
+organization_id = '11111111-2222-3333-4444-555555555555' # 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.
+collection_uid = 'collection_uid_example' # String | The UID for the collection
+search_query_input_body = CensysApi::SearchQueryInputBody.new({query: 'query_example'}) # SearchQueryInputBody | 
+opts = {
+  x_organization_id: '11111111-2222-3333-4444-555555555555' # 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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead.
+}
+
+begin
+  # Run a search query within a collection
+  result = api_instance.v3_collections_search_query(organization_id, collection_uid, search_query_input_body, opts)
+  p result
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_search_query: #{e}"
+end
+```
+
+#### Using the v3_collections_search_query_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseEnvelopeSearchQueryResponse>, Integer, Hash)> v3_collections_search_query_with_http_info(organization_id, collection_uid, search_query_input_body, opts)
+
+```ruby
+begin
+  # Run a search query within a collection
+  data, status_code, headers = api_instance.v3_collections_search_query_with_http_info(organization_id, collection_uid, search_query_input_body, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseEnvelopeSearchQueryResponse>
+rescue CensysApi::ApiError => e
+  puts "Error when calling CollectionsApi->v3_collections_search_query_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **collection_uid** | **String** | The UID for the collection |  |
+| **search_query_input_body** | [**SearchQueryInputBody**](SearchQueryInputBody.md) |  |  |
+| **x_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. Note: The header parameter is supported for atypical use cases; we recommend always providing this field in the query parameter instead. | [optional] |
+
+### Return type
+
+[**ResponseEnvelopeSearchQueryResponse**](ResponseEnvelopeSearchQueryResponse.md)
+
+### Authorization
+
+[PersonalAccessToken](../README.md#PersonalAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+

data/docs/Connection.md

@@ -0,0 +1,34 @@
+# CensysApi::Connection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ahs_length** | **Integer** |  | [optional] |
+| **cmd_seq** | **Integer** |  | [optional] |
+| **isid** | **Integer** |  | [optional] |
+| **keyval_pairs** | **Array<String>** |  | [optional] |
+| **max_new_cmds** | **Integer** |  | [optional] |
+| **status_seq** | **Integer** |  | [optional] |
+| **tsih** | **Integer** |  | [optional] |
+| **version_active** | **Integer** |  | [optional] |
+| **version_max** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'censys'
+
+instance = CensysApi::Connection.new(
+  ahs_length: null,
+  cmd_seq: null,
+  isid: null,
+  keyval_pairs: null,
+  max_new_cmds: null,
+  status_seq: null,
+  tsih: null,
+  version_active: null,
+  version_max: null
+)
+```
+