feat(sdk): swagger updates for 2024-01-26 release (#28)

Latest swagger updates from end of January
CrowdStrike · Feb 16, 2024 · 58b7df7 · 58b7df7
1 parent 90e339e
commit 58b7df7
Show file tree

Hide file tree

Showing 1,342 changed files with 163,599 additions and 2,735 deletions.
diff --git a/.openapi-generator/VERSION b/.openapi-generator/VERSION
@@ -1 +1 @@
-6.6.0
+7.1.0
diff --git a/README.md b/README.md
diff --git a/docs/AlertsApi.md b/docs/AlertsApi.md
diff --git a/docs/AlertsContainerAlertsCountValue.md b/docs/AlertsContainerAlertsCountValue.md
@@ -0,0 +1,22 @@
+# Falcon::AlertsContainerAlertsCountValue
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resources** | [**Array&lt;CommonCountAsResource&gt;**](CommonCountAsResource.md) | | |
+| **errors** | [**Array&lt;MsaspecError&gt;**](MsaspecError.md) | | [optional] |
+| **meta** | [**MsaspecMetaInfo**](MsaspecMetaInfo.md) | | |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::AlertsContainerAlertsCountValue.new(
+ resources: null,
+ errors: null,
+ meta: null
+)
+```
+
diff --git a/docs/AlertsContainerAlertsEntityResponse.md b/docs/AlertsContainerAlertsEntityResponse.md
@@ -0,0 +1,22 @@
+# Falcon::AlertsContainerAlertsEntityResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array&lt;MsaspecError&gt;**](MsaspecError.md) | | [optional] |
+| **meta** | [**MsaspecMetaInfo**](MsaspecMetaInfo.md) | | |
+| **resources** | [**Array&lt;ModelsAPIContainerAlert&gt;**](ModelsAPIContainerAlert.md) | | |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::AlertsContainerAlertsEntityResponse.new(
+ errors: null,
+ meta: null,
+ resources: null
+)
+```
+
diff --git a/docs/ApiDetectsQueryMeta.md b/docs/ApiDetectsQueryMeta.md
@@ -0,0 +1,24 @@
+# Falcon::ApiDetectsQueryMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pagination** | [**ApiDetectsQueryPaging**](ApiDetectsQueryPaging.md) | | [optional] |
+| **powered_by** | **String** | | [optional] |
+| **query_time** | **Float** | | |
+| **trace_id** | **String** | | |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiDetectsQueryMeta.new(
+ pagination: null,
+ powered_by: null,
+ query_time: null,
+ trace_id: null
+)
+```
+
diff --git a/docs/ApiDetectsQueryPaging.md b/docs/ApiDetectsQueryPaging.md
@@ -0,0 +1,22 @@
+# Falcon::ApiDetectsQueryPaging
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **after** | **String** | | [optional] |
+| **limit** | **Integer** | | |
+| **offset** | **String** | | [optional] |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiDetectsQueryPaging.new(
+ after: null,
+ limit: null,
+ offset: null
+)
+```
+
diff --git a/docs/ApiDeviceCountRespV1.md b/docs/ApiDeviceCountRespV1.md
@@ -0,0 +1,22 @@
+# Falcon::ApiDeviceCountRespV1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array&lt;MsaspecError&gt;**](MsaspecError.md) | | |
+| **meta** | [**MsaspecMetaInfo**](MsaspecMetaInfo.md) | | [optional] |
+| **resources** | [**Array&lt;ApiDeviceCountV1&gt;**](ApiDeviceCountV1.md) | | |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiDeviceCountRespV1.new(
+ errors: null,
+ meta: null,
+ resources: null
+)
+```
+
diff --git a/docs/ApiDeviceCountV1.md b/docs/ApiDeviceCountV1.md
@@ -0,0 +1,24 @@
+# Falcon::ApiDeviceCountV1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **device_count** | **Integer** | | [optional] |
+| **limit_exceeded** | **Boolean** | | [optional] |
+| **type** | **String** | | [optional] |
+| **value** | **String** | | [optional] |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiDeviceCountV1.new(
+ device_count: null,
+ limit_exceeded: null,
+ type: null,
+ value: null
+)
+```
+
diff --git a/docs/ApiDevicesRanOnRespV1.md b/docs/ApiDevicesRanOnRespV1.md
@@ -0,0 +1,22 @@
+# Falcon::ApiDevicesRanOnRespV1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array&lt;MsaspecError&gt;**](MsaspecError.md) | | |
+| **meta** | [**ApiDetectsQueryMeta**](ApiDetectsQueryMeta.md) | | [optional] |
+| **resources** | **Array&lt;String&gt;** | | |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiDevicesRanOnRespV1.new(
+ errors: null,
+ meta: null,
+ resources: null
+)
+```
+
diff --git a/docs/CommonEntitiesResponse.md → docs/ApiEntitiesResponse.md b/docs/CommonEntitiesResponse.md → docs/ApiEntitiesResponse.md
@@ -1,10 +1,10 @@
-# Falcon::CommonEntitiesResponse
+# Falcon::ApiEntitiesResponse
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **errors** | [**Array&lt;MsaspecError&gt;**](MsaspecError.md) | | |
+| **errors** | [**Array&lt;MsaspecError&gt;**](MsaspecError.md) | | [optional] |
 | **meta** | [**MsaspecMetaInfo**](MsaspecMetaInfo.md) | | |
 | **resources** | **Object** | | |
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'crimson-falcon'
 
-instance = Falcon::CommonEntitiesResponse.new(
+instance = Falcon::ApiEntitiesResponse.new(
  errors: null,
  meta: null,
  resources: null

diff --git a/docs/ApiExecutionResultsResponse.md b/docs/ApiExecutionResultsResponse.md
@@ -0,0 +1,22 @@
+# Falcon::ApiExecutionResultsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array&lt;MsaspecError&gt;**](MsaspecError.md) | | [optional] |
+| **meta** | [**MsaspecMetaInfo**](MsaspecMetaInfo.md) | | |
+| **resources** | [**Array&lt;ExecutionsExecutionResult&gt;**](ExecutionsExecutionResult.md) | | |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiExecutionResultsResponse.new(
+ errors: null,
+ meta: null,
+ resources: null
+)
+```
+
diff --git a/docs/ApiExposedDataRecordBotLocationV1.md b/docs/ApiExposedDataRecordBotLocationV1.md
@@ -0,0 +1,20 @@
+# Falcon::ApiExposedDataRecordBotLocationV1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **country** | **String** | | [optional] |
+| **zip_code** | **String** | | [optional] |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiExposedDataRecordBotLocationV1.new(
+ country: null,
+ zip_code: null
+)
+```
+
diff --git a/docs/ApiExposedDataRecordBotOperatingSystemV1.md b/docs/ApiExposedDataRecordBotOperatingSystemV1.md
@@ -0,0 +1,40 @@
+# Falcon::ApiExposedDataRecordBotOperatingSystemV1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **antivirus** | **Array&lt;String&gt;** | | [optional] |
+| **computer_name** | **String** | | [optional] |
+| **domain** | **String** | | [optional] |
+| **hardware_id** | **String** | | [optional] |
+| **installed_software** | **Array&lt;String&gt;** | | [optional] |
+| **language** | **String** | | [optional] |
+| **layouts** | **Array&lt;String&gt;** | | [optional] |
+| **os_architecture** | **String** | | [optional] |
+| **os_version** | **String** | | [optional] |
+| **timezone** | **String** | | [optional] |
+| **uac** | **String** | | [optional] |
+| **username** | **String** | | [optional] |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiExposedDataRecordBotOperatingSystemV1.new(
+ antivirus: null,
+ computer_name: null,
+ domain: null,
+ hardware_id: null,
+ installed_software: null,
+ language: null,
+ layouts: null,
+ os_architecture: null,
+ os_version: null,
+ timezone: null,
+ uac: null,
+ username: null
+)
+```
+
diff --git a/docs/ApiExposedDataRecordBotV1.md b/docs/ApiExposedDataRecordBotV1.md
@@ -0,0 +1,32 @@
+# Falcon::ApiExposedDataRecordBotV1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bot_id** | **String** | | [optional] |
+| **domain_detects** | **Array&lt;String&gt;** | | [optional] |
+| **infection_build_id** | **String** | | [optional] |
+| **infection_date** | **Time** | | [optional] |
+| **infection_path** | **String** | | [optional] |
+| **ip** | **String** | | [optional] |
+| **location** | [**ApiExposedDataRecordBotLocationV1**](ApiExposedDataRecordBotLocationV1.md) | | [optional] |
+| **operating_system** | [**ApiExposedDataRecordBotOperatingSystemV1**](ApiExposedDataRecordBotOperatingSystemV1.md) | | [optional] |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiExposedDataRecordBotV1.new(
+ bot_id: null,
+ domain_detects: null,
+ infection_build_id: null,
+ infection_date: null,
+ infection_path: null,
+ ip: null,
+ location: null,
+ operating_system: null
+)
+```
+
diff --git a/docs/ApiExposedDataRecordFinancialV1.md b/docs/ApiExposedDataRecordFinancialV1.md
@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **bank_account** | **String** | | [optional] |
-| **credit_card** | **String** | | [optional] |
-| **crypto_currency_addresses** | **Array&lt;String&gt;** | | [optional] |
+| **bank_account** | **String** | Bank Account information | [optional] |
+| **credit_card** | **String** | Credit Card information | [optional] |
+| **crypto_currency_addresses** | **Array&lt;String&gt;** | A list of Crypto Currency addresses | [optional] |
 
 ## Example
 

diff --git a/docs/ApiExposedDataRecordLocationV1.md b/docs/ApiExposedDataRecordLocationV1.md
@@ -4,12 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **city** | **String** | | [optional] |
-| **country_code** | **String** | | [optional] |
-| **federal_admin_region** | **String** | | [optional] |
-| **federal_district** | **String** | | [optional] |
-| **postal_code** | **String** | | [optional] |
-| **state** | **String** | | [optional] |
+| **city** | **String** | City name | [optional] |
+| **country_code** | **String** | The country code | [optional] |
+| **federal_admin_region** | **String** | Federal Administrative Region | [optional] |
+| **federal_district** | **String** | Federal District | [optional] |
+| **postal_code** | **String** | The postal code | [optional] |
+| **state** | **String** | State name | [optional] |
 
 ## Example
 

diff --git a/docs/ApiExposedDataRecordSocialV1.md b/docs/ApiExposedDataRecordSocialV1.md
@@ -4,15 +4,15 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **aim_id** | **String** | | [optional] |
-| **facebook_id** | **String** | | [optional] |
-| **icq_id** | **String** | | [optional] |
-| **instagram_id** | **String** | | [optional] |
-| **msn_id** | **String** | | [optional] |
-| **skype_id** | **String** | | [optional] |
-| **twitter_id** | **String** | | [optional] |
-| **vk_id** | **String** | | [optional] |
-| **vk_token** | **String** | | [optional] |
+| **aim_id** | **String** | AIM ID of the affected user | [optional] |
+| **facebook_id** | **String** | Facebook ID of the affected user | [optional] |
+| **icq_id** | **String** | ICQ ID of the affected user | [optional] |
+| **instagram_id** | **String** | Instagram ID of the affected user | [optional] |
+| **msn_id** | **String** | MSN ID of the affected user | [optional] |
+| **skype_id** | **String** | Skype ID of the affected user | [optional] |
+| **twitter_id** | **String** | Twitter ID of the affected user | [optional] |
+| **vk_id** | **String** | VK ID of the affected user | [optional] |
+| **vk_token** | **String** | VK Access Token of the affected user | [optional] |
 
 ## Example
 

diff --git a/docs/ApiMetaInfo.md b/docs/ApiMetaInfo.md
@@ -0,0 +1,24 @@
+# Falcon::ApiMetaInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pagination** | [**ApiResponsePagination**](ApiResponsePagination.md) | | [optional] |
+| **powered_by** | **String** | The alias of the service which handled the request | [optional] |
+| **query_time** | **Float** | The duration (in seconds) that the service took to handle the request | |
+| **trace_id** | **String** | Identifier used to debug the request | |
+
+## Example
+
+```ruby
+require 'crimson-falcon'
+
+instance = Falcon::ApiMetaInfo.new(
+ pagination: null,
+ powered_by: null,
+ query_time: null,
+ trace_id: null
+)
+```
+