isogeo_pysdk.api.routes_invitation module

Isogeo API v1 - API Routes for Invitations entities

See: http://help.isogeo.com/api/complete/index.html

class isogeo_pysdk.api.routes_invitation.ApiInvitation(api_client=None)[source]

Bases: object

Routes as methods of Isogeo API used to manipulate invitations.

accept(invitation: object = <class 'isogeo_pysdk.models.invitation.Invitation'>) → isogeo_pysdk.models.invitation.Invitation[source]

Accept the invitation to join an Isogeo Workgroup.

Parameters:invitation (class) – Invitation model object to accept
create(workgroup_id: str, invitation: object = {'_created': None, '_id': None, '_modified': None, 'email': None, 'expiresIn': None, 'group': None, 'role': None}) → isogeo_pysdk.models.invitation.Invitation[source]

Add a new invitation to Isogeo.

Parameters:invitation (class) – Invitation model object to create
Return type:Invitation
Example:
>>> # create the invitation locally
>>> invit = Invitation(
    email="prenom.nom@organisation.com",
    role="admin"
    )
>>> # send the invitation
>>> isogeo.invitation.create(WORKGROUP_UUID, new_invit)
decline(invitation: object = <class 'isogeo_pysdk.models.invitation.Invitation'>) → isogeo_pysdk.models.invitation.Invitation[source]

Decline the invitation to join an Isogeo Workgroup.

Parameters:invitation (class) – Invitation model object to decline
delete(invitation_id: str)[source]

Delete an invitation from Isogeo database.

Parameters:invitation_id (str) – identifier of the invitation
get(invitation_id: str) → isogeo_pysdk.models.invitation.Invitation[source]

Get details about a specific invitation.

Parameters:invitation_id (str) – invitation UUID
listing(workgroup_id: str) → list[source]

Returns pending invitations (including expired) for the specified workgroup.

Parameters:workgroup_id (str) – workgroup UUID
update(invitation: isogeo_pysdk.models.invitation.Invitation) → isogeo_pysdk.models.invitation.Invitation[source]

Update a invitation owned by a invitation.

Parameters:invitation (class) – Invitation model object to update