Rely on Python annotations for docstring types

Author: razor-x

codegen/lib/layouts/resources.ts

@@ -85,7 +85,6 @@ const createResourceDocstring = (
       ]
         .filter(Boolean)
         .join(' ')}`,
-      `:vartype ${toSafeIdentifier(property.name)}: ${mapPropertyToPythonType(property)}`,
     )
   }
   if (isDeprecated) {

codegen/lib/layouts/route.ts

@@ -75,24 +75,18 @@ const methodDocstring = (
     lines.push(
       '',
       `:param ${parameter.name}: ${[deprecated, description].filter(Boolean).join(' ')}`,
-      `:type ${parameter.name}: ${parameter.type}`,
     )
   }
 
   if (method.returnResource === 'ActionAttempt') {
     lines.push(
       '',
       ':param wait_for_action_attempt: Whether, and for how long, to wait for the action attempt to finish.',
-      ':type wait_for_action_attempt: Optional[Union[bool, Dict[str, float]]]',
     )
   }
 
   if (method.returnResource !== 'None') {
-    lines.push(
-      '',
-      `:returns: ${formatPythonDoc(method.responseDescription)}`,
-      `:rtype: ${method.returnResource}`,
-    )
+    lines.push('', `:returns: ${formatPythonDoc(method.responseDescription)}`)
   }
 
   if (method.isDeprecated) {

seam/resources/access_code.py

@@ -16,76 +16,53 @@ class AccessCode:
     For granting a person access to a space, `Access Grants <https://docs.seam.co/use-cases/granting-access>`_ are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
 
     :ivar access_code_id: Unique identifier for the access code.
-    :vartype access_code_id: str
 
     :ivar code: Code used for access. Typically, a numeric or alphanumeric string.
-    :vartype code: str
 
     :ivar common_code_key: Unique identifier for a group of access codes that share the same code.
-    :vartype common_code_key: str
 
     :ivar created_at: Date and time at which the access code was created.
-    :vartype created_at: str
 
     :ivar device_id: Unique identifier for the device associated with the access code.
-    :vartype device_id: str
 
     :ivar dormakaba_oracode_metadata: Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.
-    :vartype dormakaba_oracode_metadata: Dict[str, Any]
 
     :ivar ends_at: Date and time after which the time-bound access code becomes inactive.
-    :vartype ends_at: str
 
     :ivar errors: Errors associated with the `access code <https://docs.seam.co/low-level-apis/smart-locks/access-codes>`_.
-    :vartype errors: List[Dict[str, Any]]
 
     :ivar is_backup: Indicates whether the access code is a backup code.
-    :vartype is_backup: bool
 
     :ivar is_backup_access_code_available: Indicates whether a backup access code is available for use if the primary access code is lost or compromised.
-    :vartype is_backup_access_code_available: bool
 
     :ivar is_external_modification_allowed: Indicates whether changes to the access code from external sources are permitted.
-    :vartype is_external_modification_allowed: bool
 
     :ivar is_managed: Indicates whether Seam manages the access code.
-    :vartype is_managed: bool
 
     :ivar is_offline_access_code: Indicates whether the access code is intended for use in offline scenarios. If ``true``, this code can be created on a device without a network connection.
-    :vartype is_offline_access_code: bool
 
     :ivar is_one_time_use: Indicates whether the access code can only be used once. If ``true``, the code becomes invalid after the first use.
-    :vartype is_one_time_use: bool
 
     :ivar is_scheduled_on_device: Indicates whether the code is set on the device according to a preconfigured schedule.
-    :vartype is_scheduled_on_device: bool
 
     :ivar is_waiting_for_code_assignment: Indicates whether the access code is waiting for a code assignment.
-    :vartype is_waiting_for_code_assignment: bool
 
     :ivar name: Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as ``first_name`` and ``last_name``. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called ``appearance``. This is an object with a ``name`` property and, optionally, ``first_name`` and ``last_name`` properties (for providers that break down a name into components).
-    :vartype name: str
 
     :ivar pending_mutations: Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.
-    :vartype pending_mutations: List[Dict[str, Any]]
 
     :ivar pulled_backup_access_code_id: Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code.
-    :vartype pulled_backup_access_code_id: str
 
     :ivar starts_at: Date and time at which the time-bound access code becomes active.
-    :vartype starts_at: str
 
     :ivar status: Current status of the access code within the operational lifecycle. Values are ``setting``, a transitional phase that indicates that the code is being configured or activated; ``set``, which indicates that the code is active and operational; ``unset``, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; ``removing``, which indicates a transitional period in which the code is being deleted or made inactive; and ``unknown``, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also `Lifecycle of Access Codes <https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes>`_.
-    :vartype status: str
 
     :ivar type: Type of the access code. ``ongoing`` access codes are active continuously until deactivated manually. ``time_bound`` access codes have a specific duration.
-    :vartype type: str
 
     :ivar warnings: Warnings associated with the `access code <https://docs.seam.co/low-level-apis/smart-locks/access-codes>`_.
-    :vartype warnings: List[Dict[str, Any]]
 
     :ivar workspace_id: Unique identifier for the Seam workspace associated with the access code.
-    :vartype workspace_id: str"""
+    """
 
     access_code_id: str
     code: str

seam/resources/access_grant.py

@@ -8,64 +8,44 @@ class AccessGrant:
     """Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.
 
     :ivar access_grant_id: ID of the Access Grant.
-    :vartype access_grant_id: str
 
     :ivar access_grant_key: Unique key for the access grant within the workspace.
-    :vartype access_grant_key: str
 
     :ivar access_method_ids: IDs of the access methods created for the Access Grant.
-    :vartype access_method_ids: List[str]
 
     :ivar client_session_token: Client Session Token. Only returned if the Access Grant has a mobile_key access method.
-    :vartype client_session_token: str
 
     :ivar created_at: Date and time at which the Access Grant was created.
-    :vartype created_at: str
 
     :ivar customization_profile_id: ID of the customization profile associated with the Access Grant.
-    :vartype customization_profile_id: str
 
     :ivar display_name: Display name of the Access Grant.
-    :vartype display_name: str
 
     :ivar ends_at: Date and time at which the Access Grant ends.
-    :vartype ends_at: str
 
     :ivar errors: Errors associated with the `access grant <https://docs.seam.co/use-cases/granting-access>`_.
-    :vartype errors: List[Dict[str, Any]]
 
     :ivar instant_key_url: Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.
-    :vartype instant_key_url: str
 
     :ivar location_ids: Deprecated: Use ``space_ids``.
-    :vartype location_ids: List[str]
 
     :ivar name: Name of the Access Grant. If not provided, the display name will be computed.
-    :vartype name: str
 
     :ivar pending_mutations: List of pending mutations for the access grant. This shows updates that are in progress.
-    :vartype pending_mutations: List[Dict[str, Any]]
 
     :ivar requested_access_methods: Access methods that the user requested for the Access Grant.
-    :vartype requested_access_methods: List[Dict[str, Any]]
 
     :ivar reservation_key: Reservation key for the access grant.
-    :vartype reservation_key: str
 
     :ivar space_ids: IDs of the spaces to which the Access Grant gives access.
-    :vartype space_ids: List[str]
 
     :ivar starts_at: Date and time at which the Access Grant starts.
-    :vartype starts_at: str
 
     :ivar user_identity_id: ID of user identity to which the Access Grant gives access.
-    :vartype user_identity_id: str
 
     :ivar warnings: Warnings associated with the `access grant <https://docs.seam.co/use-cases/granting-access>`_.
-    :vartype warnings: List[Dict[str, Any]]
 
-    :ivar workspace_id: ID of the Seam workspace associated with the Access Grant.
-    :vartype workspace_id: str"""
+    :ivar workspace_id: ID of the Seam workspace associated with the Access Grant."""
 
     access_grant_id: str
     access_grant_key: str

seam/resources/access_method.py

@@ -8,58 +8,40 @@ class AccessMethod:
     """Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
 
     :ivar access_method_id: ID of the access method.
-    :vartype access_method_id: str
 
     :ivar client_session_token: Token of the client session associated with the access method.
-    :vartype client_session_token: str
 
     :ivar code: The actual PIN code for code access methods.
-    :vartype code: str
 
     :ivar created_at: Date and time at which the access method was created.
-    :vartype created_at: str
 
     :ivar customization_profile_id: ID of the customization profile associated with the access method.
-    :vartype customization_profile_id: str
 
     :ivar display_name: Display name of the access method.
-    :vartype display_name: str
 
     :ivar errors: Errors associated with the `access method <https://docs.seam.co/use-cases/granting-access/creating-an-access-grant>`_.
-    :vartype errors: List[Dict[str, Any]]
 
     :ivar instant_key_url: URL of the Instant Key for mobile key access methods.
-    :vartype instant_key_url: str
 
     :ivar is_assignment_required: Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment.
-    :vartype is_assignment_required: bool
 
     :ivar is_encoding_required: Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.
-    :vartype is_encoding_required: bool
 
     :ivar is_issued: Indicates whether the access method has been issued.
-    :vartype is_issued: bool
 
     :ivar is_ready_for_assignment: Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment.
-    :vartype is_ready_for_assignment: bool
 
     :ivar is_ready_for_encoding: Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
-    :vartype is_ready_for_encoding: bool
 
     :ivar issued_at: Date and time at which the access method was issued.
-    :vartype issued_at: str
 
     :ivar mode: Access method mode. Supported values: ``code``, ``card``, ``mobile_key``, ``cloud_key``.
-    :vartype mode: str
 
     :ivar pending_mutations: Pending mutations for the `access method <https://docs.seam.co/use-cases/granting-access/creating-an-access-grant>`_. Indicates operations that are in progress.
-    :vartype pending_mutations: List[Dict[str, Any]]
 
     :ivar warnings: Warnings associated with the `access method <https://docs.seam.co/use-cases/granting-access/creating-an-access-grant>`_.
-    :vartype warnings: List[Dict[str, Any]]
 
-    :ivar workspace_id: ID of the Seam workspace associated with the access method.
-    :vartype workspace_id: str"""
+    :ivar workspace_id: ID of the Seam workspace associated with the access method."""
 
     access_method_id: str
     client_session_token: str

seam/resources/acs_access_group.py

@@ -12,52 +12,36 @@ class AcsAccessGroup:
     To learn whether your access control system supports access groups, see the corresponding `system integration guide <https://docs.seam.co/device-and-system-integration-guides#access-control-systems>`_.
 
     :ivar access_group_type: Deprecated: Use ``external_type``.
-    :vartype access_group_type: str
 
     :ivar access_group_type_display_name: Deprecated: Use ``external_type_display_name``.
-    :vartype access_group_type_display_name: str
 
     :ivar access_schedule: ``starts_at`` and ``ends_at`` timestamps for the access group's access.
-    :vartype access_schedule: Dict[str, Any]
 
     :ivar acs_access_group_id: ID of the access group.
-    :vartype acs_access_group_id: str
 
     :ivar acs_system_id: ID of the access control system that contains the access group.
-    :vartype acs_system_id: str
 
     :ivar connected_account_id: ID of the connected account that contains the access group.
-    :vartype connected_account_id: str
 
     :ivar created_at: Date and time at which the access group was created.
-    :vartype created_at: str
 
     :ivar display_name: Display name for the access group.
-    :vartype display_name: str
 
     :ivar errors: Errors associated with the ``acs_access_group``.
-    :vartype errors: List[Dict[str, Any]]
 
     :ivar external_type: Brand-specific terminology for the access group type.
-    :vartype external_type: str
 
     :ivar external_type_display_name: Display name that corresponds to the brand-specific terminology for the access group type.
-    :vartype external_type_display_name: str
 
     :ivar is_managed: Indicates whether Seam manages the access group.
-    :vartype is_managed: bool
 
     :ivar name: Name of the access group.
-    :vartype name: str
 
     :ivar pending_mutations: Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.
-    :vartype pending_mutations: List[Dict[str, Any]]
 
     :ivar warnings: Warnings associated with the ``acs_access_group``.
-    :vartype warnings: List[Dict[str, Any]]
 
-    :ivar workspace_id: ID of the workspace that contains the access group.
-    :vartype workspace_id: str"""
+    :ivar workspace_id: ID of the workspace that contains the access group."""
 
     access_group_type: str
     access_group_type_display_name: str