diff --git a/README.md b/README.md index fdb0182..08da3a3 100644 --- a/README.md +++ b/README.md @@ -174,12 +174,12 @@ Class | Method | HTTP request | Description *FunctionsDataTypesApi* | [**batch_update_function_data_types**](docs/FunctionsDataTypesApi.md#batch_update_function_data_types) | **PUT** /v3/analyses/{analysis_id}/functions/data-types | Batch update function data types *FunctionsDataTypesApi* | [**generate_function_data_types_for_analysis**](docs/FunctionsDataTypesApi.md#generate_function_data_types_for_analysis) | **POST** /v2/analyses/{analysis_id}/functions/data_types | Generate Function Data Types *FunctionsDataTypesApi* | [**generate_function_data_types_for_functions**](docs/FunctionsDataTypesApi.md#generate_function_data_types_for_functions) | **POST** /v2/functions/data_types | Generate Function Data Types for an arbitrary list of functions -*FunctionsDataTypesApi* | [**get_function_data_types**](docs/FunctionsDataTypesApi.md#get_function_data_types) | **GET** /v2/analyses/{analysis_id}/functions/{function_id}/data_types | Get Function Data Types -*FunctionsDataTypesApi* | [**get_function_data_types_0**](docs/FunctionsDataTypesApi.md#get_function_data_types_0) | **GET** /v3/analyses/{analysis_id}/functions/{function_id}/data-types | Get data types for a single function +*FunctionsDataTypesApi* | [**get_function_data_types**](docs/FunctionsDataTypesApi.md#get_function_data_types) | **GET** /v3/analyses/{analysis_id}/functions/{function_id}/data-types | Get data types for a single function *FunctionsDataTypesApi* | [**list_analysis_functions_data_types**](docs/FunctionsDataTypesApi.md#list_analysis_functions_data_types) | **GET** /v3/analyses/{analysis_id}/functions/data-types | List data types for all functions in an analysis *FunctionsDataTypesApi* | [**list_function_data_types_for_analysis**](docs/FunctionsDataTypesApi.md#list_function_data_types_for_analysis) | **GET** /v2/analyses/{analysis_id}/functions/data_types | List Function Data Types *FunctionsDataTypesApi* | [**list_function_data_types_for_functions**](docs/FunctionsDataTypesApi.md#list_function_data_types_for_functions) | **GET** /v2/functions/data_types | List Function Data Types *FunctionsDataTypesApi* | [**list_functions_data_types**](docs/FunctionsDataTypesApi.md#list_functions_data_types) | **GET** /v3/functions/data-types | Get data types for many functions +*FunctionsDataTypesApi* | [**update_function_data_types**](docs/FunctionsDataTypesApi.md#update_function_data_types) | **PUT** /v2/analyses/{analysis_id}/functions/{function_id}/data_types | Update function data types *FunctionsRenamingHistoryApi* | [**batch_rename_function**](docs/FunctionsRenamingHistoryApi.md#batch_rename_function) | **POST** /v2/functions/rename/batch | Batch Rename Functions *FunctionsRenamingHistoryApi* | [**batch_rename_functions**](docs/FunctionsRenamingHistoryApi.md#batch_rename_functions) | **POST** /v3/functions/rename | Batch rename functions *FunctionsRenamingHistoryApi* | [**get_function_history**](docs/FunctionsRenamingHistoryApi.md#get_function_history) | **GET** /v3/functions/{function_id}/history | Get function name history @@ -472,7 +472,6 @@ Class | Method | HTTP request | Description - [FunctionDetailsOutputBody](docs/FunctionDetailsOutputBody.md) - [FunctionHeader](docs/FunctionHeader.md) - [FunctionInfo](docs/FunctionInfo.md) - - [FunctionInfoFuncDepsInner](docs/FunctionInfoFuncDepsInner.md) - [FunctionListItem](docs/FunctionListItem.md) - [FunctionLocalVariableResponse](docs/FunctionLocalVariableResponse.md) - [FunctionMapping](docs/FunctionMapping.md) @@ -688,6 +687,13 @@ Class | Method | HTTP request | Description - [UserCredits](docs/UserCredits.md) - [UserIdentity](docs/UserIdentity.md) - [UserProfile](docs/UserProfile.md) + - [V2FunctionHeader](docs/V2FunctionHeader.md) + - [V2FunctionInfo](docs/V2FunctionInfo.md) + - [V2FunctionInfoFuncDepsInner](docs/V2FunctionInfoFuncDepsInner.md) + - [V2FunctionMatch](docs/V2FunctionMatch.md) + - [V2FunctionType](docs/V2FunctionType.md) + - [V2MatchedFunction](docs/V2MatchedFunction.md) + - [V2NameConfidence](docs/V2NameConfidence.md) - [Vulnerabilities](docs/Vulnerabilities.md) - [Vulnerability](docs/Vulnerability.md) - [WarningEvent](docs/WarningEvent.md) diff --git a/docs/AgentApi.md b/docs/AgentApi.md index e076074..64c434f 100644 --- a/docs/AgentApi.md +++ b/docs/AgentApi.md @@ -23,6 +23,7 @@ Check the status of a capabilities analysis workflow ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -47,6 +48,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -77,7 +83,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -101,6 +107,7 @@ Check the status of a report analysis workflow ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -125,6 +132,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -155,7 +167,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -179,6 +191,7 @@ Check the status of a triage analysis workflow ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -203,6 +216,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -233,7 +251,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -257,6 +275,7 @@ Queues a capabilities analysis workflow process ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -281,6 +300,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -311,7 +335,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -335,6 +359,7 @@ Queues a combined report analysis workflow process ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -359,6 +384,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -389,7 +419,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -414,6 +444,7 @@ Queues a triage analysis workflow process ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -438,6 +469,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -468,7 +504,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -492,6 +528,7 @@ Get Capabilities Result ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -516,6 +553,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -546,7 +588,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -578,6 +620,7 @@ Returns: ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -602,6 +645,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -632,7 +680,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -656,6 +704,7 @@ Get Triage Result ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -680,6 +729,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -710,7 +764,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/AnalysesBulkActionsApi.md b/docs/AnalysesBulkActionsApi.md index a435d08..3d9ae5a 100644 --- a/docs/AnalysesBulkActionsApi.md +++ b/docs/AnalysesBulkActionsApi.md @@ -18,6 +18,7 @@ Updates analysis tags for multiple analyses. User must be the owner. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -43,6 +44,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -73,7 +79,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -99,6 +105,7 @@ Deletes multiple analyses. User must be the owner of all analyses. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -124,6 +131,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -154,7 +166,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/AnalysesCommentsApi.md b/docs/AnalysesCommentsApi.md index efd4245..35296e8 100644 --- a/docs/AnalysesCommentsApi.md +++ b/docs/AnalysesCommentsApi.md @@ -20,6 +20,7 @@ Creates a comment associated with a specified analysis). ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -45,6 +46,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -77,7 +83,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -104,6 +110,7 @@ Deletes an existing comment. Users can only delete their own comments. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -128,6 +135,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -160,7 +172,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -188,6 +200,7 @@ Retrieves all comments created for a specific analysis. Only returns comments fo ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -212,6 +225,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -242,7 +260,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -268,6 +286,7 @@ Updates the content of an existing comment. Users can only update their own comm ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -293,6 +312,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -327,7 +351,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/AnalysesCoreApi.md b/docs/AnalysesCoreApi.md index 42f114d..cd40b82 100644 --- a/docs/AnalysesCoreApi.md +++ b/docs/AnalysesCoreApi.md @@ -46,6 +46,7 @@ Attaches a user-provided string to an analysis at the given virtual address. The ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -70,6 +71,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -102,7 +108,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -131,6 +137,7 @@ Begins an analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -156,6 +163,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -188,7 +200,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -216,6 +228,7 @@ Deletes an analysis based on the provided analysis ID. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -240,6 +253,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -270,7 +288,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -298,6 +316,7 @@ Returns basic analysis information for an analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -322,6 +341,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -352,7 +376,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -382,6 +406,7 @@ Returns basic metadata for the given analysis including binary details, model, o ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -406,6 +431,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -436,7 +466,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -470,6 +500,7 @@ Returns a 64kb byte page from the binary. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -493,6 +524,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -523,7 +559,7 @@ void (empty response body) ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -553,6 +589,7 @@ Returns three maps: a map of function ids to function addresses, it's inverse an ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -577,6 +614,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -607,7 +649,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -637,6 +679,7 @@ Returns the matches blob when the matching workflow has completed. While the wor ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -661,6 +704,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -691,7 +739,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -724,6 +772,7 @@ Returns the matching workflow's current status. Does not include the matches blo ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -748,6 +797,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -778,7 +832,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -807,6 +861,7 @@ Given an analysis ID gets the current logs of an analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -831,6 +886,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -861,7 +921,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -887,6 +947,7 @@ Gets the params that the analysis was run with ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -911,6 +972,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -941,7 +1007,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -967,6 +1033,7 @@ Given an analysis ID gets the current status of the analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -991,6 +1058,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1021,7 +1093,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1051,6 +1123,7 @@ Returns the dynamic execution report JSON for the analysis. Requires the task to ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1075,6 +1148,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1105,7 +1183,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1137,6 +1215,7 @@ Returns the status of the most recent dynamic execution task for the analysis. R ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1161,6 +1240,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1191,7 +1275,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1219,6 +1303,7 @@ Inserts a log record for an analysis. Only the analysis owner can insert logs. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1244,6 +1329,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1276,7 +1366,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1302,6 +1392,7 @@ Gets the most recent analyses provided a scope, this is then paginated, if pages ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1332,6 +1423,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1382,7 +1478,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1408,6 +1504,7 @@ Given an binary ID gets the ID of an analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1431,6 +1528,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1461,7 +1563,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1487,6 +1589,7 @@ Add strings to the analysis. Rejects if any string already exists at the given v ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1512,6 +1615,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1544,7 +1652,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1570,6 +1678,7 @@ Re-queues an already uploaded analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1595,6 +1704,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1629,7 +1743,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1662,6 +1776,7 @@ Dispatches the function-matching workflow against every function in the analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1687,6 +1802,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1719,7 +1839,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1749,6 +1869,7 @@ Updates analysis attributes (binary_name, analysis_scope). User must be the owne ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1774,6 +1895,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1806,7 +1932,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1832,6 +1958,7 @@ Updates analysis tags. User must be the owner. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1857,6 +1984,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1889,7 +2021,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1913,6 +2045,7 @@ Upload File ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1938,6 +2071,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1974,7 +2112,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2004,6 +2142,7 @@ Returns the strings discovered in an analysis, combining function-level and anal ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -2028,6 +2167,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2070,7 +2214,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2103,6 +2247,7 @@ Returns the status of the string-extraction task for the binary backing the anal ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -2127,6 +2272,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2157,7 +2307,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2186,6 +2336,7 @@ Returns the curated example Analyses. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -2210,6 +2361,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2236,7 +2392,7 @@ This endpoint does not need any parameter. ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/AnalysesResultsMetadataApi.md b/docs/AnalysesResultsMetadataApi.md index fefc2c3..0366ef4 100644 --- a/docs/AnalysesResultsMetadataApi.md +++ b/docs/AnalysesResultsMetadataApi.md @@ -22,6 +22,7 @@ Returns a paginated list of functions identified during analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -46,6 +47,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -80,7 +86,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -104,6 +110,7 @@ Gets the capabilities from the analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -128,6 +135,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -158,7 +170,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -184,6 +196,7 @@ Gets the functions identified during analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -208,6 +221,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -250,7 +268,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -274,6 +292,7 @@ Gets the software-bill-of-materials (SBOM) found in the analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -298,6 +317,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -328,7 +352,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -352,6 +376,7 @@ Get function tags with maliciousness score ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -376,6 +401,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -406,7 +436,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -430,6 +460,7 @@ Gets the vulnerabilities found in the analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -454,6 +485,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -484,7 +520,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/AnalysesXRefsApi.md b/docs/AnalysesXRefsApi.md index db3e3db..9926d94 100644 --- a/docs/AnalysesXRefsApi.md +++ b/docs/AnalysesXRefsApi.md @@ -17,6 +17,7 @@ Method | HTTP request | Description ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -41,6 +42,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -73,7 +79,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/AuthenticationUsersApi.md b/docs/AuthenticationUsersApi.md index 9010f44..f1dfa2b 100644 --- a/docs/AuthenticationUsersApi.md +++ b/docs/AuthenticationUsersApi.md @@ -17,6 +17,7 @@ Get a user's public information ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -41,6 +42,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -71,7 +77,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -95,6 +101,7 @@ Get auth user activity ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -119,6 +126,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -145,7 +157,7 @@ This endpoint does not need any parameter. ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -171,6 +183,7 @@ Submits feedback about the application and forwards it to the RevEng.ai project ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -196,6 +209,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -226,7 +244,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/BinariesApi.md b/docs/BinariesApi.md index 643919a..6db989c 100644 --- a/docs/BinariesApi.md +++ b/docs/BinariesApi.md @@ -24,6 +24,7 @@ Downloads a zipped binary with password protection ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -47,6 +48,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -77,7 +83,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -101,6 +107,7 @@ Gets the additional details of a binary ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -125,6 +132,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -155,7 +167,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -185,6 +197,7 @@ Returns structured metadata extracted by the additional-details pipeline for the ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -209,6 +222,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -239,7 +257,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -266,6 +284,7 @@ Gets the status of the additional details task for a binary ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -290,6 +309,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -320,7 +344,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -350,6 +374,7 @@ Returns the status of the additional-details extraction task. One of `UNINITIALI ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -374,6 +399,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -404,7 +434,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -431,6 +461,7 @@ Gets the details of a binary ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -455,6 +486,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -485,7 +521,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -509,6 +545,7 @@ Gets the die info of a binary ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -533,6 +570,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -563,7 +605,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -587,6 +629,7 @@ Gets the external details of a binary ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -611,6 +654,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -641,7 +689,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -665,6 +713,7 @@ Gets the status of the unpack binary task for a binary ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -689,6 +738,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -719,7 +773,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -743,6 +797,7 @@ Gets the related binaries of a binary. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -767,6 +822,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -797,7 +857,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/CollectionsApi.md b/docs/CollectionsApi.md index b427ccb..f1fa40a 100644 --- a/docs/CollectionsApi.md +++ b/docs/CollectionsApi.md @@ -30,6 +30,7 @@ A collection is a group of binaries that are related in some way. This endpoint ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -55,6 +56,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -85,7 +91,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -111,6 +117,7 @@ Deletes a collection ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -135,6 +142,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -165,7 +177,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -191,6 +203,7 @@ Gets a single collection. The collection can include binaries and tags if reques ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -215,6 +228,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -255,7 +273,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -281,6 +299,7 @@ Returns a list of collections ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -308,6 +327,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -348,7 +372,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -374,6 +398,7 @@ Updates a collection, you can update the collection name, description, and scope ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -399,6 +424,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -431,7 +461,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -457,6 +487,7 @@ Updates/changes a collection binaries to whatever is provided in the request. Af ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -482,6 +513,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -514,7 +550,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -540,6 +576,7 @@ Updates/changes a collection tags to whatever is provided in the request. After ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -565,6 +602,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -597,7 +639,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -627,6 +669,7 @@ Creates a new collection, optionally tagging it and linking binary IDs to it. Ta ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -652,6 +695,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -682,7 +730,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -715,6 +763,7 @@ Deletes a collection. The collection must not have any linked binaries (call PAT ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -738,6 +787,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -766,7 +820,7 @@ void (empty response body) ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -799,6 +853,7 @@ Gets a single collection by ID. Optionally include tags and paginated binaries. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -823,6 +878,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -863,7 +923,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -894,6 +954,7 @@ Lists collections accessible to the authenticated user. Supports search, filteri ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -918,6 +979,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -958,7 +1024,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -990,6 +1056,7 @@ Updates a collection's name, description, and/or scope. Omitted fields keep thei ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1015,6 +1082,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1047,7 +1119,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1081,6 +1153,7 @@ Replaces the binaries linked to a collection with the supplied list. Binaries no ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1106,6 +1179,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1138,7 +1216,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1171,6 +1249,7 @@ Replaces the tags on a collection with the supplied list. Tags not present in th ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1196,6 +1275,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1228,7 +1312,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/ConfigApi.md b/docs/ConfigApi.md index 4d9bc03..3399d82 100644 --- a/docs/ConfigApi.md +++ b/docs/ConfigApi.md @@ -17,6 +17,7 @@ General configuration endpoint ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -41,6 +42,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -67,7 +73,7 @@ This endpoint does not need any parameter. ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/ConversationsApi.md b/docs/ConversationsApi.md index 417fab7..d6f4bd0 100644 --- a/docs/ConversationsApi.md +++ b/docs/ConversationsApi.md @@ -28,6 +28,7 @@ Cancels the currently active agentic run for the given conversation. Returns 404 ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -52,6 +53,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -82,7 +88,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -116,6 +122,7 @@ Responds to a pending tool confirmation request. The agent pauses before executi ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -141,6 +148,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -173,7 +185,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -205,6 +217,7 @@ Creates a new conversation for the authenticated user. Optionally include a bina ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -230,6 +243,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -260,7 +278,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -292,6 +310,7 @@ Returns the conversation metadata along with all persisted events. Useful for re ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -316,6 +335,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -346,7 +370,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -375,6 +399,7 @@ Returns all conversations owned by the authenticated user, ordered by most recen ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -399,6 +424,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -425,7 +455,7 @@ This endpoint does not need any parameter. ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -459,6 +489,7 @@ Sends a user message to the conversation and kicks off an agentic processing loo ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -484,6 +515,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -516,7 +552,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -548,6 +584,7 @@ Opens a Server-Sent Events stream for the given conversation. Events include run ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -572,6 +609,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -604,7 +646,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/ExternalSourcesApi.md b/docs/ExternalSourcesApi.md index dbae590..10c98d0 100644 --- a/docs/ExternalSourcesApi.md +++ b/docs/ExternalSourcesApi.md @@ -17,6 +17,7 @@ Pulls data from VirusTotal ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -41,6 +42,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -71,7 +77,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -96,6 +102,7 @@ Get VirusTotal data ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -120,6 +127,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -150,7 +162,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -175,6 +187,7 @@ Check the status of VirusTotal data retrieval ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -199,6 +212,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -229,7 +247,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/FirmwareApi.md b/docs/FirmwareApi.md index 4955c99..7baf42a 100644 --- a/docs/FirmwareApi.md +++ b/docs/FirmwareApi.md @@ -18,6 +18,7 @@ Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -41,6 +42,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -71,7 +77,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -97,6 +103,7 @@ Uploads a firmware file and begins a 'Firmware Unpacker' task. Returns a result ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -120,6 +127,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -152,7 +164,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/FunctionDataTypes.md b/docs/FunctionDataTypes.md index d5af1bf..4d2de0e 100644 --- a/docs/FunctionDataTypes.md +++ b/docs/FunctionDataTypes.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **completed** | **bool** | Whether the service has completed data types generation | **status** | **str** | The current status of the data types service | -**data_types** | [**FunctionInfo**](FunctionInfo.md) | | [optional] +**data_types** | [**V2FunctionInfo**](V2FunctionInfo.md) | | [optional] **data_types_version** | **int** | | [optional] ## Example diff --git a/docs/FunctionDataTypesListItem.md b/docs/FunctionDataTypesListItem.md index 8c4b2b5..3d55b95 100644 --- a/docs/FunctionDataTypesListItem.md +++ b/docs/FunctionDataTypesListItem.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **completed** | **bool** | Whether the service has completed data types generation | **status** | **str** | The current status of the data types service | -**data_types** | [**FunctionInfo**](FunctionInfo.md) | | [optional] +**data_types** | [**V2FunctionInfo**](V2FunctionInfo.md) | | [optional] **data_types_version** | **int** | | [optional] **function_id** | **int** | Function id | diff --git a/docs/FunctionHeader.md b/docs/FunctionHeader.md index e0f364e..01617e0 100644 --- a/docs/FunctionHeader.md +++ b/docs/FunctionHeader.md @@ -5,11 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**addr** | **int** | | +**args** | [**Dict[str, FunctionArgument]**](FunctionArgument.md) | Argument map keyed by ordinal hex (e.g. \"0x0\", \"0x1\"). | **last_change** | **str** | | [optional] -**name** | **str** | Name of the function | -**addr** | **int** | Memory address of the function | -**type** | **str** | Return type of the function | -**args** | [**Dict[str, Argument]**](Argument.md) | Dictionary of function arguments | +**name** | **str** | | +**scope** | **str** | | [optional] +**type** | **str** | | ## Example diff --git a/docs/FunctionInfo.md b/docs/FunctionInfo.md index 0e14caa..f8fc4aa 100644 --- a/docs/FunctionInfo.md +++ b/docs/FunctionInfo.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**func_deps** | [**List[FunctionDependency]**](FunctionDependency.md) | | **func_types** | [**FunctionType**](FunctionType.md) | | [optional] -**func_deps** | [**List[FunctionInfoFuncDepsInner]**](FunctionInfoFuncDepsInner.md) | List of function dependencies | ## Example diff --git a/docs/FunctionMatch.md b/docs/FunctionMatch.md index 7cd06b3..2fc5c2e 100644 --- a/docs/FunctionMatch.md +++ b/docs/FunctionMatch.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**function_id** | **int** | Unique identifier of the function | -**matched_functions** | [**List[MatchedFunction]**](MatchedFunction.md) | | -**confidences** | [**List[NameConfidence]**](NameConfidence.md) | | [optional] +**confidences** | [**List[NameConfidence]**](NameConfidence.md) | Per-name confidences when canonify was requested | [optional] +**function_id** | **int** | Source function ID | +**matched_functions** | [**List[MatchedFunction]**](MatchedFunction.md) | Top candidate matches in similarity-descending order | ## Example diff --git a/docs/FunctionMatchingResponse.md b/docs/FunctionMatchingResponse.md index 28b91ef..4cc07da 100644 --- a/docs/FunctionMatchingResponse.md +++ b/docs/FunctionMatchingResponse.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **error_message** | **str** | | [optional] **current_page** | **int** | | [optional] **total_pages** | **int** | | [optional] -**matches** | [**List[FunctionMatch]**](FunctionMatch.md) | | [optional] +**matches** | [**List[V2FunctionMatch]**](V2FunctionMatch.md) | | [optional] **num_matches** | **int** | | [optional] **num_debug_matches** | **int** | | [optional] **updated_at** | **str** | | [optional] diff --git a/docs/FunctionType.md b/docs/FunctionType.md index 0f9c908..6bc961c 100644 --- a/docs/FunctionType.md +++ b/docs/FunctionType.md @@ -5,14 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**addr** | **int** | | +**artifact_type** | **str** | | [optional] +**header** | [**FunctionHeader**](FunctionHeader.md) | | **last_change** | **str** | | [optional] -**addr** | **int** | Memory address of the function | -**size** | **int** | Size of the function in bytes | -**header** | [**FunctionHeader**](FunctionHeader.md) | Function header information | -**stack_vars** | [**Dict[str, StackVariable]**](StackVariable.md) | | [optional] -**name** | **str** | Name of the function | -**type** | **str** | Return type of the function | -**artifact_type** | **str** | Type of artifact that the structure is associated with | [optional] [default to 'Function'] +**name** | **str** | | +**scope** | **str** | | [optional] +**size** | **int** | | +**stack_vars** | [**Dict[str, FunctionStackVariable]**](FunctionStackVariable.md) | Stack variables keyed by offset hex. | [optional] +**type** | **str** | | ## Example diff --git a/docs/FunctionsAIDecompilationApi.md b/docs/FunctionsAIDecompilationApi.md index f4adb22..add9b55 100644 --- a/docs/FunctionsAIDecompilationApi.md +++ b/docs/FunctionsAIDecompilationApi.md @@ -38,6 +38,7 @@ Begins the AI decompilation process for a function. Charges team credits and sta ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -62,6 +63,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -96,7 +102,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -131,6 +137,7 @@ Removes the comment for the given line number. Requires comments to have been ge ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -155,6 +162,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -187,7 +199,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -221,6 +233,7 @@ Returns the decompilation source code. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -245,6 +258,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -275,7 +293,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -308,6 +326,7 @@ Returns the commented source if available. Returns pending status if comments ar ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -332,6 +351,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -362,7 +386,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -395,6 +419,7 @@ Returns fine-grained progress of the inline comments generation workflow. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -419,6 +444,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -449,7 +479,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -476,6 +506,7 @@ Get rating for AI decompilation ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -500,6 +531,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -530,7 +566,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -560,6 +596,7 @@ Returns fine-grained progress of the running workflow including current step, to ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -584,6 +621,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -614,7 +656,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -647,6 +689,7 @@ Returns the summary if available. Returns pending status if summary is still bei ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -671,6 +714,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -701,7 +749,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -734,6 +782,7 @@ Returns fine-grained progress of the summary generation workflow. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -758,6 +807,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -788,7 +842,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -822,6 +876,7 @@ Returns the decompilation with placeholder tokens, the function mapping for toke ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -846,6 +901,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -876,7 +936,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -909,6 +969,7 @@ Merges a single line comment into the existing AI-generated inline comments. Req ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -934,6 +995,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -966,7 +1032,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -999,6 +1065,7 @@ Starts a new inline comments generation workflow for the function. Requires an e ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1023,6 +1090,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1053,7 +1125,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1086,6 +1158,7 @@ Starts a new summary generation workflow for the function. Requires an existing ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1110,6 +1183,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1140,7 +1218,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1169,6 +1247,7 @@ Opens a Server-Sent Events stream of incremental decompilation events for the gi ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1193,6 +1272,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1223,7 +1307,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1254,6 +1338,7 @@ Applies user-provided name overrides to placeholder tokens in the decompilation. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1279,6 +1364,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1311,7 +1401,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1339,6 +1429,7 @@ Upsert rating for AI decompilation ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1364,6 +1455,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1396,7 +1492,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/FunctionsCoreApi.md b/docs/FunctionsCoreApi.md index 81a1e67..9315db3 100644 --- a/docs/FunctionsCoreApi.md +++ b/docs/FunctionsCoreApi.md @@ -47,6 +47,7 @@ Records an outgoing call edge from the given function to a callee. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -71,6 +72,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -103,7 +109,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -137,6 +143,7 @@ Attaches a user-provided string to a function at the given virtual address. The ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -161,6 +168,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -193,7 +205,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -222,6 +234,7 @@ Takes in the analysis ID, uses the functions ID's from it and settings to find t ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -247,6 +260,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -279,7 +297,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -305,6 +323,7 @@ Takes in an analysis id and settings and matches the nearest functions to the on ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -330,6 +349,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -362,7 +386,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -388,6 +412,7 @@ Takes in the analysis ID, uses the functions ID's from it and settings to find t ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -413,6 +438,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -445,7 +475,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -471,6 +501,7 @@ Takes in an input of functions ID's and settings and finds the nearest functions ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -496,6 +527,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -526,7 +562,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -552,6 +588,7 @@ Takes in the analysis ID and cancels a running ai-unstrip operation ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -576,6 +613,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -606,7 +648,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -632,6 +674,7 @@ Takes in the analysis ID and cancels a running auto-unstrip operation ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -656,6 +699,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -686,7 +734,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -712,6 +760,7 @@ Get string information found in the analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -736,6 +785,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -778,7 +832,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -804,6 +858,7 @@ Get string processing state for the Analysis ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -828,6 +883,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -858,7 +918,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -884,6 +944,7 @@ Get disassembly blocks related to the function ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -908,6 +969,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -938,7 +1004,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -969,6 +1035,7 @@ Returns the function's disassembly metadata (JSON blob containing basic blocks + ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -993,6 +1060,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1023,7 +1095,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1050,6 +1122,7 @@ Get list of functions that call or are called by the specified function ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1074,6 +1147,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1104,7 +1182,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1134,6 +1212,7 @@ Returns both the outgoing call edges (callees) and incoming call edges (callers) ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1158,6 +1237,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1188,7 +1272,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1215,6 +1299,7 @@ Get list of functions that call or are called for a list of functions ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1239,6 +1324,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1269,7 +1359,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1293,6 +1383,7 @@ Retrieve a functions capabilities ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1317,6 +1408,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1347,7 +1443,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1378,6 +1474,7 @@ Returns the capability findings (CAPA-style behaviour matches) associated with t ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1402,6 +1499,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1432,7 +1534,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1459,6 +1561,7 @@ Get function details ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1483,6 +1586,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1513,7 +1621,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1543,6 +1651,7 @@ Returns metadata for a single function — name, virtual address, size, debug st ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1567,6 +1676,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1597,7 +1711,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1626,6 +1740,7 @@ Get string information found in the function ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1650,6 +1765,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1686,7 +1806,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1716,6 +1836,7 @@ Returns the strings discovered in a function. Supports value search and paginati ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1740,6 +1861,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1776,7 +1902,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1810,6 +1936,7 @@ Bulk variant — pass `function_ids` as a query parameter (comma-separated or re ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1834,6 +1961,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1864,7 +1996,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1899,6 +2031,7 @@ Returns the matches blob when the matching workflow has completed. While the wor ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -1923,6 +2056,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -1953,7 +2091,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -1988,6 +2126,7 @@ Returns the matching workflow's current status for the supplied function IDs. Do ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -2012,6 +2151,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2042,7 +2186,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2076,6 +2220,7 @@ Returns a paginated list of functions belonging to the analysis. `total_count` i ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -2100,6 +2245,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2134,7 +2284,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -2168,6 +2318,7 @@ Dispatches the function-matching workflow against the provided function IDs. Ret ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -2193,6 +2344,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -2223,7 +2379,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/FunctionsDataTypesApi.md b/docs/FunctionsDataTypesApi.md index 7435618..bb2ef4b 100644 --- a/docs/FunctionsDataTypesApi.md +++ b/docs/FunctionsDataTypesApi.md @@ -7,12 +7,12 @@ Method | HTTP request | Description [**batch_update_function_data_types**](FunctionsDataTypesApi.md#batch_update_function_data_types) | **PUT** /v3/analyses/{analysis_id}/functions/data-types | Batch update function data types [**generate_function_data_types_for_analysis**](FunctionsDataTypesApi.md#generate_function_data_types_for_analysis) | **POST** /v2/analyses/{analysis_id}/functions/data_types | Generate Function Data Types [**generate_function_data_types_for_functions**](FunctionsDataTypesApi.md#generate_function_data_types_for_functions) | **POST** /v2/functions/data_types | Generate Function Data Types for an arbitrary list of functions -[**get_function_data_types**](FunctionsDataTypesApi.md#get_function_data_types) | **GET** /v2/analyses/{analysis_id}/functions/{function_id}/data_types | Get Function Data Types -[**get_function_data_types_0**](FunctionsDataTypesApi.md#get_function_data_types_0) | **GET** /v3/analyses/{analysis_id}/functions/{function_id}/data-types | Get data types for a single function +[**get_function_data_types**](FunctionsDataTypesApi.md#get_function_data_types) | **GET** /v3/analyses/{analysis_id}/functions/{function_id}/data-types | Get data types for a single function [**list_analysis_functions_data_types**](FunctionsDataTypesApi.md#list_analysis_functions_data_types) | **GET** /v3/analyses/{analysis_id}/functions/data-types | List data types for all functions in an analysis [**list_function_data_types_for_analysis**](FunctionsDataTypesApi.md#list_function_data_types_for_analysis) | **GET** /v2/analyses/{analysis_id}/functions/data_types | List Function Data Types [**list_function_data_types_for_functions**](FunctionsDataTypesApi.md#list_function_data_types_for_functions) | **GET** /v2/functions/data_types | List Function Data Types [**list_functions_data_types**](FunctionsDataTypesApi.md#list_functions_data_types) | **GET** /v3/functions/data-types | Get data types for many functions +[**update_function_data_types**](FunctionsDataTypesApi.md#update_function_data_types) | **PUT** /v2/analyses/{analysis_id}/functions/{function_id}/data_types | Update function data types # **batch_update_function_data_types** @@ -30,6 +30,7 @@ Updates data types for multiple functions in one analysis. All function IDs in t ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -55,6 +56,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -87,7 +93,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -117,6 +123,7 @@ Submits a request to generate the function data types ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -142,6 +149,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -174,7 +186,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -200,6 +212,7 @@ Submits a request to generate the function data types ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -225,6 +238,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -255,7 +273,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -272,19 +290,24 @@ 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_function_data_types** -> BaseResponseFunctionDataTypes get_function_data_types(analysis_id, function_id) +> DataTypesEntry get_function_data_types(analysis_id, function_id) -Get Function Data Types +Get data types for a single function -Polling endpoint which returns the current status of function generation and once completed the data type information +Returns the stored data-types blob for one function. The function must belong to the supplied analysis. + +**Error codes:** +- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied +- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai -from revengai.models.base_response_function_data_types import BaseResponseFunctionDataTypes +from revengai.models.data_types_entry import DataTypesEntry from revengai.rest import ApiException from pprint import pprint @@ -305,15 +328,20 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # 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.FunctionsDataTypesApi(api_client) - analysis_id = 56 # int | - function_id = 56 # int | + analysis_id = 56 # int | Analysis ID + function_id = 56 # int | Function ID try: - # Get Function Data Types + # Get data types for a single function api_response = api_instance.get_function_data_types(analysis_id, function_id) print("The response of FunctionsDataTypesApi->get_function_data_types:\n") pprint(api_response) @@ -328,16 +356,16 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **analysis_id** | **int**| | - **function_id** | **int**| | + **analysis_id** | **int**| Analysis ID | + **function_id** | **int**| Function ID | ### Return type -[**BaseResponseFunctionDataTypes**](BaseResponseFunctionDataTypes.md) +[**DataTypesEntry**](DataTypesEntry.md) ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -348,17 +376,20 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Invalid request parameters | - | +**200** | OK | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**422** | Unprocessable Entity | - | +**500** | Internal Server 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) -# **get_function_data_types_0** -> DataTypesEntry get_function_data_types_0(analysis_id, function_id) +# **list_analysis_functions_data_types** +> ListAnalysisFunctionsDataTypesOutputBody list_analysis_functions_data_types(analysis_id, offset=offset, limit=limit) -Get data types for a single function +List data types for all functions in an analysis -Returns the stored data-types blob for one function. The function must belong to the supplied analysis. +Paginated read of the stored data-types blob for each function in the analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied @@ -367,10 +398,11 @@ Returns the stored data-types blob for one function. The function must belong to ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai -from revengai.models.data_types_entry import DataTypesEntry +from revengai.models.list_analysis_functions_data_types_output_body import ListAnalysisFunctionsDataTypesOutputBody from revengai.rest import ApiException from pprint import pprint @@ -391,20 +423,26 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # 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.FunctionsDataTypesApi(api_client) analysis_id = 56 # int | Analysis ID - function_id = 56 # int | Function ID + offset = 56 # int | Pagination offset. Defaults to 0. (optional) + limit = 56 # int | Page size. Defaults to 100. (optional) try: - # Get data types for a single function - api_response = api_instance.get_function_data_types_0(analysis_id, function_id) - print("The response of FunctionsDataTypesApi->get_function_data_types_0:\n") + # List data types for all functions in an analysis + api_response = api_instance.list_analysis_functions_data_types(analysis_id, offset=offset, limit=limit) + print("The response of FunctionsDataTypesApi->list_analysis_functions_data_types:\n") pprint(api_response) except Exception as e: - print("Exception when calling FunctionsDataTypesApi->get_function_data_types_0: %s\n" % e) + print("Exception when calling FunctionsDataTypesApi->list_analysis_functions_data_types: %s\n" % e) ``` @@ -415,15 +453,16 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **analysis_id** | **int**| Analysis ID | - **function_id** | **int**| Function ID | + **offset** | **int**| Pagination offset. Defaults to 0. | [optional] + **limit** | **int**| Page size. Defaults to 100. | [optional] ### Return type -[**DataTypesEntry**](DataTypesEntry.md) +[**ListAnalysisFunctionsDataTypesOutputBody**](ListAnalysisFunctionsDataTypesOutputBody.md) ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -442,24 +481,21 @@ 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) -# **list_analysis_functions_data_types** -> ListAnalysisFunctionsDataTypesOutputBody list_analysis_functions_data_types(analysis_id, offset=offset, limit=limit) - -List data types for all functions in an analysis +# **list_function_data_types_for_analysis** +> BaseResponseFunctionDataTypesList list_function_data_types_for_analysis(analysis_id, function_ids=function_ids) -Paginated read of the stored data-types blob for each function in the analysis. +List Function Data Types -**Error codes:** -- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied -- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found +Returns data types for multiple functions with optional function ID filtering ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai -from revengai.models.list_analysis_functions_data_types_output_body import ListAnalysisFunctionsDataTypesOutputBody +from revengai.models.base_response_function_data_types_list import BaseResponseFunctionDataTypesList from revengai.rest import ApiException from pprint import pprint @@ -480,21 +516,25 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # 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.FunctionsDataTypesApi(api_client) - analysis_id = 56 # int | Analysis ID - offset = 56 # int | Pagination offset. Defaults to 0. (optional) - limit = 56 # int | Page size. Defaults to 100. (optional) + analysis_id = 56 # int | + function_ids = [56] # List[Optional[int]] | (optional) try: - # List data types for all functions in an analysis - api_response = api_instance.list_analysis_functions_data_types(analysis_id, offset=offset, limit=limit) - print("The response of FunctionsDataTypesApi->list_analysis_functions_data_types:\n") + # List Function Data Types + api_response = api_instance.list_function_data_types_for_analysis(analysis_id, function_ids=function_ids) + print("The response of FunctionsDataTypesApi->list_function_data_types_for_analysis:\n") pprint(api_response) except Exception as e: - print("Exception when calling FunctionsDataTypesApi->list_analysis_functions_data_types: %s\n" % e) + print("Exception when calling FunctionsDataTypesApi->list_function_data_types_for_analysis: %s\n" % e) ``` @@ -504,17 +544,16 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **analysis_id** | **int**| Analysis ID | - **offset** | **int**| Pagination offset. Defaults to 0. | [optional] - **limit** | **int**| Page size. Defaults to 100. | [optional] + **analysis_id** | **int**| | + **function_ids** | [**List[Optional[int]]**](int.md)| | [optional] ### Return type -[**ListAnalysisFunctionsDataTypesOutputBody**](ListAnalysisFunctionsDataTypesOutputBody.md) +[**BaseResponseFunctionDataTypesList**](BaseResponseFunctionDataTypesList.md) ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -525,24 +564,22 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | OK | - | -**403** | Forbidden | - | -**404** | Not Found | - | -**422** | Unprocessable Entity | - | -**500** | Internal Server Error | - | +**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) -# **list_function_data_types_for_analysis** -> BaseResponseFunctionDataTypesList list_function_data_types_for_analysis(analysis_id, function_ids=function_ids) +# **list_function_data_types_for_functions** +> BaseResponseFunctionDataTypesList list_function_data_types_for_functions(function_ids=function_ids) List Function Data Types -Returns data types for multiple functions with optional function ID filtering +Returns data types for multiple function IDs ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -567,20 +604,24 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # 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.FunctionsDataTypesApi(api_client) - analysis_id = 56 # int | function_ids = [56] # List[Optional[int]] | (optional) try: # List Function Data Types - api_response = api_instance.list_function_data_types_for_analysis(analysis_id, function_ids=function_ids) - print("The response of FunctionsDataTypesApi->list_function_data_types_for_analysis:\n") + api_response = api_instance.list_function_data_types_for_functions(function_ids=function_ids) + print("The response of FunctionsDataTypesApi->list_function_data_types_for_functions:\n") pprint(api_response) except Exception as e: - print("Exception when calling FunctionsDataTypesApi->list_function_data_types_for_analysis: %s\n" % e) + print("Exception when calling FunctionsDataTypesApi->list_function_data_types_for_functions: %s\n" % e) ``` @@ -590,7 +631,6 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **analysis_id** | **int**| | **function_ids** | [**List[Optional[int]]**](int.md)| | [optional] ### Return type @@ -599,7 +639,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -615,20 +655,26 @@ 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) -# **list_function_data_types_for_functions** -> BaseResponseFunctionDataTypesList list_function_data_types_for_functions(function_ids=function_ids) +# **list_functions_data_types** +> ListFunctionsDataTypesOutputBody list_functions_data_types(function_ids) -List Function Data Types +Get data types for many functions -Returns data types for multiple function IDs +Returns the stored data-types blob for each supplied function ID. Caller must have read access to every function or the request is rejected. + +**Error codes:** +- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied +- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found +- `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai -from revengai.models.base_response_function_data_types_list import BaseResponseFunctionDataTypesList +from revengai.models.list_functions_data_types_output_body import ListFunctionsDataTypesOutputBody from revengai.rest import ApiException from pprint import pprint @@ -649,19 +695,24 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # 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.FunctionsDataTypesApi(api_client) - function_ids = [56] # List[Optional[int]] | (optional) + function_ids = [56] # List[int] | Function IDs to fetch data-types for. try: - # List Function Data Types - api_response = api_instance.list_function_data_types_for_functions(function_ids=function_ids) - print("The response of FunctionsDataTypesApi->list_function_data_types_for_functions:\n") + # Get data types for many functions + api_response = api_instance.list_functions_data_types(function_ids) + print("The response of FunctionsDataTypesApi->list_functions_data_types:\n") pprint(api_response) except Exception as e: - print("Exception when calling FunctionsDataTypesApi->list_function_data_types_for_functions: %s\n" % e) + print("Exception when calling FunctionsDataTypesApi->list_functions_data_types: %s\n" % e) ``` @@ -671,15 +722,15 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **function_ids** | [**List[Optional[int]]**](int.md)| | [optional] + **function_ids** | [**List[int]**](int.md)| Function IDs to fetch data-types for. | ### Return type -[**BaseResponseFunctionDataTypesList**](BaseResponseFunctionDataTypesList.md) +[**ListFunctionsDataTypesOutputBody**](ListFunctionsDataTypesOutputBody.md) ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -690,30 +741,37 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Successful Response | - | -**422** | Invalid request parameters | - | +**200** | OK | - | +**400** | Bad Request | - | +**403** | Forbidden | - | +**404** | Not Found | - | +**422** | Unprocessable Entity | - | +**500** | Internal Server 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) -# **list_functions_data_types** -> ListFunctionsDataTypesOutputBody list_functions_data_types(function_ids) +# **update_function_data_types** +> UpdateDataTypesOutputBody update_function_data_types(analysis_id, function_id, update_data_types_input_body) -Get data types for many functions +Update function data types -Returns the stored data-types blob for each supplied function ID. Caller must have read access to every function or the request is rejected. +Stores user-specific overrides for a function's data types. Uses optimistic concurrency: if the stored version doesn't match `data_types_version`, the update is rejected with 409. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request +- `409` [`CONFLICT`](/errors/CONFLICT) — Conflict ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai -from revengai.models.list_functions_data_types_output_body import ListFunctionsDataTypesOutputBody +from revengai.models.update_data_types_input_body import UpdateDataTypesInputBody +from revengai.models.update_data_types_output_body import UpdateDataTypesOutputBody from revengai.rest import ApiException from pprint import pprint @@ -734,19 +792,26 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # 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.FunctionsDataTypesApi(api_client) - function_ids = [56] # List[int] | Function IDs to fetch data-types for. + analysis_id = 56 # int | Analysis ID + function_id = 56 # int | Function ID + update_data_types_input_body = revengai.UpdateDataTypesInputBody() # UpdateDataTypesInputBody | try: - # Get data types for many functions - api_response = api_instance.list_functions_data_types(function_ids) - print("The response of FunctionsDataTypesApi->list_functions_data_types:\n") + # Update function data types + api_response = api_instance.update_function_data_types(analysis_id, function_id, update_data_types_input_body) + print("The response of FunctionsDataTypesApi->update_function_data_types:\n") pprint(api_response) except Exception as e: - print("Exception when calling FunctionsDataTypesApi->list_functions_data_types: %s\n" % e) + print("Exception when calling FunctionsDataTypesApi->update_function_data_types: %s\n" % e) ``` @@ -756,19 +821,21 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **function_ids** | [**List[int]**](int.md)| Function IDs to fetch data-types for. | + **analysis_id** | **int**| Analysis ID | + **function_id** | **int**| Function ID | + **update_data_types_input_body** | [**UpdateDataTypesInputBody**](UpdateDataTypesInputBody.md)| | ### Return type -[**ListFunctionsDataTypesOutputBody**](ListFunctionsDataTypesOutputBody.md) +[**UpdateDataTypesOutputBody**](UpdateDataTypesOutputBody.md) ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details @@ -779,6 +846,7 @@ Name | Type | Description | Notes **400** | Bad Request | - | **403** | Forbidden | - | **404** | Not Found | - | +**409** | Conflict | - | **422** | Unprocessable Entity | - | **500** | Internal Server Error | - | diff --git a/docs/FunctionsRenamingHistoryApi.md b/docs/FunctionsRenamingHistoryApi.md index 2c778df..28f0538 100644 --- a/docs/FunctionsRenamingHistoryApi.md +++ b/docs/FunctionsRenamingHistoryApi.md @@ -25,6 +25,7 @@ Renames a list of functions using the function IDs ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -50,6 +51,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -80,7 +86,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -110,6 +116,7 @@ Renames multiple functions in a single request. Records name changes in history ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -135,6 +142,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -165,7 +177,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -198,6 +210,7 @@ Returns the name change history for a function, newest first. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -222,6 +235,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -252,7 +270,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -281,6 +299,7 @@ Gets the name history of a function using the function ID ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -305,6 +324,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -335,7 +359,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -365,6 +389,7 @@ Renames a single function and records the change in history. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -390,6 +415,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -422,7 +452,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -452,6 +482,7 @@ Renames a function using the function ID ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -477,6 +508,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -509,7 +545,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -535,6 +571,7 @@ Reverts the function name to a previous name using the function ID and history I ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -559,6 +596,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -591,7 +633,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -621,6 +663,7 @@ Reverts a function's name to a previous value from its history. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -644,6 +687,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -676,7 +724,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/IAMUsersApi.md b/docs/IAMUsersApi.md index 474ba92..9b10bfd 100644 --- a/docs/IAMUsersApi.md +++ b/docs/IAMUsersApi.md @@ -20,7 +20,7 @@ Returns the authenticated user's own information. ### Example -* Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -39,11 +39,10 @@ configuration = revengai.Configuration( # 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: @@ -71,7 +70,7 @@ This endpoint does not need any parameter. ### Authorization -[APIKey](../README.md#APIKey) +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -97,7 +96,7 @@ Returns the feature permissions granted to the authenticated user based on their ### Example -* Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -116,11 +115,10 @@ configuration = revengai.Configuration( # 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: @@ -148,7 +146,7 @@ This endpoint does not need any parameter. ### Authorization -[APIKey](../README.md#APIKey) +[bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/MatchedFunction.md b/docs/MatchedFunction.md index 0f9986b..16e557f 100644 --- a/docs/MatchedFunction.md +++ b/docs/MatchedFunction.md @@ -5,17 +5,17 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**function_id** | **int** | Unique identifier of the matched function | -**binary_id** | **int** | | -**function_name** | **str** | | -**function_vaddr** | **int** | | -**mangled_name** | **str** | | -**debug** | **bool** | | -**binary_name** | **str** | | -**sha_256_hash** | **str** | | -**analysis_id** | **int** | | -**similarity** | **float** | | [optional] -**confidence** | **float** | | [optional] +**analysis_id** | **int** | Analysis the candidate's binary belongs to | +**binary_id** | **int** | Binary the candidate belongs to | +**binary_name** | **str** | Binary name | +**confidence** | **float** | Softmax-normalised confidence over the candidate pool | +**debug** | **bool** | Whether the candidate's name came from debug info | +**function_id** | **int** | Candidate function ID | +**function_name** | **str** | Candidate function name | +**function_vaddr** | **int** | Candidate's virtual address inside its binary | +**mangled_name** | **str** | Mangled name when available | +**sha_256_hash** | **str** | SHA-256 of the candidate's binary | +**similarity** | **float** | Cosine similarity scaled to a percentage | ## Example diff --git a/docs/ModelsApi.md b/docs/ModelsApi.md index bf596f4..a4399db 100644 --- a/docs/ModelsApi.md +++ b/docs/ModelsApi.md @@ -17,6 +17,7 @@ Gets active models available for analysis. ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -41,6 +42,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -67,7 +73,7 @@ This endpoint does not need any parameter. ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/NameConfidence.md b/docs/NameConfidence.md index 5b8342c..1152eb0 100644 --- a/docs/NameConfidence.md +++ b/docs/NameConfidence.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **str** | The suggested function name | -**confidence** | **float** | Confidence score as a percentage | +**confidence** | **float** | Softmax-normalised confidence for this name | +**name** | **str** | Candidate name | ## Example diff --git a/docs/ReportsApi.md b/docs/ReportsApi.md index 5b6d452..039c0d6 100644 --- a/docs/ReportsApi.md +++ b/docs/ReportsApi.md @@ -23,6 +23,7 @@ Starts an asynchronous PDF report generation workflow for the given analysis. Po ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -47,6 +48,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -77,7 +83,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -112,6 +118,7 @@ Streams the rendered PDF report. Returns 409 when the workflow is still running ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -135,6 +142,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -163,7 +175,7 @@ void (empty response body) ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -197,6 +209,7 @@ Returns live workflow progress for the given analysis. Returns 404 when no repor ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -221,6 +234,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -251,7 +269,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/SearchApi.md b/docs/SearchApi.md index bc2dfb3..591bb0a 100644 --- a/docs/SearchApi.md +++ b/docs/SearchApi.md @@ -20,6 +20,7 @@ Searches for a specific binary ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -44,6 +45,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -88,7 +94,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -114,6 +120,7 @@ Searches for a specific collection ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -141,6 +148,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -189,7 +201,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -216,6 +228,7 @@ Searches for a specific function ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -240,6 +253,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -276,7 +294,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers @@ -302,6 +320,7 @@ Searches for tags by there name ### Example * Api Key Authentication (APIKey): +* Bearer Authentication (bearerAuth): ```python import revengai @@ -326,6 +345,11 @@ 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' +# Configure Bearer authorization: bearerAuth +configuration = revengai.Configuration( + access_token = os.environ["BEARER_TOKEN"] +) + # Enter a context with an instance of the API client with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class @@ -360,7 +384,7 @@ Name | Type | Description | Notes ### Authorization -[APIKey](../README.md#APIKey) +[APIKey](../README.md#APIKey), [bearerAuth](../README.md#bearerAuth) ### HTTP request headers diff --git a/docs/UpdateProfileInputBody.md b/docs/UpdateProfileInputBody.md index 939f63f..a4e78ac 100644 --- a/docs/UpdateProfileInputBody.md +++ b/docs/UpdateProfileInputBody.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **default_team_id** | **int** | Default team ID | [optional] **first_name** | **str** | First name | [optional] +**hide_example_binaries** | **bool** | Hide the Examples tab in the analyses listing | [optional] **last_name** | **str** | Last name | [optional] **time_zone** | **str** | IANA time zone | [optional] **username** | **str** | Username | [optional] diff --git a/docs/UserProfile.md b/docs/UserProfile.md index 20e43b4..62360ab 100644 --- a/docs/UserProfile.md +++ b/docs/UserProfile.md @@ -7,6 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **default_team_id** | **int** | | [optional] **first_name** | **str** | | +**hide_example_binaries** | **bool** | | **last_name** | **str** | | **time_zone** | **str** | | **username** | **str** | | diff --git a/docs/V2FunctionHeader.md b/docs/V2FunctionHeader.md new file mode 100644 index 0000000..7ce2aa8 --- /dev/null +++ b/docs/V2FunctionHeader.md @@ -0,0 +1,33 @@ +# V2FunctionHeader + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**last_change** | **str** | | [optional] +**name** | **str** | Name of the function | +**addr** | **int** | Memory address of the function | +**type** | **str** | Return type of the function | +**args** | [**Dict[str, Argument]**](Argument.md) | Dictionary of function arguments | + +## Example + +```python +from revengai.models.v2_function_header import V2FunctionHeader + +# TODO update the JSON string below +json = "{}" +# create an instance of V2FunctionHeader from a JSON string +v2_function_header_instance = V2FunctionHeader.from_json(json) +# print the JSON string representation of the object +print(V2FunctionHeader.to_json()) + +# convert the object into a dict +v2_function_header_dict = v2_function_header_instance.to_dict() +# create an instance of V2FunctionHeader from a dict +v2_function_header_from_dict = V2FunctionHeader.from_dict(v2_function_header_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) + + diff --git a/docs/V2FunctionInfo.md b/docs/V2FunctionInfo.md new file mode 100644 index 0000000..5336003 --- /dev/null +++ b/docs/V2FunctionInfo.md @@ -0,0 +1,30 @@ +# V2FunctionInfo + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**func_types** | [**V2FunctionType**](V2FunctionType.md) | | [optional] +**func_deps** | [**List[V2FunctionInfoFuncDepsInner]**](V2FunctionInfoFuncDepsInner.md) | List of function dependencies | + +## Example + +```python +from revengai.models.v2_function_info import V2FunctionInfo + +# TODO update the JSON string below +json = "{}" +# create an instance of V2FunctionInfo from a JSON string +v2_function_info_instance = V2FunctionInfo.from_json(json) +# print the JSON string representation of the object +print(V2FunctionInfo.to_json()) + +# convert the object into a dict +v2_function_info_dict = v2_function_info_instance.to_dict() +# create an instance of V2FunctionInfo from a dict +v2_function_info_from_dict = V2FunctionInfo.from_dict(v2_function_info_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) + + diff --git a/docs/FunctionInfoFuncDepsInner.md b/docs/V2FunctionInfoFuncDepsInner.md similarity index 60% rename from docs/FunctionInfoFuncDepsInner.md rename to docs/V2FunctionInfoFuncDepsInner.md index 4d728a2..7529ac2 100644 --- a/docs/FunctionInfoFuncDepsInner.md +++ b/docs/V2FunctionInfoFuncDepsInner.md @@ -1,4 +1,4 @@ -# FunctionInfoFuncDepsInner +# V2FunctionInfoFuncDepsInner ## Properties @@ -16,19 +16,19 @@ Name | Type | Description | Notes ## Example ```python -from revengai.models.function_info_func_deps_inner import FunctionInfoFuncDepsInner +from revengai.models.v2_function_info_func_deps_inner import V2FunctionInfoFuncDepsInner # TODO update the JSON string below json = "{}" -# create an instance of FunctionInfoFuncDepsInner from a JSON string -function_info_func_deps_inner_instance = FunctionInfoFuncDepsInner.from_json(json) +# create an instance of V2FunctionInfoFuncDepsInner from a JSON string +v2_function_info_func_deps_inner_instance = V2FunctionInfoFuncDepsInner.from_json(json) # print the JSON string representation of the object -print(FunctionInfoFuncDepsInner.to_json()) +print(V2FunctionInfoFuncDepsInner.to_json()) # convert the object into a dict -function_info_func_deps_inner_dict = function_info_func_deps_inner_instance.to_dict() -# create an instance of FunctionInfoFuncDepsInner from a dict -function_info_func_deps_inner_from_dict = FunctionInfoFuncDepsInner.from_dict(function_info_func_deps_inner_dict) +v2_function_info_func_deps_inner_dict = v2_function_info_func_deps_inner_instance.to_dict() +# create an instance of V2FunctionInfoFuncDepsInner from a dict +v2_function_info_func_deps_inner_from_dict = V2FunctionInfoFuncDepsInner.from_dict(v2_function_info_func_deps_inner_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) diff --git a/docs/V2FunctionMatch.md b/docs/V2FunctionMatch.md new file mode 100644 index 0000000..397e47c --- /dev/null +++ b/docs/V2FunctionMatch.md @@ -0,0 +1,31 @@ +# V2FunctionMatch + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**function_id** | **int** | Unique identifier of the function | +**matched_functions** | [**List[V2MatchedFunction]**](V2MatchedFunction.md) | | +**confidences** | [**List[V2NameConfidence]**](V2NameConfidence.md) | | [optional] + +## Example + +```python +from revengai.models.v2_function_match import V2FunctionMatch + +# TODO update the JSON string below +json = "{}" +# create an instance of V2FunctionMatch from a JSON string +v2_function_match_instance = V2FunctionMatch.from_json(json) +# print the JSON string representation of the object +print(V2FunctionMatch.to_json()) + +# convert the object into a dict +v2_function_match_dict = v2_function_match_instance.to_dict() +# create an instance of V2FunctionMatch from a dict +v2_function_match_from_dict = V2FunctionMatch.from_dict(v2_function_match_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) + + diff --git a/docs/V2FunctionType.md b/docs/V2FunctionType.md new file mode 100644 index 0000000..f0f7974 --- /dev/null +++ b/docs/V2FunctionType.md @@ -0,0 +1,36 @@ +# V2FunctionType + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**last_change** | **str** | | [optional] +**addr** | **int** | Memory address of the function | +**size** | **int** | Size of the function in bytes | +**header** | [**V2FunctionHeader**](V2FunctionHeader.md) | Function header information | +**stack_vars** | [**Dict[str, StackVariable]**](StackVariable.md) | | [optional] +**name** | **str** | Name of the function | +**type** | **str** | Return type of the function | +**artifact_type** | **str** | Type of artifact that the structure is associated with | [optional] [default to 'Function'] + +## Example + +```python +from revengai.models.v2_function_type import V2FunctionType + +# TODO update the JSON string below +json = "{}" +# create an instance of V2FunctionType from a JSON string +v2_function_type_instance = V2FunctionType.from_json(json) +# print the JSON string representation of the object +print(V2FunctionType.to_json()) + +# convert the object into a dict +v2_function_type_dict = v2_function_type_instance.to_dict() +# create an instance of V2FunctionType from a dict +v2_function_type_from_dict = V2FunctionType.from_dict(v2_function_type_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) + + diff --git a/docs/V2MatchedFunction.md b/docs/V2MatchedFunction.md new file mode 100644 index 0000000..884a84a --- /dev/null +++ b/docs/V2MatchedFunction.md @@ -0,0 +1,39 @@ +# V2MatchedFunction + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**function_id** | **int** | Unique identifier of the matched function | +**binary_id** | **int** | | +**function_name** | **str** | | +**function_vaddr** | **int** | | +**mangled_name** | **str** | | +**debug** | **bool** | | +**binary_name** | **str** | | +**sha_256_hash** | **str** | | +**analysis_id** | **int** | | +**similarity** | **float** | | [optional] +**confidence** | **float** | | [optional] + +## Example + +```python +from revengai.models.v2_matched_function import V2MatchedFunction + +# TODO update the JSON string below +json = "{}" +# create an instance of V2MatchedFunction from a JSON string +v2_matched_function_instance = V2MatchedFunction.from_json(json) +# print the JSON string representation of the object +print(V2MatchedFunction.to_json()) + +# convert the object into a dict +v2_matched_function_dict = v2_matched_function_instance.to_dict() +# create an instance of V2MatchedFunction from a dict +v2_matched_function_from_dict = V2MatchedFunction.from_dict(v2_matched_function_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) + + diff --git a/docs/V2NameConfidence.md b/docs/V2NameConfidence.md new file mode 100644 index 0000000..231621f --- /dev/null +++ b/docs/V2NameConfidence.md @@ -0,0 +1,30 @@ +# V2NameConfidence + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | The suggested function name | +**confidence** | **float** | Confidence score as a percentage | + +## Example + +```python +from revengai.models.v2_name_confidence import V2NameConfidence + +# TODO update the JSON string below +json = "{}" +# create an instance of V2NameConfidence from a JSON string +v2_name_confidence_instance = V2NameConfidence.from_json(json) +# print the JSON string representation of the object +print(V2NameConfidence.to_json()) + +# convert the object into a dict +v2_name_confidence_dict = v2_name_confidence_instance.to_dict() +# create an instance of V2NameConfidence from a dict +v2_name_confidence_from_dict = V2NameConfidence.from_dict(v2_name_confidence_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) + + diff --git a/revengai/__init__.py b/revengai/__init__.py index 45dff9b..f60aa0b 100644 --- a/revengai/__init__.py +++ b/revengai/__init__.py @@ -317,7 +317,6 @@ "FunctionDetailsOutputBody", "FunctionHeader", "FunctionInfo", - "FunctionInfoFuncDepsInner", "FunctionListItem", "FunctionLocalVariableResponse", "FunctionMapping", @@ -533,6 +532,13 @@ "UserCredits", "UserIdentity", "UserProfile", + "V2FunctionHeader", + "V2FunctionInfo", + "V2FunctionInfoFuncDepsInner", + "V2FunctionMatch", + "V2FunctionType", + "V2MatchedFunction", + "V2NameConfidence", "Vulnerabilities", "Vulnerability", "WarningEvent", @@ -848,7 +854,6 @@ from revengai.models.function_details_output_body import FunctionDetailsOutputBody as FunctionDetailsOutputBody from revengai.models.function_header import FunctionHeader as FunctionHeader from revengai.models.function_info import FunctionInfo as FunctionInfo -from revengai.models.function_info_func_deps_inner import FunctionInfoFuncDepsInner as FunctionInfoFuncDepsInner from revengai.models.function_list_item import FunctionListItem as FunctionListItem from revengai.models.function_local_variable_response import FunctionLocalVariableResponse as FunctionLocalVariableResponse from revengai.models.function_mapping import FunctionMapping as FunctionMapping @@ -1064,6 +1069,13 @@ from revengai.models.user_credits import UserCredits as UserCredits from revengai.models.user_identity import UserIdentity as UserIdentity from revengai.models.user_profile import UserProfile as UserProfile +from revengai.models.v2_function_header import V2FunctionHeader as V2FunctionHeader +from revengai.models.v2_function_info import V2FunctionInfo as V2FunctionInfo +from revengai.models.v2_function_info_func_deps_inner import V2FunctionInfoFuncDepsInner as V2FunctionInfoFuncDepsInner +from revengai.models.v2_function_match import V2FunctionMatch as V2FunctionMatch +from revengai.models.v2_function_type import V2FunctionType as V2FunctionType +from revengai.models.v2_matched_function import V2MatchedFunction as V2MatchedFunction +from revengai.models.v2_name_confidence import V2NameConfidence as V2NameConfidence from revengai.models.vulnerabilities import Vulnerabilities as Vulnerabilities from revengai.models.vulnerability import Vulnerability as Vulnerability from revengai.models.warning_event import WarningEvent as WarningEvent diff --git a/revengai/api/agent_api.py b/revengai/api/agent_api.py index d62da00..4c73bd5 100644 --- a/revengai/api/agent_api.py +++ b/revengai/api/agent_api.py @@ -281,7 +281,8 @@ def _check_capabilities_task_status_v2_analyses_analysis_id_agent_capabilities_s # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -542,7 +543,8 @@ def _check_report_analysis_task_status_v2_analyses_analysis_id_agent_report_anal # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -803,7 +805,8 @@ def _check_triage_task_status_v2_analyses_analysis_id_agent_triage_status_get_se # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1064,7 +1067,8 @@ def _create_capabilities_task_v2_analyses_analysis_id_agent_capabilities_post_se # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1328,7 +1332,8 @@ def _create_report_analysis_task_v2_analyses_analysis_id_agent_report_analysis_p # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1589,7 +1594,8 @@ def _create_triage_task_v2_analyses_analysis_id_agent_triage_post_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1850,7 +1856,8 @@ def _get_capabilities_result_v2_analyses_analysis_id_agent_capabilities_get_seri # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2114,7 +2121,8 @@ def _get_report_analysis_result_v2_analyses_analysis_id_agent_report_analysis_ge # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2375,7 +2383,8 @@ def _get_triage_result_v2_analyses_analysis_id_agent_triage_get_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/analyses_bulk_actions_api.py b/revengai/api/analyses_bulk_actions_api.py index ff44e90..294c4e8 100644 --- a/revengai/api/analyses_bulk_actions_api.py +++ b/revengai/api/analyses_bulk_actions_api.py @@ -294,7 +294,8 @@ def _bulk_add_analysis_tags_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -577,7 +578,8 @@ def _bulk_delete_analyses_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/analyses_comments_api.py b/revengai/api/analyses_comments_api.py index 9445dcd..fa81c73 100644 --- a/revengai/api/analyses_comments_api.py +++ b/revengai/api/analyses_comments_api.py @@ -315,7 +315,8 @@ def _create_analysis_comment_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -600,7 +601,8 @@ def _delete_analysis_comment_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -864,7 +866,8 @@ def _get_analysis_comments_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1177,7 +1180,8 @@ def _update_analysis_comment_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/analyses_core_api.py b/revengai/api/analyses_core_api.py index 7a91334..78c6714 100644 --- a/revengai/api/analyses_core_api.py +++ b/revengai/api/analyses_core_api.py @@ -354,7 +354,8 @@ def _add_user_string_to_analysis_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -652,7 +653,8 @@ def _create_analysis_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -922,7 +924,8 @@ def _delete_analysis_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1189,7 +1192,8 @@ def _get_analysis_basic_info_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1462,7 +1466,8 @@ def _get_analysis_basic_info_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1755,7 +1760,8 @@ def _get_analysis_bytes_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2019,7 +2025,8 @@ def _get_analysis_function_map_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2292,7 +2299,8 @@ def _get_analysis_function_matches_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2565,7 +2573,8 @@ def _get_analysis_function_matching_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2829,7 +2838,8 @@ def _get_analysis_logs_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3093,7 +3103,8 @@ def _get_analysis_params_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3357,7 +3368,8 @@ def _get_analysis_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3630,7 +3642,8 @@ def _get_dynamic_execution_report_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3900,7 +3913,8 @@ def _get_dynamic_execution_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4192,7 +4206,8 @@ def _insert_analysis_log_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4632,7 +4647,8 @@ def _list_analyses_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4896,7 +4912,8 @@ def _lookup_binary_id_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -5188,7 +5205,8 @@ def _put_analysis_strings_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -5501,7 +5519,8 @@ def _requeue_analysis_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -5805,7 +5824,8 @@ def _start_analysis_function_matching_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -6097,7 +6117,8 @@ def _update_analysis_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -6389,7 +6410,8 @@ def _update_analysis_tags_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -6710,7 +6732,8 @@ def _upload_file_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -7085,7 +7108,8 @@ def _v3_get_analysis_strings_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -7358,7 +7382,8 @@ def _v3_get_analysis_strings_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -7604,7 +7629,8 @@ def _v3_list_example_analyses_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/analyses_results_metadata_api.py b/revengai/api/analyses_results_metadata_api.py index e52e09a..4f2098b 100644 --- a/revengai/api/analyses_results_metadata_api.py +++ b/revengai/api/analyses_results_metadata_api.py @@ -323,7 +323,8 @@ def _get_analysis_functions_paginated_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -584,7 +585,8 @@ def _get_capabilities_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -953,7 +955,8 @@ def _get_functions_list_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1214,7 +1217,8 @@ def _get_sbom_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1475,7 +1479,8 @@ def _get_tags_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1736,7 +1741,8 @@ def _get_vulnerabilities_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/analyses_x_refs_api.py b/revengai/api/analyses_x_refs_api.py index d6ad56c..2f86092 100644 --- a/revengai/api/analyses_x_refs_api.py +++ b/revengai/api/analyses_x_refs_api.py @@ -298,7 +298,8 @@ def _get_xref_by_vaddr_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/authentication_users_api.py b/revengai/api/authentication_users_api.py index d0f154c..8d9bac6 100644 --- a/revengai/api/authentication_users_api.py +++ b/revengai/api/authentication_users_api.py @@ -279,7 +279,8 @@ def _get_user_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -525,7 +526,8 @@ def _get_user_activity_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -802,7 +804,8 @@ def _submit_user_feedback_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/binaries_api.py b/revengai/api/binaries_api.py index f0e4652..9bbee44 100644 --- a/revengai/api/binaries_api.py +++ b/revengai/api/binaries_api.py @@ -287,7 +287,8 @@ def _download_zipped_binary_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -551,7 +552,8 @@ def _get_binary_additional_details_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -824,7 +826,8 @@ def _get_binary_additional_details_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1088,7 +1091,8 @@ def _get_binary_additional_details_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1361,7 +1365,8 @@ def _get_binary_additional_details_status_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1622,7 +1627,8 @@ def _get_binary_details_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1883,7 +1889,8 @@ def _get_binary_die_info_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2144,7 +2151,8 @@ def _get_binary_externals_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2405,7 +2413,8 @@ def _get_binary_related_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2669,7 +2678,8 @@ def _get_related_binaries_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/collections_api.py b/revengai/api/collections_api.py index e5cc9a5..76075ef 100644 --- a/revengai/api/collections_api.py +++ b/revengai/api/collections_api.py @@ -318,7 +318,8 @@ def _create_collection_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -585,7 +586,8 @@ def _delete_collection_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -937,7 +939,8 @@ def _get_collection_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1292,7 +1295,8 @@ def _list_collections_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1587,7 +1591,8 @@ def _update_collection_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1882,7 +1887,8 @@ def _update_collection_binaries_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2177,7 +2183,8 @@ def _update_collection_tags_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2460,7 +2467,8 @@ def _v3_create_collection_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2736,7 +2744,8 @@ def _v3_delete_collection_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3091,7 +3100,8 @@ def _v3_get_collection_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3446,7 +3456,8 @@ def _v3_list_collections_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3747,7 +3758,8 @@ def _v3_patch_collection_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4048,7 +4060,8 @@ def _v3_patch_collection_binaries_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4349,7 +4362,8 @@ def _v3_patch_collection_tags_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/config_api.py b/revengai/api/config_api.py index 2ceb3bb..c5be2b1 100644 --- a/revengai/api/config_api.py +++ b/revengai/api/config_api.py @@ -263,7 +263,8 @@ def _get_config_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/conversations_api.py b/revengai/api/conversations_api.py index 97a4374..0efaec3 100644 --- a/revengai/api/conversations_api.py +++ b/revengai/api/conversations_api.py @@ -297,7 +297,8 @@ def _cancel_run_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -598,7 +599,8 @@ def _confirm_tool_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -881,7 +883,8 @@ def _create_conversation_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1154,7 +1157,8 @@ def _get_conversation_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1400,7 +1404,8 @@ def _list_conversations_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1710,7 +1715,8 @@ def _send_message_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1989,7 +1995,8 @@ def _stream_events_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/external_sources_api.py b/revengai/api/external_sources_api.py index 5c483a3..c130ca4 100644 --- a/revengai/api/external_sources_api.py +++ b/revengai/api/external_sources_api.py @@ -281,7 +281,8 @@ def _create_external_task_vt_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -545,7 +546,8 @@ def _get_vt_data_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -806,7 +808,8 @@ def _get_vt_task_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/firmware_api.py b/revengai/api/firmware_api.py index 573b21d..557468b 100644 --- a/revengai/api/firmware_api.py +++ b/revengai/api/firmware_api.py @@ -279,7 +279,8 @@ def _get_binaries_for_firmware_task_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -574,7 +575,8 @@ def _upload_firmware_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/functions_ai_decompilation_api.py b/revengai/api/functions_ai_decompilation_api.py index c2e4f30..fa6e6c1 100644 --- a/revengai/api/functions_ai_decompilation_api.py +++ b/revengai/api/functions_ai_decompilation_api.py @@ -343,7 +343,8 @@ def _create_ai_decompilation_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -631,7 +632,8 @@ def _delete_ai_decompilation_inline_comment_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -904,7 +906,8 @@ def _get_ai_decompilation_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1177,7 +1180,8 @@ def _get_ai_decompilation_inline_comments_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1450,7 +1454,8 @@ def _get_ai_decompilation_inline_comments_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1711,7 +1716,8 @@ def _get_ai_decompilation_rating_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1984,7 +1990,8 @@ def _get_ai_decompilation_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2257,7 +2264,8 @@ def _get_ai_decompilation_summary_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2530,7 +2538,8 @@ def _get_ai_decompilation_summary_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2803,7 +2812,8 @@ def _get_ai_decompilation_tokenised_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3104,7 +3114,8 @@ def _patch_ai_decompilation_inline_comment_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3377,7 +3388,8 @@ def _regenerate_ai_decompilation_inline_comments_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3650,7 +3662,8 @@ def _regenerate_ai_decompilation_summary_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3912,7 +3925,8 @@ def _stream_ai_decompilation_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4216,7 +4230,8 @@ def _upsert_ai_decompilation_overrides_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4505,7 +4520,8 @@ def _upsert_ai_decompilation_rating_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/functions_core_api.py b/revengai/api/functions_core_api.py index 0c560a3..0271493 100644 --- a/revengai/api/functions_core_api.py +++ b/revengai/api/functions_core_api.py @@ -346,7 +346,8 @@ def _add_function_callee_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -647,7 +648,8 @@ def _add_user_string_to_function_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -942,7 +944,8 @@ def _ai_unstrip_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1237,7 +1240,8 @@ def _analysis_function_matching_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1532,7 +1536,8 @@ def _auto_unstrip_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1812,7 +1817,8 @@ def _batch_function_matching_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2079,7 +2085,8 @@ def _cancel_ai_unstrip_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2346,7 +2353,8 @@ def _cancel_auto_unstrip_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2715,7 +2723,8 @@ def _get_analysis_strings_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2982,7 +2991,8 @@ def _get_analysis_strings_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3252,7 +3262,8 @@ def _get_function_blocks_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3525,7 +3536,8 @@ def _get_function_blocks_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -3789,7 +3801,8 @@ def _get_function_callees_callers_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4062,7 +4075,8 @@ def _get_function_callees_callers_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4329,7 +4343,8 @@ def _get_function_callees_callers_bulk_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4596,7 +4611,8 @@ def _get_function_capabilities_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -4869,7 +4885,8 @@ def _get_function_capabilities_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -5133,7 +5150,8 @@ def _get_function_details_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -5406,7 +5424,8 @@ def _get_function_details_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -5724,7 +5743,8 @@ def _get_function_strings_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -6048,7 +6068,8 @@ def _get_function_strings_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -6327,7 +6348,8 @@ def _get_functions_callees_callers_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -6606,7 +6628,8 @@ def _get_functions_matches_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -6885,7 +6908,8 @@ def _get_functions_matching_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -7192,7 +7216,8 @@ def _list_analysis_functions_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -7481,7 +7506,8 @@ def _start_functions_matching_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/functions_data_types_api.py b/revengai/api/functions_data_types_api.py index 26cfe38..8f5f23e 100644 --- a/revengai/api/functions_data_types_api.py +++ b/revengai/api/functions_data_types_api.py @@ -18,7 +18,6 @@ from pydantic import Field, StrictInt from typing import List, Optional from typing_extensions import Annotated -from revengai.models.base_response_function_data_types import BaseResponseFunctionDataTypes from revengai.models.base_response_function_data_types_list import BaseResponseFunctionDataTypesList from revengai.models.base_response_generate_function_data_types import BaseResponseGenerateFunctionDataTypes from revengai.models.base_response_generation_status_list import BaseResponseGenerationStatusList @@ -28,6 +27,8 @@ from revengai.models.function_data_types_params import FunctionDataTypesParams from revengai.models.list_analysis_functions_data_types_output_body import ListAnalysisFunctionsDataTypesOutputBody from revengai.models.list_functions_data_types_output_body import ListFunctionsDataTypesOutputBody +from revengai.models.update_data_types_input_body import UpdateDataTypesInputBody +from revengai.models.update_data_types_output_body import UpdateDataTypesOutputBody from revengai.api_client import ApiClient, RequestSerialized from revengai.api_response import ApiResponse @@ -330,7 +331,8 @@ def _batch_update_function_data_types_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -622,7 +624,8 @@ def _generate_function_data_types_for_analysis_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -899,7 +902,8 @@ def _generate_function_data_types_for_functions_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -923,8 +927,8 @@ def _generate_function_data_types_for_functions_serialize( @validate_call def get_function_data_types( self, - analysis_id: StrictInt, - function_id: StrictInt, + analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], + function_id: Annotated[int, Field(strict=True, ge=1, description="Function ID")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -937,14 +941,14 @@ def get_function_data_types( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> BaseResponseFunctionDataTypes: - """(Deprecated) Get Function Data Types + ) -> DataTypesEntry: + """Get data types for a single function - Polling endpoint which returns the current status of function generation and once completed the data type information + Returns the stored data-types blob for one function. The function must belong to the supplied analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - :param analysis_id: (required) + :param analysis_id: Analysis ID (required) :type analysis_id: int - :param function_id: (required) + :param function_id: Function ID (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -967,7 +971,6 @@ def get_function_data_types( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 - warnings.warn("GET /v2/analyses/{analysis_id}/functions/{function_id}/data_types is deprecated.", DeprecationWarning) _param = self._get_function_data_types_serialize( analysis_id=analysis_id, @@ -979,8 +982,11 @@ def get_function_data_types( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "BaseResponseFunctionDataTypes", - '422': "BaseResponse", + '200': "DataTypesEntry", + '403': "APIError", + '404': "APIError", + '422': "APIError", + '500': "APIError", } response_data = self.api_client.call_api( *_param, @@ -996,8 +1002,8 @@ def get_function_data_types( @validate_call def get_function_data_types_with_http_info( self, - analysis_id: StrictInt, - function_id: StrictInt, + analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], + function_id: Annotated[int, Field(strict=True, ge=1, description="Function ID")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1010,14 +1016,14 @@ def get_function_data_types_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[BaseResponseFunctionDataTypes]: - """(Deprecated) Get Function Data Types + ) -> ApiResponse[DataTypesEntry]: + """Get data types for a single function - Polling endpoint which returns the current status of function generation and once completed the data type information + Returns the stored data-types blob for one function. The function must belong to the supplied analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - :param analysis_id: (required) + :param analysis_id: Analysis ID (required) :type analysis_id: int - :param function_id: (required) + :param function_id: Function ID (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1040,7 +1046,6 @@ def get_function_data_types_with_http_info( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 - warnings.warn("GET /v2/analyses/{analysis_id}/functions/{function_id}/data_types is deprecated.", DeprecationWarning) _param = self._get_function_data_types_serialize( analysis_id=analysis_id, @@ -1052,8 +1057,11 @@ def get_function_data_types_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "BaseResponseFunctionDataTypes", - '422': "BaseResponse", + '200': "DataTypesEntry", + '403': "APIError", + '404': "APIError", + '422': "APIError", + '500': "APIError", } response_data = self.api_client.call_api( *_param, @@ -1069,8 +1077,8 @@ def get_function_data_types_with_http_info( @validate_call def get_function_data_types_without_preload_content( self, - analysis_id: StrictInt, - function_id: StrictInt, + analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], + function_id: Annotated[int, Field(strict=True, ge=1, description="Function ID")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1084,13 +1092,13 @@ def get_function_data_types_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """(Deprecated) Get Function Data Types + """Get data types for a single function - Polling endpoint which returns the current status of function generation and once completed the data type information + Returns the stored data-types blob for one function. The function must belong to the supplied analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - :param analysis_id: (required) + :param analysis_id: Analysis ID (required) :type analysis_id: int - :param function_id: (required) + :param function_id: Function ID (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1113,7 +1121,6 @@ def get_function_data_types_without_preload_content( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 - warnings.warn("GET /v2/analyses/{analysis_id}/functions/{function_id}/data_types is deprecated.", DeprecationWarning) _param = self._get_function_data_types_serialize( analysis_id=analysis_id, @@ -1125,8 +1132,11 @@ def get_function_data_types_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "BaseResponseFunctionDataTypes", - '422': "BaseResponse", + '200': "DataTypesEntry", + '403': "APIError", + '404': "APIError", + '422': "APIError", + '500': "APIError", } response_data = self.api_client.call_api( *_param, @@ -1181,12 +1191,13 @@ def _get_function_data_types_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( method='GET', - resource_path='/v2/analyses/{analysis_id}/functions/{function_id}/data_types', + resource_path='/v3/analyses/{analysis_id}/functions/{function_id}/data-types', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1203,10 +1214,11 @@ def _get_function_data_types_serialize( @validate_call - def get_function_data_types_0( + def list_analysis_functions_data_types( self, analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], - function_id: Annotated[int, Field(strict=True, ge=1, description="Function ID")], + offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Pagination offset. Defaults to 0.")] = None, + limit: Annotated[Optional[Annotated[int, Field(le=500, strict=True, ge=1)]], Field(description="Page size. Defaults to 100.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1219,15 +1231,17 @@ def get_function_data_types_0( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> DataTypesEntry: - """Get data types for a single function + ) -> ListAnalysisFunctionsDataTypesOutputBody: + """List data types for all functions in an analysis - Returns the stored data-types blob for one function. The function must belong to the supplied analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found + Paginated read of the stored data-types blob for each function in the analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found :param analysis_id: Analysis ID (required) :type analysis_id: int - :param function_id: Function ID (required) - :type function_id: int + :param offset: Pagination offset. Defaults to 0. + :type offset: int + :param limit: Page size. Defaults to 100. + :type limit: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1250,9 +1264,10 @@ def get_function_data_types_0( :return: Returns the result object. """ # noqa: E501 - _param = self._get_function_data_types_0_serialize( + _param = self._list_analysis_functions_data_types_serialize( analysis_id=analysis_id, - function_id=function_id, + offset=offset, + limit=limit, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1260,7 +1275,7 @@ def get_function_data_types_0( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "DataTypesEntry", + '200': "ListAnalysisFunctionsDataTypesOutputBody", '403': "APIError", '404': "APIError", '422': "APIError", @@ -1278,10 +1293,11 @@ def get_function_data_types_0( @validate_call - def get_function_data_types_0_with_http_info( + def list_analysis_functions_data_types_with_http_info( self, analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], - function_id: Annotated[int, Field(strict=True, ge=1, description="Function ID")], + offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Pagination offset. Defaults to 0.")] = None, + limit: Annotated[Optional[Annotated[int, Field(le=500, strict=True, ge=1)]], Field(description="Page size. Defaults to 100.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1294,15 +1310,17 @@ def get_function_data_types_0_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[DataTypesEntry]: - """Get data types for a single function + ) -> ApiResponse[ListAnalysisFunctionsDataTypesOutputBody]: + """List data types for all functions in an analysis - Returns the stored data-types blob for one function. The function must belong to the supplied analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found + Paginated read of the stored data-types blob for each function in the analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found :param analysis_id: Analysis ID (required) :type analysis_id: int - :param function_id: Function ID (required) - :type function_id: int + :param offset: Pagination offset. Defaults to 0. + :type offset: int + :param limit: Page size. Defaults to 100. + :type limit: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1325,9 +1343,10 @@ def get_function_data_types_0_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._get_function_data_types_0_serialize( + _param = self._list_analysis_functions_data_types_serialize( analysis_id=analysis_id, - function_id=function_id, + offset=offset, + limit=limit, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1335,7 +1354,7 @@ def get_function_data_types_0_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "DataTypesEntry", + '200': "ListAnalysisFunctionsDataTypesOutputBody", '403': "APIError", '404': "APIError", '422': "APIError", @@ -1353,10 +1372,11 @@ def get_function_data_types_0_with_http_info( @validate_call - def get_function_data_types_0_without_preload_content( + def list_analysis_functions_data_types_without_preload_content( self, analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], - function_id: Annotated[int, Field(strict=True, ge=1, description="Function ID")], + offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Pagination offset. Defaults to 0.")] = None, + limit: Annotated[Optional[Annotated[int, Field(le=500, strict=True, ge=1)]], Field(description="Page size. Defaults to 100.")] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1370,14 +1390,16 @@ def get_function_data_types_0_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Get data types for a single function + """List data types for all functions in an analysis - Returns the stored data-types blob for one function. The function must belong to the supplied analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found + Paginated read of the stored data-types blob for each function in the analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found :param analysis_id: Analysis ID (required) :type analysis_id: int - :param function_id: Function ID (required) - :type function_id: int + :param offset: Pagination offset. Defaults to 0. + :type offset: int + :param limit: Page size. Defaults to 100. + :type limit: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1400,9 +1422,10 @@ def get_function_data_types_0_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._get_function_data_types_0_serialize( + _param = self._list_analysis_functions_data_types_serialize( analysis_id=analysis_id, - function_id=function_id, + offset=offset, + limit=limit, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1410,7 +1433,7 @@ def get_function_data_types_0_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "DataTypesEntry", + '200': "ListAnalysisFunctionsDataTypesOutputBody", '403': "APIError", '404': "APIError", '422': "APIError", @@ -1423,10 +1446,11 @@ def get_function_data_types_0_without_preload_content( return response_data.response - def _get_function_data_types_0_serialize( + def _list_analysis_functions_data_types_serialize( self, analysis_id, - function_id, + offset, + limit, _request_auth, _content_type, _headers, @@ -1450,9 +1474,15 @@ def _get_function_data_types_0_serialize( # process the path parameters if analysis_id is not None: _path_params['analysis_id'] = analysis_id - if function_id is not None: - _path_params['function_id'] = function_id # process the query parameters + if offset is not None: + + _query_params.append(('offset', offset)) + + if limit is not None: + + _query_params.append(('limit', limit)) + # process the header parameters # process the form parameters # process the body parameter @@ -1469,12 +1499,13 @@ def _get_function_data_types_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( method='GET', - resource_path='/v3/analyses/{analysis_id}/functions/{function_id}/data-types', + resource_path='/v3/analyses/{analysis_id}/functions/data-types', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1491,11 +1522,10 @@ def _get_function_data_types_0_serialize( @validate_call - def list_analysis_functions_data_types( + def list_function_data_types_for_analysis( self, - analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], - offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Pagination offset. Defaults to 0.")] = None, - limit: Annotated[Optional[Annotated[int, Field(le=500, strict=True, ge=1)]], Field(description="Page size. Defaults to 100.")] = None, + analysis_id: StrictInt, + function_ids: Optional[List[Optional[StrictInt]]] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1508,17 +1538,15 @@ def list_analysis_functions_data_types( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ListAnalysisFunctionsDataTypesOutputBody: - """List data types for all functions in an analysis + ) -> BaseResponseFunctionDataTypesList: + """(Deprecated) List Function Data Types - Paginated read of the stored data-types blob for each function in the analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found + Returns data types for multiple functions with optional function ID filtering - :param analysis_id: Analysis ID (required) + :param analysis_id: (required) :type analysis_id: int - :param offset: Pagination offset. Defaults to 0. - :type offset: int - :param limit: Page size. Defaults to 100. - :type limit: int + :param function_ids: + :type function_ids: List[Optional[int]] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1540,11 +1568,11 @@ def list_analysis_functions_data_types( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 + warnings.warn("GET /v2/analyses/{analysis_id}/functions/data_types is deprecated.", DeprecationWarning) - _param = self._list_analysis_functions_data_types_serialize( + _param = self._list_function_data_types_for_analysis_serialize( analysis_id=analysis_id, - offset=offset, - limit=limit, + function_ids=function_ids, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1552,11 +1580,8 @@ def list_analysis_functions_data_types( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListAnalysisFunctionsDataTypesOutputBody", - '403': "APIError", - '404': "APIError", - '422': "APIError", - '500': "APIError", + '200': "BaseResponseFunctionDataTypesList", + '422': "BaseResponse", } response_data = self.api_client.call_api( *_param, @@ -1570,11 +1595,10 @@ def list_analysis_functions_data_types( @validate_call - def list_analysis_functions_data_types_with_http_info( + def list_function_data_types_for_analysis_with_http_info( self, - analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], - offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Pagination offset. Defaults to 0.")] = None, - limit: Annotated[Optional[Annotated[int, Field(le=500, strict=True, ge=1)]], Field(description="Page size. Defaults to 100.")] = None, + analysis_id: StrictInt, + function_ids: Optional[List[Optional[StrictInt]]] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1587,17 +1611,15 @@ def list_analysis_functions_data_types_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ListAnalysisFunctionsDataTypesOutputBody]: - """List data types for all functions in an analysis + ) -> ApiResponse[BaseResponseFunctionDataTypesList]: + """(Deprecated) List Function Data Types - Paginated read of the stored data-types blob for each function in the analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found + Returns data types for multiple functions with optional function ID filtering - :param analysis_id: Analysis ID (required) + :param analysis_id: (required) :type analysis_id: int - :param offset: Pagination offset. Defaults to 0. - :type offset: int - :param limit: Page size. Defaults to 100. - :type limit: int + :param function_ids: + :type function_ids: List[Optional[int]] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1619,11 +1641,11 @@ def list_analysis_functions_data_types_with_http_info( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 + warnings.warn("GET /v2/analyses/{analysis_id}/functions/data_types is deprecated.", DeprecationWarning) - _param = self._list_analysis_functions_data_types_serialize( + _param = self._list_function_data_types_for_analysis_serialize( analysis_id=analysis_id, - offset=offset, - limit=limit, + function_ids=function_ids, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1631,11 +1653,8 @@ def list_analysis_functions_data_types_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListAnalysisFunctionsDataTypesOutputBody", - '403': "APIError", - '404': "APIError", - '422': "APIError", - '500': "APIError", + '200': "BaseResponseFunctionDataTypesList", + '422': "BaseResponse", } response_data = self.api_client.call_api( *_param, @@ -1649,11 +1668,10 @@ def list_analysis_functions_data_types_with_http_info( @validate_call - def list_analysis_functions_data_types_without_preload_content( + def list_function_data_types_for_analysis_without_preload_content( self, - analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], - offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="Pagination offset. Defaults to 0.")] = None, - limit: Annotated[Optional[Annotated[int, Field(le=500, strict=True, ge=1)]], Field(description="Page size. Defaults to 100.")] = None, + analysis_id: StrictInt, + function_ids: Optional[List[Optional[StrictInt]]] = None, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1667,16 +1685,14 @@ def list_analysis_functions_data_types_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """List data types for all functions in an analysis + """(Deprecated) List Function Data Types - Paginated read of the stored data-types blob for each function in the analysis. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found + Returns data types for multiple functions with optional function ID filtering - :param analysis_id: Analysis ID (required) + :param analysis_id: (required) :type analysis_id: int - :param offset: Pagination offset. Defaults to 0. - :type offset: int - :param limit: Page size. Defaults to 100. - :type limit: int + :param function_ids: + :type function_ids: List[Optional[int]] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -1698,11 +1714,11 @@ def list_analysis_functions_data_types_without_preload_content( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 + warnings.warn("GET /v2/analyses/{analysis_id}/functions/data_types is deprecated.", DeprecationWarning) - _param = self._list_analysis_functions_data_types_serialize( + _param = self._list_function_data_types_for_analysis_serialize( analysis_id=analysis_id, - offset=offset, - limit=limit, + function_ids=function_ids, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -1710,11 +1726,8 @@ def list_analysis_functions_data_types_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListAnalysisFunctionsDataTypesOutputBody", - '403': "APIError", - '404': "APIError", - '422': "APIError", - '500': "APIError", + '200': "BaseResponseFunctionDataTypesList", + '422': "BaseResponse", } response_data = self.api_client.call_api( *_param, @@ -1723,11 +1736,10 @@ def list_analysis_functions_data_types_without_preload_content( return response_data.response - def _list_analysis_functions_data_types_serialize( + def _list_function_data_types_for_analysis_serialize( self, analysis_id, - offset, - limit, + function_ids, _request_auth, _content_type, _headers, @@ -1737,6 +1749,7 @@ def _list_analysis_functions_data_types_serialize( _host = None _collection_formats: Dict[str, str] = { + 'function_ids': 'multi', } _path_params: Dict[str, str] = {} @@ -1752,13 +1765,9 @@ def _list_analysis_functions_data_types_serialize( if analysis_id is not None: _path_params['analysis_id'] = analysis_id # process the query parameters - if offset is not None: - - _query_params.append(('offset', offset)) - - if limit is not None: + if function_ids is not None: - _query_params.append(('limit', limit)) + _query_params.append(('function_ids', function_ids)) # process the header parameters # process the form parameters @@ -1776,12 +1785,13 @@ def _list_analysis_functions_data_types_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( method='GET', - resource_path='/v3/analyses/{analysis_id}/functions/data-types', + resource_path='/v2/analyses/{analysis_id}/functions/data_types', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -1798,9 +1808,8 @@ def _list_analysis_functions_data_types_serialize( @validate_call - def list_function_data_types_for_analysis( + def list_function_data_types_for_functions( self, - analysis_id: StrictInt, function_ids: Optional[List[Optional[StrictInt]]] = None, _request_timeout: Union[ None, @@ -1817,10 +1826,8 @@ def list_function_data_types_for_analysis( ) -> BaseResponseFunctionDataTypesList: """(Deprecated) List Function Data Types - Returns data types for multiple functions with optional function ID filtering + Returns data types for multiple function IDs - :param analysis_id: (required) - :type analysis_id: int :param function_ids: :type function_ids: List[Optional[int]] :param _request_timeout: timeout setting for this request. If one @@ -1844,10 +1851,9 @@ def list_function_data_types_for_analysis( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 - warnings.warn("GET /v2/analyses/{analysis_id}/functions/data_types is deprecated.", DeprecationWarning) + warnings.warn("GET /v2/functions/data_types is deprecated.", DeprecationWarning) - _param = self._list_function_data_types_for_analysis_serialize( - analysis_id=analysis_id, + _param = self._list_function_data_types_for_functions_serialize( function_ids=function_ids, _request_auth=_request_auth, _content_type=_content_type, @@ -1871,9 +1877,8 @@ def list_function_data_types_for_analysis( @validate_call - def list_function_data_types_for_analysis_with_http_info( + def list_function_data_types_for_functions_with_http_info( self, - analysis_id: StrictInt, function_ids: Optional[List[Optional[StrictInt]]] = None, _request_timeout: Union[ None, @@ -1890,10 +1895,8 @@ def list_function_data_types_for_analysis_with_http_info( ) -> ApiResponse[BaseResponseFunctionDataTypesList]: """(Deprecated) List Function Data Types - Returns data types for multiple functions with optional function ID filtering + Returns data types for multiple function IDs - :param analysis_id: (required) - :type analysis_id: int :param function_ids: :type function_ids: List[Optional[int]] :param _request_timeout: timeout setting for this request. If one @@ -1917,10 +1920,9 @@ def list_function_data_types_for_analysis_with_http_info( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 - warnings.warn("GET /v2/analyses/{analysis_id}/functions/data_types is deprecated.", DeprecationWarning) + warnings.warn("GET /v2/functions/data_types is deprecated.", DeprecationWarning) - _param = self._list_function_data_types_for_analysis_serialize( - analysis_id=analysis_id, + _param = self._list_function_data_types_for_functions_serialize( function_ids=function_ids, _request_auth=_request_auth, _content_type=_content_type, @@ -1944,9 +1946,8 @@ def list_function_data_types_for_analysis_with_http_info( @validate_call - def list_function_data_types_for_analysis_without_preload_content( + def list_function_data_types_for_functions_without_preload_content( self, - analysis_id: StrictInt, function_ids: Optional[List[Optional[StrictInt]]] = None, _request_timeout: Union[ None, @@ -1963,10 +1964,8 @@ def list_function_data_types_for_analysis_without_preload_content( ) -> RESTResponseType: """(Deprecated) List Function Data Types - Returns data types for multiple functions with optional function ID filtering + Returns data types for multiple function IDs - :param analysis_id: (required) - :type analysis_id: int :param function_ids: :type function_ids: List[Optional[int]] :param _request_timeout: timeout setting for this request. If one @@ -1990,10 +1989,9 @@ def list_function_data_types_for_analysis_without_preload_content( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 - warnings.warn("GET /v2/analyses/{analysis_id}/functions/data_types is deprecated.", DeprecationWarning) + warnings.warn("GET /v2/functions/data_types is deprecated.", DeprecationWarning) - _param = self._list_function_data_types_for_analysis_serialize( - analysis_id=analysis_id, + _param = self._list_function_data_types_for_functions_serialize( function_ids=function_ids, _request_auth=_request_auth, _content_type=_content_type, @@ -2012,9 +2010,8 @@ def list_function_data_types_for_analysis_without_preload_content( return response_data.response - def _list_function_data_types_for_analysis_serialize( + def _list_function_data_types_for_functions_serialize( self, - analysis_id, function_ids, _request_auth, _content_type, @@ -2038,8 +2035,6 @@ def _list_function_data_types_for_analysis_serialize( _body_params: Optional[bytes] = None # process the path parameters - if analysis_id is not None: - _path_params['analysis_id'] = analysis_id # process the query parameters if function_ids is not None: @@ -2061,12 +2056,13 @@ def _list_function_data_types_for_analysis_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( method='GET', - resource_path='/v2/analyses/{analysis_id}/functions/data_types', + resource_path='/v2/functions/data_types', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2083,9 +2079,9 @@ def _list_function_data_types_for_analysis_serialize( @validate_call - def list_function_data_types_for_functions( + def list_functions_data_types( self, - function_ids: Optional[List[Optional[StrictInt]]] = None, + function_ids: Annotated[Optional[Annotated[List[StrictInt], Field(min_length=1, max_length=500)]], Field(description="Function IDs to fetch data-types for.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2098,13 +2094,13 @@ def list_function_data_types_for_functions( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> BaseResponseFunctionDataTypesList: - """(Deprecated) List Function Data Types + ) -> ListFunctionsDataTypesOutputBody: + """Get data types for many functions - Returns data types for multiple function IDs + Returns the stored data-types blob for each supplied function ID. Caller must have read access to every function or the request is rejected. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request - :param function_ids: - :type function_ids: List[Optional[int]] + :param function_ids: Function IDs to fetch data-types for. (required) + :type function_ids: List[int] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2126,9 +2122,8 @@ def list_function_data_types_for_functions( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 - warnings.warn("GET /v2/functions/data_types is deprecated.", DeprecationWarning) - _param = self._list_function_data_types_for_functions_serialize( + _param = self._list_functions_data_types_serialize( function_ids=function_ids, _request_auth=_request_auth, _content_type=_content_type, @@ -2137,8 +2132,12 @@ def list_function_data_types_for_functions( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "BaseResponseFunctionDataTypesList", - '422': "BaseResponse", + '200': "ListFunctionsDataTypesOutputBody", + '400': "APIError", + '403': "APIError", + '404': "APIError", + '422': "APIError", + '500': "APIError", } response_data = self.api_client.call_api( *_param, @@ -2152,9 +2151,9 @@ def list_function_data_types_for_functions( @validate_call - def list_function_data_types_for_functions_with_http_info( + def list_functions_data_types_with_http_info( self, - function_ids: Optional[List[Optional[StrictInt]]] = None, + function_ids: Annotated[Optional[Annotated[List[StrictInt], Field(min_length=1, max_length=500)]], Field(description="Function IDs to fetch data-types for.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2167,13 +2166,13 @@ def list_function_data_types_for_functions_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[BaseResponseFunctionDataTypesList]: - """(Deprecated) List Function Data Types + ) -> ApiResponse[ListFunctionsDataTypesOutputBody]: + """Get data types for many functions - Returns data types for multiple function IDs + Returns the stored data-types blob for each supplied function ID. Caller must have read access to every function or the request is rejected. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request - :param function_ids: - :type function_ids: List[Optional[int]] + :param function_ids: Function IDs to fetch data-types for. (required) + :type function_ids: List[int] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2195,9 +2194,8 @@ def list_function_data_types_for_functions_with_http_info( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 - warnings.warn("GET /v2/functions/data_types is deprecated.", DeprecationWarning) - _param = self._list_function_data_types_for_functions_serialize( + _param = self._list_functions_data_types_serialize( function_ids=function_ids, _request_auth=_request_auth, _content_type=_content_type, @@ -2206,8 +2204,12 @@ def list_function_data_types_for_functions_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "BaseResponseFunctionDataTypesList", - '422': "BaseResponse", + '200': "ListFunctionsDataTypesOutputBody", + '400': "APIError", + '403': "APIError", + '404': "APIError", + '422': "APIError", + '500': "APIError", } response_data = self.api_client.call_api( *_param, @@ -2221,9 +2223,9 @@ def list_function_data_types_for_functions_with_http_info( @validate_call - def list_function_data_types_for_functions_without_preload_content( + def list_functions_data_types_without_preload_content( self, - function_ids: Optional[List[Optional[StrictInt]]] = None, + function_ids: Annotated[Optional[Annotated[List[StrictInt], Field(min_length=1, max_length=500)]], Field(description="Function IDs to fetch data-types for.")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2237,12 +2239,12 @@ def list_function_data_types_for_functions_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """(Deprecated) List Function Data Types + """Get data types for many functions - Returns data types for multiple function IDs + Returns the stored data-types blob for each supplied function ID. Caller must have read access to every function or the request is rejected. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request - :param function_ids: - :type function_ids: List[Optional[int]] + :param function_ids: Function IDs to fetch data-types for. (required) + :type function_ids: List[int] :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2264,9 +2266,8 @@ def list_function_data_types_for_functions_without_preload_content( :type _host_index: int, optional :return: Returns the result object. """ # noqa: E501 - warnings.warn("GET /v2/functions/data_types is deprecated.", DeprecationWarning) - _param = self._list_function_data_types_for_functions_serialize( + _param = self._list_functions_data_types_serialize( function_ids=function_ids, _request_auth=_request_auth, _content_type=_content_type, @@ -2275,8 +2276,12 @@ def list_function_data_types_for_functions_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "BaseResponseFunctionDataTypesList", - '422': "BaseResponse", + '200': "ListFunctionsDataTypesOutputBody", + '400': "APIError", + '403': "APIError", + '404': "APIError", + '422': "APIError", + '500': "APIError", } response_data = self.api_client.call_api( *_param, @@ -2285,7 +2290,7 @@ def list_function_data_types_for_functions_without_preload_content( return response_data.response - def _list_function_data_types_for_functions_serialize( + def _list_functions_data_types_serialize( self, function_ids, _request_auth, @@ -2297,7 +2302,7 @@ def _list_function_data_types_for_functions_serialize( _host = None _collection_formats: Dict[str, str] = { - 'function_ids': 'multi', + 'function_ids': 'csv', } _path_params: Dict[str, str] = {} @@ -2331,12 +2336,13 @@ def _list_function_data_types_for_functions_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( method='GET', - resource_path='/v2/functions/data_types', + resource_path='/v3/functions/data-types', path_params=_path_params, query_params=_query_params, header_params=_header_params, @@ -2353,9 +2359,11 @@ def _list_function_data_types_for_functions_serialize( @validate_call - def list_functions_data_types( + def update_function_data_types( self, - function_ids: Annotated[Optional[Annotated[List[StrictInt], Field(min_length=1, max_length=500)]], Field(description="Function IDs to fetch data-types for.")], + analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], + function_id: Annotated[int, Field(strict=True, ge=1, description="Function ID")], + update_data_types_input_body: UpdateDataTypesInputBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2368,13 +2376,17 @@ def list_functions_data_types( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ListFunctionsDataTypesOutputBody: - """Get data types for many functions + ) -> UpdateDataTypesOutputBody: + """Update function data types - Returns the stored data-types blob for each supplied function ID. Caller must have read access to every function or the request is rejected. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request + Stores user-specific overrides for a function's data types. Uses optimistic concurrency: if the stored version doesn't match `data_types_version`, the update is rejected with 409. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request - `409` [`CONFLICT`](/errors/CONFLICT) — Conflict - :param function_ids: Function IDs to fetch data-types for. (required) - :type function_ids: List[int] + :param analysis_id: Analysis ID (required) + :type analysis_id: int + :param function_id: Function ID (required) + :type function_id: int + :param update_data_types_input_body: (required) + :type update_data_types_input_body: UpdateDataTypesInputBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2397,8 +2409,10 @@ def list_functions_data_types( :return: Returns the result object. """ # noqa: E501 - _param = self._list_functions_data_types_serialize( - function_ids=function_ids, + _param = self._update_function_data_types_serialize( + analysis_id=analysis_id, + function_id=function_id, + update_data_types_input_body=update_data_types_input_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2406,10 +2420,11 @@ def list_functions_data_types( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListFunctionsDataTypesOutputBody", + '200': "UpdateDataTypesOutputBody", '400': "APIError", '403': "APIError", '404': "APIError", + '409': "APIError", '422': "APIError", '500': "APIError", } @@ -2425,9 +2440,11 @@ def list_functions_data_types( @validate_call - def list_functions_data_types_with_http_info( + def update_function_data_types_with_http_info( self, - function_ids: Annotated[Optional[Annotated[List[StrictInt], Field(min_length=1, max_length=500)]], Field(description="Function IDs to fetch data-types for.")], + analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], + function_id: Annotated[int, Field(strict=True, ge=1, description="Function ID")], + update_data_types_input_body: UpdateDataTypesInputBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2440,13 +2457,17 @@ def list_functions_data_types_with_http_info( _content_type: Optional[StrictStr] = None, _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, - ) -> ApiResponse[ListFunctionsDataTypesOutputBody]: - """Get data types for many functions + ) -> ApiResponse[UpdateDataTypesOutputBody]: + """Update function data types - Returns the stored data-types blob for each supplied function ID. Caller must have read access to every function or the request is rejected. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request + Stores user-specific overrides for a function's data types. Uses optimistic concurrency: if the stored version doesn't match `data_types_version`, the update is rejected with 409. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request - `409` [`CONFLICT`](/errors/CONFLICT) — Conflict - :param function_ids: Function IDs to fetch data-types for. (required) - :type function_ids: List[int] + :param analysis_id: Analysis ID (required) + :type analysis_id: int + :param function_id: Function ID (required) + :type function_id: int + :param update_data_types_input_body: (required) + :type update_data_types_input_body: UpdateDataTypesInputBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2469,8 +2490,10 @@ def list_functions_data_types_with_http_info( :return: Returns the result object. """ # noqa: E501 - _param = self._list_functions_data_types_serialize( - function_ids=function_ids, + _param = self._update_function_data_types_serialize( + analysis_id=analysis_id, + function_id=function_id, + update_data_types_input_body=update_data_types_input_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2478,10 +2501,11 @@ def list_functions_data_types_with_http_info( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListFunctionsDataTypesOutputBody", + '200': "UpdateDataTypesOutputBody", '400': "APIError", '403': "APIError", '404': "APIError", + '409': "APIError", '422': "APIError", '500': "APIError", } @@ -2497,9 +2521,11 @@ def list_functions_data_types_with_http_info( @validate_call - def list_functions_data_types_without_preload_content( + def update_function_data_types_without_preload_content( self, - function_ids: Annotated[Optional[Annotated[List[StrictInt], Field(min_length=1, max_length=500)]], Field(description="Function IDs to fetch data-types for.")], + analysis_id: Annotated[int, Field(strict=True, ge=1, description="Analysis ID")], + function_id: Annotated[int, Field(strict=True, ge=1, description="Function ID")], + update_data_types_input_body: UpdateDataTypesInputBody, _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -2513,12 +2539,16 @@ def list_functions_data_types_without_preload_content( _headers: Optional[Dict[StrictStr, Any]] = None, _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, ) -> RESTResponseType: - """Get data types for many functions + """Update function data types - Returns the stored data-types blob for each supplied function ID. Caller must have read access to every function or the request is rejected. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request + Stores user-specific overrides for a function's data types. Uses optimistic concurrency: if the stored version doesn't match `data_types_version`, the update is rejected with 409. **Error codes:** - `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied - `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found - `400` [`BAD_REQUEST`](/errors/BAD_REQUEST) — Bad Request - `409` [`CONFLICT`](/errors/CONFLICT) — Conflict - :param function_ids: Function IDs to fetch data-types for. (required) - :type function_ids: List[int] + :param analysis_id: Analysis ID (required) + :type analysis_id: int + :param function_id: Function ID (required) + :type function_id: int + :param update_data_types_input_body: (required) + :type update_data_types_input_body: UpdateDataTypesInputBody :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of @@ -2541,8 +2571,10 @@ def list_functions_data_types_without_preload_content( :return: Returns the result object. """ # noqa: E501 - _param = self._list_functions_data_types_serialize( - function_ids=function_ids, + _param = self._update_function_data_types_serialize( + analysis_id=analysis_id, + function_id=function_id, + update_data_types_input_body=update_data_types_input_body, _request_auth=_request_auth, _content_type=_content_type, _headers=_headers, @@ -2550,10 +2582,11 @@ def list_functions_data_types_without_preload_content( ) _response_types_map: Dict[str, Optional[str]] = { - '200': "ListFunctionsDataTypesOutputBody", + '200': "UpdateDataTypesOutputBody", '400': "APIError", '403': "APIError", '404': "APIError", + '409': "APIError", '422': "APIError", '500': "APIError", } @@ -2564,9 +2597,11 @@ def list_functions_data_types_without_preload_content( return response_data.response - def _list_functions_data_types_serialize( + def _update_function_data_types_serialize( self, - function_ids, + analysis_id, + function_id, + update_data_types_input_body, _request_auth, _content_type, _headers, @@ -2576,7 +2611,6 @@ def _list_functions_data_types_serialize( _host = None _collection_formats: Dict[str, str] = { - 'function_ids': 'csv', } _path_params: Dict[str, str] = {} @@ -2589,14 +2623,16 @@ def _list_functions_data_types_serialize( _body_params: Optional[bytes] = None # process the path parameters + if analysis_id is not None: + _path_params['analysis_id'] = analysis_id + if function_id is not None: + _path_params['function_id'] = function_id # process the query parameters - if function_ids is not None: - - _query_params.append(('function_ids', function_ids)) - # process the header parameters # process the form parameters # process the body parameter + if update_data_types_input_body is not None: + _body_params = update_data_types_input_body # set the HTTP header `Accept` @@ -2607,15 +2643,29 @@ def _list_functions_data_types_serialize( ] ) + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + [ + 'application/json' + ] + ) + ) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( - method='GET', - resource_path='/v3/functions/data-types', + method='PUT', + resource_path='/v2/analyses/{analysis_id}/functions/{function_id}/data_types', path_params=_path_params, query_params=_query_params, header_params=_header_params, diff --git a/revengai/api/functions_renaming_history_api.py b/revengai/api/functions_renaming_history_api.py index 3a44a37..4509c14 100644 --- a/revengai/api/functions_renaming_history_api.py +++ b/revengai/api/functions_renaming_history_api.py @@ -305,7 +305,8 @@ def _batch_rename_function_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -591,7 +592,8 @@ def _batch_rename_functions_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -864,7 +866,8 @@ def _get_function_history_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1131,7 +1134,8 @@ def _get_function_name_history_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1432,7 +1436,8 @@ def _rename_function_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1727,7 +1732,8 @@ def _rename_function_id_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2009,7 +2015,8 @@ def _revert_function_name_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -2297,7 +2304,8 @@ def _revert_function_name_0_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/iam_users_api.py b/revengai/api/iam_users_api.py index 6e5ca7d..d85f77d 100644 --- a/revengai/api/iam_users_api.py +++ b/revengai/api/iam_users_api.py @@ -267,7 +267,7 @@ def _get_me_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'bearerAuth' ] return self.api_client.param_serialize( @@ -513,7 +513,7 @@ def _get_my_permissions_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/models_api.py b/revengai/api/models_api.py index f34f610..0a9aa1e 100644 --- a/revengai/api/models_api.py +++ b/revengai/api/models_api.py @@ -263,7 +263,8 @@ def _get_models_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/reports_api.py b/revengai/api/reports_api.py index 6f76d5c..99bb785 100644 --- a/revengai/api/reports_api.py +++ b/revengai/api/reports_api.py @@ -290,7 +290,8 @@ def _create_pdf_report_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -566,7 +567,8 @@ def _download_pdf_report_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -839,7 +841,8 @@ def _get_pdf_report_status_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/api/search_api.py b/revengai/api/search_api.py index 1004377..c2be914 100644 --- a/revengai/api/search_api.py +++ b/revengai/api/search_api.py @@ -409,7 +409,8 @@ def _search_binaries_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -833,7 +834,8 @@ def _search_collections_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1150,7 +1152,8 @@ def _search_functions_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( @@ -1450,7 +1453,8 @@ def _search_tags_serialize( # authentication setting _auth_settings: List[str] = [ - 'APIKey' + 'APIKey', + 'bearerAuth' ] return self.api_client.param_serialize( diff --git a/revengai/configuration.py b/revengai/configuration.py index b25aee0..7fa8dea 100644 --- a/revengai/configuration.py +++ b/revengai/configuration.py @@ -113,6 +113,7 @@ "AuthSettings", { "APIKey": APIKeyAuthSetting, + "bearerAuth": BearerAuthSetting, }, total=False, ) @@ -523,6 +524,13 @@ def auth_settings(self)-> AuthSettings: 'APIKey', ), } + if self.access_token is not None: + auth['bearerAuth'] = { + 'type': 'bearer', + 'in': 'header', + 'key': 'Authorization', + 'value': 'Bearer ' + self.access_token + } return auth def to_debug_report(self) -> str: diff --git a/revengai/models/__init__.py b/revengai/models/__init__.py index 0e00671..93e227d 100644 --- a/revengai/models/__init__.py +++ b/revengai/models/__init__.py @@ -282,7 +282,6 @@ from revengai.models.function_details_output_body import FunctionDetailsOutputBody from revengai.models.function_header import FunctionHeader from revengai.models.function_info import FunctionInfo -from revengai.models.function_info_func_deps_inner import FunctionInfoFuncDepsInner from revengai.models.function_list_item import FunctionListItem from revengai.models.function_local_variable_response import FunctionLocalVariableResponse from revengai.models.function_mapping import FunctionMapping @@ -498,6 +497,13 @@ from revengai.models.user_credits import UserCredits from revengai.models.user_identity import UserIdentity from revengai.models.user_profile import UserProfile +from revengai.models.v2_function_header import V2FunctionHeader +from revengai.models.v2_function_info import V2FunctionInfo +from revengai.models.v2_function_info_func_deps_inner import V2FunctionInfoFuncDepsInner +from revengai.models.v2_function_match import V2FunctionMatch +from revengai.models.v2_function_type import V2FunctionType +from revengai.models.v2_matched_function import V2MatchedFunction +from revengai.models.v2_name_confidence import V2NameConfidence from revengai.models.vulnerabilities import Vulnerabilities from revengai.models.vulnerability import Vulnerability from revengai.models.warning_event import WarningEvent diff --git a/revengai/models/function_argument.py b/revengai/models/function_argument.py index d5da28e..3a5b755 100644 --- a/revengai/models/function_argument.py +++ b/revengai/models/function_argument.py @@ -26,11 +26,11 @@ class FunctionArgument(BaseModel): FunctionArgument """ # noqa: E501 last_change: Optional[StrictStr] = None - name: Optional[StrictStr] + name: StrictStr offset: StrictInt scope: Optional[StrictStr] = None size: StrictInt - type: Optional[StrictStr] + type: StrictStr additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["last_change", "name", "offset", "scope", "size", "type"] @@ -80,26 +80,6 @@ def to_dict(self) -> Dict[str, Any]: for _key, _value in self.additional_properties.items(): _dict[_key] = _value - # set to None if last_change (nullable) is None - # and model_fields_set contains the field - if self.last_change is None and "last_change" in self.model_fields_set: - _dict['last_change'] = None - - # set to None if name (nullable) is None - # and model_fields_set contains the field - if self.name is None and "name" in self.model_fields_set: - _dict['name'] = None - - # set to None if scope (nullable) is None - # and model_fields_set contains the field - if self.scope is None and "scope" in self.model_fields_set: - _dict['scope'] = None - - # set to None if type (nullable) is None - # and model_fields_set contains the field - if self.type is None and "type" in self.model_fields_set: - _dict['type'] = None - return _dict @classmethod diff --git a/revengai/models/function_data_types.py b/revengai/models/function_data_types.py index 2367bad..18cfb19 100644 --- a/revengai/models/function_data_types.py +++ b/revengai/models/function_data_types.py @@ -18,7 +18,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from revengai.models.function_info import FunctionInfo +from revengai.models.v2_function_info import V2FunctionInfo from typing import Optional, Set from typing_extensions import Self @@ -28,7 +28,7 @@ class FunctionDataTypes(BaseModel): """ # noqa: E501 completed: StrictBool = Field(description="Whether the service has completed data types generation") status: StrictStr = Field(description="The current status of the data types service") - data_types: Optional[FunctionInfo] = None + data_types: Optional[V2FunctionInfo] = None data_types_version: Optional[StrictInt] = None __properties: ClassVar[List[str]] = ["completed", "status", "data_types", "data_types_version"] @@ -98,7 +98,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "completed": obj.get("completed"), "status": obj.get("status"), - "data_types": FunctionInfo.from_dict(obj["data_types"]) if obj.get("data_types") is not None else None, + "data_types": V2FunctionInfo.from_dict(obj["data_types"]) if obj.get("data_types") is not None else None, "data_types_version": obj.get("data_types_version") }) return _obj diff --git a/revengai/models/function_data_types_list_item.py b/revengai/models/function_data_types_list_item.py index 7f0772d..e5636f2 100644 --- a/revengai/models/function_data_types_list_item.py +++ b/revengai/models/function_data_types_list_item.py @@ -18,7 +18,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from revengai.models.function_info import FunctionInfo +from revengai.models.v2_function_info import V2FunctionInfo from typing import Optional, Set from typing_extensions import Self @@ -28,7 +28,7 @@ class FunctionDataTypesListItem(BaseModel): """ # noqa: E501 completed: StrictBool = Field(description="Whether the service has completed data types generation") status: StrictStr = Field(description="The current status of the data types service") - data_types: Optional[FunctionInfo] = None + data_types: Optional[V2FunctionInfo] = None data_types_version: Optional[StrictInt] = None function_id: StrictInt = Field(description="Function id") __properties: ClassVar[List[str]] = ["completed", "status", "data_types", "data_types_version", "function_id"] @@ -99,7 +99,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "completed": obj.get("completed"), "status": obj.get("status"), - "data_types": FunctionInfo.from_dict(obj["data_types"]) if obj.get("data_types") is not None else None, + "data_types": V2FunctionInfo.from_dict(obj["data_types"]) if obj.get("data_types") is not None else None, "data_types_version": obj.get("data_types_version"), "function_id": obj.get("function_id") }) diff --git a/revengai/models/function_dependency.py b/revengai/models/function_dependency.py index f396d55..6fd4d67 100644 --- a/revengai/models/function_dependency.py +++ b/revengai/models/function_dependency.py @@ -29,7 +29,7 @@ class FunctionDependency(BaseModel): artifact_type: Optional[StrictStr] = None last_change: Optional[StrictStr] = None members: Optional[Any] = None - name: Optional[StrictStr] + name: StrictStr scope: Optional[StrictStr] = None size: Optional[StrictInt] = Field(default=None, description="Total byte size (Struct, GlobalVariable).") type: Optional[StrictStr] = Field(default=None, description="Underlying type (TypeDefinition, GlobalVariable).") @@ -82,26 +82,11 @@ def to_dict(self) -> Dict[str, Any]: for _key, _value in self.additional_properties.items(): _dict[_key] = _value - # set to None if last_change (nullable) is None - # and model_fields_set contains the field - if self.last_change is None and "last_change" in self.model_fields_set: - _dict['last_change'] = None - # set to None if members (nullable) is None # and model_fields_set contains the field if self.members is None and "members" in self.model_fields_set: _dict['members'] = None - # set to None if name (nullable) is None - # and model_fields_set contains the field - if self.name is None and "name" in self.model_fields_set: - _dict['name'] = None - - # set to None if scope (nullable) is None - # and model_fields_set contains the field - if self.scope is None and "scope" in self.model_fields_set: - _dict['scope'] = None - return _dict @classmethod diff --git a/revengai/models/function_header.py b/revengai/models/function_header.py index 74dd5ba..8da2842 100644 --- a/revengai/models/function_header.py +++ b/revengai/models/function_header.py @@ -18,7 +18,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from revengai.models.argument import Argument +from revengai.models.function_argument import FunctionArgument from typing import Optional, Set from typing_extensions import Self @@ -26,12 +26,14 @@ class FunctionHeader(BaseModel): """ FunctionHeader """ # noqa: E501 + addr: StrictInt + args: Dict[str, FunctionArgument] = Field(description="Argument map keyed by ordinal hex (e.g. \"0x0\", \"0x1\").") last_change: Optional[StrictStr] = None - name: StrictStr = Field(description="Name of the function") - addr: StrictInt = Field(description="Memory address of the function") - type: StrictStr = Field(description="Return type of the function") - args: Dict[str, Argument] = Field(description="Dictionary of function arguments") - __properties: ClassVar[List[str]] = ["last_change", "name", "addr", "type", "args"] + name: StrictStr + scope: Optional[StrictStr] = None + type: StrictStr + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["addr", "args", "last_change", "name", "scope", "type"] model_config = ConfigDict( populate_by_name=True, @@ -63,8 +65,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ + "additional_properties", ]) _dict = self.model_dump( @@ -79,10 +83,10 @@ def to_dict(self) -> Dict[str, Any]: if self.args[_key_args]: _field_dict[_key_args] = self.args[_key_args].to_dict() _dict['args'] = _field_dict - # set to None if last_change (nullable) is None - # and model_fields_set contains the field - if self.last_change is None and "last_change" in self.model_fields_set: - _dict['last_change'] = None + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value return _dict @@ -96,17 +100,23 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "last_change": obj.get("last_change"), - "name": obj.get("name"), "addr": obj.get("addr"), - "type": obj.get("type"), "args": dict( - (_k, Argument.from_dict(_v)) + (_k, FunctionArgument.from_dict(_v)) for _k, _v in obj["args"].items() ) if obj.get("args") is not None - else None + else None, + "last_change": obj.get("last_change"), + "name": obj.get("name"), + "scope": obj.get("scope"), + "type": obj.get("type") }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + return _obj diff --git a/revengai/models/function_info.py b/revengai/models/function_info.py index a76fa40..23b6638 100644 --- a/revengai/models/function_info.py +++ b/revengai/models/function_info.py @@ -16,9 +16,9 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict from typing import Any, ClassVar, Dict, List, Optional -from revengai.models.function_info_func_deps_inner import FunctionInfoFuncDepsInner +from revengai.models.function_dependency import FunctionDependency from revengai.models.function_type import FunctionType from typing import Optional, Set from typing_extensions import Self @@ -27,9 +27,10 @@ class FunctionInfo(BaseModel): """ FunctionInfo """ # noqa: E501 + func_deps: Optional[List[FunctionDependency]] func_types: Optional[FunctionType] = None - func_deps: List[FunctionInfoFuncDepsInner] = Field(description="List of function dependencies") - __properties: ClassVar[List[str]] = ["func_types", "func_deps"] + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["func_deps", "func_types"] model_config = ConfigDict( populate_by_name=True, @@ -61,8 +62,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ + "additional_properties", ]) _dict = self.model_dump( @@ -70,9 +73,6 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of func_types - if self.func_types: - _dict['func_types'] = self.func_types.to_dict() # override the default output from pydantic by calling `to_dict()` of each item in func_deps (list) _items = [] if self.func_deps: @@ -80,10 +80,18 @@ def to_dict(self) -> Dict[str, Any]: if _item_func_deps: _items.append(_item_func_deps.to_dict()) _dict['func_deps'] = _items - # set to None if func_types (nullable) is None + # override the default output from pydantic by calling `to_dict()` of func_types + if self.func_types: + _dict['func_types'] = self.func_types.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + # set to None if func_deps (nullable) is None # and model_fields_set contains the field - if self.func_types is None and "func_types" in self.model_fields_set: - _dict['func_types'] = None + if self.func_deps is None and "func_deps" in self.model_fields_set: + _dict['func_deps'] = None return _dict @@ -97,9 +105,14 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "func_types": FunctionType.from_dict(obj["func_types"]) if obj.get("func_types") is not None else None, - "func_deps": [FunctionInfoFuncDepsInner.from_dict(_item) for _item in obj["func_deps"]] if obj.get("func_deps") is not None else None + "func_deps": [FunctionDependency.from_dict(_item) for _item in obj["func_deps"]] if obj.get("func_deps") is not None else None, + "func_types": FunctionType.from_dict(obj["func_types"]) if obj.get("func_types") is not None else None }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + return _obj diff --git a/revengai/models/function_match.py b/revengai/models/function_match.py index 3dc507a..54a2fc7 100644 --- a/revengai/models/function_match.py +++ b/revengai/models/function_match.py @@ -27,10 +27,11 @@ class FunctionMatch(BaseModel): """ FunctionMatch """ # noqa: E501 - function_id: StrictInt = Field(description="Unique identifier of the function") - matched_functions: List[MatchedFunction] - confidences: Optional[List[NameConfidence]] = None - __properties: ClassVar[List[str]] = ["function_id", "matched_functions", "confidences"] + confidences: Optional[List[NameConfidence]] = Field(default=None, description="Per-name confidences when canonify was requested") + function_id: StrictInt = Field(description="Source function ID") + matched_functions: Optional[List[MatchedFunction]] = Field(description="Top candidate matches in similarity-descending order") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["confidences", "function_id", "matched_functions"] model_config = ConfigDict( populate_by_name=True, @@ -62,8 +63,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ + "additional_properties", ]) _dict = self.model_dump( @@ -71,13 +74,6 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # override the default output from pydantic by calling `to_dict()` of each item in matched_functions (list) - _items = [] - if self.matched_functions: - for _item_matched_functions in self.matched_functions: - if _item_matched_functions: - _items.append(_item_matched_functions.to_dict()) - _dict['matched_functions'] = _items # override the default output from pydantic by calling `to_dict()` of each item in confidences (list) _items = [] if self.confidences: @@ -85,11 +81,28 @@ def to_dict(self) -> Dict[str, Any]: if _item_confidences: _items.append(_item_confidences.to_dict()) _dict['confidences'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in matched_functions (list) + _items = [] + if self.matched_functions: + for _item_matched_functions in self.matched_functions: + if _item_matched_functions: + _items.append(_item_matched_functions.to_dict()) + _dict['matched_functions'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + # set to None if confidences (nullable) is None # and model_fields_set contains the field if self.confidences is None and "confidences" in self.model_fields_set: _dict['confidences'] = None + # set to None if matched_functions (nullable) is None + # and model_fields_set contains the field + if self.matched_functions is None and "matched_functions" in self.model_fields_set: + _dict['matched_functions'] = None + return _dict @classmethod @@ -102,10 +115,15 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ + "confidences": [NameConfidence.from_dict(_item) for _item in obj["confidences"]] if obj.get("confidences") is not None else None, "function_id": obj.get("function_id"), - "matched_functions": [MatchedFunction.from_dict(_item) for _item in obj["matched_functions"]] if obj.get("matched_functions") is not None else None, - "confidences": [NameConfidence.from_dict(_item) for _item in obj["confidences"]] if obj.get("confidences") is not None else None + "matched_functions": [MatchedFunction.from_dict(_item) for _item in obj["matched_functions"]] if obj.get("matched_functions") is not None else None }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + return _obj diff --git a/revengai/models/function_matching_response.py b/revengai/models/function_matching_response.py index de3cf32..e22a002 100644 --- a/revengai/models/function_matching_response.py +++ b/revengai/models/function_matching_response.py @@ -18,7 +18,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional -from revengai.models.function_match import FunctionMatch +from revengai.models.v2_function_match import V2FunctionMatch from typing import Optional, Set from typing_extensions import Self @@ -32,7 +32,7 @@ class FunctionMatchingResponse(BaseModel): error_message: Optional[StrictStr] = None current_page: Optional[StrictInt] = None total_pages: Optional[StrictInt] = None - matches: Optional[List[FunctionMatch]] = None + matches: Optional[List[V2FunctionMatch]] = None num_matches: Optional[StrictInt] = None num_debug_matches: Optional[StrictInt] = None updated_at: Optional[StrictStr] = None @@ -147,7 +147,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: "error_message": obj.get("error_message"), "current_page": obj.get("current_page"), "total_pages": obj.get("total_pages"), - "matches": [FunctionMatch.from_dict(_item) for _item in obj["matches"]] if obj.get("matches") is not None else None, + "matches": [V2FunctionMatch.from_dict(_item) for _item in obj["matches"]] if obj.get("matches") is not None else None, "num_matches": obj.get("num_matches"), "num_debug_matches": obj.get("num_debug_matches"), "updated_at": obj.get("updated_at") diff --git a/revengai/models/function_stack_variable.py b/revengai/models/function_stack_variable.py index dbfe824..4221cc8 100644 --- a/revengai/models/function_stack_variable.py +++ b/revengai/models/function_stack_variable.py @@ -27,11 +27,11 @@ class FunctionStackVariable(BaseModel): """ # noqa: E501 addr: StrictInt last_change: Optional[StrictStr] = None - name: Optional[StrictStr] + name: StrictStr offset: StrictInt scope: Optional[StrictStr] = None size: StrictInt - type: Optional[StrictStr] + type: StrictStr additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = ["addr", "last_change", "name", "offset", "scope", "size", "type"] @@ -81,26 +81,6 @@ def to_dict(self) -> Dict[str, Any]: for _key, _value in self.additional_properties.items(): _dict[_key] = _value - # set to None if last_change (nullable) is None - # and model_fields_set contains the field - if self.last_change is None and "last_change" in self.model_fields_set: - _dict['last_change'] = None - - # set to None if name (nullable) is None - # and model_fields_set contains the field - if self.name is None and "name" in self.model_fields_set: - _dict['name'] = None - - # set to None if scope (nullable) is None - # and model_fields_set contains the field - if self.scope is None and "scope" in self.model_fields_set: - _dict['scope'] = None - - # set to None if type (nullable) is None - # and model_fields_set contains the field - if self.type is None and "type" in self.model_fields_set: - _dict['type'] = None - return _dict @classmethod diff --git a/revengai/models/function_type.py b/revengai/models/function_type.py index 5554e58..3365b5a 100644 --- a/revengai/models/function_type.py +++ b/revengai/models/function_type.py @@ -19,7 +19,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from revengai.models.function_header import FunctionHeader -from revengai.models.stack_variable import StackVariable +from revengai.models.function_stack_variable import FunctionStackVariable from typing import Optional, Set from typing_extensions import Self @@ -27,15 +27,17 @@ class FunctionType(BaseModel): """ FunctionType """ # noqa: E501 + addr: StrictInt + artifact_type: Optional[StrictStr] = None + header: FunctionHeader last_change: Optional[StrictStr] = None - addr: StrictInt = Field(description="Memory address of the function") - size: StrictInt = Field(description="Size of the function in bytes") - header: FunctionHeader = Field(description="Function header information") - stack_vars: Optional[Dict[str, StackVariable]] = None - name: StrictStr = Field(description="Name of the function") - type: StrictStr = Field(description="Return type of the function") - artifact_type: Optional[StrictStr] = Field(default='Function', description="Type of artifact that the structure is associated with") - __properties: ClassVar[List[str]] = ["last_change", "addr", "size", "header", "stack_vars", "name", "type", "artifact_type"] + name: StrictStr + scope: Optional[StrictStr] = None + size: StrictInt + stack_vars: Optional[Dict[str, FunctionStackVariable]] = Field(default=None, description="Stack variables keyed by offset hex.") + type: StrictStr + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["addr", "artifact_type", "header", "last_change", "name", "scope", "size", "stack_vars", "type"] model_config = ConfigDict( populate_by_name=True, @@ -67,8 +69,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ + "additional_properties", ]) _dict = self.model_dump( @@ -86,15 +90,10 @@ def to_dict(self) -> Dict[str, Any]: if self.stack_vars[_key_stack_vars]: _field_dict[_key_stack_vars] = self.stack_vars[_key_stack_vars].to_dict() _dict['stack_vars'] = _field_dict - # set to None if last_change (nullable) is None - # and model_fields_set contains the field - if self.last_change is None and "last_change" in self.model_fields_set: - _dict['last_change'] = None - - # set to None if stack_vars (nullable) is None - # and model_fields_set contains the field - if self.stack_vars is None and "stack_vars" in self.model_fields_set: - _dict['stack_vars'] = None + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value return _dict @@ -108,20 +107,26 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "last_change": obj.get("last_change"), "addr": obj.get("addr"), - "size": obj.get("size"), + "artifact_type": obj.get("artifact_type"), "header": FunctionHeader.from_dict(obj["header"]) if obj.get("header") is not None else None, + "last_change": obj.get("last_change"), + "name": obj.get("name"), + "scope": obj.get("scope"), + "size": obj.get("size"), "stack_vars": dict( - (_k, StackVariable.from_dict(_v)) + (_k, FunctionStackVariable.from_dict(_v)) for _k, _v in obj["stack_vars"].items() ) if obj.get("stack_vars") is not None else None, - "name": obj.get("name"), - "type": obj.get("type"), - "artifact_type": obj.get("artifact_type") if obj.get("artifact_type") is not None else 'Function' + "type": obj.get("type") }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + return _obj diff --git a/revengai/models/matched_function.py b/revengai/models/matched_function.py index 4e4bb06..5e7472b 100644 --- a/revengai/models/matched_function.py +++ b/revengai/models/matched_function.py @@ -17,7 +17,7 @@ import json from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr -from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Any, ClassVar, Dict, List, Union from typing import Optional, Set from typing_extensions import Self @@ -25,18 +25,19 @@ class MatchedFunction(BaseModel): """ MatchedFunction """ # noqa: E501 - function_id: StrictInt = Field(description="Unique identifier of the matched function") - binary_id: StrictInt - function_name: StrictStr - function_vaddr: StrictInt - mangled_name: StrictStr - debug: StrictBool - binary_name: StrictStr - sha_256_hash: StrictStr - analysis_id: StrictInt - similarity: Optional[Union[StrictFloat, StrictInt]] = None - confidence: Optional[Union[StrictFloat, StrictInt]] = None - __properties: ClassVar[List[str]] = ["function_id", "binary_id", "function_name", "function_vaddr", "mangled_name", "debug", "binary_name", "sha_256_hash", "analysis_id", "similarity", "confidence"] + analysis_id: StrictInt = Field(description="Analysis the candidate's binary belongs to") + binary_id: StrictInt = Field(description="Binary the candidate belongs to") + binary_name: StrictStr = Field(description="Binary name") + confidence: Union[StrictFloat, StrictInt] = Field(description="Softmax-normalised confidence over the candidate pool") + debug: StrictBool = Field(description="Whether the candidate's name came from debug info") + function_id: StrictInt = Field(description="Candidate function ID") + function_name: StrictStr = Field(description="Candidate function name") + function_vaddr: StrictInt = Field(description="Candidate's virtual address inside its binary") + mangled_name: StrictStr = Field(description="Mangled name when available") + sha_256_hash: StrictStr = Field(description="SHA-256 of the candidate's binary") + similarity: Union[StrictFloat, StrictInt] = Field(description="Cosine similarity scaled to a percentage") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["analysis_id", "binary_id", "binary_name", "confidence", "debug", "function_id", "function_name", "function_vaddr", "mangled_name", "sha_256_hash", "similarity"] model_config = ConfigDict( populate_by_name=True, @@ -68,8 +69,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ + "additional_properties", ]) _dict = self.model_dump( @@ -77,15 +80,10 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) - # set to None if similarity (nullable) is None - # and model_fields_set contains the field - if self.similarity is None and "similarity" in self.model_fields_set: - _dict['similarity'] = None - - # set to None if confidence (nullable) is None - # and model_fields_set contains the field - if self.confidence is None and "confidence" in self.model_fields_set: - _dict['confidence'] = None + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value return _dict @@ -99,18 +97,23 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "function_id": obj.get("function_id"), + "analysis_id": obj.get("analysis_id"), "binary_id": obj.get("binary_id"), + "binary_name": obj.get("binary_name"), + "confidence": obj.get("confidence"), + "debug": obj.get("debug"), + "function_id": obj.get("function_id"), "function_name": obj.get("function_name"), "function_vaddr": obj.get("function_vaddr"), "mangled_name": obj.get("mangled_name"), - "debug": obj.get("debug"), - "binary_name": obj.get("binary_name"), "sha_256_hash": obj.get("sha_256_hash"), - "analysis_id": obj.get("analysis_id"), - "similarity": obj.get("similarity"), - "confidence": obj.get("confidence") + "similarity": obj.get("similarity") }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + return _obj diff --git a/revengai/models/name_confidence.py b/revengai/models/name_confidence.py index 5b71f3a..f9779b2 100644 --- a/revengai/models/name_confidence.py +++ b/revengai/models/name_confidence.py @@ -16,9 +16,8 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Union -from typing_extensions import Annotated from typing import Optional, Set from typing_extensions import Self @@ -26,9 +25,10 @@ class NameConfidence(BaseModel): """ NameConfidence """ # noqa: E501 - name: StrictStr = Field(description="The suggested function name") - confidence: Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(description="Confidence score as a percentage") - __properties: ClassVar[List[str]] = ["name", "confidence"] + confidence: Union[StrictFloat, StrictInt] = Field(description="Softmax-normalised confidence for this name") + name: StrictStr = Field(description="Candidate name") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["confidence", "name"] model_config = ConfigDict( populate_by_name=True, @@ -60,8 +60,10 @@ def to_dict(self) -> Dict[str, Any]: * `None` is only added to the output dict for nullable fields that were set at model initialization. Other fields with value `None` are ignored. + * Fields in `self.additional_properties` are added to the output dict. """ excluded_fields: Set[str] = set([ + "additional_properties", ]) _dict = self.model_dump( @@ -69,6 +71,11 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + return _dict @classmethod @@ -81,9 +88,14 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "name": obj.get("name"), - "confidence": obj.get("confidence") + "confidence": obj.get("confidence"), + "name": obj.get("name") }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + return _obj diff --git a/revengai/models/update_profile_input_body.py b/revengai/models/update_profile_input_body.py index b5af22c..f1253d5 100644 --- a/revengai/models/update_profile_input_body.py +++ b/revengai/models/update_profile_input_body.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, Field +from pydantic import BaseModel, ConfigDict, Field, StrictBool from typing import Any, ClassVar, Dict, List, Optional from typing_extensions import Annotated from typing import Optional, Set @@ -28,11 +28,12 @@ class UpdateProfileInputBody(BaseModel): """ # noqa: E501 default_team_id: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=None, description="Default team ID") first_name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="First name") + hide_example_binaries: Optional[StrictBool] = Field(default=None, description="Hide the Examples tab in the analyses listing") last_name: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Last name") time_zone: Optional[Annotated[str, Field(strict=True, max_length=64)]] = Field(default=None, description="IANA time zone") username: Optional[Annotated[str, Field(strict=True, max_length=255)]] = Field(default=None, description="Username") additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["default_team_id", "first_name", "last_name", "time_zone", "username"] + __properties: ClassVar[List[str]] = ["default_team_id", "first_name", "hide_example_binaries", "last_name", "time_zone", "username"] model_config = ConfigDict( populate_by_name=True, @@ -94,6 +95,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "default_team_id": obj.get("default_team_id"), "first_name": obj.get("first_name"), + "hide_example_binaries": obj.get("hide_example_binaries"), "last_name": obj.get("last_name"), "time_zone": obj.get("time_zone"), "username": obj.get("username") diff --git a/revengai/models/user_profile.py b/revengai/models/user_profile.py index d5f443b..e31fa9e 100644 --- a/revengai/models/user_profile.py +++ b/revengai/models/user_profile.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List, Optional from typing import Optional, Set from typing_extensions import Self @@ -27,11 +27,12 @@ class UserProfile(BaseModel): """ # noqa: E501 default_team_id: Optional[StrictInt] = None first_name: StrictStr + hide_example_binaries: StrictBool last_name: StrictStr time_zone: StrictStr username: StrictStr additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["default_team_id", "first_name", "last_name", "time_zone", "username"] + __properties: ClassVar[List[str]] = ["default_team_id", "first_name", "hide_example_binaries", "last_name", "time_zone", "username"] model_config = ConfigDict( populate_by_name=True, @@ -93,6 +94,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "default_team_id": obj.get("default_team_id"), "first_name": obj.get("first_name"), + "hide_example_binaries": obj.get("hide_example_binaries"), "last_name": obj.get("last_name"), "time_zone": obj.get("time_zone"), "username": obj.get("username") diff --git a/revengai/models/v2_function_header.py b/revengai/models/v2_function_header.py new file mode 100644 index 0000000..1a950bb --- /dev/null +++ b/revengai/models/v2_function_header.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + RevEng.AI API + + RevEng.AI is an AI-powered binary analysis platform for reverse engineering and malware analysis. It provides similarity search across executable binaries and functions, AI-driven decompilation, dynamic execution analysis, firmware unpacking, and integration with external threat intelligence sources like VirusTotal. + + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from revengai.models.argument import Argument +from typing import Optional, Set +from typing_extensions import Self + +class V2FunctionHeader(BaseModel): + """ + V2FunctionHeader + """ # noqa: E501 + last_change: Optional[StrictStr] = None + name: StrictStr = Field(description="Name of the function") + addr: StrictInt = Field(description="Memory address of the function") + type: StrictStr = Field(description="Return type of the function") + args: Dict[str, Argument] = Field(description="Dictionary of function arguments") + __properties: ClassVar[List[str]] = ["last_change", "name", "addr", "type", "args"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of V2FunctionHeader from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each value in args (dict) + _field_dict = {} + if self.args: + for _key_args in self.args: + if self.args[_key_args]: + _field_dict[_key_args] = self.args[_key_args].to_dict() + _dict['args'] = _field_dict + # set to None if last_change (nullable) is None + # and model_fields_set contains the field + if self.last_change is None and "last_change" in self.model_fields_set: + _dict['last_change'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of V2FunctionHeader from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "last_change": obj.get("last_change"), + "name": obj.get("name"), + "addr": obj.get("addr"), + "type": obj.get("type"), + "args": dict( + (_k, Argument.from_dict(_v)) + for _k, _v in obj["args"].items() + ) + if obj.get("args") is not None + else None + }) + return _obj + + diff --git a/revengai/models/v2_function_info.py b/revengai/models/v2_function_info.py new file mode 100644 index 0000000..0dd6e9e --- /dev/null +++ b/revengai/models/v2_function_info.py @@ -0,0 +1,105 @@ +# coding: utf-8 + +""" + RevEng.AI API + + RevEng.AI is an AI-powered binary analysis platform for reverse engineering and malware analysis. It provides similarity search across executable binaries and functions, AI-driven decompilation, dynamic execution analysis, firmware unpacking, and integration with external threat intelligence sources like VirusTotal. + + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from revengai.models.v2_function_info_func_deps_inner import V2FunctionInfoFuncDepsInner +from revengai.models.v2_function_type import V2FunctionType +from typing import Optional, Set +from typing_extensions import Self + +class V2FunctionInfo(BaseModel): + """ + V2FunctionInfo + """ # noqa: E501 + func_types: Optional[V2FunctionType] = None + func_deps: List[V2FunctionInfoFuncDepsInner] = Field(description="List of function dependencies") + __properties: ClassVar[List[str]] = ["func_types", "func_deps"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of V2FunctionInfo from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of func_types + if self.func_types: + _dict['func_types'] = self.func_types.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in func_deps (list) + _items = [] + if self.func_deps: + for _item_func_deps in self.func_deps: + if _item_func_deps: + _items.append(_item_func_deps.to_dict()) + _dict['func_deps'] = _items + # set to None if func_types (nullable) is None + # and model_fields_set contains the field + if self.func_types is None and "func_types" in self.model_fields_set: + _dict['func_types'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of V2FunctionInfo from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "func_types": V2FunctionType.from_dict(obj["func_types"]) if obj.get("func_types") is not None else None, + "func_deps": [V2FunctionInfoFuncDepsInner.from_dict(_item) for _item in obj["func_deps"]] if obj.get("func_deps") is not None else None + }) + return _obj + + diff --git a/revengai/models/function_info_func_deps_inner.py b/revengai/models/v2_function_info_func_deps_inner.py similarity index 91% rename from revengai/models/function_info_func_deps_inner.py rename to revengai/models/v2_function_info_func_deps_inner.py index 32478f3..40cfa58 100644 --- a/revengai/models/function_info_func_deps_inner.py +++ b/revengai/models/v2_function_info_func_deps_inner.py @@ -26,11 +26,11 @@ from typing_extensions import Literal, Self from pydantic import Field -FUNCTIONINFOFUNCDEPSINNER_ANY_OF_SCHEMAS = ["Enumeration", "GlobalVariable", "Structure", "TypeDefinition"] +V2FUNCTIONINFOFUNCDEPSINNER_ANY_OF_SCHEMAS = ["Enumeration", "GlobalVariable", "Structure", "TypeDefinition"] -class FunctionInfoFuncDepsInner(BaseModel): +class V2FunctionInfoFuncDepsInner(BaseModel): """ - FunctionInfoFuncDepsInner + V2FunctionInfoFuncDepsInner """ # data type: Structure @@ -64,7 +64,7 @@ def __init__(self, *args, **kwargs) -> None: @field_validator('actual_instance') def actual_instance_must_validate_anyof(cls, v): - instance = FunctionInfoFuncDepsInner.model_construct() + instance = V2FunctionInfoFuncDepsInner.model_construct() error_messages = [] # validate data type: Structure if not isinstance(v, Structure): @@ -92,7 +92,7 @@ def actual_instance_must_validate_anyof(cls, v): if error_messages: # no match - raise ValueError("No match found when setting the actual_instance in FunctionInfoFuncDepsInner with anyOf schemas: Enumeration, GlobalVariable, Structure, TypeDefinition. Details: " + ", ".join(error_messages)) + raise ValueError("No match found when setting the actual_instance in V2FunctionInfoFuncDepsInner with anyOf schemas: Enumeration, GlobalVariable, Structure, TypeDefinition. Details: " + ", ".join(error_messages)) else: return v @@ -132,7 +132,7 @@ def from_json(cls, json_str: str) -> Self: if error_messages: # no match - raise ValueError("No match found when deserializing the JSON string into FunctionInfoFuncDepsInner with anyOf schemas: Enumeration, GlobalVariable, Structure, TypeDefinition. Details: " + ", ".join(error_messages)) + raise ValueError("No match found when deserializing the JSON string into V2FunctionInfoFuncDepsInner with anyOf schemas: Enumeration, GlobalVariable, Structure, TypeDefinition. Details: " + ", ".join(error_messages)) else: return instance diff --git a/revengai/models/v2_function_match.py b/revengai/models/v2_function_match.py new file mode 100644 index 0000000..d3eada6 --- /dev/null +++ b/revengai/models/v2_function_match.py @@ -0,0 +1,111 @@ +# coding: utf-8 + +""" + RevEng.AI API + + RevEng.AI is an AI-powered binary analysis platform for reverse engineering and malware analysis. It provides similarity search across executable binaries and functions, AI-driven decompilation, dynamic execution analysis, firmware unpacking, and integration with external threat intelligence sources like VirusTotal. + + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt +from typing import Any, ClassVar, Dict, List, Optional +from revengai.models.v2_matched_function import V2MatchedFunction +from revengai.models.v2_name_confidence import V2NameConfidence +from typing import Optional, Set +from typing_extensions import Self + +class V2FunctionMatch(BaseModel): + """ + V2FunctionMatch + """ # noqa: E501 + function_id: StrictInt = Field(description="Unique identifier of the function") + matched_functions: List[V2MatchedFunction] + confidences: Optional[List[V2NameConfidence]] = None + __properties: ClassVar[List[str]] = ["function_id", "matched_functions", "confidences"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of V2FunctionMatch from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in matched_functions (list) + _items = [] + if self.matched_functions: + for _item_matched_functions in self.matched_functions: + if _item_matched_functions: + _items.append(_item_matched_functions.to_dict()) + _dict['matched_functions'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in confidences (list) + _items = [] + if self.confidences: + for _item_confidences in self.confidences: + if _item_confidences: + _items.append(_item_confidences.to_dict()) + _dict['confidences'] = _items + # set to None if confidences (nullable) is None + # and model_fields_set contains the field + if self.confidences is None and "confidences" in self.model_fields_set: + _dict['confidences'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of V2FunctionMatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "function_id": obj.get("function_id"), + "matched_functions": [V2MatchedFunction.from_dict(_item) for _item in obj["matched_functions"]] if obj.get("matched_functions") is not None else None, + "confidences": [V2NameConfidence.from_dict(_item) for _item in obj["confidences"]] if obj.get("confidences") is not None else None + }) + return _obj + + diff --git a/revengai/models/v2_function_type.py b/revengai/models/v2_function_type.py new file mode 100644 index 0000000..92a5952 --- /dev/null +++ b/revengai/models/v2_function_type.py @@ -0,0 +1,127 @@ +# coding: utf-8 + +""" + RevEng.AI API + + RevEng.AI is an AI-powered binary analysis platform for reverse engineering and malware analysis. It provides similarity search across executable binaries and functions, AI-driven decompilation, dynamic execution analysis, firmware unpacking, and integration with external threat intelligence sources like VirusTotal. + + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from revengai.models.stack_variable import StackVariable +from revengai.models.v2_function_header import V2FunctionHeader +from typing import Optional, Set +from typing_extensions import Self + +class V2FunctionType(BaseModel): + """ + V2FunctionType + """ # noqa: E501 + last_change: Optional[StrictStr] = None + addr: StrictInt = Field(description="Memory address of the function") + size: StrictInt = Field(description="Size of the function in bytes") + header: V2FunctionHeader = Field(description="Function header information") + stack_vars: Optional[Dict[str, StackVariable]] = None + name: StrictStr = Field(description="Name of the function") + type: StrictStr = Field(description="Return type of the function") + artifact_type: Optional[StrictStr] = Field(default='Function', description="Type of artifact that the structure is associated with") + __properties: ClassVar[List[str]] = ["last_change", "addr", "size", "header", "stack_vars", "name", "type", "artifact_type"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of V2FunctionType from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of header + if self.header: + _dict['header'] = self.header.to_dict() + # override the default output from pydantic by calling `to_dict()` of each value in stack_vars (dict) + _field_dict = {} + if self.stack_vars: + for _key_stack_vars in self.stack_vars: + if self.stack_vars[_key_stack_vars]: + _field_dict[_key_stack_vars] = self.stack_vars[_key_stack_vars].to_dict() + _dict['stack_vars'] = _field_dict + # set to None if last_change (nullable) is None + # and model_fields_set contains the field + if self.last_change is None and "last_change" in self.model_fields_set: + _dict['last_change'] = None + + # set to None if stack_vars (nullable) is None + # and model_fields_set contains the field + if self.stack_vars is None and "stack_vars" in self.model_fields_set: + _dict['stack_vars'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of V2FunctionType from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "last_change": obj.get("last_change"), + "addr": obj.get("addr"), + "size": obj.get("size"), + "header": V2FunctionHeader.from_dict(obj["header"]) if obj.get("header") is not None else None, + "stack_vars": dict( + (_k, StackVariable.from_dict(_v)) + for _k, _v in obj["stack_vars"].items() + ) + if obj.get("stack_vars") is not None + else None, + "name": obj.get("name"), + "type": obj.get("type"), + "artifact_type": obj.get("artifact_type") if obj.get("artifact_type") is not None else 'Function' + }) + return _obj + + diff --git a/revengai/models/v2_matched_function.py b/revengai/models/v2_matched_function.py new file mode 100644 index 0000000..6fde312 --- /dev/null +++ b/revengai/models/v2_matched_function.py @@ -0,0 +1,116 @@ +# coding: utf-8 + +""" + RevEng.AI API + + RevEng.AI is an AI-powered binary analysis platform for reverse engineering and malware analysis. It provides similarity search across executable binaries and functions, AI-driven decompilation, dynamic execution analysis, firmware unpacking, and integration with external threat intelligence sources like VirusTotal. + + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional, Union +from typing import Optional, Set +from typing_extensions import Self + +class V2MatchedFunction(BaseModel): + """ + V2MatchedFunction + """ # noqa: E501 + function_id: StrictInt = Field(description="Unique identifier of the matched function") + binary_id: StrictInt + function_name: StrictStr + function_vaddr: StrictInt + mangled_name: StrictStr + debug: StrictBool + binary_name: StrictStr + sha_256_hash: StrictStr + analysis_id: StrictInt + similarity: Optional[Union[StrictFloat, StrictInt]] = None + confidence: Optional[Union[StrictFloat, StrictInt]] = None + __properties: ClassVar[List[str]] = ["function_id", "binary_id", "function_name", "function_vaddr", "mangled_name", "debug", "binary_name", "sha_256_hash", "analysis_id", "similarity", "confidence"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of V2MatchedFunction from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # set to None if similarity (nullable) is None + # and model_fields_set contains the field + if self.similarity is None and "similarity" in self.model_fields_set: + _dict['similarity'] = None + + # set to None if confidence (nullable) is None + # and model_fields_set contains the field + if self.confidence is None and "confidence" in self.model_fields_set: + _dict['confidence'] = None + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of V2MatchedFunction from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "function_id": obj.get("function_id"), + "binary_id": obj.get("binary_id"), + "function_name": obj.get("function_name"), + "function_vaddr": obj.get("function_vaddr"), + "mangled_name": obj.get("mangled_name"), + "debug": obj.get("debug"), + "binary_name": obj.get("binary_name"), + "sha_256_hash": obj.get("sha_256_hash"), + "analysis_id": obj.get("analysis_id"), + "similarity": obj.get("similarity"), + "confidence": obj.get("confidence") + }) + return _obj + + diff --git a/revengai/models/v2_name_confidence.py b/revengai/models/v2_name_confidence.py new file mode 100644 index 0000000..81bb672 --- /dev/null +++ b/revengai/models/v2_name_confidence.py @@ -0,0 +1,89 @@ +# coding: utf-8 + +""" + RevEng.AI API + + RevEng.AI is an AI-powered binary analysis platform for reverse engineering and malware analysis. It provides similarity search across executable binaries and functions, AI-driven decompilation, dynamic execution analysis, firmware unpacking, and integration with external threat intelligence sources like VirusTotal. + + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Union +from typing_extensions import Annotated +from typing import Optional, Set +from typing_extensions import Self + +class V2NameConfidence(BaseModel): + """ + V2NameConfidence + """ # noqa: E501 + name: StrictStr = Field(description="The suggested function name") + confidence: Union[Annotated[float, Field(le=100, strict=True, ge=0)], Annotated[int, Field(le=100, strict=True, ge=0)]] = Field(description="Confidence score as a percentage") + __properties: ClassVar[List[str]] = ["name", "confidence"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of V2NameConfidence from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + """ + excluded_fields: Set[str] = set([ + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of V2NameConfidence from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": obj.get("name"), + "confidence": obj.get("confidence") + }) + return _obj + +