Models

Alerts

class q2_cores.Corelation.models.alerts.BaseAlert(serial, description, account=None, account_serial=None, serial_type=None, category=None, category_serial=None, contact_method=None, contact_address=None, person_contact_serial=None, days_before_event=None)

Bases: JsonSerializable

Base alert class with attributes that all alerts will need

serial: int

Unique alert serial number

description: str

Description of the alert; e.g. ‘Card Limit Change’

account: str | None = None

Account description; e.g. ‘0000000041 L 1001 Standard Open End’

account_serial: int | None = None

Account serial number; used for ACCOUNT_SERIAL, SHARE_SERIAL, CARD_SERIAL, etc

serial_type: str | None = None

Serial type; e.g. ‘ACCOUNT_SERIAL’ or ‘CARD_SERIAL’

category: str | None = None

Category code; e.g. ‘DEP’ or ‘PMP’

category_serial: int | None = None

Category serial number; e.g. 2 is Card Limit Change, 5 is Deposit Posted, etc

contact_method: str | None = None

Contact method value

contact_address: str | None = None

Email address or phone number

person_contact_serial: int | None = None

PERSON_CONTACT_SERIAL number

days_before_event: int | None = None

Number of days before event that the alert should trigger

class q2_cores.Corelation.models.alerts.TransactionAlert(serial, description, account=None, account_serial=None, serial_type=None, category=None, category_serial=None, contact_method=None, contact_address=None, person_contact_serial=None, days_before_event=None, minimum_amount=None, maximum_amount=None)

Bases: BaseAlert

Alert model for transaction-type alerts such as Deposit Posted

minimum_amount: str | None = None

Minimum amount to trigger alert

maximum_amount: str | None = None

Maximum amount to trigger alert

class q2_cores.Corelation.models.alerts.AlertType(target_serial, description='', message='', status='', category='', channel_serial=0, account_option=False, share_option=False, loan_option=False, card_option=False, login_option=False, minimum_amount_option=False, maximum_amount_option=False, days_before_event_option=False)

Bases: JsonSerializable

Model that describes the options available for an Alert Type

target_serial: int

Serial number of the alert type

description: str = ''

Description of the alert type; e.g. ‘Card Limit Change’

message: str = ''

Default user-facing message for the alert type

status: str = ''

Status of the alert type; e.g. ‘Open’

category: str = ''

Category code; e.g. ‘DEP’ or ‘PMP’

channel_serial: int = 0

Serial number of the alert type’s channel

account_option: bool = False

True if the alert type is available for Accounts, False otherwise

share_option: bool = False

True if the alert type is available for Shares, False otherwise

loan_option: bool = False

True if the alert type is available for Loans, False otherwise

card_option: bool = False

True if the alert type is available for Cards, False otherwise

login_option: bool = False

True if the alert type is available for Logins, False otherwise

minimum_amount_option: bool = False

True if alert type supports a Minimum Amount parameter, False otherwise

maximum_amount_option: bool = False

True if the alert type supports a Maximum Amount parameter, False otherwise

days_before_event_option: bool = False

True if the alert type supports a Days Before Event parameter, False otherwise

class q2_cores.Corelation.models.alerts.AlertsEnrollment(person_serial, alerts)

Bases: JsonSerializable

Model for ALERT_ENROLLMENT search result by Person Serial

person_serial: int

Person Serial number sent in the request

alerts: List[BaseAlert]

Alerts associated with the Person Serial

Corelation Response

class q2_cores.Corelation.models.corelation_response.LoginVerifyResponse(raw_response)

Bases: JsonSerializable