Skip to content

OtherUserResource

API Access class for other users, that are not the currently active user.

Source code in src/specklepy/api/resources/current/other_user_resource.py 
18
19
20
21
22
23
24
25
26
def __init__(self, account, basepath, client, server_version) -> None:
    super().__init__(
        account=account,
        basepath=basepath,
        client=client,
        name=NAME,
        server_version=server_version,
    )
    self.schema = LimitedUser

schema instance-attribute 

schema = LimitedUser

get 

get(id: str) -> Optional[LimitedUser]

Gets the profile of another user.

Returns:

Type Description
Optional[LimitedUser]

LimitedUser -- the retrieved profile of another user
Source code in src/specklepy/api/resources/current/other_user_resource.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def get(self, id: str) -> Optional[LimitedUser]:
    """
    Gets the profile of another user.

    Arguments:
        id {str} -- the user id

    Returns:
        LimitedUser -- the retrieved profile of another user
    """
    QUERY = gql(
        """
      query LimitedUser($id: String!) {
        data:otherUser(id: $id){
          id
          name
          bio
          company
          avatar
          verified
          role
        }
      }
      """
    )

    variables = {"id": id}

    return self.make_request_and_parse_response(
        DataResponse[Optional[LimitedUser]], QUERY, variables
    ).data

user_search(
    query: str,
    *,
    limit: int = 25,
    cursor: Optional[str] = None,
    archived: bool = False,
    emailOnly: bool = False,
) -> UserSearchResultCollection

Searches for a user on the server, by name or email. The search query must be at least 3 characters long

Returns: ResourceCollection[LimitedUser] -- User objects that match the search query

Source code in src/specklepy/api/resources/current/other_user_resource.py 
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
def user_search(
    self,
    query: str,
    *,
    limit: int = 25,
    cursor: Optional[str] = None,
    archived: bool = False,
    emailOnly: bool = False,
) -> UserSearchResultCollection:
    """
    Searches for a user on the server, by name or email.
    The search query must be at least
    3 characters long

    Arguments:
        search_query {str} -- a string to search for
        limit {int} -- the maximum number of results to return
        cursor {Optional[str]} --
        archived {bool} --
        emailOnly {bool} --
    Returns:
        ResourceCollection[LimitedUser] -- User objects that match the search query
    """

    QUERY = gql(
        """
        query UserSearch(
            $query: String!,
            $limit: Int!,
            $cursor: String,
            $archived: Boolean,
            $emailOnly: Boolean
        ) {
          data:userSearch(
            query: $query,
            limit: $limit,
            cursor: $cursor,
            archived: $archived,
            emailOnly: $emailOnly
            ) {
            cursor
            items {
             id
             name
             bio
             company
             avatar
             verified
             role
           }
         }
        }
        """
    )
    variables = {
        "query": query,
        "limit": limit,
        "cursor": cursor,
        "archived": archived,
        "emailOnly": emailOnly,
    }

    return self.make_request_and_parse_response(
        DataResponse[UserSearchResultCollection], QUERY, variables
    ).data