Skip to content

Latest commit

 

History

History
147 lines (101 loc) · 13.4 KB

README.md

File metadata and controls

147 lines (101 loc) · 13.4 KB

Events

(events)

Overview

Available Operations

list

List events.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.events.list()

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
start_timestamp date ➖ Filter events after this timestamp.
end_timestamp date ➖ Filter events before this timestamp.
organization_id OptionalNullable[models.EventsListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
customer_id OptionalNullable[models.EventsListQueryParamCustomerIDFilter] ➖ Filter by customer ID.
external_customer_id OptionalNullable[models.ExternalCustomerIDFilter] ➖ Filter by external customer ID.
source OptionalNullable[models.SourceFilter] ➖ Filter by event source.
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.EventSortProperty] ➖ Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
metadata Dict[str, models.MetadataQuery] ➖ Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.EventsListResponse

Errors

Error Type Status Code Content Type
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*

get

Get an event by ID.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.events.get(id="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ The event ID.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.Event

Errors

Error Type Status Code Content Type
models.ResourceNotFound 404 application/json
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*

ingest

Ingest batch of events.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:

    res = polar.events.ingest(request={
        "events": [
            {
                "name": "<value>",
                "customer_id": "<value>",
            },
            {
                "name": "<value>",
                "external_customer_id": "<id>",
            },
        ],
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request models.EventsIngest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.EventsIngestResponse

Errors

Error Type Status Code Content Type
models.HTTPValidationError 422 application/json
models.SDKError 4XX, 5XX */*