README.md

Actions

Overview

Retrieve Actions metadata and definitions.

Available Operations

• listActionsMeta - List all actions metadata
• searchActions - Search connector actions by semantic similarity
• buildActionEmbeddings - Rebuild action embeddings for semantic search
• rpcAction - Make an RPC call to an action

listActionsMeta

Retrieves a list of all actions metadata

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.*;
import java.lang.Exception;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        StackoneListActionsMetaRequest req = StackoneListActionsMetaRequest.builder()
                .groupBy("[\"connector\"]")
                .filter(StackoneListActionsMetaQueryParamFilter.builder()
                    .connectors("connector1,connector2")
                    .accountIds("account1,account2")
                    .actionKey("action1")
                    .build())
                .include(List.of(
                    StackoneListActionsMetaQueryParamInclude.ACTION_DETAILS))
                .search("employee")
                .exclude(List.of(
                    Exclude.ACTIONS))
                .build();


        sdk.actions().listActionsMeta()
                .callAsStream()
                .forEach((StackoneListActionsMetaResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter	Type	Required	Description
request	StackoneListActionsMetaRequest	✔️	The request object to use for the request.

Response

StackoneListActionsMetaResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	*/*

searchActions

Search connector actions by semantic similarity

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.ActionSearchDto;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.StackoneSearchActionsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ActionSearchDto req = ActionSearchDto.builder()
                .query("send a message")
                .connector("slack")
                .build();

        StackoneSearchActionsResponse res = sdk.actions().searchActions()
                .request(req)
                .call();

        if (res.actionSearchResponseDto().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	ActionSearchDto	✔️	The request object to use for the request.

Response

StackoneSearchActionsResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	*/*

buildActionEmbeddings

Rebuild action embeddings for semantic search

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.ActionBuildDto;
import com.stackone.stackone_client_java.models.components.Security;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.StackoneBuildActionEmbeddingsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ActionBuildDto req = ActionBuildDto.builder()
                .connectorKey("slack")
                .build();

        StackoneBuildActionEmbeddingsResponse res = sdk.actions().buildActionEmbeddings()
                .request(req)
                .call();

        if (res.actionBuildResponseDto().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	ActionBuildDto	✔️	The request object to use for the request.

Response

StackoneBuildActionEmbeddingsResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	*/*

rpcAction

Makes a remote procedure call to the specified action

Example Usage

package hello.world;

import com.stackone.stackone_client_java.StackOne;
import com.stackone.stackone_client_java.models.components.*;
import com.stackone.stackone_client_java.models.errors.*;
import com.stackone.stackone_client_java.models.operations.StackoneRpcActionResponse;
import java.lang.Exception;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws Exception {

        StackOne sdk = StackOne.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        ActionsRpcRequestDto req = ActionsRpcRequestDto.builder()
                .action("create_employee")
                .path(Map.ofEntries(
                    Map.entry("id", "123")))
                .query(Query.builder()
                    .debug(false)
                    .build())
                .headers(Map.ofEntries(
                    Map.entry("Content-Type", "application/json")))
                .body(Map.ofEntries(
                    Map.entry("data", "example")))
                .build();

        StackoneRpcActionResponse res = sdk.actions().rpcAction()
                .request(req)
                .call();

        if (res.actionsRpcResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	ActionsRpcRequestDto	✔️	The request object to use for the request.

Response

StackoneRpcActionResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/ForbiddenResponse	403	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/RequestTimedOutResponse	408	application/json
models/errors/ConflictResponse	409	application/json
models/errors/UnprocessableEntityResponse	422	application/json
models/errors/TooManyRequestsResponse	429	application/json
models/errors/InternalServerErrorResponse	500	application/json
models/errors/NotImplementedResponse	501	application/json
models/errors/BadGatewayResponse	502	application/json
models/errors/SDKError	4XX, 5XX	*/*