Skip to content

VersionResource

API Access class for model versions

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

get 

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

get_versions 

get_versions(
    model_id: str,
    project_id: str,
    *,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[ModelVersionsFilter] = None,
) -> ResourceCollection[Version]
Source code in src/specklepy/api/resources/current/version_resource.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
def get_versions(
    self,
    model_id: str,
    project_id: str,
    *,
    limit: int = 25,
    cursor: Optional[str] = None,
    filter: Optional[ModelVersionsFilter] = None,
) -> ResourceCollection[Version]:
    metrics.track(metrics.SDK, self.account, {"name": "Version Get Versions"})
    return super().get_versions(
        model_id, project_id, limit=limit, cursor=cursor, filter=filter
    )

create 

create(input: CreateVersionInput) -> Version
Source code in src/specklepy/api/resources/current/version_resource.py 
45
46
47
def create(self, input: CreateVersionInput) -> Version:
    metrics.track(metrics.SDK, self.account, {"name": "Version Create"})
    return super().create(input)

update 

update(input: UpdateVersionInput) -> Version
Source code in src/specklepy/api/resources/current/version_resource.py 
49
50
51
def update(self, input: UpdateVersionInput) -> Version:
    metrics.track(metrics.SDK, self.account, {"name": "Version Update"})
    return super().update(input)

move_to_model 

move_to_model(input: MoveVersionsInput) -> str
Source code in src/specklepy/api/resources/current/version_resource.py 
53
54
55
def move_to_model(self, input: MoveVersionsInput) -> str:
    metrics.track(metrics.SDK, self.account, {"name": "Version Move To Model"})
    return super().move_to_model(input)

delete 

delete(input: DeleteVersionsInput) -> bool
Source code in src/specklepy/api/resources/current/version_resource.py 
57
58
59
def delete(self, input: DeleteVersionsInput) -> bool:
    metrics.track(metrics.SDK, self.account, {"name": "Version Delete"})
    return super().delete(input)

received 

received(input: MarkReceivedVersionInput) -> bool
Source code in src/specklepy/api/resources/current/version_resource.py 
61
62
63
def received(self, input: MarkReceivedVersionInput) -> bool:
    metrics.track(metrics.SDK, self.account, {"name": "Version Received"})
    return super().received(input)