Users & Groups
- class koordinates.users.UserManager(client)
Bases:
Manager
- expand(*args, **kwargs)
Returns an expanded Query view of the model objects. Equivalent to calling
.list().expand()
. Using expansions may have significant performance implications for some API requests. Seekoordinates.base.Query.expand()
.
- filter(*args, **kwargs)
Returns a filtered Query view of the model objects. Equivalent to calling
.list().filter(...)
. Seekoordinates.base.Query.filter()
.
- get(id, expand=[])
Fetches a Model instance determined by the value of id.
- Parameters:
id – numeric ID for the Model.
- list()
Fetches a set of model objects
- Return type:
koordinates.base.Query
- order_by(*args, **kwargs)
Returns an ordered Query view of the model objects. Equivalent to calling
.list().order_by(...)
. Seekoordinates.base.Query.order_by()
.
- class koordinates.users.User(**kwargs)
Bases:
Model
Represents a Koordinates User
- refresh()
Refresh this model from the server.
Updates attributes with the server-defined values. This is useful where the Model instance came from a partial response (eg. a list query) and additional details are required.
Existing attribute values will be overwritten.
- class koordinates.users.GroupManager(client)
Bases:
Manager
- expand(*args, **kwargs)
Returns an expanded Query view of the model objects. Equivalent to calling
.list().expand()
. Using expansions may have significant performance implications for some API requests. Seekoordinates.base.Query.expand()
.
- filter(*args, **kwargs)
Returns a filtered Query view of the model objects. Equivalent to calling
.list().filter(...)
. Seekoordinates.base.Query.filter()
.
- get(id, expand=[])
Fetches a Model instance determined by the value of id.
- Parameters:
id – numeric ID for the Model.
- list()
Fetches a set of model objects
- Return type:
koordinates.base.Query
- order_by(*args, **kwargs)
Returns an ordered Query view of the model objects. Equivalent to calling
.list().order_by(...)
. Seekoordinates.base.Query.order_by()
.
- class koordinates.users.Group(**kwargs)
Bases:
Model
Represents a Koordinates Group
- refresh()
Refresh this model from the server.
Updates attributes with the server-defined values. This is useful where the Model instance came from a partial response (eg. a list query) and additional details are required.
Existing attribute values will be overwritten.