Data API — Choices

10 min

choices_by_id

sync(id: UUID, client: AuthenticatedClient | Client) -> ChoicesResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ChoicesResponse | 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.

choices_delete

sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | 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.

choices_list

sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, types: list[CustomPropertyTypeEnum] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ChoicesResponse] | list[ErrorResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
name	str \| Unset	UNSET
types	list[CustomPropertyTypeEnum] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ChoicesResponse] | 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.

choices_update

sync(id: UUID, client: AuthenticatedClient | Client, body: ChoicesUpdateRequest | Unset = UNSET) -> ChoicesResponse | ProblemDetails | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	ChoicesUpdateRequest \| Unset	UNSET

body — Set of information to create or update a set of choices

Returns: ChoicesResponse | ProblemDetails | 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.

post_v1_choices

sync(client: AuthenticatedClient | Client, body: ChoicesRequest | Unset = UNSET) -> ChoicesResponse | ProblemDetails | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	ChoicesRequest \| Unset	UNSET

body — Set of information to create or update a set of choices

Returns: ChoicesResponse | ProblemDetails | 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.