Skip to content

flowmachine.core.server.query_schemas.custom_fields

Class AggregateBy

AggregateBy(required=False, validate=None, **kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

A string representing a period type, e.g. "day"

Attributes

Methods

context

context
Source: marshmallow/fields.py

The context dictionary for the parent :class:Schema.

root

root
Source: marshmallow/fields.py

Reference to the Schema that this field belongs to even if it is buried in a container field (e.g. List). Return None for unbound fields.

Class Bounds

Bounds(*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)
Source: flowmachine/core/server/query_schemas/custom_fields.py

Schema representing a range (i.e. lower and upper bound, both required, lower bound must be less than upper.

Attributes

Methods

to_tuple

to_tuple(self, params, **kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

validate_bounds_if_present

validate_bounds_if_present(self, data, **kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

dict_class

dict_class
Source: marshmallow/schema.py

set_class

set_class
Source: marshmallow/schema.py

Class DFSMetric

DFSMetric(required=True, validate=None, **kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

A string representing a DFS metric (for example: "amount", "commission", "fee", "discount")

Attributes

Methods

context

context
Source: marshmallow/fields.py

The context dictionary for the parent :class:Schema.

root

root
Source: marshmallow/fields.py

Reference to the Schema that this field belongs to even if it is buried in a container field (e.g. List). Return None for unbound fields.

Class EventTypes

EventTypes(required=False, validate=None, **kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

A list of strings representing an event type, for example "calls", "sms", "mds", "topups". When deserialised, will be deduped, and prefixed with "events."

Attributes

Methods

context

context
Source: marshmallow/fields.py

The context dictionary for the parent :class:Schema.

root

root
Source: marshmallow/fields.py

Reference to the Schema that this field belongs to even if it is buried in a container field (e.g. List). Return None for unbound fields.

Class ISODateTime

ISODateTime(format: str = None, **kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

Like marhsmallow's datetime field, but accepts anything that can be parsed using python's fromisoformat, e.g. "2016-01-01", "2016-01-01T00:00:00", "2016-01-01 00:00:00"

Attributes

Methods

context

context
Source: marshmallow/fields.py

The context dictionary for the parent :class:Schema.

root

root
Source: marshmallow/fields.py

Reference to the Schema that this field belongs to even if it is buried in a container field (e.g. List). Return None for unbound fields.

Class Statistic

Statistic(required=True, validate=None, **kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

A string representing a statistic type, e.g. "median"

Attributes

Methods

context

context
Source: marshmallow/fields.py

The context dictionary for the parent :class:Schema.

root

root
Source: marshmallow/fields.py

Reference to the Schema that this field belongs to even if it is buried in a container field (e.g. List). Return None for unbound fields.

Class SubscriberSubset

SubscriberSubset(required=False, allow_none=True, validate=None, **kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

Represents a subscriber subset. This can either be a string representing a query_id or None, meaning "all subscribers".

Attributes

Methods

context

context
Source: marshmallow/fields.py

The context dictionary for the parent :class:Schema.

root

root
Source: marshmallow/fields.py

Reference to the Schema that this field belongs to even if it is buried in a container field (e.g. List). Return None for unbound fields.

Class TotalBy

TotalBy(required=False, **kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

A string representing a period type, e.g. "day"

Attributes

Methods

context

context
Source: marshmallow/fields.py

The context dictionary for the parent :class:Schema.

root

root
Source: marshmallow/fields.py

Reference to the Schema that this field belongs to even if it is buried in a container field (e.g. List). Return None for unbound fields.

Class TowerDayOfWeekScores

TowerDayOfWeekScores(**kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

A dictionary mapping days of the week ("monday", "tuesday" etc.) to numerical scores in the range [-1.0, +1.0].

Attributes

Methods

context

context
Source: marshmallow/fields.py

The context dictionary for the parent :class:Schema.

root

root
Source: marshmallow/fields.py

Reference to the Schema that this field belongs to even if it is buried in a container field (e.g. List). Return None for unbound fields.

Class TowerHourOfDayScores

TowerHourOfDayScores(**kwargs)
Source: flowmachine/core/server/query_schemas/custom_fields.py

A list of length 24 containing numerical scores in the range [-1.0, +1.0],

Attributes

Methods

context

context
Source: marshmallow/fields.py

The context dictionary for the parent :class:Schema.

root

root
Source: marshmallow/fields.py

Reference to the Schema that this field belongs to even if it is buried in a container field (e.g. List). Return None for unbound fields.