Skip to content

Commit 539a341

Browse files
authored
Merge pull request #141 from RevEngAI/sdk-update-v3.79.0
🤖 Update SDK to version v3.79.0
2 parents c44595c + b75328e commit 539a341

9 files changed

Lines changed: 370 additions & 447 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ Class | Method | HTTP request | Description
5050
*AgentApi* | [**get_capabilities_result_v2_analyses_analysis_id_agent_capabilities_get**](docs/AgentApi.md#get_capabilities_result_v2_analyses_analysis_id_agent_capabilities_get) | **GET** /v2/analyses/{analysis_id}/agent/capabilities | Get Capabilities Result
5151
*AgentApi* | [**get_report_analysis_result_v2_analyses_analysis_id_agent_report_analysis_get**](docs/AgentApi.md#get_report_analysis_result_v2_analyses_analysis_id_agent_report_analysis_get) | **GET** /v2/analyses/{analysis_id}/agent/report-analysis | Get Report Analysis Result
5252
*AgentApi* | [**get_triage_result_v2_analyses_analysis_id_agent_triage_get**](docs/AgentApi.md#get_triage_result_v2_analyses_analysis_id_agent_triage_get) | **GET** /v2/analyses/{analysis_id}/agent/triage | Get Triage Result
53-
*AnalysesApi* | [**get_analysis_queue_position**](docs/AnalysesApi.md#get_analysis_queue_position) | **GET** /v2/analyses/{analysis_id}/queue-position | Get the queue position of an analysis
5453
*AnalysesBulkActionsApi* | [**bulk_add_analysis_tags**](docs/AnalysesBulkActionsApi.md#bulk_add_analysis_tags) | **PATCH** /v2/analyses/tags/add | Bulk Add Analysis Tags
5554
*AnalysesBulkActionsApi* | [**bulk_delete_analyses**](docs/AnalysesBulkActionsApi.md#bulk_delete_analyses) | **PATCH** /v2/analyses/delete | Bulk Delete Analyses
5655
*AnalysesCommentsApi* | [**create_analysis_comment**](docs/AnalysesCommentsApi.md#create_analysis_comment) | **POST** /v2/analyses/{analysis_id}/comments | Create a comment for this analysis
@@ -63,6 +62,7 @@ Class | Method | HTTP request | Description
6362
*AnalysesCoreApi* | [**get_analysis_function_map**](docs/AnalysesCoreApi.md#get_analysis_function_map) | **GET** /v2/analyses/{analysis_id}/func_maps | Get Analysis Function Map
6463
*AnalysesCoreApi* | [**get_analysis_logs**](docs/AnalysesCoreApi.md#get_analysis_logs) | **GET** /v2/analyses/{analysis_id}/logs | Gets the logs of an analysis
6564
*AnalysesCoreApi* | [**get_analysis_params**](docs/AnalysesCoreApi.md#get_analysis_params) | **GET** /v2/analyses/{analysis_id}/params | Gets analysis param information
65+
*AnalysesCoreApi* | [**get_analysis_queue_position**](docs/AnalysesCoreApi.md#get_analysis_queue_position) | **GET** /v2/analyses/{analysis_id}/queue-position | Get the queue position of an analysis
6666
*AnalysesCoreApi* | [**get_analysis_status**](docs/AnalysesCoreApi.md#get_analysis_status) | **GET** /v2/analyses/{analysis_id}/status | Gets the status of an analysis
6767
*AnalysesCoreApi* | [**insert_analysis_log**](docs/AnalysesCoreApi.md#insert_analysis_log) | **POST** /v2/analyses/{analysis_id}/logs | Insert a log entry for an analysis
6868
*AnalysesCoreApi* | [**list_analyses**](docs/AnalysesCoreApi.md#list_analyses) | **GET** /v2/analyses/list | Gets the most recent analyses

docs/AnalysesApi.md

Lines changed: 0 additions & 96 deletions
This file was deleted.

docs/AnalysesCoreApi.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Method | HTTP request | Description
1010
[**get_analysis_function_map**](AnalysesCoreApi.md#get_analysis_function_map) | **GET** /v2/analyses/{analysis_id}/func_maps | Get Analysis Function Map
1111
[**get_analysis_logs**](AnalysesCoreApi.md#get_analysis_logs) | **GET** /v2/analyses/{analysis_id}/logs | Gets the logs of an analysis
1212
[**get_analysis_params**](AnalysesCoreApi.md#get_analysis_params) | **GET** /v2/analyses/{analysis_id}/params | Gets analysis param information
13+
[**get_analysis_queue_position**](AnalysesCoreApi.md#get_analysis_queue_position) | **GET** /v2/analyses/{analysis_id}/queue-position | Get the queue position of an analysis
1314
[**get_analysis_status**](AnalysesCoreApi.md#get_analysis_status) | **GET** /v2/analyses/{analysis_id}/status | Gets the status of an analysis
1415
[**insert_analysis_log**](AnalysesCoreApi.md#insert_analysis_log) | **POST** /v2/analyses/{analysis_id}/logs | Insert a log entry for an analysis
1516
[**list_analyses**](AnalysesCoreApi.md#list_analyses) | **GET** /v2/analyses/list | Gets the most recent analyses
@@ -568,6 +569,93 @@ Name | Type | Description | Notes
568569

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

572+
# **get_analysis_queue_position**
573+
> QueuePositionResponse get_analysis_queue_position(analysis_id)
574+
575+
Get the queue position of an analysis
576+
577+
Returns the number of Processing analyses with a lower analysis_id than the given one. Useful for showing the user where they sit in the processing queue while waiting for their analysis to start.
578+
579+
**Error codes:**
580+
- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found
581+
- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied
582+
583+
### Example
584+
585+
* Api Key Authentication (APIKey):
586+
587+
```python
588+
import revengai
589+
from revengai.models.queue_position_response import QueuePositionResponse
590+
from revengai.rest import ApiException
591+
from pprint import pprint
592+
593+
# Defining the host is optional and defaults to https://api.reveng.ai
594+
# See configuration.py for a list of all supported configuration parameters.
595+
configuration = revengai.Configuration(
596+
host = "https://api.reveng.ai"
597+
)
598+
599+
# The client must configure the authentication and authorization parameters
600+
# in accordance with the API server security policy.
601+
# Examples for each auth method are provided below, use the example that
602+
# satisfies your auth use case.
603+
604+
# Configure API key authorization: APIKey
605+
configuration.api_key['APIKey'] = os.environ["API_KEY"]
606+
607+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
608+
# configuration.api_key_prefix['APIKey'] = 'Bearer'
609+
610+
# Enter a context with an instance of the API client
611+
with revengai.ApiClient(configuration) as api_client:
612+
# Create an instance of the API class
613+
api_instance = revengai.AnalysesCoreApi(api_client)
614+
analysis_id = 56 # int | Analysis ID
615+
616+
try:
617+
# Get the queue position of an analysis
618+
api_response = api_instance.get_analysis_queue_position(analysis_id)
619+
print("The response of AnalysesCoreApi->get_analysis_queue_position:\n")
620+
pprint(api_response)
621+
except Exception as e:
622+
print("Exception when calling AnalysesCoreApi->get_analysis_queue_position: %s\n" % e)
623+
```
624+
625+
626+
627+
### Parameters
628+
629+
630+
Name | Type | Description | Notes
631+
------------- | ------------- | ------------- | -------------
632+
**analysis_id** | **int**| Analysis ID |
633+
634+
### Return type
635+
636+
[**QueuePositionResponse**](QueuePositionResponse.md)
637+
638+
### Authorization
639+
640+
[APIKey](../README.md#APIKey)
641+
642+
### HTTP request headers
643+
644+
- **Content-Type**: Not defined
645+
- **Accept**: application/json
646+
647+
### HTTP response details
648+
649+
| Status code | Description | Response headers |
650+
|-------------|-------------|------------------|
651+
**200** | OK | - |
652+
**403** | Forbidden | - |
653+
**404** | Not Found | - |
654+
**422** | Unprocessable Entity | - |
655+
**500** | Internal Server Error | - |
656+
657+
[[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)
658+
571659
# **get_analysis_status**
572660
> BaseResponseStatus get_analysis_status(analysis_id)
573661

revengai/__init__.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
# Define package exports
1919
__all__ = [
2020
"AgentApi",
21-
"AnalysesApi",
2221
"AnalysesBulkActionsApi",
2322
"AnalysesCommentsApi",
2423
"AnalysesCoreApi",
@@ -375,7 +374,6 @@
375374

376375
# import apis into sdk package
377376
from revengai.api.agent_api import AgentApi as AgentApi
378-
from revengai.api.analyses_api import AnalysesApi as AnalysesApi
379377
from revengai.api.analyses_bulk_actions_api import AnalysesBulkActionsApi as AnalysesBulkActionsApi
380378
from revengai.api.analyses_comments_api import AnalysesCommentsApi as AnalysesCommentsApi
381379
from revengai.api.analyses_core_api import AnalysesCoreApi as AnalysesCoreApi

revengai/api/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
# import apis into api package
44
from revengai.api.agent_api import AgentApi
5-
from revengai.api.analyses_api import AnalysesApi
65
from revengai.api.analyses_bulk_actions_api import AnalysesBulkActionsApi
76
from revengai.api.analyses_comments_api import AnalysesCommentsApi
87
from revengai.api.analyses_core_api import AnalysesCoreApi

0 commit comments

Comments
 (0)