Merge pull request #298 from signalwire/fern/hide-transcribe-page

docs: hide in-progress transcribe pages in server SDK

Author: Devon-White

fern/apis/signalwire-rest/openapi.yaml

@@ -152,17 +152,17 @@ tags:
       url: https://signalwire.com/docs/apis
       description: Developer documentation on SWML Script, Fabric API endpoints
   - name: Subscriber SIP Credentials
-    description: Endpoints related to creating & managing Subscriber SIP Endpoints
+    description: Endpoints related to creating & managing [Subscriber](/docs/platform/subscribers) SIP Endpoints.
     externalDocs:
       url: https://signalwire.com/docs/apis
       description: Developer documentation on Subscriber SIP Endpoint, Fabric API endpoints
   - name: Subscriber Tokens
-    description: Endpoints related to creating & managing Subscriber tokens
+    description: Endpoints related to creating & managing [Subscriber](/docs/platform/subscribers) tokens.
     externalDocs:
       url: https://signalwire.com/docs/apis
       description: Developer documentation on Subscriber token, Fabric API endpoints
   - name: Subscribers
-    description: Endpoints related to creating & managing Subscribers
+    description: Endpoints related to creating & managing [Subscribers](/docs/platform/subscribers).
     externalDocs:
       url: https://signalwire.com/docs/apis
       description: Developer documentation on Subscriber, Fabric API endpoints
@@ -207,7 +207,7 @@ tags:
       url: https://signalwire.com/docs/apis
       description: Developer documentation on FreeSWITCH Connector, Fabric API endpoints
   - name: Addresses
-    description: Client-side endpoints for listing and retrieving resource addresses using subscriber access tokens (SAT). Intended for use with the Browser SDK to resolve addresses from the client.
+    description: Client-side endpoints for listing and retrieving resource addresses using [subscriber](/docs/platform/subscribers) access tokens (SAT). Intended for use with the Browser SDK to resolve addresses from the client.
     externalDocs:
       url: https://signalwire.com/docs/apis
       description: Developer documentation on Fabric Address, Fabric API endpoints
@@ -343,8 +343,6 @@ paths:
         | `calling.stream.stop` | Stop active stream |
         | `calling.denoise` | Start noise reduction on a call |
         | `calling.denoise.stop` | Stop noise reduction |
-        | `calling.transcribe` | Start call transcription |
-        | `calling.transcribe.stop` | Stop active transcription |
         | `calling.ai_hold` | Place an AI call on hold |
         | `calling.ai_unhold` | Resume an AI call from hold |
         | `calling.ai_message` | Inject a message into an active AI conversation |
@@ -706,23 +704,6 @@ paths:
                   command: calling.denoise.stop
                   id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                   params: {}
-              calling.transcribe:
-                summary: calling.transcribe
-                description: Start transcription on an active call
-                value:
-                  command: calling.transcribe
-                  id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
-                  params:
-                    control_id: transcribe-control-1
-                    status_url: https://example.com/status_callback
-              calling.transcribe.stop:
-                summary: calling.transcribe.stop
-                description: Stop an active transcription
-                value:
-                  command: calling.transcribe.stop
-                  id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
-                  params:
-                    control_id: transcribe-control-1
               calling.ai.stop:
                 summary: calling.ai.stop
                 description: Stop an active AI session on the call
@@ -1265,7 +1246,7 @@ paths:
       operationId: list_resource_addresses_client
       summary: List Resource Addresses from a Client
       description: |-
-        Lists resource addresses visible to the authenticated subscriber. This endpoint uses bearer token authentication with a SAT (Subscriber Access Token),
+        Lists resource addresses visible to the authenticated [subscriber](/docs/platform/subscribers). This endpoint uses bearer token authentication with a SAT (Subscriber Access Token),
         which can be generated using the [Create Subscriber Token endpoint](/docs/apis/rest/subscribers/tokens/create-subscriber-token).
         #### Permissions
 
@@ -1307,7 +1288,7 @@ paths:
       operationId: get_resource_address_client
       summary: Get Resource Address from a Client
       description: |-
-        Returns a resource address by ID. This endpoint uses bearer token authentication with a SAT (Subscriber Access Token),
+        Returns a resource address by ID. This endpoint uses bearer token authentication with a SAT ([Subscriber](/docs/platform/subscribers) Access Token),
         which can be generated using the [Create Subscriber Token endpoint](/docs/apis/rest/subscribers/tokens/create-subscriber-token).
 
         #### Permissions
@@ -18812,8 +18793,6 @@ components:
         - $ref: '#/components/schemas/Calling.CallStreamStopRequest'
         - $ref: '#/components/schemas/Calling.CallDenoiseRequest'
         - $ref: '#/components/schemas/Calling.CallDenoiseStopRequest'
-        - $ref: '#/components/schemas/Calling.CallTranscribeRequest'
-        - $ref: '#/components/schemas/Calling.CallTranscribeStopRequest'
         - $ref: '#/components/schemas/Calling.CallLiveTranscribeRequest'
         - $ref: '#/components/schemas/Calling.CallLiveTranslateRequest'
         - $ref: '#/components/schemas/Calling.CallTransferRequest'
@@ -18852,8 +18831,6 @@ components:
           calling.stream.stop: '#/components/schemas/Calling.CallStreamStopRequest'
           calling.denoise: '#/components/schemas/Calling.CallDenoiseRequest'
           calling.denoise.stop: '#/components/schemas/Calling.CallDenoiseStopRequest'
-          calling.transcribe: '#/components/schemas/Calling.CallTranscribeRequest'
-          calling.transcribe.stop: '#/components/schemas/Calling.CallTranscribeStopRequest'
           calling.live_transcribe: '#/components/schemas/Calling.CallLiveTranscribeRequest'
           calling.live_translate: '#/components/schemas/Calling.CallLiveTranslateRequest'
           calling.transfer: '#/components/schemas/Calling.CallTransferRequest'
@@ -19090,74 +19067,6 @@ components:
             - control_id
           description: An object of parameters that will be utilized by the active command.
       title: calling.tap.stop
-    Calling.CallTranscribeRequest:
-      type: object
-      required:
-        - id
-        - command
-        - params
-      properties:
-        id:
-          allOf:
-            - $ref: '#/components/schemas/uuid'
-          description: The unique identifying ID of a existing call.
-          examples:
-            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
-        command:
-          type: string
-          enum:
-            - calling.transcribe
-          description: The `calling.transcribe` command starts transcription on an active call.
-          examples:
-            - calling.transcribe
-        params:
-          type: object
-          properties:
-            control_id:
-              type: string
-              description: Unique identifier for this transcribe operation, used to control it later.
-              examples:
-                - transcribe-control-1
-            status_url:
-              type: string
-              format: uri
-              description: A URL to receive status update callbacks for the transcription.
-              examples:
-                - https://example.com/status_callback
-          description: An object of parameters that will be utilized by the active command.
-      title: calling.transcribe
-    Calling.CallTranscribeStopRequest:
-      type: object
-      required:
-        - id
-        - command
-        - params
-      properties:
-        id:
-          allOf:
-            - $ref: '#/components/schemas/uuid'
-          description: The unique identifying ID of a existing call.
-          examples:
-            - 3fa85f64-5717-4562-b3fc-2c963f66afa6
-        command:
-          type: string
-          enum:
-            - calling.transcribe.stop
-          description: The `calling.transcribe.stop` command stops an active transcription.
-          examples:
-            - calling.transcribe.stop
-        params:
-          type: object
-          properties:
-            control_id:
-              type: string
-              description: The control ID of the transcription to stop.
-              examples:
-                - transcribe-control-1
-          required:
-            - control_id
-          description: An object of parameters that will be utilized by the active command.
-      title: calling.transcribe.stop
     Calling.CallTransferRequest:
       type: object
       required:
@@ -25645,7 +25554,7 @@ components:
           type: string
           enum:
             - subscriber
-          description: The display type of a fabric address pointing to a Subscriber.
+          description: The display type of a fabric address pointing to a [Subscriber](/docs/platform/subscribers).
           examples:
             - subscriber
       title: Subscriber Address
@@ -33386,7 +33295,7 @@ components:
         subscriber:
           allOf:
             - $ref: '#/components/schemas/Subscriber'
-          description: An object containing the response data of the Subscriber
+          description: An object containing the response data of the [Subscriber](/docs/platform/subscribers).
       title: Subscriber
     ResourceSipEndpointAssignRequest:
       type: object

fern/products/server-sdks/pages/reference/python/relay/actions/index.mdx

@@ -153,12 +153,6 @@ Block until the action completes and return the terminal event.
   >
     Tracks payment collection. Stop only.
   </Card>
-  <Card
-    title="TranscribeAction"
-    href="/docs/server-sdks/reference/python/relay/actions/transcribe-action"
-  >
-    Tracks transcription. Stop only.
-  </Card>
   <Card
     title="AIAction"
     href="/docs/server-sdks/reference/python/relay/actions/ai-action"

fern/products/server-sdks/pages/reference/python/relay/actions/transcribe-action/index.mdx

@@ -3,6 +3,7 @@ title: "TranscribeAction"
 slug: /reference/python/relay/actions/transcribe-action
 description: Action handle for an active transcription operation.
 max-toc-depth: 3
+hidden: true
 ---
 
 [call-transcribe]: /docs/server-sdks/reference/python/relay/call/transcribe

fern/products/server-sdks/pages/reference/python/relay/actions/transcribe-action/stop.mdx

@@ -3,6 +3,7 @@ title: "stop"
 slug: /reference/python/relay/actions/transcribe-action/stop
 description: Stop transcription.
 max-toc-depth: 3
+hidden: true
 ---
 
 Stop transcription.

fern/products/server-sdks/pages/reference/python/relay/call/index.mdx

@@ -215,9 +215,6 @@ objects that let you stop, pause, or wait for the operation to complete.
   <Card title="pay" href="/docs/server-sdks/reference/python/relay/call/pay">
     Collect payment information on a call.
   </Card>
-  <Card title="transcribe" href="/docs/server-sdks/reference/python/relay/call/transcribe">
-    Start transcribing call audio.
-  </Card>
   <Card title="live_transcribe" href="/docs/server-sdks/reference/python/relay/call/live-transcribe">
     Start or stop live transcription on a call.
   </Card>

fern/products/server-sdks/pages/reference/python/relay/call/transcribe.mdx

@@ -3,6 +3,7 @@ title: "transcribe"
 slug: /reference/python/relay/call/transcribe
 description: "Start transcribing call audio."
 max-toc-depth: 3
+hidden: true
 ---
 
 [transcribeaction]: /docs/server-sdks/reference/python/relay/actions

fern/products/server-sdks/pages/reference/typescript/relay/actions/index.mdx

@@ -150,12 +150,6 @@ Await the action's completion and return the terminal event.
   >
     Tracks payment collection. Stop only.
   </Card>
-  <Card
-    title="TranscribeAction"
-    href="/docs/server-sdks/reference/typescript/relay/actions/transcribe-action"
-  >
-    Tracks transcription. Stop only.
-  </Card>
   <Card
     title="AIAction"
     href="/docs/server-sdks/reference/typescript/relay/actions/ai-action"

fern/products/server-sdks/pages/reference/typescript/relay/actions/transcribe-action/index.mdx

@@ -3,6 +3,7 @@ title: "TranscribeAction"
 slug: /reference/typescript/relay/actions/transcribe-action
 description: Action handle for an active transcription operation.
 max-toc-depth: 3
+hidden: true
 ---
 
 [call-transcribe]: /docs/server-sdks/reference/typescript/relay/call/transcribe

fern/products/server-sdks/pages/reference/typescript/relay/actions/transcribe-action/stop.mdx

@@ -3,6 +3,7 @@ title: "stop"
 slug: /reference/typescript/relay/actions/transcribe-action/stop
 description: Stop transcription.
 max-toc-depth: 3
+hidden: true
 ---
 
 Stop transcription.

fern/products/server-sdks/pages/reference/typescript/relay/call/index.mdx

@@ -215,9 +215,6 @@ objects that let you stop, pause, or wait for the operation to complete.
   <Card title="pay" href="/docs/server-sdks/reference/typescript/relay/call/pay">
     Collect payment information on a call.
   </Card>
-  <Card title="transcribe" href="/docs/server-sdks/reference/typescript/relay/call/transcribe">
-    Start transcribing call audio.
-  </Card>
   <Card title="liveTranscribe" href="/docs/server-sdks/reference/typescript/relay/call/live-transcribe">
     Start or stop live transcription on a call.
   </Card>