# This is an autogenerated file from the command "q2 generate_hq_api" and will be overwritten if run again
"""
Add a OnlineActivity-based alert
"""
from typing import List, Optional
from lxml import etree
from q2_sdk.core.q2_logging.logger import Q2LoggerType
from q2_sdk.hq.models.hq_response import HqResponse
from q2_sdk.hq.models.hq_credentials import HqCredentials
from q2_sdk.hq.models.hq_params.base import BaseParameter
from q2_sdk.hq.models.hq_params.wedge_online_banking import WedgeOnlineBankingParamsObj
from q2_sdk.hq.models.hq_request.wedge_online_banking import WedgeOnlineBankingRequest
[docs]
class TransactionType:
FundsTransfer = "FundsTransfer"
ChangeOfAddress = "ChangeOfAddress"
StopPayment = "StopPayment"
DomesticWire = "DomesticWire"
InternationalWire = "InternationalWire"
BillPayment = "BillPayment"
AchBatch = "AchBatch"
CheckReorder = "CheckReorder"
Eftps = "Eftps"
AchReceipt = "AchReceipt"
Payroll = "Payroll"
AchPayment = "AchPayment"
AchCollection = "AchCollection"
FundsVerification = "FundsVerification"
ExternalTransfer = "ExternalTransfer"
SendCheck = "SendCheck"
AchPassThru = "AchPassThru"
RtpRequestForPayment = "RtpRequestForPayment"
RtpCreditTransfer = "RtpCreditTransfer"
[docs]
class AlertOnlineActivityType:
Drafted = "Drafted"
Authorized = "Authorized"
Processed = "Processed"
Cancelled = "Cancelled"
Failed = "Failed"
[docs]
class Operand:
NE = "NE"
EQ = "EQ"
GE = "GE"
LE = "LE"
GT = "GT"
LT = "LT"
[docs]
class ParamsObj(WedgeOnlineBankingParamsObj):
"""Parameters definition for CreateAlertByOnlineActivity"""
def __init__(
self,
logger: Q2LoggerType,
hq_credentials: HqCredentials,
host_account_id: int,
transaction_type: TransactionType,
alert_online_activity_type: AlertOnlineActivityType,
operand: Operand,
description: Optional[str] = None,
):
"""
:param logger: Reference to calling request's logger (self.logger in your extension)
:param hq_credentials: HqCredentials instance with an hq_url and auth_token
:param host_account_id: Q2_HostAccount.HostAccountID
:param transaction_type:
:param alert_online_activity_type:
:param operand:
:param description: Free form text
"""
super().__init__(logger, hq_credentials)
self.request_params.update({
"Description": description,
"HostAccountId": host_account_id,
"TransactionType": transaction_type,
"AlertOnlineActivityType": alert_online_activity_type,
"Operand": operand,
})
[docs]
async def execute(params_obj: ParamsObj, use_json=False, **kwargs) -> HqResponse:
"""
This is the default way to submit the request to HQ.
In theory, both json and soap payloads are equally accepted by HQ, though
several variables may affect that (HQ version, Q2SDK implementation bugs, etc).
This should not affect anything about the way your code deals with the data. In fact,
the only difference to consuming extensions is the logging.
Basically, call this with default parameters unless you find a compelling
reason not to.
:param params_obj: Object containing everything necessary to call this HQ endpoint
:param use_json: If True, will call HQ's .ashx (json) endpoint instead of .asmx (soap)
"""
request = WedgeOnlineBankingRequest(
"CreateAlertByOnlineActivity", use_json=use_json, **kwargs
)
return await request.execute(params_obj, **kwargs)
[docs]
async def get_soap(params_obj: ParamsObj, **kwargs) -> HqResponse:
"""Deprecated. Please use execute instead"""
params_obj.logger.warning(
"CreateAlertByOnlineActivity.get_soap is deprecated. Please use CreateAlertByOnlineActivity.execute instead."
)
return await execute(params_obj, **kwargs)
[docs]
async def get_json(params_obj: ParamsObj, **kwargs) -> HqResponse:
"""Deprecated. Please use execute instead"""
params_obj.logger.warning(
"CreateAlertByOnlineActivity.get_json is deprecated. Please use CreateAlertByOnlineActivity.execute instead."
)
return await execute(params_obj, use_json=True, **kwargs)
[docs]
def build_json(params_obj: ParamsObj):
return WedgeOnlineBankingRequest.build_json(params_obj)
[docs]
def build_soap(params_obj: ParamsObj):
return WedgeOnlineBankingRequest(
"CreateAlertByOnlineActivity", use_json=False
).build_soap(params_obj)