Skip to content

FunctionsDataTypesApi.md

Latest commit

 

History

History
561 lines (359 loc) · 18.2 KB

FunctionsDataTypesApi.md

File metadata and controls

561 lines (359 loc) · 18.2 KB
Raw

.FunctionsDataTypesApi

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

Method HTTP request Description
batchUpdateFunctionDataTypes PUT /v3/analyses/{analysis_id}/functions/data-types Batch update function data types
generateFunctionDataTypesForAnalysis POST /v2/analyses/{analysis_id}/functions/data_types Generate Function Data Types
generateFunctionDataTypesForFunctions POST /v2/functions/data_types Generate Function Data Types for an arbitrary list of functions
getFunctionDataTypes GET /v3/analyses/{analysis_id}/functions/{function_id}/data-types Get data types for a single function
listAnalysisFunctionsDataTypes GET /v3/analyses/{analysis_id}/functions/data-types List data types for all functions in an analysis
listFunctionDataTypesForAnalysis GET /v2/analyses/{analysis_id}/functions/data_types List Function Data Types
listFunctionDataTypesForFunctions GET /v2/functions/data_types List Function Data Types
listFunctionsDataTypes GET /v3/functions/data-types Get data types for many functions
updateFunctionDataTypes PUT /v2/analyses/{analysis_id}/functions/{function_id}/data_types Update function data types

batchUpdateFunctionDataTypes

BatchUpdateDataTypesOutputBody batchUpdateFunctionDataTypes(batchUpdateDataTypesInputBody)

Updates data types for multiple functions in one analysis. All function IDs in the body must belong to the analysis. Each item is processed independently and reports its own outcome: a stale data_types_version yields version_conflict for that item without affecting the rest of the batch. Error codes: - 403 ACCESS_DENIED — Access Denied - 404 NOT_FOUND — Not Found - 400 BAD_REQUEST — Bad Request

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiBatchUpdateFunctionDataTypesRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiBatchUpdateFunctionDataTypesRequest = {
    // Analysis ID
  analysisId: 1,
  
  batchUpdateDataTypesInputBody: ,
};

const data = await apiInstance.batchUpdateFunctionDataTypes(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
batchUpdateDataTypesInputBody BatchUpdateDataTypesInputBody
analysisId [number] Analysis ID defaults to undefined

Return type

BatchUpdateDataTypesOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -
422 Unprocessable Entity -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generateFunctionDataTypesForAnalysis

BaseResponseGenerateFunctionDataTypes generateFunctionDataTypesForAnalysis(functionDataTypesParams)

Submits a request to generate the function data types

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiGenerateFunctionDataTypesForAnalysisRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiGenerateFunctionDataTypesForAnalysisRequest = {
  
  analysisId: 1,
  
  functionDataTypesParams: {
    functionIds: [
      1,
    ],
  },
};

const data = await apiInstance.generateFunctionDataTypesForAnalysis(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
functionDataTypesParams FunctionDataTypesParams
analysisId [number] defaults to undefined

Return type

BaseResponseGenerateFunctionDataTypes

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generateFunctionDataTypesForFunctions

BaseResponseGenerationStatusList generateFunctionDataTypesForFunctions(functionDataTypesParams)

Submits a request to generate the function data types

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiGenerateFunctionDataTypesForFunctionsRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiGenerateFunctionDataTypesForFunctionsRequest = {
  
  functionDataTypesParams: {
    functionIds: [
      1,
    ],
  },
};

const data = await apiInstance.generateFunctionDataTypesForFunctions(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
functionDataTypesParams FunctionDataTypesParams

Return type

BaseResponseGenerationStatusList

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFunctionDataTypes

DataTypesEntry getFunctionDataTypes()

Returns the stored data-types blob for one function. The function must belong to the supplied analysis. Error codes: - 403 ACCESS_DENIED — Access Denied - 404 NOT_FOUND — Not Found

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiGetFunctionDataTypesRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiGetFunctionDataTypesRequest = {
    // Analysis ID
  analysisId: 1,
    // Function ID
  functionId: 1,
};

const data = await apiInstance.getFunctionDataTypes(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
analysisId [number] Analysis ID defaults to undefined
functionId [number] Function ID defaults to undefined

Return type

DataTypesEntry

Authorization

APIKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -
404 Not Found -
422 Unprocessable Entity -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listAnalysisFunctionsDataTypes

ListAnalysisFunctionsDataTypesOutputBody listAnalysisFunctionsDataTypes()

Paginated read of the stored data-types blob for each function in the analysis. Error codes: - 403 ACCESS_DENIED — Access Denied - 404 NOT_FOUND — Not Found

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiListAnalysisFunctionsDataTypesRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiListAnalysisFunctionsDataTypesRequest = {
    // Analysis ID
  analysisId: 1,
    // Pagination offset. Defaults to 0. (optional)
  offset: 0,
    // Page size. Defaults to 100. (optional)
  limit: 1,
};

const data = await apiInstance.listAnalysisFunctionsDataTypes(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
analysisId [number] Analysis ID defaults to undefined
offset [number] Pagination offset. Defaults to 0. (optional) defaults to undefined
limit [number] Page size. Defaults to 100. (optional) defaults to undefined

Return type

ListAnalysisFunctionsDataTypesOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
403 Forbidden -
404 Not Found -
422 Unprocessable Entity -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listFunctionDataTypesForAnalysis

BaseResponseFunctionDataTypesList listFunctionDataTypesForAnalysis()

Returns data types for multiple functions with optional function ID filtering

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiListFunctionDataTypesForAnalysisRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiListFunctionDataTypesForAnalysisRequest = {
  
  analysisId: 1,
  
  functionIds: [
    1,
  ],
};

const data = await apiInstance.listFunctionDataTypesForAnalysis(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined
functionIds Array<number> (optional) defaults to undefined

Return type

BaseResponseFunctionDataTypesList

Authorization

APIKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listFunctionDataTypesForFunctions

BaseResponseFunctionDataTypesList listFunctionDataTypesForFunctions()

Returns data types for multiple function IDs

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiListFunctionDataTypesForFunctionsRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiListFunctionDataTypesForFunctionsRequest = {
  
  functionIds: [
    1,
  ],
};

const data = await apiInstance.listFunctionDataTypesForFunctions(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
functionIds Array<number> (optional) defaults to undefined

Return type

BaseResponseFunctionDataTypesList

Authorization

APIKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listFunctionsDataTypes

ListFunctionsDataTypesOutputBody listFunctionsDataTypes()

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 — Access Denied - 404 NOT_FOUND — Not Found - 400 BAD_REQUEST — Bad Request

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiListFunctionsDataTypesRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiListFunctionsDataTypesRequest = {
    // Function IDs to fetch data-types for.
  functionIds: [
    1,
  ],
};

const data = await apiInstance.listFunctionsDataTypes(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
functionIds Array<number> Function IDs to fetch data-types for. defaults to undefined

Return type

ListFunctionsDataTypesOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -
422 Unprocessable Entity -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateFunctionDataTypes

UpdateDataTypesOutputBody updateFunctionDataTypes(updateDataTypesInputBody)

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 — Access Denied - 404 NOT_FOUND — Not Found - 400 BAD_REQUEST — Bad Request - 409 CONFLICT — Conflict

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiUpdateFunctionDataTypesRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiUpdateFunctionDataTypesRequest = {
    // Analysis ID
  analysisId: 1,
    // Function ID
  functionId: 1,
  
  updateDataTypesInputBody: ,
};

const data = await apiInstance.updateFunctionDataTypes(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
updateDataTypesInputBody UpdateDataTypesInputBody
analysisId [number] Analysis ID defaults to undefined
functionId [number] Function ID defaults to undefined

Return type

UpdateDataTypesOutputBody

Authorization

APIKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
403 Forbidden -
404 Not Found -
409 Conflict -
422 Unprocessable Entity -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]