quota

Accessed as client.user.quota; the async client mirrors it.

SyncAsync

UserQuota

The user.quota namespace.

artifacts

artifacts(*, page: int | None = None, limit: int | None = None) -> Paginated[QuotaUsedArtifact]

List the artifacts affecting the authenticated user's quota.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`Paginated[QuotaUsedArtifact]`	QuotaUsedArtifactList.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userListQuotaArtifacts

attachments

attachments(*, page: int | None = None, limit: int | None = None) -> Paginated[QuotaUsedAttachment]

List the attachments affecting the authenticated user's quota.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`Paginated[QuotaUsedAttachment]`	QuotaUsedAttachmentList.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userListQuotaAttachments

check

check(*, subject: str) -> bool

Check if the authenticated user is over quota for a given subject.

Parameters:

Name	Type	Description	Default
`subject`	`str`	subject of the quota	required

Returns:

Type	Description
`bool`	Returns true if the action is accepted.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: userCheckQuota

get

get() -> QuotaInfo

Get quota information for the authenticated user.

Returns:

Type	Description
`QuotaInfo`	QuotaInfo.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userGetQuota

packages

packages(*, page: int | None = None, limit: int | None = None) -> Paginated[QuotaUsedPackage]

List the packages affecting the authenticated user's quota.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`Paginated[QuotaUsedPackage]`	QuotaUsedPackageList.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userListQuotaPackages

AsyncUserQuota

The user.quota namespace.

artifacts

artifacts(*, page: int | None = None, limit: int | None = None) -> AsyncPaginated[QuotaUsedArtifact]

List the artifacts affecting the authenticated user's quota.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`AsyncPaginated[QuotaUsedArtifact]`	QuotaUsedArtifactList.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userListQuotaArtifacts

attachments

attachments(*, page: int | None = None, limit: int | None = None) -> AsyncPaginated[QuotaUsedAttachment]

List the attachments affecting the authenticated user's quota.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`AsyncPaginated[QuotaUsedAttachment]`	QuotaUsedAttachmentList.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userListQuotaAttachments

check

check(*, subject: str) -> bool

Check if the authenticated user is over quota for a given subject.

Parameters:

Name	Type	Description	Default
`subject`	`str`	subject of the quota	required

Returns:

Type	Description
`bool`	Returns true if the action is accepted.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: userCheckQuota

get

get() -> QuotaInfo

Get quota information for the authenticated user.

Returns:

Type	Description
`QuotaInfo`	QuotaInfo.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userGetQuota

packages

packages(*, page: int | None = None, limit: int | None = None) -> AsyncPaginated[QuotaUsedPackage]

List the packages affecting the authenticated user's quota.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`AsyncPaginated[QuotaUsedPackage]`	QuotaUsedPackageList.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userListQuotaPackages