BaseRequest

class q2_sdk.hq.models.hq_request.base.BaseRequest(name, use_json=False, **kwargs)

Bases: object

All HQ Communication will go through this class

It supports both SOAP and REST communication styles, though ultimately an end user would just call the .execute method and the response is turned into an object

async get_json(params_obj, **kwargs)

Call HQ using a json structure

Return type:

HqResponse

async get_soap(params_obj, **kwargs)

Call HQ using a soap structure

Return type:

HqResponse

async execute(params_obj, **kwargs)

Parameters:

• params_obj (BaseParamsObj) – Object containing everything necessary to call this HQ endpoint

• kwargs – Optional keyword args as defined for q2_requests.post() e.g. “timeout”

Return type:

HqResponse