utils

Associates a Report for a given Location with a deliverable template in BriteDocs

Code
Parameters
----------
x_report_location_id : str
    The UUID of the Report for a given Location (the id of a row in
     x_report_locations table).
britedocs_id : str, required
    The UUID of the Deliverable template in BriteDocs.
report_type_name : str
    The report type name of the Deliverable template in BriteCore.
location_name : str
    The location name in BriteCore.
product_name : str
    The product name in BriteLines.

Returns
-------
success : bool
    True if successful, false if not.
messages : list
    A list of human-readable error messages.
data : dict
    An empty dict emulating a 204 response from the server.

Generates a Receipt file related to the given Payment record.

Code
Parameters
----------
payment_id : str, required
    The database UUID for the specified Payment record

Returns
-------
success : bool
    True if the receipt was successfully generated

get_effective_dates

API method to retrieve links to display in navigation headers based on contact and chosen role info available in user's session.

Code
Parameters
----------

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict containing the links
    ::
    {
        "data": {
            "briteapps": str,
            "contacts": str,
            "settings": str,
            "lines": str,
            "reports": str,
            "oops": str,
            "quotes": str,
            "dashboard": str,
            "policies": str,
            "claims": str,
            "support_tools": str,
            "payments": str
        },
        "messages": [],
        "success": bool
    }

get_policies

API method to retrieve the BriteCore release info based on britecore.cfg

Code
Parameters
----------

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:
    ::
        {
            'tag': str,
            'timestamp': str | null
        }

get_signable_deliverable_names

Use this function for marking file in files table signed e.g. esigned=True after all participants signed document.

Code
Parameters
----------
file_id : str, required
    UUID of the existing File instance

Code
Mark return premium or claim payment as exported. Optionally assign check numbers and dates to the payments.

Parameters
----------
table_name : str, required
    Table name to mark as exported, return_premium or claim_transaction.
    Only claim_transaction.type = 'payment' is supported for claim_transaction table.
    check_date is persisted on both return_premium and claim_transaction.

    A return premium is exported through the same guarded routine as the Return
    Premiums UI, so a record that must not be exported -- one already exported, or
    voided, canceled, rejected, transferred back to the policy by a reinstatement, or
    unauthorized while `billing / use_authorize_return_premium` is on -- is refused
    and reported in `failed_to_export` rather than marked exported (BC-25040).
records_to_export = dict, required
    Dictionary of records to export with the form:
    ::
        {
            '123': {'check_number': '001', 'check_date': '2024-01-01'},
            '456': {'check_number': '002', 'check_date': None},
            '789': {'check_number': None, 'check_date': None},
        }
    The keys are the record ids and the values are dictionaries with the check_number and check_date to assign
    to the record. If the check_number or check_date is None, it will not be assigned to the record.

Returns
-------
success : bool
    True if successful, false if not. It returns True if at least one record is exported.
messages : list of str
    List of human-readable error messages. If the function executed successfully, this list will be empty.
    Includes error details if any record fails to be processed.
data : dict
    The data response having the form:
    ::
        {
            'successfully_exported': list of str,
            'failed_to_export': list of str
        }
    successfully_exported is a list of record ids that were successfully exported.
    failed_to_export is a list of record ids that failed to be exported.

Code
Get meta data about britecore
Currently this is only returning the live_status,
policy_prefix, and claim_prefix

Rebuilds Elastic Search indexes for select or all index maps

Code
Parameters
----------
only_build : list of str
    Which of the index maps to rebuild, options are
    ['contacts', 'policies', 'properties', 'claims', 'protection_classes']
chunk_size : int
    How many records should be queried at a time? Default is 2500, use 0 for no chunking (memory hungry, but faster)

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

Creates a refund on the given policy regardless of the policy balance.

Code
Parameters
----------
policy_number : str, required
    Any valid policy_number.
refund_amount : float, required
    The amount of the refund.
refund_reason : str, required
    The reason for creating a refund.
transfer_policy_number : str, optional
    Optionally transfer the refund amount to another policy with this number.
policy_term_id : basestring
    The term to apply the refund to.
rebill_returned_premium : bool, optional
    Bill this refund back on the remaining installments. The portion of it that leaves
    premium still owed goes back into unbilled premium, so the next rebuild collects
    that instead of spreading the whole premium difference. Defaults to False, which is
    the behaviour every other refund producer has always had. BC-24303.

    Deliberately an operator input rather than something inferred here. A
    'Return Premium' row records that cash left, not why, and the same adjustment is a
    true restatement of over-billed premium or a false one depending on which - nothing
    at this layer can tell them apart, so it is not guessed. The portion rule in
    `PolicyAccounting.rebill_returned_premium` still decides how much, and can decide
    none: a refund that only hands back a credit re-bills nothing however this is set.

Returns
-------
success : bool
    True if the refund was successfully created.
messages : list
    List of human-readable messages including information regarding encountered errors.

Retrieves the background job info.

Code
Parameters
----------
job_id : uuid, required
    The database UUID associated with the background job

Returns
-------
success : bool
    True if the query was succesful.
messages : list
    List of human-readable messages including information regarding encountered errors.
data : dict
    The data response having the form:
    ::
        {
            'job_id'  uuid: ID of the async task
            'group_id' uuid:
            'task'  str: task name
            'contact_id' uuid:
            'file_id'  uuid:
            'arguments' list: arguments passed for task
            'queue_time'  timestamp:
            'start_time' timestamp: Time when task started
            'end_time'  timestamp: Time when task finished
            'complete' bool: Indicate whether task completed
            'failed'  bool: Indicate whether task failed
            'acknowledged' bool: Indicate whether task got acknowledged
            'retries'  int: Number of retries of task
            'exception' str: Error during job execution. For Debugging purposes only. Front end should not consume.
            'results'  obj: task result
        }

Gets all Payment records made against a particular policy.

Code
Parameters
----------
policy_number : str, required
    The identifying Policy Number for a particular policy
only_missing_receipts : bool, optional
    If True, only return payments that have missing receipts

Returns
-------
success : bool
    True if payments were successfully able to be returned
data : list
    List of Payment records

This utility will return a number of the most recently added DCR / Sweep Payment receipts.

Code
Parameters
----------
number : int, optional
    The number of receipts needing to be retrieved.

Returns
-------
success : bool
    True if records were successfully gathered
data : list
    List containing objects with the following format:
        {"id": "FILE UUID", "title": "Name of File"}

Reverts the transfer of all policies between two Agents or Agencies.

Code
Parameters
----------
archive_id : str, required
    The database UUID associated with the Archive that tracks the specific execution of
    the Agent/Agency Switch Tool that is wished to be reverted.

Returns
-------
success : bool
    True if the process was evaluated for all policies.
messages : list
    List of human-readable messages including information regarding encountered errors.

Reverts the transfer of all policies between two Mortgagee.

Code
Parameters
----------
archive_id : str
    The database UUID associated with the Archive that tracks the specific execution of the
    Mortgagee Switch Tool that is wished to be reverted.

Returns
-------
success : bool
    True if the process was evaluated for all policies.
messages : list
    List of human-readable messages including information regarding encountered errors.

Transfers all policies connected an Agent/Agency to another Agent/Agency.

Code
Parameters
----------
from_contact_id : str, required
    Database UUID associated with the current Agent/Agency contact being
     taken off of the policies.
to_contact_id : str, required
    Database UUID associated with the new Agent/Agency contact that the policies
     should be transferred to.
effective_date : str, required
    String in some common date format. Should be the date agent/agency transfer
     should become effective.
print_decs : bool, optional
    True/False, whether or not the Declarations should be regenerated for the policies
     being transferred.

Returns
-------
success : bool
    True if the process was evaluated for all policies.
success_messages : list
    List of human-readable messages including information regarding policies that were successfully transferred.
failure_messages : list
    List of human-readable messages including details for policies that may not have been able to be transferred.
data : dict
    Mapping of information regarding an asynchronous task, handling the act of transferring policies. This
    identifier can be used as a reference to poll the status of that action

Transfers all policies associated with a mortgagee, to another

Code
Parameters
----------
from_contact_id : str
    Database UUID associated with the current Mortgagee contact being taken off of the policies.
to_contact_id : str
    Database UUID associated with the new Mortgagee contact that the policies should be transferred to.
effective_date : str
    String in some common date format. Should be the date agent/agency transfer should become effective.

Returns
-------
success : bool
    True if the process was evaluated for all policies.
success_messages : list
    List of human-readable messages including information regarding policies that were successfully transferred.
failure_messages : list
    List of human-readable messages including details for policies that may not have been able to be transferred.
data : dict
    Mapping of information regarding an asynchronous task, handling the act of transferring policies. This
    identifier can be used as a reference to poll the status of that action

Unarchives a record from the contacts, claims, or policies modules. Updates one entry at a time.

Code
Parameters
----------
db_table : str, required
    One of the following values: contacts | claims | policies
unique_value : str, required
    The defining column value for the chosen db table.
    Example :
        contacts --> id
        claims --> claim number
        policies --> policy number

Returns
-------
success : bool
    True if the record was found and updated, False otherwise
messages : list of str
    List of human-readable messages, descriptive of what occurred.

Performs the given action on the given Revision, assuming the action is supported.

Code
Parameters
----------
revision_id : str, required
    The database UUID associated with the Revision that needs modification
action : str, required
    The action to perform on the Revision ('delete', 'hard delete', or 'archive')

Returns
-------
success : bool
    True if the action was performed on the Revision successfully
messages : list
    List of human-readable messages, descriptive of what occurred

Updates the Search Index.

Code
Parameters
----------
index_name : str, optional
    policies | claims | contacts | properties | protection_classes
identifiers : list, optional
    A list of data where each value is unique to its table.
    Could be policy numbers, claim numbers, or UUIDs from
    policies, claims, contacts, properties, or
    protection_classes tables.

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

Given a list of dicts, format: [{'claim_number': SOME_NUMBER}] check if claim exists. Will raise NoResultFound Exception if list is empty or a given claim number does not exists

Code
Parameters
----------
claim_numbers_list : list, required

Returns
-------
claim_numbers : list
    a list of claim numbers