formatting by save

.circleci/config.yml

@@ -1,17 +1,108 @@
 version: 2.1
 
-# Define the jobs we want to run for this project
-jobs:
-  build:
-    docker:
-      - image: cimg/base:2023.03
-    steps:
-      - run: echo "so long and thanks for all the fish"
+orbs:
+  codecov: codecov/codecov@3.3.0
+
+jobs:
+  pre-commit:
+    parameters:
+      config_file:
+        default: ./.pre-commit-config.yaml
+        description: Optional, path to pre-commit config file.
+        type: string
+      cache_prefix:
+        default: ''
+        description: |
+          Optional cache prefix to be used on CircleCI. Can be used for cache busting or to ensure multiple jobs use different caches.
+        type: string
+    docker:
+      - image: speckle/pre-commit-runner:latest
+    resource_class: medium
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - cache-pre-commit-<<parameters.cache_prefix>>-{{ checksum "<<parameters.config_file>>" }}
+      - run:
+          name: Install pre-commit hooks
+          command: pre-commit install-hooks --config <<parameters.config_file>>
+      - save_cache:
+          key: cache-pre-commit-<<parameters.cache_prefix>>-{{ checksum "<<parameters.config_file>>" }}
+          paths:
+            - ~/.cache/pre-commit
+      - run:
+          name: Run pre-commit
+          command: pre-commit run --all-files
+      - run:
+          command: git --no-pager diff
+          name: git diff
+          when: on_fail
+
+  test:
+    machine:
+      image: ubuntu-2204:2023.02.1
+      docker_layer_caching: false
+    resource_class: medium
+    parameters:
+      tag:
+        default: "3.11"
+        type: string
+    steps:
+      - checkout
+      - run:
+          name: Install python
+          command: |
+            pyenv install -s << parameters.tag >>
+            pyenv global << parameters.tag >>
+      - run:
+          name: Startup the Speckle Server
+          command: docker compose -f docker-compose.yml up -d
+      - run:
+          name: Install Poetry
+          command: |
+            pip install poetry
+      - run:
+          name: Install packages
+          command: poetry install
+      - run:
+          name: Run tests
+          command: poetry run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
+      - store_test_results:
+          path: reports
+      - store_artifacts:
+          path: reports
+      - codecov/upload
+
+  deploy:
+    docker:
+      - image: "cimg/python:3.8"
+    steps:
+      - checkout
+      - run: python patch_version.py $CIRCLE_TAG
+      - run: poetry build
+      - run: poetry publish -u __token__ -p $PYPI_TOKEN
 
-# Orchestrate our job run sequence
 workflows:
-  build_and_test:
-    when:
-      false
+  main:
     jobs:
-      - build
+      - pre-commit:
+          filters:
+            tags:
+              only: /.*/
+      - test:
+          matrix:
+            parameters:
+              tag: ["3.11"]
+          filters:
+            tags:
+              only: /.*/
+      - deploy:
+          context: pypi
+          requires:
+            - pre-commit
+            - test
+          filters:
+            tags:
+              only: /[0-9]+(\.[0-9]+)*/
+            branches:
+              ignore: /.*/ # For testing only! /ci\/.*/

.devcontainer/Dockerfile

@@ -0,0 +1,27 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/blob/main/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6
+ARG VARIANT="3.10"
+FROM mcr.microsoft.com/vscode/devcontainers/python:${VARIANT}
+
+# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
+ARG NODE_VERSION="16"
+RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
+# COPY requirements.txt /tmp/pip-tmp/
+# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
+#    && rm -rf /tmp/pip-tmp
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
+
+USER vscode
+
+RUN curl -sSL https://install.python-poetry.org | python3 -
+
+ENV PATH=$PATH:$HOME/.poetry/env

.devcontainer/devcontainer.json

@@ -0,0 +1,55 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/python-3
+{
+	"name": "Python 3",
+	// "build": {
+	// 	"dockerfile": "Dockerfile",
+	// 	"context": "..",
+	// 	"args": {
+	// 		// Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9
+	// 		"VARIANT": "3.6",
+	// 		// Options
+	// 		"NODE_VERSION": "lts/*"
+	// 	}
+	// },
+	"dockerComposeFile": "./docker-compose.yaml",
+	"service": "specklepy",
+	"workspaceFolder": "/workspaces/specklepy",
+	"shutdownAction": "stopCompose",
+	// Set *default* container specific settings.json values on container create.
+	"settings": {
+		"python.pythonPath": "/usr/local/bin/python",
+		"python.languageServer": "Pylance",
+		"python.linting.enabled": true,
+		"python.linting.pylintEnabled": true,
+		"python.linting.pylintArgs": [
+			"--max-line-length=120"
+		],
+		"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+		"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+		"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+		"python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
+		"python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
+		"python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
+		"python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
+		"python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+		"python.linting.pylintPath": "/usr/local/py-utils/bin/pylint",
+		"python.testing.pytestArgs": [
+			"tests/",
+			"-s"
+		],
+		"python.testing.pytestEnabled": true,
+		"editor.formatOnSave": true,
+	},
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"ms-python.python",
+		"ms-python.vscode-pylance"
+	],
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "poetry config virtualenvs.create false && poetry install",
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}

.devcontainer/docker-compose.yaml

@@ -0,0 +1,44 @@
+version: "3.3"  # optional since v1.27.0
+services:
+  postgres:
+    image: cimg/postgres:14.2
+    environment:
+      POSTGRES_DB: speckle2_test
+      POSTGRES_PASSWORD: speckle
+      POSTGRES_USER: speckle
+    network_mode: host
+  redis:
+    image: cimg/redis:6.2
+    network_mode: host
+  speckle-server:
+    image: speckle/speckle-server:latest
+    command: ["bash", "-c", "/wait && node bin/www"]
+    environment:
+      POSTGRES_URL: "localhost"
+      POSTGRES_USER: "speckle"
+      POSTGRES_PASSWORD: "speckle"
+      POSTGRES_DB: "speckle2_test"
+      REDIS_URL: "redis://localhost"
+      SESSION_SECRET: "keyboard cat"
+      STRATEGY_LOCAL: "true"
+      CANONICAL_URL: "http://localhost:3000"
+      WAIT_HOSTS: localhost:5432, localhost:6379
+      DISABLE_FILE_UPLOADS: "true"
+    network_mode: host
+
+  specklepy:
+    build:
+      dockerfile: Dockerfile
+      context: .
+      args:
+        VARIANT: 3.9
+        NODE_VERSION: lts/*
+    volumes:
+      # Mounts the project folder to '/workspace'. While this file is in .devcontainer,
+      # mounts are relative to the first file in the list, which is a level up.
+      - ..:/workspaces/specklepy:cached
+    # Overrides default command so things don't shut down after the process ends.
+    command: /bin/sh -c "while sleep 1000; do :; done"
+    network_mode: host
+# networks:
+#     default:

.github/workflows/pr.yml

@@ -1,58 +0,0 @@
-name: "Specklepy test"
-on:
-  workflow_call:
-    secrets:
-      CODECOV_TOKEN:
-        required: true
-  pull_request:
-    branches:
-      - "main"
-
-jobs:
-  test:
-    name: test
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version:
-          - "3.10"
-          - "3.11"
-          - "3.12"
-          - "3.13"
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Install uv and set the python version
-        uses: astral-sh/setup-uv@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-          enable-cache: true
-          cache-dependency-glob: "uv.lock"
-
-      - name: Install the project
-        run: uv sync --all-extras --dev
-
-      - uses: actions/cache@v3
-        with:
-          path: ~/.cache/pre-commit/
-          key: ${{ hashFiles('.pre-commit-config.yaml') }}
-
-      - name: Run pre-commit
-        run: uv run pre-commit run --all-files
-
-      - name: Run Speckle Server
-        run: docker compose up --detach --wait
-
-      - name: Run tests
-        run: uv run pytest --cov --cov-report xml:reports/coverage.xml --junitxml=reports/test-results.xml
-
-      - uses: codecov/codecov-action@v5
-        if: matrix.python-version == 3.13
-        with:
-          fail_ci_if_error: true # optional (default = false)
-          files: ./reports/test-results.xml # optional
-          token: ${{ secrets.CODECOV_TOKEN }}
-
-      - name: Minimize uv cache
-        run: uv cache prune --ci

.github/workflows/publish.yml

@@ -1,55 +0,0 @@
-name: "Publish Python Package"
-on:
-  push:
-    branches:
-      - "main"
-    tags:
-      - "3.*.*"
-
-jobs:
-  test:
-    uses: "./.github/workflows/pr.yml"
-    secrets:
-      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
-  publish-package:
-    name: "Build and Publish Python Package"
-    runs-on: ubuntu-latest
-    needs: test
-
-    # set the environment based on what triggered the workflow
-    environment:
-      name: ${{ github.ref_type == 'tag' && 'pypi' || 'testpypi' }}
-
-    permissions:
-      id-token: write
-
-    steps:
-      - name: "Install uv"
-        uses: astral-sh/setup-uv@v5
-
-      - name: "Checkout code"
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: "Build package artifacts"
-        run: uv build
-
-      # Logic for TestPyPI (on main branch push)
-      - name: "Publish to TestPyPI"
-        if: ${{ github.ref_type == 'branch' }}
-        run: uv publish --index test
-
-      - name: "Verify TestPyPI package installation"
-        if: ${{ github.ref_type == 'branch' }}
-        run: uv run --index test --with specklepy --no-project -- python -c "import specklepy"
-
-      # Logic for PyPI (on v3* tag creation)
-      - name: "Publish to PyPI"
-        if: ${{ github.ref_type == 'tag' }}
-        run: uv publish
-
-      - name: "Verify PyPI package installation"
-        if: ${{ github.ref_type == 'tag' }}
-        run: uv run --with specklepy --no-project -- python -c "import specklepy"

.gitignore

@@ -2,8 +2,6 @@
 .envrc
 reports/
 
-.volumes/
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.pre-commit-config.yaml

@@ -1,31 +1,33 @@
 repos:
-  - repo: local
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
     hooks:
-      # Run the linter.
       - id: ruff
-        name: ruff lint
-        entry: uv run ruff check --force-exclude
-        language: system
-        types_or: [python, pyi]
-      # Run the formatter.
-      - id: ruff-format
-        name: ruff format
-        entry: uv run ruff format --force-exclude
-        language: system
-        types_or: [python, pyi]
-
+    rev: v0.8.2
 
   - repo: https://github.com/commitizen-tools/commitizen
     hooks:
       - id: commitizen
       - id: commitizen-branch
         stages:
-          - pre-push
+          - push
     rev: v3.13.0
 
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
 
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+        # It is recommended to specify the latest version of Python
+        # supported by your project here, or alternatively use
+        # pre-commit's default_language_version, see
+        # https://pre-commit.com/#top_level-default_language_version
+        # language_version: python3.11
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v4.5.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace

README.md

@@ -25,25 +25,25 @@ Head to the [**📚 specklepy docs**](https://speckle.guide/dev/python.html) for
 
 ### Installation
 
-This project uses uv for dependency management, make sure you follow the official [docs](https://docs.astral.sh/uv/) to get it.
+This project uses python-poetry for dependency management, make sure you follow the official [docs](https://python-poetry.org/docs/#installation) to get poetry.
 
-To create a new virtual environment with uv run `$ uv venv` and follow the instructions on the screen to activate the virtual environment.
-To bootstrap the project environment run `$ uv sync`. This will install both the package and dev dependencies.
+To bootstrap the project environment run `$ poetry install`. This will create a new virtual-env for the project and install both the package and dev dependencies.
 
-To execute any python script run `$ uv run python my_script.py`
+If this is your first time using poetry and you're used to creating your venvs within the project directory, run `poetry config virtualenvs.in-project true` to configure poetry to do the same.
 
-> Alternatively you may roll your own virtual-env with either venv, virtualenv, pyenv-virtualenv etc. Uv will play along an recognize if it is invoked from inside a virtual environment.
+To execute any python script run `$ poetry run python my_script.py`
+
+> Alternatively you may roll your own virtual-env with either venv, virtualenv, pyenv-virtualenv etc. Poetry will play along an recognize if it is invoked from inside a virtual environment.
 
 ### Style guide
 
-All our repo wide styling linting and other rules are checked and enforced by `pre-commit`, which is included in the dev dependencies.
+All our repo  wide styling linting and other rules are checked and enforced by `pre-commit`, which is included in the dev dependencies.
 It is recommended to set up `pre-commit` after installing the dependencies by running `$ pre-commit install`.
 Commiting code that doesn't adhere to the given rules, will fail the checks in our CI system.
 
 ### Local Data Paths
 
 It may be helpful to know where the local accounts and object cache dbs are stored. Depending on on your OS, you can find the dbs at:
-
 - Windows: `APPDATA` or `<USER>\AppData\Roaming\Speckle`
 - Linux: `$XDG_DATA_HOME` or by default `~/.local/share/Speckle`
 - Mac: `~/.config/Speckle`

docker-compose.yml

@@ -6,7 +6,7 @@ services:
   # Speckle Server dependencies
   #######
   postgres:
-    image: "postgres:16.4-alpine3.20@sha256:d898b0b78a2627cb4ee63464a14efc9d296884f1b28c841b0ab7d7c42f1fffdf"
+    image: "postgres:14.5-alpine"
     restart: always
     environment:
       POSTGRES_DB: speckle
@@ -49,6 +49,16 @@ services:
       retries: 30
       start_period: 10s
 
+  ####
+  # Speckle Server
+  #######
+
+  speckle-frontend:
+    image: speckle/speckle-frontend-2:latest
+    restart: always
+    ports:
+      - "0.0.0.0:8080:8080"
+
   speckle-server:
     image: speckle/speckle-server:latest
     restart: always
@@ -75,7 +85,6 @@ services:
       # TODO: Change this to the URL of the speckle server, as accessed from the network
       CANONICAL_URL: "http://127.0.0.1:8080"
       SPECKLE_AUTOMATE_URL: "http://127.0.0.1:3030"
-      FRONTEND_ORIGIN: "http://127.0.0.1:8081"
 
       # TODO: Change thvolumes:
       REDIS_URL: "redis://redis"

example/units_none.py

@@ -1,8 +1,8 @@
 from devtools import debug
 
 from specklepy.api import operations
-from specklepy.objects_v2.geometry import Base
-from specklepy.objects_v2.units import Units
+from specklepy.objects.geometry import Base
+from specklepy.objects.units import Units
 
 dct = {
     "id": "1234abcd",

patch_version.py

@@ -0,0 +1,31 @@
+import re
+import sys
+
+
+def patch(tag):
+    print(f"Patching version: {tag}")
+
+    with open("pyproject.toml", "r") as f:
+        lines = f.readlines()
+
+        if "version" not in lines[2]:
+            raise Exception("Invalid pyproject.toml. Could not patch version.")
+
+        lines[2] = f'version = "{tag}"\n'
+        with open("pyproject.toml", "w") as file:
+            file.writelines(lines)
+
+
+def main():
+    if len(sys.argv) < 2:
+        return
+
+    tag = sys.argv[1]
+    if not re.match(r"[0-9]+(\.[0-9]+)*$", tag):
+        raise ValueError(f"Invalid tag provided: {tag}")
+
+    patch(tag)
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -1,90 +1,75 @@
-[project]
-dynamic = ["version"]
-# version = "3.0.0a1"
+[tool.poetry]
 name = "specklepy"
+version = "2.17.14"
 description = "The Python SDK for Speckle 2.0"
 readme = "README.md"
-authors = [{ name = "Speckle Systems", email = "devops@speckle.systems" }]
-license = { text = "Apache-2.0" }
-requires-python = ">=3.10.0, <4.0"
-dependencies = [
-    "appdirs>=1.4.4",
-    "attrs>=24.3.0",
-    "deprecated>=1.2.15",
-    "gql[requests,websockets]>=3.5.0",
-    "httpx>=0.28.1",
-    "pydantic>=2.10.5",
-    "pydantic-settings>=2.7.1",
-    "ujson>=5.10.0",
-]
-
-[dependency-groups]
-dev = [
-    "commitizen>=4.1.0",
-    "devtools>=0.12.2",
-    "hatch>=1.14.0",
-    "hatch-vcs>=0.4.0",
-    "pre-commit>=4.0.1",
-    "pytest>=8.3.4",
-    "pytest-asyncio>=0.25.2",
-    "pytest-cov>=6.0.0",
-    "pytest-ordering>=0.6",
-    "ruff>=0.9.2",
-    "types-deprecated>=1.2.15.20241117",
-    "types-requests>=2.32.0.20241016",
-    "types-ujson>=5.10.0.20240515",
-]
-
-[project.urls]
-repository = "https://github.com/specklesystems/specklepy"
+authors = ["Speckle Systems <devops@speckle.systems>"]
+license = "Apache-2.0"
+repository = "https://github.com/specklesystems/speckle-py"
 documentation = "https://speckle.guide/dev/py-examples.html"
 homepage = "https://speckle.systems/"
+packages = [
+  { include = "specklepy", from = "src" },
+  { include = "speckle_automate", from = "src" },
+]
 
-[build-system]
-requires = ["hatchling", "hatch-vcs"]
-build-backend = "hatchling.build"
 
-[tool.hatch.version]
-source = "vcs"
+[tool.poetry.dependencies]
+python = ">=3.10.0, <4.0"
+pydantic = "^2.5"
+appdirs = "^1.4.4"
+gql = { extras = ["requests", "websockets"], version = "^3.3.0" }
+ujson = "^5.3.0"
+Deprecated = "^1.2.13"
+stringcase = "^1.2.0"
+attrs = "^23.1.0"
+httpx = "^0.25.0"
+pydantic-settings = "^2.6.1"
 
-[tool.hatch.build.targets.wheel]
-only-include = ["src"]
-sources = ["src"]
+[tool.poetry.group.dev.dependencies]
+black = "24.10.0"
+isort = "^5.13.2"
+pytest = "^7.1.3"
+pytest-asyncio = "^0.23.0"
+pytest-ordering = "^0.6"
+pytest-cov = "^3.0.0"
+devtools = "^0.8.0"
+pylint = "^3.3.2"
+pydantic-settings = "^2.3.0"
+mypy = "^0.982"
+pre-commit = "^2.20.0"
+commitizen = "^3.13.0"
+ruff = "^0.8.2"
+types-deprecated = "^1.2.9"
+types-ujson = "^5.6.0.0"
+types-requests = "^2.28.11.5"
 
-[tool.hatch.version.raw-options]
-local_scheme = "no-local-version"
+[tool.black]
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''
+include = '\.pyi?$'
+line-length = 88
+target-version = ["py39", "py310", "py311", "py312", "py313"]
 
 [tool.commitizen]
 name = "cz_conventional_commits"
 version = "2.9.2"
 tag_format = "$version"
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
 
-[tool.ruff]
-exclude = [".venv", "**/*.yml"]
-
-[tool.ruff.lint]
-select = [
-    # pycodestyle
-    "E",
-    # Pyflakes
-    "F",
-    # pyupgrade
-    "UP",
-    # flake8-bugbear
-    "B",
-    # flake8-simplify
-    "SIM",
-    # isort
-    "I",
-]
-ignore = ["UP006", "UP007", "UP035"]
-
-[[tool.uv.index]]
-name = "pypi"
-url = "https://pypi.org/simple/"
-publish-url = "https://upload.pypi.org/legacy/"
-
-[[tool.uv.index]]
-name = "test"
-url = "https://test.pypi.org/simple/"
-publish-url = "https://test.pypi.org/legacy/"
+[tool.isort]
+profile = "black"

src/speckle_automate/automation_context.py

@@ -3,7 +3,7 @@
 import time
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
 
 import httpx
 from gql import gql
@@ -18,9 +18,7 @@ from speckle_automate.schema import (
 )
 from specklepy.api import operations
 from specklepy.api.client import SpeckleClient
-from specklepy.core.api.inputs.model_inputs import CreateModelInput
-from specklepy.core.api.inputs.version_inputs import CreateVersionInput
-from specklepy.core.api.models.current import Model, Version
+from specklepy.core.api.models import Branch
 from specklepy.logging.exceptions import SpeckleException
 from specklepy.objects.base import Base
 from specklepy.transports.memory import MemoryTransport
@@ -73,7 +71,7 @@ class AutomationContext:
         speckle_client.authenticate_with_token(speckle_token)
         if not speckle_client.account:
             msg = (
-                f"Could not authenticate to {automation_run_data.speckle_server_url}",
+                f"Could not autenticate to {automation_run_data.speckle_server_url}",
                 "with the provided token",
             )
             raise ValueError(msg)
@@ -98,81 +96,61 @@ class AutomationContext:
 
     def receive_version(self) -> Base:
         """Receive the Speckle project version that triggered this automation run."""
-        # TODO: this is a quick hack to keep implementation consistency.
-        # Move to proper receive many versions
+        # TODO: this is a quick hack to keep implementation consistency. Move to proper receive many versions
         version_id = self.automation_run_data.triggers[0].payload.version_id
-        try:
-            version = self.speckle_client.version.get(
-                version_id, self.automation_run_data.project_id
-            )
-        except SpeckleException as err:
-            raise ValueError(
-                f"""Could not receive specified version.
-                Is your environment configured correctly?
-                project_id: {self.automation_run_data.project_id}
-                model_id: {self.automation_run_data.triggers[0].payload.model_id}
-                version_id: {self.automation_run_data.triggers[0].payload.version_id}
-                """
-            ) from err
-
-        if not version.referenced_object:
-            raise Exception(
-                "This version is past the version history limit,",
-                " cannot execute an automation on it",
-            )
-
-        base = operations.receive(
-            version.referenced_object, self._server_transport, self._memory_transport
+        commit = self.speckle_client.commit.get(
+            self.automation_run_data.project_id, version_id
+        )
+        if not commit.referencedObject:
+            raise ValueError("The commit has no referencedObject, cannot receive it.")
+        base = operations.receive(
+            commit.referencedObject, self._server_transport, self._memory_transport
         )
-        # self._closure_tree = base["__closure"]
         print(
             f"It took {self.elapsed():.2f} seconds to receive",
             f" the speckle version {version_id}",
         )
         return base
 
-    def create_new_model_in_project(
-        self, model_name: str, model_description: Optional[str] = None
-    ) -> Model:
-        input = CreateModelInput(
-            name=model_name,
-            description=model_description,
-            project_id=self.automation_run_data.project_id,
-        )
-
-        return self.speckle_client.model.create(input)
-
-    def get_model(self, model_id: str) -> Model:
-        """
-        Args:
-            model_id (str): The id of the model to get
-        """
-        return self.speckle_client.model.get(
-            model_id, self.automation_run_data.project_id
-        )
-
     def create_new_version_in_project(
-        self, root_object: Base, model_id: str, version_message: str = ""
-    ) -> Version:
+        self, root_object: Base, model_name: str, version_message: str = ""
+    ) -> Tuple[str, str]:
         """Save a base model to a new version on the project.
 
         Args:
             root_object (Base): The Speckle base object for the new version.
-            model_id (str): Id of model to create the new version on.
+            model_id (str): For now please use a `branchName`!
             version_message (str): The message for the new version.
         """
 
-        matching_trigger = [
-            t
-            for t in self.automation_run_data.triggers
-            if t.payload.model_id == model_id
-        ]
-        if matching_trigger:
-            raise ValueError(
-                f"The target model: {model_id} cannot match the model"
-                f" that triggered this automation:"
-                f" {matching_trigger[0].payload.model_id}"
+        branch = self.speckle_client.branch.get(
+            self.automation_run_data.project_id, model_name, 1
+        )
+        if isinstance(branch, Branch):
+            if not branch.id:
+                raise ValueError("Cannot use the branch without its id")
+            matching_trigger = [
+                t
+                for t in self.automation_run_data.triggers
+                if t.payload.model_id == branch.id
+            ]
+            if matching_trigger:
+                raise ValueError(
+                    f"The target model: {model_name} cannot match the model"
+                    f" that triggered this automation:"
+                    f" {matching_trigger[0].payload.model_id}"
+                )
+            model_id = branch.id
+
+        else:
+            # we just check if it exists
+            branch_create = self.speckle_client.branch.create(
+                self.automation_run_data.project_id,
+                model_name,
             )
+            if isinstance(branch_create, Exception):
+                raise branch_create
+            model_id = branch_create
 
         root_object_id = operations.send(
             root_object,
@@ -180,17 +158,19 @@ class AutomationContext:
             use_default_cache=False,
         )
 
-        create_version_input = CreateVersionInput(
+        version_id = self.speckle_client.commit.create(
+            stream_id=self.automation_run_data.project_id,
             object_id=root_object_id,
-            model_id=model_id,
-            project_id=self.automation_run_data.project_id,
+            branch_name=model_name,
             message=version_message,
             source_application="SpeckleAutomate",
         )
-        version = self.speckle_client.version.create(create_version_input)
 
-        self._automation_result.result_versions.append(version.id)
-        return version
+        if isinstance(version_id, SpeckleException):
+            raise version_id
+
+        self._automation_result.result_versions.append(version_id)
+        return model_id, version_id
 
     @property
     def context_view(self) -> Optional[str]:
@@ -246,7 +226,7 @@ class AutomationContext:
         )
         if self.run_status in [AutomationStatus.SUCCEEDED, AutomationStatus.FAILED]:
             object_results = {
-                "version": 2,
+                "version": 1,
                 "values": {
                     "objectResults": self._automation_result.model_dump(by_alias=True)[
                         "objectResults"
@@ -284,8 +264,7 @@ class AutomationContext:
 
         if not path_obj.exists():
             raise ValueError("The given file path doesn't exist")
-
-        files = {path_obj.name: path_obj.open("rb")}
+        files = {path_obj.name: open(str(path_obj), "rb")}
 
         url = (
             f"{self.automation_run_data.speckle_server_url}api/stream/"
@@ -336,24 +315,26 @@ class AutomationContext:
     def attach_error_to_objects(
         self,
         category: str,
-        affected_objects: Union[Base, List[Base]],
+        object_ids: Union[str, List[str]],
         message: Optional[str] = None,
         metadata: Optional[Dict[str, Any]] = None,
         visual_overrides: Optional[Dict[str, Any]] = None,
     ) -> None:
         """Add a new error case to the run results.
+
+        If the error cause has already created an error case,
+        the error will be extended with a new case refering to the causing objects.
         Args:
-            category (str): A short tag for the event type.
-            affected_objects (Union[Base, List[Base]]): A single object or a list of
-                objects that are causing the error case.
-            message (Optional[str]): Optional message.
+            error_tag (str): A short tag for the error type.
+            causing_object_ids (str[]): A list of object_id-s that are causing the error
+            error_messagge (Optional[str]): Optional error message.
             metadata: User provided metadata key value pairs
             visual_overrides: Case specific 3D visual overrides.
         """
         self.attach_result_to_objects(
             ObjectResultLevel.ERROR,
             category,
-            affected_objects,
+            object_ids,
             message,
             metadata,
             visual_overrides,
@@ -362,25 +343,16 @@ class AutomationContext:
     def attach_warning_to_objects(
         self,
         category: str,
-        affected_objects: Union[Base, List[Base]],
+        object_ids: Union[str, List[str]],
         message: Optional[str] = None,
         metadata: Optional[Dict[str, Any]] = None,
         visual_overrides: Optional[Dict[str, Any]] = None,
     ) -> None:
-        """Add a new warning case to the run results.
-
-        Args:
-            category (str): A short tag for the event type.
-            affected_objects (Union[Base, List[Base]]): A single object or a list of
-                objects that are causing the warning case.
-            message (Optional[str]): Optional message.
-            metadata: User provided metadata key value pairs
-            visual_overrides: Case specific 3D visual overrides.
-        """
+        """Add a new warning case to the run results."""
         self.attach_result_to_objects(
             ObjectResultLevel.WARNING,
             category,
-            affected_objects,
+            object_ids,
             message,
             metadata,
             visual_overrides,
@@ -389,25 +361,16 @@ class AutomationContext:
     def attach_success_to_objects(
         self,
         category: str,
-        affected_objects: Union[Base, List[Base]],
+        object_ids: Union[str, List[str]],
         message: Optional[str] = None,
         metadata: Optional[Dict[str, Any]] = None,
         visual_overrides: Optional[Dict[str, Any]] = None,
     ) -> None:
-        """Add a new success case to the run results.
-
-        Args:
-            category (str): A short tag for the event type.
-            affected_objects (Union[Base, List[Base]]): A single object or a list of
-                objects that are causing the success case.
-            message (Optional[str]): Optional message.
-            metadata: User provided metadata key value pairs
-            visual_overrides: Case specific 3D visual overrides.
-        """
+        """Add a new success case to the run results."""
         self.attach_result_to_objects(
             ObjectResultLevel.SUCCESS,
             category,
-            affected_objects,
+            object_ids,
             message,
             metadata,
             visual_overrides,
@@ -416,25 +379,16 @@ class AutomationContext:
     def attach_info_to_objects(
         self,
         category: str,
-        affected_objects: Union[Base, List[Base]],
+        object_ids: Union[str, List[str]],
         message: Optional[str] = None,
         metadata: Optional[Dict[str, Any]] = None,
         visual_overrides: Optional[Dict[str, Any]] = None,
     ) -> None:
-        """Add a new info case to the run results.
-
-        Args:
-            category (str): A short tag for the event type.
-            affected_objects (Union[Base, List[Base]]): A single object or a list of
-                objects that are causing the info case.
-            message (Optional[str]): Optional message.
-            metadata: User provided metadata key value pairs
-            visual_overrides: Case specific 3D visual overrides.
-        """
+        """Add a new info case to the run results."""
         self.attach_result_to_objects(
             ObjectResultLevel.INFO,
             category,
-            affected_objects,
+            object_ids,
             message,
             metadata,
             visual_overrides,
@@ -444,39 +398,19 @@ class AutomationContext:
         self,
         level: ObjectResultLevel,
         category: str,
-        affected_objects: Union[Base, List[Base]],
+        object_ids: Union[str, List[str]],
         message: Optional[str] = None,
         metadata: Optional[Dict[str, Any]] = None,
         visual_overrides: Optional[Dict[str, Any]] = None,
     ) -> None:
-        """Add a new result case to the run results.
-
-        Args:
-            level: Result level.
-            category (str): A short tag for the event type.
-            affected_objects (Union[Base, List[Base]]): A single object or a list of
-                objects that are causing the info case.
-            message (Optional[str]): Optional message.
-            metadata: User provided metadata key value pairs
-            visual_overrides: Case specific 3D visual overrides.
-        """
-        if isinstance(affected_objects, list):
-            if len(affected_objects) < 1:
+        if isinstance(object_ids, list):
+            if len(object_ids) < 1:
                 raise ValueError(
-                    f"Need atleast one object to report a(n) {level.value.upper()}"
+                    f"Need atleast one object_id to report a(n) {level.value.upper()}"
                 )
-            object_list = affected_objects
+            id_list = object_ids
         else:
-            object_list = [affected_objects]
-
-        ids: Dict[str, Optional[str]] = {}
-        for o in object_list:
-            # validate that the Base.id is not None. If its a None, throw an Exception
-            if not o.id:
-                raise Exception(
-                    f"You can only attach {level} results to objects with an id."
-                )
-            ids[o.id] = o.applicationId
+            id_list = [object_ids]
         print(
             f"Created new {level.value.upper()}"
             f" category: {category} caused by: {message}"
@@ -485,7 +419,7 @@ class AutomationContext:
             ResultCase(
                 category=category,
                 level=level,
-                object_app_ids=ids,
+                object_ids=id_list,
                 message=message,
                 metadata=metadata,
                 visual_overrides=visual_overrides,

src/speckle_automate/runner.py

@@ -128,8 +128,7 @@ def execute_automate_function(
                 automate_function,  # type: ignore
             )
 
-        # if we've gotten this far,
-        # the execution should technically be completed as expected
+        # if we've gotten this far, the execution should technically be completed as expected
         # thus exiting with 0 is the schemantically correct thing to do
         exit_code = (
             1 if automation_context.run_status == AutomationStatus.EXCEPTION else 0
@@ -191,4 +190,4 @@ def run_function(
         if not automation_context.context_view:
             automation_context.set_context_view()
         automation_context.report_run_status()
-    return automation_context
+        return automation_context

src/speckle_automate/schema.py

@@ -4,13 +4,13 @@ from enum import Enum
 from typing import Any, Dict, List, Literal, Optional
 
 from pydantic import BaseModel, ConfigDict, Field
-from pydantic.alias_generators import to_camel
+from stringcase import camelcase
 
 
 class AutomateBase(BaseModel):
     """Use this class as a base model for automate related DTO."""
 
-    model_config = ConfigDict(alias_generator=to_camel, populate_by_name=True)
+    model_config = ConfigDict(alias_generator=camelcase, populate_by_name=True)
 
 
 class VersionCreationTriggerPayload(AutomateBase):
@@ -39,7 +39,7 @@ class AutomationRunData(BaseModel):
     triggers: List[VersionCreationTrigger]
 
     model_config = ConfigDict(
-        alias_generator=to_camel, populate_by_name=True, protected_namespaces=()
+        alias_generator=camelcase, populate_by_name=True, protected_namespaces=()
     )
 
 
@@ -52,7 +52,7 @@ class TestAutomationRunData(BaseModel):
     triggers: List[VersionCreationTrigger]
 
     model_config = ConfigDict(
-        alias_generator=to_camel, populate_by_name=True, protected_namespaces=()
+        alias_generator=camelcase, populate_by_name=True, protected_namespaces=()
     )
 
 
@@ -80,7 +80,7 @@ class ResultCase(AutomateBase):
 
     category: str
     level: ObjectResultLevel
-    object_app_ids: Dict[str, Optional[str]]
+    object_ids: List[str]
     message: Optional[str]
     metadata: Optional[Dict[str, Any]]
     visual_overrides: Optional[Dict[str, Any]]

src/specklepy/api/client.py

@@ -1,4 +1,4 @@
-import contextlib
+from deprecated import deprecated
 
 from specklepy.api.credentials import Account
 from specklepy.api.resources import (
@@ -10,7 +10,12 @@ from specklepy.api.resources import (
     ServerResource,
     SubscriptionResource,
     VersionResource,
-    WorkspaceResource,
+    branch,
+    commit,
+    object,
+    stream,
+    subscriptions,
+    user,
 )
 from specklepy.core.api.client import SpeckleClient as CoreSpeckleClient
 from specklepy.logging import metrics
@@ -29,24 +34,21 @@ class SpeckleClient(CoreSpeckleClient):
 
     ```py
     from specklepy.api.client import SpeckleClient
-    from specklepy.core.api.inputs.project_inputs import ProjectCreateInput
     from specklepy.api.credentials import get_default_account
 
     # initialise the client
     client = SpeckleClient(host="app.speckle.systems") # or whatever your host is
     # client = SpeckleClient(host="localhost:3000", use_ssl=False) or use local server
 
-    # authenticate the client with an account
-    # (account has been added in Speckle Manager)
+    # authenticate the client with an account (account has been added in Speckle Manager)
     account = get_default_account()
     client.authenticate_with_account(account)
 
-    # create a new project
-    input = ProjectCreateInput(name="a shiny new project")
-    project = self.project.create(input)
+    # create a new stream. this returns the stream id
+    new_stream_id = client.stream.create(name="a shiny new stream")
 
-    # or, use a project id to get an existing project from the server
-    new_stream = client.project.get("abcdefghij")
+    # use that stream id to get the stream from the server
+    new_stream = client.stream.get(id=new_stream_id)
     ```
     """
 
@@ -72,9 +74,10 @@ class SpeckleClient(CoreSpeckleClient):
         )
 
         server_version = None
-
-        with contextlib.suppress(Exception):
+        try:
             server_version = self.server.version()
+        except Exception:
+            pass
 
         self.other_user = OtherUserResource(
             account=self.account,
@@ -112,18 +115,59 @@ class SpeckleClient(CoreSpeckleClient):
             client=self.httpclient,
             server_version=server_version,
         )
-        self.workspace = WorkspaceResource(
-            account=self.account,
-            basepath=self.url,
-            client=self.httpclient,
-            server_version=server_version,
-        )
         self.subscription = SubscriptionResource(
             account=self.account,
             basepath=self.ws_url,
             client=self.wsclient,
             # todo: why doesn't this take a server version
         )
+        # Deprecated Resources
+        self.user = user.Resource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
+        self.stream = stream.Resource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
+        self.commit = commit.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.branch = branch.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.object = object.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.subscribe = subscriptions.Resource(
+            account=self.account,
+            basepath=self.ws_url,
+            client=self.wsclient,
+        )
+
+    @deprecated(
+        version="2.6.0",
+        reason=(
+            "Renamed: please use `authenticate_with_account` or"
+            " `authenticate_with_token` instead."
+        ),
+    )
+    def authenticate(self, token: str) -> None:
+        """Authenticate the client using a personal access token
+        The token is saved in the client object and a synchronous GraphQL
+        entrypoint is created
+
+        Arguments:
+            token {str} -- an api token
+        """
+        metrics.track(
+            metrics.SDK, self.account, {"name": "Client Authenticate_deprecated"}
+        )
+        return super().authenticate(token)
 
     def authenticate_with_token(self, token: str) -> None:
         """

src/specklepy/api/credentials.py

@@ -2,11 +2,8 @@ from typing import List, Optional
 
 # following imports seem to be unnecessary, but they need to stay
 # to not break the scripts using these functions as non-core
-from specklepy.core.api.credentials import (  # noqa: F401
-    Account,
-    StreamWrapper,  # noqa: F401
-    UserInfo,
-)
+from specklepy.core.api.credentials import StreamWrapper  # noqa: F401
+from specklepy.core.api.credentials import Account, UserInfo  # noqa: F401
 from specklepy.core.api.credentials import (
     get_account_from_token as core_get_account_from_token,
 )

src/specklepy/api/models/__init__.py

@@ -1,15 +1,35 @@
 # following imports seem to be unnecessary, but they need to stay
 # to not break the scripts using these functions as non-core
 from specklepy.core.api.models import (
+    Activity,
+    ActivityCollection,
+    Branch,
+    Branches,
+    Collaborator,
+    Commit,
+    Commits,
     LimitedUser,
+    Object,
     PendingStreamCollaborator,
     ServerInfo,
+    Stream,
+    Streams,
     User,
 )
 
 __all__ = [
+    "Activity",
+    "ActivityCollection",
+    "Branch",
+    "Branches",
+    "Collaborator",
+    "Commit",
+    "Commits",
     "LimitedUser",
+    "Object",
     "PendingStreamCollaborator",
     "ServerInfo",
+    "Stream",
+    "Streams",
     "User",
 ]

src/specklepy/api/operations.py

@@ -53,9 +53,7 @@ def receive(
     return _untracked_receive(obj_id, remote_transport, local_transport)
 
 
-def serialize(
-    base: Base, write_transports: List[AbstractTransport] | None = None
-) -> str:
+def serialize(base: Base, write_transports: List[AbstractTransport] = []) -> str:
     """
     Serialize a base object. If no write transports are provided,
     the object will be serialized
@@ -69,8 +67,6 @@ def serialize(
     Returns:
         str -- the serialized object
     """
-    if not write_transports:
-        write_transports = []
     metrics.track(metrics.SDK, custom_props={"name": "Serialize"})
     return core_serialize(base, write_transports)
 

src/specklepy/api/resources/__init__.py

@@ -8,7 +8,17 @@ from specklepy.api.resources.current.project_resource import ProjectResource
 from specklepy.api.resources.current.server_resource import ServerResource
 from specklepy.api.resources.current.subscription_resource import SubscriptionResource
 from specklepy.api.resources.current.version_resource import VersionResource
-from specklepy.api.resources.current.workspace_resource import WorkspaceResource
+from specklepy.api.resources.deprecated import (
+    active_user,
+    branch,
+    commit,
+    object,
+    other_user,
+    server,
+    stream,
+    subscriptions,
+    user,
+)
 
 __all__ = [
     "ActiveUserResource",
@@ -19,5 +29,13 @@ __all__ = [
     "ServerResource",
     "SubscriptionResource",
     "VersionResource",
-    "WorkspaceResource",
+    "active_user",
+    "branch",
+    "commit",
+    "object",
+    "other_user",
+    "server",
+    "stream",
+    "subscriptions",
+    "user",
 ]

src/specklepy/api/resources/current/active_user_resource.py

@@ -1,17 +1,19 @@
-from typing import List, Optional
+from datetime import datetime
+from typing import List, Optional, overload
 
-from specklepy.core.api.inputs.user_inputs import (
-    UserProjectsFilter,
-    UserUpdateInput,
-    UserWorkspacesFilter,
-)
+from deprecated import deprecated
+
+from specklepy.core.api.inputs.user_inputs import UserProjectsFilter, UserUpdateInput
 from specklepy.core.api.models import (
     PendingStreamCollaborator,
     Project,
     ResourceCollection,
     User,
 )
-from specklepy.core.api.models.current import PermissionCheckResult, Workspace
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
 from specklepy.core.api.resources import ActiveUserResource as CoreResource
 from specklepy.logging import metrics
 
@@ -33,13 +35,40 @@ class ActiveUserResource(CoreResource):
         metrics.track(metrics.SDK, self.account, {"name": "Active User Get"})
         return super().get()
 
+    @deprecated("Use UserUpdateInput overload", version=FE1_DEPRECATION_VERSION)
+    @overload
     def update(
         self,
-        input: UserUpdateInput,
+        name: Optional[str] = None,
+        company: Optional[str] = None,
+        bio: Optional[str] = None,
+        avatar: Optional[str] = None,
+    ) -> User: ...
+
+    @overload
+    def update(self, *, input: UserUpdateInput) -> User: ...
+
+    def update(
+        self,
+        name: Optional[str] = None,
+        company: Optional[str] = None,
+        bio: Optional[str] = None,
+        avatar: Optional[str] = None,
+        *,
+        input: Optional[UserUpdateInput] = None,
     ) -> User:
         metrics.track(metrics.SDK, self.account, {"name": "Active User Update"})
-
-        return super().update(input=input)
+        if isinstance(input, UserUpdateInput):
+            return super()._update(input=input)
+        else:
+            return super()._update(
+                input=UserUpdateInput(
+                    name=name,
+                    company=company,
+                    bio=bio,
+                    avatar=avatar,
+                )
+            )
 
     def get_projects(
         self,
@@ -57,25 +86,59 @@ class ActiveUserResource(CoreResource):
         )
         return super().get_project_invites()
 
-    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()
-
-    def get_workspaces(
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def activity(
         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)
+        limit: int = 20,
+        action_type: Optional[str] = None,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ):
+        """
+        Fetches collection the current authenticated user's activity
+        as filtered by given parameters
 
-    def get_active_workspace(self) -> Optional[Workspace]:
+        Note: all timestamps arguments should be `datetime` of any tz as they will be
+        converted to UTC ISO format strings
+
+        Args:
+            limit (int): The maximum number of activity items to return.
+            action_type (Optional[str]): Filter results to a single action type.
+            before (Optional[datetime]): Latest cutoff for activity to include.
+            after (Optional[datetime]): Oldest cutoff for an activity to include.
+            cursor (Optional[datetime]): Timestamp cursor for pagination.
+
+        Returns:
+            Activity collection, filtered according to the provided parameters.
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "User Active Activity"})
+        return super().activity(limit, action_type, before, after, cursor)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get_all_pending_invites(self) -> List[PendingStreamCollaborator]:
+        """Fetches all of the current user's pending stream invitations.
+
+        Returns:
+            List[PendingStreamCollaborator]: A list of pending stream invitations.
+        """
         metrics.track(
-            metrics.SDK, self.account, {"name": "Active User Get Active Workspace"}
+            metrics.SDK, self.account, {"name": "User Active Invites All Get"}
         )
-        return super().get_active_workspace()
+        return super().get_all_pending_invites()
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get_pending_invite(
+        self, stream_id: str, token: Optional[str] = None
+    ) -> Optional[PendingStreamCollaborator]:
+        """Fetches a specific pending invite for the current user on a given stream.
+
+        Args:
+            stream_id (str): The ID of the stream to look for invites on.
+            token (Optional[str]): The token of the invite to look for (optional).
+
+        Returns:
+            Optional[PendingStreamCollaborator]: The invite for the given stream, or None if not found.
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "User Active Invite Get"})
+        return super().get_pending_invite(stream_id, token)

src/specklepy/api/resources/current/other_user_resource.py

@@ -1,20 +1,27 @@
-from typing import Optional
+from datetime import datetime
+from typing import List, Optional, Union
+
+from deprecated import deprecated
 
 from specklepy.core.api.models import (
+    ActivityCollection,
     LimitedUser,
     UserSearchResultCollection,
 )
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
 from specklepy.core.api.resources import OtherUserResource as CoreResource
 from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException
 
 
 class OtherUserResource(CoreResource):
     """
     Provides API access to other users' profiles and activities on the platform.
-    This class enables fetching limited information about users,
-    searching for users by name or email,
-    and accessing user activity logs with appropriate privacy
-    and access control measures in place.
+    This class enables fetching limited information about users, searching for users by name or email,
+    and accessing user activity logs with appropriate privacy and access control measures in place.
     """
 
     def __init__(self, account, basepath, client, server_version) -> None:
@@ -43,3 +50,55 @@ class OtherUserResource(CoreResource):
         return super().user_search(
             query, limit=limit, cursor=cursor, archived=archived, emailOnly=emailOnly
         )
+
+    @deprecated(reason="Use user_search instead", version=FE1_DEPRECATION_VERSION)
+    def search(
+        self, search_query: str, limit: int = 25
+    ) -> Union[List[LimitedUser], SpeckleException]:
+        """
+        Searches for users by name or email.
+        The search requires a minimum query length of 3 characters.
+
+        Args:
+            search_query (str): The search string.
+            limit (int): Maximum number of search results to return.
+
+        Returns:
+            Union[List[LimitedUser], SpeckleException]: A list of users matching the search
+                query or an exception if the query is too short.
+        """
+        if len(search_query) < 3:
+            return SpeckleException(
+                message="User search query must be at least 3 characters."
+            )
+
+        metrics.track(metrics.SDK, self.account, {"name": "Other User Search"})
+        return super().search(search_query, limit)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def activity(
+        self,
+        user_id: str,
+        limit: int = 20,
+        action_type: Optional[str] = None,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ) -> ActivityCollection:
+        """
+        Retrieves a collection of activities for a specified user, with optional filters for activity type,
+        time frame, and pagination.
+
+        Args:
+            user_id (str): The ID of the user whose activities are being requested.
+            limit (int): The maximum number of activity items to return.
+            action_type (Optional[str]): A specific type of activity to filter.
+            before (Optional[datetime]): Latest timestamp to include activities before.
+            after (Optional[datetime]): Earliest timestamp to include activities after.
+            cursor (Optional[datetime]): Timestamp for pagination cursor.
+
+        Returns:
+            ActivityCollection: A collection of user activities filtered according to specified criteria.
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Other User Activity"})
+        return super().activity(user_id, limit, action_type, before, after, cursor)

src/specklepy/api/resources/current/project_resource.py

@@ -5,10 +5,8 @@ from specklepy.core.api.inputs.project_inputs import (
     ProjectModelsFilter,
     ProjectUpdateInput,
     ProjectUpdateRoleInput,
-    WorkspaceProjectCreateInput,
 )
 from specklepy.core.api.models import Project, ProjectWithModels, ProjectWithTeam
-from specklepy.core.api.models.current import ProjectPermissionChecks
 from specklepy.core.api.resources import ProjectResource as CoreResource
 from specklepy.logging import metrics
 
@@ -28,12 +26,6 @@ class ProjectResource(CoreResource):
         metrics.track(metrics.SDK, self.account, {"name": "Project Get "})
         return super().get(project_id)
 
-    def get_permissions(self, project_id: str) -> ProjectPermissionChecks:
-        metrics.track(
-            metrics.SDK, self.account, {"name": "Project Project Permissions "}
-        )
-        return super().get_permissions(project_id)
-
     def get_with_models(
         self,
         project_id: str,
@@ -58,10 +50,6 @@ class ProjectResource(CoreResource):
         metrics.track(metrics.SDK, self.account, {"name": "Project Create"})
         return super().create(input)
 
-    def create_in_workspace(self, input: WorkspaceProjectCreateInput) -> Project:
-        metrics.track(metrics.SDK, self.account, {"name": "Workspace Project Create"})
-        return super().create_in_workspace(input)
-
     def update(self, input: ProjectUpdateInput) -> Project:
         metrics.track(metrics.SDK, self.account, {"name": "Project Update"})
         return super().update(input)

src/specklepy/api/resources/current/server_resource.py

@@ -31,8 +31,7 @@ class ServerResource(CoreResource):
             the server version in the format (major, minor, patch, (tag, build))
             eg (2, 6, 3) for a stable build and (2, 6, 4, 'alpha', 4711) for alpha
         """
-        # not tracking as it will be called along with other
-        # mutations / queries as a check
+        # not tracking as it will be called along with other mutations / queries as a check
         return super().version()
 
     def apps(self) -> Dict:

src/specklepy/api/resources/current/version_resource.py

@@ -42,7 +42,7 @@ class VersionResource(CoreResource):
             model_id, project_id, limit=limit, cursor=cursor, filter=filter
         )
 
-    def create(self, input: CreateVersionInput) -> Version:
+    def create(self, input: CreateVersionInput) -> str:
         metrics.track(metrics.SDK, self.account, {"name": "Version Create"})
         return super().create(input)
 

src/specklepy/api/resources/current/workspace_resource.py

@@ -1,32 +0,0 @@
-from typing import Optional
-
-from specklepy.core.api.inputs.project_inputs import WorksaceProjectsFilter
-from specklepy.core.api.models.current import Project, ResourceCollection, Workspace
-from specklepy.core.api.resources import WorkspaceResource as CoreResource
-from specklepy.logging import metrics
-
-
-class WorkspaceResource(CoreResource):
-    """API Access class for workspace"""
-
-    def __init__(self, account, basepath, client, server_version) -> None:
-        super().__init__(
-            account=account,
-            basepath=basepath,
-            client=client,
-            server_version=server_version,
-        )
-
-    def get(self, workspace_id: str) -> Workspace:
-        metrics.track(metrics.SDK, self.account, {"name": "Workspace Get"})
-        return super().get(workspace_id)
-
-    def get_projects(
-        self,
-        workspace_id: str,
-        limit: int = 25,
-        cursor: Optional[str] = None,
-        filter: Optional[WorksaceProjectsFilter] = None,
-    ) -> ResourceCollection[Project]:
-        metrics.track(metrics.SDK, self.account, {"name": "Workspace Get Projects"})
-        return super().get_projects(workspace_id, limit, cursor, filter)

src/specklepy/api/resources/deprecated/active_user.py

@@ -0,0 +1,9 @@
+from deprecated import deprecated
+
+from specklepy.api.resources import ActiveUserResource
+from specklepy.core.api.models.deprecated import FE1_DEPRECATION_VERSION
+
+
+@deprecated(reason="Renamed to ActiveUserResource", version=FE1_DEPRECATION_VERSION)
+class Resource(ActiveUserResource):
+    """Renamed to ActiveUserResource"""

src/specklepy/api/resources/deprecated/branch.py

@@ -0,0 +1,108 @@
+from typing import Optional, Union
+
+from deprecated import deprecated
+
+from specklepy.api.models import Branch
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
+from specklepy.core.api.resources.deprecated.branch import Resource as CoreResource
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException
+
+
+class Resource(CoreResource):
+    """API Access class for branches"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+        )
+        self.schema = Branch
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def create(
+        self, stream_id: str, name: str, description: str = "No description provided"
+    ) -> str:
+        """Create a new branch on this stream
+
+        Arguments:
+            name {str} -- the name of the new branch
+            description {str} -- a short description of the branch
+
+        Returns:
+            id {str} -- the newly created branch's id
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Branch Create"})
+        return super().create(stream_id, name, description)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get(
+        self, stream_id: str, name: str, commits_limit: int = 10
+    ) -> Union[Branch, None, SpeckleException]:
+        """Get a branch by name from a stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to get the branch from
+            name {str} -- the name of the branch to get
+            commits_limit {int} -- maximum number of commits to get
+
+        Returns:
+            Branch -- the fetched branch with its latest commits
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Branch Get"})
+        return super().get(stream_id, name, commits_limit)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def list(self, stream_id: str, branches_limit: int = 10, commits_limit: int = 10):
+        """Get a list of branches from a given stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to get the branches from
+            branches_limit {int} -- maximum number of branches to get
+            commits_limit {int} -- maximum number of commits to get
+
+        Returns:
+            List[Branch] -- the branches on the stream
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Branch List"})
+        return super().list(stream_id, branches_limit, commits_limit)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def update(
+        self,
+        stream_id: str,
+        branch_id: str,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
+    ):
+        """Update a branch
+
+        Arguments:
+            stream_id {str} -- the id of the stream containing the branch to update
+            branch_id {str} -- the id of the branch to update
+            name {str} -- optional: the updated branch name
+            description {str} -- optional: the updated branch description
+
+        Returns:
+            bool -- True if update is successful
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Branch Update"})
+        return super().update(stream_id, branch_id, name, description)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def delete(self, stream_id: str, branch_id: str):
+        """Delete a branch
+
+        Arguments:
+            stream_id {str} -- the id of the stream containing the branch to delete
+            branch_id {str} -- the branch to delete
+
+        Returns:
+            bool -- True if deletion is successful
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Branch Delete"})
+        return super().delete(stream_id, branch_id)

src/specklepy/api/resources/deprecated/commit.py

@@ -0,0 +1,134 @@
+from typing import List, Optional, Union
+
+from deprecated import deprecated
+
+from specklepy.api.models import Commit
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
+from specklepy.core.api.resources.deprecated.commit import Resource as CoreResource
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException
+
+
+class Resource(CoreResource):
+    """API Access class for commits"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+        )
+        self.schema = Commit
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get(self, stream_id: str, commit_id: str) -> Commit:
+        """
+        Gets a commit given a stream and the commit id
+
+        Arguments:
+            stream_id {str} -- the stream where we can find the commit
+            commit_id {str} -- the id of the commit you want to get
+
+        Returns:
+            Commit -- the retrieved commit object
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Commit Get"})
+        return super().get(stream_id, commit_id)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def list(self, stream_id: str, limit: int = 10) -> List[Commit]:
+        """
+        Get a list of commits on a given stream
+
+        Arguments:
+            stream_id {str} -- the stream where the commits are
+            limit {int} -- the maximum number of commits to fetch (default = 10)
+
+        Returns:
+            List[Commit] -- a list of the most recent commit objects
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Commit List"})
+        return super().list(stream_id, limit)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def create(
+        self,
+        stream_id: str,
+        object_id: str,
+        branch_name: str = "main",
+        message: str = "",
+        source_application: str = "python",
+        parents: Optional[List[str]] = None,
+    ) -> Union[str, SpeckleException]:
+        """
+        Creates a commit on a branch
+
+        Arguments:
+            stream_id {str} -- the stream you want to commit to
+            object_id {str} -- the hash of your commit object
+            branch_name {str}
+                -- the name of the branch to commit to (defaults to "main")
+            message {str}
+                -- optional: a message to give more information about the commit
+            source_application{str}
+                -- optional: the application from which the commit was created
+                (defaults to "python")
+            parents {List[str]} -- optional: the id of the parent commits
+
+        Returns:
+            str -- the id of the created commit
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Commit Create"})
+        return super().create(
+            stream_id, object_id, branch_name, message, source_application, parents
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def update(self, stream_id: str, commit_id: str, message: str) -> bool:
+        """
+        Update a commit
+
+        Arguments:
+            stream_id {str}
+                -- the id of the stream that contains the commit you'd like to update
+            commit_id {str} -- the id of the commit you'd like to update
+            message {str} -- the updated commit message
+
+        Returns:
+            bool -- True if the operation succeeded
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Commit Update"})
+        return super().update(stream_id, commit_id, message)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def delete(self, stream_id: str, commit_id: str) -> bool:
+        """
+        Delete a commit
+
+        Arguments:
+            stream_id {str}
+                -- the id of the stream that contains the commit you'd like to delete
+            commit_id {str} -- the id of the commit you'd like to delete
+
+        Returns:
+            bool -- True if the operation succeeded
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Commit Delete"})
+        return super().delete(stream_id, commit_id)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def received(
+        self,
+        stream_id: str,
+        commit_id: str,
+        source_application: str = "python",
+        message: Optional[str] = None,
+    ) -> bool:
+        """
+        Mark a commit object a received by the source application.
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Commit Received"})
+        return super().received(stream_id, commit_id, source_application, message)

src/specklepy/api/resources/deprecated/object.py

@@ -0,0 +1,63 @@
+from typing import Dict, List
+
+from deprecated import deprecated
+
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
+from specklepy.core.api.resources.deprecated.object import Resource as CoreResource
+from specklepy.logging import metrics
+from specklepy.objects.base import Base
+
+
+class Resource(CoreResource):
+    """API Access class for objects"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+        )
+        self.schema = Base
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get(self, stream_id: str, object_id: str) -> Base:
+        """
+        Get a stream object
+
+        Arguments:
+            stream_id {str} -- the id of the stream for the object
+            object_id {str} -- the hash of the object you want to get
+
+        Returns:
+            Base -- the returned Base object
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Object Get"})
+        return super().get(stream_id, object_id)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def create(self, stream_id: str, objects: List[Dict]) -> str:
+        """
+        Not advised - generally, you want to use `operations.send()`.
+
+        Create a new object on a stream.
+        To send a base object, you can prepare it by running it through the
+        `BaseObjectSerializer.traverse_base()` function to get a valid (serialisable)
+        object to send.
+
+        NOTE: this does not create a commit - you can create one with
+        `SpeckleClient.commit.create`.
+        Dynamic fields will be located in the 'data' dict of the received `Base` object
+
+        Arguments:
+            stream_id {str} -- the id of the stream you want to send the object to
+            objects {List[Dict]}
+            -- a list of base dictionary objects (NOTE: must be json serialisable)
+
+        Returns:
+            str -- the id of the object
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Object Create"})
+        return super().create(stream_id, objects)

src/specklepy/api/resources/deprecated/other_user.py

@@ -0,0 +1,11 @@
+from deprecated import deprecated
+
+from specklepy.api.resources import OtherUserResource
+from specklepy.core.api.models.deprecated import FE1_DEPRECATION_VERSION
+
+
+@deprecated(reason="Renamed to OtherUserResource", version=FE1_DEPRECATION_VERSION)
+class Resource(OtherUserResource):
+    """
+    Renamed to OtherUserResource
+    """

src/specklepy/api/resources/deprecated/server.py

@@ -0,0 +1,9 @@
+from deprecated import deprecated
+
+from specklepy.api.resources import ServerResource
+from specklepy.core.api.models.deprecated import FE1_DEPRECATION_VERSION
+
+
+@deprecated(reason="Renamed to ServerResource", version=FE1_DEPRECATION_VERSION)
+class Resource(ServerResource):
+    """Renamed to ServerResource"""

src/specklepy/api/resources/deprecated/stream.py

@@ -0,0 +1,322 @@
+from datetime import datetime
+from typing import List, Optional
+
+from deprecated import deprecated
+
+from specklepy.api.models import PendingStreamCollaborator, Stream
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
+from specklepy.core.api.resources.deprecated.stream import Resource as CoreResource
+from specklepy.logging import metrics
+
+
+class Resource(CoreResource):
+    """API Access class for streams"""
+
+    def __init__(self, account, basepath, client, server_version) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            server_version=server_version,
+        )
+
+        self.schema = Stream
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get(self, id: str, branch_limit: int = 10, commit_limit: int = 10) -> Stream:
+        """Get the specified stream from the server
+
+        Arguments:
+            id {str} -- the stream id
+            branch_limit {int} -- the maximum number of branches to return
+            commit_limit {int} -- the maximum number of commits to return
+
+        Returns:
+            Stream -- the retrieved stream
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Get"})
+        return super().get(id, branch_limit, commit_limit)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def list(self, stream_limit: int = 10) -> List[Stream]:
+        """Get a list of the user's streams
+
+        Arguments:
+            stream_limit {int} -- The maximum number of streams to return
+
+        Returns:
+            List[Stream] -- A list of Stream objects
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream List"})
+        return super().list(stream_limit)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def create(
+        self,
+        name: str = "Anonymous Python Stream",
+        description: str = "No description provided",
+        is_public: bool = True,
+    ) -> str:
+        """Create a new stream
+
+        Arguments:
+            name {str} -- the name of the string
+            description {str} -- a short description of the stream
+            is_public {bool}
+                -- whether or not the stream can be viewed by anyone with the id
+
+        Returns:
+            id {str} -- the id of the newly created stream
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Create"})
+        return super().create(name, description, is_public)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def update(
+        self,
+        id: str,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
+        is_public: Optional[bool] = None,
+    ) -> bool:
+        """Update an existing stream
+
+        Arguments:
+            id {str} -- the id of the stream to be updated
+            name {str} -- the name of the string
+            description {str} -- a short description of the stream
+            is_public {bool}
+                -- whether or not the stream can be viewed by anyone with the id
+
+        Returns:
+            bool -- whether the stream update was successful
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Update"})
+        return super().update(id, name, description, is_public)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def delete(self, id: str) -> bool:
+        """Delete a stream given its id
+
+        Arguments:
+            id {str} -- the id of the stream to delete
+
+        Returns:
+            bool -- whether the deletion was successful
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Delete"})
+        return super().delete(id)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def search(
+        self,
+        search_query: str,
+        limit: int = 25,
+        branch_limit: int = 10,
+        commit_limit: int = 10,
+    ):
+        """Search for streams by name, description, or id
+
+        Arguments:
+            search_query {str} -- a string to search for
+            limit {int} -- the maximum number of results to return
+            branch_limit {int} -- the maximum number of branches to return
+            commit_limit {int} -- the maximum number of commits to return
+
+        Returns:
+            List[Stream] -- a list of Streams that match the search query
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Search"})
+        return super().search(search_query, limit, branch_limit, commit_limit)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def favorite(self, stream_id: str, favorited: bool = True):
+        """Favorite or unfavorite the given stream.
+
+        Arguments:
+            stream_id {str} -- the id of the stream to favorite / unfavorite
+            favorited {bool}
+                -- whether to favorite (True) or unfavorite (False) the stream
+
+        Returns:
+            Stream -- the stream with its `id`, `name`, and `favoritedDate`
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Favorite"})
+        return super().favorite(stream_id, favorited)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get_all_pending_invites(
+        self, stream_id: str
+    ) -> List[PendingStreamCollaborator]:
+        """Get all of the pending invites on a stream.
+        You must be a `stream:owner` to query this.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the stream id from which to get the pending invites
+
+        Returns:
+            List[PendingStreamCollaborator]
+                -- a list of pending invites for the specified stream
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Invite Get"})
+        return super().get_all_pending_invites(stream_id)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def invite(
+        self,
+        stream_id: str,
+        email: Optional[str] = None,
+        user_id: Optional[str] = None,
+        role: str = "stream:contributor",  # should default be reviewer?
+        message: Optional[str] = None,
+    ):
+        """Invite someone to a stream using either their email or user id
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to invite the user to
+            email {str} -- the email of the user to invite (use this OR `user_id`)
+            user_id {str} -- the id of the user to invite (use this OR `email`)
+            role {str}
+                -- the role to assign to the user (defaults to `stream:contributor`)
+            message {str}
+                -- a message to send along with this invite to the specified user
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Invite Create"})
+        return super().invite(stream_id, email, user_id, role, message)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def invite_batch(
+        self,
+        stream_id: str,
+        emails: Optional[List[str]] = None,
+        user_ids: Optional[List[None]] = None,
+        message: Optional[str] = None,
+    ) -> bool:
+        """Invite a batch of users to a specified stream.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to invite the user to
+            emails {List[str]}
+                -- the email of the user to invite (use this and/or `user_ids`)
+            user_id {List[str]}
+                -- the id of the user to invite (use this and/or `emails`)
+            message {str}
+                -- a message to send along with this invite to the specified user
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Invite Batch Create"})
+        return super().invite_batch(stream_id, emails, user_ids, message)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def invite_cancel(self, stream_id: str, invite_id: str) -> bool:
+        """Cancel an existing stream invite
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream invite
+            invite_id {str} -- the id of the invite to use
+
+        Returns:
+            bool -- true if the operation was successful
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Invite Cancel"})
+        return super().invite_cancel(stream_id, invite_id)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def invite_use(self, stream_id: str, token: str, accept: bool = True) -> bool:
+        """Accept or decline a stream invite
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str}
+                -- the id of the stream for which the user has a pending invite
+            token {str} -- the token of the invite to use
+            accept {bool} -- whether or not to accept the invite (defaults to True)
+
+        Returns:
+            bool -- true if the operation was successful
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Invite Use"})
+        return super().invite_use(stream_id, token, accept)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def update_permission(self, stream_id: str, user_id: str, role: str):
+        """Updates permissions for a user on a given stream
+
+        Valid for Speckle Server >=2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to grant permissions to
+            user_id {str} -- the id of the user to grant permissions for
+            role {str} -- the role to grant the user
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        metrics.track(
+            metrics.SDK,
+            self.account,
+            {"name": "Stream Permission Update", "role": role},
+        )
+        return super().update_permission(stream_id, user_id, role)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def revoke_permission(self, stream_id: str, user_id: str):
+        """Revoke permissions from a user on a given stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to revoke permissions from
+            user_id {str} -- the id of the user to revoke permissions from
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Permission Revoke"})
+        return super().revoke_permission(stream_id, user_id)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def activity(
+        self,
+        stream_id: str,
+        action_type: Optional[str] = None,
+        limit: int = 20,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ):
+        """
+        Get the activity from a given stream in an Activity collection.
+        Step into the activity `items` for the list of activity.
+
+        Note: all timestamps arguments should be `datetime` of any tz
+            as they will be converted to UTC ISO format strings
+
+        stream_id {str} -- the id of the stream to get activity from
+        action_type {str}
+            -- filter results to a single action type
+            (eg: `commit_create` or `commit_receive`)
+        limit {int} -- max number of Activity items to return
+        before {datetime}
+            -- latest cutoff for activity (ie: return all activity _before_ this time)
+        after {datetime}
+            -- oldest cutoff for activity (ie: return all activity _after_ this time)
+        cursor {datetime} -- timestamp cursor for pagination
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Stream Activity"})
+        return super().activity(stream_id, action_type, limit, before, after, cursor)

src/specklepy/api/resources/deprecated/subscriptions.py

@@ -0,0 +1,107 @@
+from typing import Callable, Dict, List, Optional, Union
+
+from deprecated import deprecated
+from graphql import DocumentNode
+
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
+from specklepy.core.api.resources.current.subscription_resource import check_wsclient
+from specklepy.core.api.resources.deprecated.subscriptions import (
+    Resource as CoreResource,
+)
+from specklepy.logging import metrics
+
+
+class Resource(CoreResource):
+    """API Access class for subscriptions"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    @check_wsclient
+    async def stream_added(self, callback: Optional[Callable] = None):
+        """Subscribes to new stream added event for your profile.
+        Use this to display an up-to-date list of streams.
+
+        Arguments:
+            callback {Callable[Stream]} -- a function that takes the updated stream
+            as an argument and executes each time a stream is added
+
+        Returns:
+            Stream -- the update stream
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "Subscription Stream Added"})
+        return super().stream_added(callback)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    @check_wsclient
+    async def stream_updated(self, id: str, callback: Optional[Callable] = None):
+        """
+        Subscribes to stream updated event.
+        Use this in clients/components that pertain only to this stream.
+
+        Arguments:
+            id {str} -- the stream id of the stream to subscribe to
+            callback {Callable[Stream]}
+            -- a function that takes the updated stream
+            as an argument and executes each time the stream is updated
+
+        Returns:
+            Stream -- the update stream
+        """
+        metrics.track(
+            metrics.SDK, self.account, {"name": "Subscription Stream Updated"}
+        )
+        return super().stream_updated(id, callback)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    @check_wsclient
+    async def stream_removed(self, callback: Optional[Callable] = None):
+        """Subscribes to stream removed event for your profile.
+        Use this to display an up-to-date list of streams for your profile.
+        NOTE: If someone revokes your permissions on a stream,
+        this subscription will be triggered with an extra value of revokedBy
+        in the payload.
+
+        Arguments:
+            callback {Callable[Dict]}
+            -- a function that takes the returned dict as an argument
+            and executes each time a stream is removed
+
+        Returns:
+            dict -- dict containing 'id' of stream removed and optionally 'revokedBy'
+        """
+        metrics.track(
+            metrics.SDK, self.account, {"name": "Subscription Stream Removed"}
+        )
+        return super().stream_removed(callback)
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    @check_wsclient
+    async def subscribe(
+        self,
+        query: DocumentNode,
+        params: Optional[Dict] = None,
+        callback: Optional[Callable] = None,
+        return_type: Optional[Union[str, List]] = None,
+        schema=None,
+        parse_response: bool = True,
+    ):
+        # if self.client.transport.websocket is None:
+        # TODO: add multiple subs to the same ws connection
+        async with self.client as session:
+            async for res in session.subscribe(query, variable_values=params):
+                res = self._step_into_response(response=res, return_type=return_type)
+                if parse_response:
+                    res = self._parse_response(response=res, schema=schema)
+                if callback is not None:
+                    callback(res)
+                else:
+                    return res

src/specklepy/api/resources/deprecated/user.py

@@ -0,0 +1,153 @@
+from datetime import datetime
+from typing import List, Optional, Union
+
+from deprecated import deprecated
+
+from specklepy.api.models import PendingStreamCollaborator, User
+from specklepy.core.api.resources.deprecated.user import Resource as CoreResource
+from specklepy.logging import metrics
+from specklepy.logging.exceptions import SpeckleException
+
+DEPRECATION_VERSION = "2.9.0"
+DEPRECATION_TEXT = (
+    "The user resource is deprecated, please use the active_user or other_user"
+    " resources"
+)
+
+
+class Resource(CoreResource):
+    """API Access class for users"""
+
+    def __init__(self, account, basepath, client, server_version) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            server_version=server_version,
+        )
+        self.schema = User
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def get(self, id: Optional[str] = None) -> User:
+        """
+        Gets the profile of a user.
+        If no id argument is provided, will return the current authenticated
+        user's profile (as extracted from the authorization header).
+
+        Arguments:
+            id {str} -- the user id
+
+        Returns:
+            User -- the retrieved user
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "User Get_deprecated"})
+        return super().get(id)
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def search(
+        self, search_query: str, limit: int = 25
+    ) -> Union[List[User], SpeckleException]:
+        """
+        Searches for user 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
+        Returns:
+            List[User] -- a list of User objects that match the search query
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "User Search_deprecated"})
+        return super().search(search_query, limit)
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def update(
+        self,
+        name: Optional[str] = None,
+        company: Optional[str] = None,
+        bio: Optional[str] = None,
+        avatar: Optional[str] = None,
+    ):
+        """Updates your user profile. All arguments are optional.
+
+        Arguments:
+            name {str} -- your name
+            company {str} -- the company you may or may not work for
+            bio {str} -- tell us about yourself
+            avatar {str} -- a nice photo of yourself
+
+        Returns:
+            bool -- True if your profile was updated successfully
+        """
+        # metrics.track(metrics.USER, self.account, {"name": "update"})
+        metrics.track(metrics.SDK, self.account, {"name": "User Update_deprecated"})
+        return super().update(name, company, bio, avatar)
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def activity(
+        self,
+        user_id: Optional[str] = None,
+        limit: int = 20,
+        action_type: Optional[str] = None,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ):
+        """
+        Get the activity from a given stream in an Activity collection.
+        Step into the activity `items` for the list of activity.
+        If no id argument is provided, will return the current authenticated
+        user's activity (as extracted from the authorization header).
+
+        Note: all timestamps arguments should be `datetime` of any tz as
+        they will be converted to UTC ISO format strings
+
+        user_id {str} -- the id of the user to get the activity from
+        action_type {str} -- filter results to a single action type
+        (eg: `commit_create` or `commit_receive`)
+        limit {int} -- max number of Activity items to return
+        before {datetime}
+            -- latest cutoff for activity (ie: return all activity _before_ this time)
+        after {datetime}
+            -- oldest cutoff for activity (ie: return all activity _after_ this time)
+        cursor {datetime} -- timestamp cursor for pagination
+        """
+        metrics.track(metrics.SDK, self.account, {"name": "User Activity_deprecated"})
+        return super().activity(user_id, limit, action_type, before, after, cursor)
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def get_all_pending_invites(self) -> List[PendingStreamCollaborator]:
+        """Get all of the active user's pending stream invites
+
+        Requires Speckle Server version >= 2.6.4
+
+        Returns:
+            List[PendingStreamCollaborator]
+                -- a list of pending invites for the current user
+        """
+        # metrics.track(metrics.INVITE, self.account, {"name": "get"})
+        metrics.track(
+            metrics.SDK, self.account, {"name": "User GetAllInvites_deprecated"}
+        )
+        return super().get_all_pending_invites()
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def get_pending_invite(
+        self, stream_id: str, token: Optional[str] = None
+    ) -> Optional[PendingStreamCollaborator]:
+        """Get a particular pending invite for the active user on a given stream.
+        If no invite_id is provided, any valid invite will be returned.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to look for invites on
+            token {str} -- the token of the invite to look for (optional)
+
+        Returns:
+            PendingStreamCollaborator
+                -- the invite for the given stream (or None if it isn't found)
+        """
+        # metrics.track(metrics.INVITE, self.account, {"name": "get"})
+        metrics.track(metrics.SDK, self.account, {"name": "User GetInvite_deprecated"})
+        return super().get_pending_invite(stream_id, token)

src/specklepy/api/wrapper.py

@@ -10,7 +10,7 @@ class StreamWrapper(CoreStreamWrapper):
     The `StreamWrapper` gives you some handy helpers to deal with urls and
     get authenticated clients and transports.
 
-    Construct a `StreamWrapper` with a URL of a model, version, or object.
+    Construct a `StreamWrapper` with a stream, branch, commit, or object URL.
     The corresponding ids will be stored
     in the wrapper. If you have local accounts on the machine,
     you can use the `get_account` and `get_client` methods
@@ -21,8 +21,8 @@ class StreamWrapper(CoreStreamWrapper):
     ```py
     from specklepy.api.wrapper import StreamWrapper
 
-    # provide a url for a model, version, or object
-    wrapper = StreamWrapper("https://app.speckle.systems/projects/3073b96e86/models/0fe47c9dca@604bea8cc6")
+    # provide any stream, branch, commit, object, or globals url
+    wrapper = StreamWrapper("https://app.speckle.systems/streams/3073b96e86/commits/604bea8cc6")
 
     # get an authenticated SpeckleClient if you have a local account for the server
     client = wrapper.get_client()

src/specklepy/core/api/client.py

@@ -1,14 +1,15 @@
-import contextlib
 import re
 from typing import Dict
 from warnings import warn
 
+from deprecated import deprecated
 from gql import Client
 from gql.transport.exceptions import TransportServerError
 from gql.transport.requests import RequestsHTTPTransport
 from gql.transport.websockets import WebsocketsTransport
 
-from specklepy.core.api.credentials import Account
+from specklepy.core.api import resources
+from specklepy.core.api.credentials import Account, get_account_from_token
 from specklepy.core.api.resources import (
     ActiveUserResource,
     ModelResource,
@@ -18,7 +19,12 @@ from specklepy.core.api.resources import (
     ServerResource,
     SubscriptionResource,
     VersionResource,
-    WorkspaceResource,
+    branch,
+    commit,
+    object,
+    stream,
+    subscriptions,
+    user,
 )
 from specklepy.logging import metrics
 from specklepy.logging.exceptions import SpeckleException, SpeckleWarning
@@ -37,24 +43,21 @@ class SpeckleClient:
 
     ```py
     from specklepy.api.client import SpeckleClient
-    from specklepy.core.api.inputs.project_inputs import ProjectCreateInput
     from specklepy.api.credentials import get_default_account
 
     # initialise the client
     client = SpeckleClient(host="app.speckle.systems") # or whatever your host is
     # client = SpeckleClient(host="localhost:3000", use_ssl=False) or use local server
 
-    # authenticate the client with an account
-    # (account has been added in Speckle Manager)
+    # authenticate the client with an account (account has been added in Speckle Manager)
     account = get_default_account()
     client.authenticate_with_account(account)
 
-    # create a new project
-    input = ProjectCreateInput(name="a shiny new project")
-    project = self.project.create(input)
+    # create a new stream. this returns the stream id
+    new_stream_id = client.stream.create(name="a shiny new stream")
 
-    # or, use a project id to get an existing project from the server
-    new_stream = client.project.get("abcdefghij")
+    # use that stream id to get the stream from the server
+    new_stream = client.stream.get(id=new_stream_id)
     ```
     """
 
@@ -99,8 +102,7 @@ class SpeckleClient:
 
         self._init_resources()
 
-        # ? Check compatibility with the server
-        # - i think we can skip this at this point? save a request
+        # ? Check compatibility with the server - i think we can skip this at this point? save a request
         # try:
         #     server_info = self.server.get()
         #     if isinstance(server_info, Exception):
@@ -118,6 +120,23 @@ class SpeckleClient:
             f" {self.account.token is not None} )"
         )
 
+    @deprecated(
+        version="2.6.0",
+        reason=(
+            "Renamed: please use `authenticate_with_account` or"
+            " `authenticate_with_token` instead."
+        ),
+    )
+    def authenticate(self, token: str) -> None:
+        """Authenticate the client using a personal access token
+        The token is saved in the client object and a synchronous GraphQL
+        entrypoint is created
+
+        Arguments:
+            token {str} -- an api token
+        """
+        self.authenticate_with_account(get_account_from_token(token))
+
     def authenticate_with_token(self, token: str) -> None:
         """
         Authenticate the client using a personal access token.
@@ -168,10 +187,9 @@ class SpeckleClient:
                 if ex.exception.code == 403:
                     warn(
                         SpeckleWarning(
-                            "Possibly invalid token - could not authenticate "
-                            f"Speckle Client for server {self.url}"
-                        ),
-                        stacklevel=2,
+                            "Possibly invalid token - could not authenticate Speckle Client"
+                            f" for server {self.url}"
+                        )
                     )
                 else:
                     raise ex
@@ -185,8 +203,10 @@ class SpeckleClient:
         )
 
         server_version = None
-        with contextlib.suppress(Exception):
+        try:
             server_version = self.server.version()
+        except Exception:
+            pass
 
         self.other_user = OtherUserResource(
             account=self.account,
@@ -224,14 +244,46 @@ class SpeckleClient:
             client=self.httpclient,
             server_version=server_version,
         )
-        self.workspace = WorkspaceResource(
-            account=self.account,
-            basepath=self.url,
-            client=self.httpclient,
-            server_version=server_version,
-        )
         self.subscription = SubscriptionResource(
             account=self.account,
             basepath=self.ws_url,
             client=self.wsclient,
         )
+        # Deprecated Resources
+        self.user = user.Resource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
+        self.stream = stream.Resource(
+            account=self.account,
+            basepath=self.url,
+            client=self.httpclient,
+            server_version=server_version,
+        )
+        self.commit = commit.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.branch = branch.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.object = object.Resource(
+            account=self.account, basepath=self.url, client=self.httpclient
+        )
+        self.subscribe = subscriptions.Resource(
+            account=self.account,
+            basepath=self.ws_url,
+            client=self.wsclient,
+        )
+
+    def __getattr__(self, name):
+        try:
+            attr = getattr(resources, name)
+            return attr.Resource(
+                account=self.account, basepath=self.url, client=self.httpclient
+            )
+        except AttributeError:
+            raise SpeckleException(
+                f"Method {name} is not supported by the SpeckleClient class"
+            )

src/specklepy/core/api/credentials.py

@@ -150,7 +150,7 @@ def get_accounts_for_server(host: str) -> List[Account]:
 
     for acc in all_accounts:
         moved_from = (
-            acc.serverInfo.migration.moved_from if acc.serverInfo.migration else None
+            acc.serverInfo.migration.movedFrom if acc.serverInfo.migration else None
         )
 
         if moved_from and host == urlparse(moved_from).netloc:

src/specklepy/core/api/enums.py

@@ -2,12 +2,9 @@ from enum import Enum
 
 
 class ProjectVisibility(str, Enum):
-    """Supported project visibility types"""
-
     PRIVATE = "PRIVATE"
     PUBLIC = "PUBLIC"
-    UNLISTED = "UNLISTED"
-    WORKSPACE = "WORKSPACE"
+    UNLISTEd = "UNLISTED"
 
 
 class UserProjectsUpdatedMessageType(str, Enum):

src/specklepy/core/api/inputs/model_inputs.py

@@ -1,26 +1,26 @@
 from typing import Optional, Sequence
 
-from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
+from pydantic import BaseModel
 
 
-class CreateModelInput(GraphQLBaseModel):
+class CreateModelInput(BaseModel):
     name: str
     description: Optional[str] = None
-    project_id: str
+    projectId: str
 
 
-class DeleteModelInput(GraphQLBaseModel):
+class DeleteModelInput(BaseModel):
     id: str
-    project_id: str
+    projectId: str
 
 
-class UpdateModelInput(GraphQLBaseModel):
+class UpdateModelInput(BaseModel):
     id: str
     name: Optional[str] = None
     description: Optional[str] = None
-    project_id: str
+    projectId: str
 
 
-class ModelVersionsFilter(GraphQLBaseModel):
-    priority_ids: Sequence[str]
-    priority_ids_only: Optional[bool] = None
+class ModelVersionsFilter(BaseModel):
+    priorityIds: Sequence[str]
+    priorityIdsOnly: Optional[bool] = None

src/specklepy/core/api/inputs/project_inputs.py

@@ -1,62 +1,47 @@
 from typing import Optional, Sequence
 
+from pydantic import BaseModel
+
 from specklepy.core.api.enums import ProjectVisibility
-from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
 
 
-class ProjectCreateInput(GraphQLBaseModel):
+class ProjectCreateInput(BaseModel):
     name: Optional[str]
     description: Optional[str]
     visibility: Optional[ProjectVisibility]
 
 
-class WorkspaceProjectCreateInput(GraphQLBaseModel):
-    name: Optional[str]
-    description: Optional[str]
-    visibility: Optional[ProjectVisibility]
-    workspaceId: str
-
-
-class ProjectInviteCreateInput(GraphQLBaseModel):
+class ProjectInviteCreateInput(BaseModel):
     email: Optional[str]
     role: Optional[str]
-    server_role: Optional[str]
+    serverRole: Optional[str]
     userId: Optional[str]
 
 
-class ProjectInviteUseInput(GraphQLBaseModel):
+class ProjectInviteUseInput(BaseModel):
     accept: bool
-    project_id: str
+    projectId: str
     token: str
 
 
-class ProjectModelsFilter(GraphQLBaseModel):
+class ProjectModelsFilter(BaseModel):
     contributors: Optional[Sequence[str]] = None
-    exclude_ids: Optional[Sequence[str]] = None
+    excludeIds: Optional[Sequence[str]] = None
     ids: Optional[Sequence[str]] = None
-    only_with_versions: Optional[bool] = None
+    onlyWithVersions: Optional[bool] = None
     search: Optional[str] = None
-    source_apps: Optional[Sequence[str]] = None
+    sourceApps: Optional[Sequence[str]] = None
 
 
-class ProjectUpdateInput(GraphQLBaseModel):
+class ProjectUpdateInput(BaseModel):
     id: str
     name: Optional[str] = None
     description: Optional[str] = None
-    allow_public_comments: Optional[bool] = None
+    allowPublicComments: Optional[bool] = None
     visibility: Optional[ProjectVisibility] = None
 
 
-class ProjectUpdateRoleInput(GraphQLBaseModel):
-    user_id: str
-    project_id: str
+class ProjectUpdateRoleInput(BaseModel):
+    userId: str
+    projectId: str
     role: Optional[str]
-
-
-class WorksaceProjectsFilter(GraphQLBaseModel):
-    search: Optional[str]
-    """Filter out projects by name"""
-    with_project_role_only: Optional[bool]
-    """
-    Only return workspace projects that the active user has an explicit project role in
-    """

src/specklepy/core/api/inputs/user_inputs.py

@@ -1,22 +1,15 @@
 from typing import Optional, Sequence
 
-from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
+from pydantic import BaseModel
 
 
-class UserUpdateInput(GraphQLBaseModel):
+class UserUpdateInput(BaseModel):
     avatar: Optional[str] = None
     bio: Optional[str] = None
     company: Optional[str] = None
     name: Optional[str] = None
 
 
-class UserProjectsFilter(GraphQLBaseModel):
-    search: Optional[str] = None
-    only_with_roles: Optional[Sequence[str]] = None
-    workspace_id: Optional[str] = None
-    personal_only: Optional[bool] = None
-    include_implicit_access: Optional[bool] = None
-
-
-class UserWorkspacesFilter(GraphQLBaseModel):
-    search: Optional[str]
+class UserProjectsFilter(BaseModel):
+    search: str
+    onlyWithRoles: Optional[Sequence[str]] = None

src/specklepy/core/api/inputs/version_inputs.py

@@ -1,37 +1,37 @@
 from typing import Optional, Sequence
 
-from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
+from pydantic import BaseModel
 
 
-class UpdateVersionInput(GraphQLBaseModel):
-    version_id: str
-    project_id: str
+class UpdateVersionInput(BaseModel):
+    versionId: str
+    projectId: str
     message: Optional[str]
 
 
-class MoveVersionsInput(GraphQLBaseModel):
-    target_model_name: str
-    version_ids: Sequence[str]
-    project_id: str
+class MoveVersionsInput(BaseModel):
+    targetModelName: str
+    versionIds: Sequence[str]
+    projectId: str
 
 
-class DeleteVersionsInput(GraphQLBaseModel):
-    version_ids: Sequence[str]
-    project_id: str
+class DeleteVersionsInput(BaseModel):
+    versionIds: Sequence[str]
+    projectId: str
 
 
-class CreateVersionInput(GraphQLBaseModel):
-    object_id: str
-    model_id: str
-    project_id: str
+class CreateVersionInput(BaseModel):
+    objectId: str
+    modelId: str
+    projectId: str
     message: Optional[str] = None
-    source_application: Optional[str] = "py"
-    total_children_count: Optional[int] = None
+    sourceApplication: Optional[str] = "py"
+    totalChildrenCount: Optional[int] = None
     parents: Optional[Sequence[str]] = None
 
 
-class MarkReceivedVersionInput(GraphQLBaseModel):
-    version_id: str
-    project_id: str
-    source_application: str
+class MarkReceivedVersionInput(BaseModel):
+    versionId: str
+    projectId: str
+    sourceApplication: str
     message: Optional[str] = None

src/specklepy/core/api/models/__init__.py

@@ -17,6 +17,18 @@ from specklepy.core.api.models.current import (
     UserSearchResultCollection,
     Version,
 )
+from specklepy.core.api.models.deprecated import (
+    Activity,
+    ActivityCollection,
+    Branch,
+    Branches,
+    Collaborator,
+    Commit,
+    Commits,
+    Object,
+    Stream,
+    Streams,
+)
 from specklepy.core.api.models.subscription_messages import (
     ProjectModelsUpdatedMessage,
     ProjectUpdatedMessage,
@@ -46,4 +58,14 @@ __all__ = [
     "ProjectModelsUpdatedMessage",
     "ProjectUpdatedMessage",
     "ProjectVersionsUpdatedMessage",
+    "Collaborator",
+    "Commit",
+    "Commits",
+    "Object",
+    "Branch",
+    "Branches",
+    "Stream",
+    "Streams",
+    "Activity",
+    "ActivityCollection",
 ]

src/specklepy/core/api/models/current.py

@@ -1,14 +1,15 @@
 from datetime import datetime
 from typing import Generic, List, Optional, TypeVar
 
+from pydantic import BaseModel
+
 from specklepy.core.api.enums import ProjectVisibility
-from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
-from specklepy.logging.exceptions import WorkspacePermissionException
+from specklepy.core.api.models.deprecated import Streams
 
 T = TypeVar("T")
 
 
-class User(GraphQLBaseModel):
+class User(BaseModel):
     id: str
     email: Optional[str] = None
     name: str
@@ -17,6 +18,7 @@ class User(GraphQLBaseModel):
     avatar: Optional[str] = None
     verified: Optional[bool] = None
     role: Optional[str] = None
+    streams: Optional["Streams"] = None
 
     def __repr__(self):
         return (
@@ -28,18 +30,18 @@ class User(GraphQLBaseModel):
         return self.__repr__()
 
 
-class ResourceCollection(GraphQLBaseModel, Generic[T]):
-    total_count: int
+class ResourceCollection(BaseModel, Generic[T]):
+    totalCount: int
     items: List[T]
     cursor: Optional[str] = None
 
 
-class ServerMigration(GraphQLBaseModel):
-    moved_from: Optional[str]
-    moved_to: Optional[str]
+class ServerMigration(BaseModel):
+    movedFrom: Optional[str]
+    movedTo: Optional[str]
 
 
-class AuthStrategy(GraphQLBaseModel):
+class AuthStrategy(BaseModel):
     color: Optional[str]
     icon: str
     id: str
@@ -47,34 +49,31 @@ class AuthStrategy(GraphQLBaseModel):
     url: str
 
 
-class ServerConfiguration(GraphQLBaseModel):
-    blob_size_limit_bytes: int
-    object_multipart_upload_size_limit_bytes: int
-    object_size_limit_bytes: int
+class ServerConfiguration(BaseModel):
+    blobSizeLimitBytes: int
+    objectMultipartUploadSizeLimitBytes: int
+    objectSizeLimitBytes: int
 
 
-class ServerWorkspacesInfo(GraphQLBaseModel):
-    workspaces_enabled: bool
-
-
-# Keeping this one all Optionals at the minute,
-#  because its used both as a deserialization model for GQL and Account Management
-class ServerInfo(GraphQLBaseModel):
+# Keeping this one all Optionals at the minute, because its used both as a deserialization model for GQL and Account Management
+class ServerInfo(BaseModel):
     name: Optional[str] = None
     company: Optional[str] = None
     url: Optional[str] = None
-    admin_contact: Optional[str] = None
+    adminContact: Optional[str] = None
     description: Optional[str] = None
-    canonical_url: Optional[str] = None
+    canonicalUrl: Optional[str] = None
+    roles: Optional[List[dict]] = None
     scopes: Optional[List[dict]] = None
-    auth_strategies: Optional[List[dict]] = None
+    authStrategies: Optional[List[dict]] = None
     version: Optional[str] = None
+    frontend2: Optional[bool] = None
     migration: Optional[ServerMigration] = None
-    workspaces: Optional[ServerWorkspacesInfo] = None
+
     # TODO separate gql model from account management model
 
 
-class LimitedUser(GraphQLBaseModel):
+class LimitedUser(BaseModel):
     """Limited user type, for showing public info about a user to another user."""
 
     id: str
@@ -85,34 +84,24 @@ class LimitedUser(GraphQLBaseModel):
     verified: Optional[bool]
     role: Optional[str]
 
-    def __repr__(self):
-        return (
-            f"(name: {self.name}, "
-            f"id: {self.id}, "
-            f"bio: {self.bio}, "
-            f"company: {self.company}, "
-            f"verified: {self.verified}, "
-            f"role: {self.role})"
-        )
 
-
-class PendingStreamCollaborator(GraphQLBaseModel):
+class PendingStreamCollaborator(BaseModel):
     id: str
-    invite_id: str
-    stream_id: Optional[str] = None
+    inviteId: str
+    streamId: Optional[str] = None
     projectId: str
-    stream_name: Optional[str] = None
-    project_name: str
+    streamName: Optional[str] = None
+    projectName: str
     title: str
     role: str
-    invited_by: LimitedUser
+    invitedBy: LimitedUser
     user: Optional[LimitedUser] = None
     token: Optional[str]
 
     def __repr__(self):
         return (
-            f"PendingStreamCollaborator( inviteId: {self.invite_id}, streamId:"
-            f" {self.stream_id}, role: {self.role}, title: {self.title}, invitedBy:"
+            f"PendingStreamCollaborator( inviteId: {self.inviteId}, streamId:"
+            f" {self.streamId}, role: {self.role}, title: {self.title}, invitedBy:"
             f" {self.user.name if self.user else None})"
         )
 
@@ -120,56 +109,48 @@ class PendingStreamCollaborator(GraphQLBaseModel):
         return self.__repr__()
 
 
-class ProjectCollaborator(GraphQLBaseModel):
+class ProjectCollaborator(BaseModel):
     id: str
     role: str
     user: LimitedUser
 
 
-class Version(GraphQLBaseModel):
-    author_user: Optional[LimitedUser]
-    created_at: datetime
+class Version(BaseModel):
+    authorUser: Optional[LimitedUser]
+    createdAt: datetime
     id: str
     message: Optional[str]
-    preview_url: str
-    referenced_object: Optional[str]
-    """Maybe null if workspaces version history limit has been exceeded"""
-    source_application: Optional[str]
+    previewUrl: str
+    referencedObject: str
+    sourceApplication: Optional[str]
 
 
-class Model(GraphQLBaseModel):
-    author: Optional[LimitedUser]
-    created_at: datetime
+class Model(BaseModel):
+    author: LimitedUser
+    createdAt: datetime
     description: Optional[str]
-    display_name: str
+    displayName: str
     id: str
     name: str
-    preview_url: Optional[str]
-    updated_at: datetime
+    previewUrl: Optional[str]
+    updatedAt: datetime
 
 
 class ModelWithVersions(Model):
     versions: ResourceCollection[Version]
 
 
-class ProjectPermissionChecks(GraphQLBaseModel):
-    can_create_model: "PermissionCheckResult"
-    can_delete: "PermissionCheckResult"
-    can_load: "PermissionCheckResult"
-    can_publish: "PermissionCheckResult"
-
-
-class Project(GraphQLBaseModel):
-    allow_public_comments: bool
-    created_at: datetime
+class Project(BaseModel):
+    allowPublicComments: bool
+    createdAt: datetime
     description: Optional[str]
     id: str
     name: str
     role: Optional[str]
-    source_apps: List[str]
-    updated_at: datetime
+    sourceApps: List[str]
+    updatedAt: datetime
     visibility: ProjectVisibility
-    workspace_id: Optional[str]
+    workspaceId: Optional[str]
 
 
 class ProjectWithModels(Project):
@@ -177,47 +158,14 @@ class ProjectWithModels(Project):
 
 
 class ProjectWithTeam(Project):
-    invited_team: List[PendingStreamCollaborator]
+    invitedTeam: List[PendingStreamCollaborator]
     team: List[ProjectCollaborator]
 
 
 class ProjectCommentCollection(ResourceCollection[T], Generic[T]):
-    total_archived_count: int
+    totalArchivedCount: int
 
 
-class UserSearchResultCollection(GraphQLBaseModel):
+class UserSearchResultCollection(BaseModel):
     items: List[LimitedUser]
     cursor: Optional[str] = None
-
-
-class PermissionCheckResult(GraphQLBaseModel):
-    authorized: bool
-    code: str
-    message: str
-
-    def ensure_authorised(self) -> None:
-        """Raises WorkspacePermissionException if not authorized"""
-        if not self.authorized:
-            raise WorkspacePermissionException(self.message)
-
-
-class WorkspacePermissionChecks(GraphQLBaseModel):
-    can_create_project: PermissionCheckResult
-
-
-class WorkspaceCreationState(GraphQLBaseModel):
-    completed: bool
-
-
-class Workspace(GraphQLBaseModel):
-    id: str
-    name: str
-    role: Optional[str]
-    slug: str
-    logo: Optional[str]
-    created_at: datetime
-    updated_at: datetime
-    read_only: bool
-    description: Optional[str]
-    creation_state: Optional[WorkspaceCreationState]
-    permissions: WorkspacePermissionChecks

src/specklepy/core/api/models/deprecated.py

@@ -0,0 +1,144 @@
+from datetime import datetime
+from typing import List, Optional
+
+from deprecated import deprecated
+from pydantic import BaseModel, Field
+
+FE1_DEPRECATION_REASON = "Stream/Branch/Commit API is now deprecated, Use the new Project/Model/Version API functions in Client}"
+FE1_DEPRECATION_VERSION = "2.20"
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class Collaborator(BaseModel):
+    id: Optional[str] = None
+    name: Optional[str] = None
+    role: Optional[str] = None
+    avatar: Optional[str] = None
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class Commit(BaseModel):
+    id: Optional[str] = None
+    message: Optional[str] = None
+    authorName: Optional[str] = None
+    authorId: Optional[str] = None
+    authorAvatar: Optional[str] = None
+    branchName: Optional[str] = None
+    createdAt: Optional[datetime] = None
+    sourceApplication: Optional[str] = None
+    referencedObject: Optional[str] = None
+    totalChildrenCount: Optional[int] = None
+    parents: Optional[List[str]] = None
+
+    def __repr__(self) -> str:
+        return (
+            f"Commit( id: {self.id}, message: {self.message}, referencedObject:"
+            f" {self.referencedObject}, authorName: {self.authorName}, branchName:"
+            f" {self.branchName}, createdAt: {self.createdAt} )"
+        )
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class Commits(BaseModel):
+    totalCount: Optional[int] = None
+    cursor: Optional[datetime] = None
+    items: List[Commit] = []
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class Object(BaseModel):
+    id: Optional[str] = None
+    speckleType: Optional[str] = None
+    applicationId: Optional[str] = None
+    totalChildrenCount: Optional[int] = None
+    createdAt: Optional[datetime] = None
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class Branch(BaseModel):
+    id: Optional[str] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+    commits: Optional[Commits] = None
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class Branches(BaseModel):
+    totalCount: Optional[int] = None
+    cursor: Optional[datetime] = None
+    items: List[Branch] = []
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class Stream(BaseModel):
+    id: Optional[str] = None
+    name: Optional[str] = None
+    role: Optional[str] = None
+    isPublic: Optional[bool] = None
+    description: Optional[str] = None
+    createdAt: Optional[datetime] = None
+    updatedAt: Optional[datetime] = None
+    collaborators: List[Collaborator] = Field(default_factory=list)
+    branches: Optional[Branches] = None
+    commit: Optional[Commit] = None
+    object: Optional[Object] = None
+    commentCount: Optional[int] = None
+    favoritedDate: Optional[datetime] = None
+    favoritesCount: Optional[int] = None
+
+    def __repr__(self):
+        return (
+            f"Stream( id: {self.id}, name: {self.name}, description:"
+            f" {self.description}, isPublic: {self.isPublic})"
+        )
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class Streams(BaseModel):
+    totalCount: Optional[int] = None
+    cursor: Optional[datetime] = None
+    items: List[Stream] = []
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class Activity(BaseModel):
+    actionType: Optional[str] = None
+    info: Optional[dict] = None
+    userId: Optional[str] = None
+    streamId: Optional[str] = None
+    resourceId: Optional[str] = None
+    resourceType: Optional[str] = None
+    message: Optional[str] = None
+    time: Optional[datetime] = None
+
+    def __repr__(self) -> str:
+        return (
+            f"Activity( streamId: {self.streamId}, actionType: {self.actionType},"
+            f" message: {self.message}, userId: {self.userId} )"
+        )
+
+    def __str__(self) -> str:
+        return self.__repr__()
+
+
+@deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+class ActivityCollection(BaseModel):
+    totalCount: Optional[int] = None
+    items: Optional[List[Activity]] = None
+    cursor: Optional[datetime] = None
+
+    def __repr__(self) -> str:
+        return (
+            f"ActivityCollection( totalCount: {self.totalCount}, items:"
+            f" {len(self.items) if self.items else 0}, cursor:"
+            f" {self.cursor.isoformat() if self.cursor else None} )"
+        )
+
+    def __str__(self) -> str:
+        return self.__repr__()

src/specklepy/core/api/models/graphql_base_model.py

@@ -1,17 +0,0 @@
-from pydantic import AliasGenerator, BaseModel, ConfigDict
-from pydantic.alias_generators import to_camel
-
-
-class GraphQLBaseModel(BaseModel):
-    """
-    Parent class for all GraphQL Object Model classes
-    Sets-up a pydantic config to serialize properties using a camel case alias
-    """
-
-    model_config = ConfigDict(
-        alias_generator=AliasGenerator(
-            serialization_alias=to_camel,
-            validation_alias=to_camel,
-        ),
-        populate_by_name=True,
-    )

src/specklepy/core/api/models/subscription_messages.py

@@ -1,5 +1,7 @@
 from typing import Optional
 
+from pydantic import BaseModel
+
 from specklepy.core.api.enums import (
     ProjectModelsUpdatedMessageType,
     ProjectUpdatedMessageType,
@@ -7,29 +9,28 @@ from specklepy.core.api.enums import (
     UserProjectsUpdatedMessageType,
 )
 from specklepy.core.api.models.current import Model, Project, Version
-from specklepy.core.api.models.graphql_base_model import GraphQLBaseModel
 
 
-class UserProjectsUpdatedMessage(GraphQLBaseModel):
+class UserProjectsUpdatedMessage(BaseModel):
     id: str
     type: UserProjectsUpdatedMessageType
     project: Optional[Project]
 
 
-class ProjectModelsUpdatedMessage(GraphQLBaseModel):
+class ProjectModelsUpdatedMessage(BaseModel):
     id: str
     type: ProjectModelsUpdatedMessageType
     model: Optional[Model]
 
 
-class ProjectUpdatedMessage(GraphQLBaseModel):
+class ProjectUpdatedMessage(BaseModel):
     id: str
     type: ProjectUpdatedMessageType
     project: Optional[Project]
 
 
-class ProjectVersionsUpdatedMessage(GraphQLBaseModel):
+class ProjectVersionsUpdatedMessage(BaseModel):
     id: str
     type: ProjectVersionsUpdatedMessageType
-    model_id: str
+    modelId: Optional[str]
     version: Optional[Version]

src/specklepy/core/api/operations.py

@@ -70,8 +70,7 @@ def receive(
 
     serializer = BaseObjectSerializer(read_transport=local_transport)
 
-    # try local transport first. if the parent is there, we assume all the children
-    # are there and continue with deserialization using the local transport
+    # try local transport first. if the parent is there, we assume all the children are there and continue with deserialization using the local transport
     obj_string = local_transport.get_object(obj_id)
     if obj_string:
         return serializer.read_json(obj_string=obj_string)
@@ -91,9 +90,7 @@ def receive(
     return serializer.read_json(obj_string=obj_string)
 
 
-def serialize(
-    base: Base, write_transports: List[AbstractTransport] | None = None
-) -> str:
+def serialize(base: Base, write_transports: List[AbstractTransport] = []) -> str:
     """
     Serialize a base object. If no write transports are provided,
     the object will be serialized
@@ -107,8 +104,6 @@ def serialize(
     Returns:
         str -- the serialized object
     """
-    if not write_transports:
-        write_transports = []
     serializer = BaseObjectSerializer(write_transports=write_transports)
 
     return serializer.write_json(base)[1]

src/specklepy/core/api/resource.py

@@ -18,7 +18,7 @@ from specklepy.transports.sqlite import SQLiteTransport
 T = TypeVar("T", bound=BaseModel)
 
 
-class ResourceBase:
+class ResourceBase(object):
     def __init__(
         self,
         account: Account,
@@ -101,8 +101,7 @@ class ResourceBase:
         parse_response: bool = True,
     ) -> Any:
         """Executes the GraphQL query"""
-        # This method has quite complex and ambiguous typing,
-        # and counter-intuitive error handling
+        # This method has quite complex and ambiguous typing, and counter-intuitive error handling
         # We are going to phase it out in favour of `make_request_and_parse_response`
         try:
             with self.__lock:

src/specklepy/core/api/resources/__init__.py

@@ -10,7 +10,17 @@ from specklepy.core.api.resources.current.subscription_resource import (
     SubscriptionResource,
 )
 from specklepy.core.api.resources.current.version_resource import VersionResource
-from specklepy.core.api.resources.current.workspace_resource import WorkspaceResource
+from specklepy.core.api.resources.deprecated import (
+    active_user,
+    branch,
+    commit,
+    object,
+    other_user,
+    server,
+    stream,
+    subscriptions,
+    user,
+)
 
 __all__ = [
     "ActiveUserResource",
@@ -21,5 +31,13 @@ __all__ = [
     "ServerResource",
     "SubscriptionResource",
     "VersionResource",
-    "WorkspaceResource",
+    "active_user",
+    "branch",
+    "commit",
+    "object",
+    "other_user",
+    "server",
+    "stream",
+    "subscriptions",
+    "user",
 ]

src/specklepy/core/api/resources/current/active_user_resource.py

@@ -1,19 +1,21 @@
-from typing import List, Optional
+from datetime import datetime, timezone
+from typing import List, Optional, overload
 
+from deprecated import deprecated
 from gql import gql
 
-from specklepy.core.api.inputs.user_inputs import (
-    UserProjectsFilter,
-    UserUpdateInput,
-    UserWorkspacesFilter,
-)
+from specklepy.core.api.inputs.user_inputs import UserProjectsFilter, UserUpdateInput
 from specklepy.core.api.models import (
+    ActivityCollection,
     PendingStreamCollaborator,
     Project,
     ResourceCollection,
     User,
 )
-from specklepy.core.api.models.current import PermissionCheckResult, Workspace
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
 from specklepy.core.api.resource import ResourceBase
 from specklepy.core.api.responses import DataResponse
 from specklepy.logging.exceptions import GraphQLException
@@ -35,12 +37,10 @@ class ActiveUserResource(ResourceBase):
         self.schema = User
 
     def get(self) -> Optional[User]:
-        """Gets the currently active user profile
-        (as extracted from the authorization header)
+        """Gets the currently active user profile (as extracted from the authorization header)
 
         Returns:
-            User -- the requested user, or none if no authentication token
-            is provided to the Client
+            User -- the requested user, or none if no authentication token is provided to the Client
         """
         QUERY = gql(
             """
@@ -65,7 +65,7 @@ class ActiveUserResource(ResourceBase):
             DataResponse[Optional[User]], QUERY, variables
         ).data
 
-    def update(self, input: UserUpdateInput) -> User:
+    def _update(self, input: UserUpdateInput) -> User:
         QUERY = gql(
             """
             mutation ActiveUserMutations($input: UserUpdateInput!) {
@@ -85,12 +85,46 @@ class ActiveUserResource(ResourceBase):
            """
         )
 
-        variables = {"input": input.model_dump(warnings="error", by_alias=True)}
+        variables = {"input": input.model_dump(warnings="error")}
 
         return self.make_request_and_parse_response(
             DataResponse[DataResponse[User]], QUERY, variables
         ).data.data
 
+    @deprecated("Use UserUpdateInput overload", version=FE1_DEPRECATION_VERSION)
+    @overload
+    def update(
+        self,
+        name: Optional[str] = None,
+        company: Optional[str] = None,
+        bio: Optional[str] = None,
+        avatar: Optional[str] = None,
+    ) -> User: ...
+
+    @overload
+    def update(self, *, input: UserUpdateInput) -> User: ...
+
+    def update(
+        self,
+        name: Optional[str] = None,
+        company: Optional[str] = None,
+        bio: Optional[str] = None,
+        avatar: Optional[str] = None,
+        *,
+        input: Optional[UserUpdateInput] = None,
+    ) -> User:
+        if isinstance(input, UserUpdateInput):
+            return self._update(input=input)
+        else:
+            return self._update(
+                input=UserUpdateInput(
+                    name=name,
+                    company=company,
+                    bio=bio,
+                    avatar=avatar,
+                )
+            )
+
     def get_projects(
         self,
         *,
@@ -126,9 +160,7 @@ class ActiveUserResource(ResourceBase):
         variables = {
             "limit": limit,
             "cursor": cursor,
-            "filter": filter.model_dump(warnings="error", by_alias=True)
-            if filter
-            else None,
+            "filter": filter.model_dump(warnings="error") if filter else None,
         }
 
         response = self.make_request_and_parse_response(
@@ -196,145 +228,183 @@ class ActiveUserResource(ResourceBase):
 
         return response.data.data
 
-    def can_create_personal_projects(self) -> PermissionCheckResult:
-        QUERY = gql(
-            """
-            query CanCreatePersonalProject {
-              data:activeUser {
-                data:permissions {
-                  data:canCreatePersonalProject {
-                    authorized
-                    code
-                    message
-                  }
-                }
-              }
-            }
-            """
-        )
-
-        response = self.make_request_and_parse_response(
-            DataResponse[Optional[DataResponse[DataResponse[PermissionCheckResult]]]],
-            QUERY,
-        )
-
-        if response.data is None:
-            raise GraphQLException(
-                "GraphQL response indicated that the ActiveUser could not be found"
-            )
-
-        return response.data.data.data
-
-    def get_workspaces(
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def activity(
         self,
-        limit: int = 25,
-        cursor: Optional[str] = None,
-        filter: Optional[UserWorkspacesFilter] = None,
-    ) -> ResourceCollection[Workspace]:
+        limit: int = 20,
+        action_type: Optional[str] = None,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ) -> ActivityCollection:
         """
-        This feature is only available on Workspace enabled servers  (server versions
-        >=2.23.17) e.g. app.speckle.systems
+        Get the activity from a given stream in an Activity collection.
+        Step into the activity `items` for the list of activity.
+        If no id argument is provided, will return the current authenticated user's
+        activity (as extracted from the authorization header).
+
+        Note: all timestamps arguments should be `datetime` of any tz as they will be
+        converted to UTC ISO format strings
+
+        user_id {str} -- the id of the user to get the activity from
+        action_type {str} -- filter results to a single action type
+            (eg: `commit_create` or `commit_receive`)
+        limit {int} -- max number of Activity items to return
+        before {datetime} -- latest cutoff for activity
+            (ie: return all activity _before_ this time)
+        after {datetime} -- oldest cutoff for activity
+            (ie: return all activity _after_ this time)
+        cursor {datetime} -- timestamp cursor for pagination
         """
-        QUERY = gql(
+
+        query = gql(
             """
-            query ActiveUser($limit: Int!, $cursor: String, $filter: UserWorkspacesFilter) {
-              data:activeUser {
-                data:workspaces(limit: $limit, cursor: $cursor, filter: $filter) {
-                  cursor
-                  totalCount
-                  items {
-                    id
-                    name
-                    role
-                    slug
-                    logo
-                    createdAt
-                    updatedAt
-                    readOnly
-                    description
-                    creationState
-                    {
-                      completed
+            query UserActivity(
+                $action_type: String,
+                $before:DateTime,
+                $after: DateTime,
+                $cursor: DateTime,
+                $limit: Int
+                ){
+                activeUser {
+                    activity(
+                        actionType: $action_type,
+                        before: $before,
+                        after: $after,
+                        cursor: $cursor,
+                        limit: $limit
+                        ) {
+                        totalCount
+                        cursor
+                        items {
+                            actionType
+                            info
+                            userId
+                            streamId
+                            resourceId
+                            resourceType
+                            message
+                            time
+                        }
                     }
-                    permissions {
-                      canCreateProject {
-                        authorized
-                        code
-                        message
-                      }
-                    }
-                  }
                 }
-              }
             }
-            """  # noqa: E501
+            """
         )
 
-        variables = {
+        params = {
             "limit": limit,
-            "cursor": cursor,
-            "filter": filter.model_dump(warnings="error", by_alias=True)
-            if filter
-            else None,
+            "action_type": action_type,
+            "before": before.astimezone(timezone.utc).isoformat() if before else before,
+            "after": after.astimezone(timezone.utc).isoformat() if after else after,
+            "cursor": cursor.astimezone(timezone.utc).isoformat() if cursor else cursor,
         }
 
-        response = self.make_request_and_parse_response(
-            DataResponse[Optional[DataResponse[ResourceCollection[Workspace]]]],
-            QUERY,
-            variables,
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["activeUser", "activity"],
+            schema=ActivityCollection,
         )
 
-        if response.data is None:
-            raise GraphQLException(
-                "GraphQL response indicated that the ActiveUser could not be found"
-            )
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get_all_pending_invites(self) -> List[PendingStreamCollaborator]:
+        """Get all of the active user's pending stream invites
 
-        return response.data.data
+        Requires Speckle Server version >= 2.6.4
 
-    def get_active_workspace(self) -> Optional[Workspace]:
+        Returns:
+            List[PendingStreamCollaborator]
+            -- a list of pending invites for the current user
         """
-        This feature is only available on Workspace enabled servers  (server versions
-        >=2.23.17) e.g. app.speckle.systems
-        """
-        QUERY = gql(
+        self._check_invites_supported()
+
+        query = gql(
             """
-            query ActiveUser {
-              data:activeUser {
-                data:activeWorkspace {
-                  id
-                  name
-                  role
-                  slug
-                  logo
-                  createdAt
-                  updatedAt
-                  readOnly
-                  description
-                  creationState
-                  {
-                    completed
-                  }
-                  permissions {
-                    canCreateProject {
-                      authorized
-                      code
-                      message
+            query StreamInvites {
+                streamInvites{
+                    id
+                    token
+                    inviteId
+                    streamId
+                    streamName
+                    projectId
+                    projectName
+                    title
+                    role
+                    invitedBy {
+                        id
+                        name
+                        bio
+                        company
+                        avatar
+                        verified
+                        role
                     }
-                  }
                 }
-              }
             }
-            """  # noqa: E501
+            """
         )
 
-        response = self.make_request_and_parse_response(
-            DataResponse[Optional[DataResponse[Optional[Workspace]]]],
-            QUERY,
+        return self.make_request(
+            query=query,
+            return_type="streamInvites",
+            schema=PendingStreamCollaborator,
         )
 
-        if response.data is None:
-            raise GraphQLException(
-                "GraphQL response indicated that the ActiveUser could not be found"
-            )
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get_pending_invite(
+        self, stream_id: str, token: Optional[str] = None
+    ) -> Optional[PendingStreamCollaborator]:
+        """Get a particular pending invite for the active user on a given stream.
+        If no invite_id is provided, any valid invite will be returned.
 
-        return response.data.data
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to look for invites on
+            token {str} -- the token of the invite to look for (optional)
+
+        Returns:
+            PendingStreamCollaborator
+            -- the invite for the given stream (or None if it isn't found)
+        """
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            query StreamInvite($streamId: String!, $token: String) {
+                streamInvite(streamId: $streamId, token: $token) {
+                    id
+                    token
+                    inviteId
+                    streamId
+                    streamName
+                    projectId
+                    projectName
+                    title
+                    role
+                    invitedBy {
+                        id
+                        name
+                        bio
+                        company
+                        avatar
+                        verified
+                        role
+                    }
+                }
+            }
+            """
+        )
+
+        params = {"streamId": stream_id}
+        if token:
+            params["token"] = token
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInvite",
+            schema=PendingStreamCollaborator,
+        )

src/specklepy/core/api/resources/current/model_resource.py

@@ -76,24 +76,14 @@ class ModelResource(ResourceBase):
     ) -> ModelWithVersions:
         QUERY = gql(
             """
-            query ModelGetWithVersions(
-              $modelId: String!,
-              $projectId: String!,
-              $versionsLimit: Int!,
-              $versionsCursor: String,
-              $versionsFilter: ModelVersionsFilter
-              ) {
+            query ModelGetWithVersions($modelId: String!, $projectId: String!, $versionsLimit: Int!, $versionsCursor: String, $versionsFilter: ModelVersionsFilter) {
               data:project(id: $projectId) {
                 data:model(id: $modelId) {
                   id
                   name
                   previewUrl
                   updatedAt
-                  versions(
-                    limit: $versionsLimit,
-                    cursor: $versionsCursor,
-                    filter: $versionsFilter
-                    ) {
+                  versions(limit: $versionsLimit, cursor: $versionsCursor, filter: $versionsFilter) {
                     items {
                       id
                       referencedObject
@@ -138,7 +128,7 @@ class ModelResource(ResourceBase):
             "versionsLimit": versions_limit,
             "versionsCursor": versions_cursor,
             "versionsFilter": (
-                versions_filter.model_dump(warnings="error", by_alias=True)
+                versions_filter.model_dump(warnings="error")
                 if versions_filter
                 else None
             ),
@@ -158,18 +148,9 @@ class ModelResource(ResourceBase):
     ) -> ResourceCollection[Model]:
         QUERY = gql(
             """
-            query ProjectGetWithModels(
-              $projectId: String!,
-              $modelsLimit: Int!,
-              $modelsCursor: String,
-              $modelsFilter: ProjectModelsFilter
-              ) {
+            query ProjectGetWithModels($projectId: String!, $modelsLimit: Int!, $modelsCursor: String, $modelsFilter: ProjectModelsFilter) {
               data:project(id: $projectId) {
-                data:models(
-                  limit: $modelsLimit,
-                  cursor: $modelsCursor,
-                  filter: $modelsFilter
-                  ) {
+                data:models(limit: $modelsLimit, cursor: $modelsCursor, filter: $modelsFilter) {
                   items {
                     id
                     name
@@ -201,9 +182,7 @@ class ModelResource(ResourceBase):
             "modelsLimit": models_limit,
             "modelsCursor": models_cursor,
             "modelsFilter": (
-                models_filter.model_dump(warnings="error", by_alias=True)
-                if models_filter
-                else None
+                models_filter.model_dump(warnings="error") if models_filter else None
             ),
         }
 
@@ -240,7 +219,7 @@ class ModelResource(ResourceBase):
         )
 
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(
@@ -258,7 +237,7 @@ class ModelResource(ResourceBase):
             """
         )
 
-        variables = {"input": input.model_dump(warnings="error", by_alias=True)}
+        variables = {"input": input.model_dump(warnings="error")}
 
         return self.make_request_and_parse_response(
             DataResponse[DataResponse[bool]], QUERY, variables
@@ -293,7 +272,7 @@ class ModelResource(ResourceBase):
         )
 
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(

src/specklepy/core/api/resources/current/other_user_resource.py

@@ -1,13 +1,21 @@
-from typing import Optional
+from datetime import datetime, timezone
+from typing import List, Optional, Union
 
+from deprecated import deprecated
 from gql import gql
 
 from specklepy.core.api.models import (
+    ActivityCollection,
     LimitedUser,
     UserSearchResultCollection,
 )
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
 from specklepy.core.api.resource import ResourceBase
 from specklepy.core.api.responses import DataResponse
+from specklepy.logging.exceptions import SpeckleException
 
 NAME = "other_user"
 
@@ -66,9 +74,7 @@ class OtherUserResource(ResourceBase):
         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
+        """Searches for a user on the server, by name or email. The search query must be at least
         3 characters long
 
         Arguments:
@@ -83,20 +89,8 @@ class OtherUserResource(ResourceBase):
 
         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
-                ) {
+            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
@@ -122,3 +116,124 @@ class OtherUserResource(ResourceBase):
         return self.make_request_and_parse_response(
             DataResponse[UserSearchResultCollection], QUERY, variables
         ).data
+
+    @deprecated(reason="Use user_search instead", version=FE1_DEPRECATION_VERSION)
+    def search(
+        self, search_query: str, limit: int = 25
+    ) -> Union[List[LimitedUser], SpeckleException]:
+        """Searches for user 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
+        Returns:
+            List[LimitedUser] -- a list of User objects that match the search query
+        """
+        if len(search_query) < 3:
+            return SpeckleException(
+                message="User search query must be at least 3 characters"
+            )
+
+        query = gql(
+            """
+            query UserSearch($search_query: String!, $limit: Int!) {
+                userSearch(query: $search_query, limit: $limit) {
+                    items {
+                      id
+                      name
+                      bio
+                      company
+                      avatar
+                      verified
+                      role
+                    }
+                }
+            }
+          """
+        )
+        params = {"search_query": search_query, "limit": limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["userSearch", "items"]
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def activity(
+        self,
+        user_id: str,
+        limit: int = 20,
+        action_type: Optional[str] = None,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ) -> ActivityCollection:
+        """
+        Get the activity from a given stream in an Activity collection.
+        Step into the activity `items` for the list of activity.
+
+        Note: all timestamps arguments should be `datetime` of
+        any tz as they will be converted to UTC ISO format strings
+
+        user_id {str} -- the id of the user to get the activity from
+        action_type {str} -- filter results to a single action type
+            (eg: `commit_create` or `commit_receive`)
+        limit {int} -- max number of Activity items to return
+        before {datetime} -- latest cutoff for activity
+            (ie: return all activity _before_ this time)
+        after {datetime} -- oldest cutoff for activity
+            (ie: return all activity _after_ this time)
+        cursor {datetime} -- timestamp cursor for pagination
+        """
+
+        query = gql(
+            """
+            query UserActivity(
+                $user_id: String!,
+                $action_type: String,
+                $before:DateTime,
+                $after: DateTime,
+                $cursor: DateTime,
+                $limit: Int
+                ){
+                otherUser(id: $user_id) {
+                    activity(
+                        actionType: $action_type,
+                        before: $before,
+                        after: $after,
+                        cursor: $cursor,
+                        limit: $limit
+                        ) {
+                        totalCount
+                        cursor
+                        items {
+                            actionType
+                            info
+                            userId
+                            streamId
+                            resourceId
+                            resourceType
+                            message
+                            time
+                        }
+                    }
+                }
+            }
+            """
+        )
+
+        params = {
+            "user_id": user_id,
+            "limit": limit,
+            "action_type": action_type,
+            "before": before.astimezone(timezone.utc).isoformat() if before else before,
+            "after": after.astimezone(timezone.utc).isoformat() if after else after,
+            "cursor": cursor.astimezone(timezone.utc).isoformat() if cursor else cursor,
+        }
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["otherUser", "activity"],
+            schema=ActivityCollection,
+        )

src/specklepy/core/api/resources/current/project_invite_resource.py

@@ -37,10 +37,7 @@ class ProjectInviteResource(ResourceBase):
     ) -> ProjectWithTeam:
         QUERY = gql(
             """
-            mutation ProjectInviteCreate(
-              $projectId: ID!,
-              $input: ProjectInviteCreateInput!
-              ) {
+            mutation ProjectInviteCreate($projectId: ID!, $input: ProjectInviteCreateInput!) {
               data:projectMutations {
                 data:invites {
                   data:create(projectId: $projectId, input: $input) {
@@ -103,7 +100,7 @@ class ProjectInviteResource(ResourceBase):
 
         variables = {
             "projectId": project_id,
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(
@@ -124,7 +121,7 @@ class ProjectInviteResource(ResourceBase):
         )
 
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(

src/specklepy/core/api/resources/current/project_resource.py

@@ -7,10 +7,8 @@ from specklepy.core.api.inputs.project_inputs import (
     ProjectModelsFilter,
     ProjectUpdateInput,
     ProjectUpdateRoleInput,
-    WorkspaceProjectCreateInput,
 )
 from specklepy.core.api.models import Project, ProjectWithModels, ProjectWithTeam
-from specklepy.core.api.models.current import ProjectPermissionChecks
 from specklepy.core.api.resource import ResourceBase
 from specklepy.core.api.responses import DataResponse
 
@@ -57,46 +55,6 @@ class ProjectResource(ResourceBase):
             DataResponse[Project], QUERY, variables
         ).data
 
-    def get_permissions(self, project_id: str) -> ProjectPermissionChecks:
-        QUERY = gql(
-            """
-            query Project($projectId: String!) {
-              data:project(id: $projectId) {
-                data:permissions {
-                  canCreateModel {
-                    authorized
-                    code
-                    message
-                  }
-                  canDelete {
-                    authorized
-                    code
-                    message
-                  }
-                  canLoad {
-                    authorized
-                    code
-                    message
-                  }
-                  canPublish {
-                    authorized
-                    code
-                    message
-                  }
-                }
-              }
-            }
-            """
-        )
-
-        variables = {
-            "projectId": project_id,
-        }
-
-        return self.make_request_and_parse_response(
-            DataResponse[DataResponse[ProjectPermissionChecks]], QUERY, variables
-        ).data.data
-
     def get_with_models(
         self,
         project_id: str,
@@ -107,12 +65,7 @@ class ProjectResource(ResourceBase):
     ) -> ProjectWithModels:
         QUERY = gql(
             """
-            query ProjectGetWithModels(
-              $projectId: String!,
-              $modelsLimit: Int!,
-              $modelsCursor: String,
-              $modelsFilter: ProjectModelsFilter
-              ) {
+            query ProjectGetWithModels($projectId: String!, $modelsLimit: Int!, $modelsCursor: String, $modelsFilter: ProjectModelsFilter) {
               data:project(id: $projectId) {
                 id
                 name
@@ -124,11 +77,7 @@ class ProjectResource(ResourceBase):
                 updatedAt
                 sourceApps
                 workspaceId
-                models(
-                  limit: $modelsLimit,
-                  cursor: $modelsCursor,
-                  filter: $modelsFilter
-                  ) {
+                models(limit: $modelsLimit, cursor: $modelsCursor, filter: $modelsFilter) {
                   items {
                     id
                     name
@@ -160,9 +109,7 @@ class ProjectResource(ResourceBase):
             "modelsLimit": models_limit,
             "modelsCursor": models_cursor,
             "modelsFilter": (
-                models_filter.model_dump(warnings="error", by_alias=True)
-                if models_filter
-                else None
+                models_filter.model_dump(warnings="error") if models_filter else None
             ),
         }
 
@@ -240,12 +187,6 @@ class ProjectResource(ResourceBase):
         ).data
 
     def create(self, input: ProjectCreateInput) -> Project:
-        """
-        Creates a non-workspace project (aka Personal Project)
-
-        see client.active_user.can_create_personal_projects to see if the user has
-        permission
-        """
         QUERY = gql(
             """
             mutation ProjectCreate($input: ProjectCreateInput) {
@@ -268,52 +209,13 @@ class ProjectResource(ResourceBase):
         )
 
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(
             DataResponse[DataResponse[Project]], QUERY, variables
         ).data.data
 
-    def create_in_workspace(self, input: WorkspaceProjectCreateInput) -> Project:
-        """
-        Creates a workspace project
-        This feature is only supported by Workspace Enabled Servers
-        (e.g. app.speckle.systems)
-
-        see `workspace.permissions.can_create_project` to see if the user has permission
-        """
-        QUERY = gql(
-            """
-          mutation WorkspaceProjectCreate($input: WorkspaceProjectCreateInput!) {
-            data:workspaceMutations {
-              data:projects {
-                data:create(input: $input) {
-                  id
-                  name
-                  description
-                  visibility
-                  allowPublicComments
-                  role
-                  createdAt
-                  updatedAt
-                  sourceApps
-                  workspaceId
-                }
-              }
-            }
-          }
-          """
-        )
-
-        variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
-        }
-
-        return self.make_request_and_parse_response(
-            DataResponse[DataResponse[DataResponse[Project]]], QUERY, variables
-        ).data.data.data
-
     def update(self, input: ProjectUpdateInput) -> Project:
         QUERY = gql(
             """
@@ -337,7 +239,7 @@ class ProjectResource(ResourceBase):
         )
 
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(
@@ -426,7 +328,7 @@ class ProjectResource(ResourceBase):
         )
 
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(

src/specklepy/core/api/resources/current/server_resource.py

@@ -1,6 +1,7 @@
 import re
 from typing import Any, Dict, List, Tuple
 
+import requests
 from gql import gql
 
 from specklepy.core.api.models import ServerInfo
@@ -37,6 +38,11 @@ class ServerResource(ResourceBase):
                     adminContact
                     canonicalUrl
                     version
+                    roles {
+                        name
+                        description
+                        resourceTarget
+                    }
                     scopes {
                         name
                         description
@@ -46,9 +52,6 @@ class ServerResource(ResourceBase):
                         name
                         icon
                     }
-                    workspaces {
-                      workspacesEnabled
-                    }
                 }
             }
             """
@@ -57,6 +60,16 @@ class ServerResource(ResourceBase):
         server_info = self.make_request(
             query=query, return_type="serverInfo", schema=ServerInfo
         )
+        if isinstance(server_info, ServerInfo) and isinstance(
+            server_info.canonicalUrl, str
+        ):
+            r = requests.get(
+                server_info.canonicalUrl, headers={"User-Agent": "specklepy SDK"}
+            )
+            if "x-speckle-frontend-2" in r.headers:
+                server_info.frontend2 = True
+            else:
+                server_info.frontend2 = False
 
         return server_info
 
@@ -67,8 +80,7 @@ class ServerResource(ResourceBase):
             the server version in the format (major, minor, patch, (tag, build))
             eg (2, 6, 3) for a stable build and (2, 6, 4, 'alpha', 4711) for alpha
         """
-        # not tracking as it will be called along with other mutations / queries
-        # as a check
+        # not tracking as it will be called along with other mutations / queries as a check
         query = gql(
             """
             query Server {

src/specklepy/core/api/resources/current/version_resource.py

@@ -76,13 +76,7 @@ class VersionResource(ResourceBase):
     ) -> ResourceCollection[Version]:
         QUERY = gql(
             """
-            query VersionGetVersions(
-              $projectId: String!,
-              $modelId: String!,
-              $limit: Int!,
-              $cursor: String,
-              $filter: ModelVersionsFilter
-              ) {
+            query VersionGetVersions($projectId: String!, $modelId: String!, $limit: Int!, $cursor: String, $filter: ModelVersionsFilter) {
               data:project(id: $projectId) {
                 data:model(id: $modelId) {
                   data:versions(limit: $limit, cursor: $cursor, filter: $filter) {
@@ -117,9 +111,7 @@ class VersionResource(ResourceBase):
             "modelId": model_id,
             "limit": limit,
             "cursor": cursor,
-            "filter": (
-                filter.model_dump(warnings="error", by_alias=True) if filter else None
-            ),
+            "filter": filter.model_dump(warnings="error") if filter else None,
         }
 
         return self.make_request_and_parse_response(
@@ -128,39 +120,26 @@ class VersionResource(ResourceBase):
             variables,
         ).data.data.data
 
-    def create(self, input: CreateVersionInput) -> Version:
+    def create(self, input: CreateVersionInput) -> str:
         QUERY = gql(
             """
             mutation Create($input: CreateVersionInput!) {
               data:versionMutations {
                 data:create(input: $input) {
-                  id
-                  referencedObject
-                  message
-                  sourceApplication
-                  createdAt
-                  previewUrl
-                  authorUser {
-                    id
-                    name
-                    bio
-                    company
-                    verified
-                    role
-                    avatar
-                  }
+                  data:id
                 }
               }
             }
             """
         )
+
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(
-            DataResponse[DataResponse[Version]], QUERY, variables
-        ).data.data
+            DataResponse[DataResponse[DataResponse[str]]], QUERY, variables
+        ).data.data.data
 
     def update(self, input: UpdateVersionInput) -> Version:
         QUERY = gql(
@@ -189,7 +168,7 @@ class VersionResource(ResourceBase):
             """
         )
 
-        variables = {"input": input.model_dump(warnings="error", by_alias=True)}
+        variables = {"input": input.model_dump(warnings="error")}
 
         return self.make_request_and_parse_response(
             DataResponse[DataResponse[Version]], QUERY, variables
@@ -209,7 +188,7 @@ class VersionResource(ResourceBase):
         )
 
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(
@@ -228,7 +207,7 @@ class VersionResource(ResourceBase):
         )
 
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(
@@ -247,7 +226,7 @@ class VersionResource(ResourceBase):
         )
 
         variables = {
-            "input": input.model_dump(warnings="error", by_alias=True),
+            "input": input.model_dump(warnings="error"),
         }
 
         return self.make_request_and_parse_response(

src/specklepy/core/api/resources/current/workspace_resource.py

@@ -1,106 +0,0 @@
-from typing import Optional
-
-from gql import gql
-
-from specklepy.core.api.inputs.project_inputs import WorksaceProjectsFilter
-from specklepy.core.api.models.current import Project, ResourceCollection, Workspace
-from specklepy.core.api.resource import ResourceBase
-from specklepy.core.api.responses import DataResponse
-
-NAME = "workspace"
-
-
-class WorkspaceResource(ResourceBase):
-    """API Access class for models"""
-
-    def __init__(self, account, basepath, client, server_version) -> None:
-        super().__init__(
-            account=account,
-            basepath=basepath,
-            client=client,
-            name=NAME,
-            server_version=server_version,
-        )
-
-    def get(self, workspace_id: str) -> Workspace:
-        QUERY = gql(
-            """
-            query WorkspaceGet($workspaceId: String!) {
-              data:workspace(id: $workspaceId) {
-                id
-                name
-                role
-                slug
-                logo
-                createdAt
-                updatedAt
-                readOnly
-                description
-                creationState
-                {
-                  completed
-                }
-                permissions {
-                  canCreateProject {
-                    authorized
-                    code
-                    message
-                  }
-                }
-              }
-            }
-            """
-        )
-
-        variables = {
-            "workspaceId": workspace_id,
-        }
-
-        return self.make_request_and_parse_response(
-            DataResponse[Workspace], QUERY, variables
-        ).data
-
-    def get_projects(
-        self,
-        workspace_id: str,
-        limit: int = 25,
-        cursor: Optional[str] = None,
-        filter: Optional[WorksaceProjectsFilter] = None,
-    ) -> ResourceCollection[Project]:
-        QUERY = gql(
-            """
-            query Workspace($workspaceId: String!, $limit: Int!, $cursor: String, $filter: WorkspaceProjectsFilter) {
-              data:workspace(id: $workspaceId) {
-                data:projects(limit: $limit, cursor: $cursor, filter: $filter) {
-                  cursor
-                  items {
-                    allowPublicComments
-                    createdAt
-                    description
-                    id
-                    name
-                    role
-                    sourceApps
-                    updatedAt
-                    visibility
-                    workspaceId
-                  }
-                  totalCount
-                }
-              }
-            }
-            """  # noqa: E501
-        )
-
-        variables = {
-            "workspaceId": workspace_id,
-            "limit": limit,
-            "cursor": cursor,
-            "filter": filter.model_dump(warnings="error", by_alias=True)
-            if filter
-            else None,
-        }
-
-        return self.make_request_and_parse_response(
-            DataResponse[DataResponse[ResourceCollection[Project]]], QUERY, variables
-        ).data.data

src/specklepy/core/api/resources/deprecated/active_user.py

@@ -0,0 +1,15 @@
+from deprecated import deprecated
+
+from specklepy.core.api.models.deprecated import FE1_DEPRECATION_VERSION
+from specklepy.core.api.resources import ActiveUserResource
+
+
+@deprecated(
+    reason="Class renamed to ActiveUserResource", version=FE1_DEPRECATION_VERSION
+)
+class Resource(ActiveUserResource):
+    """
+    Class renamed to ActiveUserResource
+    """
+
+    pass

src/specklepy/core/api/resources/deprecated/branch.py

@@ -0,0 +1,235 @@
+from typing import Optional
+
+from deprecated import deprecated
+from gql import gql
+
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+    Branch,
+)
+from specklepy.core.api.resource import ResourceBase
+from specklepy.logging.exceptions import SpeckleException
+
+NAME = "branch"
+
+
+class Resource(ResourceBase):
+    """
+    API Access class for branches
+    Branch resource is deprecated, please use model resource instead
+    """
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+        )
+        self.schema = Branch
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def create(
+        self, stream_id: str, name: str, description: str = "No description provided"
+    ) -> str:
+        """Create a new branch on this stream
+
+        Arguments:
+            name {str} -- the name of the new branch
+            description {str} -- a short description of the branch
+
+        Returns:
+            id {str} -- the newly created branch's id
+        """
+        query = gql(
+            """
+            mutation BranchCreate($branch: BranchCreateInput!) {
+              branchCreate(branch: $branch)
+            }
+          """
+        )
+        if len(name) < 3:
+            return SpeckleException(message="Branch Name must be at least 3 characters")
+        params = {
+            "branch": {
+                "streamId": stream_id,
+                "name": name,
+                "description": description,
+            }
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type="branchCreate", parse_response=False
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get(self, stream_id: str, name: str, commits_limit: int = 10):
+        """Get a branch by name from a stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to get the branch from
+            name {str} -- the name of the branch to get
+            commits_limit {int} -- maximum number of commits to get
+
+        Returns:
+            Branch -- the fetched branch with its latest commits
+        """
+        query = gql(
+            """
+            query BranchGet($stream_id: String!, $name: String!, $commits_limit: Int!) {
+                stream(id: $stream_id) {
+                        branch(name: $name) {
+                          id,
+                          name,
+                          description,
+                          commits (limit: $commits_limit) {
+                            totalCount,
+                            cursor,
+                            items {
+                              id,
+                              referencedObject,
+                              sourceApplication,
+                              totalChildrenCount,
+                              message,
+                              authorName,
+                              authorId,
+                              branchName,
+                              parents,
+                              createdAt
+                            }
+                        }
+                    }
+                }
+            }
+            """
+        )
+
+        params = {"stream_id": stream_id, "name": name, "commits_limit": commits_limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "branch"]
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def list(self, stream_id: str, branches_limit: int = 10, commits_limit: int = 10):
+        """Get a list of branches from a given stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to get the branches from
+            branches_limit {int} -- maximum number of branches to get
+            commits_limit {int} -- maximum number of commits to get
+
+        Returns:
+            List[Branch] -- the branches on the stream
+        """
+        query = gql(
+            """
+            query BranchesGet(
+                    $stream_id: String!,
+                    $branches_limit: Int!,
+                    $commits_limit: Int!
+                ) {
+                stream(id: $stream_id) {
+                    branches(limit: $branches_limit) {
+                        items {
+                            id
+                            name
+                            description
+                            commits(limit: $commits_limit) {
+                                totalCount
+                                items{
+                                    id
+                                    message
+                                    referencedObject
+                                    sourceApplication
+                                    parents
+                                    authorId
+                                    authorName
+                                    branchName
+                                    createdAt
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+            """
+        )
+
+        params = {
+            "stream_id": stream_id,
+            "branches_limit": branches_limit,
+            "commits_limit": commits_limit,
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "branches", "items"]
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def update(
+        self,
+        stream_id: str,
+        branch_id: str,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
+    ):
+        """Update a branch
+
+        Arguments:
+            stream_id {str} -- the id of the stream containing the branch to update
+            branch_id {str} -- the id of the branch to update
+            name {str} -- optional: the updated branch name
+            description {str} -- optional: the updated branch description
+
+        Returns:
+            bool -- True if update is successful
+        """
+        query = gql(
+            """
+            mutation  BranchUpdate($branch: BranchUpdateInput!) {
+                branchUpdate(branch: $branch)
+                }
+            """
+        )
+        params = {
+            "branch": {
+                "streamId": stream_id,
+                "id": branch_id,
+            }
+        }
+
+        if name:
+            params["branch"]["name"] = name
+        if description:
+            params["branch"]["description"] = description
+
+        return self.make_request(
+            query=query, params=params, return_type="branchUpdate", parse_response=False
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def delete(self, stream_id: str, branch_id: str):
+        """Delete a branch
+
+        Arguments:
+            stream_id {str} -- the id of the stream containing the branch to delete
+            branch_id {str} -- the branch to delete
+
+        Returns:
+            bool -- True if deletion is successful
+        """
+        query = gql(
+            """
+            mutation BranchDelete($branch: BranchDeleteInput!) {
+                branchDelete(branch: $branch)
+            }
+            """
+        )
+
+        params = {"branch": {"streamId": stream_id, "id": branch_id}}
+
+        return self.make_request(
+            query=query, params=params, return_type="branchDelete", parse_response=False
+        )

src/specklepy/core/api/resources/deprecated/commit.py

@@ -0,0 +1,252 @@
+from typing import List, Optional, Union
+
+from deprecated import deprecated
+from gql import gql
+
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+    Commit,
+)
+from specklepy.core.api.resource import ResourceBase
+from specklepy.logging.exceptions import SpeckleException
+
+NAME = "commit"
+
+
+class Resource(ResourceBase):
+    """
+    API Access class for commits
+    Commit resource is deprecated, please use version resource instead
+    """
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+        )
+        self.schema = Commit
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get(self, stream_id: str, commit_id: str) -> Commit:
+        """
+        Gets a commit given a stream and the commit id
+
+        Arguments:
+            stream_id {str} -- the stream where we can find the commit
+            commit_id {str} -- the id of the commit you want to get
+
+        Returns:
+            Commit -- the retrieved commit object
+        """
+        query = gql(
+            """
+            query Commit($stream_id: String!, $commit_id: String!) {
+                stream(id: $stream_id) {
+                    commit(id: $commit_id) {
+                        id
+                        message
+                        referencedObject
+                        authorId
+                        authorName
+                        authorAvatar
+                        branchName
+                        createdAt
+                        sourceApplication
+                        totalChildrenCount
+                        parents
+                    }
+                }
+            }
+            """
+        )
+        params = {"stream_id": stream_id, "commit_id": commit_id}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "commit"]
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def list(self, stream_id: str, limit: int = 10) -> List[Commit]:
+        """
+        Get a list of commits on a given stream
+
+        Arguments:
+            stream_id {str} -- the stream where the commits are
+            limit {int} -- the maximum number of commits to fetch (default = 10)
+
+        Returns:
+            List[Commit] -- a list of the most recent commit objects
+        """
+        query = gql(
+            """
+            query Commits($stream_id: String!, $limit: Int!) {
+                stream(id: $stream_id) {
+                    commits(limit: $limit) {
+                        items {
+                            id
+                            message
+                            referencedObject
+                            authorName
+                            authorId
+                            authorName
+                            authorAvatar
+                            branchName
+                            createdAt
+                            sourceApplication
+                            totalChildrenCount
+                            parents
+                        }
+                    }
+                }
+            }
+            """
+        )
+        params = {"stream_id": stream_id, "limit": limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["stream", "commits", "items"]
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def create(
+        self,
+        stream_id: str,
+        object_id: str,
+        branch_name: str = "main",
+        message: str = "",
+        source_application: str = "python",
+        parents: Optional[List[str]] = None,
+    ) -> Union[str, SpeckleException]:
+        """
+        Creates a commit on a branch
+
+        Arguments:
+            stream_id {str} -- the stream you want to commit to
+            object_id {str} -- the hash of your commit object
+            branch_name {str}
+                -- the name of the branch to commit to (defaults to "main")
+            message {str}
+                -- optional: a message to give more information about the commit
+            source_application{str}
+                -- optional: the application from which the commit was created
+                (defaults to "python")
+            parents {List[str]} -- optional: the id of the parent commits
+
+        Returns:
+            str -- the id of the created commit
+        """
+        query = gql(
+            """
+            mutation CommitCreate ($commit: CommitCreateInput!)
+                { commitCreate(commit: $commit)}
+            """
+        )
+        params = {
+            "commit": {
+                "streamId": stream_id,
+                "branchName": branch_name,
+                "objectId": object_id,
+                "message": message,
+                "sourceApplication": source_application,
+            }
+        }
+        if parents:
+            params["commit"]["parents"] = parents
+
+        return self.make_request(
+            query=query, params=params, return_type="commitCreate", parse_response=False
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def update(self, stream_id: str, commit_id: str, message: str) -> bool:
+        """
+        Update a commit
+
+        Arguments:
+            stream_id {str}
+                -- the id of the stream that contains the commit you'd like to update
+            commit_id {str} -- the id of the commit you'd like to update
+            message {str} -- the updated commit message
+
+        Returns:
+            bool -- True if the operation succeeded
+        """
+        query = gql(
+            """
+            mutation CommitUpdate($commit: CommitUpdateInput!)
+                { commitUpdate(commit: $commit)}
+            """
+        )
+        params = {
+            "commit": {"streamId": stream_id, "id": commit_id, "message": message}
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type="commitUpdate", parse_response=False
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def delete(self, stream_id: str, commit_id: str) -> bool:
+        """
+        Delete a commit
+
+        Arguments:
+            stream_id {str}
+                -- the id of the stream that contains the commit you'd like to delete
+            commit_id {str} -- the id of the commit you'd like to delete
+
+        Returns:
+            bool -- True if the operation succeeded
+        """
+        query = gql(
+            """
+            mutation CommitDelete($commit: CommitDeleteInput!)
+                { commitDelete(commit: $commit)}
+            """
+        )
+        params = {"commit": {"streamId": stream_id, "id": commit_id}}
+
+        return self.make_request(
+            query=query, params=params, return_type="commitDelete", parse_response=False
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def received(
+        self,
+        stream_id: str,
+        commit_id: str,
+        source_application: str = "python",
+        message: Optional[str] = None,
+    ) -> bool:
+        """
+        Mark a commit object a received by the source application.
+        """
+        query = gql(
+            """
+            mutation CommitReceive($receivedInput:CommitReceivedInput!){
+                commitReceive(input:$receivedInput)
+            }
+            """
+        )
+        params = {
+            "receivedInput": {
+                "sourceApplication": source_application,
+                "streamId": stream_id,
+                "commitId": commit_id,
+                "message": "message",
+            }
+        }
+
+        try:
+            return self.make_request(
+                query=query,
+                params=params,
+                return_type="commitReceive",
+                parse_response=False,
+            )
+        except Exception as ex:
+            print(ex.with_traceback)
+            return False

src/specklepy/core/api/resources/deprecated/object.py

@@ -0,0 +1,92 @@
+from typing import Dict, List
+
+from gql import gql
+
+from specklepy.core.api.resource import ResourceBase
+from specklepy.objects.base import Base
+
+NAME = "object"
+
+
+class Resource(ResourceBase):
+    """API Access class for objects"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+        )
+        self.schema = Base
+
+    def get(self, stream_id: str, object_id: str) -> Base:
+        """
+        Get a stream object
+
+        Arguments:
+            stream_id {str} -- the id of the stream for the object
+            object_id {str} -- the hash of the object you want to get
+
+        Returns:
+            Base -- the returned Base object
+        """
+        query = gql(
+            """
+            query Object($stream_id: String!, $object_id: String!) {
+              stream(id: $stream_id) {
+                id
+                name
+                object(id: $object_id) {
+                  id
+                  speckleType
+                  applicationId
+                  createdAt
+                  totalChildrenCount
+                  data
+                }
+              }
+            }
+          """
+        )
+        params = {"stream_id": stream_id, "object_id": object_id}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["stream", "object", "data"],
+        )
+
+    def create(self, stream_id: str, objects: List[Dict]) -> str:
+        """
+        Not advised - generally, you want to use `operations.send()`.
+
+        Create a new object on a stream.
+        To send a base object, you can prepare it by running it through the
+        `BaseObjectSerializer.traverse_base()` function to get a valid (serialisable)
+        object to send.
+
+        NOTE: this does not create a commit - you can create one with
+        `SpeckleClient.commit.create`.
+        Dynamic fields will be located in the 'data' dict of the received `Base` object
+
+        Arguments:
+            stream_id {str} -- the id of the stream you want to send the object to
+            objects {List[Dict]}
+            -- a list of base dictionary objects (NOTE: must be json serialisable)
+
+        Returns:
+            str -- the id of the object
+        """
+        query = gql(
+            """
+          mutation ObjectCreate($object_input: ObjectCreateInput!) {
+            objectCreate(objectInput: $object_input)
+        }
+          """
+        )
+        params = {"object_input": {"streamId": stream_id, "objects": objects}}
+
+        return self.make_request(
+            query=query, params=params, return_type="objectCreate", parse_response=False
+        )

src/specklepy/core/api/resources/deprecated/other_user.py

@@ -0,0 +1,15 @@
+from deprecated import deprecated
+
+from specklepy.core.api.models.deprecated import FE1_DEPRECATION_VERSION
+from specklepy.core.api.resources import OtherUserResource
+
+
+@deprecated(
+    reason="Class renamed to OtherUserResource", version=FE1_DEPRECATION_VERSION
+)
+class Resource(OtherUserResource):
+    """
+    Class renamed to OtherUserResource
+    """
+
+    pass

src/specklepy/core/api/resources/deprecated/server.py

@@ -0,0 +1,11 @@
+from deprecated import deprecated
+
+from specklepy.core.api.models.deprecated import FE1_DEPRECATION_VERSION
+from specklepy.core.api.resources import ServerResource
+
+NAME = "server"
+
+
+@deprecated(reason="Renamed to ServerResource", version=FE1_DEPRECATION_VERSION)
+class Resource(ServerResource):
+    """API Access class for the server"""

src/specklepy/core/api/resources/deprecated/stream.py

@@ -0,0 +1,785 @@
+from datetime import datetime, timezone
+from typing import List, Optional
+
+from deprecated import deprecated
+from gql import gql
+
+from specklepy.core.api.models import (
+    ActivityCollection,
+    PendingStreamCollaborator,
+    Stream,
+)
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+)
+from specklepy.core.api.resource import ResourceBase
+from specklepy.logging.exceptions import SpeckleException, UnsupportedException
+
+NAME = "stream"
+
+
+class Resource(ResourceBase):
+    """
+    API Access class for streams
+    Stream resource is deprecated, please use project resource instead
+    """
+
+    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 = Stream
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get(self, id: str, branch_limit: int = 10, commit_limit: int = 10) -> Stream:
+        """Get the specified stream from the server
+
+        Arguments:
+            id {str} -- the stream id
+            branch_limit {int} -- the maximum number of branches to return
+            commit_limit {int} -- the maximum number of commits to return
+
+        Returns:
+            Stream -- the retrieved stream
+        """
+        query = gql(
+            """
+            query Stream($id: String!, $branch_limit: Int!, $commit_limit: Int!) {
+                stream(id: $id) {
+                    id
+                    name
+                    role
+                    description
+                    isPublic
+                    createdAt
+                    updatedAt
+                    commentCount
+                    favoritesCount
+                    collaborators {
+                        id
+                        name
+                        role
+                        avatar
+                    }
+                    branches(limit: $branch_limit) {
+                        totalCount
+                        cursor
+                        items {
+                            id
+                            name
+                            description
+                            commits(limit: $commit_limit) {
+                                totalCount
+                                cursor
+                                items {
+                                    id
+                                    message
+                                    authorId
+                                    createdAt
+                                    authorName
+                                    referencedObject
+                                    sourceApplication
+                                }
+                              }
+                          }
+                      }
+                }
+            }
+          """
+        )
+
+        params = {"id": id, "branch_limit": branch_limit, "commit_limit": commit_limit}
+
+        return self.make_request(query=query, params=params, return_type="stream")
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def list(self, stream_limit: int = 10) -> List[Stream]:
+        """Get a list of the user's streams
+
+        Arguments:
+            stream_limit {int} -- The maximum number of streams to return
+
+        Returns:
+            List[Stream] -- A list of Stream objects
+        """
+        query = gql(
+            """
+            query User($stream_limit: Int!) {
+                activeUser {
+                    id
+                    bio
+                    name
+                    email
+                    avatar
+                    company
+                    verified
+                    profiles
+                    role
+                    streams(limit: $stream_limit) {
+                        totalCount
+                        cursor
+                        items {
+                            id
+                            name
+                            role
+                            isPublic
+                            createdAt
+                            updatedAt
+                            description
+                            commentCount
+                            favoritesCount
+                            collaborators {
+                                id
+                                name
+                                role
+                            }
+                          }
+                      }
+                  }
+            }
+          """
+        )
+
+        params = {"stream_limit": stream_limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["activeUser", "streams", "items"]
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def create(
+        self,
+        name: str = "Anonymous Python Stream",
+        description: str = "No description provided",
+        is_public: bool = True,
+    ) -> str:
+        """Create a new stream
+
+        Arguments:
+            name {str} -- the name of the string
+            description {str} -- a short description of the stream
+            is_public {bool}
+                -- whether or not the stream can be viewed by anyone with the id
+
+        Returns:
+            id {str} -- the id of the newly created stream
+        """
+        query = gql(
+            """
+            mutation StreamCreate($stream: StreamCreateInput!) {
+              streamCreate(stream: $stream)
+            }
+        """
+        )
+        if len(name) < 3 and len(name) != 0:
+            return SpeckleException(message="Stream Name must be at least 3 characters")
+        params = {
+            "stream": {"name": name, "description": description, "isPublic": is_public}
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type="streamCreate", parse_response=False
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def update(
+        self,
+        id: str,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
+        is_public: Optional[bool] = None,
+    ) -> bool:
+        """Update an existing stream
+
+        Arguments:
+            id {str} -- the id of the stream to be updated
+            name {str} -- the name of the string
+            description {str} -- a short description of the stream
+            is_public {bool}
+                -- whether or not the stream can be viewed by anyone with the id
+
+        Returns:
+            bool -- whether the stream update was successful
+        """
+        query = gql(
+            """
+            mutation StreamUpdate($stream: StreamUpdateInput!) {
+                streamUpdate(stream: $stream)
+            }
+        """
+        )
+
+        params = {
+            "id": id,
+            "name": name,
+            "description": description,
+            "isPublic": is_public,
+        }
+        # remove None values so graphql doesn't cry
+        params = {"stream": {k: v for k, v in params.items() if v is not None}}
+
+        return self.make_request(
+            query=query, params=params, return_type="streamUpdate", parse_response=False
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def delete(self, id: str) -> bool:
+        """Delete a stream given its id
+
+        Arguments:
+            id {str} -- the id of the stream to delete
+
+        Returns:
+            bool -- whether the deletion was successful
+        """
+        query = gql(
+            """
+            mutation StreamDelete($id: String!) {
+                streamDelete(id: $id)
+            }
+            """
+        )
+
+        params = {"id": id}
+
+        return self.make_request(
+            query=query, params=params, return_type="streamDelete", parse_response=False
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def search(
+        self,
+        search_query: str,
+        limit: int = 25,
+        branch_limit: int = 10,
+        commit_limit: int = 10,
+    ):
+        """Search for streams by name, description, or id
+
+        Arguments:
+            search_query {str} -- a string to search for
+            limit {int} -- the maximum number of results to return
+            branch_limit {int} -- the maximum number of branches to return
+            commit_limit {int} -- the maximum number of commits to return
+
+        Returns:
+            List[Stream] -- a list of Streams that match the search query
+        """
+        query = gql(
+            """
+            query StreamSearch(
+                $search_query: String!,
+                $limit: Int!,
+                $branch_limit:Int!,
+                $commit_limit:Int!
+            ) {
+                streams(query: $search_query, limit: $limit) {
+                    items {
+                        id
+                        name
+                        role
+                        description
+                        isPublic
+                        createdAt
+                        updatedAt
+                        collaborators {
+                            id
+                            name
+                            role
+                            avatar
+                        }
+                        branches(limit: $branch_limit) {
+                            totalCount
+                            cursor
+                            items {
+                                id
+                                name
+                                description
+                                commits(limit: $commit_limit) {
+                                    totalCount
+                                    cursor
+                                    items {
+                                        id
+                                        referencedObject
+                                        message
+                                        authorName
+                                        authorId
+                                        createdAt
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+          """
+        )
+
+        params = {
+            "search_query": search_query,
+            "limit": limit,
+            "branch_limit": branch_limit,
+            "commit_limit": commit_limit,
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type=["streams", "items"]
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def favorite(self, stream_id: str, favorited: bool = True):
+        """Favorite or unfavorite the given stream.
+
+        Arguments:
+            stream_id {str} -- the id of the stream to favorite / unfavorite
+            favorited {bool}
+                -- whether to favorite (True) or unfavorite (False) the stream
+
+        Returns:
+            Stream -- the stream with its `id`, `name`, and `favoritedDate`
+        """
+        query = gql(
+            """
+            mutation StreamFavorite($stream_id: String!, $favorited: Boolean!) {
+                streamFavorite(streamId: $stream_id, favorited: $favorited) {
+                    id
+                    name
+                    favoritedDate
+                    favoritesCount
+                }
+            }
+            """
+        )
+
+        params = {
+            "stream_id": stream_id,
+            "favorited": favorited,
+        }
+
+        return self.make_request(
+            query=query, params=params, return_type=["streamFavorite"]
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def get_all_pending_invites(
+        self, stream_id: str
+    ) -> List[PendingStreamCollaborator]:
+        """Get all of the pending invites on a stream.
+        You must be a `stream:owner` to query this.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the stream id from which to get the pending invites
+
+        Returns:
+            List[PendingStreamCollaborator]
+                -- a list of pending invites for the specified stream
+        """
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            query StreamInvites($streamId: String!) {
+                stream(id: $streamId){
+                    pendingCollaborators {
+                        id
+                        token
+                        inviteId
+                        streamId
+                        streamName
+                        projectName
+                        projectId
+                        title
+                        role
+                        invitedBy{
+                            id
+                            name
+                            bio
+                            company
+                            avatar
+                            verified
+                            role
+                        }
+                        user {
+                            id
+                            name
+                            bio
+                            company
+                            avatar
+                            verified
+                            role
+                        }
+                    }
+                }
+            }
+            """
+        )
+        params = {"streamId": stream_id}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["stream", "pendingCollaborators"],
+            schema=PendingStreamCollaborator,
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def invite(
+        self,
+        stream_id: str,
+        email: Optional[str] = None,
+        user_id: Optional[str] = None,
+        role: str = "stream:contributor",  # should default be reviewer?
+        message: Optional[str] = None,
+    ):
+        """Invite someone to a stream using either their email or user id
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to invite the user to
+            email {str} -- the email of the user to invite (use this OR `user_id`)
+            user_id {str} -- the id of the user to invite (use this OR `email`)
+            role {str}
+                -- the role to assign to the user (defaults to `stream:contributor`)
+            message {str}
+                -- a message to send along with this invite to the specified user
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        self._check_invites_supported()
+
+        if email is None and user_id is None:
+            raise SpeckleException(
+                "You must provide either an email or a user id to use the"
+                " `stream.invite` method"
+            )
+
+        query = gql(
+            """
+            mutation StreamInviteCreate($input: StreamInviteCreateInput!) {
+                streamInviteCreate(input: $input)
+            }
+            """
+        )
+
+        params = {
+            "email": email,
+            "userId": user_id,
+            "streamId": stream_id,
+            "message": message,
+            "role": role,
+        }
+        params = {"input": {k: v for k, v in params.items() if v is not None}}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInviteCreate",
+            parse_response=False,
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def invite_batch(
+        self,
+        stream_id: str,
+        emails: Optional[List[str]] = None,
+        user_ids: Optional[List[None]] = None,
+        message: Optional[str] = None,
+    ) -> bool:
+        """Invite a batch of users to a specified stream.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to invite the user to
+            emails {List[str]}
+                -- the email of the user to invite (use this and/or `user_ids`)
+            user_id {List[str]}
+                -- the id of the user to invite (use this and/or `emails`)
+            message {str}
+                -- a message to send along with this invite to the specified user
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        self._check_invites_supported()
+        if emails is None and user_ids is None:
+            raise SpeckleException(
+                "You must provide either an email or a user id to use the"
+                " `stream.invite` method"
+            )
+
+        query = gql(
+            """
+            mutation StreamInviteBatchCreate($input: [StreamInviteCreateInput!]!) {
+                streamInviteBatchCreate(input: $input)
+            }
+            """
+        )
+
+        email_invites = [
+            {"streamId": stream_id, "message": message, "email": email}
+            for email in (emails if emails is not None else [])
+            if email is not None
+        ]
+
+        user_invites = [
+            {"streamId": stream_id, "message": message, "userId": user_id}
+            for user_id in (user_ids if user_ids is not None else [])
+            if user_id is not None
+        ]
+
+        params = {"input": [*email_invites, *user_invites]}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInviteBatchCreate",
+            parse_response=False,
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def invite_cancel(self, stream_id: str, invite_id: str) -> bool:
+        """Cancel an existing stream invite
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream invite
+            invite_id {str} -- the id of the invite to use
+
+        Returns:
+            bool -- true if the operation was successful
+        """
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            mutation StreamInviteCancel($streamId: String!, $inviteId: String!) {
+                streamInviteCancel(streamId: $streamId, inviteId: $inviteId)
+            }
+            """
+        )
+
+        params = {"streamId": stream_id, "inviteId": invite_id}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInviteCancel",
+            parse_response=False,
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def invite_use(self, stream_id: str, token: str, accept: bool = True) -> bool:
+        """Accept or decline a stream invite
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str}
+                -- the id of the stream for which the user has a pending invite
+            token {str} -- the token of the invite to use
+            accept {bool} -- whether or not to accept the invite (defaults to True)
+
+        Returns:
+            bool -- true if the operation was successful
+        """
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            mutation StreamInviteUse(
+                $accept: Boolean!,
+                $streamId: String!,
+                $token: String!
+                ) {
+                streamInviteUse(accept: $accept, streamId: $streamId, token: $token)
+            }
+            """
+        )
+
+        params = {"streamId": stream_id, "token": token, "accept": accept}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInviteUse",
+            parse_response=False,
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def update_permission(self, stream_id: str, user_id: str, role: str):
+        """Updates permissions for a user on a given stream
+
+        Valid for Speckle Server >=2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to grant permissions to
+            user_id {str} -- the id of the user to grant permissions for
+            role {str} -- the role to grant the user
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        if self.server_version and (
+            self.server_version != ("dev",) and self.server_version < (2, 6, 4)
+        ):
+            raise UnsupportedException(
+                "Server mutation `update_permission` is only supported as of Speckle"
+                " Server v2.6.4. Please update your Speckle Server to use this method"
+                " or use the `grant_permission` method instead."
+            )
+        query = gql(
+            """
+            mutation StreamUpdatePermission(
+                $permission_params: StreamUpdatePermissionInput!
+                ) {
+                streamUpdatePermission(permissionParams: $permission_params)
+            }
+            """
+        )
+
+        params = {
+            "permission_params": {
+                "streamId": stream_id,
+                "userId": user_id,
+                "role": role,
+            }
+        }
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamUpdatePermission",
+            parse_response=False,
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def revoke_permission(self, stream_id: str, user_id: str):
+        """Revoke permissions from a user on a given stream
+
+        Arguments:
+            stream_id {str} -- the id of the stream to revoke permissions from
+            user_id {str} -- the id of the user to revoke permissions from
+
+        Returns:
+            bool -- True if the operation was successful
+        """
+        query = gql(
+            """
+            mutation StreamRevokePermission(
+                $permission_params: StreamRevokePermissionInput!
+                ) {
+                streamRevokePermission(permissionParams: $permission_params)
+            }
+            """
+        )
+
+        params = {"permission_params": {"streamId": stream_id, "userId": user_id}}
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamRevokePermission",
+            parse_response=False,
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    def activity(
+        self,
+        stream_id: str,
+        action_type: Optional[str] = None,
+        limit: int = 20,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ):
+        """
+        Get the activity from a given stream in an Activity collection.
+        Step into the activity `items` for the list of activity.
+
+        Note: all timestamps arguments should be `datetime` of any tz
+            as they will be converted to UTC ISO format strings
+
+        stream_id {str} -- the id of the stream to get activity from
+        action_type {str}
+            -- filter results to a single action type
+            (eg: `commit_create` or `commit_receive`)
+        limit {int} -- max number of Activity items to return
+        before {datetime}
+            -- latest cutoff for activity (ie: return all activity _before_ this time)
+        after {datetime}
+            -- oldest cutoff for activity (ie: return all activity _after_ this time)
+        cursor {datetime} -- timestamp cursor for pagination
+        """
+        query = gql(
+            """
+            query StreamActivity(
+                $stream_id: String!,
+                $action_type: String,
+                $before:DateTime,
+                $after: DateTime,
+                $cursor: DateTime,
+                $limit: Int
+                ){
+                stream(id: $stream_id) {
+                    activity(
+                        actionType: $action_type,
+                        before: $before,
+                        after: $after,
+                        cursor: $cursor,
+                        limit: $limit
+                        ) {
+                        totalCount
+                        cursor
+                        items {
+                            actionType
+                            info
+                            userId
+                            streamId
+                            resourceId
+                            resourceType
+                            message
+                            time
+                        }
+                    }
+                }
+            }
+            """
+        )
+        try:
+            params = {
+                "stream_id": stream_id,
+                "limit": limit,
+                "action_type": action_type,
+                "before": (
+                    before.astimezone(timezone.utc).isoformat() if before else before
+                ),
+                "after": after.astimezone(timezone.utc).isoformat() if after else after,
+                "cursor": (
+                    cursor.astimezone(timezone.utc).isoformat() if cursor else cursor
+                ),
+            }
+        except AttributeError as e:
+            raise SpeckleException(
+                "Could not get stream activity - `before`, `after`, and `cursor` must"
+                " be in `datetime` format if provided",
+                ValueError(),
+            ) from e
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["stream", "activity"],
+            schema=ActivityCollection,
+        )

src/specklepy/core/api/resources/deprecated/subscriptions.py

@@ -0,0 +1,144 @@
+from functools import wraps
+from typing import Callable, Dict, List, Optional, Union
+
+from deprecated import deprecated
+from gql import gql
+from graphql import DocumentNode
+
+from specklepy.core.api.models.deprecated import (
+    FE1_DEPRECATION_REASON,
+    FE1_DEPRECATION_VERSION,
+    Stream,
+)
+from specklepy.core.api.resource import ResourceBase
+from specklepy.logging.exceptions import SpeckleException
+
+NAME = "subscribe"
+
+
+def check_wsclient(function):
+    @wraps(function)
+    async def check_wsclient_wrapper(self, *args, **kwargs):
+        if self.client is None:
+            raise SpeckleException(
+                "You must authenticate before you can subscribe to events"
+            )
+        else:
+            return await function(self, *args, **kwargs)
+
+    return check_wsclient_wrapper
+
+
+class Resource(ResourceBase):
+    """API Access class for subscriptions"""
+
+    def __init__(self, account, basepath, client) -> None:
+        super().__init__(
+            account=account,
+            basepath=basepath,
+            client=client,
+            name=NAME,
+        )
+
+    @deprecated(reason=FE1_DEPRECATION_REASON, version=FE1_DEPRECATION_VERSION)
+    @check_wsclient
+    async def stream_added(self, callback: Optional[Callable] = None):
+        """Subscribes to new stream added event for your profile.
+        Use this to display an up-to-date list of streams.
+
+        Arguments:
+            callback {Callable[Stream]} -- a function that takes the updated stream
+            as an argument and executes each time a stream is added
+
+        Returns:
+            Stream -- the update stream
+        """
+        query = gql(
+            """
+            subscription { userStreamAdded }
+            """
+        )
+        return await self.subscribe(
+            query=query, callback=callback, return_type="userStreamAdded", schema=Stream
+        )
+
+    @check_wsclient
+    async def stream_updated(self, id: str, callback: Optional[Callable] = None):
+        """
+        Subscribes to stream updated event.
+        Use this in clients/components that pertain only to this stream.
+
+        Arguments:
+            id {str} -- the stream id of the stream to subscribe to
+            callback {Callable[Stream]}
+            -- a function that takes the updated stream
+            as an argument and executes each time the stream is updated
+
+        Returns:
+            Stream -- the update stream
+        """
+        query = gql(
+            """
+            subscription Update($id: String!) { streamUpdated(streamId: $id) }
+            """
+        )
+        params = {"id": id}
+
+        return await self.subscribe(
+            query=query,
+            params=params,
+            callback=callback,
+            return_type="streamUpdated",
+            schema=Stream,
+        )
+
+    @check_wsclient
+    async def stream_removed(self, callback: Optional[Callable] = None):
+        """Subscribes to stream removed event for your profile.
+        Use this to display an up-to-date list of streams for your profile.
+        NOTE: If someone revokes your permissions on a stream,
+        this subscription will be triggered with an extra value of revokedBy
+        in the payload.
+
+        Arguments:
+            callback {Callable[Dict]}
+            -- a function that takes the returned dict as an argument
+            and executes each time a stream is removed
+
+        Returns:
+            dict -- dict containing 'id' of stream removed and optionally 'revokedBy'
+        """
+        query = gql(
+            """
+            subscription { userStreamRemoved }
+            """
+        )
+
+        return await self.subscribe(
+            query=query,
+            callback=callback,
+            return_type="userStreamRemoved",
+            parse_response=False,
+        )
+
+    @check_wsclient
+    async def subscribe(
+        self,
+        query: DocumentNode,
+        params: Optional[Dict] = None,
+        callback: Optional[Callable] = None,
+        return_type: Optional[Union[str, List]] = None,
+        schema=None,
+        parse_response: bool = True,
+    ):
+        # if self.client.transport.websocket is None:
+        # TODO: add multiple subs to the same ws connection
+        async with self.client as session:
+            async for res in session.subscribe(query, variable_values=params):
+                res = self._step_into_response(response=res, return_type=return_type)
+                if parse_response:
+                    res = self._parse_response(response=res, schema=schema)
+                if callback is not None:
+                    callback(res)
+                else:
+                    return res

src/specklepy/core/api/resources/deprecated/user.py

@@ -0,0 +1,325 @@
+from datetime import datetime, timezone
+from typing import List, Optional, Union
+
+from deprecated import deprecated
+from gql import gql
+
+from specklepy.core.api.models import (
+    ActivityCollection,
+    PendingStreamCollaborator,
+    User,
+)
+from specklepy.core.api.resource import ResourceBase
+from specklepy.logging.exceptions import SpeckleException
+
+NAME = "user"
+
+DEPRECATION_VERSION = "2.9.0"
+DEPRECATION_TEXT = (
+    "The user resource is deprecated, please use the active_user or other_user"
+    " resources"
+)
+
+
+class Resource(ResourceBase):
+    """API Access class for users"""
+
+    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 = User
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def get(self, id: Optional[str] = None) -> User:
+        """
+        Gets the profile of a user.
+        If no id argument is provided, will return the current authenticated
+        user's profile (as extracted from the authorization header).
+
+        Arguments:
+            id {str} -- the user id
+
+        Returns:
+            User -- the retrieved user
+        """
+        query = gql(
+            """
+            query User($id: String) {
+                user(id: $id) {
+                    id
+                    email
+                    name
+                    bio
+                    company
+                    avatar
+                    verified
+                    profiles
+                    role
+                }
+            }
+          """
+        )
+
+        params = {"id": id}
+
+        return self.make_request(query=query, params=params, return_type="user")
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def search(
+        self, search_query: str, limit: int = 25
+    ) -> Union[List[User], SpeckleException]:
+        """
+        Searches for user 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
+        Returns:
+            List[User] -- a list of User objects that match the search query
+        """
+        if len(search_query) < 3:
+            return SpeckleException(
+                message="User search query must be at least 3 characters"
+            )
+
+        query = gql(
+            """
+            query UserSearch($search_query: String!, $limit: Int!) {
+                userSearch(query: $search_query, limit: $limit) {
+                    items {
+                        id
+                        name
+                        bio
+                        company
+                        avatar
+                        verified
+                    }
+                }
+            }
+          """
+        )
+        params = {"search_query": search_query, "limit": limit}
+
+        return self.make_request(
+            query=query, params=params, return_type=["userSearch", "items"]
+        )
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def update(
+        self,
+        name: Optional[str] = None,
+        company: Optional[str] = None,
+        bio: Optional[str] = None,
+        avatar: Optional[str] = None,
+    ):
+        """Updates your user profile. All arguments are optional.
+
+        Arguments:
+            name {str} -- your name
+            company {str} -- the company you may or may not work for
+            bio {str} -- tell us about yourself
+            avatar {str} -- a nice photo of yourself
+
+        Returns:
+            bool -- True if your profile was updated successfully
+        """
+        query = gql(
+            """
+            mutation UserUpdate($user: UserUpdateInput!) {
+                userUpdate(user: $user)
+            }
+            """
+        )
+        params = {"name": name, "company": company, "bio": bio, "avatar": avatar}
+
+        params = {"user": {k: v for k, v in params.items() if v is not None}}
+
+        if not params["user"]:
+            return SpeckleException(
+                message=(
+                    "You must provide at least one field to update your user profile"
+                )
+            )
+
+        return self.make_request(
+            query=query, params=params, return_type="userUpdate", parse_response=False
+        )
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def activity(
+        self,
+        user_id: Optional[str] = None,
+        limit: int = 20,
+        action_type: Optional[str] = None,
+        before: Optional[datetime] = None,
+        after: Optional[datetime] = None,
+        cursor: Optional[datetime] = None,
+    ):
+        """
+        Get the activity from a given stream in an Activity collection.
+        Step into the activity `items` for the list of activity.
+        If no id argument is provided, will return the current authenticated
+        user's activity (as extracted from the authorization header).
+
+        Note: all timestamps arguments should be `datetime` of any tz as
+        they will be converted to UTC ISO format strings
+
+        user_id {str} -- the id of the user to get the activity from
+        action_type {str} -- filter results to a single action type
+        (eg: `commit_create` or `commit_receive`)
+        limit {int} -- max number of Activity items to return
+        before {datetime}
+            -- latest cutoff for activity (ie: return all activity _before_ this time)
+        after {datetime}
+            -- oldest cutoff for activity (ie: return all activity _after_ this time)
+        cursor {datetime} -- timestamp cursor for pagination
+        """
+
+        query = gql(
+            """
+            query UserActivity(
+                $user_id: String,
+                $action_type: String,
+                $before:DateTime,
+                $after: DateTime,
+                $cursor: DateTime,
+                $limit: Int
+                ){
+                user(id: $user_id) {
+                    activity(
+                        actionType: $action_type,
+                        before: $before,
+                        after: $after,
+                        cursor: $cursor,
+                        limit: $limit
+                        ) {
+                        totalCount
+                        cursor
+                        items {
+                            actionType
+                            info
+                            userId
+                            streamId
+                            resourceId
+                            resourceType
+                            message
+                            time
+                        }
+                    }
+                }
+            }
+            """
+        )
+
+        params = {
+            "user_id": user_id,
+            "limit": limit,
+            "action_type": action_type,
+            "before": before.astimezone(timezone.utc).isoformat() if before else before,
+            "after": after.astimezone(timezone.utc).isoformat() if after else after,
+            "cursor": cursor.astimezone(timezone.utc).isoformat() if cursor else cursor,
+        }
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type=["user", "activity"],
+            schema=ActivityCollection,
+        )
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def get_all_pending_invites(self) -> List[PendingStreamCollaborator]:
+        """Get all of the active user's pending stream invites
+
+        Requires Speckle Server version >= 2.6.4
+
+        Returns:
+            List[PendingStreamCollaborator]
+                -- a list of pending invites for the current user
+        """
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            query StreamInvites {
+                streamInvites{
+                    id
+                    token
+                    inviteId
+                    streamId
+                    streamName
+                    title
+                    role
+                    invitedBy {
+                        id
+                        name
+                        company
+                        avatar
+                    }
+                }
+            }
+            """
+        )
+
+        return self.make_request(
+            query=query,
+            return_type="streamInvites",
+            schema=PendingStreamCollaborator,
+        )
+
+    @deprecated(version=DEPRECATION_VERSION, reason=DEPRECATION_TEXT)
+    def get_pending_invite(
+        self, stream_id: str, token: Optional[str] = None
+    ) -> Optional[PendingStreamCollaborator]:
+        """Get a particular pending invite for the active user on a given stream.
+        If no invite_id is provided, any valid invite will be returned.
+
+        Requires Speckle Server version >= 2.6.4
+
+        Arguments:
+            stream_id {str} -- the id of the stream to look for invites on
+            token {str} -- the token of the invite to look for (optional)
+
+        Returns:
+            PendingStreamCollaborator
+                -- the invite for the given stream (or None if it isn't found)
+        """
+        self._check_invites_supported()
+
+        query = gql(
+            """
+            query StreamInvite($streamId: String!, $token: String) {
+                streamInvite(streamId: $streamId, token: $token) {
+                    id
+                    token
+                    streamId
+                    streamName
+                    title
+                    role
+                    invitedBy {
+                        id
+                        name
+                        company
+                        avatar
+                    }
+                }
+            }
+            """
+        )
+
+        params = {"streamId": stream_id}
+        if token:
+            params["token"] = token
+
+        return self.make_request(
+            query=query,
+            params=params,
+            return_type="streamInvite",
+            schema=PendingStreamCollaborator,
+        )

src/specklepy/core/api/wrapper.py

@@ -18,7 +18,7 @@ class StreamWrapper:
     The `StreamWrapper` gives you some handy helpers to deal with urls and
     get authenticated clients and transports.
 
-    Construct a `StreamWrapper` with a URL of a model, version, or object.
+    Construct a `StreamWrapper` with a stream, branch, commit, or object URL.
     The corresponding ids will be stored
     in the wrapper. If you have local accounts on the machine,
     you can use the `get_account` and `get_client` methods
@@ -29,8 +29,8 @@ class StreamWrapper:
     ```py
     from specklepy.api.wrapper import StreamWrapper
 
-    # provide a url for a model, version, or object
-    wrapper = StreamWrapper("https://app.speckle.systems/projects/3073b96e86/models/0fe47c9dca@604bea8cc6")
+    # provide any stream, branch, commit, object, or globals url
+    wrapper = StreamWrapper("https://app.speckle.systems/streams/3073b96e86/commits/604bea8cc6")
 
     # get an authenticated SpeckleClient if you have a local account for the server
     client = wrapper.get_client()
@@ -159,12 +159,11 @@ class StreamWrapper:
             try:
                 self.branch_name = project["project"]["model"]["name"]
             except KeyError as ke:
-                raise SpeckleException("Project model name is not found", ke) from ke
+                raise SpeckleException("Project model name is not found", ke)
 
         if not self.stream_id:
             raise SpeckleException(
-                f"Cannot parse {url} into a stream wrapper class - no {key_stream} "
-                "id found.",
+                f"Cannot parse {url} into a stream wrapper class - no {key_stream} id found."
             )
 
     @property
@@ -214,11 +213,7 @@ class StreamWrapper:
             self._client = SpeckleClient(host=self.host, use_ssl=self.use_ssl)
 
         if self._account.token is None and token is None:
-            warn(
-                f"No local account found for server {self.host}",
-                SpeckleWarning,
-                stacklevel=2,
-            )
+            warn(f"No local account found for server {self.host}", SpeckleWarning)
             return self._client
 
         if self._account.token:
@@ -271,20 +266,14 @@ class StreamWrapper:
         if use_fe2 is False or (use_fe2 is True and not self.model_id):
             base_url = f"{self.server_url}{key_streams}{self.stream_id}"
         else:  # fe2 is True and model_id available
-            base_url = (
-                f"{self.server_url}{key_streams}"
-                f"{self.stream_id}{key_branches}{value_branch}"
-            )
+            base_url = f"{self.server_url}{key_streams}{self.stream_id}{key_branches}{value_branch}"
 
         if wrapper_type == "object":
             return f"{base_url}{key_objects}{self.object_id}"
         elif wrapper_type == "commit":
             return f"{base_url}{key_commits}{self.commit_id}"
         elif wrapper_type == "branch":
-            return (
-                f"{self.server_url}{key_streams}{self.stream_id}"
-                f"{key_branches}{value_branch}"
-            )
+            return f"{self.server_url}{key_streams}{self.stream_id}{key_branches}{value_branch}"
         elif wrapper_type == "stream":
             return f"{self.server_url}{key_streams}{self.stream_id}"
         else:

src/specklepy/core/helpers/speckle_path_provider.py

@@ -99,7 +99,7 @@ def user_application_data_path() -> Path:
     except Exception as ex:
         raise SpeckleException(
             message="Failed to initialize user application data path.", exception=ex
-        ) from ex
+        )
 
 
 def user_speckle_folder_path() -> Path:

src/specklepy/logging/exceptions.py

@@ -58,8 +58,3 @@ class UnsupportedException(SpeckleException):
 class SpeckleWarning(Warning):
     def __init__(self, *args: object) -> None:
         super().__init__(*args)
-
-
-class WorkspacePermissionException(SpeckleException):
-    def __init__(self, message: str) -> None:
-        super().__init__(message=message)

src/specklepy/logging/metrics.py

@@ -86,8 +86,7 @@ def track(
 
         METRICS_TRACKER.queue.put_nowait(event_params)
     except Exception as ex:
-        # wrapping this whole thing in a try except as we never want a failure here
-        # to annoy users!
+        # wrapping this whole thing in a try except as we never want a failure here to annoy users!
         LOG.debug(f"Error queueing metrics request: {str(ex)}")
 
 
@@ -107,7 +106,7 @@ class Singleton(type):
 
     def __call__(cls, *args, **kwargs):
         if cls not in cls._instances:
-            cls._instances[cls] = super().__call__(*args, **kwargs)
+            cls._instances[cls] = super(Singleton, cls).__call__(*args, **kwargs)
         return cls._instances[cls]
 
 

src/specklepy/objects/__init__.py

@@ -1,3 +0,0 @@
-from .data_objects import Base, DataObject, QgisObject, BlenderObject  # noqa: I001
-
-__all__ = ["Base", "DataObject", "QgisObject", "BlenderObject"]

src/specklepy/objects/annotation/__init__.py

@@ -1,8 +0,0 @@
-from .text import AlignmentHorizontal, AlignmentVertical, Text
-
-# re-export them at the geometry package level
-__all__ = [
-    "Text",
-    "AlignmentHorizontal",
-    "AlignmentVertical",
-]

src/specklepy/objects/annotation/text.py

@@ -1,54 +0,0 @@
-from dataclasses import dataclass, field
-from enum import Enum
-from typing import Optional
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry import Plane, Point
-from specklepy.objects.interfaces import IHasUnits
-
-
-class AlignmentHorizontal(Enum):
-    Left = 0
-    Center = 1
-    Right = 2
-
-
-class AlignmentVertical(Enum):
-    Top = 0
-    Center = 1
-    Bottom = 2
-
-
-@dataclass(kw_only=True)
-class Text(Base, IHasUnits, speckle_type="Objects.Annotation.Text"):
-    """
-    Text class for representation in the viewer.
-    Units will be 'Units.None' if the text size is defined in pixels.
-    """
-
-    value: str  # Plain text, without formatting
-    origin: Point  # Relation to the text is defined by AlignmentH and AlignmentV
-    height: float  # Font height in linear units or pixels (if Units.None)
-    alignmentH: AlignmentHorizontal = field(
-        default_factory=lambda: AlignmentHorizontal.Left
-    )
-    alignmentV: AlignmentVertical = field(default_factory=lambda: AlignmentVertical.Top)
-    plane: Optional[Plane] = field(
-        default_factory=lambda: None
-    )  # None if the text object orientation follows camera view
-    maxWidth: Optional[float] = field(
-        default_factory=lambda: None
-    )  # Maximum width of the text field. None, if don't split into lines
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"value: {self.value}, "
-            f"origin: {self.origin}, "
-            f"height: {self.height}, "
-            f"alignmentH: {self.alignmentH}, "
-            f"alignmentV: {self.alignmentV}, "
-            f"plane: {self.plane}, "
-            f"maxWidth: {self.maxWidth}, "
-            f"units: {self.units})"
-        )

src/specklepy/objects/base.py

@@ -17,7 +17,7 @@ from typing import (
 )
 from warnings import warn
 
-from pydantic.alias_generators import to_pascal
+from stringcase import pascalcase
 
 from specklepy.logging.exceptions import SpeckleException
 from specklepy.transports.memory import MemoryTransport
@@ -147,7 +147,7 @@ class _RegisteringBase:
         # convert the module names to PascalCase to match c# namespace naming convention
         # also drop specklepy from the beginning
         namespace = ".".join(
-            to_pascal(m)
+            pascalcase(m)
             for m in filter(lambda name: name != "specklepy", cls.__module__.split("."))
         )
         return f"{namespace}.{cls.__name__}"
@@ -224,7 +224,7 @@ def _validate_type(t: Optional[type], value: Any) -> Tuple[bool, Any]:
         if isinstance(t, ForwardRef):
             return True, value
 
-        origin = t.__origin__
+        origin = getattr(t, "__origin__")
         # below is what in nicer for >= py38
         # origin = get_origin(t)
 
@@ -289,7 +289,7 @@ def _validate_type(t: Optional[type], value: Any) -> Tuple[bool, Any]:
             if len(args) != len(value):
                 return False, value
             values = []
-            for t_item, v_item in zip(args, value, strict=True):
+            for t_item, v_item in zip(args, value):
                 item_valid, item_value = _validate_type(t_item, v_item)
                 if not item_valid:
                     return False, value
@@ -372,8 +372,7 @@ class Base(_RegisteringBase, speckle_type="Base"):
         if name == "speckle_type":
             # not sure if we should raise an exception here??
             # raise SpeckleException(
-            #     "Cannot override the `speckle_type`."
-            #     "This is set manually by the class or on deserialisation"
+            #     "Cannot override the `speckle_type`. This is set manually by the class or on deserialisation"
             # )
             return
         # if value is not None:
@@ -401,10 +400,7 @@ class Base(_RegisteringBase, speckle_type="Base"):
         try:
             cls._attr_types = get_type_hints(cls)
         except Exception as e:
-            warn(
-                f"Could not update forward refs for class {cls.__name__}: {e}",
-                stacklevel=2,
-            )
+            warn(f"Could not update forward refs for class {cls.__name__}: {e}")
 
     @classmethod
     def validate_prop_name(cls, name: str) -> None:
@@ -469,8 +465,7 @@ class Base(_RegisteringBase, speckle_type="Base"):
 
     # @units.setter
     # def units(self, value: Union[str, Units, None]):
-    #     """While this property accepts any string value,
-    #        geometry expects units to be specific strings (see Units enum)"""
+    #     """While this property accepts any string value, geometry expects units to be specific strings (see Units enum)"""
     #     if isinstance(value, str) or value is None:
     #         self._units = value
     #     elif isinstance(value, Units):

src/specklepy/objects/data_objects.py

@@ -1,107 +0,0 @@
-from dataclasses import dataclass, field
-from typing import Dict, List
-
-from specklepy.logging.exceptions import SpeckleException
-from specklepy.objects.base import Base
-from specklepy.objects.interfaces import (
-    IBlenderObject,
-    IDataObject,
-    IGisObject,
-    IHasUnits,
-)
-
-
-@dataclass(kw_only=True)
-class DataObject(
-    Base,
-    IDataObject,
-    speckle_type="Objects.Data.DataObject",
-    detachable={"displayValue"},
-):
-    name: str
-    properties: Dict[str, object]
-    displayValue: List[Base]
-    _name: str = field(repr=False, init=False)
-    _properties: Dict[str, object] = field(repr=False, init=False)
-    _displayValue: List[Base] = field(repr=False, init=False)
-
-    @property
-    def name(self) -> str:
-        return self._name
-
-    @property
-    def properties(self) -> Dict[str, object]:
-        return self._properties
-
-    @property
-    def displayValue(self) -> List[Base]:
-        return self._displayValue
-
-    @name.setter
-    def name(self, value: str):
-        if isinstance(value, str):
-            self._name = value
-        else:
-            raise SpeckleException(
-                f"'name' value should be string, received {type(value)}"
-            )
-
-    @properties.setter
-    def properties(self, value: dict):
-        if isinstance(value, dict):
-            self._properties = value
-        else:
-            raise SpeckleException(
-                f"'properties' value should be Dict, received {type(value)}"
-            )
-
-    @displayValue.setter
-    def displayValue(self, value: list):
-        if isinstance(value, list):
-            self._displayValue = value
-        else:
-            raise SpeckleException(
-                f"'displayValue' value should be List, received {type(value)}"
-            )
-
-
-@dataclass(kw_only=True)
-class QgisObject(
-    DataObject, IGisObject, IHasUnits, speckle_type="Objects.Data.QgisObject"
-):
-    type: str
-    _type: str = field(repr=False, init=False)
-
-    @property
-    def type(self) -> str:
-        return self._type
-
-    @type.setter
-    def type(self, value: str):
-        if isinstance(value, str):
-            self._type = value
-        else:
-            raise SpeckleException(
-                f"'type' value should be string, received {type(value)}"
-            )
-
-
-@dataclass(kw_only=True)
-class BlenderObject(
-    DataObject, IBlenderObject, IHasUnits, speckle_type="Objects.Data.BlenderObject"
-):
-    type: str
-    _type: str = field(repr=False, init=False)
-
-    @property
-    def type(self) -> str:
-        return self._type
-
-    @type.setter
-    def type(self, value: str):
-        if isinstance(value, str):
-            self._type = value
-        else:
-            raise SpeckleException(
-                f"'type' value should be string, received {type(value)}"
-            )

src/specklepy/objects/geometry.py

@@ -0,0 +1,272 @@
+from dataclasses import dataclass, field
+from typing import List, Tuple
+
+from specklepy.objects.base import Base
+from specklepy.objects.interfaces import ICurve, IHasArea, IHasUnits, IHasVolume
+from specklepy.objects.models.units import Units
+from specklepy.objects.primitive import Interval
+
+
+@dataclass(kw_only=True)
+class Point(Base, IHasUnits, speckle_type="Objects.Geometry.Point"):
+    """
+    a 3-dimensional point
+    """
+
+    x: float
+    y: float
+    z: float
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__name__}(x: {self.x}, y: {self.y}, z: {self.z}, units: {self.units})"
+
+    def to_list(self) -> List[float]:
+        return [self.x, self.y, self.z]
+
+    @classmethod
+    def from_list(cls, coords: List[float], units: str | Units) -> "Point":
+        return cls(x=coords[0], y=coords[1], z=coords[2], units=units)
+
+    @classmethod
+    def from_coords(cls, x: float, y: float, z: float, units: str | Units) -> "Point":
+        return cls(x=x, y=y, z=z, units=units)
+
+    def distance_to(self, other: "Point") -> float:
+        """
+        calculates the distance between this point and another given point
+        """
+        dx = other.x - self.x
+        dy = other.y - self.y
+        dz = other.z - self.z
+        return (dx * dx + dy * dy + dz * dz) ** 0.5
+
+
+@dataclass(kw_only=True)
+class Line(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Line"):
+    """
+    a line defined by two points in 3D space
+    """
+
+    start: Point
+    end: Point
+    domain: Interval = field(default_factory=Interval.unit_interval)
+
+    @property
+    def length(self) -> float:
+        """
+        calculate the length of the line using Point's distance_to method
+        """
+        return self.start.distance_to(self.end)
+
+    @property
+    def _domain(self) -> Interval:
+        return self.domain
+
+    def to_list(self) -> List[float]:
+        result = []
+        result.extend(self.start.to_list())
+        result.extend(self.end.to_list())
+        result.extend([self.domain.start, self.domain.end])
+        return result
+
+    @classmethod
+    def from_list(cls, coords: List[float], units: str) -> "Line":
+        if len(coords) < 6:
+            raise ValueError("Line from coordinate array requires 6 coordinates.")
+
+        start = Point(x=coords[0], y=coords[1], z=coords[2], units=units)
+        end = Point(x=coords[3], y=coords[4], z=coords[5], units=units)
+
+        return cls(start=start, end=end, units=units)
+
+    @classmethod
+    def from_coords(
+        cls,
+        start_x: float,
+        start_y: float,
+        start_z: float,
+        end_x: float,
+        end_y: float,
+        end_z: float,
+        units: str,
+    ) -> "Line":
+        start = Point(x=start_x, y=start_y, z=start_z, units=units)
+        end = Point(x=end_x, y=end_y, z=end_z, units=units)
+        return cls(start=start, end=end, units=units)
+
+
+@dataclass(kw_only=True)
+class Polyline(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Polyline"):
+    """
+    a polyline curve, defined by a set of vertices.
+    """
+
+    value: List[float] = field(default_factory=list)
+    closed: bool = False
+    domain: Interval = field(default_factory=Interval.unit_interval)
+
+    @property
+    def length(self) -> float:
+        points = self.get_points()
+        total_length = 0.0
+        for i in range(len(points) - 1):
+            total_length += points[i].distance_to(points[i + 1])
+        if self.closed and points:
+            total_length += points[-1].distance_to(points[0])
+        return total_length
+
+    @property
+    def _domain(self) -> Interval:
+        """
+        internal domain property for ICurve interface
+        """
+        return self.domain
+
+    def get_points(self) -> List[Point]:
+        """
+        converts the raw coordinate list into Point objects
+        """
+        if len(self.value) % 3 != 0:
+            raise ValueError(
+                "Polyline value list is malformed: expected length to be multiple of 3"
+            )
+
+        points = []
+        for i in range(0, len(self.value), 3):
+            points.append(
+                Point(
+                    x=self.value[i],
+                    y=self.value[i + 1],
+                    z=self.value[i + 2],
+                    units=self.units,
+                )
+            )
+        return points
+
+    def to_list(self) -> List[float]:
+        """
+        returns the values of this Polyline as a list of numbers
+        """
+        result = []
+        result.append(len(self.value) + 6)  # total list length
+        # type indicator for polyline ?? not sure about this
+        result.append("Objects.Geometry.Polyline")
+        result.append(1 if self.closed else 0)
+        result.append(self.domain.start)
+        result.append(self.domain.end)
+        result.append(len(self.value))
+        result.extend(self.value)
+        result.append(Units.get_encoding_from_unit(self.units))
+        return result
+
+    @classmethod
+    def from_list(cls, coords: List[float], units: str | Units) -> "Polyline":
+        """
+        creates a new Polyline based on a list of coordinates
+        """
+        point_count = int(coords[5])
+        return cls(
+            closed=(int(coords[2]) == 1),
+            domain=Interval(start=coords[3], end=coords[4]),
+            value=coords[6 : 6 + point_count],
+            units=units,
+        )
+
+
+@dataclass(kw_only=True)
+class Mesh(
+    Base,
+    IHasArea,
+    IHasVolume,
+    IHasUnits,
+    speckle_type="Objects.Geometry.Mesh",
+    detachable={"vertices", "faces", "colors", "textureCoordinates"},
+    chunkable={
+        "vertices": 31250,
+        "faces": 62500,
+        "colors": 62500,
+        "textureCoordinates": 31250,
+    },
+):
+    vertices: List[float] = field(default_factory=list)
+    faces: List[int] = field(default_factory=list)
+    colors: List[int] = field(default_factory=list)
+    textureCoordinates: List[float] = field(default_factory=list)
+
+    @property
+    def vertices_count(self) -> int:
+        return len(self.vertices) // 3
+
+    @property
+    def texture_coordinates_count(self) -> int:
+        return len(self.textureCoordinates) // 2
+
+    def get_point(self, index: int) -> Point:
+        index *= 3
+        return Point(
+            x=self.vertices[index],
+            y=self.vertices[index + 1],
+            z=self.vertices[index + 2],
+            units=self.units,
+        )
+
+    def get_points(self) -> List[Point]:
+        if len(self.vertices) % 3 != 0:
+            raise ValueError(
+                "Mesh vertices list is malformed: expected length to be multiple of 3"
+            )
+
+        points = []
+        for i in range(0, len(self.vertices), 3):
+            points.append(
+                Point(
+                    x=self.vertices[i],
+                    y=self.vertices[i + 1],
+                    z=self.vertices[i + 2],
+                    units=self.units,
+                )
+            )
+        return points
+
+    def get_texture_coordinate(self, index: int) -> Tuple[float, float]:
+        index *= 2
+        return (self.textureCoordinates[index], self.textureCoordinates[index + 1])
+
+    def align_vertices_with_texcoords_by_index(self) -> None:
+        if not self.textureCoordinates:
+            return
+
+        if self.texture_coordinates_count == self.vertices_count:
+            return
+
+        faces_unique = []
+        vertices_unique = []
+        has_colors = len(self.colors) > 0
+        colors_unique = [] if has_colors else None
+
+        n_index = 0
+        while n_index < len(self.faces):
+            n = self.faces[n_index]
+            if n < 3:
+                n += 3
+
+            if n_index + n >= len(self.faces):
+                break
+
+            faces_unique.append(n)
+            for i in range(1, n + 1):
+                vert_index = self.faces[n_index + i]
+                new_vert_index = len(vertices_unique) // 3
+
+                point = self.get_point(vert_index)
+                vertices_unique.extend([point.x, point.y, point.z])
+
+                if colors_unique is not None:
+                    colors_unique.append(self.colors[vert_index])
+                faces_unique.append(new_vert_index)
+
+            n_index += n + 1
+
+        self.vertices = vertices_unique
+        self.colors = colors_unique if colors_unique is not None else self.colors
+        self.faces = faces_unique

src/specklepy/objects/geometry/__init__.py

@@ -1,38 +0,0 @@
-from .arc import Arc
-from .box import Box
-from .circle import Circle
-from .control_point import ControlPoint
-from .curve import Curve
-from .ellipse import Ellipse
-from .line import Line
-from .mesh import Mesh
-from .plane import Plane
-from .point import Point
-from .point_cloud import PointCloud
-from .polycurve import Polycurve
-from .polyline import Polyline
-from .region import Region
-from .spiral import Spiral
-from .surface import Surface
-from .vector import Vector
-
-# re-export them at the geometry package level
-__all__ = [
-    "Arc",
-    "Line",
-    "Mesh",
-    "Plane",
-    "Point",
-    "Polyline",
-    "Region",
-    "Vector",
-    "Box",
-    "Circle",
-    "ControlPoint",
-    "Ellipse",
-    "PointCloud",
-    "Polycurve",
-    "Spiral",
-    "Surface",
-    "Curve",
-]

src/specklepy/objects/geometry/arc.py

@@ -1,38 +0,0 @@
-import math
-from dataclasses import dataclass
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.plane import Plane
-from specklepy.objects.geometry.point import Point
-from specklepy.objects.interfaces import ICurve, IHasUnits
-
-
-@dataclass(kw_only=True)
-class Arc(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Arc"):
-    plane: Plane
-    startPoint: Point
-    midPoint: Point
-    endPoint: Point
-
-    @property
-    def radius(self) -> float:
-        return self.startPoint.distance_to(self.plane.origin)
-
-    @property
-    def length(self) -> float:
-        start_to_mid = self.startPoint.distance_to(self.midPoint)
-        mid_to_end = self.midPoint.distance_to(self.endPoint)
-        r = self.radius
-        angle = (2 * math.asin(start_to_mid / (2 * r))) + (
-            2 * math.asin(mid_to_end / (2 * r))
-        )
-        return r * angle
-
-    @property
-    def measure(self) -> float:
-        start_to_mid = self.startPoint.distance_to(self.midPoint)
-        mid_to_end = self.midPoint.distance_to(self.endPoint)
-        r = self.radius
-        return (2 * math.asin(start_to_mid / (2 * r))) + (
-            2 * math.asin(mid_to_end / (2 * r))
-        )

src/specklepy/objects/geometry/box.py

@@ -1,40 +0,0 @@
-from dataclasses import dataclass
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.plane import Plane
-from specklepy.objects.interfaces import IHasArea, IHasUnits, IHasVolume
-from specklepy.objects.primitive import Interval
-
-
-@dataclass(kw_only=True)
-class Box(Base, IHasUnits, IHasArea, IHasVolume, speckle_type="Objects.Geometry.Box"):
-    """
-    a 3-dimensional box oriented on a plane
-    """
-
-    basePlane: Plane
-    xSize: Interval
-    ySize: Interval
-    zSize: Interval
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"basePlane: {self.basePlane}, "
-            f"xSize: {self.xSize}, "
-            f"ySize: {self.ySize}, "
-            f"zSize: {self.zSize}, "
-            f"units: {self.units})"
-        )
-
-    @property
-    def area(self) -> float:
-        return 2 * (
-            self.xSize.length * self.ySize.length
-            + self.xSize.length * self.zSize.length
-            + self.ySize.length * self.zSize.length
-        )
-
-    @property
-    def volume(self) -> float:
-        return self.xSize.length * self.ySize.length * self.zSize.length

src/specklepy/objects/geometry/circle.py

@@ -1,35 +0,0 @@
-import math
-from dataclasses import dataclass
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.plane import Plane
-from specklepy.objects.geometry.point import Point
-from specklepy.objects.interfaces import ICurve, IHasArea, IHasUnits
-
-
-@dataclass(kw_only=True)
-class Circle(Base, IHasUnits, ICurve, IHasArea, speckle_type="Objects.Geometry.Circle"):
-    """
-    a circular curve based on a plane
-    """
-
-    plane: Plane
-    center: Point
-    radius: float
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"plane: {self.plane}, "
-            f"center: {self.center}, "
-            f"radius: {self.radius}, "
-            f"units: {self.units})"
-        )
-
-    @property
-    def length(self) -> float:
-        return 2 * math.pi * self.radius
-
-    @property
-    def area(self) -> float:
-        return math.pi * self.radius**2

src/specklepy/objects/geometry/control_point.py

@@ -1,22 +0,0 @@
-from dataclasses import dataclass
-
-from specklepy.objects.geometry.point import Point
-
-
-@dataclass(kw_only=True)
-class ControlPoint(Point, speckle_type="Objects.Geometry.ControlPoint"):
-    """
-    a single 3-dimensional point with weight
-    """
-
-    weight: float
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"x: {self.x}, "
-            f"y: {self.y}, "
-            f"z: {self.z}, "
-            f"weight: {self.weight}, "
-            f"units: {self.units})"
-        )

src/specklepy/objects/geometry/curve.py

@@ -1,58 +0,0 @@
-from dataclasses import dataclass
-from typing import List, Optional
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.box import Box
-from specklepy.objects.geometry.polyline import Polyline
-from specklepy.objects.interfaces import ICurve, IHasArea, IHasUnits
-
-
-@dataclass(kw_only=True)
-class Curve(
-    Base,
-    ICurve,
-    IHasArea,
-    IHasUnits,
-    speckle_type="Objects.Geometry.Curve",
-    detachable={"points", "weights", "knots", "displayValue"},
-    chunkable={"points": 31250, "weights": 31250, "knots": 31250},
-):
-    """
-    a NURBS curve
-    """
-
-    degree: int
-    periodic: bool
-    rational: bool
-    points: List[float]
-    weights: List[float]
-    knots: List[float]
-    closed: bool
-    displayValue: Polyline
-    bbox: Optional[Box] = None
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"degree: {self.degree}, "
-            f"periodic: {self.periodic}, "
-            f"rational: {self.rational}, "
-            f"closed: {self.closed}, "
-            f"units: {self.units})"
-        )
-
-    @property
-    def length(self) -> float:
-        return self.__dict__.get("_length", 0.0)
-
-    @length.setter
-    def length(self, value: float) -> None:
-        self.__dict__["_length"] = value
-
-    @property
-    def area(self) -> float:
-        return self.__dict__.get("_area", 0.0)
-
-    @area.setter
-    def area(self, value: float) -> None:
-        self.__dict__["_area"] = value

src/specklepy/objects/geometry/ellipse.py

@@ -1,34 +0,0 @@
-from dataclasses import dataclass
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.plane import Plane
-from specklepy.objects.interfaces import ICurve, IHasArea, IHasUnits
-
-
-@dataclass(kw_only=True)
-class Ellipse(
-    Base, IHasUnits, ICurve, IHasArea, speckle_type="Objects.Geometry.Ellipse"
-):
-    """
-    an ellipse
-    """
-
-    plane: Plane
-    first_radius: float
-    second_radius: float
-
-    @property
-    def length(self) -> float:
-        return self.__dict__.get("_length", 0.0)
-
-    @length.setter
-    def length(self, value: float) -> None:
-        self.__dict__["_length"] = value
-
-    @property
-    def area(self) -> float:
-        return self.__dict__.get("_area", 0.0)
-
-    @area.setter
-    def area(self, value: float) -> None:
-        self.__dict__["_area"] = value

src/specklepy/objects/geometry/line.py

@@ -1,15 +0,0 @@
-from dataclasses import dataclass
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.point import Point
-from specklepy.objects.interfaces import ICurve, IHasUnits
-
-
-@dataclass(kw_only=True)
-class Line(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Line"):
-    start: Point
-    end: Point
-
-    @property
-    def length(self) -> float:
-        return self.start.distance_to(self.end)

src/specklepy/objects/geometry/mesh.py

@@ -1,213 +0,0 @@
-from dataclasses import dataclass, field
-from typing import List, Tuple
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.point import Point
-from specklepy.objects.interfaces import IHasArea, IHasUnits, IHasVolume
-
-
-@dataclass(kw_only=True)
-class Mesh(
-    Base,
-    IHasArea,
-    IHasVolume,
-    IHasUnits,
-    speckle_type="Objects.Geometry.Mesh",
-    detachable={"vertices", "faces", "colors", "textureCoordinates", "vertexNormals"},
-    chunkable={
-        "vertices": 31250,
-        "faces": 62500,
-        "colors": 62500,
-        "textureCoordinates": 31250,
-        "vertexNormals": 31250,
-    },
-    serialize_ignore={"vertices_count", "texture_coordinates_count"},
-):
-    """
-    a 3D mesh consisting of vertices and faces
-    with optional colors and texture coordinates
-    """
-
-    vertices: List[float]
-    faces: List[int]
-    colors: List[int] = field(default_factory=list)
-    textureCoordinates: List[float] = field(default_factory=list)
-    vertexNormals: List[float] = field(default_factory=list)
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"vertices: {self.vertices_count}, "
-            f"units: {self.units}, "
-            f"has_colors: {len(self.colors) > 0}, "
-            f"has_texture_coords: {len(self.textureCoordinates) > 0})"
-        )
-
-    @property
-    def vertices_count(self) -> int:
-        """
-        get the number of vertices in the mesh
-        """
-
-        if len(self.vertices) % 3 != 0:
-            raise ValueError(
-                f"Invalid vertices list: length {len(self.vertices)} "
-                f"must be a multiple of 3"
-            )
-        return len(self.vertices) // 3
-
-    @property
-    def texture_coordinates_count(self) -> int:
-        """
-        get the number of texture coordinates in the mesh
-        """
-        return len(self.textureCoordinates) // 2
-
-    @property
-    def area(self) -> float:
-        return self.__dict__.get("_area", 0.0)
-
-    @area.setter
-    def area(self, value: float) -> None:
-        self.__dict__["_area"] = value
-
-    @property
-    def volume(self) -> float:
-        return self.__dict__.get("_volume", 0.0)
-
-    @volume.setter
-    def volume(self, value: float) -> None:
-        self.__dict__["_volume"] = value
-
-    def calculate_area(self) -> float:
-        """
-        calculate total surface area of the mesh
-        """
-        total_area = 0.0
-        face_index = 0
-        i = 0
-
-        while i < len(self.faces):
-            vertex_count = self.faces[i]
-            if vertex_count >= 3:
-                face_vertices = self.get_face_vertices(face_index)
-                for j in range(1, vertex_count - 1):
-                    v0 = face_vertices[0]
-                    v1 = face_vertices[j]
-                    v2 = face_vertices[j + 1]
-                    a = [v1.x - v0.x, v1.y - v0.y, v1.z - v0.z]
-                    b = [v2.x - v0.x, v2.y - v0.y, v2.z - v0.z]
-                    cx = a[1] * b[2] - a[2] * b[1]
-                    cy = a[2] * b[0] - a[0] * b[2]
-                    cz = a[0] * b[1] - a[1] * b[0]
-                    area = 0.5 * (cx * cx + cy * cy + cz * cz) ** 0.5
-                    total_area += area
-            i += vertex_count + 1
-            face_index += 1
-
-        return total_area
-
-    def calculate_volume(self) -> float:
-        """
-        calculate volume of the mesh if it is closed
-        """
-        if not self.is_closed():
-            return 0.0
-
-        total_volume = 0.0
-        face_index = 0
-        i = 0
-        while i < len(self.faces):
-            vertex_count = self.faces[i]
-            if vertex_count >= 3:
-                face_vertices = self.get_face_vertices(face_index)
-                v0 = face_vertices[0]
-                for j in range(1, vertex_count - 1):
-                    v1 = face_vertices[j]
-                    v2 = face_vertices[j + 1]
-                    a = [v0.x, v0.y, v0.z]
-                    b = [v1.x - v0.x, v1.y - v0.y, v1.z - v0.z]
-                    c = [v2.x - v0.x, v2.y - v0.y, v2.z - v0.z]
-                    cx = b[1] * c[2] - b[2] * c[1]
-                    cy = b[2] * c[0] - b[0] * c[2]
-                    cz = b[0] * c[1] - b[1] * c[0]
-                    v = (a[0] * cx + a[1] * cy + a[2] * cz) / 6.0
-                    total_volume += v
-            i += vertex_count + 1
-            face_index += 1
-
-        return abs(total_volume)
-
-    def get_point(self, index: int) -> Point:
-        """
-        get vertex at index as a Point object
-        """
-        if index < 0 or index >= self.vertices_count:
-            raise IndexError(f"Vertex index {index} out of range")
-
-        index *= 3
-        return Point(
-            x=self.vertices[index],
-            y=self.vertices[index + 1],
-            z=self.vertices[index + 2],
-            units=self.units,
-        )
-
-    def get_points(self) -> List[Point]:
-        """
-        get all vertices as Point objects
-        """
-        return [self.get_point(i) for i in range(self.vertices_count)]
-
-    def get_texture_coordinate(self, index: int) -> Tuple[float, float]:
-        """
-        get texture coordinate at index
-        """
-        if index < 0 or index >= self.texture_coordinates_count:
-            raise IndexError(f"Texture coordinate index {index} out of range")
-
-        index *= 2
-        return (self.textureCoordinates[index], self.textureCoordinates[index + 1])
-
-    def get_face_vertices(self, face_index: int) -> List[Point]:
-        """
-        get the vertices of a specific face
-        """
-        i = 0
-        current_face = 0
-
-        while i < len(self.faces):
-            if current_face == face_index:
-                vertex_count = self.faces[i]
-                vertices = []
-                for j in range(vertex_count):
-                    vertex_index = self.faces[i + j + 1]
-                    if vertex_index >= self.vertices_count:
-                        raise IndexError(f"Vertex index {vertex_index} out of range")
-                    vertices.append(self.get_point(vertex_index))
-                return vertices
-
-            vertex_count = self.faces[i]
-            i += vertex_count + 1
-            current_face += 1
-
-        raise IndexError(f"Face index {face_index} out of range")
-
-    def is_closed(self) -> bool:
-        """
-        check if the mesh is closed (verifying each edge appears twice)
-        """
-        edge_counts = {}
-
-        i = 0
-        while i < len(self.faces):
-            vertex_count = self.faces[i]
-            for j in range(vertex_count):
-                v1 = self.faces[i + 1 + j]
-                v2 = self.faces[i + 1 + ((j + 1) % vertex_count)]
-                edge = tuple(sorted([v1, v2]))
-                edge_counts[edge] = edge_counts.get(edge, 0) + 1
-
-            i += vertex_count + 1
-
-        return all(count == 2 for count in edge_counts.values())

src/specklepy/objects/geometry/plane.py

@@ -1,28 +0,0 @@
-from dataclasses import dataclass
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.point import Point
-from specklepy.objects.geometry.vector import Vector
-from specklepy.objects.interfaces import IHasUnits
-
-
-@dataclass(kw_only=True)
-class Plane(Base, IHasUnits, speckle_type="Objects.Geometry.Plane"):
-    """
-    a plane consisting of an origin Point, and 3 Vectors as its X, Y and Z axis.
-    """
-
-    origin: Point
-    normal: Vector
-    xdir: Vector
-    ydir: Vector
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"origin: {self.origin}, "
-            f"normal: {self.normal}, "
-            f"xdir: {self.xdir}, "
-            f"ydir: {self.ydir}, "
-            f"units: {self.units})"
-        )

src/specklepy/objects/geometry/point.py

@@ -1,39 +0,0 @@
-from dataclasses import dataclass
-
-from specklepy.objects.base import Base
-from specklepy.objects.interfaces import IHasUnits
-
-
-@dataclass(kw_only=True)
-class Point(Base, IHasUnits, speckle_type="Objects.Geometry.Point"):
-    """
-    a 3-dimensional point
-    """
-
-    x: float
-    y: float
-    z: float
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"x: {self.x}, "
-            f"y: {self.y}, "
-            f"z: {self.z}, "
-            f"units: {self.units})"
-        )
-
-    def distance_to(self, other: "Point") -> float:
-        """
-        calculates the distance between this point and another given point.
-        """
-        if not isinstance(other, Point):
-            raise TypeError(f"Expected Point object, got {type(other)}")
-
-        # we assume that host application units are the same for both points
-        # unit conversion could be expensive, so we avoid it here
-        dx = other.x - self.x
-        dy = other.y - self.y
-        dz = other.z - self.z
-
-        return (dx * dx + dy * dy + dz * dz) ** 0.5

src/specklepy/objects/geometry/point_cloud.py

@@ -1,24 +0,0 @@
-from dataclasses import dataclass
-from typing import List
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.point import Point
-from specklepy.objects.interfaces import IHasUnits
-
-
-@dataclass(kw_only=True)
-class PointCloud(Base, IHasUnits, speckle_type="Objects.Geometry.PointCloud"):
-    """
-    a collection of 3-dimensional points
-    """
-
-    points: List[Point]
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"points: {len(self.points)}, "
-            f"units: {self.units})"
-        )
-
-    # sizes and colors could be added in the future

src/specklepy/objects/geometry/polycurve.py

@@ -1,97 +0,0 @@
-from dataclasses import dataclass, field
-from typing import List
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.line import Line
-from specklepy.objects.geometry.point import Point
-from specklepy.objects.geometry.polyline import Polyline
-from specklepy.objects.interfaces import ICurve, IHasArea, IHasUnits
-
-
-@dataclass(kw_only=True)
-class Polycurve(
-    Base, IHasUnits, ICurve, IHasArea, speckle_type="Objects.Geometry.Polycurve"
-):
-    """
-    a curve that is comprised of multiple curves connected
-    """
-
-    segments: List[ICurve] = field(default_factory=list)
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"segments: {len(self.segments)}, "
-            f"closed: {self.is_closed()}, "
-            f"units: {self.units})"
-        )
-
-    def is_closed(self, tolerance: float = 1e-6) -> bool:
-        """
-        checks if the polycurve is closed
-        (comparing start of first segment to end of last segment)
-        """
-        if len(self.segments) < 1:
-            return False
-
-        first_segment = self.segments[0]
-        last_segment = self.segments[-1]
-
-        if not (hasattr(first_segment, "start") and hasattr(last_segment, "end")):
-            return False
-
-        start_pt = first_segment.start
-        end_pt = last_segment.end
-
-        if not (isinstance(start_pt, Point) and isinstance(end_pt, Point)):
-            return False
-
-        return start_pt.distance_to(end_pt) <= tolerance
-
-    @property
-    def length(self) -> float:
-        return self.__dict__.get("_length", 0.0)
-
-    @length.setter
-    def length(self, value: float) -> None:
-        self.__dict__["_length"] = value
-
-    def calculate_length(self) -> float:
-        """
-        calculate total length of all segments
-        """
-        total_length = 0.0
-        for segment in self.segments:
-            if hasattr(segment, "length"):
-                total_length += segment.length
-        return total_length
-
-    @property
-    def area(self) -> float:
-        return self.__dict__.get("_area", 0.0)
-
-    @area.setter
-    def area(self, value: float) -> None:
-        self.__dict__["_area"] = value
-
-    @classmethod
-    def from_polyline(cls, polyline: Polyline) -> "Polycurve":
-        """
-        constructs a new polycurve instance from an existing polyline curve
-        """
-        polycurve = cls(units=polyline.units)
-        points = polyline.get_points()
-        for i in range(len(points) - 1):
-            line = Line(start=points[i], end=points[i + 1], units=polyline.units)
-            polycurve.segments.append(line)
-
-        if polyline.is_closed():
-            line = Line(start=points[-1], end=points[0], units=polyline.units)
-            polycurve.segments.append(line)
-
-        if hasattr(polyline, "_length"):
-            polycurve.length = polyline.length
-        if hasattr(polyline, "_area"):
-            polycurve.area = polyline.area
-
-        return polycurve

src/specklepy/objects/geometry/polyline.py

@@ -1,71 +0,0 @@
-from dataclasses import dataclass
-from typing import List
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.point import Point
-from specklepy.objects.interfaces import ICurve, IHasUnits
-
-
-@dataclass(kw_only=True)
-class Polyline(Base, IHasUnits, ICurve, speckle_type="Objects.Geometry.Polyline"):
-    """
-    a polyline curve, defined by a set of vertices.
-    """
-
-    value: List[float]
-
-    def __repr__(self) -> str:
-        return f"{self.__class__.__name__}(value: {self.value}, units: {self.units})"
-
-    def is_closed(self, tolerance: float = 1e-6) -> bool:
-        """
-        check if the polyline is closed (start point equals end point within tolerance)
-        """
-        if len(self.value) < 6:  # need at least 2 points to be closed
-            return False
-
-        # compare first and last points
-        start = Point(
-            x=self.value[0], y=self.value[1], z=self.value[2], units=self.units
-        )
-        end = Point(
-            x=self.value[-3], y=self.value[-2], z=self.value[-1], units=self.units
-        )
-        return start.distance_to(end) <= tolerance
-
-    @property
-    def length(self) -> float:
-        return self.__dict__.get("_length", 0.0)
-
-    @length.setter
-    def length(self, value: float) -> None:
-        self.__dict__["_length"] = value
-
-    def calculate_length(self) -> float:
-        points = self.get_points()
-        total_length = 0.0
-        for i in range(len(points) - 1):
-            total_length += points[i].distance_to(points[i + 1])
-        if self.is_closed() and points:
-            total_length += points[-1].distance_to(points[0])
-        return total_length
-
-    def get_points(self) -> List[Point]:
-        """
-        converts the raw coordinate list into Point objects
-        """
-        if len(self.value) % 3 != 0:
-            raise ValueError(
-                "Polyline value list is malformed: expected length to be multiple of 3"
-            )
-
-        points = []
-        for i in range(0, len(self.value), 3):
-            point = Point(
-                x=self.value[i],
-                y=self.value[i + 1],
-                z=self.value[i + 2],
-                units=self.units,
-            )
-            points.append(point)
-        return points

src/specklepy/objects/geometry/region.py

@@ -1,59 +0,0 @@
-from dataclasses import dataclass, field
-from typing import List
-
-from specklepy.logging.exceptions import SpeckleException
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.box import Box
-from specklepy.objects.geometry.mesh import Mesh
-from specklepy.objects.interfaces import ICurve, IDisplayValue, IHasArea, IHasUnits
-
-
-@dataclass(kw_only=True)
-class Region(
-    Base,
-    IHasArea,
-    IDisplayValue[List[Mesh]],
-    IHasUnits,
-    speckle_type="Objects.Geometry.Region",
-    detachable={"displayValue"},
-):
-    """
-    Flat shape, defined by an outer boundary and inner loops.
-    """
-
-    boundary: ICurve
-    innerLoops: List[ICurve]
-    hasHatchPattern: bool
-    bbox: Box | None = None
-    # unlike C#, constructor will require displayValue, even if it's empty
-    displayValue: List[Mesh]
-    _displayValue: List[Mesh] = field(repr=False, init=False)
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"units: {self.units}, "
-            f"has_hatch_pattern: {self.hasHatchPattern}, "
-            f"inner_loops: {len(self.innerLoops)})"
-        )
-
-    @property
-    def area(self) -> float:
-        return self.__dict__.get("_area", 0.0)
-
-    @area.setter
-    def area(self, value: float) -> None:
-        self.__dict__["_area"] = value
-
-    @property
-    def displayValue(self) -> List[Mesh]:
-        return self._displayValue
-
-    @displayValue.setter
-    def displayValue(self, value: list):
-        if isinstance(value, list):
-            self._displayValue = value
-        else:
-            raise SpeckleException(
-                f"'displayValue' value should be List, received {type(value)}"
-            )

src/specklepy/objects/geometry/spiral.py

@@ -1,49 +0,0 @@
-from dataclasses import dataclass
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.plane import Plane
-from specklepy.objects.geometry.point import Point
-from specklepy.objects.geometry.vector import Vector
-from specklepy.objects.interfaces import ICurve, IHasArea, IHasUnits
-
-
-@dataclass(kw_only=True)
-class Spiral(Base, IHasUnits, ICurve, IHasArea, speckle_type="Objects.Geometry.Spiral"):
-    """
-    a spiral
-    """
-
-    start_point: Point
-    end_point: Point
-    plane: Plane  # plane with origin at spiral center
-    turns: float  # total angle of spiral.
-    pitch: float
-    pitch_axis: Vector
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"start_point: {self.start_point}, "
-            f"end_point: {self.end_point}, "
-            f"plane: {self.plane}, "
-            f"turns: {self.turns}, "
-            f"pitch: {self.pitch}, "
-            f"pitch_axis: {self.pitch_axis}, "
-            f"units: {self.units})"
-        )
-
-    @property
-    def length(self) -> float:
-        return self.__dict__.get("_length", 0.0)
-
-    @length.setter
-    def length(self, value: float) -> None:
-        self.__dict__["_length"] = value
-
-    @property
-    def area(self) -> float:
-        return self.__dict__.get("_area", 0.0)
-
-    @area.setter
-    def area(self, value: float) -> None:
-        self.__dict__["_area"] = value

src/specklepy/objects/geometry/surface.py

@@ -1,65 +0,0 @@
-from dataclasses import dataclass
-from typing import List
-
-from specklepy.objects.base import Base
-from specklepy.objects.geometry.control_point import ControlPoint
-from specklepy.objects.interfaces import IHasArea, IHasUnits
-from specklepy.objects.primitive import Interval
-
-
-@dataclass(kw_only=True)
-class Surface(Base, IHasArea, IHasUnits, speckle_type="Objects.Geometry.Surface"):
-    """
-    a surface in nurbs form
-    """
-
-    degreeU: int
-    degreeV: int
-    rational: bool
-    pointData: List[float]
-    countU: int
-    countV: int
-    knotsU: List[float]
-    knotsV: List[float]
-    domainU: Interval
-    domainV: Interval
-    closedU: bool
-    closedV: bool
-
-    @property
-    def area(self) -> float:
-        return self.__dict__.get("_area", 0.0)
-
-    @area.setter
-    def area(self, value: float) -> None:
-        self.__dict__["_area"] = value
-
-    def get_control_points(self) -> List:
-        """
-        gets the control points of this surface
-        """
-
-        matrix = [[] for _ in range(self.countU)]
-
-        for i in range(0, len(self.pointData), 4):
-            u_index = i // (self.countV * 4)
-            x, y, z, w = self.pointData[i : i + 4]
-            matrix[u_index].append(
-                ControlPoint(x=x, y=y, z=z, weight=w, units=self.units)
-            )
-
-        return matrix
-
-    def set_control_points(self, value: List) -> None:
-        """
-        sets the control points of this surface
-        """
-        data = []
-        self.countU = len(value)
-        self.countV = len(value[0])
-
-        for row in value:
-            for pt in row:
-                data.extend([pt.x, pt.y, pt.z, pt.weight])
-
-        self.pointData = data

src/specklepy/objects/geometry/vector.py

@@ -1,30 +0,0 @@
-from dataclasses import dataclass
-
-from specklepy.objects.base import Base
-from specklepy.objects.interfaces import IHasUnits
-
-
-@dataclass(kw_only=True)
-class Vector(
-    Base, IHasUnits, speckle_type="Objects.Geometry.Vector", serialize_ignore={"length"}
-):
-    """
-    a 3-dimensional vector
-    """
-
-    x: float
-    y: float
-    z: float
-
-    def __repr__(self) -> str:
-        return (
-            f"{self.__class__.__name__}("
-            f"x: {self.x}, "
-            f"y: {self.y}, "
-            f"z: {self.z}, "
-            f"units: {self.units})"
-        )
-
-    @property
-    def length(self) -> float:
-        return (self.x**2 + self.y**2 + self.z**2) ** 0.5

src/specklepy/objects/graph_traversal/default_traversal.py

@@ -1,29 +0,0 @@
-from specklepy.objects.base import Base
-from specklepy.objects.graph_traversal.traversal import GraphTraversal, TraversalRule
-
-DISPLAY_VALUE_PROPERTY_ALIASES = {"displayValue", "@displayValue"}
-ELEMENTS_PROPERTY_ALIASES = {"elements", "@elements"}
-
-
-def has_display_value(x: Base):
-    return any(hasattr(x, alias) for alias in DISPLAY_VALUE_PROPERTY_ALIASES)
-
-
-def create_default_traversal_function() -> GraphTraversal:
-    """
-    Traversal func for traversing the root object of a Speckle Model
-    """
-
-    convertible_rule = TraversalRule(
-        [lambda b: b.speckle_type != "Base", has_display_value],
-        lambda _: ELEMENTS_PROPERTY_ALIASES,
-    )
-
-    default_rule = TraversalRule(
-        [lambda _: True],
-        # NOTE: Unlike the C# implementation, this does not ignore Obsolete members
-        lambda o: o.get_member_names(),
-        False,
-    )
-
-    return GraphTraversal([convertible_rule, default_rule])

src/specklepy/objects/interfaces.py

@@ -1,6 +1,6 @@
 from abc import ABCMeta, abstractmethod
 from dataclasses import dataclass, field
-from typing import Dict, Generic, List, TypeVar
+from typing import Generic, List, TypeVar
 
 from specklepy.logging.exceptions import SpeckleInvalidUnitException
 from specklepy.objects.base import Base
@@ -11,34 +11,30 @@ T = TypeVar("T")  # define type variable for generic type
 
 
 # generic interfaces
-@dataclass(kw_only=True)
 class ICurve(metaclass=ABCMeta):
-    _domain: Interval = field(default_factory=Interval.unit_interval, init=False)
-
     @property
     @abstractmethod
     def length(self) -> float:
         pass
 
     @property
-    def domain(self) -> Interval:
-        return self._domain
+    @abstractmethod
+    def _domain(self) -> Interval:
+        pass
 
-    @domain.setter
-    def domain(self, value: Interval) -> None:
-        if not isinstance(value, Interval):
-            raise TypeError(f"Domain must be an Interval, got {type(value)}")
-        self._domain = value
+    @property
+    @abstractmethod
+    def units(self) -> str:
+        pass
 
 
 class IDisplayValue(Generic[T], metaclass=ABCMeta):
     @property
     @abstractmethod
-    def displayValue(self) -> T:
+    def display_value(self) -> T:
         pass
 
 
-# field interfaces
 @dataclass(kw_only=True)
 class IHasUnits(metaclass=ABCMeta):
     units: str | Units
@@ -62,32 +58,32 @@ class IHasUnits(metaclass=ABCMeta):
 
 @dataclass(kw_only=True)
 class IHasArea(metaclass=ABCMeta):
+    area: float
     _area: float = field(init=False, repr=False)
 
     @property
-    @abstractmethod
     def area(self) -> float:
-        pass
+        return self._area
 
     @area.setter
     def area(self, value: float):
-        if not isinstance(value, int | float):
+        if not isinstance(value, (int, float)):
             raise ValueError(f"Area must be a number, got {type(value)}")
         self._area = float(value)
 
 
 @dataclass(kw_only=True)
 class IHasVolume(metaclass=ABCMeta):
+    volume: float
     _volume: float = field(init=False, repr=False)
 
     @property
-    @abstractmethod
     def volume(self) -> float:
-        pass
+        return self._volume
 
     @volume.setter
     def volume(self, value: float):
-        if not isinstance(value, int | float):
+        if not isinstance(value, (int, float)):
             raise ValueError(f"Volume must be a number, got {type(value)}")
         self._volume = float(value)
 
@@ -96,7 +92,7 @@ class IHasVolume(metaclass=ABCMeta):
 class IProperties(metaclass=ABCMeta):
     @property
     @abstractmethod
-    def properties(self) -> Dict[str, object]:
+    def properties(self) -> dict[str, object]:
         pass
 
 
@@ -112,10 +108,3 @@ class IBlenderObject(IDataObject, metaclass=ABCMeta):
     @abstractmethod
     def type(self) -> str:
         pass
-
-
-class IGisObject(IDataObject, metaclass=ABCMeta):
-    @property
-    @abstractmethod
-    def type(self) -> str:
-        pass