integrations

Code
Retrieves the installed integrations for the given policy type.

Parameters
----------
policy_type_id : str, optional
    The policy type id to retrieve the installed integrations for.
    If not provided, returns all installed integrations.
integration_point_code : str, optional
    The integration point code to filter integrations by (e.g., 'PROPERTY_VALUATION').
    If not provided, returns all integration types.

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:
    ::
        {
            "integrations": [{
                "id": str,
                "name": str
            }, ...]
        }

Code
Retrieves the potential dependencies for the given policy type.

Parameters
----------
policy_type_id : str, required
    The policy type id to retrieve the dependencies for
include_optionals : bool, optional
    Whether to include optional dependencies or not

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:
    ::
        {
            "potential_dependency_list": [{
                "categories": [{
                    "label": str,
                    "input": str,
                    "type": str,
                    "categories": [str, str, ...]
                }, ...],
                "policy_type_item_id": str,
                "policy_type_item_name": str,
                "policy_type_item_description": str,
                "policy_type_item_category": str,
                "policy_type_item_sub_line_id": str
            }, ...]
        }

Code
Retrieves the dependencies stored for the given integration and policy type.

Parameters
----------
integration_id : str, required
    The integration id
policy_type_id : str, required
    The policy type id to retrieve the dependencies for

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:
    ::
        {
            "dependencies": [str, str, ...]
        }

Code
Retrieves the Policy Types that are selected for the specified Integration Instance.

Parameters
----------
integration_instance_external_id : str
    External ID of the Integration Instance

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:
    ::
        {
            "policy_types": [{"id": "..."}, {"id": "..."}, ...]
        }

Code
Checks if a specific integration point is installed and optionally enabled for a policy type.

Parameters
----------
integration_point_code : str, required
    The code of the integration point to check (e.g. 'CLAIM_ESTIMATION')
policy_type_id : str, optional
    The policy type id to check if the integration is enabled for.
    If not provided, only checks if integration is installed globally.

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:
    ::
        {
            "is_installed": bool
        }

Code
Lists all supported Integration Points.

Parameters
----------
None

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:
    ::
        {
            "integration_points": [{
                "code": str
                "description": str
                "request_schema": JSON Schema object
                "response_schema": JSON Schema object
                "error_schema": JSON Schema object
                "request_samples": List of objects
                "response_samples": List of objects
                "error_samples": List of objects
            }, ...]
        }

Code
Allow integration instance to create a note on BriteCore.

Parameters
----------
note_data : dict
    The note data containing:
    - integration_instance_external_id: str, required
    - reference_id: str, required
    - title: str, required
    - contents: str, required

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

Code
Allow integration instance to persist file on BriteCore. Human user can download the file via
https://site.britecore.com/gateway?file=core.uploads&method=getAttachment&id=<file_id>
API user can download the file via /api/v2/files/generate_download_url.

Parameters
----------
integration_instance_external_id : str
    Specify the integration instance.
file_data_base64 : str
    The base64-encoded file data.
title : str
    The name of the file.
mime_type : str
    The mime type of the file.

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:
    ::
        {
            "file_id": str
        }

Code
Allows integration instances to send emails via BriteCore's email service.

Parameters
----------
integration_instance_external_id : str, required
    Specify the integration instance.
to_emails : list of str, required
    List of email addresses to send the email to.
subject : str, required
    The subject line of the email.
plain_body : str, required
    The plain text body of the email.
html_body : str, optional
    The HTML body of the email.
attachments : list of dict, optional
    List of attachments to include in the email. Each attachment should be a dictionary with the following keys
    - file_name: str, required
        The name of the file.
    - file_data_base64: str, required
        The base64-encoded file data.
    - mime_type: str, optional
        The mime type of the file.
cc_emails : list of str, optional
    List of email addresses to CC.
reply_to_emails : list of str, optional
    List of email addresses to set as the reply-to address. If unset, system default will be used.
attachments_exceed_message : str, optional
    Message to send along when the size of attachments exceeds the maximum allowed. Default to empty string.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

Code
Send an alert email to the receipients under Settings > Administrative Alerts > Integration Notifications.

Parameters
----------
integration_instance_external_id : str
    Specify the integration instance.
email_subject : str
    The subject line. The final email subject will have the name of the specified Integration Instance prepended
    in a pair of brackets, which will read as "[Integration Instance Name] Your Email Subject"
email_body : str
    The plain text email body.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

Code
Stores the dependencies for the given integration and policy type.

Parameters
----------
integration_id : str, required
    The integration id to store the dependencies for
policy_type_id : str, required
    The policy type id to store the dependencies for
dependencies : list of str, optional
    The dependencies to store. Each dependency is a string in the form of "policy_type_item_id--category"

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages