SDKV2

(orchestration->v2)

Overview

Available Operations

testTrigger - Test trigger
cancelEvent - Cancel a running workflow
createTrigger - Create trigger
createWorkflow - Create workflow
deleteTrigger - Delete trigger
deleteWorkflow - Delete a flow by id
getInstance - Get a workflow instance by id
getInstanceHistory - Get a workflow instance history by id
getInstanceStageHistory - Get a workflow instance stage history
getServerInfo - Get server info
getWorkflow - Get a flow by id
listInstances - List instances of a workflow
listTriggers - List triggers
listTriggersOccurrences - List triggers occurrences
listWorkflows - List registered workflows
readTrigger - Read trigger
runWorkflow - Run workflow
sendEvent - Send an event to a running workflow

testTrigger

Test trigger

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\TestTriggerRequest(
    triggerID: '<id>',
);

$response = $sdk->orchestration->v2->testTrigger(
    request: $request
);

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

Parameters

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

Response

?Operations\TestTriggerResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

cancelEvent

Cancel a running workflow

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2CancelEventRequest(
    instanceID: 'xxx',
);

$response = $sdk->orchestration->v2->cancelEvent(
    request: $request
);

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

Parameters

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

Response

?Operations\V2CancelEventResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

createTrigger

Create trigger

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Shared\V2TriggerData(
    event: '<value>',
    workflowID: '<id>',
);

$response = $sdk->orchestration->v2->createTrigger(
    request: $request
);

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

Parameters

Parameter	Type	Required	Description
`$request`	Shared\V2TriggerData	✔️	The request object to use for the request.

Response

?Operations\V2CreateTriggerResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

createWorkflow

Create a workflow

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Shared\V2CreateWorkflowRequest(
    stages: [
        [
            'key' => '<value>',
        ],
    ],
);

$response = $sdk->orchestration->v2->createWorkflow(
    request: $request
);

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

Parameters

Parameter	Type	Required	Description
`$request`	Shared\V2CreateWorkflowRequest	✔️	The request object to use for the request.

Response

?Operations\V2CreateWorkflowResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

deleteTrigger

Read trigger

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2DeleteTriggerRequest(
    triggerID: '<id>',
);

$response = $sdk->orchestration->v2->deleteTrigger(
    request: $request
);

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

Parameters

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

Response

?Operations\V2DeleteTriggerResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

deleteWorkflow

Delete a flow by id

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2DeleteWorkflowRequest(
    flowId: 'xxx',
);

$response = $sdk->orchestration->v2->deleteWorkflow(
    request: $request
);

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

Parameters

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

Response

?Operations\V2DeleteWorkflowResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

getInstance

Get a workflow instance by id

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2GetInstanceRequest(
    instanceID: 'xxx',
);

$response = $sdk->orchestration->v2->getInstance(
    request: $request
);

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

Parameters

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

Response

?Operations\V2GetInstanceResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

getInstanceHistory

Get a workflow instance history by id

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2GetInstanceHistoryRequest(
    instanceID: 'xxx',
);

$response = $sdk->orchestration->v2->getInstanceHistory(
    request: $request
);

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

Parameters

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

Response

?Operations\V2GetInstanceHistoryResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

getInstanceStageHistory

Get a workflow instance stage history

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2GetInstanceStageHistoryRequest(
    instanceID: 'xxx',
    number: 0,
);

$response = $sdk->orchestration->v2->getInstanceStageHistory(
    request: $request
);

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

Parameters

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

Response

?Operations\V2GetInstanceStageHistoryResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

getServerInfo

Get server info

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();



$response = $sdk->orchestration->v2->getServerInfo(

);

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

Response

?Operations\V2GetServerInfoResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

getWorkflow

Get a flow by id

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2GetWorkflowRequest(
    flowId: 'xxx',
);

$response = $sdk->orchestration->v2->getWorkflow(
    request: $request
);

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

Parameters

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

Response

?Operations\V2GetWorkflowResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

listInstances

List instances of a workflow

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2ListInstancesRequest(
    cursor: 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==',
    pageSize: 100,
    running: true,
    workflowID: 'xxx',
);

$response = $sdk->orchestration->v2->listInstances(
    request: $request
);

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

Parameters

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

Response

?Operations\V2ListInstancesResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

listTriggers

List triggers

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2ListTriggersRequest(
    cursor: 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==',
    pageSize: 100,
);

$response = $sdk->orchestration->v2->listTriggers(
    request: $request
);

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

Parameters

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

Response

?Operations\V2ListTriggersResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

listTriggersOccurrences

List triggers occurrences

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2ListTriggersOccurrencesRequest(
    triggerID: '<id>',
    cursor: 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==',
    pageSize: 100,
);

$response = $sdk->orchestration->v2->listTriggersOccurrences(
    request: $request
);

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

Parameters

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

Response

?Operations\V2ListTriggersOccurrencesResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

listWorkflows

List registered workflows

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2ListWorkflowsRequest(
    cursor: 'aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==',
    pageSize: 100,
);

$response = $sdk->orchestration->v2->listWorkflows(
    request: $request
);

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

Parameters

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

Response

?Operations\V2ListWorkflowsResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

readTrigger

Read trigger

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2ReadTriggerRequest(
    triggerID: '<id>',
);

$response = $sdk->orchestration->v2->readTrigger(
    request: $request
);

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

Parameters

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

Response

?Operations\V2ReadTriggerResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

runWorkflow

Run workflow

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2RunWorkflowRequest(
    workflowID: 'xxx',
);

$response = $sdk->orchestration->v2->runWorkflow(
    request: $request
);

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

Parameters

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

Response

?Operations\V2RunWorkflowResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

sendEvent

Send an event to a running workflow

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use formance\stack;
use formance\stack\Models\Operations;
use formance\stack\Models\Shared;

$sdk = stack\SDK::builder()
    ->setSecurity(
        new Shared\Security(
            clientID: '<YOUR_CLIENT_ID_HERE>',
            clientSecret: '<YOUR_CLIENT_SECRET_HERE>',
        )
    )
    ->build();

$request = new Operations\V2SendEventRequest(
    instanceID: 'xxx',
);

$response = $sdk->orchestration->v2->sendEvent(
    request: $request
);

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

Parameters

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

Response

?Operations\V2SendEventResponse

Errors

Error Type	Status Code	Content Type
Errors\V2Error	default	application/json
Errors\SDKException	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

SDKV2

Overview

Available Operations

testTrigger

Example Usage

Parameters

Response

Errors

cancelEvent

Example Usage

Parameters

Response

Errors

createTrigger

Example Usage

Parameters

Response

Errors

createWorkflow

Example Usage

Parameters

Response

Errors

deleteTrigger

Example Usage

Parameters

Response

Errors

deleteWorkflow

Example Usage

Parameters

Response

Errors

getInstance

Example Usage

Parameters

Response

Errors

getInstanceHistory

Example Usage

Parameters

Response

Errors

getInstanceStageHistory

Example Usage

Parameters

Response

Errors

getServerInfo

Example Usage

Response

Errors

getWorkflow

Example Usage

Parameters

Response

Errors

listInstances

Example Usage

Parameters

Response

Errors

listTriggers

Example Usage

Parameters

Response

Errors

listTriggersOccurrences

Example Usage

Parameters

Response

Errors

listWorkflows

Example Usage