quota

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

SyncAsync

OrgsQuota

The orgs.quota namespace.

artifacts

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

List the artifacts affecting the organization's quota.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`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
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgListQuotaArtifacts

attachments

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

List the attachments affecting the organization's quota.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`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
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgListQuotaAttachments

check

check(org: str, *, subject: str) -> bool

Check if the organization is over quota for a given subject.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`subject`	`str`	subject of the quota	required

Returns:

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

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: orgCheckQuota

get

get(org: str) -> QuotaInfo

Get quota information for an organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required

Returns:

Type	Description
`QuotaInfo`	QuotaInfo.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgGetQuota

packages

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

List the packages affecting the organization's quota.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`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
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgListQuotaPackages

AsyncOrgsQuota

The orgs.quota namespace.

artifacts

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

List the artifacts affecting the organization's quota.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`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
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgListQuotaArtifacts

attachments

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

List the attachments affecting the organization's quota.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`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
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgListQuotaAttachments

check

check(org: str, *, subject: str) -> bool

Check if the organization is over quota for a given subject.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`subject`	`str`	subject of the quota	required

Returns:

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

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: orgCheckQuota

get

get(org: str) -> QuotaInfo

Get quota information for an organization.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required

Returns:

Type	Description
`QuotaInfo`	QuotaInfo.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgGetQuota

packages

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

List the packages affecting the organization's quota.

Parameters:

Name	Type	Description	Default
`org`	`str`	name of the organization	required
`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
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: orgListQuotaPackages