Data API — Settings

10 min

settings_list

sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[CustomerSettingResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[CustomerSettingResponse] | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

setting_delete

sync(type_: CustomerSettingType, scope: CustomerSettingScope, client: AuthenticatedClient | Client) -> ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Parameter	Type	Default
type_	CustomerSettingType	required
scope	CustomerSettingScope	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | UserRoleResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

setting_get

sync(type_: CustomerSettingType, scope: CustomerSettingScope, client: AuthenticatedClient | Client) -> CustomerSettingResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
type_	CustomerSettingType	required
scope	CustomerSettingScope	required
client	AuthenticatedClient \| Client	required

Returns: CustomerSettingResponse | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

setting_types_list

sync(client: AuthenticatedClient | Client, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[CustomerSettingTypeResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[CustomerSettingTypeResponse] | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

setting_update

sync(client: AuthenticatedClient | Client, body: list[CustomerSettingRequest] | Unset = UNSET) -> ProblemDetails | list[CustomerSettingResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	list[CustomerSettingRequest] \| Unset	UNSET

Returns: ProblemDetails | list[CustomerSettingResponse] | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.