attachments

Create subfolder in user folder.

Code
Parameters
----------
folder_name : str
    Folder name
reference_id : str
    Reference id
reference_type : str
    Reference type
parent_folder_id : str
    Parent folder id

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    A dict containing the following data representation. ::
        {'folder_id': folder_id}

Code
Deletes attachments and everything in the folders among them (the classic `core.uploads.removeAttachments`).
Unlike `remove_attachments`, it applies the delete rules: on the agent portal the agent rules (policy files only,
of unsubmitted policies unless the agent may remove them at any time), elsewhere the `removeAttachments`
permission of the record kind, or the delete time limit for one's own uploads. A refused delete changes nothing.

Parameters
----------
attachment_ids : list of str, required
    The files and folders to delete.

Returns
-------
dict
    ``message`` and ``returnById`` (``success`` and ``message`` per attachment).

Removes a photo from the file table and also deletes the photo on the filesystem.

Code
Parameters
----------
file_id : str, required
    The UUID for the file

Code
Gets the new attachment definition and updates the existing attachment with the new definition.
An empty or null code_value_type clears the Type and its quick_code.
Parameters:
    attachment: dict
        title: str - The attchment name
        description: str - The attachment description
        code_value_type: str - The attachment type (FK to quick_code_values.codeValueType)
        quick_code: str - The parent category (FK to quick_code_values.quickCode)
        tag: str - Alias for code_value_type
        id: str - The attachment id
    claim_id: str, optional
        Legacy claim ownership hint (same as reference_id for claims).
    reference_type: str, optional
        Expected attachment type (claims/policies/contacts).
    reference_id: str, optional
        Expected owning entity id.
Returns:
    dict: The updated attachment definition

Get Folder's file list.

Code
Parameters
----------
folder_id : str
    Folder id
reference_id : str, required
    Reference id
reference_type : str, required
    Reference type
order_by : str
    Column name to sort by
ascending : bool
    Asc/Desc
page : int
    Page number
include_forms : bool
    Includes forms in response
    Removes "fake forms" which were generated when the setting `printing.include-forms-as-attachments` was enabled.
    `getToBePrinted` does the same.

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    A dict containing the following data representation. ::
    {
        "folders": [],
        "records": [
            {
                "isdir": true,
                "actualPrintDate": null,
                "printState": "Do Not Print",
                "folderId": null,
                "emailed": false,
                "uploadingToS3": false,
                "emailOnly": false,
                "url": "/gateway?file=core.uploads&method=getAttachment&id=a5ba0c19-776a-4cab-aaef-6987784b84a4",
                "title": "Continuation of Coverage - NonPay",
                "mimeType": null,
                "printDateFmt": null,
                "folderName": null,
                "readOnly": true,
                "private": false,
                "dateAddedFmt": "12/06/2017 03:34 PM",
                "itemCount": 1,
                "id": "a5ba0c19-776a-4cab-aaef-6987784b84a4",
                "size": "0.0 bytes",
                "label": "Continuation of Coverage - NonPay"
            },...
        ],
        "activePage": 1,
        "maxPages": 1,
        "folderName": null
    }

Gets the reference ID and receivedMetadata fields associated with the given file ID.

Code
Parameters
----------
file_id : str, required
    The UUID for the file

Returns
-------
success : bool
    True if completely successful, false otherwise
messages : list of str
    Human readable error messages, if any
data : dict
    The metadata portion of the data is of variable format, depending on the type of file.
    It is returned as it is stored in the database. Broadly it will either be a
    dictionary, or a list of dictionaries:
    ::
        {
            "reference_id": "alpha_numeric_file_reference_id",
            "metadata": [
                {
                    "relatedToBillWhom": bool,
                    "contactId": [
                        "alpha_numeric_contact_id",
                        "alpha_numeric_contact_id"
                    ],
                    "type": "namedInsured,agent,etc...",
                    "name": [
                        "Full Name 1",
                        "Full Name 2"
                    ],
                    "address": "Street Address <br /> with HTML inclusions"
                },
                {
                    ...
                }
            ]
        }

Exposure of 'api.v2.insured._get_photos_for_entity'

Code
Parameters
----------
reference_id : str
    id of resourse

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    A dict containing the following data ::
        {
            insured=[{
                caption='',
                id='d023b562-e618-4130-96e8-c085cb9265c6',
                date_added='2020-11-10 03:33:33'
            }],
            carrier=[],
            preferred='d023b562-e618-4130-96e8-c085cb9265c6'
        }

Code
A page of a record's attachments (the classic `core.uploads.retrieveAttachments`): the folders and files of one
folder, a search across the record's files, or with ``list_view`` every file of the record. The session's CSRF
token goes in ``_csrf_token``; a caller with an API key needs none.

Parameters
----------
reference_type : str, required
    The record kind: claims, policies, contacts, policy_types or reports.
reference_id : str
    The record's id. None for lines and reports, which list every file of their kind.
folder_id : str
    The folder to list; None for the root folder. Ignored while ``search_string`` is set.
search_string : str
    Matches the title, the description and the file type.
list_view : bool
    Every file of the record, without folders.
display_original_print_state : bool
    Keep the stored print state of a lone print or email copy.
page : int
    Page number, 1 or greater (defaults to 1).
page_size : int
    Size of the page, 1 or greater, capped at 100 (defaults to 10).
order_by : str
    One of `domain.file.ATTACHMENT_SORT_COLUMNS`, in either spelling (defaults to 'dateAdded').
ascending : bool
    Sort ascending (defaults to False).
skip_reference_id_filter : bool
    With no ``reference_id``, list every file of the kind. Lines and reports only.
date_added_start, date_added_end, print_date_start, print_date_end : str
    Date filters (``MM/DD/YYYY``), each optional.

Returns
-------
dict
    ``records`` (the page; each with ``canBeDeletedByThisUser``), ``folders`` (the path to the open folder),
    ``folderName``, ``canMakePrivate``, ``activePage``, ``maxPages`` and ``fileCount``.

Code
Moves attachments into a folder of their record (the classic `core.uploads.moveAttachments`). Moving into a
private folder makes them private. A read-only attachment stays. A folder cannot go into itself or into a folder
inside it.

Parameters
----------
attachment_ids : list of str, required
    The files and folders to move.
folder_id : str
    A folder of their record to move them into; None for the root folder.

Returns
-------
dict
    ``message`` and ``returnById`` (``success`` and ``message`` per attachment).

Move file

Code
Parameters
----------
file_id : str
    Moved file id
to_folder_id : str
    New folder's id

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

Code
Creates a folder (the classic `core.uploads.newFolder`). A folder in a private folder is private.

Parameters
----------
reference_type : str, required
    The record kind: claims, policies, contacts, policy_types or reports.
folder_name : str, required
    The folder's name.
reference_id : str
    The record's id. None for lines and reports.
parent_folder_id : str
    The folder of the record to create it in; None for the root folder.

Returns
-------
dict
    The new folder's ``id`` and ``title``.

Removes attachments.

Code
Parameters
----------
attachment_ids : list of str
    List of attachment ids to remove

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    A dict containing the following data representation. ::
        {'returnById': {
            'id1': True,
            'id2': False
            ....
            }
        }

Rename file

Code
Parameters
----------
file_id : str
    Renamed file id
file_name : str
    New title for the file. Named file_name to keep the API signature; the
    value is stored on File.title.

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

Code
Retrieves all attachments that the user is privileged to see from
the `files` table with the reference id equal to one passed in as an
argument. The JSON string represents the same hierarchical structure
as the filesystem.

Parameters
----------
reference_id : str, required
    The ID of the related policies, claims, etc.
reference_type : str, required
    The associated BriteCore module
folder_id : str
    The ID of the folder to retrieve
    None, if at the root.
search_string : str | None
    An optional search string to search by on the File.title column.
list_view : bool
    Display contents of attachments without directories
    but in a paginated list sorted by dateAdded by default.
display_original_print_state: bool
    Return the original value of the print_state field instead of
    consolidating the values of email and print states
page : int
    Page number, 1 or greater (defaults to 1).
page_size : int
    Size of the page, 1 or greater, capped at 100 (defaults to 10).
order_by : str
    One of `domain.file.ATTACHMENT_SORT_COLUMNS`, in either spelling
    (defaults to 'dateAdded').
ascending : bool
    Boolean option representing ascending or
    descending (defaults to False).

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    A dict containing the following data representation.
    ``recipientName`` is the Declaration recipient's contact name for
    ``label='Form'`` attachments and ``null`` for every other row.
    {
        "folders": [],
        "activePage": 1,
        "folderName": null,
        "records": [
            {
                "isdir": false,
                "actualPrintDate": null,
                "printState": "Do Not Print or Email",
                "folderId": null,
                "mimeType": "image/jpeg",
                "uploadingToS3": false,
                "emailOnly": false,
                "title": "1616576475555.jpeg",
                "recipientName": null,
                "folderIsPrivate": null,
                "printDateFmt": null,
                "id": "0af756d7-7b35-439e-a9e4-53e8830050d7",
                "edeliveryState": null,
                "readOnly": false,
                "folderName": null,
                "private": false,
                "dateAddedFmt": "04/26/2021 05:07 AM",
                "itemCount": 0,
                "certifiedMail": null,
                "size": "86.9 KB"
            }
        ],
        "maxPages": 1,
        "canMakePrivate": true
    }

Code
A record's folders, for choosing where to move attachments (the classic `core.uploads.retrieveFolderTree`).

Parameters
----------
reference_type : str, required
    The record kind: claims, policies, contacts, policy_types or reports.
reference_id : str
    The record's id.

Returns
-------
list of dict
    One ``Root Folder`` node (``id`` None); each node has ``label``, ``id`` and ``children``.

Code
Makes each private attachment public and each public one private (the classic
`core.uploads.toggleAttachmentsPrivacy`). A folder's files and folders take its new privacy.

Parameters
----------
attachment_ids : list of str, required
    The files and folders to toggle.

Returns
-------
dict
    ``message`` and ``returnById`` (``private`` per attachment).

Code
Sets the print state of attachments (the classic `core.uploads.updateAttachmentsPrintStates`). A folder's files
take it too. Void needs the `printStateUpdateToVoid` permission of every record kind among them.

Parameters
----------
attachment_ids : list of str, required
    The files and folders.
print_state : str, required
    A print state label, e.g. 'Do Not Print', 'Printed', 'Void' or 'Email, but Do Not Print'.

Returns
-------
dict
    ``message`` and ``returnById`` (``true`` per attachment).

Upload attachment to user folder.

Code
Parameters
----------
file_data_base64 : str
    Base64 encoded data
file_type : str
    File MIME type
file_name : str
    Filename
reference_id : str
    Reference id
reference_type : str
    Reference type
folder_id : str
    Folder id (optional)

Returns
-------
success : bool
    True if completely successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    A dict containing the following data representation. ::
        {'folder_id': folder_id}

Upload attachment to user folder.

Code
Parameters
----------
file_data_base64 : str
    Base64 encoded data
file_type : str
    File MIME type
file_name : str
    Filename
reference_id : str
    Reference id
reference_type : str
    Reference type
folder_id : str
    Folder id (oprtional)
revisionId : str
    Revision Id (optional)

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

Code
Uploads files into a record's folder (the classic `core.uploads.uploadAttachment`). Send ``multipart/form-data``:
one ``files`` part per file, and the other parameters as fields.

Parameters
----------
reference_type : str, required
    The record kind: claims, policies, contacts, policy_types or reports.
reference_id : str
    The record's id. None for lines and reports.
folder_id : str
    The folder of the record to upload into; None for the root folder.
details : str
    JSON list, one object per file: ``fileName`` (the part it describes), ``name`` (the title), ``description``,
    ``code_value_type`` and ``quick_code`` (the file type).
from_brite_quote : bool
    The upload comes from the agent portal's quote.
files : file parts, required
    The files. Read from the request itself.

Returns
-------
dict
    ``id``: the last stored file's id.