Sync monorepo state at "update python userstore sample for data types" (#99)

Syncing from
userclouds/userclouds@6ee49350b266e518c9423db9bfa88f150499114b

Author: uc-build-user

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## UNPUBLISHED
+
+- Add methods for creating, retrieving, updating, and deleting ColumnDataTypes
+- Add data_type field to Column that refers to a ColumnDataType
+- Add input_data_type and output_data_type fields to Transformer that refer to ColumnDataTypes
+- Add ColumnDataType resource IDs for native ColumnDataTypes
+- Update userstore_sample.py to interact with ColumnDataTypes
+
 ## 1.6.1
 
 - Add SDK method for data import via ExecuteMutator

src/usercloudssdk/asyncclient.py

@@ -20,6 +20,7 @@
     AccessPolicyTemplate,
     Column,
     ColumnConsentedPurposes,
+    ColumnDataType,
     ColumnRetentionDurationResponse,
     ColumnRetentionDurationsResponse,
     Edge,
@@ -185,9 +186,59 @@ async def CreateUserWithMutatorAsync(
         }
         return await self._post_async("/userstore/api/users", json_data=body)
 
+    # ColumnDataType Operations
+
+    async def CreateColumnDataTypeAsync(
+        self, dataType: ColumnDataType, if_not_exists: bool = False
+    ) -> ColumnDataType:
+        try:
+            resp_json = await self._post_async(
+                "/userstore/config/datatypes",
+                json_data={"data_type": dataType.__dict__},
+            )
+            return ColumnDataType.from_json(resp_json)
+        except UserCloudsSDKError as err:
+            if if_not_exists:
+                dataType.id = _id_from_identical_conflict(err)
+                return dataType
+            raise err
+
+    async def DeleteColumnDataTypeAsync(self, id: uuid.UUID) -> bool:
+        return await self._delete_async(f"/userstore/config/datatypes/{id}")
+
+    async def GetColumnDataTypeAsync(self, id: uuid.UUID) -> ColumnDataType:
+        resp_json = await self._get_async(f"/userstore/config/datatypes/{id}")
+        return ColumnDataType.from_json(resp_json)
+
+    async def ListColumnDataTypesAsync(
+        self, limit: int = 0, starting_after: uuid.UUID | None = None
+    ) -> list[ColumnDataType]:
+        params: dict[str, int | str] = {}
+        if limit > 0:
+            params["limit"] = limit
+        if starting_after is not None:
+            params["starting_after"] = f"id:{starting_after}"
+        params["version"] = "3"
+        resp_json = await self._get_async("/userstore/config/datatypes", params=params)
+        dataTypes = [
+            ColumnDataType.from_json(dataType) for dataType in resp_json["data"]
+        ]
+        return dataTypes
+
+    async def UpdateColumnDataTypeAsync(
+        self, dataType: ColumnDataType
+    ) -> ColumnDataType:
+        resp_json = await self._put_async(
+            f"/userstore/config/datatypes/{dataType.id}",
+            json_data={"data_type": dataType.__dict__},
+        )
+        return ColumnDataType.from_json(resp_json)
+
     # Column Operations
 
-    async def CreateColumnAsync(self, column: Column, if_not_exists=False) -> Column:
+    async def CreateColumnAsync(
+        self, column: Column, if_not_exists: bool = False
+    ) -> Column:
         try:
             resp_json = await self._post_async(
                 "/userstore/config/columns", json_data={"column": column.__dict__}
@@ -229,7 +280,7 @@ async def UpdateColumnAsync(self, column: Column) -> Column:
     # Purpose Operations
 
     async def CreatePurposeAsync(
-        self, purpose: Purpose, if_not_exists=False
+        self, purpose: Purpose, if_not_exists: bool = False
     ) -> Purpose:
         try:
             resp_json = await self._post_async(
@@ -438,7 +489,7 @@ async def UpdateSoftDeletedRetentionDurationsOnColumnAsync(
     # Access Policy Templates
 
     async def CreateAccessPolicyTemplateAsync(
-        self, access_policy_template: AccessPolicyTemplate, if_not_exists=False
+        self, access_policy_template: AccessPolicyTemplate, if_not_exists: bool = False
     ) -> AccessPolicyTemplate | UserCloudsSDKError:
         try:
             resp_json = await self._post_async(
@@ -498,7 +549,7 @@ async def DeleteAccessPolicyTemplateAsync(self, id: uuid.UUID, version: int):
     # Access Policies
 
     async def CreateAccessPolicyAsync(
-        self, access_policy: AccessPolicy, if_not_exists=False
+        self, access_policy: AccessPolicy, if_not_exists: bool = False
     ) -> AccessPolicy | UserCloudsSDKError:
         try:
             resp_json = await self._post_async(
@@ -552,7 +603,7 @@ async def DeleteAccessPolicyAsync(self, id: uuid.UUID, version: int):
     # Transformers
 
     async def CreateTransformerAsync(
-        self, transformer: Transformer, if_not_exists=False
+        self, transformer: Transformer, if_not_exists: bool = False
     ):
         try:
             resp_json = await self._post_async(
@@ -589,7 +640,7 @@ async def DeleteTransformerAsync(self, id: uuid.UUID):
     # Accessor Operations
 
     async def CreateAccessorAsync(
-        self, accessor: Accessor, if_not_exists=False
+        self, accessor: Accessor, if_not_exists: bool = False
     ) -> Accessor:
         try:
             resp_json = await self._post_async(
@@ -643,7 +694,7 @@ async def ExecuteAccessorAsync(
     # Mutator Operations
 
     async def CreateMutatorAsync(
-        self, mutator: Mutator, if_not_exists=False
+        self, mutator: Mutator, if_not_exists: bool = False
     ) -> Mutator:
         try:
             resp_json = await self._post_async(
@@ -783,7 +834,9 @@ async def ListObjectsAsync(
         objects = [Object.from_json(o) for o in j["data"]]
         return objects
 
-    async def CreateObjectAsync(self, object: Object, if_not_exists=False) -> Object:
+    async def CreateObjectAsync(
+        self, object: Object, if_not_exists: bool = False
+    ) -> Object:
         try:
             j = await self._post_async(
                 "/authz/objects", json_data={"object": object.__dict__}
@@ -816,7 +869,7 @@ async def ListEdgesAsync(
         edges = [Edge.from_json(e) for e in j["data"]]
         return edges
 
-    async def CreateEdgeAsync(self, edge: Edge, if_not_exists=False) -> Edge:
+    async def CreateEdgeAsync(self, edge: Edge, if_not_exists: bool = False) -> Edge:
         try:
             j = await self._post_async(
                 "/authz/edges", json_data={"edge": edge.__dict__}
@@ -850,7 +903,7 @@ async def ListObjectTypesAsync(
         return object_types
 
     async def CreateObjectTypeAsync(
-        self, object_type: ObjectType, if_not_exists=False
+        self, object_type: ObjectType, if_not_exists: bool = False
     ) -> ObjectType:
         try:
             j = await self._post_async(
@@ -885,7 +938,7 @@ async def ListEdgeTypesAsync(
         return edge_types
 
     async def CreateEdgeTypeAsync(
-        self, edge_type: EdgeType, if_not_exists=False
+        self, edge_type: EdgeType, if_not_exists: bool = False
     ) -> EdgeType:
         try:
             j = await self._post_async(
@@ -920,7 +973,7 @@ async def ListOrganizationsAsync(
         return organizations
 
     async def CreateOrganizationAsync(
-        self, organization: Organization, if_not_exists=False
+        self, organization: Organization, if_not_exists: bool = False
     ) -> Organization:
         try:
             json_data = await self._post_async(

src/usercloudssdk/client.py

@@ -19,6 +19,7 @@
     AccessPolicyTemplate,
     Column,
     ColumnConsentedPurposes,
+    ColumnDataType,
     ColumnRetentionDurationResponse,
     ColumnRetentionDurationsResponse,
     Edge,
@@ -179,9 +180,55 @@ def CreateUserWithMutator(
         }
         return self._post("/userstore/api/users", json_data=body)
 
+    # ColumnDataType Operations
+
+    def CreateColumnDataType(
+        self, dataType: ColumnDataType, if_not_exists: bool = False
+    ) -> ColumnDataType:
+        try:
+            resp_json = self._post(
+                "/userstore/config/datatypes",
+                json_data={"data_type": dataType.__dict__},
+            )
+            return ColumnDataType.from_json(resp_json)
+        except UserCloudsSDKError as err:
+            if if_not_exists:
+                dataType.id = _id_from_identical_conflict(err)
+                return dataType
+            raise err
+
+    def DeleteColumnDataType(self, id: uuid.UUID) -> bool:
+        return self._delete(f"/userstore/config/datatypes/{id}")
+
+    def GetColumnDataType(self, id: uuid.UUID) -> ColumnDataType:
+        resp_json = self._get(f"/userstore/config/datatypes/{id}")
+        return ColumnDataType.from_json(resp_json)
+
+    def ListColumnDataTypes(
+        self, limit: int = 0, starting_after: uuid.UUID | None = None
+    ) -> list[ColumnDataType]:
+        params: dict[str, int | str] = {}
+        if limit > 0:
+            params["limit"] = limit
+        if starting_after is not None:
+            params["starting_after"] = f"id:{starting_after}"
+        params["version"] = "3"
+        resp_json = self._get("/userstore/config/datatypes", params=params)
+        dataTypes = [
+            ColumnDataType.from_json(dataType) for dataType in resp_json["data"]
+        ]
+        return dataTypes
+
+    def UpdateColumnDataType(self, dataType: ColumnDataType) -> ColumnDataType:
+        resp_json = self._put(
+            f"/userstore/config/datatypes/{dataType.id}",
+            json_data={"data_type": dataType.__dict__},
+        )
+        return ColumnDataType.from_json(resp_json)
+
     # Column Operations
 
-    def CreateColumn(self, column: Column, if_not_exists=False) -> Column:
+    def CreateColumn(self, column: Column, if_not_exists: bool = False) -> Column:
         try:
             resp_json = self._post(
                 "/userstore/config/columns", json_data={"column": column.__dict__}
@@ -222,7 +269,7 @@ def UpdateColumn(self, column: Column) -> Column:
 
     # Purpose Operations
 
-    def CreatePurpose(self, purpose: Purpose, if_not_exists=False) -> Purpose:
+    def CreatePurpose(self, purpose: Purpose, if_not_exists: bool = False) -> Purpose:
         try:
             resp_json = self._post(
                 "/userstore/config/purposes", json_data={"purpose": purpose.__dict__}
@@ -428,7 +475,7 @@ def UpdateSoftDeletedRetentionDurationsOnColumn(
     # Access Policy Templates
 
     def CreateAccessPolicyTemplate(
-        self, access_policy_template: AccessPolicyTemplate, if_not_exists=False
+        self, access_policy_template: AccessPolicyTemplate, if_not_exists: bool = False
     ) -> AccessPolicyTemplate | UserCloudsSDKError:
         try:
             resp_json = self._post(
@@ -480,7 +527,7 @@ def DeleteAccessPolicyTemplate(self, id: uuid.UUID, version: int):
     # Access Policies
 
     def CreateAccessPolicy(
-        self, access_policy: AccessPolicy, if_not_exists=False
+        self, access_policy: AccessPolicy, if_not_exists: bool = False
     ) -> AccessPolicy | UserCloudsSDKError:
         try:
             resp_json = self._post(
@@ -531,7 +578,7 @@ def DeleteAccessPolicy(self, id: uuid.UUID, version: int):
 
     # Transformers
 
-    def CreateTransformer(self, transformer: Transformer, if_not_exists=False):
+    def CreateTransformer(self, transformer: Transformer, if_not_exists: bool = False):
         try:
             resp_json = self._post(
                 "/tokenizer/policies/transformation",
@@ -562,7 +609,9 @@ def DeleteTransformer(self, id: uuid.UUID):
 
     # Accessor Operations
 
-    def CreateAccessor(self, accessor: Accessor, if_not_exists=False) -> Accessor:
+    def CreateAccessor(
+        self, accessor: Accessor, if_not_exists: bool = False
+    ) -> Accessor:
         try:
             resp_json = self._post(
                 "/userstore/config/accessors", json_data={"accessor": accessor.__dict__}
@@ -614,7 +663,7 @@ def ExecuteAccessor(
 
     # Mutator Operations
 
-    def CreateMutator(self, mutator: Mutator, if_not_exists=False) -> Mutator:
+    def CreateMutator(self, mutator: Mutator, if_not_exists: bool = False) -> Mutator:
         try:
             resp_json = self._post(
                 "/userstore/config/mutators", json_data={"mutator": mutator.__dict__}
@@ -751,7 +800,7 @@ def ListObjects(
         objects = [Object.from_json(o) for o in j["data"]]
         return objects
 
-    def CreateObject(self, object: Object, if_not_exists=False) -> Object:
+    def CreateObject(self, object: Object, if_not_exists: bool = False) -> Object:
         try:
             j = self._post("/authz/objects", json_data={"object": object.__dict__})
             return Object.from_json(j)
@@ -782,7 +831,7 @@ def ListEdges(
         edges = [Edge.from_json(e) for e in j["data"]]
         return edges
 
-    def CreateEdge(self, edge: Edge, if_not_exists=False) -> Edge:
+    def CreateEdge(self, edge: Edge, if_not_exists: bool = False) -> Edge:
         try:
             j = self._post("/authz/edges", json_data={"edge": edge.__dict__})
             return Edge.from_json(j)
@@ -814,7 +863,7 @@ def ListObjectTypes(
         return object_types
 
     def CreateObjectType(
-        self, object_type: ObjectType, if_not_exists=False
+        self, object_type: ObjectType, if_not_exists: bool = False
     ) -> ObjectType:
         try:
             j = self._post(
@@ -848,7 +897,9 @@ def ListEdgeTypes(
         edge_types = [EdgeType.from_json(et) for et in j["data"]]
         return edge_types
 
-    def CreateEdgeType(self, edge_type: EdgeType, if_not_exists=False) -> EdgeType:
+    def CreateEdgeType(
+        self, edge_type: EdgeType, if_not_exists: bool = False
+    ) -> EdgeType:
         try:
             j = self._post(
                 "/authz/edgetypes", json_data={"edge_type": edge_type.__dict__}
@@ -882,7 +933,7 @@ def ListOrganizations(
         return organizations
 
     def CreateOrganization(
-        self, organization: Organization, if_not_exists=False
+        self, organization: Organization, if_not_exists: bool = False
     ) -> Organization:
         try:
             json_data = self._post(

src/usercloudssdk/data_types.py

@@ -0,0 +1,15 @@
+from .models import ResourceID
+
+# Note: these need to stay in sync with idp/userstore/datatype/constants.go
+ColumnDataTypeAddress = ResourceID(name="address")
+ColumnDataTypeBirthdate = ResourceID(name="birthdate")
+ColumnDataTypeBoolean = ResourceID(name="boolean")
+ColumnDataTypeDate = ResourceID(name="date")
+ColumnDataTypeE164PhoneNumber = ResourceID(name="e164_phonenumber")
+ColumnDataTypeEmail = ResourceID(name="email")
+ColumnDataTypeInteger = ResourceID(name="integer")
+ColumnDataTypePhoneNumber = ResourceID(name="phonenumber")
+ColumnDataTypeSSN = ResourceID(name="ssn")
+ColumnDataTypeString = ResourceID(name="string")
+ColumnDataTypeTimestamp = ResourceID(name="timestamp")
+ColumnDataTypeUUID = ResourceID(name="uuid")