smartytalent-client 0.2.1.dev1__tar.gz → 0.2.1.dev3__tar.gz

{smartytalent_client-0.2.1.dev1/smartytalent_client.egg-info → smartytalent_client-0.2.1.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartytalent_client
-Version: 0.2.1.dev1
+Version: 0.2.1.dev3
 Summary: SmartyMeet Dev03 API REST
 Home-page: 
 Author: SmartyTalent API Support

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "smartytalent_client"
-version = "0.2.1.dev1"
+version = "0.2.1.dev3"
 description = "SmartyMeet Dev03 API REST"
 authors = [
   {name = "SmartyTalent API Support",email = "developer@smartymeet.com"},

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3}/smartytalent_client/api/tenants_api.py

@@ -624,6 +624,7 @@ class TenantsApi:
     def delete_tenant(
         self,
         tenant_id: Annotated[StrictStr, Field(description="The tenant's identifier")],
+        permanent_delete: Annotated[Optional[StrictStr], Field(description="Set to true for immediate irreversible purge of all tenant data. Defaults to false (soft archive with a retention window).")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -639,10 +640,12 @@ class TenantsApi:
     ) -> None:
         """Delete Tenant
 
-        This endpoint allows you to delete a specific tenant from your account. Once deleted, the tenant's information will be permanently removed and cannot be recovered.
+        Two-phase deletion. Default (soft delete): archives the tenant (`status -> archived`), stamps `archivedAt`, and freezes all of its activity (automations, API keys, user logins). Reversible via `PATCH` with `attributes.status = \"active\"` within the retention window; after the window the tenant is automatically and permanently purged. Permanent delete (`?permanentDelete=true`): flips the tenant to `status = purging` and immediately, irreversibly destroys every trace of it (all data, users, files and secrets). Cannot be undone. The system tenant can never be deleted.
 
         :param tenant_id: The tenant's identifier (required)
         :type tenant_id: str
+        :param permanent_delete: Set to true for immediate irreversible purge of all tenant data. Defaults to false (soft archive with a retention window).
+        :type permanent_delete: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -667,6 +670,7 @@ class TenantsApi:
 
         _param = self._delete_tenant_serialize(
             tenant_id=tenant_id,
+            permanent_delete=permanent_delete,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -691,6 +695,7 @@ class TenantsApi:
     def delete_tenant_with_http_info(
         self,
         tenant_id: Annotated[StrictStr, Field(description="The tenant's identifier")],
+        permanent_delete: Annotated[Optional[StrictStr], Field(description="Set to true for immediate irreversible purge of all tenant data. Defaults to false (soft archive with a retention window).")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -706,10 +711,12 @@ class TenantsApi:
     ) -> ApiResponse[None]:
         """Delete Tenant
 
-        This endpoint allows you to delete a specific tenant from your account. Once deleted, the tenant's information will be permanently removed and cannot be recovered.
+        Two-phase deletion. Default (soft delete): archives the tenant (`status -> archived`), stamps `archivedAt`, and freezes all of its activity (automations, API keys, user logins). Reversible via `PATCH` with `attributes.status = \"active\"` within the retention window; after the window the tenant is automatically and permanently purged. Permanent delete (`?permanentDelete=true`): flips the tenant to `status = purging` and immediately, irreversibly destroys every trace of it (all data, users, files and secrets). Cannot be undone. The system tenant can never be deleted.
 
         :param tenant_id: The tenant's identifier (required)
         :type tenant_id: str
+        :param permanent_delete: Set to true for immediate irreversible purge of all tenant data. Defaults to false (soft archive with a retention window).
+        :type permanent_delete: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -734,6 +741,7 @@ class TenantsApi:
 
         _param = self._delete_tenant_serialize(
             tenant_id=tenant_id,
+            permanent_delete=permanent_delete,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -758,6 +766,7 @@ class TenantsApi:
     def delete_tenant_without_preload_content(
         self,
         tenant_id: Annotated[StrictStr, Field(description="The tenant's identifier")],
+        permanent_delete: Annotated[Optional[StrictStr], Field(description="Set to true for immediate irreversible purge of all tenant data. Defaults to false (soft archive with a retention window).")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -773,10 +782,12 @@ class TenantsApi:
     ) -> RESTResponseType:
         """Delete Tenant
 
-        This endpoint allows you to delete a specific tenant from your account. Once deleted, the tenant's information will be permanently removed and cannot be recovered.
+        Two-phase deletion. Default (soft delete): archives the tenant (`status -> archived`), stamps `archivedAt`, and freezes all of its activity (automations, API keys, user logins). Reversible via `PATCH` with `attributes.status = \"active\"` within the retention window; after the window the tenant is automatically and permanently purged. Permanent delete (`?permanentDelete=true`): flips the tenant to `status = purging` and immediately, irreversibly destroys every trace of it (all data, users, files and secrets). Cannot be undone. The system tenant can never be deleted.
 
         :param tenant_id: The tenant's identifier (required)
         :type tenant_id: str
+        :param permanent_delete: Set to true for immediate irreversible purge of all tenant data. Defaults to false (soft archive with a retention window).
+        :type permanent_delete: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -801,6 +812,7 @@ class TenantsApi:
 
         _param = self._delete_tenant_serialize(
             tenant_id=tenant_id,
+            permanent_delete=permanent_delete,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -820,6 +832,7 @@ class TenantsApi:
     def _delete_tenant_serialize(
         self,
         tenant_id,
+        permanent_delete,
         _request_auth,
         _content_type,
         _headers,
@@ -844,6 +857,10 @@ class TenantsApi:
         if tenant_id is not None:
             _path_params['tenantId'] = tenant_id
         # process the query parameters
+        if permanent_delete is not None:
+            
+            _query_params.append(('permanentDelete', permanent_delete))
+            
         # process the header parameters
         # process the form parameters
         # process the body parameter

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3}/smartytalent_client/models/tenant_attributes_schema.py

@@ -38,6 +38,7 @@ class TenantAttributesSchema(BaseModel):
     email: Annotated[str, Field(min_length=5, strict=True, max_length=255)]
     status: Optional[StrictStr] = None
     short_code: Optional[StrictStr] = Field(default=None, alias="shortCode")
+    archived_at: Optional[datetime] = Field(default=None, description="ISO timestamp the tenant was archived (soft-deleted). Present only on archived/purging tenants; null otherwise. The deletion deadline is archivedAt + the retention window (90 days on prod/test).", alias="archivedAt")
     timestamps: Optional[ResourceTimestampsSchema] = None
     phone: Optional[StrictStr] = None
     address: Optional[TenantAttributesAddressSchema] = None
@@ -50,7 +51,7 @@ class TenantAttributesSchema(BaseModel):
     boe_phone: Optional[StrictStr] = Field(default=None, description="Twilio phone number assigned to the Boe AI agent for this tenant", alias="boePhone")
     boe_email: Optional[StrictStr] = Field(default=None, description="Email address assigned to the Boe AI agent for this tenant", alias="boeEmail")
     default_form_id: Optional[StrictStr] = Field(default=None, description="Tenant-wide default form used for guest submissions when no job-specific form is configured. Set to null to clear.", alias="defaultFormId")
-    __properties: ClassVar[List[str]] = ["name", "username", "email", "status", "shortCode", "timestamps", "phone", "address", "settings", "plan", "activeLanguages", "trialExpiryDate", "timezone", "logoUrl", "boePhone", "boeEmail", "defaultFormId"]
+    __properties: ClassVar[List[str]] = ["name", "username", "email", "status", "shortCode", "archivedAt", "timestamps", "phone", "address", "settings", "plan", "activeLanguages", "trialExpiryDate", "timezone", "logoUrl", "boePhone", "boeEmail", "defaultFormId"]
 
     model_config = ConfigDict(
         validate_by_name=True,
@@ -100,6 +101,11 @@ class TenantAttributesSchema(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of settings
         if self.settings:
             _dict['settings'] = self.settings.to_dict()
+        # set to None if archived_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.archived_at is None and "archived_at" in self.model_fields_set:
+            _dict['archivedAt'] = None
+
         # set to None if default_form_id (nullable) is None
         # and model_fields_set contains the field
         if self.default_form_id is None and "default_form_id" in self.model_fields_set:
@@ -122,6 +128,7 @@ class TenantAttributesSchema(BaseModel):
             "email": obj.get("email"),
             "status": obj.get("status"),
             "shortCode": obj.get("shortCode"),
+            "archivedAt": obj.get("archivedAt"),
             "timestamps": ResourceTimestampsSchema.from_dict(obj["timestamps"]) if obj.get("timestamps") is not None else None,
             "phone": obj.get("phone"),
             "address": TenantAttributesAddressSchema.from_dict(obj["address"]) if obj.get("address") is not None else None,

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3/smartytalent_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: smartytalent_client
-Version: 0.2.1.dev1
+Version: 0.2.1.dev3
 Summary: SmartyMeet Dev03 API REST
 Home-page: 
 Author: SmartyTalent API Support

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3}/test/test_create_tenant_request_body.py

@@ -44,6 +44,7 @@ class TestCreateTenantRequestBody(unittest.TestCase):
                         email = '01234', 
                         status = '', 
                         short_code = '', 
+                        archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                             created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                             modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), 
@@ -96,6 +97,7 @@ class TestCreateTenantRequestBody(unittest.TestCase):
                         email = '01234', 
                         status = '', 
                         short_code = '', 
+                        archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                             created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                             modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), 

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3}/test/test_create_tenant_request_body_data.py

@@ -43,6 +43,7 @@ class TestCreateTenantRequestBodyData(unittest.TestCase):
                     email = '01234', 
                     status = '', 
                     short_code = '', 
+                    archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                     timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                         created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), 
@@ -94,6 +95,7 @@ class TestCreateTenantRequestBodyData(unittest.TestCase):
                     email = '01234', 
                     status = '', 
                     short_code = '', 
+                    archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                     timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                         created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), 

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3}/test/test_tenant_attributes_schema.py

@@ -41,6 +41,7 @@ class TestTenantAttributesSchema(unittest.TestCase):
                 email = '01234',
                 status = '',
                 short_code = '',
+                archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
                 timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                     created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                     modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ),

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3}/test/test_tenant_resource_schema.py

@@ -44,6 +44,7 @@ class TestTenantResourceSchema(unittest.TestCase):
                     email = '01234', 
                     status = '', 
                     short_code = '', 
+                    archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                     timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                         created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), 
@@ -99,6 +100,7 @@ class TestTenantResourceSchema(unittest.TestCase):
                     email = '01234', 
                     status = '', 
                     short_code = '', 
+                    archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                     timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                         created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), 

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3}/test/test_update_tenant_request_body.py

@@ -45,6 +45,7 @@ class TestUpdateTenantRequestBody(unittest.TestCase):
                         email = '01234', 
                         status = '', 
                         short_code = '', 
+                        archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                             created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                             modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), 
@@ -98,6 +99,7 @@ class TestUpdateTenantRequestBody(unittest.TestCase):
                         email = '01234', 
                         status = '', 
                         short_code = '', 
+                        archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                             created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                             modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ), 

{smartytalent_client-0.2.1.dev1 → smartytalent_client-0.2.1.dev3}/test/test_update_tenant_request_body_data.py

@@ -44,6 +44,7 @@ class TestUpdateTenantRequestBodyData(unittest.TestCase):
                     email = '01234', 
                     status = '', 
                     short_code = '', 
+                    archived_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                     timestamps = smartytalent_client.models.resource_timestamps_schema.ResourceTimestampsSchema(
                         created = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
                         modified = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), ),