ai.lucidtech.las.sdk

Class Client

java.lang.Object

ai.lucidtech.las.sdk.Client

public class Client
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Client(Credentials credentials) A client to invoke api methods from Lucidtech AI Services.

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	createAsset(byte[] content) Creates an asset, calls the POST /assets endpoint.
org.json.JSONObject	createAsset(byte[] content, CreateAssetOptions options) Creates an asset, calls the POST /assets endpoint.
org.json.JSONObject	createAsset(java.io.InputStream content) Creates an asset, calls the POST /assets endpoint.
org.json.JSONObject	createAsset(java.io.InputStream content, CreateAssetOptions options) Creates an asset, calls the POST /assets endpoint.
org.json.JSONObject	createBatch() Creates a batch, calls the POST /batches endpoint.
org.json.JSONObject	createBatch(CreateBatchOptions options) Creates a batch, calls the POST /batches endpoint.
org.json.JSONObject	createDocument(byte[] content, ContentType contentType) Creates a document, calls the POST /documents endpoint.
org.json.JSONObject	createDocument(byte[] content, ContentType contentType, CreateDocumentOptions options) Creates a document, calls the POST /documents endpoint.
org.json.JSONObject	createDocument(java.io.InputStream content, ContentType contentType) Creates a document, calls the POST /documents endpoint.
org.json.JSONObject	createDocument(java.io.InputStream content, ContentType contentType, CreateDocumentOptions options) Creates a document, calls the POST /documents endpoint.
org.json.JSONObject	createPrediction(java.lang.String documentId, java.lang.String modelId) Create a prediction on a document using specified model, calls the POST /predictions endpoint.
org.json.JSONObject	createPrediction(java.lang.String documentId, java.lang.String modelId, CreatePredictionOptions options) Create a prediction on a document using specified model, calls the POST /predictions endpoint.
org.json.JSONObject	createSecret(org.json.JSONObject data) Creates a secret, calls the POST /secrets endpoint.
org.json.JSONObject	createSecret(org.json.JSONObject data, CreateSecretOptions options) Creates a secret, calls the POST /secrets endpoint.
org.json.JSONObject	createSecret(java.util.Map<java.lang.String,java.lang.String> data) Creates a secret, calls the POST /secrets endpoint.
org.json.JSONObject	createSecret(java.util.Map<java.lang.String,java.lang.String> data, CreateSecretOptions options) Creates a secret, calls the POST /secrets endpoint.
org.json.JSONObject	createTransition(TransitionType transitionType) Creates a transition, calls the POST /transitions endpoint.
org.json.JSONObject	createTransition(TransitionType transitionType, CreateTransitionOptions options) Creates a transition, calls the POST /transitions endpoint.
org.json.JSONObject	createUser(java.lang.String email) Creates a new user, calls the POST /users endpoint.
org.json.JSONObject	createUser(java.lang.String email, CreateUserOptions options) Creates a new user, calls the POST /users endpoint.
org.json.JSONObject	createWorkflow(org.json.JSONObject specification) Creates a new workflow, calls the POST /workflows endpoint.
org.json.JSONObject	createWorkflow(org.json.JSONObject specification, CreateWorkflowOptions options) Creates a new workflow, calls the POST /workflows endpoint.
org.json.JSONObject	deleteDocuments() Delete documents, calls the DELETE /documents endpoint.
org.json.JSONObject	deleteDocuments(java.lang.String consentId) Delete documents with the provided consentId, calls the DELETE /documents endpoint.
org.json.JSONObject	deleteTransition(java.lang.String transitionId) Delete a transition, calls the PATCH /transitions/{transitionId} endpoint.
org.json.JSONObject	deleteUser(java.lang.String userId) Delete a user, calls the PATCH /users/{userId} endpoint.
org.json.JSONObject	deleteWorkflow(java.lang.String workflowId) Delete a workflow, calls the DELETE /workflows/{workflowId} endpoint.
org.json.JSONObject	deleteWorkflowExecution(java.lang.String workflowId, java.lang.String executionId) Deletes the execution with the provided executionId from workflowId, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.
org.json.JSONObject	executeTransition(java.lang.String transitionId) Start executing a manual transition, calls the POST /transitions/{transitionId}/executions endpoint.
org.json.JSONObject	executeWorkflow(java.lang.String workflowId, org.json.JSONObject content) Start a workflow execution, calls the POST /workflows/{workflowId}/executions endpoint.
org.json.JSONObject	getAsset(java.lang.String assetId) Get asset, calls the GET /assets/{assetId} endpoint.
org.json.JSONObject	getDocument(java.lang.String documentId) Get document, calls the GET /documents/{documentId} endpoint.
org.json.JSONObject	getLog(java.lang.String logId) Get log, calls the GET /logs/{logId} endpoint.
org.json.JSONObject	getTransition(java.lang.String transitionId) Get transition, calls the GET /transitions/{transitionId} endpoint.
org.json.JSONObject	getTransitionExecution(java.lang.String transitionId, java.lang.String executionId) Get an execution of a transition, calls the GET /transitions/{transitionId}/executions/{executionId} endpoint
org.json.JSONObject	getUser(java.lang.String userId) Get information about a specific user, calls the GET /users/{user_id} endpoint.
org.json.JSONObject	getWorkflow(java.lang.String workflowId) Get workflow, calls the GET /workflows/{workflowId} endpoint.
org.json.JSONObject	listAssets() List assets available, calls the GET /assets endpoint.
org.json.JSONObject	listAssets(ListAssetsOptions options) List assets available, calls the GET /assets endpoint.
org.json.JSONObject	listDocuments() List documents, calls the GET /documents endpoint.
org.json.JSONObject	listDocuments(ListDocumentsOptions options) List documents, calls the GET /documents endpoint.
org.json.JSONObject	listModels() List models available, calls the GET /models endpoint.
org.json.JSONObject	listModels(ListModelsOptions options) List models available, calls the GET /models endpoint.
org.json.JSONObject	listPredictions() List predictions available, calls the GET /predictions endpoint.
org.json.JSONObject	listPredictions(ListPredictionsOptions options) List predictions available, calls the GET /predictions endpoint.
org.json.JSONObject	listSecrets() List secrets available, calls the GET /secrets endpoint.
org.json.JSONObject	listSecrets(ListSecretsOptions options) List secrets available, calls the GET /secrets endpoint.
org.json.JSONObject	listTransitionExecutions(java.lang.String transitionId) List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
org.json.JSONObject	listTransitionExecutions(java.lang.String transitionId, ListTransitionExecutionsOptions options) List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
org.json.JSONObject	listTransitions() List transitions, calls the GET /transitions endpoint.
org.json.JSONObject	listTransitions(ListTransitionsOptions options) List transitions, calls the GET /transitions endpoint.
org.json.JSONObject	listUsers() List users, calls the GET /users endpoint.
org.json.JSONObject	listUsers(ListUsersOptions options) List users, calls the GET /users endpoint.
org.json.JSONObject	listWorkflowExecutions(java.lang.String workflowId) List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
org.json.JSONObject	listWorkflowExecutions(java.lang.String workflowId, ListWorkflowExecutionsOptions options) List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
org.json.JSONObject	listWorkflows() List workflows, calls the GET /workflows endpoint.
org.json.JSONObject	listWorkflows(ListWorkflowsOptions options) List workflows, calls the GET /workflows endpoint.
org.json.JSONObject	sendHeartbeat(java.lang.String transitionId, java.lang.String executionId) Send heartbeat for a manual execution to signal that we are still working on it.
org.json.JSONObject	updateAsset(java.lang.String assetId, UpdateAssetOptions options) Updates an asset, calls the PATCH /assets/{assetId} endpoint.
org.json.JSONObject	updateDocument(java.lang.String documentId, org.json.JSONArray groundTruth) Update ground truth for a document, calls the PATCH /documents/{documentId} endpoint.
org.json.JSONObject	updateSecret(java.lang.String secretId, UpdateSecretOptions options) Updates a secret, calls the PATCH /secrets/{secretId} endpoint.
org.json.JSONObject	updateTransition(java.lang.String transitionId, UpdateTransitionOptions options) Updates a transition, calls the PATCH /transitions/{transitionId} endpoint.
org.json.JSONObject	updateTransitionExecution(java.lang.String transitionId, java.lang.String executionId, TransitionExecutionStatus status, UpdateTransitionExecutionOptions options) Ends the processing of the transition execution, calls the PATCH /transitions/{transition_id}/executions/{execution_id} endpoint.
org.json.JSONObject	updateUser(java.lang.String userId, UpdateUserOptions options) Updates a user, calls the PATCH /users/{userId} endpoint.
org.json.JSONObject	updateWorkflow(java.lang.String workflowId, UpdateWorkflowOptions options) Updates a workflow, calls the PATCH /workflows/{workflowId} endpoint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Client

public Client(Credentials credentials)

A client to invoke api methods from Lucidtech AI Services.

Parameters:

credentials - Credentials to use

See Also:

Credentials

Method Detail

createAsset

public org.json.JSONObject createAsset(byte[] content,
                                       CreateAssetOptions options)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Creates an asset, calls the POST /assets endpoint.

Parameters:

content - Binary data

options - Additional options to include in request body

Returns:

Asset response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateAssetOptions

createAsset

public org.json.JSONObject createAsset(java.io.InputStream content,
                                       CreateAssetOptions options)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Creates an asset, calls the POST /assets endpoint.

Parameters:

content - Data from input stream

options - Additional options to include in request body

Returns:

Asset response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateAssetOptions

createAsset

public org.json.JSONObject createAsset(byte[] content)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Creates an asset, calls the POST /assets endpoint.

Parameters:

content - Binary data

Returns:

Asset response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

createAsset

public org.json.JSONObject createAsset(java.io.InputStream content)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Creates an asset, calls the POST /assets endpoint.

Parameters:

content - Data from input stream

Returns:

Asset response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

listAssets

public org.json.JSONObject listAssets(ListAssetsOptions options)
                               throws java.io.IOException,
                                      APIException,
                                      MissingAccessTokenException

List assets available, calls the GET /assets endpoint.

Parameters:

options - Additional options to pass along as query parameters

Returns:

Assets response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListAssetsOptions

listAssets

public org.json.JSONObject listAssets()
                               throws java.io.IOException,
                                      APIException,
                                      MissingAccessTokenException

List assets available, calls the GET /assets endpoint.

Returns:

Assets response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

getAsset

public org.json.JSONObject getAsset(java.lang.String assetId)
                             throws java.io.IOException,
                                    APIException,
                                    MissingAccessTokenException

Get asset, calls the GET /assets/{assetId} endpoint.

Parameters:

assetId - Id of the asset

Returns:

Asset response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

updateAsset

public org.json.JSONObject updateAsset(java.lang.String assetId,
                                       UpdateAssetOptions options)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Updates an asset, calls the PATCH /assets/{assetId} endpoint.

Parameters:

assetId - Id of the asset

options - Additional options to include in request body

Returns:

Asset response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

UpdateAssetOptions

createBatch

public org.json.JSONObject createBatch(CreateBatchOptions options)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Creates a batch, calls the POST /batches endpoint.

Parameters:

options - Additional options to include in request body

Returns:

Batch response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateBatchOptions

createBatch

public org.json.JSONObject createBatch()
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Creates a batch, calls the POST /batches endpoint.

Returns:

Batch response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

createDocument

public org.json.JSONObject createDocument(byte[] content,
                                          ContentType contentType,
                                          CreateDocumentOptions options)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a document, calls the POST /documents endpoint.

Parameters:

content - Binary data

contentType - A mime type for the document

options - Additional options to include in request body

Returns:

Document response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateDocumentOptions

createDocument

public org.json.JSONObject createDocument(java.io.InputStream content,
                                          ContentType contentType,
                                          CreateDocumentOptions options)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a document, calls the POST /documents endpoint.

Parameters:

content - Data from input stream

contentType - A mime type for the document

options - Additional options to include in request body

Returns:

Document response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateDocumentOptions

createDocument

public org.json.JSONObject createDocument(java.io.InputStream content,
                                          ContentType contentType)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a document, calls the POST /documents endpoint.

Parameters:

content - Data from input stream

contentType - A mime type for the document

Returns:

Document response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateDocumentOptions

createDocument

public org.json.JSONObject createDocument(byte[] content,
                                          ContentType contentType)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a document, calls the POST /documents endpoint.

Parameters:

content - Binary data

contentType - A mime type for the document

Returns:

Document response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateDocumentOptions

listDocuments

public org.json.JSONObject listDocuments(ListDocumentsOptions options)
                                  throws java.io.IOException,
                                         APIException,
                                         MissingAccessTokenException

List documents, calls the GET /documents endpoint.

Parameters:

options - Additional options to pass along as query parameters

Returns:

Documents response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListDocumentsOptions

listDocuments

public org.json.JSONObject listDocuments()
                                  throws java.io.IOException,
                                         APIException,
                                         MissingAccessTokenException

List documents, calls the GET /documents endpoint.

Returns:

Documents response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

deleteDocuments

public org.json.JSONObject deleteDocuments()
                                    throws java.io.IOException,
                                           APIException,
                                           MissingAccessTokenException

Delete documents, calls the DELETE /documents endpoint.

Returns:

Documents response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createDocument(byte[], ai.lucidtech.las.sdk.ContentType, ai.lucidtech.las.sdk.CreateDocumentOptions)

deleteDocuments

public org.json.JSONObject deleteDocuments(java.lang.String consentId)
                                    throws java.io.IOException,
                                           APIException,
                                           MissingAccessTokenException

Delete documents with the provided consentId, calls the DELETE /documents endpoint.

Parameters:

consentId - Delete documents with this consentId

Returns:

Documents response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createDocument(byte[], ai.lucidtech.las.sdk.ContentType, ai.lucidtech.las.sdk.CreateDocumentOptions)

getDocument

public org.json.JSONObject getDocument(java.lang.String documentId)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Get document, calls the GET /documents/{documentId} endpoint.

Parameters:

documentId - Id of the document

Returns:

Document response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

updateDocument

public org.json.JSONObject updateDocument(java.lang.String documentId,
                                          org.json.JSONArray groundTruth)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Update ground truth for a document, calls the PATCH /documents/{documentId} endpoint.

Parameters:

documentId - The document id to post groundTruth to.

groundTruth - List of json objects containing label and value for the ground truth

Returns:

Document response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createDocument(byte[], ai.lucidtech.las.sdk.ContentType, ai.lucidtech.las.sdk.CreateDocumentOptions)

getLog

public org.json.JSONObject getLog(java.lang.String logId)
                           throws java.io.IOException,
                                  APIException,
                                  MissingAccessTokenException

Get log, calls the GET /logs/{logId} endpoint.

Parameters:

logId - Id of the log

Returns:

Log response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

listModels

public org.json.JSONObject listModels(ListModelsOptions options)
                               throws java.io.IOException,
                                      APIException,
                                      MissingAccessTokenException

List models available, calls the GET /models endpoint.

Parameters:

options - Additional options to pass along as query parameters

Returns:

Models response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListModelsOptions

listModels

public org.json.JSONObject listModels()
                               throws java.io.IOException,
                                      APIException,
                                      MissingAccessTokenException

List models available, calls the GET /models endpoint.

Returns:

Models response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

createPrediction

public org.json.JSONObject createPrediction(java.lang.String documentId,
                                            java.lang.String modelId,
                                            CreatePredictionOptions options)
                                     throws java.io.IOException,
                                            APIException,
                                            MissingAccessTokenException

Create a prediction on a document using specified model, calls the POST /predictions endpoint.

Parameters:

documentId - The document id to run inference and create a prediction on.

modelId - The id of the model to use for inference

options - Additional options to include in request body

Returns:

Prediction response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createDocument(byte[], ai.lucidtech.las.sdk.ContentType, ai.lucidtech.las.sdk.CreateDocumentOptions), CreatePredictionOptions

createPrediction

public org.json.JSONObject createPrediction(java.lang.String documentId,
                                            java.lang.String modelId)
                                     throws java.io.IOException,
                                            APIException,
                                            MissingAccessTokenException

Create a prediction on a document using specified model, calls the POST /predictions endpoint.

Parameters:

documentId - The document id to run inference and create a prediction on.

modelId - The id of the model to use for inference

Returns:

Prediction response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createDocument(byte[], ai.lucidtech.las.sdk.ContentType, ai.lucidtech.las.sdk.CreateDocumentOptions)

listPredictions

public org.json.JSONObject listPredictions(ListPredictionsOptions options)
                                    throws java.io.IOException,
                                           APIException,
                                           MissingAccessTokenException

List predictions available, calls the GET /predictions endpoint.

Parameters:

options - Additional options to pass along as query parameters

Returns:

Predictions response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListPredictionsOptions

listPredictions

public org.json.JSONObject listPredictions()
                                    throws java.io.IOException,
                                           APIException,
                                           MissingAccessTokenException

List predictions available, calls the GET /predictions endpoint.

Returns:

Predictions response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

createSecret

public org.json.JSONObject createSecret(org.json.JSONObject data,
                                        CreateSecretOptions options)
                                 throws java.io.IOException,
                                        APIException,
                                        MissingAccessTokenException

Creates a secret, calls the POST /secrets endpoint.

Parameters:

data - Key-Value pairs to store secretly

options - Additional options to include in request body

Returns:

Secret response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateSecretOptions

createSecret

public org.json.JSONObject createSecret(java.util.Map<java.lang.String,java.lang.String> data,
                                        CreateSecretOptions options)
                                 throws java.io.IOException,
                                        APIException,
                                        MissingAccessTokenException

Creates a secret, calls the POST /secrets endpoint.

Parameters:

data - Key-Value pairs to store secretly

options - Additional options to include in request body

Returns:

Secret response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateSecretOptions

createSecret

public org.json.JSONObject createSecret(java.util.Map<java.lang.String,java.lang.String> data)
                                 throws java.io.IOException,
                                        APIException,
                                        MissingAccessTokenException

Creates a secret, calls the POST /secrets endpoint.

Parameters:

data - Key-Value pairs to store secretly

Returns:

Secret response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

createSecret

public org.json.JSONObject createSecret(org.json.JSONObject data)
                                 throws java.io.IOException,
                                        APIException,
                                        MissingAccessTokenException

Creates a secret, calls the POST /secrets endpoint.

Parameters:

data - Key-Value pairs to store secretly

Returns:

Secret response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

listSecrets

public org.json.JSONObject listSecrets(ListSecretsOptions options)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

List secrets available, calls the GET /secrets endpoint.

Parameters:

options - Additional options to pass along as query parameters

Returns:

Secrets response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListSecretsOptions

listSecrets

public org.json.JSONObject listSecrets()
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

List secrets available, calls the GET /secrets endpoint.

Returns:

Secrets response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

updateSecret

public org.json.JSONObject updateSecret(java.lang.String secretId,
                                        UpdateSecretOptions options)
                                 throws java.io.IOException,
                                        APIException,
                                        MissingAccessTokenException

Updates a secret, calls the PATCH /secrets/{secretId} endpoint.

Parameters:

secretId - Id of the secret

options - Additional options to include in request body

Returns:

Secret response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

UpdateSecretOptions

createTransition

public org.json.JSONObject createTransition(TransitionType transitionType,
                                            CreateTransitionOptions options)
                                     throws java.io.IOException,
                                            APIException,
                                            MissingAccessTokenException

Creates a transition, calls the POST /transitions endpoint.

Parameters:

transitionType - Type of transition

options - Additional options to include in request body

Returns:

Transition response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateTransitionOptions, TransitionType

createTransition

public org.json.JSONObject createTransition(TransitionType transitionType)
                                     throws java.io.IOException,
                                            APIException,
                                            MissingAccessTokenException

Creates a transition, calls the POST /transitions endpoint.

Parameters:

transitionType - Type of transition

Returns:

Transition response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

TransitionType

listTransitions

public org.json.JSONObject listTransitions(ListTransitionsOptions options)
                                    throws java.io.IOException,
                                           APIException,
                                           MissingAccessTokenException

List transitions, calls the GET /transitions endpoint.

Parameters:

options - Additional options to pass along as query parameters

Returns:

Transitions response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListTransitionsOptions

listTransitions

public org.json.JSONObject listTransitions()
                                    throws java.io.IOException,
                                           APIException,
                                           MissingAccessTokenException

List transitions, calls the GET /transitions endpoint.

Returns:

Transitions response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

getTransition

public org.json.JSONObject getTransition(java.lang.String transitionId)
                                  throws java.io.IOException,
                                         APIException,
                                         MissingAccessTokenException

Get transition, calls the GET /transitions/{transitionId} endpoint.

Parameters:

transitionId - Id of the transition

Returns:

Transition response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

updateTransition

public org.json.JSONObject updateTransition(java.lang.String transitionId,
                                            UpdateTransitionOptions options)
                                     throws java.io.IOException,
                                            APIException,
                                            MissingAccessTokenException

Updates a transition, calls the PATCH /transitions/{transitionId} endpoint.

Parameters:

transitionId - Id of the transition

options - Additional options to include in request body

Returns:

Transition response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

UpdateTransitionOptions

executeTransition

public org.json.JSONObject executeTransition(java.lang.String transitionId)
                                      throws java.io.IOException,
                                             APIException,
                                             MissingAccessTokenException

Start executing a manual transition, calls the POST /transitions/{transitionId}/executions endpoint.

Parameters:

transitionId - Id of the transition

Returns:

TransitionExecution response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

deleteTransition

public org.json.JSONObject deleteTransition(java.lang.String transitionId)
                                     throws java.io.IOException,
                                            APIException,
                                            MissingAccessTokenException

Delete a transition, calls the PATCH /transitions/{transitionId} endpoint. Will fail if transition is in use by one or more workflows.

Parameters:

transitionId - Id of the transition

Returns:

Transition response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

listTransitionExecutions

public org.json.JSONObject listTransitionExecutions(java.lang.String transitionId,
                                                    ListTransitionExecutionsOptions options)
                                             throws java.io.IOException,
                                                    APIException,
                                                    MissingAccessTokenException

List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.

Parameters:

transitionId - Id of the transition

options - Additional options to pass along as query parameters

Returns:

Transition executions response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListTransitionExecutionsOptions

listTransitionExecutions

public org.json.JSONObject listTransitionExecutions(java.lang.String transitionId)
                                             throws java.io.IOException,
                                                    APIException,
                                                    MissingAccessTokenException

List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.

Parameters:

transitionId - Id of the transition

Returns:

Transition executions response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

getTransitionExecution

public org.json.JSONObject getTransitionExecution(java.lang.String transitionId,
                                                  java.lang.String executionId)
                                           throws java.io.IOException,
                                                  APIException,
                                                  MissingAccessTokenException

Get an execution of a transition, calls the GET /transitions/{transitionId}/executions/{executionId} endpoint

Parameters:

transitionId - Id of the transition

executionId - Id of the execution

Returns:

TransitionExecution response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

updateTransitionExecution

public org.json.JSONObject updateTransitionExecution(java.lang.String transitionId,
                                                     java.lang.String executionId,
                                                     TransitionExecutionStatus status,
                                                     UpdateTransitionExecutionOptions options)
                                              throws java.io.IOException,
                                                     APIException,
                                                     MissingAccessTokenException

Ends the processing of the transition execution, calls the PATCH /transitions/{transition_id}/executions/{execution_id} endpoint.

Parameters:

transitionId - Id of the transition

executionId - Id of the execution

status - Status of the execution

options - Additional options to include in request body

Returns:

Transition response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

UpdateTransitionExecutionOptions, TransitionExecutionStatus

sendHeartbeat

public org.json.JSONObject sendHeartbeat(java.lang.String transitionId,
                                         java.lang.String executionId)
                                  throws java.io.IOException,
                                         APIException,
                                         MissingAccessTokenException

Send heartbeat for a manual execution to signal that we are still working on it. Must be done at minimum once every 60 seconds or the transition execution will time out, calls the POST /transitions/{transitionId}/executions/{executionId}/heartbeats endpoint.

Parameters:

transitionId - Id of the transition

executionId - Id of the execution

Returns:

Empty response

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

createUser

public org.json.JSONObject createUser(java.lang.String email,
                                      CreateUserOptions options)
                               throws java.io.IOException,
                                      APIException,
                                      MissingAccessTokenException

Creates a new user, calls the POST /users endpoint.

Parameters:

email - Email of the new user

options - Additional options to include in request body

Returns:

User response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateUserOptions

createUser

public org.json.JSONObject createUser(java.lang.String email)
                               throws java.io.IOException,
                                      APIException,
                                      MissingAccessTokenException

Creates a new user, calls the POST /users endpoint.

Parameters:

email - Email to the new user

Returns:

User response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

listUsers

public org.json.JSONObject listUsers(ListUsersOptions options)
                              throws java.io.IOException,
                                     APIException,
                                     MissingAccessTokenException

List users, calls the GET /users endpoint.

Parameters:

options - Additional options to pass along as query parameters

Returns:

Users response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListUsersOptions

listUsers

public org.json.JSONObject listUsers()
                              throws java.io.IOException,
                                     APIException,
                                     MissingAccessTokenException

List users, calls the GET /users endpoint.

Returns:

Users response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

getUser

public org.json.JSONObject getUser(java.lang.String userId)
                            throws java.io.IOException,
                                   APIException,
                                   MissingAccessTokenException

Get information about a specific user, calls the GET /users/{user_id} endpoint.

Parameters:

userId - The Id of the user

Returns:

User response

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

updateUser

public org.json.JSONObject updateUser(java.lang.String userId,
                                      UpdateUserOptions options)
                               throws java.io.IOException,
                                      APIException,
                                      MissingAccessTokenException

Updates a user, calls the PATCH /users/{userId} endpoint.

Parameters:

userId - Id of the user

options - Additional options to include in request body

Returns:

User response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

UpdateUserOptions

deleteUser

public org.json.JSONObject deleteUser(java.lang.String userId)
                               throws java.io.IOException,
                                      APIException,
                                      MissingAccessTokenException

Delete a user, calls the PATCH /users/{userId} endpoint.

Parameters:

userId - Id of the user

Returns:

User response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

createWorkflow

public org.json.JSONObject createWorkflow(org.json.JSONObject specification,
                                          CreateWorkflowOptions options)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow. see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve

Parameters:

specification - Specification of the workflow, currently supporting ASL: https://states-language.net/spec.html. Check out the tutorials for more information: see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve#creating-the-workflow

options - Additional options to include in request body

Returns:

Workflow response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

CreateWorkflowOptions

createWorkflow

public org.json.JSONObject createWorkflow(org.json.JSONObject specification)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow. see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve

Parameters:

specification - Specification of the workflow, currently supporting ASL: https://states-language.net/spec.html. Check out the tutorials for more information: see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve#creating-the-workflow

Returns:

Workflow response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

listWorkflows

public org.json.JSONObject listWorkflows(ListWorkflowsOptions options)
                                  throws java.io.IOException,
                                         APIException,
                                         MissingAccessTokenException

List workflows, calls the GET /workflows endpoint.

Parameters:

options - Additional options to pass along as query parameters

Returns:

Workflows response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListWorkflowsOptions

listWorkflows

public org.json.JSONObject listWorkflows()
                                  throws java.io.IOException,
                                         APIException,
                                         MissingAccessTokenException

List workflows, calls the GET /workflows endpoint.

Returns:

Workflows response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

getWorkflow

public org.json.JSONObject getWorkflow(java.lang.String workflowId)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Get workflow, calls the GET /workflows/{workflowId} endpoint.

Parameters:

workflowId - Id of the workflow

Returns:

Workflow response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

updateWorkflow

public org.json.JSONObject updateWorkflow(java.lang.String workflowId,
                                          UpdateWorkflowOptions options)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Updates a workflow, calls the PATCH /workflows/{workflowId} endpoint.

Parameters:

workflowId - Id of the workflow

options - Additional options to include in request body

Returns:

Workflow response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

UpdateWorkflowOptions

deleteWorkflow

public org.json.JSONObject deleteWorkflow(java.lang.String workflowId)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Delete a workflow, calls the DELETE /workflows/{workflowId} endpoint.

Parameters:

workflowId - Id of the workflow

Returns:

Workflow response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createWorkflow(org.json.JSONObject, ai.lucidtech.las.sdk.CreateWorkflowOptions)

executeWorkflow

public org.json.JSONObject executeWorkflow(java.lang.String workflowId,
                                           org.json.JSONObject content)
                                    throws java.io.IOException,
                                           APIException,
                                           MissingAccessTokenException

Start a workflow execution, calls the POST /workflows/{workflowId}/executions endpoint.

Parameters:

workflowId - Id of the workflow

content - Input to the first step of the workflow

Returns:

WorkflowExecution response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

listWorkflowExecutions

public org.json.JSONObject listWorkflowExecutions(java.lang.String workflowId,
                                                  ListWorkflowExecutionsOptions options)
                                           throws java.io.IOException,
                                                  APIException,
                                                  MissingAccessTokenException

List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.

Parameters:

workflowId - Id of the workflow

options - Additional options to pass along as query parameters

Returns:

Workflow executions response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ListWorkflowExecutionsOptions

listWorkflowExecutions

public org.json.JSONObject listWorkflowExecutions(java.lang.String workflowId)
                                           throws java.io.IOException,
                                                  APIException,
                                                  MissingAccessTokenException

List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.

Parameters:

workflowId - Id of the workflow

Returns:

Workflow executions response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

deleteWorkflowExecution

public org.json.JSONObject deleteWorkflowExecution(java.lang.String workflowId,
                                                   java.lang.String executionId)
                                            throws java.io.IOException,
                                                   APIException,
                                                   MissingAccessTokenException

Deletes the execution with the provided executionId from workflowId, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.

Parameters:

workflowId - Id of the workflow

executionId - Id of the execution

Returns:

WorklowExecution response from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

executeWorkflow(java.lang.String, org.json.JSONObject)