censys 1.0.36

data/spec/api/collections_api_spec.rb

@@ -0,0 +1,158 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for CensysApi::CollectionsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'CollectionsApi' do
+  before do
+    # run before each test
+    @api_instance = CensysApi::CollectionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CollectionsApi' do
+    it 'should create an instance of CollectionsApi' do
+      expect(@api_instance).to be_instance_of(CensysApi::CollectionsApi)
+    end
+  end
+
+  # unit tests for v3_collections_crud_create
+  # Create a collection
+  # Create a new collection.
+  # @param 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.
+  # @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]
+  describe 'v3_collections_crud_create test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_collections_crud_delete
+  # Delete a collection
+  # Delete a collection.
+  # @param 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.
+  # @param collection_uid 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]
+  describe 'v3_collections_crud_delete test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_collections_crud_get
+  # Get a collection
+  # Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
+  # @param 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.
+  # @param collection_uid 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]
+  describe 'v3_collections_crud_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_collections_crud_list
+  # List collections
+  # List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
+  # @param 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.
+  # @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]
+  describe 'v3_collections_crud_list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_collections_crud_update
+  # Update a collection
+  # Update a collection's name, description, and/or query.
+  # @param 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.
+  # @param collection_uid 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]
+  describe 'v3_collections_crud_update test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_collections_list_events
+  # 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 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 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]
+  describe 'v3_collections_list_events test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_collections_search_aggregate
+  # 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 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 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 
+  # @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]
+  describe 'v3_collections_search_aggregate test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_collections_search_query
+  # 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 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 The UID for the collection
+  # @param search_query_input_body 
+  # @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]
+  describe 'v3_collections_search_query test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/global_data_api_spec.rb

@@ -0,0 +1,291 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for CensysApi::GlobalDataApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'GlobalDataApi' do
+  before do
+    # run before each test
+    @api_instance = CensysApi::GlobalDataApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of GlobalDataApi' do
+    it 'should create an instance of GlobalDataApi' do
+      expect(@api_instance).to be_instance_of(CensysApi::GlobalDataApi)
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_certificate
+  # Get a certificate
+  # Retrieve information about a single certificate. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
+  # @param 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.
+  # @param certificate_id The SHA-256 certificate fingerprint.
+  # @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 [ResponseEnvelopeCertificateAsset]
+  describe 'v3_globaldata_asset_certificate test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_certificate_list
+  # Retrieve multiple certificates
+  # Retrieve information about multiple certificates. A certificate ID is its SHA-256 fingerprint in the Censys dataset.<br><br>The GET method of this endpoint is deprecated, but will continue to be supported for backwards compatibility. Please use the [POST variant](https://docs.censys.com/reference/v3-globaldata-asset-certificate-list-post#/) of this endpoint instead.
+  # @param 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.
+  # @param certificate_ids A list of SHA-256 certificate fingerprints.
+  # @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 [ResponseEnvelopeListCertificateAsset]
+  describe 'v3_globaldata_asset_certificate_list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_certificate_list_post
+  # Retrieve multiple certificates
+  # Retrieve information about multiple certificates. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
+  # @param 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.
+  # @param asset_certificate_list_input_body 
+  # @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 [ResponseEnvelopeListCertificateAsset]
+  describe 'v3_globaldata_asset_certificate_list_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_certificate_list_raw
+  # Retrieve multiple certificates in PEM format
+  # Retrieve the raw PEM-encoded format for multiple certificates. A certificate ID is its SHA-256 fingerprint in the Censys dataset.<br><br>The GET method of this endpoint is deprecated, but will continue to be supported for backwards compatibility. Please use the [POST variant](https://docs.censys.com/reference/v3-globaldata-asset-certificate-list-raw-post#/) of this endpoint instead.
+  # @param 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.
+  # @param certificate_ids A list of SHA-256 certificate fingerprints.
+  # @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 [ResponseEnvelopeListRawCertificateResponse]
+  describe 'v3_globaldata_asset_certificate_list_raw test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_certificate_list_raw_post
+  # Retrieve multiple certificates in PEM format
+  # Retrieve the raw PEM-encoded format for multiple certificates. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
+  # @param 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.
+  # @param asset_certificate_list_input_body 
+  # @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 [ResponseEnvelopeListRawCertificateResponse]
+  describe 'v3_globaldata_asset_certificate_list_raw_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_certificate_raw
+  # Get a certificate in PEM format
+  # Retrieve the raw PEM-encoded format of a certificate. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
+  # @param 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.
+  # @param certificate_id The SHA-256 certificate fingerprint.
+  # @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 [File]
+  describe 'v3_globaldata_asset_certificate_raw test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_host
+  # Get a host
+  # Retrieve information about a single host. A host ID is its IP address.
+  # @param 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.
+  # @param host_id The IP address of a host.
+  # @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 [Time] :at_time RFC3339 Timestamp to view a host at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time.
+  # @return [ResponseEnvelopeHostAsset]
+  describe 'v3_globaldata_asset_host test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_host_list
+  # Retrieve multiple hosts
+  # Retrieve information about multiple hosts. A host ID is its IP address.<br><br>The GET method of this endpoint is deprecated, but will continue to be supported for backwards compatibility. Please use the [POST variant](https://docs.censys.com/reference/v3-globaldata-asset-host-list-post#/) of this endpoint instead.
+  # @param 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.
+  # @param host_ids A list of host IP addresses.
+  # @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 [ResponseEnvelopeListHostAsset]
+  describe 'v3_globaldata_asset_host_list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_host_list_post
+  # Retrieve multiple hosts
+  # Retrieve information about multiple hosts. A host ID is its IP address.
+  # @param 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.
+  # @param asset_host_list_input_body 
+  # @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 [ResponseEnvelopeListHostAsset]
+  describe 'v3_globaldata_asset_host_list_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_host_timeline
+  # Get host event history
+  # Retrieve event history for a host. A host ID is its IP address.<br><br>Note that when a service protocol changes after a new scan (for example, from `UNKNOWN` to `NETBIOS`), this information will only be reflected in the `scan` object. It will not be shown in the `service_scanned diff` object.
+  # @param 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.
+  # @param host_id The IP address of a host.
+  # @param start_time Start time of the host timeline. Equivalent to the To field in the event history UI. This must be the timestamp closest to the current time. For example, if you want events from January 1, 2025 to the start of January 2, 2025, input the January 2 timestamp here. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time.
+  # @param end_time End time of the host timeline. Equivalent to the From field in the event history UI. This must be the timestamp furthest from the current time. For example, if you want events from January 1, 2025 to the start of January 2, 2025, input the January 1 timestamp here. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time.
+  # @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 [ResponseEnvelopeHostTimeline]
+  describe 'v3_globaldata_asset_host_timeline test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_webproperty
+  # Get a web property
+  # Retrieve information about a single web property. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80`.
+  # @param 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.
+  # @param webproperty_id A web property identifier.
+  # @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 [Time] :at_time RFC3339 Timestamp to view a webproperty at a specific point in time. Must be a valid RFC3339 string. Ensure that you suffix the date with T00:00:00Z or a specific time
+  # @return [ResponseEnvelopeWebpropertyAsset]
+  describe 'v3_globaldata_asset_webproperty test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_webproperty_list
+  # Retrieve multiple web properties
+  # Retrieve information about multiple web properties. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80`.<br><br>The GET method of this endpoint is deprecated, but will continue to be supported for backwards compatibility. Please use the [POST variant](https://docs.censys.com/reference/v3-globaldata-asset-webproperty-list-post#/) of this endpoint instead.
+  # @param 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.
+  # @param webproperty_ids A list of web property identifiers.
+  # @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 [ResponseEnvelopeListWebpropertyAsset]
+  describe 'v3_globaldata_asset_webproperty_list test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_asset_webproperty_list_post
+  # Retrieve multiple web properties
+  # Retrieve information about multiple web properties. Web properties are identified using a combination of a hostname and port joined with a colon, such as `platform.censys.io:80`.
+  # @param 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.
+  # @param asset_webproperty_list_input_body 
+  # @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 [ResponseEnvelopeListWebpropertyAsset]
+  describe 'v3_globaldata_asset_webproperty_list_post test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_scans_get
+  # Get scan status
+  # Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. This endpoint does not cost any credits to execute.
+  # @param 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.
+  # @param scan_id The unique identifier of the tracked scan
+  # @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 [ResponseEnvelopeTrackedScan]
+  describe 'v3_globaldata_scans_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_scans_rescan
+  # Live Rescan: Initiate a new rescan
+  # Initiate a rescan for a known host service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Rescan](https://docs.censys.com/docs/platform-live-rescan#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-globaldata-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. It costs 10 credits to execute.
+  # @param 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.
+  # @param scans_rescan_input_body 
+  # @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 [ResponseEnvelopeTrackedScan]
+  describe 'v3_globaldata_scans_rescan test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_search_aggregate
+  # Aggregate results for a search query
+  # Aggregate results for a Platform search query. This functionality is equivalent to the [Report Builder](https://docs.censys.com/docs/platform-report-builder#/) in the Platform web UI.
+  # @param 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.
+  # @param search_aggregate_input_body 
+  # @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]
+  describe 'v3_globaldata_search_aggregate test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_search_convert
+  # Convert Legacy Search queries to Platform queries
+  # Convert Censys Search Language queries used in Legacy Search into Censys Query Language (CenQL) queries for use in the Platform.<br><br>Reference the [documentation on CenQL](https://docs.censys.com/docs/censys-query-language) for more information about query syntax.
+  # @param 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.
+  # @param search_convert_query_input_body 
+  # @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 [ResponseEnvelopeListSearchConvertQueryResponse]
+  describe 'v3_globaldata_search_convert test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_globaldata_search_query
+  # Run a search query
+  # Run a search query across Censys data. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax.
+  # @param 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.
+  # @param search_query_input_body 
+  # @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]
+  describe 'v3_globaldata_search_query test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/threat_hunting_api_spec.rb

@@ -0,0 +1,97 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for CensysApi::ThreatHuntingApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ThreatHuntingApi' do
+  before do
+    # run before each test
+    @api_instance = CensysApi::ThreatHuntingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ThreatHuntingApi' do
+    it 'should create an instance of ThreatHuntingApi' do
+      expect(@api_instance).to be_instance_of(CensysApi::ThreatHuntingApi)
+    end
+  end
+
+  # unit tests for v3_threathunting_get_host_observations_with_certificate
+  # Get host history for a certificate
+  # Retrieve the historical observations of hosts associated with a certificate. This is useful for threat hunting, detection engineering, and timeline generation. Certificate history is also visible to Threat Hunting users in the Platform UI on the [certificate timeline](https://docs.censys.com/docs/platform-threat-hunting-use-cert-history-to-build-better-detections#/).<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account. You may also filter results by port and transport protocol.<br><br>This endpoint is available to organizations that have access to the Threat Hunting module. It costs 5 credits per page of results.
+  # @param 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.
+  # @param certificate_id SHA-256 hash of the certificate
+  # @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] :start_time Only show ranges ending at or after this time (ISO 8601)
+  # @option opts [String] :end_time Only show ranges starting at or before this time (ISO 8601)
+  # @option opts [Integer] :port The port to filter by
+  # @option opts [String] :protocol The transport protocol to filter by
+  # @option opts [String] :page_token Pagination token from previous response to retrieve next page of results
+  # @option opts [Integer] :page_size Number of results per page. Maximum 100, defaults to 100 if not specified
+  # @return [ResponseEnvelopeHostObservationResponse]
+  describe 'v3_threathunting_get_host_observations_with_certificate test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_threathunting_scans_discovery
+  # Live Discovery: Initiate a new scan
+  # Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to organizations that have access to the Threat Hunting module. It costs 15 credits to execute this endpoint.
+  # @param 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.
+  # @param scans_discovery_input_body 
+  # @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 [ResponseEnvelopeTrackedScan]
+  describe 'v3_threathunting_scans_discovery test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_threathunting_scans_get
+  # Get scan status
+  # Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. This endpoint does not cost any credits to execute.
+  # @param 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.
+  # @param scan_id The unique identifier of the tracked scan
+  # @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 [ResponseEnvelopeTrackedScan]
+  describe 'v3_threathunting_scans_get test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for v3_threathunting_value_counts
+  # CensEye: Retrieve value counts to discover pivots
+  # Get counts of web assets for specific field-value pairs and combinations of field-value pairs. This is similar to the [CensEye functionality](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#/) available in the Platform web UI, but it allows you to define specific fields of interest rather than the [default fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) leveraged by the tool in the UI.<br><br>Each array can only target fields within the same nested object. For example, you can combine `host.services.port=80` and `host.services.protocol=SSH` in the same array, but you cannot combine `host.services.port=80` and `host.location.country=”United States”` in the same array. You can input multiple arrays of objects in each API call.<br><br>To use this endpoint, your organization must have access to the Threat Hunting Module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
+  # @param 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.
+  # @param search_value_counts_input_body 
+  # @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 [ResponseEnvelopeValueCountsResponse]
+  describe 'v3_threathunting_value_counts test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end