Skip to content

Latest commit

 

History

History
139 lines (96 loc) · 12.5 KB

README.md

File metadata and controls

139 lines (96 loc) · 12.5 KB
Raw

Repositories

(repositories)

Overview

Available Operations

  • list - List Repositories
  • get - Get Repository
  • update - Update Repository

list

List repositories.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.repositories.list()

    if res is not None:
        while True:
            # handle items

            res = res.next()
            if res is None:
                break

Parameters

Parameter Type Required Description
platform OptionalNullable[models.QueryParamPlatformFilter] ➖ Filter by platform.
name OptionalNullable[models.QueryParamRepositoryNameFilter] ➖ Filter by name.
external_organization_name OptionalNullable[models.ExternalOrganizationNameFilter] ➖ Filter by external organization name.
is_private OptionalNullable[bool] ➖ Filter by private status.
organization_id OptionalNullable[models.RepositoriesListQueryParamOrganizationIDFilter] ➖ 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.RepositorySortProperty] ➖ 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.RepositoriesListResponse

Errors

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

get

Get a repository by ID.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.repositories.get(id="<value>")

    if res is not None:
        # handle response
        pass

Parameters

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

Response

models.Repository

Errors

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

update

Update a repository.

Example Usage

from polar_sdk import Polar

with Polar(
    access_token="<YOUR_BEARER_TOKEN_HERE>",
) as s:
    res = s.repositories.update(id="<value>", repository_update={})

    if res is not None:
        # handle response
        pass

Parameters

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

Response

models.Repository

Errors

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