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 @@
v2.83.0
v2.84.0
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ Class | Method | HTTP request | Description
*FunctionsCoreApi* | [**cancel_ai_unstrip**](docs/FunctionsCoreApi.md#cancel_ai_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/ai-unstrip/cancel | Cancels a running ai-unstrip
*FunctionsCoreApi* | [**cancel_auto_unstrip**](docs/FunctionsCoreApi.md#cancel_auto_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/unstrip/cancel | Cancels a running auto-unstrip
*FunctionsCoreApi* | [**get_analysis_strings**](docs/FunctionsCoreApi.md#get_analysis_strings) | **GET** /v2/analyses/{analysis_id}/functions/strings | Get string information found in the Analysis
*FunctionsCoreApi* | [**get_analysis_strings_status**](docs/FunctionsCoreApi.md#get_analysis_strings_status) | **GET** /v2/analyses/{analysis_id}/functions/strings/status | Get string processing state for the Analysis
*FunctionsCoreApi* | [**get_function_blocks**](docs/FunctionsCoreApi.md#get_function_blocks) | **GET** /v2/functions/{function_id}/blocks | Get disassembly blocks related to the function
*FunctionsCoreApi* | [**get_function_callees_callers**](docs/FunctionsCoreApi.md#get_function_callees_callers) | **GET** /v2/functions/{function_id}/callees_callers | Get list of functions that call or are called by the specified function
*FunctionsCoreApi* | [**get_function_capabilities**](docs/FunctionsCoreApi.md#get_function_capabilities) | **GET** /v2/functions/{function_id}/capabilities | Retrieve a functions capabilities
Expand Down Expand Up @@ -161,6 +162,7 @@ Class | Method | HTTP request | Description
- [AnalysisRecord](docs/AnalysisRecord.md)
- [AnalysisScope](docs/AnalysisScope.md)
- [AnalysisStringsResponse](docs/AnalysisStringsResponse.md)
- [AnalysisStringsStatusResponse](docs/AnalysisStringsStatusResponse.md)
- [AnalysisTags](docs/AnalysisTags.md)
- [AnalysisUpdateRequest](docs/AnalysisUpdateRequest.md)
- [AnalysisUpdateTagsRequest](docs/AnalysisUpdateTagsRequest.md)
Expand All @@ -181,6 +183,7 @@ Class | Method | HTTP request | Description
- [BaseResponseAnalysisFunctions](docs/BaseResponseAnalysisFunctions.md)
- [BaseResponseAnalysisFunctionsList](docs/BaseResponseAnalysisFunctionsList.md)
- [BaseResponseAnalysisStringsResponse](docs/BaseResponseAnalysisStringsResponse.md)
- [BaseResponseAnalysisStringsStatusResponse](docs/BaseResponseAnalysisStringsStatusResponse.md)
- [BaseResponseAnalysisTags](docs/BaseResponseAnalysisTags.md)
- [BaseResponseAnalysisUpdateTagsResponse](docs/BaseResponseAnalysisUpdateTagsResponse.md)
- [BaseResponseBasic](docs/BaseResponseBasic.md)
Expand Down Expand Up @@ -244,6 +247,7 @@ Class | Method | HTTP request | Description
- [BaseResponseUploadResponse](docs/BaseResponseUploadResponse.md)
- [BaseResponseVulnerabilities](docs/BaseResponseVulnerabilities.md)
- [Basic](docs/Basic.md)
- [BinariesTaskStatus](docs/BinariesTaskStatus.md)
- [BinaryAdditionalDetailsDataResponse](docs/BinaryAdditionalDetailsDataResponse.md)
- [BinaryAdditionalResponse](docs/BinaryAdditionalResponse.md)
- [BinaryConfig](docs/BinaryConfig.md)
Expand Down
29 changes: 29 additions & 0 deletions docs/AnalysisStringsStatusResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# AnalysisStringsStatusResponse


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | [**BinariesTaskStatus**](BinariesTaskStatus.md) | The current status of the strings extraction task |

## Example

```python
from revengai.models.analysis_strings_status_response import AnalysisStringsStatusResponse

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

# convert the object into a dict
analysis_strings_status_response_dict = analysis_strings_status_response_instance.to_dict()
# create an instance of AnalysisStringsStatusResponse from a dict
analysis_strings_status_response_from_dict = AnalysisStringsStatusResponse.from_dict(analysis_strings_status_response_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **bool** | Response status on whether the request succeeded | [optional] [default to True]
**data** | [**AnalysisStringsStatusResponse**](AnalysisStringsStatusResponse.md) | | [optional]
**message** | **str** | | [optional]
**errors** | [**List[ErrorModel]**](ErrorModel.md) | | [optional]
**meta** | [**MetaModel**](MetaModel.md) | Metadata | [optional]

## Example

```python
from revengai.models.base_response_analysis_strings_status_response import BaseResponseAnalysisStringsStatusResponse

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

# convert the object into a dict
base_response_analysis_strings_status_response_dict = base_response_analysis_strings_status_response_instance.to_dict()
# create an instance of BaseResponseAnalysisStringsStatusResponse from a dict
base_response_analysis_strings_status_response_from_dict = BaseResponseAnalysisStringsStatusResponse.from_dict(base_response_analysis_strings_status_response_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)


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


## Enum

* `UNINITIALISED` (value: `'UNINITIALISED'`)

* `PENDING` (value: `'PENDING'`)

* `RUNNING` (value: `'RUNNING'`)

* `COMPLETED` (value: `'COMPLETED'`)

* `FAILED` (value: `'FAILED'`)

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


81 changes: 81 additions & 0 deletions docs/FunctionsCoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Method | HTTP request | Description
[**cancel_ai_unstrip**](FunctionsCoreApi.md#cancel_ai_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/ai-unstrip/cancel | Cancels a running ai-unstrip
[**cancel_auto_unstrip**](FunctionsCoreApi.md#cancel_auto_unstrip) | **DELETE** /v2/analyses/{analysis_id}/functions/unstrip/cancel | Cancels a running auto-unstrip
[**get_analysis_strings**](FunctionsCoreApi.md#get_analysis_strings) | **GET** /v2/analyses/{analysis_id}/functions/strings | Get string information found in the Analysis
[**get_analysis_strings_status**](FunctionsCoreApi.md#get_analysis_strings_status) | **GET** /v2/analyses/{analysis_id}/functions/strings/status | Get string processing state for the Analysis
[**get_function_blocks**](FunctionsCoreApi.md#get_function_blocks) | **GET** /v2/functions/{function_id}/blocks | Get disassembly blocks related to the function
[**get_function_callees_callers**](FunctionsCoreApi.md#get_function_callees_callers) | **GET** /v2/functions/{function_id}/callees_callers | Get list of functions that call or are called by the specified function
[**get_function_capabilities**](FunctionsCoreApi.md#get_function_capabilities) | **GET** /v2/functions/{function_id}/capabilities | Retrieve a functions capabilities
Expand Down Expand Up @@ -596,6 +597,86 @@ 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)

# **get_analysis_strings_status**
> BaseResponseAnalysisStringsStatusResponse get_analysis_strings_status(analysis_id)

Get string processing state for the Analysis

Get string processing state for the Analysis

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.base_response_analysis_strings_status_response import BaseResponseAnalysisStringsStatusResponse
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.FunctionsCoreApi(api_client)
analysis_id = 56 # int |

try:
# Get string processing state for the Analysis
api_response = api_instance.get_analysis_strings_status(analysis_id)
print("The response of FunctionsCoreApi->get_analysis_strings_status:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling FunctionsCoreApi->get_analysis_strings_status: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| |

### Return type

[**BaseResponseAnalysisStringsStatusResponse**](BaseResponseAnalysisStringsStatusResponse.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** | Successful Response | - |
**422** | Invalid request parameters | - |

[[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)

# **get_function_blocks**
> BaseResponseFunctionBlocksResponse get_function_blocks(function_id)

Expand Down
8 changes: 7 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__ = "v2.83.0"
__version__ = "v2.84.0"

# Define package exports
__all__ = [
Expand Down Expand Up @@ -59,6 +59,7 @@
"AnalysisRecord",
"AnalysisScope",
"AnalysisStringsResponse",
"AnalysisStringsStatusResponse",
"AnalysisTags",
"AnalysisUpdateRequest",
"AnalysisUpdateTagsRequest",
Expand All @@ -79,6 +80,7 @@
"BaseResponseAnalysisFunctions",
"BaseResponseAnalysisFunctionsList",
"BaseResponseAnalysisStringsResponse",
"BaseResponseAnalysisStringsStatusResponse",
"BaseResponseAnalysisTags",
"BaseResponseAnalysisUpdateTagsResponse",
"BaseResponseBasic",
Expand Down Expand Up @@ -142,6 +144,7 @@
"BaseResponseUploadResponse",
"BaseResponseVulnerabilities",
"Basic",
"BinariesTaskStatus",
"BinaryAdditionalDetailsDataResponse",
"BinaryAdditionalResponse",
"BinaryConfig",
Expand Down Expand Up @@ -376,6 +379,7 @@
from revengai.models.analysis_record import AnalysisRecord as AnalysisRecord
from revengai.models.analysis_scope import AnalysisScope as AnalysisScope
from revengai.models.analysis_strings_response import AnalysisStringsResponse as AnalysisStringsResponse
from revengai.models.analysis_strings_status_response import AnalysisStringsStatusResponse as AnalysisStringsStatusResponse
from revengai.models.analysis_tags import AnalysisTags as AnalysisTags
from revengai.models.analysis_update_request import AnalysisUpdateRequest as AnalysisUpdateRequest
from revengai.models.analysis_update_tags_request import AnalysisUpdateTagsRequest as AnalysisUpdateTagsRequest
Expand All @@ -396,6 +400,7 @@
from revengai.models.base_response_analysis_functions import BaseResponseAnalysisFunctions as BaseResponseAnalysisFunctions
from revengai.models.base_response_analysis_functions_list import BaseResponseAnalysisFunctionsList as BaseResponseAnalysisFunctionsList
from revengai.models.base_response_analysis_strings_response import BaseResponseAnalysisStringsResponse as BaseResponseAnalysisStringsResponse
from revengai.models.base_response_analysis_strings_status_response import BaseResponseAnalysisStringsStatusResponse as BaseResponseAnalysisStringsStatusResponse
from revengai.models.base_response_analysis_tags import BaseResponseAnalysisTags as BaseResponseAnalysisTags
from revengai.models.base_response_analysis_update_tags_response import BaseResponseAnalysisUpdateTagsResponse as BaseResponseAnalysisUpdateTagsResponse
from revengai.models.base_response_basic import BaseResponseBasic as BaseResponseBasic
Expand Down Expand Up @@ -459,6 +464,7 @@
from revengai.models.base_response_upload_response import BaseResponseUploadResponse as BaseResponseUploadResponse
from revengai.models.base_response_vulnerabilities import BaseResponseVulnerabilities as BaseResponseVulnerabilities
from revengai.models.basic import Basic as Basic
from revengai.models.binaries_task_status import BinariesTaskStatus as BinariesTaskStatus
from revengai.models.binary_additional_details_data_response import BinaryAdditionalDetailsDataResponse as BinaryAdditionalDetailsDataResponse
from revengai.models.binary_additional_response import BinaryAdditionalResponse as BinaryAdditionalResponse
from revengai.models.binary_config import BinaryConfig as BinaryConfig
Expand Down
Loading