Panel Log

psengine.playbook_alerts.models.panel_log ¶

TYPE_MAPPING `module-attribute` ¶

TYPE_MAPPING = {
    'assignee_change': AssigneeChange,
    'status_change': StatusChange,
    'priority_change': PriorityChange,
    'reopen_strategy_change': OldNewOptionalType,
    'title_change': OldNewOptionalType,
    'entities_change': AddedRemovedTypeEntities,
    'related_entities_change': AddedRemovedTypeEntities,
    'description_change': OldNewOptionalType,
    'external_id_change': OldNewOptionalType,
    'comment_change': CommentChange,
    'action_change': AddedRemovedList,
    'assessment_ids_change': AddedRemovedList,
    'dns_change': DomainAbuseDnsChange,
    'whois_change': DomainAbuseWhoisChange,
    'logotype_in_screenshot_change': DomainAbuseLogoTypeChange,
    'malicious_dns_change': DomainAbuseMaliciousDnsChange,
    'reregistration_change': DomainAbuseReregistrationRecordChange,
    'malicious_url_change': DomainAbuseMaliciousUrlChange,
    'screenshot_mentions_change': DomainAbuseScreenshotMentions,
    'lifecycle_in_cve_change': VulnerabilityLifecycleChange,
    'evidence_change': CodeRepoLeakageEvidenceChange,
    'tpr_assessment_change': ThirdPartyAssessmentChange,
    'assessment_change': AssessmentChange,
}

AddedRemovedList ¶

Bases: ChangeType

added `class-attribute` `instance-attribute` ¶

added: Optional[list[str]] = []

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `class-attribute` `instance-attribute` ¶

removed: Optional[list[str]] = []

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

AddedRemovedTypeEntities ¶

Bases: ChangeType

This is valid for the following Panel Log types.

EntityChangeV2,
RelatedEntityChangeV2

added `class-attribute` `instance-attribute` ¶

added: Optional[list[IdOptionalNameType]] = []

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `class-attribute` `instance-attribute` ¶

removed: Optional[list[IdOptionalNameType]] = []

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

Assessment ¶

Bases: RFBaseModel

evidence_string `instance-attribute` ¶

evidence_string: str

level `instance-attribute` ¶

level: int

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

timestamp `instance-attribute` ¶

timestamp: datetime

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

AssessmentChange ¶

Bases: ChangeType

added `class-attribute` `instance-attribute` ¶

added: Optional[Assessment] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `class-attribute` `instance-attribute` ¶

removed: Optional[Assessment] = None

risk_attribute `instance-attribute` ¶

risk_attribute: str

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

Assignee ¶

Bases: RFBaseModel

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

name `instance-attribute` ¶

name: str

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

AssigneeChange ¶

Bases: ChangeType

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

new `class-attribute` `instance-attribute` ¶

new: Optional[Assignee] = None

old `class-attribute` `instance-attribute` ¶

old: Optional[Assignee] = None

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

ChangeType ¶

Bases: RFBaseModel

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

CodeRepoLeakageEvidence ¶

Bases: RFBaseModel

assessments `instance-attribute` ¶

assessments: list[RepoAssessment]

document `instance-attribute` ¶

document: Document

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

target_entities `instance-attribute` ¶

target_entities: list[IdOptionalNameType]

watch_lists `instance-attribute` ¶

watch_lists: list[WatchList]

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

CodeRepoLeakageEvidenceChange ¶

Bases: ChangeType

added `instance-attribute` ¶

added: list[CodeRepoLeakageEvidence]

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

CommentChange ¶

Bases: ChangeType

comment `instance-attribute` ¶

comment: str

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

DnsRecord ¶

Bases: RFBaseModel

entity `class-attribute` `instance-attribute` ¶

entity: Optional[IdOptionalNameType] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

type_ `class-attribute` `instance-attribute` ¶

type_: Optional[str] = Field(alias='type', default=None)

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

Document ¶

Bases: RFBaseModel

content `instance-attribute` ¶

content: str

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

owner_id `instance-attribute` ¶

owner_id: str

owner_name `class-attribute` `instance-attribute` ¶

owner_name: Optional[str] = None

published `instance-attribute` ¶

published: datetime

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

DomainAbuseDnsChange ¶

Bases: ChangeType

added `instance-attribute` ¶

added: list[DnsRecord]

domain `instance-attribute` ¶

domain: str

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `instance-attribute` ¶

removed: list[DnsRecord]

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

DomainAbuseLogoTypeChange ¶

Bases: ChangeType

added `class-attribute` `instance-attribute` ¶

added: Optional[list[LogotypeInScreenshot]] = []

domain `instance-attribute` ¶

domain: str

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `class-attribute` `instance-attribute` ¶

removed: Optional[list[LogotypeInScreenshot]] = []

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

DomainAbuseMaliciousDnsChange ¶

Bases: ChangeType

added `class-attribute` `instance-attribute` ¶

added: Optional[list[MaliciousDnsRecord]] = []

domain `instance-attribute` ¶

domain: str

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `class-attribute` `instance-attribute` ¶

removed: Optional[list[MaliciousDnsRecord]] = []

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

DomainAbuseMaliciousUrlChange ¶

Bases: ChangeType

added `class-attribute` `instance-attribute` ¶

added: Optional[list[MaliciousUrlRecord]] = []

domain `instance-attribute` ¶

domain: str

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `class-attribute` `instance-attribute` ¶

removed: Optional[list[MaliciousUrlRecord]] = []

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

DomainAbuseReregistrationRecordChange ¶

Bases: ChangeType

added `class-attribute` `instance-attribute` ¶

added: Optional[ReregistrationRecord] = None

domain `instance-attribute` ¶

domain: str

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `class-attribute` `instance-attribute` ¶

removed: Optional[ReregistrationRecord] = None

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

DomainAbuseScreenshotMentions ¶

Bases: ChangeType

added `instance-attribute` ¶

added: list[ScreenshotMention]

domain `instance-attribute` ¶

domain: str

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

DomainAbuseWhoisChange ¶

Bases: ChangeType

added_contacts `instance-attribute` ¶

added_contacts: list[WhoisContactRecord]

domain `instance-attribute` ¶

domain: str

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

new_record `class-attribute` `instance-attribute` ¶

new_record: Optional[WhoisRecord] = None

old_record `class-attribute` `instance-attribute` ¶

old_record: Optional[WhoisRecord] = None

removed_contacts `instance-attribute` ¶

removed_contacts: list[WhoisContactRecord]

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

LogotypeInScreenshot ¶

Bases: RFBaseModel

logotype_id `class-attribute` `instance-attribute` ¶

logotype_id: Optional[str] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

screenshot_id `class-attribute` `instance-attribute` ¶

screenshot_id: Optional[str] = None

url `instance-attribute` ¶

url: HttpUrl

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

MaliciousAssessment ¶

Bases: RFBaseModel

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

level `instance-attribute` ¶

level: int

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

title `class-attribute` `instance-attribute` ¶

title: Optional[str] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

MaliciousDnsRecord ¶

Bases: RFBaseModel

assessments `instance-attribute` ¶

assessments: list[MaliciousAssessment]

id_ `class-attribute` `instance-attribute` ¶

id_: Optional[str] = Field(alias='id', default=None)

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

MaliciousUrlRecord ¶

Bases: RFBaseModel

assessments `instance-attribute` ¶

assessments: list[UrlAssessment]

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

url `class-attribute` `instance-attribute` ¶

url: Optional[HttpUrl] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

MentionedEntity ¶

Bases: RFBaseModel

entity `instance-attribute` ¶

entity: IdOptionalNameType

fragment `class-attribute` `instance-attribute` ¶

fragment: Optional[str] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

reference `class-attribute` `instance-attribute` ¶

reference: Optional[str] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

OldNewOptionalType ¶

Bases: ChangeType

This is valid for the following Panel Log types.

ExternalIdChange,
DescriptionChange,
TitleChange,
ReopenStrategyChange

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

new `class-attribute` `instance-attribute` ¶

new: Optional[str] = None

old `class-attribute` `instance-attribute` ¶

old: Optional[str] = None

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

PanelLogV2 ¶

Bases: RFBaseModel

author_id `class-attribute` `instance-attribute` ¶

author_id: Optional[str] = None

author_name `class-attribute` `instance-attribute` ¶

author_name: Optional[str] = None

changes `instance-attribute` ¶

changes: list

created `instance-attribute` ¶

created: datetime

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

validate_changes `classmethod` ¶

validate_changes(data)

Validate each panel_log_v2 changes based on the supported changes.

The list of changes is in TYPE_MAPPING. Skip unsupported changes.

Source code in psengine/playbook_alerts/models/panel_log.py

@model_validator(mode='before')
@classmethod
def validate_changes(cls, data):
    """Validate each panel_log_v2 changes based on the supported changes.

    The list of changes is in `TYPE_MAPPING`. Skip unsupported changes.
    """
    new_changes = [
        model_type.model_validate(change)
        for change in data.get('changes', [])
        if (change_type := change.get('type')) and (model_type := TYPE_MAPPING.get(change_type))
    ]
    data['changes'] = new_changes
    return data

PriorityChange ¶

Bases: ChangeType

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

new `instance-attribute` ¶

new: str

old `instance-attribute` ¶

old: str

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

RepoAssessment ¶

Bases: RFBaseModel

entity `class-attribute` `instance-attribute` ¶

entity: Optional[IdOptionalNameType] = None

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

level `instance-attribute` ¶

level: int

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

text_indicator `class-attribute` `instance-attribute` ¶

text_indicator: Optional[str] = None

title `class-attribute` `instance-attribute` ¶

title: Optional[str] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

ReregistrationRecord ¶

Bases: RFBaseModel

expiration `class-attribute` `instance-attribute` ¶

expiration: Optional[datetime] = None

iana_id `class-attribute` `instance-attribute` ¶

iana_id: Optional[int] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

registrar `class-attribute` `instance-attribute` ¶

registrar: Optional[str] = None

registrar_name `class-attribute` `instance-attribute` ¶

registrar_name: Optional[str] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

ScreenshotMention ¶

Bases: RFBaseModel

analyzed `instance-attribute` ¶

analyzed: datetime

document `instance-attribute` ¶

document: str

mentioned_entities `instance-attribute` ¶

mentioned_entities: list[MentionedEntity]

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

screenshot_id `instance-attribute` ¶

screenshot_id: str

url `instance-attribute` ¶

url: HttpUrl

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

Source ¶

Bases: RFBaseModel

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

name `instance-attribute` ¶

name: str

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

StatusChange ¶

Bases: ChangeType

actions_taken `instance-attribute` ¶

actions_taken: list

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

new `instance-attribute` ¶

new: str

old `instance-attribute` ¶

old: str

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

TPRRiskEvidence ¶

Bases: RFBaseModel

evidence_string `class-attribute` `instance-attribute` ¶

evidence_string: Optional[str] = None

level `instance-attribute` ¶

level: int

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

timestamp `class-attribute` `instance-attribute` ¶

timestamp: Optional[datetime] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

ThirdPartyAssessmentChange ¶

Bases: ChangeType

added `class-attribute` `instance-attribute` ¶

added: Optional[TPRRiskEvidence] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `class-attribute` `instance-attribute` ¶

removed: Optional[TPRRiskEvidence] = None

risk_attribute `instance-attribute` ¶

risk_attribute: str

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

TriggeredRiskRule ¶

Bases: RFBaseModel

description `class-attribute` `instance-attribute` ¶

description: Optional[str] = None

evidence_string `class-attribute` `instance-attribute` ¶

evidence_string: Optional[str] = None

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

machine_name `class-attribute` `instance-attribute` ¶

machine_name: Optional[str] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

name `class-attribute` `instance-attribute` ¶

name: Optional[str] = None

timestamp `class-attribute` `instance-attribute` ¶

timestamp: Optional[datetime] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

UrlAssessment ¶

Bases: MaliciousAssessment

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

level `instance-attribute` ¶

level: int

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

source `instance-attribute` ¶

source: Source

title `class-attribute` `instance-attribute` ¶

title: Optional[str] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

VulnerabilityAssessment ¶

Bases: RFBaseModel

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

level `instance-attribute` ¶

level: int

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

title `class-attribute` `instance-attribute` ¶

title: Optional[str] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

VulnerabilityLifecycleChange ¶

Bases: ChangeType

added `class-attribute` `instance-attribute` ¶

added: Optional[VulnerabilityAssessment] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

removed `class-attribute` `instance-attribute` ¶

removed: Optional[VulnerabilityAssessment] = None

triggered_by_risk_rule `class-attribute` `instance-attribute` ¶

triggered_by_risk_rule: Optional[TriggeredRiskRule] = None

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

WatchList ¶

Bases: RFBaseModel

id_ `class-attribute` `instance-attribute` ¶

id_: str = Field(alias='id')

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

name `class-attribute` `instance-attribute` ¶

name: Optional[str] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

WhoisContactRecord ¶

Bases: ChangeType

city `class-attribute` `instance-attribute` ¶

city: Optional[str] = None

country `class-attribute` `instance-attribute` ¶

country: Optional[str] = None

country_code `class-attribute` `instance-attribute` ¶

country_code: Optional[str] = None

created `class-attribute` `instance-attribute` ¶

created: Optional[datetime] = None

email `class-attribute` `instance-attribute` ¶

email: Optional[str] = None

fax `class-attribute` `instance-attribute` ¶

fax: Optional[str] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

name `class-attribute` `instance-attribute` ¶

name: Optional[str] = None

organization `class-attribute` `instance-attribute` ¶

organization: Optional[str] = None

postal_code `class-attribute` `instance-attribute` ¶

postal_code: Optional[str] = None

state `class-attribute` `instance-attribute` ¶

state: Optional[str] = None

street1 `class-attribute` `instance-attribute` ¶

street1: Optional[str] = None

telephone `class-attribute` `instance-attribute` ¶

telephone: Optional[str] = None

type_ `class-attribute` `instance-attribute` ¶

type_: str = Field(alias='type')

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

WhoisRecord ¶

Bases: RFBaseModel

contact_email `class-attribute` `instance-attribute` ¶

contact_email: Optional[str] = None

created `class-attribute` `instance-attribute` ¶

created: Optional[datetime] = None

model_config `class-attribute` `instance-attribute` ¶

model_config = ConfigDict(
    extra=get('RF_MODEL_EXTRA', 'ignore')
)

name_servers `class-attribute` `instance-attribute` ¶

name_servers: Optional[list[str]] = []

private_registration `class-attribute` `instance-attribute` ¶

private_registration: Optional[bool] = None

registrar_name `class-attribute` `instance-attribute` ¶

registrar_name: Optional[str] = None

status `class-attribute` `instance-attribute` ¶

status: Optional[str] = None

json ¶

json(
    by_alias: bool = True,
    exclude_none: bool = True,
    auto_exclude_unset: bool = True,
    **kwargs,
)

JSON representation of models. It is inherited by every model.

PARAMETER	DESCRIPTION
`by_alias`	Alias flag: If `True`, writes fields with their API alias (e.g., `IpAddress`) If `False` uses the Python attribute name alias. TYPE: `bool` DEFAULT: `True`
`exclude_none`	Whether to exclude fields equal to None. TYPE: `bool` DEFAULT: `True`
`auto_exclude_unset`	Whether to auto exclude values not set. If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields. If `False`, you must specify `exclude_unset` manually. TYPE: `bool` DEFAULT: `True`

Source code in psengine/common_models.py

def json(
    self,
    by_alias: Annotated[
        bool,
        Doc(
            """
            Alias flag:

            - If `True`, writes fields with their API alias (e.g., `IpAddress`)
            - If `False` uses the Python attribute name alias.
            """
        ),
    ] = True,
    exclude_none: Annotated[bool, Doc('Whether to exclude fields equal to None.')] = True,
    auto_exclude_unset: Annotated[
        bool,
        Doc("""
            Whether to auto exclude values not set.

            - If `True`, uses `RF_EXTRA_MODEL` config to decide inclusion of unmapped fields.
            - If `False`, you must specify `exclude_unset` manually.
            """),
    ] = True,
    **kwargs,
):
    """JSON representation of models. It is inherited by every model."""
    if not auto_exclude_unset and kwargs.get('exclude_unset') is None:
        raise ValueError('`auto_exclude_unset` is False, `exclude_unset has to be provided`')

    exclude_unset = (
        bool(self.model_config['extra'] != 'allow')
        if auto_exclude_unset
        else kwargs['exclude_unset']
    )
    kwargs['exclude_unset'] = exclude_unset
    return self.model_dump(mode='json', by_alias=by_alias, exclude_none=exclude_none, **kwargs)

Panel Log

psengine.playbook_alerts.models.panel_log ¶

TYPE_MAPPING module-attribute ¶

AddedRemovedList ¶

added class-attribute instance-attribute ¶

model_config class-attribute instance-attribute ¶

removed class-attribute instance-attribute ¶

type_ class-attribute instance-attribute ¶

json ¶

AddedRemovedTypeEntities ¶

added class-attribute instance-attribute ¶

model_config class-attribute instance-attribute ¶

removed class-attribute instance-attribute ¶

type_ class-attribute instance-attribute ¶

json ¶

Assessment ¶

evidence_string instance-attribute ¶

level instance-attribute ¶

model_config class-attribute instance-attribute ¶

timestamp instance-attribute ¶

json ¶

AssessmentChange ¶

added class-attribute instance-attribute ¶

model_config class-attribute instance-attribute ¶

removed class-attribute instance-attribute ¶

risk_attribute instance-attribute ¶

type_ class-attribute instance-attribute ¶

json ¶

Assignee ¶

id_ class-attribute instance-attribute ¶

model_config class-attribute instance-attribute ¶

name instance-attribute ¶

json ¶

AssigneeChange ¶

model_config class-attribute instance-attribute ¶

new class-attribute instance-attribute ¶

old class-attribute instance-attribute ¶

type_ class-attribute instance-attribute ¶

json ¶

ChangeType ¶

model_config class-attribute instance-attribute ¶

type_ class-attribute instance-attribute ¶

json ¶

CodeRepoLeakageEvidence ¶

assessments instance-attribute ¶

document instance-attribute ¶

model_config class-attribute instance-attribute ¶

target_entities instance-attribute ¶

watch_lists instance-attribute ¶

json ¶

CodeRepoLeakageEvidenceChange ¶

added instance-attribute ¶

model_config class-attribute instance-attribute ¶

type_ class-attribute instance-attribute ¶

json ¶

CommentChange ¶

comment instance-attribute ¶

model_config class-attribute instance-attribute ¶

type_ class-attribute instance-attribute ¶

json ¶

DnsRecord ¶

entity class-attribute instance-attribute ¶

model_config class-attribute instance-attribute ¶

type_ class-attribute instance-attribute ¶

json ¶

Document ¶

content instance-attribute ¶

id_ class-attribute instance-attribute ¶

model_config class-attribute instance-attribute ¶

owner_id instance-attribute ¶

owner_name class-attribute instance-attribute ¶

published instance-attribute ¶

json ¶

DomainAbuseDnsChange ¶

added instance-attribute ¶

domain instance-attribute ¶

model_config class-attribute instance-attribute ¶

removed instance-attribute ¶

type_ class-attribute instance-attribute ¶

json ¶

TYPE_MAPPING `module-attribute` ¶

added `class-attribute` `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

removed `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

added `class-attribute` `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

removed `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

evidence_string `instance-attribute` ¶

level `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

timestamp `instance-attribute` ¶

added `class-attribute` `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

removed `class-attribute` `instance-attribute` ¶

risk_attribute `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

id_ `class-attribute` `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

name `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

new `class-attribute` `instance-attribute` ¶

old `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

assessments `instance-attribute` ¶

document `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

target_entities `instance-attribute` ¶

watch_lists `instance-attribute` ¶

added `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

comment `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

entity `class-attribute` `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

content `instance-attribute` ¶

id_ `class-attribute` `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

owner_id `instance-attribute` ¶

owner_name `class-attribute` `instance-attribute` ¶

published `instance-attribute` ¶

added `instance-attribute` ¶

domain `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

removed `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

added `class-attribute` `instance-attribute` ¶

domain `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

removed `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

added `class-attribute` `instance-attribute` ¶

domain `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

removed `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

added `class-attribute` `instance-attribute` ¶

domain `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

removed `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

added `class-attribute` `instance-attribute` ¶

domain `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

removed `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

added `instance-attribute` ¶

domain `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

type_ `class-attribute` `instance-attribute` ¶

added_contacts `instance-attribute` ¶

domain `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

new_record `class-attribute` `instance-attribute` ¶