vendors

Builds an XML file for specific claims and prepares it to be sent to IVANS.

Code
Parameters
----------
data_list : list, required
    A list of claim numbers to be used to generate the files
file_date : date, required
    The date for which the file should be generated for

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

Builds an XML file for policies for specified Contact, changing all Transaction Codes to SYN.

Code
The build process will be done on the background cluster if available.

Parameters
----------
contact_id : str, required
    The id of the contact to build for
file_date : date, required
    The date for which the file should be generated for

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

Builds an XML file for specific policies and prepares it to be sent to NxTech.

Code
Parameters
----------
data_list : list, required
    Objects with key-value pairs matching the following format:
    ::
        {
            "policy_number": "SOME-POLICY",
            "transaction_code": "NxTech-Trans-Code"
        }
    The "transaction_code" choices can be found at
    https://help.britecore.com/hc/en-us/articles/8723472807443-IVANS-Download-overview

file_date : date, optional
    The date for which the manual file should be generated for.

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

Checks and returns indepth inland_flood eligibility

Code
Parameters
----------
property_id : str, required
    UUID of a BriteCore property, must have core address fields defined

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human readable messages
data : dict
    A dict containing the following data:
        KatRiskFloodScore : str
            1-10 score indicating how flood-prone a property is, 1 being least, 10 most
        FloodEligible : bool
            True means property is eligible for coverage, False means ineligible
        Message : str
            Human readable / user presentable message on whether / why not eligible

Requests and retrieves Motor Vehicle Reports (MVR) for drivers.

Code
Parameters
----------
drivers : list, required
    Objects with key-value pairs matching the following format:
    ::
        {
            "driversLicenseNumber": "123456789",
            "driversLicenseState": "MO",
            "driverFirstName": "John",
            "driverLastName": "Doe",
            "driverDateOfBirth": "1990-01-01"
        }
store_no_hit : bool, optional

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:
    ::
    {
        "123456789": {"accidents_count": 0, "violations_count": 1},
        "987654321": {"accidents_count": 1, "violations_count": 0}
    }

Submit a request to AON Cat Scoring vendor services, if enabled, for the given risk.

Code
Parameters
----------
risk_id : str
    UUID of a property/risk that needs to be scored.
geocoding_service : str
    Optional. The geocoder to be used by AON. Supported values are: Google, Pitney Bowes, or Bing

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human readable messages
data : dict
::
    {
        "air": {
            "data": {
                "TVGScore": Decimal,
                "DistanceToCoast": Decimal,
                "GeocoderAccuracy": str,
                "GeocoderServiceProviderUsed": str,
                "GeocoderServiceProviderRequested": str,
                "NonCatCost": Decimal,
                "FipsCode": int
            },
            "errors": [],
        },
        "rms": {
            "data": {
                "TVGScore": Decimal,
                "DistanceToCoast": Decimal,
                "GeocoderAccuracy": str,
                "GeocoderServiceProviderUsed": str,
                "GeocoderServiceProviderRequested": str,
                "NonCatCost": Decimal,
                "FipsCode": int
            },
            "errors": [],
        }
    }

Status of the NxTech initial load requested for a contact and date (BC-26162).

Code
Read-only: a run that stopped reporting (e.g. killed for memory) is shown as ``failed``;
marking it failed and notifying its user is left to the initial load request and the daily cron.

Parameters
----------
contact_id : str, required
    The id of the contact the initial load was requested for
file_date : date, optional
    The date the initial load was requested for. Defaults to today

Returns
-------
status : str
    ``running``, ``succeeded``, ``failed`` or ``unknown`` (no dedicated run recorded)
job_id : str
    Id of the run, if any
error : str
    Why the run failed, if it did

Return a token to initiate a 360Value Prefill data call.

Code
Parameters
----------
property_id : str, required
    UUID of the property being valuated.

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human readable messages
data : dict
    A dict containing the following data :
        token : str
            String that is used to initiate a valuation.
        script_src : str
            Location from where the 360 value script must be loaded.
        report_id : str
            UUID of the Value360Report for the current valuation.

Return a token to initiate a 360 Value property valuation.

Code
Parameters
----------
property_id : str, required
    UUID of the property being valuated.
home_type : str
    The type of home we expect to show on value360 plugin form, the default
    is ``residential`` for 1-4 Family
    The value could be one of the fallowing also:
    ``condo_iu`` for Condo Interior Unit,
    ``manufactured_mobile`` for Manufactured/Mobile

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human readable messages
data : dict
    A dict containing the following data :
        token : str
            String that is used to initiate a valuation.
        script_src : str
            Location from where the 360 value script must be loaded.
        report_id : str
            UUID of the Value360Report for the current valuation.

Code
Parameters
----------
property : str
    ID of the property/risk that the WTW STS will be calculated for.

Returns
-------
data : dict
    Set of named scores returned from the WTW STS service.
    The scores include:
        - allperils
        - fire
        - liability
        - theft
        - water
        - weather
        - other

Code
Import a credit report into the system. This is a restricted endpoint and only available to is_god users.

Parameters
----------
contact_id : str, required
    The contact id to associate the credit report with.
date_added : str, required
    The date the credit report is considered added. Format: YYYY-mm-ddTHH:MM:SSZ (in UTC)
report_number : str, required
    The report number of the credit report. Max length 20.
content : str
    Optional. The content of the credit report.
score : str
    Optional. The score of the credit report. Max length 20.
warning : str
    Optional. The warning message of the credit report. Max length 1024.

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human readable messages
data : dict
    A dict containing the following data:
    ::
        {
            "id": str  // The id of the credit report
        }

Code
Import a motor vehicle report into the system. This is a restricted endpoint and only available to is_god users.

Parameters
----------
date_added : str, required
    The date the motor vehicle report is considered added. Format: YYYY-mm-ddTHH:MM:SSZ (in UTC)
contact_id : str, required
    The contact id to associate the motor vehicle report with.
report_number : str, required
    The report number of the motor vehicle report. Max length 20.
report_content : str, required
    The content of the motor vehicle report.
drivers_license_number : str, required
    The driver's license number. Max length 260.
drivers_license_state : str, required
    BusinessLocation ID as driver's license state.

Handles enrolling or un-enrolling an account on auto-pay for Invoice Cloud. Parameters ---------- policy_number : str, required value for Policy.policy_number enable : bool, optional true if setting up for autopay, false if disabling autopay Returns ------- success : bool True if successful, False if not messages : list of str List of human-readable error messages data : dict Representation of dict result: :: { 'success': true, 'messages': [] }

Returns whether a policy is enrolled for auto-pay with Invoice Cloud.

Code
Parameters
----------
policy_number : str, required
    value for Policy.policy_number

Returns
-------
bool
    True if enrolled, False if not

Handle enrolling or un-enrolling an account/policy on eDelivery for Installment Billing Statements. When enabled the system toggles the flag suppress-primary-insured-billing-printing in XVendorPolicySetting table.

Code
This will then mark all future InvoiceCloudEDelivery.DOCUMENTS_FOR_EDELIVERY
as `do not print` for the primary insured, as Invoice Cloud will become responsible
in retrieving the document and emailing it.

Parameters
----------
policy_number : str, required
    Policy.policy_number
enable : bool, optional
    True if setting policy primary insured for eDelivery

Returns
-------
success : bool
    True if successful, False if not
messages : list of str containing possible failure messages
data : dict
    ::
    {
        'invoiceNumbers': [  # list of invoice ids that had documents affected
            # 36 charactor UUID strings referencing AccountHistory.id
        ],
        'suppressedPrinting':  # True if InvoiceCloud Edelivery was set active, else False
    }

Builds a manual edocs file for IVANS and automatically uploads it to IVANS.

Code
The generated XML files is not like the daily automated files and can be distinguished by the name
of the XML containing ``_manual``.

Parameters
----------
date_cursor : str, required
  ``YYYY-MM-DD``
file_ids : list, required
    ``['UUID1', 'UUID2']``

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human-readable error messages
data : dict
    Representation of dict result:
    ::
        {
            'data':{
                'file_name': 'britecore_edocs_manual20180601.xml',
                'success': True
                'active': True,
                'actual_print_date': None,
                'added_to_zip': False,
                'batch': '',
                'contact_id':None,
                'date_added': date,
                'date_updated': date,
                'email_only':False,
                'emailed':False,
                'esigned':False,
                'folder_id':None,
                'id': '6f22957c-de5a-426c-a819-ea94a0d25ac6',
                'isdir':False,
                'isphoto':False,
                'label':None,
                'mime_type': 'application/xml',
                'print_date':None,
                'print_location':None,
                'print_state': 'do not print',
                'private':False,
                'read_only':False,
                'received_meta_data': '',
                'reference_id':None,
                'revision_id':None,
                'size':9591,
                'sub_type':None,
                'successful_upload':False,
                'title': 'britecore_edocs_manual20180601.xml',
                'type': 'nxtech_edocs',
                'uploaded_by':None,
                'uploading_to_s3':False,
                'url': 'uploads/vendors/nxtech/edocs/britecore_edocs_manual20180601.xml',
                'vendor_upload':None,
                'virus_scan':False,
                'x_report_location_id':None
            },
            'success': True,
            'messages': []
        }

Uploads an XML file and all it's related files/transactions into IVANS servers

Code
Parameters
----------
file_name : str, optional
    The title of the XML file record to upload when ``file_id`` is omitted.
    Legacy callers may still match multiple unuploaded rows with this title.
ivans_type : str, required
    The type of IVANS service. Value of type must be one of the following:
    ``claims``, ``edocs``, ``dbcs``, ``transactions``
file_id : str, optional
    Prefer this. Uploads exactly one File row when it matches ``ivans_type``
    and ``successful_upload`` is false.

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human-readable error messages
data : list of dict
    The data response having list of result uploads:
    ::
        {
            'data':[{
                'file_name': 'britecore_edocs_manual20180601.xml',
                'success': True
            }],
            'success': True,
            'messages': []
        }

Copy the e-signature configuration of one effective date's policy types to another's.

Code
Forms and files are matched to the target effective date's copies. Saving (`dry_run` false) also
drops the entries whose policy type no longer exists; a preview reports them.

Parameters
----------
target_effective_date_id : str, required
    The effective date that receives the configuration.
source_effective_date_id : str, optional
    The effective date to copy from. Defaults to the effective date right before the target.
dry_run : bool, optional
    Report what would change without saving anything. Defaults to true.
overwrite : bool, optional
    Replace the target effective date's existing configuration. Without it, a target that already
    has configuration is refused. Defaults to false.

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:
    ::
        {
            'source_effective_date_id': UUID,
            'target_effective_date_id': UUID,
            'esignature_enabled': bool,
            'dry_run': bool,
            'applied': bool,  // False when there was nothing to save
            'requires_overwrite': bool,  // The target already has configuration
            'added_documents': [
                {
                    'document_parent_type': str,
                    'document_type_id': UUID,
                    'state_id': UUID,
                    'effective_date_id': UUID,
                    'policy_type_id': UUID
                }
            ],
            'added_policy_type_settings': {UUID: {'allow_binding_without_insured_signature': bool}},
            'replaced_documents': [],  // Target entries an overwrite replaces
            'replaced_policy_type_settings': [UUID],
            'unmatched': [
                {
                    'document_parent_type': str,
                    'document_type_id': UUID,
                    'policy_type_id': UUID,
                    'reason': str
                }
            ],
            'orphan_documents': [],  // Entries dropped because their policy type is gone
            'orphan_policy_type_settings': [UUID],
            'names': {  // Display names by id; unknown deleted records are absent
                'documents': {UUID: str},
                'policy_types': {UUID: str},
                'states': {UUID: str}
            }
        }

Checks and returns indepth inland_flood eligibility

Code
Parameters
----------
property_id : str, required
    UUID of a BriteCore property, must have core address fields defined

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human readable messages
data : dict
    A dict containing the following data:
        KatRiskFloodScore : str
            1-10 score indicating how flood-prone a property is, 1 being least, 10 most
        FloodEligible : bool
            True means property is eligible for coverage, False means ineligible
        Message : str
            Human readable / user presentable message on whether / why not eligible

Re-process missed Stripe webhooks events from the last 30 days. Currently, only payment_method.attached events are replayed.

Code
Parameters
----------
contact_id : str, required
    The contact id to replay the missed webhooks for.

Retry sending a file to SunGard.

Code
This function attempts to send a file to SunGard. It first validates the file_name and file_date parameters.
If the parameters are valid, it proceeds to send the file. If any error occurs during the process,
it logs the error and returns a standard error response.

Parameters
----------
file_name : str, required
    The name of the file to be sent. It should be either 'Return_Premium' or 'Claims'. Defaults to None.
file_date : str, required
    The date associated with the file in 'YYYY-MM-DD' format. Defaults to None.

Returns
-------
success : bool
    True if the operation is successful, False otherwise.
messages : list of str
    List of human-readable error messages.
data : dict
    The data response having the result of the operation:
    ::
        {
            'success': True,
            'messages': [],
            'data': {}
        }

Update the replacement cost value of a property from 360 Value valuation.

Code
Parameters
----------
report_id : str, required
    UUID of a report that will be updated with the result received.
result : dict, required
    The replacement cost value and the valuation id are present in the result.
        erc : float
            Property's replacement_cost_value
        valuationId : str
            value360_report valuation_id

Returns
-------
success : bool
    True if successful, False if not
messages : list of str
    List of human readable messages
data : dict
    report_file_id: str
        New Value360 report file (pdf) id
    rating_invalidated: bool
        True when the new replacement cost sent the property and its revision
        back to unrated, so the quote must be rated again.