# This is an autogenerated file from the command "q2 generate_hq_api" and will be overwritten if run again
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.q2_api import Q2ApiParamsObj
from q2_sdk.hq.models.hq_request.q2_api import Q2ApiRequest
[docs]
class WireRate(BaseParameter):
def __init__(
self,
usd_amount: float,
rate: float,
base_rate: float,
value_date: str,
expires_at: str,
currency_code: str,
fx_amount: float,
top_tier: bool,
rate_applied_to_usd_equivalent: bool,
quote_id: Optional[str] = None,
booking_id: Optional[str] = None,
reverse_booking_id: Optional[str] = None,
):
self.quote_id = quote_id
self.booking_id = booking_id
self.reverse_booking_id = reverse_booking_id
self.usd_amount = usd_amount
self.rate = rate
self.base_rate = base_rate
self.value_date = value_date
self.expires_at = expires_at
self.currency_code = currency_code
self.fx_amount = fx_amount
self.top_tier = top_tier
self.rate_applied_to_usd_equivalent = rate_applied_to_usd_equivalent
[docs]
def serialize_as_xml(self):
root = etree.Element("WireRate")
elem = etree.SubElement(root, "QuoteId")
elem.text = str(self.quote_id)
elem = etree.SubElement(root, "BookingId")
elem.text = str(self.booking_id)
elem = etree.SubElement(root, "ReverseBookingId")
elem.text = str(self.reverse_booking_id)
elem = etree.SubElement(root, "UsdAmount")
elem.text = str(self.usd_amount)
elem = etree.SubElement(root, "Rate")
elem.text = str(self.rate)
elem = etree.SubElement(root, "BaseRate")
elem.text = str(self.base_rate)
elem = etree.SubElement(root, "ValueDate")
elem.text = str(self.value_date)
elem = etree.SubElement(root, "ExpiresAt")
elem.text = str(self.expires_at)
elem = etree.SubElement(root, "CurrencyCode")
elem.text = str(self.currency_code)
elem = etree.SubElement(root, "FxAmount")
elem.text = str(self.fx_amount)
elem = etree.SubElement(root, "TopTier")
elem.text = str(self.top_tier.real)
elem = etree.SubElement(root, "RateAppliedToUsdEquivalent")
elem.text = str(self.rate_applied_to_usd_equivalent.real)
return root
[docs]
def serialize_as_json(self):
return {
"QuoteId": self.quote_id,
"BookingId": self.booking_id,
"ReverseBookingId": self.reverse_booking_id,
"UsdAmount": self.usd_amount,
"Rate": self.rate,
"BaseRate": self.base_rate,
"ValueDate": self.value_date,
"ExpiresAt": self.expires_at,
"CurrencyCode": self.currency_code,
"FxAmount": self.fx_amount,
"TopTier": self.top_tier,
"RateAppliedToUsdEquivalent": self.rate_applied_to_usd_equivalent,
}
[docs]
class wireRateQuoteRequests(BaseParameter):
def __init__(self, wire_rate: Optional[List[WireRate]] = None):
self.wire_rate = wire_rate
[docs]
def serialize_as_xml(self):
root = etree.Element("wireRateQuoteRequests")
if self.wire_rate is not None:
for elem in self.wire_rate:
root.append(elem.serialize_as_xml())
return root
[docs]
def serialize_as_json(self):
return [x.serialize_as_json() for x in self.wire_rate]
[docs]
class ParamsObj(Q2ApiParamsObj):
"""Parameters definition for RequestForeignExchangeQuote"""
def __init__(
self,
logger: Q2LoggerType,
end_user_logon_name: Optional[str] = None,
wire_rate_quote_requests: Optional[wireRateQuoteRequests] = None,
hq_credentials: Optional[HqCredentials] = None,
):
"""
:param logger: Reference to calling request's logger (self.logger in your extension)
:param end_user_logon_name: Q2_UserLogon.LoginName
:param wire_rate_quote_requests:
:param hq_credentials: Defaults to settings.HQ_CREDENTIALS
"""
super().__init__(logger, hq_credentials)
self.request_params.update({
"EndUserLogonName": end_user_logon_name,
"wireRateQuoteRequests": wire_rate_quote_requests,
})
[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 = Q2ApiRequest("RequestForeignExchangeQuote", 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(
"RequestForeignExchangeQuote.get_soap is deprecated. Please use RequestForeignExchangeQuote.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(
"RequestForeignExchangeQuote.get_json is deprecated. Please use RequestForeignExchangeQuote.execute instead."
)
return await execute(params_obj, use_json=True, **kwargs)
[docs]
def build_json(params_obj: ParamsObj):
return Q2ApiRequest.build_json(params_obj)
[docs]
def build_soap(params_obj: ParamsObj):
return Q2ApiRequest("RequestForeignExchangeQuote", use_json=False).build_soap(
params_obj
)