# This is an autogenerated file from the command "q2 generate_hq_api" and will be overwritten if run again
"""
Add stop payment for a range of check numbers
"""
from typing import List, Optional
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.wedge_online_banking import WedgeOnlineBankingParamsObj
from q2_sdk.hq.models.hq_request.wedge_online_banking import WedgeOnlineBankingRequest
[docs]
class ParamsObj(WedgeOnlineBankingParamsObj):
"""Parameters definition for AddStopPaymentRange"""
def __init__(
self,
logger: Q2LoggerType,
hq_credentials: HqCredentials,
process_date: str,
originating_account_id: int,
description: str,
start_check_number: str,
end_check_number: str,
start_date: str,
end_date: str,
):
"""
: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 process_date: ex. 1980-10-23. Some HQ endpoints require a timestamp as well (1980-10-23T00:00:00)
:param originating_account_id: Q2_HostAccount.HostAccountID
:param description: Free form text
:param start_check_number:
:param end_check_number:
:param start_date: ex. 1980-10-23. Some HQ endpoints require a timestamp as well (1980-10-23T00:00:00)
:param end_date: ex. 1980-10-23. Some HQ endpoints require a timestamp as well (1980-10-23T00:00:00)
"""
super().__init__(logger, hq_credentials)
self.request_params.update({
"ProcessDate": process_date,
"OriginatingAccountId": originating_account_id,
"Description": description,
"StartCheckNumber": start_check_number,
"EndCheckNumber": end_check_number,
"StartDate": start_date,
"EndDate": end_date,
})
[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(
"AddStopPaymentRange", 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(
"AddStopPaymentRange.get_soap is deprecated. Please use AddStopPaymentRange.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(
"AddStopPaymentRange.get_json is deprecated. Please use AddStopPaymentRange.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("AddStopPaymentRange", use_json=False).build_soap(
params_obj
)