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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .sdk-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.46.0
v3.51.0
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>ai.reveng</groupId>
<artifactId>sdk</artifactId>
<version>3.46.0</version>
<version>3.51.0</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -31,7 +31,7 @@ repositories {
}

dependencies {
implementation "ai.reveng:sdk:3.46.0"
implementation "ai.reveng:sdk:3.51.0"
}
```

Expand Down Expand Up @@ -114,6 +114,8 @@ Class | Method | HTTP request | Description
*AnalysesSecurityChecksApi* | [**getSecurityChecks**](docs/AnalysesSecurityChecksApi.md#getSecurityChecks) | **GET** /v2/analyses/{analysis_id}/security-checks | Get Security Checks
*AnalysesSecurityChecksApi* | [**getSecurityChecksTaskStatus**](docs/AnalysesSecurityChecksApi.md#getSecurityChecksTaskStatus) | **GET** /v2/analyses/{analysis_id}/security-checks/status | Check the status of a security check process
*AnalysesXRefsApi* | [**getXrefByVaddr**](docs/AnalysesXRefsApi.md#getXrefByVaddr) | **GET** /v2/analyses/{analysis_id}/xrefs/{vaddr} | [Beta] Look up xrefs by virtual address
*AnalysisStagesApi* | [**getAnalysisStages**](docs/AnalysisStagesApi.md#getAnalysisStages) | **GET** /v2/analysis-stages/{analysis_id} | Get Analysis Stages
*AnalysisStagesApi* | [**getPipelineStatus**](docs/AnalysisStagesApi.md#getPipelineStatus) | **GET** /v2/analysis-stages/{analysis_id}/pipeline-status | Get Pipeline Status
*AuthenticationUsersApi* | [**getRequesterUserInfo**](docs/AuthenticationUsersApi.md#getRequesterUserInfo) | **GET** /v2/users/me | Get the requesters user information
*AuthenticationUsersApi* | [**getUser**](docs/AuthenticationUsersApi.md#getUser) | **GET** /v2/users/{user_id} | Get a user&#39;s public information
*AuthenticationUsersApi* | [**getUserActivity**](docs/AuthenticationUsersApi.md#getUserActivity) | **GET** /v2/users/activity | Get auth user activity
Expand Down Expand Up @@ -208,6 +210,9 @@ Class | Method | HTTP request | Description
- [AnalysisFunctionsList](docs/AnalysisFunctionsList.md)
- [AnalysisRecord](docs/AnalysisRecord.md)
- [AnalysisScope](docs/AnalysisScope.md)
- [AnalysisStage](docs/AnalysisStage.md)
- [AnalysisStageStatus](docs/AnalysisStageStatus.md)
- [AnalysisStagesResponse](docs/AnalysisStagesResponse.md)
- [AnalysisStringsResponse](docs/AnalysisStringsResponse.md)
- [AnalysisStringsStatusResponse](docs/AnalysisStringsStatusResponse.md)
- [AnalysisTags](docs/AnalysisTags.md)
Expand All @@ -232,6 +237,7 @@ Class | Method | HTTP request | Description
- [BaseResponseAnalysisFunctionMapping](docs/BaseResponseAnalysisFunctionMapping.md)
- [BaseResponseAnalysisFunctions](docs/BaseResponseAnalysisFunctions.md)
- [BaseResponseAnalysisFunctionsList](docs/BaseResponseAnalysisFunctionsList.md)
- [BaseResponseAnalysisStagesResponse](docs/BaseResponseAnalysisStagesResponse.md)
- [BaseResponseAnalysisStringsResponse](docs/BaseResponseAnalysisStringsResponse.md)
- [BaseResponseAnalysisStringsStatusResponse](docs/BaseResponseAnalysisStringsStatusResponse.md)
- [BaseResponseAnalysisTags](docs/BaseResponseAnalysisTags.md)
Expand Down Expand Up @@ -286,6 +292,7 @@ Class | Method | HTTP request | Description
- [BaseResponseModelsResponse](docs/BaseResponseModelsResponse.md)
- [BaseResponseNetworkOverviewResponse](docs/BaseResponseNetworkOverviewResponse.md)
- [BaseResponseParams](docs/BaseResponseParams.md)
- [BaseResponsePipelineStatusResponse](docs/BaseResponsePipelineStatusResponse.md)
- [BaseResponseProcessDumps](docs/BaseResponseProcessDumps.md)
- [BaseResponseProcessRegistry](docs/BaseResponseProcessRegistry.md)
- [BaseResponseProcessTree](docs/BaseResponseProcessTree.md)
Expand Down Expand Up @@ -435,6 +442,8 @@ Class | Method | HTTP request | Description
- [PEModel](docs/PEModel.md)
- [PaginationModel](docs/PaginationModel.md)
- [Params](docs/Params.md)
- [PipelineStageStatus](docs/PipelineStageStatus.md)
- [PipelineStatusResponse](docs/PipelineStatusResponse.md)
- [Platform](docs/Platform.md)
- [Process](docs/Process.md)
- [ProcessDump](docs/ProcessDump.md)
Expand Down Expand Up @@ -463,6 +472,8 @@ Class | Method | HTTP request | Description
- [SinglePDBEntryModel](docs/SinglePDBEntryModel.md)
- [SingleSectionModel](docs/SingleSectionModel.md)
- [StackVariable](docs/StackVariable.md)
- [StageEvent](docs/StageEvent.md)
- [StageStatus](docs/StageStatus.md)
- [StatusInput](docs/StatusInput.md)
- [StatusOutput](docs/StatusOutput.md)
- [StringFunctions](docs/StringFunctions.md)
Expand Down
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ apply plugin: 'java'
apply plugin: 'com.diffplug.spotless'

group = 'ai.reveng'
version = '3.46.0'
version = '3.51.0'



Expand Down Expand Up @@ -171,7 +171,7 @@ mavenPublishing {
publishToMavenCentral(true)
signAllPublications()

coordinates("ai.reveng", "sdk", "3.46.0")
coordinates("ai.reveng", "sdk", "3.51.0")

pom {
name = "sdk"
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "ai.reveng",
name := "sdk",
version := "3.46.0",
version := "3.51.0",
scalaVersion := "2.11.12",
scalacOptions ++= Seq("-feature"),
compile / javacOptions ++= Seq("-Xlint:deprecation"),
Expand Down
15 changes: 15 additions & 0 deletions docs/AnalysisStage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# AnalysisStage

## Enum


* `ANALYSIS` (value: `"ANALYSIS"`)

* `POST_PROCESSING` (value: `"POST_PROCESSING"`)

* `INFERENCE` (value: `"INFERENCE"`)



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


# AnalysisStageStatus

## Enum


* `QUEUED` (value: `"QUEUED"`)

* `STARTED` (value: `"STARTED"`)

* `FINISHED` (value: `"FINISHED"`)

* `ERROR` (value: `"ERROR"`)



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

All URIs are relative to *https://api.reveng.ai*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**getAnalysisStages**](AnalysisStagesApi.md#getAnalysisStages) | **GET** /v2/analysis-stages/{analysis_id} | Get Analysis Stages |
| [**getPipelineStatus**](AnalysisStagesApi.md#getPipelineStatus) | **GET** /v2/analysis-stages/{analysis_id}/pipeline-status | Get Pipeline Status |


<a id="getAnalysisStages"></a>
# **getAnalysisStages**
> BaseResponseAnalysisStagesResponse getAnalysisStages(analysisId)

Get Analysis Stages

Returns all stage events for an analysis ordered by timestamp.

### Example
```java
// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysisStagesApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.reveng.ai");

// Configure API key authorization: APIKey
ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
APIKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.setApiKeyPrefix("Token");

AnalysisStagesApi apiInstance = new AnalysisStagesApi(defaultClient);
Integer analysisId = 56; // Integer |
try {
BaseResponseAnalysisStagesResponse result = apiInstance.getAnalysisStages(analysisId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalysisStagesApi#getAnalysisStages");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```

### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **analysisId** | **Integer**| | |

### Return type

[**BaseResponseAnalysisStagesResponse**](BaseResponseAnalysisStagesResponse.md)

### Authorization

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

### HTTP request headers

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

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful Response | - |
| **422** | Invalid request parameters | - |

<a id="getPipelineStatus"></a>
# **getPipelineStatus**
> BaseResponsePipelineStatusResponse getPipelineStatus(analysisId)

Get Pipeline Status

Returns the latest status for each core pipeline stage with the number of analyses ahead in the queue.

### Example
```java
// Import classes:
import ai.reveng.invoker.ApiClient;
import ai.reveng.invoker.ApiException;
import ai.reveng.invoker.Configuration;
import ai.reveng.invoker.auth.*;
import ai.reveng.invoker.models.*;
import ai.reveng.api.AnalysisStagesApi;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.reveng.ai");

// Configure API key authorization: APIKey
ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
APIKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.setApiKeyPrefix("Token");

AnalysisStagesApi apiInstance = new AnalysisStagesApi(defaultClient);
Integer analysisId = 56; // Integer |
try {
BaseResponsePipelineStatusResponse result = apiInstance.getPipelineStatus(analysisId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AnalysisStagesApi#getPipelineStatus");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```

### Parameters

| Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **analysisId** | **Integer**| | |

### Return type

[**BaseResponsePipelineStatusResponse**](BaseResponsePipelineStatusResponse.md)

### Authorization

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

### HTTP request headers

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

### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Successful Response | - |
| **422** | Invalid request parameters | - |

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


# AnalysisStagesResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**events** | [**List&lt;StageEvent&gt;**](StageEvent.md) | | |



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


# BaseResponseAnalysisStagesResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**status** | **Boolean** | Response status on whether the request succeeded | [optional] |
|**data** | [**AnalysisStagesResponse**](AnalysisStagesResponse.md) | | [optional] |
|**message** | **String** | | [optional] |
|**errors** | [**List&lt;ErrorModel&gt;**](ErrorModel.md) | | [optional] |
|**meta** | [**MetaModel**](MetaModel.md) | Metadata | [optional] |



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


# BaseResponsePipelineStatusResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**status** | **Boolean** | Response status on whether the request succeeded | [optional] |
|**data** | [**PipelineStatusResponse**](PipelineStatusResponse.md) | | [optional] |
|**message** | **String** | | [optional] |
|**errors** | [**List&lt;ErrorModel&gt;**](ErrorModel.md) | | [optional] |
|**meta** | [**MetaModel**](MetaModel.md) | Metadata | [optional] |



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


# PipelineStageStatus

## Enum


* `PENDING` (value: `"PENDING"`)

* `QUEUED` (value: `"QUEUED"`)

* `STARTED` (value: `"STARTED"`)

* `FINISHED` (value: `"FINISHED"`)

* `ERROR` (value: `"ERROR"`)



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


# PipelineStatusResponse


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**stages** | [**List&lt;StageStatus&gt;**](StageStatus.md) | | |



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


# StageEvent


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**stage** | **AnalysisStage** | | |
|**status** | **AnalysisStageStatus** | | |
|**timestamp** | **String** | | |



Loading