envoy-schema 2.3.2__tar.gz → 2.3.3__tar.gz

{envoy_schema-2.3.2/src/envoy_schema.egg-info → envoy_schema-2.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: envoy_schema
-Version: 2.3.2
+Version: 2.3.3
 Summary: Envoy Schema - a collection of pydantic models compatible with the Envoy utility server
 Author: Battery Storage and Grid Integration Program
 License: The MIT License (MIT)

{envoy_schema-2.3.2 → envoy_schema-2.3.3}/pyproject.toml

@@ -34,7 +34,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "envoy_schema"
-version = "2.3.2"
+version = "2.3.3"
 description = "Envoy Schema - a collection of pydantic models compatible with the Envoy utility server"
 authors = [{ name = "Battery Storage and Grid Integration Program" }]
 readme = "README.md"

envoy_schema-2.3.3/src/envoy_schema/admin/schema/site_group.py

@@ -0,0 +1,52 @@
+from datetime import datetime
+
+from pydantic import BaseModel
+
+
+class SiteGroupRequest(BaseModel):
+    """Request model for SiteGroup - used for creating"""
+
+    name: str  # Unique name of this SiteGroup
+    default_group: bool  # If set - all "new" site registrations (in/out of band) will be assigned to this group\
+
+
+class SiteGroupResponse(SiteGroupRequest):
+    """Response model for SiteGroup - includes basic summary information"""
+
+    site_group_id: int
+    created_time: datetime
+    changed_time: datetime
+
+    total_sites: int  # How many sites/assignments are linked to this group
+
+
+class SiteGroupPageResponse(BaseModel):
+    """Represents a paginated response of SiteGroup"""
+
+    total_count: int  # The total number of groups (independent of this page of results)
+    limit: int  # The maximum number of groups that could've been returned (the limit set by the query)
+    start: int  # The number of groups that have been skipped as part of this query (the start set by the query)
+    groups: list[SiteGroupResponse]  # The group models in this page
+
+
+class SiteGroupAssignmentRequest(BaseModel):
+    """Request model for SiteGroupAssignment - used for creating new assignments to a SiteGroup"""
+
+    site_id: int  # The site_id whose membership is being added to a group
+
+
+class SiteGroupAssignmentResponse(SiteGroupAssignmentRequest):
+    """Response model for SiteGroupAssignment - used for checking membership"""
+
+    site_group_assignment_id: int
+    created_time: datetime
+    changed_time: datetime
+
+
+class SiteGroupAssignmentPageResponse(BaseModel):
+    """Represents a paginated response of SiteGroupAssignment"""
+
+    total_count: int  # The total number of assignments (independent of this page of results)
+    limit: int  # The maximum number of assignments that could've been returned (the limit set by the query)
+    start: int  # The number of assignments that have been skipped as part of this query (the start set by the query)
+    assignments: list[SiteGroupAssignmentResponse]  # The assignment models in this page

{envoy_schema-2.3.2 → envoy_schema-2.3.3}/src/envoy_schema/admin/schema/uri.py

@@ -29,8 +29,11 @@ TariffGeneratedRateRangeUri = (
 )
 SiteListUri = "/site"
 SiteUri = "/site/{site_id}"  # Supports updating/deleting single sites
-SiteGroupUri = "/site_group/{group_name}"
 SiteGroupListUri = "/site_group"
+SiteGroupUri = "/site_group/{group_name}"
+SiteGroupAssignmentsListUri = "/site_group/{group_name}/assignments"
+SiteGroupAssignmentsUri = "/site_group/{group_name}/assignments/{site_group_assignment_id}"
+
 CSIPAusSiteReadingUri = "/site_readings/{site_id}/csip_aus_unit/{unit_enum}/period/{period_start}/{period_end}"
 CalculationLogCreateUri = "/calculation_log"
 CalculationLogUri = "/calculation_log/{calculation_log_id}"

{envoy_schema-2.3.2 → envoy_schema-2.3.3/src/envoy_schema.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: envoy_schema
-Version: 2.3.2
+Version: 2.3.3
 Summary: Envoy Schema - a collection of pydantic models compatible with the Envoy utility server
 Author: Battery Storage and Grid Integration Program
 License: The MIT License (MIT)

envoy_schema-2.3.2/src/envoy_schema/admin/schema/site_group.py

@@ -1,23 +0,0 @@
-from datetime import datetime
-
-from pydantic import BaseModel
-
-
-class SiteGroupResponse(BaseModel):
-    """Response model for SiteGroup - includes basic summary information"""
-
-    site_group_id: int
-    name: str
-    created_time: datetime
-    changed_time: datetime
-    default_group: bool  # If set - all "new" site registrations (in/out of band) will be assigned to this group
-    total_sites: int  # How many sites are linked to this group
-
-
-class SiteGroupPageResponse(BaseModel):
-    """Represents a paginated response of SiteGroup"""
-
-    total_count: int  # The total number of groups (independent of this page of results)
-    limit: int  # The maximum number of groups that could've been returned (the limit set by the query)
-    start: int  # The number of groups that have been skipped as part of this query (the start set by the query)
-    groups: list[SiteGroupResponse]  # The group models in this page