Skip to content

Commit fdf7da8

Browse files
authored
Merge pull request #344 from signalwire/devin/1780410419-fix-calling-schema-types
fix: use method-specific Schema types for calling REST client pages
2 parents 36388d0 + 21e1d98 commit fdf7da8

74 files changed

Lines changed: 370 additions & 222 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

fern/products/server-sdks/pages/reference/python/rest/calling/ai-hold.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ Put an active AI session on hold. The AI agent stops processing speech
99
while the call remains connected. This is useful for transferring the
1010
caller to a human agent or performing background operations.
1111

12-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
12+
## **Request**
1313

14-
## **Response Example**
14+
<Schema type="Calling.CallHoldRequest" api="signalwire-rest" exclude={["command"]} />
1515

16-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
16+
## **Response**
17+
18+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1719

1820
## **Example**
1921

fern/products/server-sdks/pages/reference/python/rest/calling/ai-message.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ Send a message to an active AI session on a call. This injects instructions
99
or context into the AI agent's conversation without the caller hearing the
1010
message directly.
1111

12-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
12+
## **Request**
1313

14-
## **Response Example**
14+
<Schema type="Calling.CallAIMessageRequest" api="signalwire-rest" exclude={["command"]} />
1515

16-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
16+
## **Response**
17+
18+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1719

1820
## **Example**
1921

fern/products/server-sdks/pages/reference/python/rest/calling/ai-stop.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ max-toc-depth: 3
88
Stop an active AI session on a call. The AI agent is disconnected but
99
the call itself remains active, allowing further call control operations.
1010

11-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
11+
## **Request**
1212

13-
## **Response Example**
13+
<Schema type="Calling.CallAIStopRequest" api="signalwire-rest" exclude={["command"]} />
1414

15-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
15+
## **Response**
16+
17+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1618

1719
## **Example**
1820

fern/products/server-sdks/pages/reference/python/rest/calling/ai-unhold.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,13 @@ max-toc-depth: 3
1010
Resume an AI session that was previously put on hold with
1111
[`ai_hold()`][ai-hold].
1212

13-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
13+
## **Request**
1414

15-
## **Response Example**
15+
<Schema type="Calling.CallUnholdRequest" api="signalwire-rest" exclude={["command"]} />
1616

17-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
17+
## **Response**
18+
19+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1820

1921
## **Example**
2022

fern/products/server-sdks/pages/reference/python/rest/calling/collect-start-input-timers.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ Manually start the input timers for a collection that was started without
1111
automatic timer activation. This is useful when you want to play a prompt
1212
before starting the timer countdown.
1313

14-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
14+
## **Request**
1515

16-
## **Response Example**
16+
<Schema type="Calling.CallCollectStartInputTimersRequest" api="signalwire-rest" exclude={["command"]} />
1717

18-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
18+
## **Response**
19+
20+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1921

2022
## **Example**
2123

fern/products/server-sdks/pages/reference/python/rest/calling/collect-stop.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ max-toc-depth: 3
99

1010
Stop an active input collection.
1111

12-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
12+
## **Request**
1313

14-
## **Response Example**
14+
<Schema type="Calling.CallCollectStopRequest" api="signalwire-rest" exclude={["command"]} />
1515

16-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
16+
## **Response**
17+
18+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1719

1820
## **Example**
1921

fern/products/server-sdks/pages/reference/python/rest/calling/collect.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ max-toc-depth: 3
88
Start collecting user input on an active call. Supports DTMF digit collection
99
and speech recognition. Returns a `control_id` for managing the collection.
1010

11-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
11+
## **Request**
1212

13-
## **Response Example**
13+
<Schema type="Calling.CallCollectRequest" api="signalwire-rest" exclude={["command"]} />
1414

15-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
15+
## **Response**
16+
17+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1618

1719
## **Examples**
1820

fern/products/server-sdks/pages/reference/python/rest/calling/denoise-stop.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ max-toc-depth: 3
77

88
Disable noise reduction on an active call.
99

10-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
10+
## **Request**
1111

12-
## **Response Example**
12+
<Schema type="Calling.CallDenoiseStopRequest" api="signalwire-rest" exclude={["command"]} />
1313

14-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
14+
## **Response**
15+
16+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1517

1618
## **Example**
1719

fern/products/server-sdks/pages/reference/python/rest/calling/denoise.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ max-toc-depth: 3
88
Enable noise reduction on an active call. This applies real-time noise
99
suppression to the audio stream, improving clarity for both parties.
1010

11-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
11+
## **Request**
1212

13-
## **Response Example**
13+
<Schema type="Calling.CallDenoiseRequest" api="signalwire-rest" exclude={["command"]} />
1414

15-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
15+
## **Response**
16+
17+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1618

1719
## **Example**
1820

fern/products/server-sdks/pages/reference/python/rest/calling/detect-stop.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@ max-toc-depth: 3
99

1010
Stop an active detector.
1111

12-
<EndpointSchemaSnippet endpoint="POST /api/calling/calls" />
12+
## **Request**
1313

14-
## **Response Example**
14+
<Schema type="Calling.CallDetectStopRequest" api="signalwire-rest" exclude={["command"]} />
1515

16-
<EndpointResponseSnippet endpoint="POST /api/calling/calls" />
16+
## **Response**
17+
18+
<Schema type="Calling.CallResponse" api="signalwire-rest" />
1719

1820
## **Example**
1921

0 commit comments

Comments
 (0)