README.md

Search

Available Operations

• search - Search
• searchgetServerInfo - Get server info

search

ElasticSearch query engine

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
        $request = new Shared\Query();
    $request->after = [
        'users:002',
    ];
    $request->cursor = 'YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=';
    $request->ledgers = [
        'quickstart',
    ];
    $request->pageSize = 307631;
    $request->policy = 'OR';
    $request->raw = new Shared\QueryRaw();
    $request->sort = 'id:asc';
    $request->target = '<value>';
    $request->terms = [
        'destination=central_bank1',
    ];;

    $response = $sdk->search->search($request);

    if ($response->response !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

Parameter	Type	Required	Description
$request	\formance\stack\Models\Shared\Query	✔️	The request object to use for the request.

Response

?\formance\stack\Models\Operations\SearchResponse

searchgetServerInfo

Get server info

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

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

$security = new Shared\Security();
$security->authorization = '<YOUR_AUTHORIZATION_HERE>';

$sdk = stack\SDK::builder()->setSecurity($security)->build();

try {
    $response = $sdk->search->searchgetServerInfo();

    if ($response->serverInfo !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Response

?\formance\stack\Models\Operations\SearchgetServerInfoResponse