rbtools.api.resource.base_archived_object¶

Base resource definitions for archived object resources.

The archived/muted object resources are special because they don’t support GET at all. This means we can’t use our normal fetch-then-introspect methods in order to populate links.

Classes

class rbtools.api.resource.base_archived_object.BaseArchivedObjectItemResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, **kwargs)[source]¶

Bases: ItemResource

Base class for archived object item resources.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 28¶

__init__(transport: Transport, payload: JSONDict, url: str, token: str | None = None, **kwargs) → None[source]¶

Initialize the resource.

Parameters:

• transport (rbtools.api.transport.Transport) – The API transport.

• payload (dict) – The request payload.

• url (str) – The URL for the resource.

• token (str, optional) – The key within the request payload for the resource data.

• **kwargs (dict) – Keyword arguments to pass through to the parent class.

__static_attributes__ = ()¶

class rbtools.api.resource.base_archived_object.BaseArchivedObjectListResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, item_mime_type: str | None = None, **kwargs)[source]¶

Bases: Generic[TItemResource], ListResource[TItemResource]

Base class for archived object list resources.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 80¶

__init__(transport: Transport, payload: JSONDict, url: str, token: str | None = None, item_mime_type: str | None = None, **kwargs) → None[source]¶

Initialize the resource.

Parameters:

• transport (rbtools.api.transport.Transport) – The API transport.

• payload (dict) – The request payload.

• url (str) – The URL for the resource.

• token (str, optional) – The key within the request payload for the resource data.

• item_mime_type (str, optional) – The mimetype of the items within the list.

• **kwargs (dict) – Keyword arguments to pass through to the parent class.

__static_attributes__ = ()¶