AddRecipientsCse module

class q2_sdk.hq.hq_api.backoffice.AddRecipientsCse.ParamsObj(logger, hq_credentials, recipients=None)[source]

Bases: BackOfficeAuthenticatedParamsObj

Parameters definition for AddRecipientsCse

See also

AddRecipientsCse_models for DataSet schemas and builder functions.

Parameters:

  • logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)

  • recipients (Optional[DataSetBuilder]) – DataSetBuilder instance

  • hq_credentials (BackOfficeHqCredentials) – Defaults to settings.HQ_CREDENTIALS

async q2_sdk.hq.hq_api.backoffice.AddRecipientsCse.execute(params_obj, use_json=True, **kwargs)[source]

This is the default way to submit the request to HQ.

This endpoint uses DataSet parameters and defaults to the JSON (.ashx) transport. SOAP (.asmx) is not supported for DataSet serialization.

Parameters:

  • params_obj (ParamsObj) – Object containing everything necessary to call this HQ endpoint

  • use_json – If True, will call HQ’s .ashx (json) endpoint instead of .asmx (soap)

Return type:

BackOfficeResponse

q2_sdk.hq.hq_api.backoffice.AddRecipientsCse.build_json(params_obj)[source]