Queries

DemographicInfoQuery

class q2_cores.FISIBSOpenAPI.queries.demographic_info_query.DemographicInfoQuery(logger, req_val, search_method=None, signature='')[source]

Bases: BaseQuery

Builds the payload for the demographic call to the FIS IBS OpenAPI core

Parameters:

req_dict – Request data
search_method (SearchMethod) – Method used to get demographic data
signature (str) – DigitalSignature for dynamic profile requests

build()[source]

Creates an OpenAPI query to get the customer’s demographic info

Return type:: str
Returns:: OpenAPI request query as a JSON string

Example query to search by SSN (prior to JSON string conversion):

{
  "Endpoint": "rest/IBSCI/v2/customers/search/taxnbr?CIKeySSN=_CIKeySSN",
  "HttpVerb": "GET",
  "Entity": null,
  "RequestGuid": "00000000-0000-0000-0000-000000000000",
  "ApplicationID": "CI",
  "UrlEncryptionParams": {
    "_CIKeySSN": "123456789"
  }
}

Example query to search by CIF (prior to JSON string conversion):

{
  "Endpoint": "rest/IBSCI/v2/customers/_CIApplNbr",
  "HttpVerb": "GET",
  "Entity": null,
  "RequestGuid": "00000000-0000-0000-0000-000000000000",
  "ApplicationID": "CI",
  "UrlEncryptionParams": {
    "_CIApplNbr": "123456789"
  }
}

Example query to search by AccountNumber and AccountType (prior to JSON string conversion):

{
  "Endpoint": "rest/IBSCI/v2/accounts/DP/_AppNbr/dynamic-profile",
  "HttpVerb": "GET",
  "Entity": null,
  "RequestGuid": "00000000-0000-0000-0000-000000000000",
  "ApplicationID": "CI",
  "UrlEncryptionParams": {
    "_AppNbr": "000112233"
  }
}

mock_response()[source]

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.

GetPhoneNumbersQuery

class q2_cores.FISIBSOpenAPI.queries.get_phone_numbers_query.GetPhoneNumbersQuery(logger, customer_number)[source]

Bases: BaseQuery

Builds the payload for the Get Phone Numbers call in the FIS IBS OpenAPI core

Parameters:: self.customer_number – corresponds to the user’s primary cif

build()[source]

Creates an OpenAPI query to get the customer’s phone numbers

Return type:: str
Returns:: OpenAPI request query as a JSON string

Example query (prior to JSON string conversion):

{
  "Endpoint": "rest/IBSCI/v2/customers/_CustNbr/phone-numbers",
  "HttpVerb": "GET",
  "Entity": null,
  "RequestGuid": "00000000-0000-0000-0000-000000000000",
  "ApplicationID": "CI",
  "UrlEncryptionParams": {
    "_CustNbr": "00000012975"
  }
}

mock_response()[source]

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.

GetEmailAddressesQuery

class q2_cores.FISIBSOpenAPI.queries.get_email_addresses_query.GetEmailAddressesQuery(logger, customer_number)[source]

Bases: BaseQuery

Builds the payload for the Get Email Addresses call in the FIS IBS OpenAPI core

Parameters:: customer_number – corresponds to the user’s primary cif

build()[source]

Creates an OpenAPI query to get the customer’s email addresses

Return type:: str
Returns:: OpenAPI request query as a JSON string

Example query (prior to JSON string conversion):

{
  "Endpoint": "rest/IBSCI/v2/customers/_CustNbr/email-addresses",
  "HttpVerb": "GET",
  "Entity": null,
  "RequestGuid": "00000000-0000-0000-0000-000000000000",
  "ApplicationID": "CI",
  "UrlEncryptionParams": {
    "_CustNbr": "00000012975"
  }
}

mock_response()[source]

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.FISIBSOpenAPI.queries.mock_responses.mock_demographic_info_response_tax_id()[source]

Return type:: dict

q2_cores.FISIBSOpenAPI.queries.mock_responses.mock_demographic_info_response_cif(failure=False)[source]

Return type:: dict

q2_cores.FISIBSOpenAPI.queries.mock_responses.mock_demographic_info_response_acc(failure=False, account_failure=False, use_default_err_msg=False)[source]

Return type:: dict

q2_cores.FISIBSOpenAPI.queries.mock_responses.mock_demographic_info_response_dynamic_profile(failure=False, missing_customer_emails=False, missing_emails=False)[source]

Return type:: dict

q2_cores.FISIBSOpenAPI.queries.mock_responses.mock_get_phone_numbers_response(failure=False)[source]

Return type:: dict

q2_cores.FISIBSOpenAPI.queries.mock_responses.mock_get_email_addresses_response()[source]

Return type:: dict