chore: add trigger resource reference

Author: angrybayblade

fern/docs.yml

@@ -317,6 +317,8 @@ navigation:
       path: pages/dist/sdk_reference/python/toolkits.md
     - page: Tools
       path: pages/dist/sdk_reference/python/tools.md
+    - page: Triggers
+      path: pages/dist/sdk_reference/python/triggers.md
 
 - tab: api-reference
   layout:

fern/generators/py_sdk/build.py

@@ -149,9 +149,10 @@ def generate_docs(attr: str, docspec: dict) -> str:
                 render += f"    - **{param_name}**: {param_desc}\n"
 
         render += "\n"
-        render += "**Returns**\n\n"
-        render += "    - " + doc.returns
-        render += "\n\n"
+        if doc.returns:
+            render += "**Returns**\n\n"
+            render += "    - " + doc.returns
+            render += "\n\n"
 
         if doc.raises:
             render += "**Raises**\n\n"

fern/pages/src/sdk_reference/python/triggers.md

@@ -21,26 +21,26 @@ Create a trigger instance
 
 ```python
 # Create a trigger using a user ID
-    trigger = composio.triggers.create(
-        slug="GITHUB_COMMIT_EVENT",
-        user_id="1234567890",
-        trigger_config={
-            "owner": "composiohq",
-            "repo": "composio",
-        },
-    )
-    print(trigger)
-
-    # Create a trigger using a connected account ID
-    trigger = composio.triggers.create(
-        slug="GITHUB_COMMIT_EVENT",
-        connected_account_id="1234567890",
-        trigger_config={
-            "owner": "composiohq",
-            "repo": "composio",
-        },
-    )
-    print(trigger)
+trigger = composio.triggers.create(
+    slug="GITHUB_COMMIT_EVENT",
+    user_id="<USER_ID>",
+    trigger_config={
+        "owner": "composiohq",
+        "repo": "composio",
+    },
+)
+print(trigger)
+
+# Create a trigger using a connected account ID
+trigger = composio.triggers.create(
+    slug="GITHUB_COMMIT_EVENT",
+    connected_account_id="<CONNECTED_ACCOUNT_ID>",
+    trigger_config={
+        "owner": "composiohq",
+        "repo": "composio",
+    },
+)
+print(trigger)
 ```
 
 ## composio.triggers.delete
@@ -51,15 +51,10 @@ Delete a trigger instance.
 
     - **trigger_id**: The ID of the trigger to delete. 
 
-**Returns**
-
-    - 
-
 **Examples**
 
 ```python
-# Delete a trigger
-    composio.triggers.delete(trigger_id="1234567890")
+composio.triggers.delete(trigger_id="<TRIGGER_ID>")
 ```
 
 ## composio.triggers.disable
@@ -70,15 +65,10 @@ Disable a trigger instance.
 
     - **trigger_id**: The ID of the trigger to disable. 
 
-**Returns**
-
-    - 
-
 **Examples**
 
 ```python
-# Disable a trigger
-    composio.triggers.disable(trigger_id="1234567890")
+composio.triggers.disable(trigger_id="<TRIGGER_ID>")
 ```
 
 ## composio.triggers.enable
@@ -89,15 +79,10 @@ Enable a trigger instance.
 
     - **trigger_id**: The ID of the trigger to enable. 
 
-**Returns**
-
-    - 
-
 **Examples**
 
 ```python
-# Enable a trigger
-    composio.triggers.enable(trigger_id="1234567890")
+composio.triggers.enable(trigger_id="<TRIGGER_ID>")
 ```
 
 ## composio.triggers.get_type
@@ -115,9 +100,8 @@ Get a trigger type by slug.
 **Examples**
 
 ```python
-# Get a trigger type by slug
-    trigger_type = composio.triggers.get_type(slug="GITHUB_COMMIT_EVENT")
-    print(trigger_type)
+trigger_type = composio.triggers.get_type(slug="GITHUB_COMMIT_EVENT")
+print(trigger_type)
 ```
 
 ## composio.triggers.list
@@ -137,9 +121,8 @@ List all trigger types.
 **Examples**
 
 ```python
-# List all trigger types
-    triggers = composio.triggers.list()
-    print(triggers)
+triggers = composio.triggers.list()
+print(triggers)
 ```
 
 ## composio.triggers.list_active
@@ -164,31 +147,26 @@ List all active triggers
 
 ```python
 # List all active triggers
-    triggers = composio.triggers.list_active()
-    print(triggers)
-
-    # List all active triggers for a connected account
-    triggers = composio.triggers.list_active(
-        connected_account_ids=["1234567890"],
-    )
-    print(triggers)
+triggers = composio.triggers.list_active()
+print(triggers)
+
+# List all active triggers for a connected account
+triggers = composio.triggers.list_active(
+    connected_account_ids=["<CONNECTED_ACCOUNT_ID>"],
+)
+print(triggers)
 ```
 
 ## composio.triggers.list_enum
 
 List all trigger enums.
 
 
-**Returns**
-
-    - 
-
 **Examples**
 
 ```python
-# List all trigger enums
-    enums = composio.triggers.list_enum()
-    print(enums)
+enums = composio.triggers.list_enum()
+print(enums)
 ```
 
 ## composio.triggers.subscribe
@@ -206,13 +184,15 @@ Subscribe to a trigger and receive trigger events.
 **Examples**
 
 ```python
-# Subscribe to a trigger
-    subscription = composio.triggers.subscribe()
-    @subscription.handle(toolkit="GITHUB")
-    def handle_github_event(data):
-        print(data)
-
-    # Wait for the subscription to be closed
-    subscription.wait_forever()
+# Create a subscription object
+subscription = composio.triggers.subscribe()
+
+# Register a callback for a trigger
+@subscription.handle(toolkit="GITHUB")
+def handle_github_event(data):
+    print(data)
+
+# Wait for the subscription to be closed
+subscription.wait_forever()
 ```
 

python/composio/core/models/triggers.py

@@ -392,23 +392,21 @@ def get_type(
             The trigger type.
 
         Examples:
-        ```python
-            # Get a trigger type by slug
+            ```python
             trigger_type = composio.triggers.get_type(slug="GITHUB_COMMIT_EVENT")
             print(trigger_type)
-        ```
+            ```
         """
         return self._client.triggers_types.retrieve(slug=slug)
 
     def list_enum(self) -> list[str]:
         """List all trigger enums.
 
         Examples:
-        ```python
-            # List all trigger enums
+            ```python
             enums = composio.triggers.list_enum()
             print(enums)
-        ```
+            ```
         """
         return self._client.triggers_types.retrieve_enum()
 
@@ -431,11 +429,10 @@ def list(
             List of trigger types
 
         Examples:
-        ```python
-            # List all trigger types
+            ```python
             triggers = composio.triggers.list()
             print(triggers)
-        ```
+            ```
         """
         return self._client.triggers_types.list(
             cursor=cursor or self._client.not_given,
@@ -469,17 +466,17 @@ def list_active(
             List of active triggers
 
         Examples:
-        ```python
+            ```python
             # List all active triggers
             triggers = composio.triggers.list_active()
             print(triggers)
 
             # List all active triggers for a connected account
             triggers = composio.triggers.list_active(
-                connected_account_ids=["1234567890"],
+                connected_account_ids=["<CONNECTED_ACCOUNT_ID>"],
             )
             print(triggers)
-        ```
+            ```
         """
         return self._client.trigger_instances.list_active(
             query_trigger_ids_1=trigger_ids,
@@ -530,11 +527,11 @@ def create(
             The trigger instance
 
         Examples:
-        ```python
+            ```python
             # Create a trigger using a user ID
             trigger = composio.triggers.create(
                 slug="GITHUB_COMMIT_EVENT",
-                user_id="1234567890",
+                user_id="<USER_ID>",
                 trigger_config={
                     "owner": "composiohq",
                     "repo": "composio",
@@ -545,14 +542,14 @@ def create(
             # Create a trigger using a connected account ID
             trigger = composio.triggers.create(
                 slug="GITHUB_COMMIT_EVENT",
-                connected_account_id="1234567890",
+                connected_account_id="<CONNECTED_ACCOUNT_ID>",
                 trigger_config={
                     "owner": "composiohq",
                     "repo": "composio",
                 },
             )
             print(trigger)
-        ```
+            ```
         """
         if user_id is not None:
             connected_account_id = self._get_connected_account_for_user(
@@ -578,10 +575,9 @@ def delete(self, trigger_id: str) -> None:
             trigger_id: The ID of the trigger to delete.
 
         Examples:
-        ```python
-            # Delete a trigger
-            composio.triggers.delete(trigger_id="1234567890")
-        ```
+            ```python
+            composio.triggers.delete(trigger_id="<TRIGGER_ID>")
+            ```
         """
         self._client.trigger_instances.manage.delete(trigger_id=trigger_id)
 
@@ -592,10 +588,9 @@ def enable(self, trigger_id: str) -> None:
             trigger_id: The ID of the trigger to enable.
 
         Examples:
-        ```python
-            # Enable a trigger
-            composio.triggers.enable(trigger_id="1234567890")
-        ```
+            ```python
+            composio.triggers.enable(trigger_id="<TRIGGER_ID>")
+            ```
         """
         self._client.trigger_instances.manage.update(
             trigger_id=trigger_id, status="enable"
@@ -608,10 +603,9 @@ def disable(self, trigger_id: str) -> None:
             trigger_id: The ID of the trigger to disable.
 
         Examples:
-        ```python
-            # Disable a trigger
-            composio.triggers.disable(trigger_id="1234567890")
-        ```
+            ```python
+            composio.triggers.disable(trigger_id="<TRIGGER_ID>")
+            ```
         """
         self._client.trigger_instances.manage.update(
             trigger_id=trigger_id, status="disable"
@@ -645,16 +639,17 @@ def subscribe(self, timeout: float = 15.0) -> TriggerSubscription:
             The trigger subscription handler.
 
         Examples:
-        ```python
-            # Subscribe to a trigger
+            ```python
+            # Create a subscription object
             subscription = composio.triggers.subscribe()
 
+            # Register a callback for a trigger
             @subscription.handle(toolkit="GITHUB")
             def handle_github_event(data):
                 print(data)
 
             # Wait for the subscription to be closed
             subscription.wait_forever()
-        ```
+            ```
         """
         return _SubcriptionBuilder(client=self._client).connect(timeout=timeout)