Skip to content

Latest commit

 

History

History
231 lines (157 loc) · 7.47 KB

README.md

File metadata and controls

231 lines (157 loc) · 7.47 KB

Events

(events)

Overview

Available Operations

list

List events.

Scopes: events:read events:write

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(
    organizationId: [
        '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    ],
);

$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 */*

listNames

List event names.

Scopes: events:read events:write

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\EventsListNamesRequest(
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
);

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


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

Parameters

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

Response

?Operations\EventsListNamesResponse

Errors

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

get

Get an event by ID.

Scopes: events:read events:write

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.

Scopes: events:write

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>',
            organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
            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 */*