Skip to main content

EFSPIntegration.efm_client

DALogger Objects​

class DALogger(LoggerAdapter)

log​

def log(level, msg, *args, **kwargs)

Delegate a log call to Docassemble's log function, after adding contextual information from this adapter instance.

ProxyConnection Objects​

class ProxyConnection(EfspConnection)

The main class you use to communicate with the E-file proxy server from docassemble.

Many methods are unchanged from the parent class, EfspConnection, and are documented there.

__init__​

def __init__(*,
             url: str = None,
             api_key: str = None,
             credentials_code_block: str = "tyler_login",
             default_jurisdiction: str = None)

Creates the connection. Tries to get params from docassemble's config, but can be overriden with parameters to init.

authenticate_user​

def authenticate_user(tyler_email: str = None,
                      tyler_password: str = None,
                      jeffnet_key: str = None,
                      *,
                      jurisdiction: str = None) -> ApiResponse

Params: tyler_email (str) tyler_password (str) jeffnet_key (str)

register_user​

def register_user(person: Union[Individual, dict],
                  registration_type: str,
                  *,
                  password: str = None,
                  firm_name_or_id: str = None) -> ApiResponse

registration_type needs to be INDIVIDUAL, FIRM_ADMINISTRATOR, or FIRM_ADMIN_NEW_MEMBER. If registration_type is INDIVIDUAL or FIRM_ADMINISTRATOR, you need a password. If it's FIRM_ADMINISTRATOR or FIRM_ADMIN_NEW_MEMBER, you need a firm_name_or_id

get_service_types​

def get_service_types(
        court_id: str,
        court_bundle: Union[ALDocumentBundle, dict] = None) -> ApiResponse

Checks the court info: if it has conditional service types, call a special API with all filing info so far to get service types

serialize_person​

def serialize_person(person: Union[Person, Individual]) -> Dict

Converts a Docassemble Person or Individual into a dictionary suitable for json.dumps and in format expected by Tyler-specific endpoints on the EFSPProxy