Skip to content

README.md

Latest commit

 

History

History
297 lines (228 loc) · 14.7 KB

README.md

File metadata and controls

297 lines (228 loc) · 14.7 KB

Actions

Overview

Retrieve Actions metadata and definitions.

Available Operations

listActionsMeta

Retrieves a list of all actions metadata

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;
use StackOne\client\Models\Operations;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Operations\StackoneListActionsMetaRequest(
    groupBy: '["connector"]',
    filter: new Operations\StackoneListActionsMetaQueryParamFilter(
        connectors: 'connector1,connector2',
        accountIds: 'account1,account2',
        actionKey: 'action1',
    ),
    include: [
        Operations\StackoneListActionsMetaQueryParamInclude::ActionDetails,
    ],
    search: 'employee',
    exclude: [
        Operations\Exclude::Actions,
    ],
);

$responses = $sdk->actions->listActionsMeta(
    request: $request
);


foreach ($responses as $response) {
    if ($response->statusCode === 200) {
        // handle response
    }
}

Parameters

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

Response

?Operations\StackoneListActionsMetaResponse

Errors

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

searchActions

Search connector actions by semantic similarity

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Components\ActionSearchDto(
    query: 'send a message',
    connector: 'slack',
);

$response = $sdk->actions->searchActions(
    request: $request
);

if ($response->actionSearchResponseDto !== null) {
    // handle response
}

Parameters

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

Response

?Operations\StackoneSearchActionsResponse

Errors

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

buildActionEmbeddings

Rebuild action embeddings for semantic search

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Components\ActionBuildDto(
    connectorKey: 'slack',
);

$response = $sdk->actions->buildActionEmbeddings(
    request: $request
);

if ($response->actionBuildResponseDto !== null) {
    // handle response
}

Parameters

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

Response

?Operations\StackoneBuildActionEmbeddingsResponse

Errors

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

rpcAction

Makes a remote procedure call to the specified action

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use StackOne\client;
use StackOne\client\Models\Components;

$sdk = client\StackOne::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$request = new Components\ActionsRpcRequestDto(
    action: 'create_employee',
    path: [
        'id' => '123',
    ],
    query: new Components\Query(
        debug: false,
    ),
    headers: [
        'Content-Type' => 'application/json',
    ],
    body: [
        'data' => 'example',
    ],
);

$response = $sdk->actions->rpcAction(
    request: $request
);

if ($response->actionsRpcResponse !== null) {
    // handle response
}

Parameters

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

Response

?Operations\StackoneRpcActionResponse

Errors

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