JXchange

Core

class q2_cores.JXchange.core.Core(logger, core_user, hq_credentials=None, **kwargs)[source]

Bases: BaseCore

All cores will inherit from this common base class. This contains a self.configured_user property, which is an instance of q2_sdk.models.cores.models.core_user.CoreUser.

CONFIG_FILE_NAME = 'JXchange_Core'

OPTIONAL_CONFIGURATIONS = {'CHANGE_ELEMENT_TO_MsgRqHdr': False}

async build_demographic_info()[source]

Returns a DemographicInfoMapper ready to execute

Return type:: DemographicInfoMapper

async build_update_demographic_info(demographic_info)[source]

Returns a UpdateDemographicInfoMapper ready to execute

Return type:: UpdateDemographicInfoMapper

async build_address_search(cust_id=None, acct_id=None, acct_type=None, addr_cat_use=None, addr_cat_2_use=None)[source]

Search for address records associated with a customer or account.

Provide cust_id for CIF-level searches, or acct_id + acct_type for account-level searches. Optional addr_cat_use and addr_cat_2_use filter by address category.

Return type:: AddressSearchMapper

async build_account_inquiry(acct_id, acct_type, xtend_elems=None)[source]

Retrieve account details including address information from xtend elements. Address fields for deposit accounts are under x_DepInfoRec.Addr; pass a custom xtend_elems list to adjust the payload.

Return type:: AccountInquiryMapper

async build_address_modify(addr_key, new_address=None, delete_address=False)[source]

Modify or delete an existing address record. addr_key is always required. Pass new_address (dict with address_1, city, state, zip_code, and optional address_2) to update, or set delete_address=True to remove the record.

Return type:: AddressModifyMapper

async build_address_add(new_address, addr_cat_use, cust_id=None, acct_id=None, acct_type=None, addr_cat_2_use=None)[source]

Add a new alternate address record. Provide cust_id for CIF-level addresses or acct_id + acct_type for account-level. addr_cat_use is required (e.g. 'Cust', 'Acct', 'Seasonal'). The mapper returns the new AddrKey.

Return type:: AddressAddMapper