Skip to content

ModelResource

API Access class for models

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

get 

get(model_id: str, project_id: str) -> Model
Source code in src/specklepy/api/resources/current/model_resource.py 
26
27
28
def get(self, model_id: str, project_id: str) -> Model:
    metrics.track(metrics.SDK, self.account, {"name": "Model Get"})
    return super().get(model_id, project_id)

get_with_versions 

get_with_versions(
    model_id: str,
    project_id: str,
    *,
    versions_limit: int = 25,
    versions_cursor: Optional[str] = None,
    versions_filter: Optional[ModelVersionsFilter] = None,
) -> ModelWithVersions
Source code in src/specklepy/api/resources/current/model_resource.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def get_with_versions(
    self,
    model_id: str,
    project_id: str,
    *,
    versions_limit: int = 25,
    versions_cursor: Optional[str] = None,
    versions_filter: Optional[ModelVersionsFilter] = None,
) -> ModelWithVersions:
    metrics.track(metrics.SDK, self.account, {"name": "Model Get With Versions"})
    return super().get_with_versions(
        model_id,
        project_id,
        versions_limit=versions_limit,
        versions_cursor=versions_cursor,
        versions_filter=versions_filter,
    )

get_models 

get_models(
    project_id: str,
    *,
    models_limit: int = 25,
    models_cursor: Optional[str] = None,
    models_filter: Optional[ProjectModelsFilter] = None,
) -> ResourceCollection[Model]
Source code in src/specklepy/api/resources/current/model_resource.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def get_models(
    self,
    project_id: str,
    *,
    models_limit: int = 25,
    models_cursor: Optional[str] = None,
    models_filter: Optional[ProjectModelsFilter] = None,
) -> ResourceCollection[Model]:
    metrics.track(metrics.SDK, self.account, {"name": "Model Get Models"})
    return super().get_models(
        project_id,
        models_limit=models_limit,
        models_cursor=models_cursor,
        models_filter=models_filter,
    )

create 

create(input: CreateModelInput) -> Model
Source code in src/specklepy/api/resources/current/model_resource.py 
64
65
66
def create(self, input: CreateModelInput) -> Model:
    metrics.track(metrics.SDK, self.account, {"name": "Model Create"})
    return super().create(input)

delete 

delete(input: DeleteModelInput) -> bool
Source code in src/specklepy/api/resources/current/model_resource.py 
68
69
70
def delete(self, input: DeleteModelInput) -> bool:
    metrics.track(metrics.SDK, self.account, {"name": "Model Delete"})
    return super().delete(input)

update 

update(input: UpdateModelInput) -> Model
Source code in src/specklepy/api/resources/current/model_resource.py 
72
73
74
def update(self, input: UpdateModelInput) -> Model:
    metrics.track(metrics.SDK, self.account, {"name": "Model Update"})
    return super().update(input)