Events

Intro

Events passed from the integration agent back to Hydra.

For write agent, the most important events are OptinSuccessEvent and OptinFailureEvent:

OptinSuccessEvent

class lerna.events.OptinSuccessEvent(_optional=False, _description=None, **properties)

generate()

Generate a random value that satisifies this SchemaLike.

Note

Certain SchemaLikes may break this invariant if it isn’t feasible to automatically generate valid data.

lookup_name(default=None)

Look up this instance’s virtual name, falling back to its attribute name and then to default.

Parameters:default (str) – The default value to return when this instance doesn’t define a virtual name AND when it’s not a part of a larger schema (where it would get assigned the same name as its attribute name automatically). Returns:The name. Return type:str

materialize(sparse=False)

Materializes this Schema into a dictionary recursively.

Parameters:sparse (bool) – Controls whether or not null properties should be included in the result. Returns:The dictionary representation of this instance. Return type:dict

update(data)

Validate data against this Schema and set its properties to the appropriate values from the data dictionary on succcess.

Raises:ValidationError – If data fails to Schema.validate(). Parameters:data (dict) – Returns:On success. Return type:None

validate(data)

Validate data against this Schema.

Raises:ValidationError – When the dictionary fails to validate. Parameters:data (dict) – Returns:On success. Return type:None

virtualize()

The virtual representation of a Schema is that Schema.

OptinFailureEvent

class lerna.events.OptinFailureEvent(_optional=False, _description=None, **properties)

generate()

Generate a random value that satisifies this SchemaLike.

Note

Certain SchemaLikes may break this invariant if it isn’t feasible to automatically generate valid data.

lookup_name(default=None)

Look up this instance’s virtual name, falling back to its attribute name and then to default.

Parameters:default (str) – The default value to return when this instance doesn’t define a virtual name AND when it’s not a part of a larger schema (where it would get assigned the same name as its attribute name automatically). Returns:The name. Return type:str

materialize(sparse=False)

Materializes this Schema into a dictionary recursively.

Parameters:sparse (bool) – Controls whether or not null properties should be included in the result. Returns:The dictionary representation of this instance. Return type:dict

update(data)

Validate data against this Schema and set its properties to the appropriate values from the data dictionary on succcess.

Raises:ValidationError – If data fails to Schema.validate(). Parameters:data (dict) – Returns:On success. Return type:None

validate(data)

Validate data against this Schema.

Raises:ValidationError – When the dictionary fails to validate. Parameters:data (dict) – Returns:On success. Return type:None

virtualize()

The virtual representation of a Schema is that Schema.

Module docs

class lerna.events.ActionFailureEvent(_optional=False, _description=None, **properties)

Bases: lerna.events._BaseFailureEvent

class lerna.events.ActionSuccessEvent(_optional=False, _description=None, **properties)

Bases: lerna.events._BaseEvent

class lerna.events.AuthorizationFailureEvent(_optional=False, _description=None, **properties)

Bases: lerna.events._BaseFailureEvent

class lerna.events.Event(_optional=False, _description=None, **properties)

Bases: req.schema.schema.Schema

class lerna.events.IntegrationFailureEvent(_optional=False, _description=None, **properties)

Bases: lerna.events._BaseFailureEvent

Signals that something is wrong with the customer’s Integration, but that it may be reparable. Optin delivery attempts should be paused until the Integration has been successfully repaired.

class lerna.events.NetworkFailureEvent(_optional=False, _description=None, **properties)

Bases: lerna.events._BaseFailureEvent

class lerna.events.NotificationEvent(_optional=False, _description=None, **properties)

Bases: req.schema.schema.Schema

class lerna.events.OptinFailureEvent(_optional=False, _description=None, **properties)

Bases: lerna.events._BaseFailureEvent

class lerna.events.OptinSuccessEvent(_optional=False, _description=None, **properties)

Bases: lerna.events._BaseEvent

class lerna.events.ProtocolViolationEvent(_optional=False, _description=None, **properties)

Bases: lerna.events._BaseFailureEvent

class lerna.events.ReadEvent(_optional=False, _description=None, **properties)

Bases: req.schema.schema.Schema

class lerna.events.ServiceFailureEvent(_optional=False, _description=None, **properties)

Bases: lerna.events._BaseFailureEvent