Queries

BaseQuery

enum q2_cores.CoreAPI.queries.base_query.LookupType(value)

Bases: Enum

Valid values are as follows:

SOCIAL_SECURITY_NUMBER = <LookupType.SOCIAL_SECURITY_NUMBER: 'taxid'>

MEMBER_NUMBER = <LookupType.MEMBER_NUMBER: 'MemberNumber'>

class q2_cores.CoreAPI.queries.base_query.CoreAPIBaseQuery(logger, request_type, req_data, cif=None, mock_failure=False)

Bases: BaseQuery

All CoreAPI queries inherit from this

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

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

• mock_failure – If server is running in debug mode, will be used while mocking the response

make_query(name, context=None)

Return type:

JinjaQuery

build()

Constructs and returns the core request from a template and provided parameters.

Return type:

str

mock_response()

When run in DEBUG mode, the SDK will intercept calls before they go to HQ’s AdapterPassThru endpoint.

In these cases, the response will be whatever is returned from this function.

AccountDetailsQuery

class q2_cores.CoreAPI.queries.account_details_query.AccountDetailsQuery(logger, account_number, cif=None)

Bases: CoreAPIBaseQuery

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

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

• mock_failure – If server is running in debug mode, will be used while mocking the response

AccountMaintenanceQuery

class q2_cores.CoreAPI.queries.account_maintenance_query.AccountMaintenanceQuery(logger, account_number, delivery_method, is_acct_maintenance, cif=None)

Bases: CoreAPIBaseQuery

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

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

• mock_failure – If server is running in debug mode, will be used while mocking the response

DemographicInfoQuery

class q2_cores.CoreAPI.queries.demographic_info_query.DemographicInfoQuery(logger, lookup_key, lookup_type, cif=None)

Bases: CoreAPIBaseQuery

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

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

• mock_failure – If server is running in debug mode, will be used while mocking the response

NAME_MAP = {LookupType.MEMBER_NUMBER: 'PersonDetailsInquiryWithMemberNumber', LookupType.SOCIAL_SECURITY_NUMBER: 'PersonDetailsInquiry'}

UpdateDemographicInfoQuery

class q2_cores.CoreAPI.queries.update_demographic_info_query.UpdateDemographicInfoQuery(logger, demographic_info)

Bases: CoreAPIBaseQuery

Object which builds the query to be send to the Core. If server is running debug mode, will return mocked response instead of calling the core.

Parameters:

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

• mock_failure – If server is running in debug mode, will be used while mocking the response

MockResponses

q2_cores.CoreAPI.queries.mock_responses.mock_demographic_response()

q2_cores.CoreAPI.queries.mock_responses.get_mock_demo_mapper_cif_from_user_fields_response()

q2_cores.CoreAPI.queries.mock_responses.mock_error_demographic_response()

q2_cores.CoreAPI.queries.mock_responses.mock_error_user_authentication_response()

q2_cores.CoreAPI.queries.mock_responses.mock_update_demographic_response()

q2_cores.CoreAPI.queries.mock_responses.mock_error_update_demographic_info_response()

q2_cores.CoreAPI.queries.mock_responses.mock_error_update_demographic_info_response_2()

q2_cores.CoreAPI.queries.mock_responses.mock_account_details_response()

q2_cores.CoreAPI.queries.mock_responses.mock_demographic_response_without_phone_and_email_nodes()