cleanup on docstrings

Author: gjtorikian

src/workos/__init__.py

@@ -3,7 +3,17 @@
 """WorkOS Python SDK."""
 
 from ._client import AsyncWorkOSClient, WorkOSClient
-from ._errors import WorkOSError
+from ._errors import (
+    WorkOSError,
+    AuthenticationError,
+    AuthorizationError,
+    BadRequestError,
+    ConflictError,
+    NotFoundError,
+    RateLimitExceededError,
+    ServerError,
+    UnprocessableEntityError,
+)
 from ._pagination import AsyncPage, ListMetadata, SyncPage
 from .public_client import create_public_client
 from ._types import RequestOptions
@@ -12,6 +22,14 @@
     "WorkOSClient",
     "AsyncWorkOSClient",
     "WorkOSError",
+    "AuthenticationError",
+    "AuthorizationError",
+    "BadRequestError",
+    "ConflictError",
+    "NotFoundError",
+    "RateLimitExceededError",
+    "ServerError",
+    "UnprocessableEntityError",
     "SyncPage",
     "AsyncPage",
     "ListMetadata",

src/workos/_client.py

@@ -129,18 +129,22 @@ def mfa(self) -> MultiFactorAuth:
 
     @functools.cached_property
     def passwordless(self) -> Passwordless:
+        """Passwordless authentication sessions."""
         return Passwordless(self)
 
     @functools.cached_property
     def vault(self) -> Vault:
+        """Vault encryption, key management, and secret storage."""
         return Vault(self)
 
     @functools.cached_property
     def actions(self) -> Actions:
+        """Actions logging and audit trail."""
         return Actions()
 
     @functools.cached_property
     def pkce(self) -> PKCE:
+        """PKCE (Proof Key for Code Exchange) utilities."""
         return PKCE()
 
 
@@ -239,16 +243,20 @@ def mfa(self) -> AsyncMultiFactorAuth:
 
     @functools.cached_property
     def passwordless(self) -> AsyncPasswordless:
+        """Passwordless authentication sessions."""
         return AsyncPasswordless(self)
 
     @functools.cached_property
     def vault(self) -> AsyncVault:
+        """Vault encryption, key management, and secret storage."""
         return AsyncVault(self)
 
     @functools.cached_property
     def actions(self) -> AsyncActions:
+        """Actions logging and audit trail."""
         return AsyncActions()
 
     @functools.cached_property
     def pkce(self) -> PKCE:
+        """PKCE (Proof Key for Code Exchange) utilities."""
         return PKCE()

src/workos/api_keys/_resource.py

@@ -95,10 +95,10 @@ def list_organization_api_keys(
 
         Args:
             organization_id: Unique identifier of the Organization.
-            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            limit: Upper limit on the number of objects to return, between `1` and `100`. Defaults to `10`.
             before: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
             after: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
-            order: Order the results by the creation time.
+            order: Order the results by the creation time. Defaults to `desc`.
             request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
 
         Returns:
@@ -255,10 +255,10 @@ async def list_organization_api_keys(
 
         Args:
             organization_id: Unique identifier of the Organization.
-            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            limit: Upper limit on the number of objects to return, between `1` and `100`. Defaults to `10`.
             before: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
             after: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
-            order: Order the results by the creation time.
+            order: Order the results by the creation time. Defaults to `desc`.
             request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
 
         Returns:

src/workos/audit_logs/_resource.py

@@ -109,10 +109,10 @@ def list_actions(
         Get a list of all Audit Log actions in the current environment.
 
         Args:
-            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            limit: Upper limit on the number of objects to return, between `1` and `100`. Defaults to `10`.
             before: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
             after: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
-            order: Order the results by the creation time.
+            order: Order the results by the creation time. Defaults to `desc`.
             request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
 
         Returns:
@@ -159,10 +159,10 @@ def list_action_schemas(
 
         Args:
             action_name: The name of the Audit Log action.
-            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            limit: Upper limit on the number of objects to return, between `1` and `100`. Defaults to `10`.
             before: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
             after: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
-            order: Order the results by the creation time.
+            order: Order the results by the creation time. Defaults to `desc`.
             request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
 
         Returns:
@@ -464,10 +464,10 @@ async def list_actions(
         Get a list of all Audit Log actions in the current environment.
 
         Args:
-            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            limit: Upper limit on the number of objects to return, between `1` and `100`. Defaults to `10`.
             before: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
             after: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
-            order: Order the results by the creation time.
+            order: Order the results by the creation time. Defaults to `desc`.
             request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
 
         Returns:
@@ -514,10 +514,10 @@ async def list_action_schemas(
 
         Args:
             action_name: The name of the Audit Log action.
-            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            limit: Upper limit on the number of objects to return, between `1` and `100`. Defaults to `10`.
             before: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
             after: An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
-            order: Order the results by the creation time.
+            order: Order the results by the creation time. Defaults to `desc`.
             request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
 
         Returns:

src/workos/audit_logs/models/audit_log_export_creation.py

@@ -22,7 +22,7 @@ class AuditLogExportCreation:
     actors: Optional[List[str]] = None
     """Deprecated. Use `actor_names` instead.
 
-    .. deprecated::"""
+    .. deprecated:: This field is deprecated."""
     actor_names: Optional[List[str]] = None
     """List of actor names to filter against."""
     actor_ids: Optional[List[str]] = None