README.md

Requests

Overview

REST APIs for retrieving request information

Available Operations

• generateRequestPostmanCollection - Generate a Postman collection for a particular request.
• getRequestFromEventLog - Get information about a particular request.
• queryEventLog - Query the event log to retrieve a list of requests.

generateRequestPostmanCollection

Generates a Postman collection for a particular request. Allowing it to be replayed with the same inputs that were captured by the SDK.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \Speakeasy\SpeakeasyClientSDK;
use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
use \Speakeasy\SpeakeasyClientSDK\Models\Operations;

$security = new Shared\Security();
$security->apiKey = '<YOUR_API_KEY_HERE>';

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

try {
        $request = new Operations\GenerateRequestPostmanCollectionRequest();
    $request->requestID = '<value>';;

    $response = $sdk->requests->generateRequestPostmanCollection($request);

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

Parameters

Parameter	Type	Required	Description
$request	\Speakeasy\SpeakeasyClientSDK\Models\Operations\GenerateRequestPostmanCollectionRequest	✔️	The request object to use for the request.

Response

?\Speakeasy\SpeakeasyClientSDK\Models\Operations\GenerateRequestPostmanCollectionResponse

getRequestFromEventLog

Get information about a particular request.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \Speakeasy\SpeakeasyClientSDK;
use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
use \Speakeasy\SpeakeasyClientSDK\Models\Operations;

$security = new Shared\Security();
$security->apiKey = '<YOUR_API_KEY_HERE>';

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

try {
        $request = new Operations\GetRequestFromEventLogRequest();
    $request->requestID = '<value>';;

    $response = $sdk->requests->getRequestFromEventLog($request);

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

Parameters

Parameter	Type	Required	Description
$request	\Speakeasy\SpeakeasyClientSDK\Models\Operations\GetRequestFromEventLogRequest	✔️	The request object to use for the request.

Response

?\Speakeasy\SpeakeasyClientSDK\Models\Operations\GetRequestFromEventLogResponse

queryEventLog

Supports retrieving a list of request captured by the SDK for this workspace. Allows the filtering of requests on a number of criteria such as ApiID, VersionID, Path, Method, etc.

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \Speakeasy\SpeakeasyClientSDK;
use \Speakeasy\SpeakeasyClientSDK\Models\Shared;
use \Speakeasy\SpeakeasyClientSDK\Models\Operations;

$security = new Shared\Security();
$security->apiKey = '<YOUR_API_KEY_HERE>';

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

try {
        $request = new Operations\QueryEventLogRequest();
    $request->filters = new Shared\Filters();
    $request->filters->filters = [
        new Shared\Filter(),
    ];
    $request->filters->limit = 241978;
    $request->filters->offset = 451388;
    $request->filters->operator = '<value>';;

    $response = $sdk->requests->queryEventLog($request);

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

Parameters

Parameter	Type	Required	Description
$request	\Speakeasy\SpeakeasyClientSDK\Models\Operations\QueryEventLogRequest	✔️	The request object to use for the request.

Response

?\Speakeasy\SpeakeasyClientSDK\Models\Operations\QueryEventLogResponse