Skip to content

ProjectResource

API Access class for projects

Source code in src/specklepy/api/resources/current/project_resource.py 
23
24
25
26
27
28
29
def __init__(self, account, basepath, client, server_version) -> None:
    super().__init__(
        account=account,
        basepath=basepath,
        client=client,
        server_version=server_version,
    )

get 

get(project_id: str) -> Project
Source code in src/specklepy/api/resources/current/project_resource.py 
31
32
33
def get(self, project_id: str) -> Project:
    metrics.track(metrics.SDK, self.account, {"name": "Project Get "})
    return super().get(project_id)

get_permissions 

get_permissions(project_id: str) -> ProjectPermissionChecks
Source code in src/specklepy/api/resources/current/project_resource.py 
35
36
37
38
39
def get_permissions(self, project_id: str) -> ProjectPermissionChecks:
    metrics.track(
        metrics.SDK, self.account, {"name": "Project Project Permissions "}
    )
    return super().get_permissions(project_id)

get_with_models 

get_with_models(
    project_id: str,
    *,
    models_limit: int = 25,
    models_cursor: Optional[str] = None,
    models_filter: Optional[ProjectModelsFilter] = None,
) -> ProjectWithModels
Source code in src/specklepy/api/resources/current/project_resource.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def get_with_models(
    self,
    project_id: str,
    *,
    models_limit: int = 25,
    models_cursor: Optional[str] = None,
    models_filter: Optional[ProjectModelsFilter] = None,
) -> ProjectWithModels:
    metrics.track(metrics.SDK, self.account, {"name": "Project Get With Models"})
    return super().get_with_models(
        project_id,
        models_limit=models_limit,
        models_cursor=models_cursor,
        models_filter=models_filter,
    )

get_with_team 

get_with_team(project_id: str) -> ProjectWithTeam
Source code in src/specklepy/api/resources/current/project_resource.py 
57
58
59
def get_with_team(self, project_id: str) -> ProjectWithTeam:
    metrics.track(metrics.SDK, self.account, {"name": "Project Get With Team"})
    return super().get_with_team(project_id)

create 

create(input: ProjectCreateInput) -> Project
Source code in src/specklepy/api/resources/current/project_resource.py 
61
62
63
def create(self, input: ProjectCreateInput) -> Project:
    metrics.track(metrics.SDK, self.account, {"name": "Project Create"})
    return super().create(input)

create_in_workspace 

create_in_workspace(
    input: WorkspaceProjectCreateInput,
) -> Project
Source code in src/specklepy/api/resources/current/project_resource.py 
65
66
67
def create_in_workspace(self, input: WorkspaceProjectCreateInput) -> Project:
    metrics.track(metrics.SDK, self.account, {"name": "Workspace Project Create"})
    return super().create_in_workspace(input)

update 

update(input: ProjectUpdateInput) -> Project
Source code in src/specklepy/api/resources/current/project_resource.py 
69
70
71
def update(self, input: ProjectUpdateInput) -> Project:
    metrics.track(metrics.SDK, self.account, {"name": "Project Update"})
    return super().update(input)

delete 

delete(project_id: str) -> bool
Source code in src/specklepy/api/resources/current/project_resource.py 
73
74
75
def delete(self, project_id: str) -> bool:
    metrics.track(metrics.SDK, self.account, {"name": "Project Delete"})
    return super().delete(project_id)

update_role 

update_role(
    input: ProjectUpdateRoleInput,
) -> ProjectWithTeam
Source code in src/specklepy/api/resources/current/project_resource.py 
77
78
79
def update_role(self, input: ProjectUpdateRoleInput) -> ProjectWithTeam:
    metrics.track(metrics.SDK, self.account, {"name": "Project Update Role"})
    return super().update_role(input)