AddCustomerCse module

class q2_sdk.hq.hq_api.backoffice.AddCustomerCse.ParamsObj(logger, hq_credentials, dal_customer_edit=None, customer_rights=None)[source]

Bases: BackOfficeAuthenticatedParamsObj

Parameters definition for AddCustomerCse

See also

AddCustomerCse_models for DataSet schemas and builder functions.

Parameters:

logger (TypeAliasType) – Reference to calling request’s logger (self.logger in your extension)
dal_customer_edit (Optional[DataSetBuilder]) – DataSetBuilder instance
customer_rights (Optional[DataSetBuilder]) – DataSetBuilder instance
hq_credentials (BackOfficeHqCredentials) – Defaults to settings.HQ_CREDENTIALS

async q2_sdk.hq.hq_api.backoffice.AddCustomerCse.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.AddCustomerCse.build_json(params_obj)[source]

async q2_sdk.hq.hq_api.backoffice.AddCustomerCse.fetch_current(logger, hq_credentials, id, refresh_accounts)[source]

Fetch current state from GetCustomerByIDWithRefreshAccounts for optimistic concurrency.

Calls the GET operation and parses the response into typed model instances with original_record pre-populated. Modify the returned instances and pass them to the corresponding build_*_dataset() function.

Workflow:

# 1. Fetch current state (pre-populates original_record on each instance)
current = await AddCustomerCse.fetch_current(logger, hq_creds, ...)

# 2. Modify the returned dataclass instances
instance = current["ModelClassName"][0]
instance.some_field = new_value

# 3. Build dataset and execute (original_record produces the Unchanged row)
dataset = build_*_dataset(instance)
params = AddCustomerCse.ParamsObj(logger, hq_creds, param=dataset)
await AddCustomerCse.execute(params)