everyaction.services.Locations

class everyaction.services.Locations(ea: EAClient)

Represents the Locations service.

Methods

create(**kwargs)	See POST /locations.
delete(location_id, /)	See DELETE /locations/{locationId}.
find_or_create(**kwargs)	See POST /locations/findOrCreate.
get(location_id, /)	See GET /locations/{locationId}.
list(*[, limit])	See GET /locations.

create(**kwargs: EAValue) → Location

See POST /locations.

Parameters

kwargs – The applicable query arguments and JSON data for the request. A Location is appropriate to unpack here.

Returns

The created Location object.

Keyword Arguments

• address

• displayName (display_name, display)

• locationId (location_id, id)

• name

delete(location_id: int, /) → None

See DELETE /locations/{locationId}.

Parameters

location_id – The locationId path parameter.

find_or_create(**kwargs: EAValue) → Location

See POST /locations/findOrCreate.

Parameters

kwargs – The applicable query arguments and JSON data for the request. A Location is appropriate to unpack here.

Returns

The resulting Location object.

Keyword Arguments

• address

• displayName (display_name, display)

• locationId (location_id, id)

• name

get(location_id: int, /) → Location

See GET /locations/{locationId}.

Parameters

location_id – The locationId path parameter.

Returns

The resulting Location object.

list(*, limit: Optional[int] = None, **kwargs: EAValue) → List[Location]

See GET /locations.

Parameters

• limit – Maximum number of records to get for this request.

• kwargs – The applicable query arguments and JSON data for the request.

Returns

List of the resulting Location objects.

Keyword Arguments

• name