EFSPIntegration.py_efsp_client
The base python client used to communicate with the E-file proxy server.
Doesn't include anything from docassemble, and can be used without having it installed.
EfspConnection Objectsβ
class EfspConnection()
A python client that communicates with the E-file proxy server.
__init__β
def __init__(*, url: str, api_key: str, default_jurisdiction: str = None)
Arguments:
url (str) api_key (str) default_jurisdiction (str)
authenticate_userβ
def authenticate_user(*,
tyler_email: Optional[str] = None,
tyler_password: Optional[str] = None,
jeffnet_key: Optional[str] = None,
jurisdiction: str = None) -> ApiResponse
Authenticates the user with the EFM server (not the E-file proxy).
register_userβ
def register_user(person: 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_password_rulesβ
def get_password_rules() -> ApiResponse
Password rules are stored in the global court, id 0.
TODO: They're in other courts too, including 1. Could they ever be different?
get_notification_optionsβ
def get_notification_options() -> ApiResponse
AKA NotificationPreferencesList
get_firmβ
def get_firm() -> ApiResponse
Gets info about the "firm" for an associated user. If a user is a pro-se, this contains their address information.
update_firmβ
def update_firm(firm: dict) -> ApiResponse
firm should have the below keys:
- firstName, middleName, lastName if it's a person
- firmName if it's a business
- address (a dict), with keys addressLine1 addressLine2, city, state, zipCode, country
- phoneNumber
get_courtsβ
def get_courts(fileable_only: bool = False,
with_names: bool = False) -> ApiResponse
Gets the list of courts.
get_courtβ
def get_court(court_id: str) -> ApiResponse
Gets codes for a specific court
get_court_listβ
def get_court_list() -> ApiResponse
Gets a list of all of the courts that you can file into. Slightly more limited than get_courts
get_filing_listβ
def get_filing_list(court_id: str,
user_id: str = None,
start_date: datetime = None,
before_date: datetime = None) -> ApiResponse
Returns a list of filings that a particular user has made with a court.
get_service_typesβ
def get_service_types(court_id: str, all_vars: 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
get_cases_rawβ
def get_cases_raw(court_id: str,
*,
person_name: dict = None,
business_name: str = None,
docket_number: str = None) -> ApiResponse
Finds existing cases at a particular court. Only one of person_name, business_name, or docket_number should be provided at a time. Params: court_id (str) person_name (dict) buisness_name (str) docket_number (str)