Queries

BaseQuery

class q2_cores.Symitar.queries.base_query.SymitarBaseQuery(logger, customer_id, unit_number, device_type, card_prefix, repgen_name, procedure, data_attrs=None, guid=None, mock_response_string=None, data_file_name='', rg_params=None, purge_account_cache=False, mock_failure=False, use_symxchange=False)

Bases: BaseQuery

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id (str) – Symitar account number

• unit_number (str) – SymConnect UnitNumber

• device_type (str) – SymConnect DeviceType

• card_prefix (str) – SymConnect CardPrefix

• repgen_name (str) – Regpen/PowerOn name

• procedure (str) – RGSTATE

• data_attrs (dict) – Key/Value pairs for letter file

• guid (Optional[str]) – Unique indentifer for SymConnect message

• mock_response_string (str) – The response to emulate what Symitar would respond with

• data_file_name (str) – Name of the letter file that will be created if using data_attrs

• rg_params (dict) – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache (bool) – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

q2_cores.Symitar.queries.base_query.build_mock_response(response)

A helper method for constructing a valid SymConnect response from a string.

>>> build_mock_response("<data><first_name>John</first_name></data>")
'RSRG~12345~K0~JRGLINE=<data><first_name>John</first_name></data>~JRGDATATYPE=9'

Parameters:

response (str) – A string that you want to convert to a SymConnect response

Return type:

str

Returns:

A valid SymConnect response

AccountDemographicQuery

class q2_cores.Symitar.queries.account_demographic_query.AccountDemographicQuery(logger, customer_id, unit_number, device_type, card_prefix, repgenname=None, procedure=None, rg_params=None, guid=None, use_symxchange=False)

Bases: SymitarBaseQuery

Returns all available shares that can be opened

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

class q2_cores.Symitar.queries.account_demographic_query.AccountDemographicUpdateQuery(logger, customer_id, unit_number, device_type, card_prefix, repgenname, procedure, data_file_name, rg_params, guid=None, use_symxchange=False)

Bases: SymitarBaseQuery

Returns rates and other details from core based on the selected funding amount

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

AssessFeeQuery

class q2_cores.Symitar.queries.assess_fee_query.AssessFeeQuery(logger, customer_id, unit_number, device_type, card_prefix, repgen, startstate, loan_id, share_charged, fee, gl_code, guid=None, comment='SKIP A PAY FEE', use_symxchange=False)

Bases: SymitarBaseQuery

Assesses a fee for skip a pay using the Q2.SKIP.PAY repgen

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

DemographicInfoQuery

class q2_cores.Symitar.queries.demographic_info_query.DemographicInfoQuery(logger, customer_id, unit_number, device_type, card_prefix, guid=None, use_symxchange=False, set_member_number_as_demo_cif=False, strip_zeroes_from_cif=False)

Bases: SymitarBaseQuery

Returns demographic info for a Symitar Entity

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid (Optional[str]) – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

GetCardsQuery

class q2_cores.Symitar.queries.get_cards_query.GetCardsQuery(logger, customer_id, unit_number, device_type, card_prefix, guid=None, use_symxchange=False)

Bases: SymitarBaseQuery

Returns all card types for Symitar using the Q2.CARDMANAGEMENT.GEN repgen

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

GetAllCardsQuery

class q2_cores.Symitar.queries.get_all_cards_query.GetAllCardsQuery(logger, customer_id, unit_number, device_type, card_prefix, guid=None, use_symxchange=False)

Bases: SymitarBaseQuery

Returns all card types for Symitar using the Q2 repgen

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

GetLoansQuery

class q2_cores.Symitar.queries.get_loans_query.GetLoansQuery(logger, customer_id, unit_number, device_type, card_prefix, repgen, startstate, guid=None, use_symxchange=False)

Bases: SymitarBaseQuery

Returns eligible loans for Symitar skip a pay using the Q2.SKIP.PAY repgen

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

GetSharesQuery

class q2_cores.Symitar.queries.get_shares_query.GetSharesQuery(logger, customer_id, unit_number, device_type, card_prefix, guid=None, use_symxchange=False)

Bases: SymitarBaseQuery

Returns valid shares for Symitar skip a pay using the Q2.SKIP.PAY repgen

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

LoanPaymentQuery

class q2_cores.Symitar.queries.loan_payment_query.SymitarPrincipalPaymentQuery(logger, from_account, to_account, unit_number, device_type, card_prefix, transaction_amount, memo=None, remit_tran_code=None, use_symxchange=False)

Bases: BaseRestrictedQuery

build(guid=None)

We’ll build the symitar transaction request string here

Return type:

str

MockResponses

q2_cores.Symitar.queries.mock_responses.mock_demo_info_response()

q2_cores.Symitar.queries.mock_responses.mock_get_eligible_skip_loans_response()

q2_cores.Symitar.queries.mock_responses.mock_skip_loan_response()

q2_cores.Symitar.queries.mock_responses.mock_get_shares_response()

q2_cores.Symitar.queries.mock_responses.mock_get_shares_response_no_shares()

q2_cores.Symitar.queries.mock_responses.mock_assess_fee_response()

“Assess fee has no data in its response

q2_cores.Symitar.queries.mock_responses.mock_get_cards_response()

q2_cores.Symitar.queries.mock_responses.mock_get_all_cards_response()

q2_cores.Symitar.queries.mock_responses.mock_get_sub_accounts_response()

q2_cores.Symitar.queries.mock_responses.mock_get_sub_accounts_empty_response()

q2_cores.Symitar.queries.mock_responses.mock_get_sub_accounts_details_response()

q2_cores.Symitar.queries.mock_responses.mock_open_sub_accounts_response()

q2_cores.Symitar.queries.mock_responses.mock_estatement_enrollment_info_response()

q2_cores.Symitar.queries.mock_responses.mock_estatement_enrollment_info_memo_mode_response()

q2_cores.Symitar.queries.mock_responses.mock_estatement_enrollment_update_response()

q2_cores.Symitar.queries.mock_responses.mock_estatement_enrollment_update_bad_response()

q2_cores.Symitar.queries.mock_responses.mock_invalid_spec_file_error()

q2_cores.Symitar.queries.mock_responses.mock_account_demographic_response()

q2_cores.Symitar.queries.mock_responses.mock_account_demographic_update_response()

q2_cores.Symitar.queries.mock_responses.mock_closed_account_demographic_response()

q2_cores.Symitar.queries.mock_responses.mock_account_demographic_update_error_response()

q2_cores.Symitar.queries.mock_responses.mock_account_demographic_empty_response()

q2_cores.Symitar.queries.mock_responses.mock_symxchange_get_all_cards_response()

q2_cores.Symitar.queries.mock_responses.mock_symxchange_demographic_response()

q2_cores.Symitar.queries.mock_responses.mock_symxchange_error_response()

q2_cores.Symitar.queries.mock_responses.mock_symxchange_warning_response()

OpenAccountQuery

class q2_cores.Symitar.queries.open_account_query.GetSubAccountListQuery(logger, customer_id, unit_number, device_type, card_prefix, guid=None, use_symxchange=False)

Bases: SymitarBaseQuery

Returns all available shares that can be opened

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

class q2_cores.Symitar.queries.open_account_query.GetSubAccountDetailsQuery(logger, customer_id, unit_number, device_type, card_prefix, rg_params, guid=None, use_symxchange=False)

Bases: SymitarBaseQuery

Returns rates and other details from core based on the selected funding amount

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

class q2_cores.Symitar.queries.open_account_query.OpenAccountQuery(logger, customer_id, unit_number, device_type, card_prefix, data_file_name, rg_params, guid=None)

Bases: SymitarBaseQuery

Opens new share on core

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

SkipLoanQuery

class q2_cores.Symitar.queries.skip_loan.SkipLoanQuery(logger, customer_id, unit_number, device_type, card_prefix, repgen, procedure, loan_id, share_charged, fee, loan_note=None, guid=None, use_symxchange=False)

Bases: SymitarBaseQuery

Initiates skip a pay using the Q2.SKIP.PAY repgen

Symitar query object for building Poweron based SymConnect messages.

Parameters:

• logger (Logger) – Logger

• customer_id – Symitar account number

• unit_number – SymConnect UnitNumber

• device_type – SymConnect DeviceType

• card_prefix – SymConnect CardPrefix

• repgen_name – Regpen/PowerOn name

• procedure – RGSTATE

• data_attrs – Key/Value pairs for letter file

• guid – Unique indentifer for SymConnect message

• mock_response_string – The response to emulate what Symitar would respond with

• data_file_name – Name of the letter file that will be created if using data_attrs

• rg_params – JRGUSERCHR1 through JRGUSERCHR5 parameters

• purge_account_cache – Will tell the adapter to dump it’s cache for this account

• mock_failure – Simulate a Core failure

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.

get_loan_note()