Holocron

exception q2_sdk.models.holocron.BadEnvstackError[source]: This Envstack does not exist

exception q2_sdk.models.holocron.NoDataError[source]: No data returned for Envstack

class q2_sdk.models.holocron.Result(success=False, error_message=None, data=<factory>)[source]

Result of the query.

success

Sets to True if success.

Type:: bool

error_message

Shows error message.

Type:: Optional[str]

data

Data returned from Holocron.

Type:: dict

class q2_sdk.models.holocron.EnvStackEntry(env_stack='', aba='', customer_key='', db_name='', core_only=False)[source]

Stores the envstack details returned from Holocron.

envstack

The environment stack. Typically set in the format of <FI Number>-<environment>.

Type:: str

aba

The American Bankers Association number.

Type:: str

customer_key

Unique identifier for a stack.

Type:: str

db_name

The name of the database.

Type:: str

core_only

Indicator of whether this stack is an Online Banking Stack or a core adapter

Type:: bool

classmethod from_dict(envstack)[source]

Converts dictionary into a list of EnvStackEntry instances.

Parameters:: envstack (dict) – A dictionary populated with envstack information
Return type:: EnvStackEntry
Returns:: Instantiated EnvStackEntry

class q2_sdk.models.holocron.EnvStackResponse(success=False, reason='', data=None)[source]

Stores envstack response from Holocron.

success

Indicator of whether the request was successful.

Type:: bool

reason

The reasoning for the failure.

Type:: str

data

The environment stack for the provided customer key.

Type:: EnvStackEntry

class q2_sdk.models.holocron.EnvStackListResponse(success=False, reason='', data=<factory>)[source]

Stores envstack response information from Holocron.

success

Indicator of whether the request was successful.

Type:: bool

reason

The reasoning for the failure.

Type:: str

data

The list of environment stacks returned.

Type:: list[EnvStackEntry]

enum q2_sdk.models.holocron.SearchType(value)[source]

Valid values are as follows:

Name = <SearchType.Name: 'name'>

CustomerKey = <SearchType.CustomerKey: 'customer_key'>

ABA = <SearchType.ABA: 'aba'>

DbName = <SearchType.DbName: 'db_name'>

class q2_sdk.models.holocron.SearchFilter(key, search_type)[source]: SearchFilter(key: ‘str’, search_type: ‘SearchType’)

class q2_sdk.models.holocron.HolocronEndpoint(logger=None, environment=None)[source]

Interacts with Holocron for a given environment.

Parameters:

logger (Optional[TypeAliasType]) – Q2Logger instance.
environment (Optional[EnvLevel]) – The holocron environment to point to.

async get_envstack(key, search_type=SearchType.Name)[source]

Retrieves the envstack information from Holocron using the customer key.

Parameters:

key (str) – Key to filter by. Note: the response will be marked as unsuccessful if more than one envstack is returned for the provided key.
search_type (SearchType) – Can be any value from the SearchType enum. Defaults to searching by EnvStack name.

Return type:

EnvStackResponse

Returns:

EnvStackResponse dataclass containing information on the response status (success or otherwise), reasoning for any failures, and the environment stack on success.

async get_envstack_list(filter=None)[source]

Retrieves the envstack information from Holocron.

Parameters:: key – Key to filter by.
Return type:: EnvStackListResponse
Returns:: EnvStackListResponse containing information on the response status (success or otherwise), reasoning for any failures, and a list of environment stacks on success.

async create_or_update_envstack(envstack, updated_by)[source]

Envstacks are the base objects that have configs and facets attached to them. This upserts (creates or updates) a given envstack.

Parameters:

envstack (EnvStackEntry) – EnvStack metadata to create
updated_by (str) – An identifier to who is creating (your name perhaps)

async get_configs(envstack_name)[source]

Configs are key/value pairs attached to envstacks

Parameters:: envstack_name (str) – Name of the envstack
Return type:: dict

async get_facets(envstack_name, facet_id)[source]

Facets are key/value pairs attached to envstacks, but segmented one level further. Good for if multiple groups are accessing the envstack, each one can have their own facet_id.

Parameters:: envstack_name (str) – Name of the envstack
Return type:: dict

async add_configs(envstack_name, config)[source]

Configs are key/value pairs attached to envstacks. This adds arbitrary pairs under the service_configs config location

Parameters:

envstack_name (str) – Name of the envstack
config (dict) – Dict of key/value pairs to add

Return type:

bool

async add_facets(envstack_name, facet_id, config)[source]

Facets are key/value pairs attached to envstacks, but segmented one level further. Good for if multiple groups are accessing the envstack, each one can have their own facet_id.

Parameters:

envstack_name (str) – Name of the envstack
facet_id (str) – Can be anything that uniquely groups together configs. A UUID, or just a string
config (dict) – Dict of key/value pairs to add

Return type:

bool