quote

Add new custom placeholder to the wizard flow

Code
Parameters
----------
    flow_id : uuid, required
    placeholder_dict : dict, required
Returns
-------
    success : bool
    data : dict
        Representation of the placeholder

Adds a new Quote flow by passing a policy type ID. Parameters ---------- policy_type_id : uuid, required is_endorsement: bool, default to false Returns ------- success : bool data : dict Representation of the newly added wizard flow

Code
    Add a section to the current flow definition
    ----------
    flow_id : The target wizard flow
    section_name : The name from the section to be added
    Returns
    -------
    success : bool
    data : list of sections dictionary data

Code
    Update the sections list in the definition Json within the given flow
    ----------
    flow_id : The target wizard flow
    section_list : The list of sections in the desired order
    Returns
    -------
    success : bool
    data : dict - the dictionary de flow data

copy_wizard_flows

Create an endorsement flow based on a existing quote_flow. Parameters ---------- quote_flow_id : uuid, required Returns ------- success : bool data : dict Representation of the newly added endorsement wizard flow

Code
Deletes wizard flow.

Parameters
----------
    id: uuid, required

Returns
-------
    success : bool
    messages : list
        List of human-readable error messages

Return the application effective-date bounds scoped to a policy type.

Code
The `britequote` `application-past-date-bound` / `application-future-date-bound`
settings can be overridden per policy_type_definition / state. This
resolves them scoped to the given policy type (or revision) for the quote
wizard's effective-date validation, degrading to the carrier-wide global
value when no policy type/revision is in scope or resolution fails.

Parameters
----------
policy_type_id : str, optional
    The selected policy type id; preferred scope source.
revision_id : str, optional
    Fallback scope source when no policy_type_id is available.

Returns
-------
success : bool
data : dict
    ``{'allowedPastDate': str, 'allowedFutureDate': str}`` where each value
    is the resolved bound, or the string ``'None'`` when unset (matching the
    shape the wizard already consumes from the page-rendered globals).

Code
Parameters
----------
    flow_id : wizard_flow.id, required
Returns
-------
    success : bool
    data : list of features and their attributes

get all placeholders for a given flow

Code
Parameters
----------
    flow_id : uuid, required
Returns
-------
    success : bool
    data : list, list of placeholder dictionaries.

Code
Get all dependencies for a given property and integration instance.

Parameters
----------
property_id : str, required
    The target property id (uuid) - required
integration_id : str, required
    The target integration instance id (uuid) - required

Returns
-------
success : bool
data : dict - the dictionary containing the dependencies
    {
        "dependencies": [{
            "value": str,  // the category or user input value
            "itemId": str,  // the item id
            ...  // category or user input definitions
            "integrationSelectionOptions": {
                "options": [str, str, ...],
                "displaySuffixes": [str, str, ...]
            }
        }]
    }

Returns the corresponding quote wizard flow matching the filtering criteria

Code
Parameters
----------
    policy_type_id : str, optional
    role_id : str, optional
    is_endorsement: bool, default to false
Returns
-------
    success : bool
    messages : list
        List of human-readable error messages
    data : dict
        the wizard flow matchig the filter parameters or the default flow in case none are specified
        ::
        {
            "id" : uuid
            "version" : str, the uispec version of this flow
            "sections" : list, list with the sections information
            "placeholders" : dict, a map of placeholders and their values
            "customizers" : list, each element is as dict containing information to load a customizer
            "features" : str, javascript code for the uispec features
            "link_overrides" : dict
            "meta" : dict
                policy_type_id : uuid
                role_id : uuid
        }

Returns all quote wizard flows

Code
Parameters
----------
    include : str, optional
        Comma-separated list of models to include in the meta field. Available: PolicyType, EffectiveDate

Returns
-------
    list : all wizard flows

Code
    Get all wizard sections
    ----------
    flow_id : The target wizard flow
    Returns
    -------
    success : bool
    data : list of section dictionaries

Patches a flow's definition. Fields that are not specified as left intact. Parameters __________ id : uuid, required endorsement : boolean, required definition: dict, required A dict with the parts of the flow definition to be updated. For a example, a definition like: { { "features": [...] } } will patch only the features field. The other definition fields will stay the same. Returns ------- success : bool messages : list List of human-readable error messages

Code
Update the feature attribute value
Parameters
----------
    attr_dict : dictionary with relevant data, required
    should have the fields:
    flow_id - the current flow of the feature.
    id - The attribute Id
    value - the value to be changed
    key - the key of the changed value
Returns
-------
    success : bool
    data : dict - the dictionary containing the updated attribute data

Code
Update the feature display label and description
Parameters
----------
    feature_dict : dictionary with relevant data, required
    should have the fields:
    id - The feature Id
    flow_id - the wizard flow id
    label - the feature label
    display_label - the display label to be changed
    description - the descriptition to be changed
    Returns
-------
success : bool
data : dict - the dictionary containing the updated feature

Update placeholders

Code
Parameters
----------
    placeholder_dict : dict, required
Returns
-------
    success : bool
    data : dict
        Representation of the placeholder

Code
    Remove a section from the current flow definition
    ----------
    flow_id : The target wizard flow
    section_name : The name from the section to be added
    Returns
    -------
    success : bool
    data : list of sections dictionary data