api.v2.settings module

api.v2.settings.add_city_to_zip_override(city=None, state_abbreviation=None, zip_code=None, county=None)[source]

Associate a city to a zip code.

Add a city to a zip code as an override, so that the zip code will have this city as an option during the lookup of possible cities in a zip code, even if an external geolocation service disagrees.

Parameters:
  • city (str) – The exact string that will be associated with the zip_code.
  • state_abbreviation (str) – The two letter abbreviation of the state (US). This is necessary because zip codes can cross state lines.
  • zip_code (str) – The five character zip code.
  • county (str) – An appropriate county for the specified location
Returns:

  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (none)

api.v2.settings.add_county_to_zip_override(county=None, state_abbreviation=None, zip_code=None)[source]

Associate a county to a zip code.

Add a county to a zip code as an override, so that the zip code will have this county as an option during the lookup of possible cities in a zip code, even if an external geolocation service disagrees.

Parameters:
  • county (str) – The exact county string that will be associated with the zip_code.
  • state_abbreviation (str) – The two letter abbreviation of the state (US). This is necessary because zip codes can cross state lines.
  • zip_code (str) – The five character zip code.
Returns:

  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (none)

api.v2.settings.get_pdf_engine()[source]

Gets the HTML to PDF engine used by BriteCore for custom deliverables.

Returns:
  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (dict) – The data response having the form:
    {'engine': 'weasyprint'}
    
api.v2.settings.get_setting_value(section=None, option=None)[source]

Gets the value of a setting by section and option.

Parameters:
  • section (str) – The section the setting falls under.
  • option (str) – The specific option we’re looking for.
Returns:

  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (str) – The value of the setting. Settings can actually be dicts, bools, lists, or strings but are always returned inside of a string.

api.v2.settings.get_system_tags_list()[source]

Return a list of system tags.

Returns:
  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (list of dict)
api.v2.settings.retrieve_credit_permission_prompt()[source]

Retrieves the configured prompt intended prior to pulling a credit report.

Returns:
  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (object) – The data response having the form:
    {
        'prompt': 'Do you have permission to pull a credit score?'
    }
    
api.v2.settings.retrieve_property_valuation_availability(is_app=None, revision_id=None)[source]

Check whether the current user can perform a property replacement cost valuation on the policy.

Parameters:
  • is_app (bool) – True is the policy is an application and False if it is a quote.
  • revision_id (str) – ID of the revision whose property valuation availability is being questioned.
Returns:

  • success (bool) – True if successful, false if not

  • messages (list of str) – List of human-readable error messages

  • data (dict) – The data response having the form:

    {
        'allow_property_valuation': bool  # True if property valuation is allowed.
    }
    

api.v2.settings.retrieve_system_tags(level='all')[source]

Retrieves information about system tags :param level: The level at which the resulting tags are allowed to tag.

(‘line’, ‘policy_type’, ‘sub_line’,
‘policy_type_item’, ‘category’, ‘question’, ‘claim’, ‘contact’, ‘policy’)
Returns:
  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (list) – The data response having the form:
    [
        {
            'id': 'UUID',
            'name': 'Tag Name',
            'required': boolean,
            'type': ('internal', 'report', 'vendor', 'custom'),
            'style': ('text', 'checkbox', 'select'),
            'line': boolean,
            'policy_type': boolean,
            'sub_lines': boolean,
            'policy_type_item': boolean,
            'category': boolean,
            'question': boolean,
            'claim': boolean,
            'contact': boolean,
            'policy': boolean
        }
    ]
    
api.v2.settings.set_pdf_engine(engine=None)[source]

Sets the HTML to PDF engine used by BriteCore for custom deliverables.

Parameters:engine (str) – The name of the PDF engine to use for processing custom deliverables in BriteCore. (weasyprint, wkhtmltopdf)
Returns:
  • success (bool) – True if successful, false if not
  • messages (list of str) – List of human-readable error messages
  • data (none)