diff --git a/.sdk-version b/.sdk-version index b77e3cc..7227c77 100644 --- a/.sdk-version +++ b/.sdk-version @@ -1 +1 @@ -v2.8.0 +v2.9.1 diff --git a/docs/CalleeFunctionInfo.md b/docs/CalleeFunctionInfo.md index 299bbd0..419844d 100644 --- a/docs/CalleeFunctionInfo.md +++ b/docs/CalleeFunctionInfo.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**function_id** | **int** | | +**function_id** | **int** | Unique identifier of the function | **matched_function_id** | **int** | | **dashboard_url** | **str** | | **is_external** | **bool** | Indicates if the function is external | [optional] [default to False] diff --git a/docs/CallerFunctionInfo.md b/docs/CallerFunctionInfo.md index 7e32630..18822ef 100644 --- a/docs/CallerFunctionInfo.md +++ b/docs/CallerFunctionInfo.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**function_id** | **int** | | +**function_id** | **int** | Unique identifier of the function | **matched_function_id** | **int** | | **dashboard_url** | **str** | | **is_external** | **bool** | Indicates if the function is external | [optional] [default to False] diff --git a/docs/DecompilationResponse.md b/docs/DecompilationResponse.md index 4932307..d1ace6d 100644 --- a/docs/DecompilationResponse.md +++ b/docs/DecompilationResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**function_id** | **int** | | +**function_id** | **int** | The ID of the function | **decompilation** | **str** | | **calling_convention** | **str** | | diff --git a/docs/FunctionMatchingResultWithBestMatch.md b/docs/FunctionMatchingResultWithBestMatch.md index 5437700..1b7e5bd 100644 --- a/docs/FunctionMatchingResultWithBestMatch.md +++ b/docs/FunctionMatchingResultWithBestMatch.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**function_id** | **int** | | +**function_id** | **int** | Unique identifier of the function | **matched_functions** | [**List[MatchedFunction]**](MatchedFunction.md) | | **confidences** | [**List[NameConfidence]**](NameConfidence.md) | | [optional] diff --git a/docs/FunctionsAIDecompilationApi.md b/docs/FunctionsAIDecompilationApi.md index 95bc0cb..2d9f89e 100644 --- a/docs/FunctionsAIDecompilationApi.md +++ b/docs/FunctionsAIDecompilationApi.md @@ -137,7 +137,7 @@ configuration.api_key['APIKey'] = os.environ["API_KEY"] with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = revengai.FunctionsAIDecompilationApi(api_client) - function_id = 56 # int | + function_id = 56 # int | The ID of the function for which we are creating the decompilation task try: # Begins AI Decompilation Process @@ -155,7 +155,7 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **function_id** | **int**| | + **function_id** | **int**| The ID of the function for which we are creating the decompilation task | ### Return type @@ -383,7 +383,7 @@ configuration.api_key['APIKey'] = os.environ["API_KEY"] with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = revengai.FunctionsAIDecompilationApi(api_client) - function_id = 56 # int | + function_id = 56 # int | The ID of the function for which to get the rating try: # Get rating for AI decompilation @@ -401,7 +401,7 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **function_id** | **int**| | + **function_id** | **int**| The ID of the function for which to get the rating | ### Return type @@ -463,7 +463,7 @@ configuration.api_key['APIKey'] = os.environ["API_KEY"] with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = revengai.FunctionsAIDecompilationApi(api_client) - function_id = 56 # int | + function_id = 56 # int | The ID of the function being decompiled summarise = True # bool | Generate a summary for the decompilation (optional) (default to True) generate_inline_comments = True # bool | Generate inline comments for the decompilation (only works if summarise is enabled) (optional) (default to True) @@ -483,7 +483,7 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **function_id** | **int**| | + **function_id** | **int**| The ID of the function being decompiled | **summarise** | **bool**| Generate a summary for the decompilation | [optional] [default to True] **generate_inline_comments** | **bool**| Generate inline comments for the decompilation (only works if summarise is enabled) | [optional] [default to True] @@ -546,7 +546,7 @@ configuration.api_key['APIKey'] = os.environ["API_KEY"] with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = revengai.FunctionsAIDecompilationApi(api_client) - function_id = 56 # int | + function_id = 56 # int | The ID of the function being checked try: # Check the status of a function ai decompilation @@ -564,7 +564,7 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **function_id** | **int**| | + **function_id** | **int**| The ID of the function being checked | ### Return type @@ -712,7 +712,7 @@ configuration.api_key['APIKey'] = os.environ["API_KEY"] with revengai.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = revengai.FunctionsAIDecompilationApi(api_client) - function_id = 56 # int | + function_id = 56 # int | The ID of the function being rated upsert_ai_decomplation_rating_request = revengai.UpsertAiDecomplationRatingRequest() # UpsertAiDecomplationRatingRequest | try: @@ -731,7 +731,7 @@ with revengai.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **function_id** | **int**| | + **function_id** | **int**| The ID of the function being rated | **upsert_ai_decomplation_rating_request** | [**UpsertAiDecomplationRatingRequest**](UpsertAiDecomplationRatingRequest.md)| | ### Return type diff --git a/docs/FunctionsDetailResponse.md b/docs/FunctionsDetailResponse.md index 20ae267..ba30a90 100644 --- a/docs/FunctionsDetailResponse.md +++ b/docs/FunctionsDetailResponse.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**function_id** | **int** | | +**function_id** | **int** | Function id | **function_name** | **str** | | **function_vaddr** | **int** | | **function_size** | **int** | | diff --git a/docs/MatchedFunction.md b/docs/MatchedFunction.md index e168f5c..0f9986b 100644 --- a/docs/MatchedFunction.md +++ b/docs/MatchedFunction.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**function_id** | **int** | | +**function_id** | **int** | Unique identifier of the matched function | **binary_id** | **int** | | **function_name** | **str** | | **function_vaddr** | **int** | | diff --git a/revengai/__init__.py b/revengai/__init__.py index 6b3f9e7..b95a5b8 100644 --- a/revengai/__init__.py +++ b/revengai/__init__.py @@ -13,7 +13,7 @@ """ # noqa: E501 -__version__ = "v2.8.0" +__version__ = "v2.9.1" # Define package exports __all__ = [ diff --git a/revengai/api/functions_ai_decompilation_api.py b/revengai/api/functions_ai_decompilation_api.py index 321be0f..4e96410 100644 --- a/revengai/api/functions_ai_decompilation_api.py +++ b/revengai/api/functions_ai_decompilation_api.py @@ -345,7 +345,7 @@ def _create_ai_decompilation_comment_serialize( @validate_call def create_ai_decompilation_task( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function for which we are creating the decompilation task")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -363,7 +363,7 @@ def create_ai_decompilation_task( Begins the AI Decompilation Process - :param function_id: (required) + :param function_id: The ID of the function for which we are creating the decompilation task (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -417,7 +417,7 @@ def create_ai_decompilation_task( @validate_call def create_ai_decompilation_task_with_http_info( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function for which we are creating the decompilation task")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -435,7 +435,7 @@ def create_ai_decompilation_task_with_http_info( Begins the AI Decompilation Process - :param function_id: (required) + :param function_id: The ID of the function for which we are creating the decompilation task (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -489,7 +489,7 @@ def create_ai_decompilation_task_with_http_info( @validate_call def create_ai_decompilation_task_without_preload_content( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function for which we are creating the decompilation task")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -507,7 +507,7 @@ def create_ai_decompilation_task_without_preload_content( Begins the AI Decompilation Process - :param function_id: (required) + :param function_id: The ID of the function for which we are creating the decompilation task (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1170,7 +1170,7 @@ def _get_ai_decompilation_comments_serialize( @validate_call def get_ai_decompilation_rating( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function for which to get the rating")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1187,7 +1187,7 @@ def get_ai_decompilation_rating( """Get rating for AI decompilation - :param function_id: (required) + :param function_id: The ID of the function for which to get the rating (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1237,7 +1237,7 @@ def get_ai_decompilation_rating( @validate_call def get_ai_decompilation_rating_with_http_info( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function for which to get the rating")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1254,7 +1254,7 @@ def get_ai_decompilation_rating_with_http_info( """Get rating for AI decompilation - :param function_id: (required) + :param function_id: The ID of the function for which to get the rating (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1304,7 +1304,7 @@ def get_ai_decompilation_rating_with_http_info( @validate_call def get_ai_decompilation_rating_without_preload_content( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function for which to get the rating")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1321,7 +1321,7 @@ def get_ai_decompilation_rating_without_preload_content( """Get rating for AI decompilation - :param function_id: (required) + :param function_id: The ID of the function for which to get the rating (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1431,7 +1431,7 @@ def _get_ai_decompilation_rating_serialize( @validate_call def get_ai_decompilation_task_result( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function being decompiled")], summarise: Annotated[Optional[StrictBool], Field(description="Generate a summary for the decompilation")] = None, generate_inline_comments: Annotated[Optional[StrictBool], Field(description="Generate inline comments for the decompilation (only works if summarise is enabled)")] = None, _request_timeout: Union[ @@ -1451,7 +1451,7 @@ def get_ai_decompilation_task_result( Polls the AI Decompilation Process - :param function_id: (required) + :param function_id: The ID of the function being decompiled (required) :type function_id: int :param summarise: Generate a summary for the decompilation :type summarise: bool @@ -1508,7 +1508,7 @@ def get_ai_decompilation_task_result( @validate_call def get_ai_decompilation_task_result_with_http_info( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function being decompiled")], summarise: Annotated[Optional[StrictBool], Field(description="Generate a summary for the decompilation")] = None, generate_inline_comments: Annotated[Optional[StrictBool], Field(description="Generate inline comments for the decompilation (only works if summarise is enabled)")] = None, _request_timeout: Union[ @@ -1528,7 +1528,7 @@ def get_ai_decompilation_task_result_with_http_info( Polls the AI Decompilation Process - :param function_id: (required) + :param function_id: The ID of the function being decompiled (required) :type function_id: int :param summarise: Generate a summary for the decompilation :type summarise: bool @@ -1585,7 +1585,7 @@ def get_ai_decompilation_task_result_with_http_info( @validate_call def get_ai_decompilation_task_result_without_preload_content( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function being decompiled")], summarise: Annotated[Optional[StrictBool], Field(description="Generate a summary for the decompilation")] = None, generate_inline_comments: Annotated[Optional[StrictBool], Field(description="Generate inline comments for the decompilation (only works if summarise is enabled)")] = None, _request_timeout: Union[ @@ -1605,7 +1605,7 @@ def get_ai_decompilation_task_result_without_preload_content( Polls the AI Decompilation Process - :param function_id: (required) + :param function_id: The ID of the function being decompiled (required) :type function_id: int :param summarise: Generate a summary for the decompilation :type summarise: bool @@ -1732,7 +1732,7 @@ def _get_ai_decompilation_task_result_serialize( @validate_call def get_ai_decompilation_task_status( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function being checked")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1749,7 +1749,7 @@ def get_ai_decompilation_task_status( """Check the status of a function ai decompilation - :param function_id: (required) + :param function_id: The ID of the function being checked (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1799,7 +1799,7 @@ def get_ai_decompilation_task_status( @validate_call def get_ai_decompilation_task_status_with_http_info( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function being checked")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1816,7 +1816,7 @@ def get_ai_decompilation_task_status_with_http_info( """Check the status of a function ai decompilation - :param function_id: (required) + :param function_id: The ID of the function being checked (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -1866,7 +1866,7 @@ def get_ai_decompilation_task_status_with_http_info( @validate_call def get_ai_decompilation_task_status_without_preload_content( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function being checked")], _request_timeout: Union[ None, Annotated[StrictFloat, Field(gt=0)], @@ -1883,7 +1883,7 @@ def get_ai_decompilation_task_status_without_preload_content( """Check the status of a function ai decompilation - :param function_id: (required) + :param function_id: The ID of the function being checked (required) :type function_id: int :param _request_timeout: timeout setting for this request. If one number provided, it will be total request @@ -2306,7 +2306,7 @@ def _update_ai_decompilation_comment_serialize( @validate_call def upsert_ai_decompilation_rating( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function being rated")], upsert_ai_decomplation_rating_request: UpsertAiDecomplationRatingRequest, _request_timeout: Union[ None, @@ -2324,7 +2324,7 @@ def upsert_ai_decompilation_rating( """Upsert rating for AI decompilation - :param function_id: (required) + :param function_id: The ID of the function being rated (required) :type function_id: int :param upsert_ai_decomplation_rating_request: (required) :type upsert_ai_decomplation_rating_request: UpsertAiDecomplationRatingRequest @@ -2377,7 +2377,7 @@ def upsert_ai_decompilation_rating( @validate_call def upsert_ai_decompilation_rating_with_http_info( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function being rated")], upsert_ai_decomplation_rating_request: UpsertAiDecomplationRatingRequest, _request_timeout: Union[ None, @@ -2395,7 +2395,7 @@ def upsert_ai_decompilation_rating_with_http_info( """Upsert rating for AI decompilation - :param function_id: (required) + :param function_id: The ID of the function being rated (required) :type function_id: int :param upsert_ai_decomplation_rating_request: (required) :type upsert_ai_decomplation_rating_request: UpsertAiDecomplationRatingRequest @@ -2448,7 +2448,7 @@ def upsert_ai_decompilation_rating_with_http_info( @validate_call def upsert_ai_decompilation_rating_without_preload_content( self, - function_id: StrictInt, + function_id: Annotated[StrictInt, Field(description="The ID of the function being rated")], upsert_ai_decomplation_rating_request: UpsertAiDecomplationRatingRequest, _request_timeout: Union[ None, @@ -2466,7 +2466,7 @@ def upsert_ai_decompilation_rating_without_preload_content( """Upsert rating for AI decompilation - :param function_id: (required) + :param function_id: The ID of the function being rated (required) :type function_id: int :param upsert_ai_decomplation_rating_request: (required) :type upsert_ai_decomplation_rating_request: UpsertAiDecomplationRatingRequest diff --git a/revengai/api_client.py b/revengai/api_client.py index d70d1ce..97d1328 100644 --- a/revengai/api_client.py +++ b/revengai/api_client.py @@ -90,7 +90,7 @@ def __init__( self.default_headers[header_name] = header_value self.cookie = cookie # Set default User-Agent. - self.user_agent = 'OpenAPI-Generator/v2.8.0/python' + self.user_agent = 'OpenAPI-Generator/v2.9.1/python' self.client_side_validation = configuration.client_side_validation def __enter__(self): diff --git a/revengai/configuration.py b/revengai/configuration.py index 0020ccb..bb4d10b 100644 --- a/revengai/configuration.py +++ b/revengai/configuration.py @@ -529,8 +529,8 @@ def to_debug_report(self) -> str: return "Python SDK Debug Report:\n"\ "OS: {env}\n"\ "Python Version: {pyversion}\n"\ - "Version of the API: v2.8.0\n"\ - "SDK Package Version: v2.8.0".\ + "Version of the API: v2.9.1\n"\ + "SDK Package Version: v2.9.1".\ format(env=sys.platform, pyversion=sys.version) def get_host_settings(self) -> List[HostSetting]: diff --git a/revengai/models/callee_function_info.py b/revengai/models/callee_function_info.py index 50c6596..eeb2ec1 100644 --- a/revengai/models/callee_function_info.py +++ b/revengai/models/callee_function_info.py @@ -25,7 +25,7 @@ class CalleeFunctionInfo(BaseModel): """ CalleeFunctionInfo """ # noqa: E501 - function_id: StrictInt + function_id: StrictInt = Field(description="Unique identifier of the function") matched_function_id: Optional[StrictInt] dashboard_url: Optional[StrictStr] is_external: Optional[StrictBool] = Field(default=False, description="Indicates if the function is external") diff --git a/revengai/models/caller_function_info.py b/revengai/models/caller_function_info.py index 3157711..955664a 100644 --- a/revengai/models/caller_function_info.py +++ b/revengai/models/caller_function_info.py @@ -25,7 +25,7 @@ class CallerFunctionInfo(BaseModel): """ CallerFunctionInfo """ # noqa: E501 - function_id: StrictInt + function_id: StrictInt = Field(description="Unique identifier of the function") matched_function_id: Optional[StrictInt] dashboard_url: Optional[StrictStr] is_external: Optional[StrictBool] = Field(default=False, description="Indicates if the function is external") diff --git a/revengai/models/decompilation_response.py b/revengai/models/decompilation_response.py index 859d82f..dbcda5e 100644 --- a/revengai/models/decompilation_response.py +++ b/revengai/models/decompilation_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr +from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr from typing import Any, ClassVar, Dict, List from typing import Optional, Set from typing_extensions import Self @@ -25,7 +25,7 @@ class DecompilationResponse(BaseModel): """ DecompilationResponse """ # noqa: E501 - function_id: StrictInt + function_id: StrictInt = Field(description="The ID of the function") decompilation: StrictStr calling_convention: StrictStr __properties: ClassVar[List[str]] = ["function_id", "decompilation", "calling_convention"] diff --git a/revengai/models/function_matching_result_with_best_match.py b/revengai/models/function_matching_result_with_best_match.py index 29e8267..3313e8f 100644 --- a/revengai/models/function_matching_result_with_best_match.py +++ b/revengai/models/function_matching_result_with_best_match.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictInt +from pydantic import BaseModel, ConfigDict, Field, StrictInt from typing import Any, ClassVar, Dict, List, Optional from revengai.models.matched_function import MatchedFunction from revengai.models.name_confidence import NameConfidence @@ -27,7 +27,7 @@ class FunctionMatchingResultWithBestMatch(BaseModel): """ FunctionMatchingResultWithBestMatch """ # noqa: E501 - function_id: StrictInt + 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"] diff --git a/revengai/models/functions_detail_response.py b/revengai/models/functions_detail_response.py index 75131e0..c4f4cfe 100644 --- a/revengai/models/functions_detail_response.py +++ b/revengai/models/functions_detail_response.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictBool, StrictFloat, StrictInt, StrictStr +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 @@ -25,7 +25,7 @@ class FunctionsDetailResponse(BaseModel): """ FunctionsDetailResponse """ # noqa: E501 - function_id: StrictInt + function_id: StrictInt = Field(description="Function id") function_name: StrictStr function_vaddr: StrictInt function_size: StrictInt diff --git a/revengai/models/matched_function.py b/revengai/models/matched_function.py index c639c2f..ffe4458 100644 --- a/revengai/models/matched_function.py +++ b/revengai/models/matched_function.py @@ -16,7 +16,7 @@ import re # noqa: F401 import json -from pydantic import BaseModel, ConfigDict, StrictBool, StrictFloat, StrictInt, StrictStr +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 @@ -25,7 +25,7 @@ class MatchedFunction(BaseModel): """ MatchedFunction """ # noqa: E501 - function_id: StrictInt + function_id: StrictInt = Field(description="Unique identifier of the matched function") binary_id: StrictInt function_name: StrictStr function_vaddr: StrictInt