fix docstrings

Author: gjtorikian

src/workos/_client.py

@@ -28,10 +28,10 @@
 from .webhooks._resource import Webhooks, AsyncWebhooks
 from .widgets._resource import Widgets, AsyncWidgets
 from .audit_logs._resource import AuditLogs, AsyncAuditLogs
-from .actions import Actions, AsyncActions
 from .passwordless import AsyncPasswordless, Passwordless
-from .pkce import PKCE
 from .vault import AsyncVault, Vault
+from .actions import Actions, AsyncActions
+from .pkce import PKCE
 
 
 class WorkOSClient(_SyncBase):

src/workos/admin_portal/_resource.py

@@ -30,35 +30,34 @@ def generate_link(
     ) -> PortalLinkResponse:
         """Generate a Portal Link
 
-          Generate a Portal Link scoped to an Organization.
-
-          Args:
-              return_url: The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
-              success_url: The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
-              organization: An [Organization](https://workos.com/docs/reference/organization) identifier.
-              intent:
-        The intent of the Admin Portal.
-          - `sso` - Launch Admin Portal for creating SSO connections
-          - `dsync` - Launch Admin Portal for creating Directory Sync connections
-          - `audit_logs` - Launch Admin Portal for viewing Audit Logs
-          - `log_streams` - Launch Admin Portal for creating Log Streams
-          - `domain_verification` - Launch Admin Portal for Domain Verification
-          - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates
-          - `bring_your_own_key` - Launch Admin Portal for configuring Bring Your Own Key
-              intent_options: Options to configure the Admin Portal based on the intent.
-              request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
-
-          Returns:
-              PortalLinkResponse
-
-          Raises:
-              BadRequestError: If the request is malformed (400).
-              AuthorizationError: If the request is forbidden (403).
-              NotFoundError: If the resource is not found (404).
-              UnprocessableEntityError: If the request data is unprocessable (422).
-              AuthenticationError: If the API key is invalid (401).
-              RateLimitExceededError: If rate limited (429).
-              ServerError: If the server returns a 5xx error.
+        Generate a Portal Link scoped to an Organization.
+
+        Args:
+            return_url: The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
+            success_url: The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
+            organization: An [Organization](https://workos.com/docs/reference/organization) identifier.
+            intent: The intent of the Admin Portal.
+                - `sso` - Launch Admin Portal for creating SSO connections
+                - `dsync` - Launch Admin Portal for creating Directory Sync connections
+                - `audit_logs` - Launch Admin Portal for viewing Audit Logs
+                - `log_streams` - Launch Admin Portal for creating Log Streams
+                - `domain_verification` - Launch Admin Portal for Domain Verification
+                - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates
+                - `bring_your_own_key` - Launch Admin Portal for configuring Bring Your Own Key
+            intent_options: Options to configure the Admin Portal based on the intent.
+            request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
+
+        Returns:
+            PortalLinkResponse
+
+        Raises:
+            BadRequestError: If the request is malformed (400).
+            AuthorizationError: If the request is forbidden (403).
+            NotFoundError: If the resource is not found (404).
+            UnprocessableEntityError: If the request data is unprocessable (422).
+            AuthenticationError: If the API key is invalid (401).
+            RateLimitExceededError: If rate limited (429).
+            ServerError: If the server returns a 5xx error.
         """
         body: Dict[str, Any] = {
             k: v
@@ -100,35 +99,34 @@ async def generate_link(
     ) -> PortalLinkResponse:
         """Generate a Portal Link
 
-          Generate a Portal Link scoped to an Organization.
-
-          Args:
-              return_url: The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
-              success_url: The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
-              organization: An [Organization](https://workos.com/docs/reference/organization) identifier.
-              intent:
-        The intent of the Admin Portal.
-          - `sso` - Launch Admin Portal for creating SSO connections
-          - `dsync` - Launch Admin Portal for creating Directory Sync connections
-          - `audit_logs` - Launch Admin Portal for viewing Audit Logs
-          - `log_streams` - Launch Admin Portal for creating Log Streams
-          - `domain_verification` - Launch Admin Portal for Domain Verification
-          - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates
-          - `bring_your_own_key` - Launch Admin Portal for configuring Bring Your Own Key
-              intent_options: Options to configure the Admin Portal based on the intent.
-              request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
-
-          Returns:
-              PortalLinkResponse
-
-          Raises:
-              BadRequestError: If the request is malformed (400).
-              AuthorizationError: If the request is forbidden (403).
-              NotFoundError: If the resource is not found (404).
-              UnprocessableEntityError: If the request data is unprocessable (422).
-              AuthenticationError: If the API key is invalid (401).
-              RateLimitExceededError: If rate limited (429).
-              ServerError: If the server returns a 5xx error.
+        Generate a Portal Link scoped to an Organization.
+
+        Args:
+            return_url: The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
+            success_url: The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the [Redirects](https://dashboard.workos.com/redirects) page will be used.
+            organization: An [Organization](https://workos.com/docs/reference/organization) identifier.
+            intent: The intent of the Admin Portal.
+                - `sso` - Launch Admin Portal for creating SSO connections
+                - `dsync` - Launch Admin Portal for creating Directory Sync connections
+                - `audit_logs` - Launch Admin Portal for viewing Audit Logs
+                - `log_streams` - Launch Admin Portal for creating Log Streams
+                - `domain_verification` - Launch Admin Portal for Domain Verification
+                - `certificate_renewal` - Launch Admin Portal for renewing SAML Certificates
+                - `bring_your_own_key` - Launch Admin Portal for configuring Bring Your Own Key
+            intent_options: Options to configure the Admin Portal based on the intent.
+            request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
+
+        Returns:
+            PortalLinkResponse
+
+        Raises:
+            BadRequestError: If the request is malformed (400).
+            AuthorizationError: If the request is forbidden (403).
+            NotFoundError: If the resource is not found (404).
+            UnprocessableEntityError: If the request data is unprocessable (422).
+            AuthenticationError: If the API key is invalid (401).
+            RateLimitExceededError: If rate limited (429).
+            ServerError: If the server returns a 5xx error.
         """
         body: Dict[str, Any] = {
             k: v

src/workos/api_keys/_resource.py

@@ -95,10 +95,10 @@ def list_organization_api_keys(
 
         Args:
             organization_id: Unique identifier of the Organization.
-            limit: Maximum number of records to return (1-100, default: 10).
-            before: Pagination cursor for previous page.
-            after: Pagination cursor for next page.
-            order: Sort order.
+            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            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.
             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: Maximum number of records to return (1-100, default: 10).
-            before: Pagination cursor for previous page.
-            after: Pagination cursor for next page.
-            order: Sort order.
+            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            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.
             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: Maximum number of records to return (1-100, default: 10).
-            before: Pagination cursor for previous page.
-            after: Pagination cursor for next page.
-            order: Sort order.
+            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            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.
             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: Maximum number of records to return (1-100, default: 10).
-            before: Pagination cursor for previous page.
-            after: Pagination cursor for next page.
-            order: Sort order.
+            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            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.
             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: Maximum number of records to return (1-100, default: 10).
-            before: Pagination cursor for previous page.
-            after: Pagination cursor for next page.
-            order: Sort order.
+            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            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.
             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: Maximum number of records to return (1-100, default: 10).
-            before: Pagination cursor for previous page.
-            after: Pagination cursor for next page.
-            order: Sort order.
+            limit: Upper limit on the number of objects to return, between `1` and `100`.
+            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.
             request_options: Per-request options. Supports extra_headers, timeout, max_retries, and base_url override.
 
         Returns: