Data API — Locations

10 min

location_create

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

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

body — Properties used to create a new location

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

location_delete

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

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
include_children	bool \| Unset	UNSET

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.

location_describe

sync(id: UUID, client: AuthenticatedClient | Client, include_children: bool | Unset = UNSET) -> LocationDetailsResponse | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
include_children	bool \| Unset	UNSET

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

location_list

sync(client: AuthenticatedClient | Client, include_children: bool | Unset = UNSET, location_types: list[LocationTypeEnum] | Unset = UNSET, is_top_level_location: bool | Unset = UNSET, parent_location_id: UUID | Unset = UNSET, name: str | Unset = UNSET, description: str | Unset = UNSET, thumbnail_ref: str | Unset = UNSET, image_ref: str | Unset = UNSET, sort: list[LocationSort] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[LocationDetailsResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
include_children	bool \| Unset	UNSET
location_types	list[LocationTypeEnum] \| Unset	UNSET
is_top_level_location	bool \| Unset	UNSET
parent_location_id	UUID \| Unset	UNSET
name	str \| Unset	UNSET
description	str \| Unset	UNSET
thumbnail_ref	str \| Unset	UNSET
image_ref	str \| Unset	UNSET
sort	list[LocationSort] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

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

location_update

sync(id: UUID, client: AuthenticatedClient | Client, body: UpdateLocationRequest | Unset = UNSET) -> LocationDetailsResponse | ProblemDetails | list[ErrorResponse] | None

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

body — Properties used to update a location

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