Getting Started
Learn by Doing
settings.toml
.secrets.toml
get_api_client()
RequestParameters
async-http
typed-config
interactive
How-To Guides
create_full_quotes_batch()
acreate_full_quotes_batch()
max_workers
max_concurrent
use_api_client
API Reference
LoadClientSettings
LoadClientSettings.load_config()
BritecoreAPIClient
BritecoreAPIClient.init_client()
BritecoreAPIClient.process_result()
BritecoreAPIClient.do_request()
BritecoreAPIClient.multiple_parameter_verification()
BritecoreAPIClient.json_dict_builder()
BritecoreAPIClient.create_full_quotes_batch()
BritecoreAPIClient.create_contacts_batch()
BritecoreAPIClient.create_policies_batch()
BritecoreAPIClient.create_risks_batch()
RequestParameters.request_timeout
RequestParameters.request_retries
RequestParameters.request_headers
RequestParameters.cache_enabled
RequestParameters.cache_ttl_seconds
RequestParameters.cache_namespace
RequestParameters.cache_key_parts
RequestParameters.cache_bypass
RequestParameters.cache_invalidate_on_success
RequestParameters.dedupe_in_flight
RequestParameters.dry_run
RequestParameters.dry_run_include_sensitive_headers
RequestParameters.rate_limiter_bypass
AsyncBritecoreAPIClient
AsyncBritecoreAPIClient.aget_client()
AsyncBritecoreAPIClient.clear_cache()
AsyncBritecoreAPIClient.invalidate_cache_namespaces()
AsyncBritecoreAPIClient.aprocess_result()
AsyncBritecoreAPIClient.ado_request()
AsyncBritecoreAPIClient.acreate_full_quotes_batch()
AsyncBritecoreAPIClient.acreate_contacts_batch()
AsyncBritecoreAPIClient.acreate_policies_batch()
AsyncBritecoreAPIClient.acreate_risks_batch()
build_cache_key()
CacheEntry
CacheEntry.value
CacheEntry.expires_at
CacheEntry.namespace
CacheEntry.created_at
CacheEntry.is_expired()
RequestCache
RequestCache.get()
RequestCache.set()
RequestCache.invalidate_namespace()
RequestCache.invalidate_namespaces()
RequestCache.clear()
RequestCache.prune_expired()
BritecoreError
BritecoreError.Base
BritecoreError.NoDataReturned
BritecoreError.NoTokenReturned
BritecoreError.InvalidPhoneNumber
BritecoreError.InvalidEmailAddress
BritecoreError.InvalidAddress
BritecoreError.BritecoreKeyError
BritecoreError.NoSiteError
BritecoreError.MissingParameter
BritecoreError.ConflictingParameters
BritecoreError.AuthenticationError
BritecoreError.RateLimitError
BritecoreError.ServerError
BritecoreError.ValidationError
BritecoreError.NotFoundError
BritecoreError.ConflictError
BritecoreError.ConfigurationError
BritecoreError.RequestTimeoutError
BritecoreBaseError
NoDataReturned
NoTokenReturned
AuthenticationError
RateLimitError
ServerError
ValidationError
NotFoundError
ConflictError
ConfigurationError
RequestTimeoutError
BritecoreKeyError
NoSiteError
MissingParameter
ConflictingParameters
InvalidPhoneNumber
InvalidEmailAddress
InvalidAddress
HealthcheckResult
HealthcheckResult.ok
HealthcheckResult.site
HealthcheckResult.auth_mode
HealthcheckResult.config_ok
HealthcheckResult.api_ok
HealthcheckResult.message
run_healthcheck()
main()
create_contacts_batch()
create_policies_batch()
create_risks_batch()
aadd_contact_to_role()
aadd_line_item()
acreate_contacts_batch()
acreate_full_quote()
acreate_policies_batch()
acreate_policy()
acreate_risk()
acreate_risks_batch()
afind_contact_by_params()
aget_contact()
aget_quote()
anew_contact()
anew_mortgagee()
anew_revision_contact()
arate_revision()
arate_risk()
aretrieve_policy()
aretrieve_policy_contact_info()
aretrieve_policy_ids()
aretrieve_policy_snapshot()
aretrieve_policy_terms()
aretrieve_revision_details()
aretrieve_risk_details()
aretrieve_risks()
astore_mortgagee()
aupdate_contact()
aupdate_property_location()
aupdate_rating_information()
BatchContactCreateResult
BatchContactCreateResult.index
BatchContactCreateResult.success
BatchContactCreateResult.contact_data
BatchContactCreateResult.contact_id
BatchContactCreateResult.error
BatchPolicyCreateResult
BatchPolicyCreateResult.index
BatchPolicyCreateResult.success
BatchPolicyCreateResult.policy_data
BatchPolicyCreateResult.revision_id
BatchPolicyCreateResult.error
BatchQuoteCreateResult
BatchQuoteCreateResult.index
BatchQuoteCreateResult.success
BatchQuoteCreateResult.quote_data
BatchQuoteCreateResult.quote_id
BatchQuoteCreateResult.error
BatchRiskCreateResult
BatchRiskCreateResult.index
BatchRiskCreateResult.success
BatchRiskCreateResult.risk_data
BatchRiskCreateResult.risk_id
BatchRiskCreateResult.error
StagedWorkflowJob
StagedWorkflowJob.contact_payload
StagedWorkflowJob.quote_payload
StagedWorkflowJob.policy_payload
StagedWorkflowJob.risk_payloads
StagedWorkflowResult
StagedWorkflowResult.index
StagedWorkflowResult.success
StagedWorkflowResult.contact_id
StagedWorkflowResult.contact_data
StagedWorkflowResult.quote_id
StagedWorkflowResult.quote_data
StagedWorkflowResult.revision_id
StagedWorkflowResult.policy_data
StagedWorkflowResult.risk_ids
StagedWorkflowResult.risk_results
StagedWorkflowResult.error
StagedWorkflowResult.failed_stage
acreate_entities_staged_batch()
create_entities_staged_batch()
add_additional_interest()
check_vehicle_prefill_fallback_configured()
create_vehicle()
delete_additional_interest()
delete_vehicle()
get_additional_interest()
get_vehicle()
list_additional_interests_for_vehicle()
list_custom_fields_types()
list_vehicles_for_quote()
update_additional_interest()
update_vehicle()
vehicle_prefill_fallback()
create_driver()
delete_driver()
get_driver()
list_driver_integration_reports()
list_drivers_for_quote()
update_driver()
create_driver_mvr_report_file()
create_violation()
create_violations()
delete_violation()
dispute_violation()
get_violation()
list_violation_for_driver()
remove_violation_dispute()
update_violation()
create_watercraft()
delete_watercraft()
get_watercraft()
list_watercrafts_for_quote()
update_watercraft()
create_geometry()
delete_geometry()
get_geometries()
get_geometry()
update_geometry()
get_zip_geometry()
Deployment & Operations
britecore_sdk/maps/
pyproject.toml
tests.yml
lint.yml
docs.yml
ci.yml
Contributing & Policies
git commit
git push
Reference & Migration
stripe/stripe-python
slackapi/python-slack-sdk
twilio/twilio-python
sendgrid/sendgrid-python
plaid/plaid-python
openapi-generators/openapi-python-client
OpenAPITools/openapi-generator
britecore_sdk
This section groups spatial helper endpoints used by the asset and geometry systems.