plexus.dashboard.api.models.report_configuration module

ReportConfiguration Model - Python representation of the GraphQL ReportConfiguration type.

class plexus.dashboard.api.models.report_configuration.ReportConfiguration(id: str, name: str, accountId: str, configuration: str, description: str | None = None, createdAt: datetime.datetime | None = None, updatedAt: datetime.datetime | None = None, client: ForwardRef('_BaseAPIClient') | None = None)

Bases: BaseModel

__init__(id: str, name: str, accountId: str, configuration: str, description: str | None = None, createdAt: datetime | None = None, updatedAt: datetime | None = None, client: _BaseAPIClient | None = None)

accountId: str

configuration: str

classmethod create(client: _BaseAPIClient, name: str, accountId: str, configuration: str, description: str | None = None) → ReportConfiguration

Create a new ReportConfiguration record via GraphQL mutation.

createdAt: datetime | None = None

description: str | None = None

classmethod fields() → str

Return the GraphQL fields to query for this model.

classmethod from_dict(data: Dict[str, Any], client: _BaseAPIClient) → ReportConfiguration

Create an instance from a dictionary of data.

classmethod get_by_name(name: str, account_id: str, client: _BaseAPIClient) → ReportConfiguration | None

Get a ReportConfiguration by its name within a specific account.

Uses the GSI ‘byAccountIdAndName’. Returns the first match found.

classmethod list_by_account_and_name(account_id: str, name: str, client: _BaseAPIClient, limit: int = 50, next_token: str | None = None) → Dict[str, Any]

List Report Configurations for a specific account matching a name using the GSI.

classmethod list_by_account_id(account_id: str, client: _BaseAPIClient, limit: int = 50, next_token: str | None = None) → Dict[str, Any]

List Report Configurations for a specific account using the GSI.

name: str

update(client: _BaseAPIClient, name: str, accountId: str, configuration: str, description: str | None = None) → ReportConfiguration

Update the ReportConfiguration record.

updatedAt: datetime | None = None