Skip to content

ActiveUserResource

API Access class for users. This class provides methods to get and update the user profile, fetch user activity, and manage pending stream invitations.

Source code in src/specklepy/api/resources/current/active_user_resource.py 
28
29
30
31
32
33
34
35
def __init__(self, account, basepath, client, server_version) -> None:
    super().__init__(
        account=account,
        basepath=basepath,
        client=client,
        server_version=server_version,
    )
    self.schema = User

schema instance-attribute 

schema = User

get 

get() -> Optional[User]
Source code in src/specklepy/api/resources/current/active_user_resource.py 
37
38
39
def get(self) -> Optional[User]:
    metrics.track(metrics.SDK, self.account, {"name": "Active User Get"})
    return super().get()

update 

update(input: UserUpdateInput) -> User
Source code in src/specklepy/api/resources/current/active_user_resource.py 
41
42
43
44
45
46
47
def update(
    self,
    input: UserUpdateInput,
) -> User:
    metrics.track(metrics.SDK, self.account, {"name": "Active User Update"})

    return super().update(input=input)

get_projects 

get_projects(
    *,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[UserProjectsFilter] = None,
) -> ResourceCollection[Project]
Source code in src/specklepy/api/resources/current/active_user_resource.py 
49
50
51
52
53
54
55
56
57
def get_projects(
    self,
    *,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[UserProjectsFilter] = None,
) -> ResourceCollection[Project]:
    metrics.track(metrics.SDK, self.account, {"name": "Active User Get Projects"})
    return super().get_projects(limit=limit, cursor=cursor, filter=filter)

get_projects_with_permissions 

get_projects_with_permissions(
    *,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[UserProjectsFilter] = None,
) -> ResourceCollection[ProjectWithPermissions]
Source code in src/specklepy/api/resources/current/active_user_resource.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def get_projects_with_permissions(
    self,
    *,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[UserProjectsFilter] = None,
) -> ResourceCollection[ProjectWithPermissions]:
    metrics.track(
        metrics.SDK,
        self.account,
        {"name": "Active User Get Projects With Permissions"},
    )
    return super().get_projects_with_permissions(
        limit=limit, cursor=cursor, filter=filter
    )

get_project_invites 

get_project_invites() -> List[PendingStreamCollaborator]
Source code in src/specklepy/api/resources/current/active_user_resource.py 
75
76
77
78
79
def get_project_invites(self) -> List[PendingStreamCollaborator]:
    metrics.track(
        metrics.SDK, self.account, {"name": "Active User Get Project Invites"}
    )
    return super().get_project_invites()

can_create_personal_projects 

can_create_personal_projects() -> PermissionCheckResult
Source code in src/specklepy/api/resources/current/active_user_resource.py 
81
82
83
84
85
86
87
def can_create_personal_projects(self) -> PermissionCheckResult:
    metrics.track(
        metrics.SDK,
        self.account,
        {"name": "Active User Can Create Personal Projects Check"},
    )
    return super().can_create_personal_projects()

get_workspaces 

get_workspaces(
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[UserWorkspacesFilter] = None,
) -> ResourceCollection[Workspace]
Source code in src/specklepy/api/resources/current/active_user_resource.py 
89
90
91
92
93
94
95
96
def get_workspaces(
    self,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[UserWorkspacesFilter] = None,
) -> ResourceCollection[Workspace]:
    metrics.track(metrics.SDK, self.account, {"name": "Active User Get Workspaces"})
    return super().get_workspaces(limit, cursor, filter)

get_active_workspace 

get_active_workspace() -> Optional[LimitedWorkspace]
Source code in src/specklepy/api/resources/current/active_user_resource.py 
 98
 99
100
101
102
def get_active_workspace(self) -> Optional[LimitedWorkspace]:
    metrics.track(
        metrics.SDK, self.account, {"name": "Active User Get Active Workspace"}
    )
    return super().get_active_workspace()