Settings Module API

API reference for application settings endpoints.

BriteCore v2 Settings API endpoint wrappers.

This module provides wrappers for settings, ZIP override, PDF engine, and system-tag endpoints in the BriteCore v2 settings API.

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

Add a city override for a ZIP code.

POST /api/v2/settings/add_city_to_zip_override

Parameters:

  • city (str | None)

  • county (str | None)

  • state_abbreviation (str | None)

  • zip_code (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.add_counties_to_state(counties=None, country=None, state=None, **kwargs)[source]

Add county records to a state.

POST /api/v2/settings/add_counties_to_state

Parameters:

  • counties (list | None)

  • country (str | None)

  • state (dict | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

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

Add a county override for a ZIP code.

POST /api/v2/settings/add_county_to_zip_override

Parameters:

  • county (str | None)

  • state_abbreviation (str | None)

  • zip_code (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.get_pdf_engine(**kwargs)[source]

Retrieve the active PDF engine setting.

POST /api/v2/settings/get_pdf_engine

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.get_setting_value(option=None, section=None, **kwargs)[source]

Retrieve a specific system setting value.

POST /api/v2/settings/get_setting_value

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.get_system_tags_list(**kwargs)[source]

Retrieve the complete system tag list.

POST /api/v2/settings/get_system_tags_list

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.retrieve_credit_permission_prompt(**kwargs)[source]

Retrieve the configured credit permission prompt.

POST /api/v2/settings/retrieve_credit_permission_prompt

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.retrieve_property_valuation_availability(chosen_role=None, is_app=None, revision_id=None, **kwargs)[source]

Check property valuation availability for a revision.

POST /api/v2/settings/retrieve_property_valuation_availability

Parameters:

  • chosen_role (str | None)

  • is_app (bool | None)

  • revision_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.retrieve_system_tags(level=None, **kwargs)[source]

Retrieve system tags, optionally filtered by level.

POST /api/v2/settings/retrieve_system_tags

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.set_pdf_engine(engine=None, **kwargs)[source]

Set the PDF engine used for document generation.

POST /api/v2/settings/set_pdf_engine

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.set_setting_value(option=None, section=None, value=None, **kwargs)[source]

Set the value of a specific system setting.

POST /api/v2/settings/set_setting_value

Parameters:

  • option (str | None)

  • section (str | None)

  • value (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.create_carbone_custom_deliverable(custom_name=None, module=None, generated_per=None, **kwargs)[source]

Create Carbone Custom Deliverable.

POST /api/v2/settings/create_carbone_custom_deliverable

Parameters:

  • custom_name (Any | None)

  • module (Any | None)

  • generated_per (Any | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.create_system_tags(system_tags=None, **kwargs)[source]

Create System Tags.

POST /api/v2/settings/create_system_tags

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.delete_carbone_custom_deliverable(id=None, **kwargs)[source]

Delete Carbone Custom Deliverable.

POST /api/v2/settings/delete_carbone_custom_deliverable

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.get_deliverable_preview_json(entity_id=None, deliverable_id=None, entity_type=None, entity_number=None, policy_type_name=None, location_id=None, **kwargs)[source]

Get Deliverable Preview Json.

POST /api/v2/settings/get_deliverable_preview_json

Parameters:

  • entity_id (Any | None)

  • deliverable_id (Any | None)

  • entity_type (Any | None)

  • entity_number (Any | None)

  • policy_type_name (Any | None)

  • location_id (Any | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.list_cancellation_reasons(ids=None, policy_life_cycle_ids=None, **kwargs)[source]

List Cancellation Reasons.

POST /api/v2/settings/list_cancellation_reasons

Parameters:

  • ids (list[str] | None)

  • policy_life_cycle_ids (list[str] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.list_system_tags(additionalProperties=None, **kwargs)[source]

List System Tags.

POST /api/v2/settings/list_system_tags

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.new_permission_level_rule_dashboard(permission_level_id=None, is_primary=None, **kwargs)[source]

New Permission Level Rule Dashboard.

POST /api/v2/settings/new_permission_level_rule_dashboard

Parameters:

  • permission_level_id (str | None)

  • is_primary (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.persist_carbone_draft(new_draft_filename=None, deliverable_id=None, new_draft_id=None, prior_draft_id=None, **kwargs)[source]

Persist Carbone Draft.

POST /api/v2/settings/persist_carbone_draft

Parameters:

  • new_draft_filename (Any | None)

  • deliverable_id (Any | None)

  • new_draft_id (Any | None)

  • prior_draft_id (Any | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.remove_permission_level_rule_dashboard(permission_level_rule_dashboard_id=None, **kwargs)[source]

Remove Permission Level Rule Dashboard.

POST /api/v2/settings/remove_permission_level_rule_dashboard

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.retrieve_permissions(prefixes=None, **kwargs)[source]

Retrieve Permissions.

POST /api/v2/settings/retrieve_permissions

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.retrieve_quick_code_value_tags(quick_code=None, **kwargs)[source]

Retrieve Quick Code Value Tags.

POST /api/v2/settings/retrieve_quick_code_value_tags

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.retrieve_template_setup(**kwargs)[source]

Retrieve Template Setup.

POST /api/v2/settings/retrieve_template_setup

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.settings.update_carbone_custom_deliverable(id=None, **kwargs)[source]

Update Carbone Custom Deliverable.

POST /api/v2/settings/update_carbone_custom_deliverable

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.settings.update_permission_level_rule_dashboard(permission_level_rule_dashboard_id=None, dashboard_id=None, is_primary=None, **kwargs)[source]

Update Permission Level Rule Dashboard.

POST /api/v2/settings/update_permission_level_rule_dashboard

Parameters:

  • permission_level_rule_dashboard_id (str | None)

  • dashboard_id (str | None)

  • is_primary (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any