Queries

DemographicInfoQuery

class q2_cores.OSI.queries.demographic_info_query.DemographicInfoQuery(logger, access_number, pin, use_code, max_rows=100)

Bases: BaseQuery

Returns addresses, First/Last Name, Phones, etc for an OSI Entity

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

build()

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.

MockResponses

q2_cores.OSI.queries.mock_responses.mock_demographic_response_no_phone()

q2_cores.OSI.queries.mock_responses.mock_demographic_response_no_address()

q2_cores.OSI.queries.mock_responses.get_base_demo_response()

q2_cores.OSI.queries.mock_responses.mock_demographic_response()

q2_cores.OSI.queries.mock_responses.decorate_response(response, itc_code)

q2_cores.OSI.queries.mock_responses.mock_demographic_response_with_namespace()

q2_cores.OSI.queries.mock_responses.mock_demographic_response_with_error()

q2_cores.OSI.queries.mock_responses.mock_unexpected_demographic_response()

q2_cores.OSI.queries.mock_responses.mock_demographic_unknown_types()

q2_cores.OSI.queries.mock_responses.mock_email_core_response()

q2_cores.OSI.queries.mock_responses.mock_update_email_response()

q2_cores.OSI.queries.mock_responses.mock_fail_update_email()

UpdateAddressQuery

class q2_cores.OSI.queries.update_address_query.UpdateAddressQuery(logger, access_number, pin, use_code, city, state, zipcode, address_1, address_2, address_3='', address_type='PRI', country='USA')

Bases: BaseQuery

Updates address for an OSI Entity

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

build()

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.

UpdatePhoneQuery

class q2_cores.OSI.queries.update_phone_query.UpdatePhoneQuery(logger, access_number, pin, use_code, phone, country='USA', phone_type='PER')

Bases: BaseQuery

Updates Phone info for an OSI Entity

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

build()

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.

GetEmailsQuery

class q2_cores.OSI.queries.get_emails_query.GetEmailsQuery(logger, access_number, pin, use_code, max_rows=100)

Bases: BaseQuery

Returns addresses, First/Last Name, Phones, etc for an OSI Entity

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

build()

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.

UpdateEmailQuery

class q2_cores.OSI.queries.update_email_query.UpdateEmailQuery(logger, access_number, pin, use_code, email, email_type)

Bases: BaseQuery

Updates Phone info for an OSI Entity

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

build()

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.