Skip to content

ProjectInviteResource

API Access class for project invites

Source code in src/specklepy/api/resources/current/project_invite_resource.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
def __init__(
    self,
    account: Account,
    basepath: str,
    client: Client,
    server_version: Optional[Tuple[Any, ...]],
) -> None:
    super().__init__(
        account=account,
        basepath=basepath,
        client=client,
        server_version=server_version,
    )

create 

create(
    project_id: str, input: ProjectInviteCreateInput
) -> ProjectWithTeam
Source code in src/specklepy/api/resources/current/project_invite_resource.py 
32
33
34
35
36
def create(
    self, project_id: str, input: ProjectInviteCreateInput
) -> ProjectWithTeam:
    metrics.track(metrics.SDK, self.account, {"name": "Project Invite Create"})
    return super().create(project_id, input)

use 

use(input: ProjectInviteUseInput) -> bool
Source code in src/specklepy/api/resources/current/project_invite_resource.py 
38
39
40
def use(self, input: ProjectInviteUseInput) -> bool:
    metrics.track(metrics.SDK, self.account, {"name": "Project Invite Use"})
    return super().use(input)

get 

get(
    project_id: str, token: Optional[str]
) -> Optional[PendingStreamCollaborator]
Source code in src/specklepy/api/resources/current/project_invite_resource.py 
42
43
44
45
46
def get(
    self, project_id: str, token: Optional[str]
) -> Optional[PendingStreamCollaborator]:
    metrics.track(metrics.SDK, self.account, {"name": "Project Invite Get"})
    return super().get(project_id, token)

cancel 

cancel(project_id: str, invite_id: str) -> ProjectWithTeam
Source code in src/specklepy/api/resources/current/project_invite_resource.py 
48
49
50
51
52
53
54
def cancel(
    self,
    project_id: str,
    invite_id: str,
) -> ProjectWithTeam:
    metrics.track(metrics.SDK, self.account, {"name": "Project Invite Cancel"})
    return super().cancel(project_id, invite_id)