GetCustomerLocateWhere module

class q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.Operand

Bases: object

NE = 'NE'

EQ = 'EQ'

GE = 'GE'

LE = 'LE'

GT = 'GT'

LT = 'LT'

BeginsWith = 'BeginsWith'

EndsWith = 'EndsWith'

Contains = 'Contains'

IsNull = 'IsNull'

NotNull = 'NotNull'

IN = 'IN'

class q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.FilterItem(is_or_operator_not_and, operand, parens_before, parens_after, field_name=None, comparison_value=None, not_before_paren=False)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.Filter(filter_item=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.SortItem(ascending_sort, field_name=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.Sort(sort_item=None)

Bases: BaseParameter

serialize_as_xml()

serialize_as_json()

class q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.ParamsObj(logger, page_number, page_size, filter=None, sort=None, hq_credentials=None)

Bases: Q2ApiParamsObj

Parameters definition for GetCustomerLocateWhere

Parameters:

• logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)

• page_number (int) – The starting point of the page

• page_size (int) – The number of results to return per page

• filter (Optional[Filter]) – OptionalFilter object that contains a list of FilterItem objects

• sort (Optional[Sort]) – OptionalSort object that contains a list of SortItem objects

• hq_credentials (Optional[HqCredentials]) – Defaults to settings.HQ_CREDENTIALS

async q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.execute(params_obj, use_json=False, **kwargs)

This is the default way to submit the request to HQ. In theory, both json and soap payloads are equally accepted by HQ, though several variables may affect that (HQ version, Q2SDK implementation bugs, etc). This should not affect anything about the way your code deals with the data. In fact, the only difference to consuming extensions is the logging. Basically, call this with default parameters unless you find a compelling reason not to.

Parameters:

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

• use_json – If True, will call HQ’s .ashx (json) endpoint instead of .asmx (soap)

Return type:

HqResponse

async q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.get_soap(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

async q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.get_json(params_obj, **kwargs)

Deprecated. Please use execute instead

Return type:

HqResponse

q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.build_json(params_obj)

q2_sdk.hq.hq_api.q2_api.GetCustomerLocateWhere.build_soap(params_obj)