sift_py.report_templates.config

CLASS	DESCRIPTION
ReportTemplateConfig	Configuration for a report template.
ReportTemplateUpdate	Represents a dictionary for updating properties of a report template. All fields are optional

ReportTemplateConfig

Bases: BaseModel, AsJson

Configuration for a report template.

• name: Name of the report template.
• template_client_key: Unique client key to identify the report template.
• organization_id: Organization ID that the report template belongs to.
• tags: Tags to associate with the report template.
• description: Description of the report template.
• rule_client_keys: List of rule client keys associated with the report template.
• archived_date: Date when the report template was archived. Setting this field will archive the report template, and unsetting it will unarchive the report template.
• archived: True if the report template is archived, False otherwise.

METHOD	DESCRIPTION
as_json

ATTRIBUTE	DESCRIPTION
archived	TYPE: bool
archived_date	TYPE: Optional[datetime]
description	TYPE: Optional[str]
model_config
name	TYPE: str
rule_client_keys	TYPE: List[str]
tags	TYPE: Optional[List[str]]
template_client_key	TYPE: Optional[str]
template_id	TYPE: Optional[str]

archived class-attribute instance-attribute

archived: bool = False

archived_date class-attribute instance-attribute

archived_date: Optional[datetime] = None

description class-attribute instance-attribute

description: Optional[str] = None

model_config class-attribute instance-attribute

model_config = ConfigDict(arbitrary_types_allowed=True)

name instance-attribute

name: str

rule_client_keys class-attribute instance-attribute

rule_client_keys: List[str] = []

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

template_client_key class-attribute instance-attribute

template_client_key: Optional[str] = None

template_id class-attribute instance-attribute

template_id: Optional[str] = None

as_json

as_json() -> Any

ReportTemplateUpdate

Bases: TypedDict

Represents a dictionary for updating properties of a report template. All fields are optional and only the provided fields will be updated.

• name: Updated name of the report template.
• template_client_key: Updated unique client key to identify the report template.
• organization_id: Updated organization ID that the report template belongs to.
• tags: Updated tags to associate with the report template.
• description: Updated description of the report template.
• rule_client_keys: Updated list of rule client keys associated with the report template.
• archived: True if the report template is archived, False otherwise.

ATTRIBUTE	DESCRIPTION
archived	TYPE: NotRequired[bool]
description	TYPE: NotRequired[str]
name	TYPE: NotRequired[str]
rule_client_keys	TYPE: NotRequired[List[str]]
tags	TYPE: NotRequired[List[str]]
template_client_key	TYPE: NotRequired[str]

archived instance-attribute

archived: NotRequired[bool]

description instance-attribute

description: NotRequired[str]

name instance-attribute

name: NotRequired[str]

rule_client_keys instance-attribute

rule_client_keys: NotRequired[List[str]]

tags instance-attribute

tags: NotRequired[List[str]]

template_client_key instance-attribute

template_client_key: NotRequired[str]