Skip to content

README.md

Latest commit

 

History

History
177 lines (114 loc) · 12.9 KB

README.md

File metadata and controls

177 lines (114 loc) · 12.9 KB

OrganizationAccessTokens

(organization_access_tokens)

Overview

Available Operations

list

List organization access tokens.

Scopes: organization_access_tokens:read organization_access_tokens:write

Example Usage

from polar_sdk import Polar


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

    res = polar.organization_access_tokens.list(organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737", page=1, limit=10)

    while res is not None:
        # Handle items

        res = res.next()

Parameters

Parameter Type Required Description
organization_id OptionalNullable[models.OrganizationAccessTokensListQueryParamOrganizationIDFilter] ➖ Filter by organization ID.
page Optional[int] ➖ Page number, defaults to 1.
limit Optional[int] ➖ Size of a page, defaults to 10. Maximum is 100.
sorting List[models.OrganizationAccessTokenSortProperty] ➖ 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.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.OrganizationAccessTokensListResponse

Errors

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

create

Scopes: organization_access_tokens:write

Example Usage

from polar_sdk import Polar


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

    res = polar.organization_access_tokens.create(request={
        "comment": "The Football Is Good For Training And Recreational Purposes",
        "scopes": [],
    })

    # Handle response
    print(res)

Parameters

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

Response

models.OrganizationAccessTokenCreateResponse

Errors

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

update

Scopes: organization_access_tokens:write

Example Usage

from polar_sdk import Polar


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

    res = polar.organization_access_tokens.update(id="<value>", organization_access_token_update={})

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
id str ✔️ N/A
organization_access_token_update models.OrganizationAccessTokenUpdate ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.OrganizationAccessToken

Errors

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

delete

Scopes: organization_access_tokens:write

Example Usage

from polar_sdk import Polar


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

    polar.organization_access_tokens.delete(id="<value>")

    # Use the SDK ...

Parameters

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

Errors

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