Skip to content

Commit

Permalink
feat(sdk): swagger updates for 2023-08-03 release (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
carlosmmatos authored Aug 5, 2023
1 parent ca1188c commit e86ebf9
Show file tree
Hide file tree
Showing 274 changed files with 14,078 additions and 1,685 deletions.
224 changes: 128 additions & 96 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,22 @@ We appreciate your interest in our project and look forward to collaborating wit

---

**Class**: `Falcon::ConfigurationAssessmentApi`

- **Operation**: [**get_combined_assessments_query**](docs/ConfigurationAssessmentApi.md#get_combined_assessments_query)
- **GET**: /configuration-assessment/combined/assessments/v1
- **Description**: Search for assessments in your environment by providing an FQL filter and paging details. Returns a set of HostFinding entities which match the filter criteria

---

**Class**: `Falcon::ConfigurationAssessmentEvaluationLogicApi`

- **Operation**: [**get_evaluation_logic_mixin0**](docs/ConfigurationAssessmentEvaluationLogicApi.md#get_evaluation_logic_mixin0)
- **GET**: /configuration-assessment/entities/evaluation-logic/v1
- **Description**: Get details on evaluation logic items by providing one or more finding IDs.

---

**Class**: `Falcon::CspmRegistrationApi`

- **Operation**: [**azure_download_certificate**](docs/CspmRegistrationApi.md#azure_download_certificate)
Expand Down Expand Up @@ -485,7 +501,7 @@ We appreciate your interest in our project and look forward to collaborating wit

**Class**: `Falcon::CustomIoaApi`

- **Operation**: [**get_rules_mixin0_mixin65**](docs/CustomIoaApi.md#get_rules_mixin0_mixin65)
- **Operation**: [**get_rules_mixin0**](docs/CustomIoaApi.md#get_rules_mixin0)
- **GET**: /ioarules/entities/rules/v1
- **Description**: Get rules by ID and optionally with cid and/or version in the following format: `[cid:]ID[:version]`. The max number of IDs is constrained by URL size.

Expand Down Expand Up @@ -533,7 +549,7 @@ We appreciate your interest in our project and look forward to collaborating wit

**Class**: `Falcon::CustomIoaApi`

- **Operation**: [**query_rules_mixin0_mixin65**](docs/CustomIoaApi.md#query_rules_mixin0_mixin65)
- **Operation**: [**query_rules_mixin0**](docs/CustomIoaApi.md#query_rules_mixin0)
- **GET**: /ioarules/queries/rules/v1
- **Description**: Finds all rule IDs matching the query with optional filter.

Expand Down Expand Up @@ -861,38 +877,6 @@ We appreciate your interest in our project and look forward to collaborating wit

**Class**: `Falcon::DiscoverApi`

- **Operation**: [**query_active_discovery_networks**](docs/DiscoverApi.md#query_active_discovery_networks)
- **GET**: /discover/queries/active-discovery-networks/v1
- **Description**: Search for active discovery networks in your environment by providing an FQL filter and paging details. returns a set of network IDs which match the filter criteria.

---

**Class**: `Falcon::DiscoverApi`

- **Operation**: [**query_active_discovery_rules**](docs/DiscoverApi.md#query_active_discovery_rules)
- **GET**: /discover/queries/active-discovery-rules/v1
- **Description**: Search for active discovery rules in your environment by providing an FQL filter and paging details. returns a set of rule IDs which match the filter criteria.

---

**Class**: `Falcon::DiscoverApi`

- **Operation**: [**query_active_discovery_scanners**](docs/DiscoverApi.md#query_active_discovery_scanners)
- **GET**: /discover/queries/active-discovery-scanners/v1
- **Description**: Search for active discovery scanners in your environment by providing an FQL filter and paging details. returns a set of scanner IDs which match the filter criteria.

---

**Class**: `Falcon::DiscoverApi`

- **Operation**: [**query_active_discovery_scans**](docs/DiscoverApi.md#query_active_discovery_scans)
- **GET**: /discover/queries/active-discovery-scans/v1
- **Description**: Search for active discovery scans in your environment by providing an FQL filter and paging details. returns a set of scan IDs which match the filter criteria.

---

**Class**: `Falcon::DiscoverApi`

- **Operation**: [**query_applications**](docs/DiscoverApi.md#query_applications)
- **GET**: /discover/queries/applications/v1
- **Description**: Search for applications in your environment by providing an FQL filter and paging details. returns a set of application IDs which match the filter criteria.
Expand Down Expand Up @@ -1117,6 +1101,14 @@ We appreciate your interest in our project and look forward to collaborating wit

**Class**: `Falcon::FalconContainerImageApi`

- **Operation**: [**get_combined_images**](docs/FalconContainerImageApi.md#get_combined_images)
- **GET**: /container-security/combined/image-assessment/images/v1
- **Description**: Get image assessment results by providing an FQL filter and paging details

---

**Class**: `Falcon::FalconContainerImageApi`

- **Operation**: [**read_registry_entities**](docs/FalconContainerImageApi.md#read_registry_entities)
- **GET**: /container-security/queries/registries/v1
- **Description**: Retrieve registry entities identified by the customer id
Expand Down Expand Up @@ -1803,6 +1795,30 @@ We appreciate your interest in our project and look forward to collaborating wit

---

**Class**: `Falcon::IdentityEntitiesApi`

- **Operation**: [**get_sensor_aggregates**](docs/IdentityEntitiesApi.md#get_sensor_aggregates)
- **POST**: /identity-protection/aggregates/devices/GET/v1
- **Description**: Get sensor aggregates as specified via json in request body.

---

**Class**: `Falcon::IdentityEntitiesApi`

- **Operation**: [**get_sensor_details**](docs/IdentityEntitiesApi.md#get_sensor_details)
- **POST**: /identity-protection/entities/devices/GET/v1
- **Description**: Get details on one or more sensors by providing device IDs in a POST body. Supports up to a maximum of 5000 IDs.

---

**Class**: `Falcon::IdentityEntitiesApi`

- **Operation**: [**query_sensors_by_filter**](docs/IdentityEntitiesApi.md#query_sensors_by_filter)
- **GET**: /identity-protection/queries/devices/v1
- **Description**: Search for sensors in your environment by hostname, IP, and other criteria.

---

**Class**: `Falcon::IdentityProtectionApi`

- **Operation**: [**api_preempt_proxy_post_graphql**](docs/IdentityProtectionApi.md#api_preempt_proxy_post_graphql)
Expand Down Expand Up @@ -2071,7 +2087,7 @@ We appreciate your interest in our project and look forward to collaborating wit

- **Operation**: [**query_mitre_attacks**](docs/IntelApi.md#query_mitre_attacks)
- **GET**: /intel/queries/mitre/v1
- **Description**: Gets MITRE tactics and techniques for the given actor
- **Description**: Gets MITRE tactics and techniques for the given actor, returning concatenation of id and tactic and technique ids, example: fancy-bear_TA0011_T1071

---

Expand All @@ -2083,6 +2099,14 @@ We appreciate your interest in our project and look forward to collaborating wit

---

**Class**: `Falcon::InventoriesApi`

- **Operation**: [**create_inventory**](docs/InventoriesApi.md#create_inventory)
- **POST**: /snapshots/entities/inventories/v1
- **Description**: Create inventory from data received from snapshot

---

**Class**: `Falcon::IoaExclusionsApi`

- **Operation**: [**create_ioa_exclusions_v1**](docs/IoaExclusionsApi.md#create_ioa_exclusions_v1)
Expand Down Expand Up @@ -2647,7 +2671,15 @@ We appreciate your interest in our project and look forward to collaborating wit

- **Operation**: [**delete_cid_group_members**](docs/MsspApi.md#delete_cid_group_members)
- **DELETE**: /mssp/entities/cid-group-members/v1
- **Description**: Delete CID group members.
- **Description**: Deprecated : Please use DELETE /entities/cid-group-members/v2. Delete CID group members.

---

**Class**: `Falcon::MsspApi`

- **Operation**: [**delete_cid_group_members_v2**](docs/MsspApi.md#delete_cid_group_members_v2)
- **DELETE**: /mssp/entities/cid-group-members/v2
- **Description**: Delete CID group members. Prevents removal of a cid group a cid group if it is only part of one cid group.

---

Expand Down Expand Up @@ -3091,11 +3123,11 @@ We appreciate your interest in our project and look forward to collaborating wit

---

**Class**: `Falcon::PublicAssessmentsApi`
**Class**: `Falcon::ProvisionApi`

- **Operation**: [**get_combined_assessments_query**](docs/PublicAssessmentsApi.md#get_combined_assessments_query)
- **GET**: /configuration-assessment/combined/assessments/v1
- **Description**: Search for assessments in your environment by providing an FQL filter and paging details. Returns a set of HostFinding entities which match the filter criteria
- **Operation**: [**get_credentials_mixin0**](docs/ProvisionApi.md#get_credentials_mixin0)
- **GET**: /snapshots/entities/image-registry-credentials/v1
- **Description**: Gets the registry credentials

---

Expand Down Expand Up @@ -4131,62 +4163,6 @@ We appreciate your interest in our project and look forward to collaborating wit

---

**Class**: `Falcon::SpotlightEvaluationLogicApi`

- **Operation**: [**combined_query_evaluation_logic**](docs/SpotlightEvaluationLogicApi.md#combined_query_evaluation_logic)
- **GET**: /spotlight/combined/evaluation-logic/v1
- **Description**: Search for evaluation logic in your environment by providing a FQL filter and paging details. Returns a set of evaluation logic entities which match the filter criteria.

---

**Class**: `Falcon::SpotlightEvaluationLogicApi`

- **Operation**: [**get_evaluation_logic**](docs/SpotlightEvaluationLogicApi.md#get_evaluation_logic)
- **GET**: /spotlight/entities/evaluation-logic/v1
- **Description**: Get details on evaluation logic items by providing one or more IDs.

---

**Class**: `Falcon::SpotlightEvaluationLogicApi`

- **Operation**: [**query_evaluation_logic**](docs/SpotlightEvaluationLogicApi.md#query_evaluation_logic)
- **GET**: /spotlight/queries/evaluation-logic/v1
- **Description**: Search for evaluation logic in your environment by providing a FQL filter and paging details. Returns a set of evaluation logic IDs which match the filter criteria.

---

**Class**: `Falcon::SpotlightVulnerabilitiesApi`

- **Operation**: [**combined_query_vulnerabilities**](docs/SpotlightVulnerabilitiesApi.md#combined_query_vulnerabilities)
- **GET**: /spotlight/combined/vulnerabilities/v1
- **Description**: Search for Vulnerabilities in your environment by providing an FQL filter and paging details. Returns a set of Vulnerability entities which match the filter criteria

---

**Class**: `Falcon::SpotlightVulnerabilitiesApi`

- **Operation**: [**get_remediations_v2**](docs/SpotlightVulnerabilitiesApi.md#get_remediations_v2)
- **GET**: /spotlight/entities/remediations/v2
- **Description**: Get details on remediation by providing one or more IDs

---

**Class**: `Falcon::SpotlightVulnerabilitiesApi`

- **Operation**: [**get_vulnerabilities**](docs/SpotlightVulnerabilitiesApi.md#get_vulnerabilities)
- **GET**: /spotlight/entities/vulnerabilities/v2
- **Description**: Get details on vulnerabilities by providing one or more IDs

---

**Class**: `Falcon::SpotlightVulnerabilitiesApi`

- **Operation**: [**query_vulnerabilities**](docs/SpotlightVulnerabilitiesApi.md#query_vulnerabilities)
- **GET**: /spotlight/queries/vulnerabilities/v1
- **Description**: Search for Vulnerabilities in your environment by providing an FQL filter and paging details. Returns a set of Vulnerability IDs which match the filter criteria

---

**Class**: `Falcon::TailoredIntelligenceApi`

- **Operation**: [**get_events_body**](docs/TailoredIntelligenceApi.md#get_events_body)
Expand Down Expand Up @@ -4403,6 +4379,62 @@ We appreciate your interest in our project and look forward to collaborating wit

---

**Class**: `Falcon::VulnerabilitiesApi`

- **Operation**: [**combined_query_vulnerabilities**](docs/VulnerabilitiesApi.md#combined_query_vulnerabilities)
- **GET**: /spotlight/combined/vulnerabilities/v1
- **Description**: Search for Vulnerabilities in your environment by providing an FQL filter and paging details. Returns a set of Vulnerability entities which match the filter criteria

---

**Class**: `Falcon::VulnerabilitiesApi`

- **Operation**: [**get_remediations_v2**](docs/VulnerabilitiesApi.md#get_remediations_v2)
- **GET**: /spotlight/entities/remediations/v2
- **Description**: Get details on remediation by providing one or more IDs

---

**Class**: `Falcon::VulnerabilitiesApi`

- **Operation**: [**get_vulnerabilities**](docs/VulnerabilitiesApi.md#get_vulnerabilities)
- **GET**: /spotlight/entities/vulnerabilities/v2
- **Description**: Get details on vulnerabilities by providing one or more IDs

---

**Class**: `Falcon::VulnerabilitiesApi`

- **Operation**: [**query_vulnerabilities**](docs/VulnerabilitiesApi.md#query_vulnerabilities)
- **GET**: /spotlight/queries/vulnerabilities/v1
- **Description**: Search for Vulnerabilities in your environment by providing an FQL filter and paging details. Returns a set of Vulnerability IDs which match the filter criteria

---

**Class**: `Falcon::VulnerabilitiesEvaluationLogicApi`

- **Operation**: [**combined_query_evaluation_logic**](docs/VulnerabilitiesEvaluationLogicApi.md#combined_query_evaluation_logic)
- **GET**: /spotlight/combined/evaluation-logic/v1
- **Description**: Search for evaluation logic in your environment by providing a FQL filter and paging details. Returns a set of evaluation logic entities which match the filter criteria.

---

**Class**: `Falcon::VulnerabilitiesEvaluationLogicApi`

- **Operation**: [**get_evaluation_logic**](docs/VulnerabilitiesEvaluationLogicApi.md#get_evaluation_logic)
- **GET**: /spotlight/entities/evaluation-logic/v1
- **Description**: Get details on evaluation logic items by providing one or more IDs.

---

**Class**: `Falcon::VulnerabilitiesEvaluationLogicApi`

- **Operation**: [**query_evaluation_logic**](docs/VulnerabilitiesEvaluationLogicApi.md#query_evaluation_logic)
- **GET**: /spotlight/queries/evaluation-logic/v1
- **Description**: Search for evaluation logic in your environment by providing a FQL filter and paging details. Returns a set of evaluation logic IDs which match the filter criteria.

---

**Class**: `Falcon::ZeroTrustAssessmentApi`

- **Operation**: [**get_assessment_v1**](docs/ZeroTrustAssessmentApi.md#get_assessment_v1)
Expand Down
22 changes: 22 additions & 0 deletions docs/ApiSensorDetailsResponseSwagger.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Falcon::ApiSensorDetailsResponseSwagger

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **errors** | [**Array<MsaspecError>**](MsaspecError.md) | | |
| **meta** | [**MsaspecMetaInfo**](MsaspecMetaInfo.md) | | |
| **resources** | [**Array<InternalSensorStatus>**](InternalSensorStatus.md) | | |

## Example

```ruby
require 'crimson-falcon'

instance = Falcon::ApiSensorDetailsResponseSwagger.new(
errors: null,
meta: null,
resources: null
)
```

20 changes: 20 additions & 0 deletions docs/ClassificationCriteria.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Falcon::ClassificationCriteria

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **accounts** | **Array<String>** | | [optional] |
| **resources** | **Array<String>** | | [optional] |

## Example

```ruby
require 'crimson-falcon'

instance = Falcon::ClassificationCriteria.new(
accounts: null,
resources: null
)
```

28 changes: 28 additions & 0 deletions docs/ClassificationLabel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Falcon::ClassificationLabel

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **criteria** | [**Array<ClassificationCriteria>**](ClassificationCriteria.md) | | [optional] |
| **dynamic** | **Boolean** | | [optional] |
| **global** | **Boolean** | | [optional] |
| **group** | **String** | | [optional] |
| **id** | **Integer** | | [optional] |
| **name** | **String** | | [optional] |

## Example

```ruby
require 'crimson-falcon'

instance = Falcon::ClassificationLabel.new(
criteria: null,
dynamic: null,
global: null,
group: null,
id: null,
name: null
)
```

Loading

0 comments on commit e86ebf9

Please sign in to comment.