Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .sdk-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.96.4
v3.97.0
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ Class | Method | HTTP request | Description
*AnalysesCoreApi* | [**upload_file**](docs/AnalysesCoreApi.md#upload_file) | **POST** /v2/upload | Upload File
*AnalysesCoreApi* | [**v3_get_analysis_strings**](docs/AnalysesCoreApi.md#v3_get_analysis_strings) | **GET** /v3/analyses/{analysis_id}/functions/strings | List strings for an analysis.
*AnalysesCoreApi* | [**v3_get_analysis_strings_status**](docs/AnalysesCoreApi.md#v3_get_analysis_strings_status) | **GET** /v3/analyses/{analysis_id}/functions/strings/status | Get the string-extraction status for an analysis.
*AnalysesCoreApi* | [**v3_list_example_analyses**](docs/AnalysesCoreApi.md#v3_list_example_analyses) | **GET** /v3/analyses/examples | List example analyses
*AnalysesResultsMetadataApi* | [**get_analysis_functions_paginated**](docs/AnalysesResultsMetadataApi.md#get_analysis_functions_paginated) | **GET** /v2/analyses/{analysis_id}/functions | Get functions from analysis
*AnalysesResultsMetadataApi* | [**get_capabilities**](docs/AnalysesResultsMetadataApi.md#get_capabilities) | **GET** /v2/analyses/{analysis_id}/capabilities | Gets the capabilities from the analysis
*AnalysesResultsMetadataApi* | [**get_functions_list**](docs/AnalysesResultsMetadataApi.md#get_functions_list) | **GET** /v2/analyses/{analysis_id}/functions/list | Gets functions from analysis
Expand Down Expand Up @@ -444,6 +445,7 @@ Class | Method | HTTP request | Description
- [EventTOOLCALLSTART](docs/EventTOOLCALLSTART.md)
- [EventTOOLCONFIRMATIONREQUIRED](docs/EventTOOLCONFIRMATIONREQUIRED.md)
- [EventWarning](docs/EventWarning.md)
- [Example](docs/Example.md)
- [ExportModel](docs/ExportModel.md)
- [ExternalResponse](docs/ExternalResponse.md)
- [ExtractedURL](docs/ExtractedURL.md)
Expand Down Expand Up @@ -520,6 +522,7 @@ Class | Method | HTTP request | Description
- [ListAnalysisStringsOutputBody](docs/ListAnalysisStringsOutputBody.md)
- [ListCollectionResults](docs/ListCollectionResults.md)
- [ListCollectionsOutputBody](docs/ListCollectionsOutputBody.md)
- [ListExampleAnalysesOutputBody](docs/ListExampleAnalysesOutputBody.md)
- [ListFunctionStringsOutputBody](docs/ListFunctionStringsOutputBody.md)
- [ListFunctionsDataTypesOutputBody](docs/ListFunctionsDataTypesOutputBody.md)
- [ListTeamsOutputBody](docs/ListTeamsOutputBody.md)
Expand Down
77 changes: 77 additions & 0 deletions docs/AnalysesCoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Method | HTTP request | Description
[**upload_file**](AnalysesCoreApi.md#upload_file) | **POST** /v2/upload | Upload File
[**v3_get_analysis_strings**](AnalysesCoreApi.md#v3_get_analysis_strings) | **GET** /v3/analyses/{analysis_id}/functions/strings | List strings for an analysis.
[**v3_get_analysis_strings_status**](AnalysesCoreApi.md#v3_get_analysis_strings_status) | **GET** /v3/analyses/{analysis_id}/functions/strings/status | Get the string-extraction status for an analysis.
[**v3_list_example_analyses**](AnalysesCoreApi.md#v3_list_example_analyses) | **GET** /v3/analyses/examples | List example analyses


# **add_user_string_to_analysis**
Expand Down Expand Up @@ -2175,3 +2176,79 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **v3_list_example_analyses**
> ListExampleAnalysesOutputBody v3_list_example_analyses()

List example analyses

Returns the curated example Analyses.

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.list_example_analyses_output_body import ListExampleAnalysesOutputBody
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
host = "https://api.reveng.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = revengai.AnalysesCoreApi(api_client)

try:
# List example analyses
api_response = api_instance.v3_list_example_analyses()
print("The response of AnalysesCoreApi->v3_list_example_analyses:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnalysesCoreApi->v3_list_example_analyses: %s\n" % e)
```



### Parameters

This endpoint does not need any parameter.

### Return type

[**ListExampleAnalysesOutputBody**](ListExampleAnalysesOutputBody.md)

### Authorization

[APIKey](../README.md#APIKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**0** | Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**analysis_id** | **int** | Analysis ID |
**analysis_scope** | **str** | Scope of the analysis (always PUBLIC for examples) |
**binary_id** | **int** | Binary ID |
**binary_name** | **str** | Binary filename |
**binary_size** | **int** | Binary size in bytes |
**creation** | **datetime** | When the analysis was created |
**is_owner** | **bool** | True when the caller owns the analysis |
**model_id** | **int** | Model ID |
**sha_256_hash** | **str** | SHA-256 hash of the binary |
**status** | **str** | Analysis status |
**tags** | **List[str]** | Tags associated with this binary |
**username** | **str** | Username of the analysis owner |

## Example

```python
from revengai.models.example import Example

# TODO update the JSON string below
json = "{}"
# create an instance of Example from a JSON string
example_instance = Example.from_json(json)
# print the JSON string representation of the object
print(Example.to_json())

# convert the object into a dict
example_dict = example_instance.to_dict()
# create an instance of Example from a dict
example_from_dict = Example.from_dict(example_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**analyses** | [**List[Example]**](Example.md) | List of example analyses |

## Example

```python
from revengai.models.list_example_analyses_output_body import ListExampleAnalysesOutputBody

# TODO update the JSON string below
json = "{}"
# create an instance of ListExampleAnalysesOutputBody from a JSON string
list_example_analyses_output_body_instance = ListExampleAnalysesOutputBody.from_json(json)
# print the JSON string representation of the object
print(ListExampleAnalysesOutputBody.to_json())

# convert the object into a dict
list_example_analyses_output_body_dict = list_example_analyses_output_body_instance.to_dict()
# create an instance of ListExampleAnalysesOutputBody from a dict
list_example_analyses_output_body_from_dict = ListExampleAnalysesOutputBody.from_dict(list_example_analyses_output_body_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


6 changes: 5 additions & 1 deletion revengai/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
""" # noqa: E501


__version__ = "v3.96.4"
__version__ = "v3.97.0"

# Define package exports
__all__ = [
Expand Down Expand Up @@ -290,6 +290,7 @@
"EventTOOLCALLSTART",
"EventTOOLCONFIRMATIONREQUIRED",
"EventWarning",
"Example",
"ExportModel",
"ExternalResponse",
"ExtractedURL",
Expand Down Expand Up @@ -366,6 +367,7 @@
"ListAnalysisStringsOutputBody",
"ListCollectionResults",
"ListCollectionsOutputBody",
"ListExampleAnalysesOutputBody",
"ListFunctionStringsOutputBody",
"ListFunctionsDataTypesOutputBody",
"ListTeamsOutputBody",
Expand Down Expand Up @@ -818,6 +820,7 @@
from revengai.models.event_toolcallstart import EventTOOLCALLSTART as EventTOOLCALLSTART
from revengai.models.event_toolconfirmationrequired import EventTOOLCONFIRMATIONREQUIRED as EventTOOLCONFIRMATIONREQUIRED
from revengai.models.event_warning import EventWarning as EventWarning
from revengai.models.example import Example as Example
from revengai.models.export_model import ExportModel as ExportModel
from revengai.models.external_response import ExternalResponse as ExternalResponse
from revengai.models.extracted_url import ExtractedURL as ExtractedURL
Expand Down Expand Up @@ -894,6 +897,7 @@
from revengai.models.list_analysis_strings_output_body import ListAnalysisStringsOutputBody as ListAnalysisStringsOutputBody
from revengai.models.list_collection_results import ListCollectionResults as ListCollectionResults
from revengai.models.list_collections_output_body import ListCollectionsOutputBody as ListCollectionsOutputBody
from revengai.models.list_example_analyses_output_body import ListExampleAnalysesOutputBody as ListExampleAnalysesOutputBody
from revengai.models.list_function_strings_output_body import ListFunctionStringsOutputBody as ListFunctionStringsOutputBody
from revengai.models.list_functions_data_types_output_body import ListFunctionsDataTypesOutputBody as ListFunctionsDataTypesOutputBody
from revengai.models.list_teams_output_body import ListTeamsOutputBody as ListTeamsOutputBody
Expand Down
Loading