README.md

Events

(events)

Overview

Available Operations

• get - Get Event
• ingest - Ingest Events
• list - List Events

get

Get an event by ID.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->events->get(
    id: '<value>'
);

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

Parameters

Parameter	Type	Required	Description
id	string	✔️	The event ID.

Response

?Operations\EventsGetResponse

Errors

Error Type	Status Code	Content Type
Errors\ResourceNotFound	404	application/json
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

ingest

Ingest batch of events.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Components;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Components\EventsIngest(
    events: [
        new Components\EventCreateExternalCustomer(
            name: '<value>',
            externalCustomerId: '<id>',
        ),
    ],
);

$response = $sdk->events->ingest(
    request: $request
);

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

Parameters

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

Response

?Operations\EventsIngestResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

list

List events.

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;
use Polar\Models\Operations;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\EventsListRequest();

$responses = $sdk->events->list(
    request: $request
);


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

Parameters

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

Response

?Operations\EventsListResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*