diff --git a/specs/compatibility-api/_spec_.yaml b/specs/compatibility-api/_spec_.yaml index 82f0bcd20..704d7e78f 100644 --- a/specs/compatibility-api/_spec_.yaml +++ b/specs/compatibility-api/_spec_.yaml @@ -213,7 +213,9 @@ paths: #### Permissions - The API token must include the following scopes: _Management_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Accounts parameters: @@ -364,7 +366,9 @@ paths: This endpoint create a subproject on the Project you are connecting as. #### Permissions - The API token must include the following scopes: _Management_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Accounts requestBody: @@ -521,7 +525,9 @@ paths: Find a Project (also referred to as _Account_) by ID. #### Permissions - The API token must include the following scopes: _Management_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Accounts responses: @@ -656,7 +662,9 @@ paths: Update a Project (also referred to as _Account_). #### Permissions - The API token must include the following scopes: _Management_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Accounts requestBody: @@ -813,8 +821,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Applications requestBody: @@ -1091,8 +1101,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Applications responses: @@ -1269,8 +1281,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Applications responses: @@ -1422,8 +1436,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Applications requestBody: @@ -1678,8 +1694,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Applications responses: @@ -1790,7 +1808,9 @@ paths: Search for Local AvailablePhoneNumbers. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: OK @@ -1988,7 +2008,9 @@ paths: Search for toll-free AvailablePhoneNumbers. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: OK @@ -2104,7 +2126,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: OK @@ -2182,7 +2206,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: OK @@ -2240,7 +2266,9 @@ paths: List all calls. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - in: query name: EndTime @@ -2498,7 +2526,9 @@ paths: Create a call. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). requestBody: required: true content: @@ -2945,7 +2975,9 @@ paths: Retrieve a call. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: OK @@ -3097,7 +3129,9 @@ paths: Allows you to modify an active call. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). requestBody: required: true content: @@ -3322,7 +3356,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '204': $ref: '#/components/responses/204' @@ -3360,7 +3396,9 @@ paths: Retrieve a single Participant. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: OK @@ -3459,7 +3497,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). requestBody: required: true content: @@ -3626,7 +3666,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '204': $ref: '#/components/responses/204' @@ -3674,7 +3716,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: OK @@ -3820,7 +3864,9 @@ paths: Retrieve a single conference. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: OK @@ -3901,7 +3947,9 @@ paths: Allows you to modify the properties of a conference. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). requestBody: content: application/x-www-form-urlencoded: @@ -4052,7 +4100,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: OK @@ -4181,7 +4231,9 @@ paths: Create a stream for an existing conference. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conference Streams requestBody: @@ -4345,7 +4397,9 @@ paths: description: | Update an existing conference stream. Commonly used to stop/start streams or modify stream properties. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conference Streams requestBody: @@ -4480,7 +4534,9 @@ paths: #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Faxes responses: @@ -4641,7 +4697,9 @@ paths: Send a fax. #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Faxes requestBody: @@ -4835,7 +4893,9 @@ paths: Retrieve a fax. #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Faxes responses: @@ -4971,7 +5031,9 @@ paths: Allows you to modify the properties of Fax. #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Faxes requestBody: @@ -5131,7 +5193,9 @@ paths: #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Faxes responses: @@ -5165,7 +5229,9 @@ paths: #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Fax Media responses: @@ -5254,7 +5320,9 @@ paths: #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Fax Media responses: @@ -5311,7 +5379,9 @@ paths: #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Fax Media responses: @@ -5367,7 +5437,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Incoming Phone Numbers responses: @@ -5624,7 +5696,9 @@ paths: Create an Incoming Phone Number. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Incoming Phone Numbers requestBody: @@ -5988,7 +6062,9 @@ paths: Retrieve an incoming phone number. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Incoming Phone Numbers responses: @@ -6203,7 +6279,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Incoming Phone Numbers requestBody: @@ -6553,7 +6631,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Incoming Phone Numbers responses: @@ -6581,7 +6661,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Imported Phone Numbers requestBody: @@ -6884,8 +6966,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - cXML Bins responses: @@ -6989,8 +7073,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - cXML Bins requestBody: @@ -7114,8 +7200,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - cXML Bins responses: @@ -7201,8 +7289,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - cXML Bins requestBody: @@ -7309,8 +7399,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - cXML Bins responses: @@ -7388,7 +7480,9 @@ paths: #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Messages responses: @@ -7574,7 +7668,9 @@ paths: Create a message. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Messages requestBody: @@ -7844,7 +7940,9 @@ paths: Retrieve a single message. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Messages responses: @@ -8005,7 +8103,9 @@ paths: #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Messages requestBody: @@ -8185,7 +8285,9 @@ paths: #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Messages responses: @@ -8232,7 +8334,9 @@ paths: #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Media responses: @@ -8324,7 +8428,9 @@ paths: Retrieve a single media. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Media responses: @@ -8379,7 +8485,9 @@ paths: #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Media responses: @@ -8428,7 +8536,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Recordings responses: @@ -8643,7 +8753,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. This permission is only required for authenticated requests to retrieve recording metadata (.json extension). + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. This permission is only required for authenticated requests to retrieve recording metadata (.json extension). + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Recordings responses: @@ -8761,7 +8873,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Recordings responses: @@ -8794,7 +8908,9 @@ paths: Create a recording. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Recordings requestBody: @@ -9003,7 +9119,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Recordings requestBody: @@ -9156,7 +9274,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Recording Transcriptions responses: @@ -9268,7 +9388,9 @@ paths: Retrieve a single recording transcription. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Recording Transcriptions responses: @@ -9357,7 +9479,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Recording Transcriptions responses: @@ -9394,7 +9518,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queues responses: @@ -9478,7 +9604,9 @@ paths: Create a call queue. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queues requestBody: @@ -9576,7 +9704,9 @@ paths: Retrieve a single queue. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queues responses: @@ -9640,7 +9770,9 @@ paths: Allows you to modify the properties of a single call queue. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queues requestBody: @@ -9726,7 +9858,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queues responses: @@ -9743,7 +9877,9 @@ paths: The ability to read all of the queue members that are waiting in a particular queue. This will be returned as a list of members. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queue Members responses: @@ -9793,7 +9929,9 @@ paths: Retrieve a single queue member. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queue Members responses: @@ -9810,7 +9948,9 @@ paths: Allows you to dequeue a given queue member and execute new XML Instructions. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queue Members parameters: @@ -9853,7 +9993,9 @@ paths: Create a stream. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Streams requestBody: @@ -10004,7 +10146,9 @@ paths: description: | Stop a Stream. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Streams requestBody: @@ -10094,6 +10238,13 @@ paths: description: >- Generate an API Token for a project to be used to authenticate requests within the project. + + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Tokens requestBody: @@ -10200,7 +10351,15 @@ paths: patch: operationId: update_token summary: Update an API Token - description: Update an API Token's name or permissions. + description: >- + Update an API Token's name or permissions. + + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Tokens parameters: @@ -10313,7 +10472,15 @@ paths: delete: operationId: delete_token summary: Delete an API Token - description: Delete an API Token. This action cannot be undone. + description: >- + Delete an API Token. This action cannot be undone. + + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Tokens parameters: diff --git a/specs/signalwire-rest/calling-api/calls/main.tsp b/specs/signalwire-rest/calling-api/calls/main.tsp index ffb2afc33..2dd0d31e7 100644 --- a/specs/signalwire-rest/calling-api/calls/main.tsp +++ b/specs/signalwire-rest/calling-api/calls/main.tsp @@ -19,6 +19,12 @@ namespace CallingAPI.Calls { Unified JSON-RPC style endpoint for executing call methods through command-based dispatch. Send a request with the appropriate `command` field to invoke the desired call operation. This endpoint provides a single interface for all call-related methods including creation, updates, termination, and AI conversation control. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) @opExample( #{ parameters: dialCallExample }, diff --git a/specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml index 569890787..007194e74 100644 --- a/specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -29,6 +29,12 @@ paths: Unified JSON-RPC style endpoint for executing call methods through command-based dispatch. Send a request with the appropriate `command` field to invoke the desired call operation. This endpoint provides a single interface for all call-related methods including creation, updates, termination, and AI conversation control. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': diff --git a/specs/signalwire-rest/chat-api/_spec_.yaml b/specs/signalwire-rest/chat-api/_spec_.yaml index bffde44ea..8dba0aafd 100644 --- a/specs/signalwire-rest/chat-api/_spec_.yaml +++ b/specs/signalwire-rest/chat-api/_spec_.yaml @@ -32,7 +32,7 @@ paths: #### Permissions - The API token must include the following scopes: _Chat_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Chat_. tags: - Tokens requestBody: diff --git a/specs/signalwire-rest/chat-api/tokens/main.tsp b/specs/signalwire-rest/chat-api/tokens/main.tsp index 96fae0994..bc2757a20 100644 --- a/specs/signalwire-rest/chat-api/tokens/main.tsp +++ b/specs/signalwire-rest/chat-api/tokens/main.tsp @@ -19,7 +19,9 @@ namespace ChatAPI.Tokens { #### Permissions - The API token must include the following scopes: `Chat`. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Chat_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) create(...NewChatToken): | { diff --git a/specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml index 401d3e886..f9fd89b6a 100644 --- a/specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -16,7 +16,9 @@ paths: #### Permissions - The API token must include the following scopes: `Chat`. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Chat_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': diff --git a/specs/signalwire-rest/datasphere-api/document/main.tsp b/specs/signalwire-rest/datasphere-api/document/main.tsp index b8804a0f1..5e13c2e28 100644 --- a/specs/signalwire-rest/datasphere-api/document/main.tsp +++ b/specs/signalwire-rest/datasphere-api/document/main.tsp @@ -12,11 +12,27 @@ namespace DatasphereAPI.Documents { @route("/documents") @tag("Documents") interface Documents { - @doc("A list of Datasphere Documents") + @doc(""" + A list of Datasphere Documents. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @summary("List Documents") list(): DocumentListResponse | StatusCode401 | StatusCode404; - @doc("Creates a Datasphere Document") + @doc(""" + Creates a Datasphere Document. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @summary("Create a Document") @post create(@body body: DocumentCreateRequest): @@ -28,7 +44,15 @@ namespace DatasphereAPI.Documents { | StatusCode404 | CreateStatusCode422; - @doc("Updates a Datasphere Document by ID") + @doc(""" + Updates a Datasphere Document by ID. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @summary("Update a Document") @patch(#{ implicitOptionality: true }) update(...PathID, ...DocumentUpdateRequest): @@ -40,14 +64,30 @@ namespace DatasphereAPI.Documents { | StatusCode404 | SearchStatusCode422; - @doc("Deletes a Datasphere Document by ID") + @doc(""" + Deletes a Datasphere Document by ID. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @summary("Delete a Document") @delete delete(...PathID): { @statusCode statusCode: 204; } | StatusCode401 | StatusCode404; - @doc("Search Datasphere Documents") + @doc(""" + Search Datasphere Documents. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @route("/search") @summary("Search Documents") @post @@ -64,16 +104,40 @@ namespace DatasphereAPI.Chunks { @tag("Chunks") @friendlyName("Chunks") interface Chunks { - @doc("A list of chunks for a Datasphere Document.") + @doc(""" + A list of chunks for a Datasphere Document. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @summary("List Chunks") list(...DocumentPathID): ChunkListResponse | StatusCode401 | StatusCode404; - @doc("Retrieves a specific chunk for a Datasphere Document by ID.") + @doc(""" + Retrieves a specific chunk for a Datasphere Document by ID. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @summary("Retrieve Chunk") @route("/{chunkId}") get(...ChunkPathID): ChunkResponse | StatusCode401 | StatusCode404; - @doc("Deletes a specific chunk for a Datasphere Document by ID.") + @doc(""" + Deletes a specific chunk for a Datasphere Document by ID. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @summary("Delete Chunk") @route("/{chunkId}") @delete diff --git a/specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml index 943750638..7f9ef5dd6 100644 --- a/specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -11,7 +11,14 @@ paths: get: operationId: Documents_list summary: List Documents - description: A list of Datasphere Documents + description: |- + A list of Datasphere Documents. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -37,7 +44,14 @@ paths: post: operationId: Documents_create summary: Create a Document - description: Creates a Datasphere Document + description: |- + Creates a Datasphere Document. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -76,7 +90,14 @@ paths: post: operationId: Documents_search summary: Search Documents - description: Search Datasphere Documents + description: |- + Search Datasphere Documents. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -117,7 +138,14 @@ paths: get: operationId: Chunks_list summary: List Chunks - description: A list of chunks for a Datasphere Document. + description: |- + A list of chunks for a Datasphere Document. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/DocumentPathID' responses: @@ -145,7 +173,14 @@ paths: get: operationId: Chunks_get summary: Retrieve Chunk - description: Retrieves a specific chunk for a Datasphere Document by ID. + description: |- + Retrieves a specific chunk for a Datasphere Document by ID. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ChunkPathID.documentId' - $ref: '#/components/parameters/ChunkPathID.chunkId' @@ -173,7 +208,14 @@ paths: delete: operationId: Chunks_delete summary: Delete Chunk - description: Deletes a specific chunk for a Datasphere Document by ID. + description: |- + Deletes a specific chunk for a Datasphere Document by ID. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ChunkPathID.documentId' - $ref: '#/components/parameters/ChunkPathID.chunkId' @@ -198,7 +240,14 @@ paths: patch: operationId: Documents_update summary: Update a Document - description: Updates a Datasphere Document by ID + description: |- + Updates a Datasphere Document by ID. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/PathID' responses: @@ -237,7 +286,14 @@ paths: delete: operationId: Documents_delete summary: Delete a Document - description: Deletes a Datasphere Document by ID + description: |- + Deletes a Datasphere Document by ID. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/PathID' responses: diff --git a/specs/signalwire-rest/fabric-api/addresses/main.tsp b/specs/signalwire-rest/fabric-api/addresses/main.tsp index 91f2e167d..69b224bf4 100644 --- a/specs/signalwire-rest/fabric-api/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/addresses/main.tsp @@ -17,6 +17,13 @@ namespace FabricAPI.FabricAddresses { @doc(""" A list of Fabric Addresses. This endpoint uses the bearer token authentication method with the SAT (Subscriber Access Token) which can be generated using the [Create Subscriber Token endpoint](/rest/signalwire-rest/endpoints/fabric/subscriber-tokens-create). + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) list(): | FabricAddressesResponse @@ -28,6 +35,13 @@ namespace FabricAPI.FabricAddresses { @doc(""" Returns a Fabric Address by ID. This endpoint uses the bearer token authentication method with the SAT (Subscriber Access Token) which can be generated using the [Create Subscriber Token endpoint](/rest/signalwire-rest/endpoints/fabric/subscriber-tokens-create). + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) read(...FabricAddressID): | { diff --git a/specs/signalwire-rest/fabric-api/ai-agent/addresses/main.tsp b/specs/signalwire-rest/fabric-api/ai-agent/addresses/main.tsp index 9d9ea2b44..263501695 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.AIAgent.Addresses { @tag(AI_CUSTOM_TAG) interface AIAgentAddresses { @summary("List AI Agent Addresses") - @doc("This endpoint returns a list of addresses associated with a specific AI Agent.") + @doc(""" + This endpoint returns a list of addresses associated with a specific AI Agent. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...AIAgentIDPath): | AIAgentAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/ai-agent/main.tsp b/specs/signalwire-rest/fabric-api/ai-agent/main.tsp index c31723a5b..b8bba27b6 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/main.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/main.tsp @@ -17,11 +17,27 @@ namespace FabricAPI.AIAgents { @friendlyName("AI Agent: Custom") interface AIAgents { @summary("List AI Agents") - @doc("A list of AI Agents") + @doc(""" + A list of AI Agents + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): AIAgentListResponse | StatusCode401 | StatusCode404 | StatusCode500; @summary("Get AI Agent") - @doc("Returns an AI Agent by ID") + @doc(""" + Returns an AI Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...AIAgentPathID): | { @statusCode statusCode: 200; @@ -32,7 +48,15 @@ namespace FabricAPI.AIAgents { | StatusCode500; @summary("Create AI Agent") - @doc("Creates an AI Agent") + @doc(""" + Creates an AI Agent + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(...AIAgentCreateRequest): | { @@ -45,7 +69,15 @@ namespace FabricAPI.AIAgents { | StatusCode500; @summary("Update AI Agent") - @doc("Updates an AI Agent by ID") + @doc(""" + Updates an AI Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @patch(#{ implicitOptionality: true }) update(...AIAgentPathID, ...AIAgentUpdateRequest): | { @@ -58,7 +90,15 @@ namespace FabricAPI.AIAgents { | StatusCode500; @summary("Delete AI Agent") - @doc("Deletes an AI Agent by ID") + @doc(""" + Deletes an AI Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...AIAgentPathID): | { diff --git a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/main.tsp b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/main.tsp index f995a0dd7..5275fa0c5 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/main.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/main.tsp @@ -6,42 +6,61 @@ import "./swaig"; @summary("AI object") model AI { - @doc("Create a new AI agent.") + @doc(""" + Create a new AI agent. + """) @summary("ai") ai: { @doc(""" A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script or from the SWML `set_global_data` action. This data can be referenced `globally`. All contained information can be accessed and expanded within the prompt - for example, by using a template string. + """) global_data?: { ...TypeSpec.Record; }; - @doc("An array of hints (as strings) to provide context to the dialogue.") + @doc(""" + An array of hints (as strings) to provide context to the dialogue. + """) @example(#["pizza", "pepperoni"]) hints?: string[]; - @doc("An array of JSON objects defining supported languages in the conversation.") + @doc(""" + An array of JSON objects defining supported languages in the conversation. + """) languages?: Languages[]; - @doc("A JSON object containing parameters as key-value pairs.") + @doc(""" + A JSON object containing parameters as key-value pairs. + """) params?: AIParams; - @doc("The final set of instructions and configuration settings to send to the agent.") + @doc(""" + The final set of instructions and configuration settings to send to the agent. + """) post_prompt?: AIPostPrompt; - @doc("The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of `username:password@url`.") + @doc(""" + The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of `username:password@url`. + """) @example("username:password@https://example.com") post_prompt_url?: url; - @doc("An array of JSON objects to clarify the agent's pronunciation of words or expressions.") + @doc(""" + An array of JSON objects to clarify the agent's pronunciation of words or expressions. + """) pronounce?: Pronounce[]; - @doc("Establishes the initial set of instructions and settings to configure the agent.") + @doc(""" + Establishes the initial set of instructions and settings to configure the agent. + """) prompt: AIPrompt; - @doc("An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue.") + @doc(""" + An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue. + """) SWAIG?: SWAIG; }; } diff --git a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/prompt/contexts/main.tsp b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/prompt/contexts/main.tsp index dd99965fb..1c33bf42b 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/prompt/contexts/main.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/prompt/contexts/main.tsp @@ -2,7 +2,9 @@ import "./steps.tsp"; @summary("contexts") model Contexts { - @doc("The default context to use at the beginning of the conversation. Additional context steps can be defined as any other key in the object.") + @doc(""" + The default context to use at the beginning of the conversation. Additional context steps can be defined as any other key in the object. + """) default: ContextSteps; ...TypeSpec.Record; diff --git a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/prompt/main.tsp b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/prompt/main.tsp index dd8576515..f0a8632e7 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/prompt/main.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/prompt/main.tsp @@ -2,16 +2,22 @@ import "./contexts"; @summary("AIPromptBase") model AIPromptBase { - @doc("The instructions to send to the agent.") + @doc(""" + The instructions to send to the agent. + """) @example("Your name is Franklin and you are taking orders for Franklin's Pizza. Begin by greeting the caller, and ask if they'd like to place an order for pickup or delivery.") text: string; - @doc("Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random.") + @doc(""" + Randomness setting. Float value between 0.0 and 1.5. Closer to 0 will make the output less random. + """) @minValue(0.0) @maxValue(1.5) temperature?: float; - @doc("Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random.") + @doc(""" + Randomness setting. Alternative to `temperature`. Float value between 0.0 and 1.0. Closer to 0 will make the output less random. + """) @minValue(0.0) @maxValue(1.0) top_p?: float; @@ -24,12 +30,16 @@ model AIPromptBase { @maxValue(1.0) confidence?: float; - @doc("Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics.") + @doc(""" + Aversion to staying on topic. Float value between -2.0 and 2.0. Positive values increase the model's likelihood to talk about new topics. + """) @minValue(-2.0) @maxValue(2.0) presence_penalty?: float; - @doc("Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim.") + @doc(""" + Aversion to repeating lines. Float value between -2.0 and 2.0. Positive values decrease the model's likelihood to repeat the same line verbatim. + """) @minValue(-2.0) @maxValue(2.0) frequency_penalty?: float; diff --git a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/data_map/main.tsp b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/data_map/main.tsp index eedf0f6d2..2af12a440 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/data_map/main.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/data_map/main.tsp @@ -8,12 +8,18 @@ using TypeSpec.OpenAPI; @oneOf @summary("DataMap union") union DataMap { - @doc("An object that defines the output of the SWAIG function.") + @doc(""" + An object that defines the output of the SWAIG function. + """) Output, - @doc("An array of objects that define patterns and corresponding actions.") + @doc(""" + An array of objects that define patterns and corresponding actions. + """) Expression, - @doc("An array of objects that define external API calls.") + @doc(""" + An array of objects that define external API calls. + """) Webhook, } diff --git a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/main.tsp b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/main.tsp index fedb5ed67..f9bea5bf3 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/main.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/functions/main.tsp @@ -4,18 +4,26 @@ import "./parameters.tsp"; @summary("functions") model SWAIGFunction { - @doc("A unique name for the function. For example, 'get_weather'.") + @doc(""" + A unique name for the function. For example, 'get_weather'. + """) @example("get_weather") function: string; - @doc("A description of the context and purpose of the function, to explain to the agent when to use it.") + @doc(""" + A description of the context and purpose of the function, to explain to the agent when to use it. + """) @example("Get the weather information") description: string; - @doc("A JSON object defining the input that should be passed to the function. The fields of this object are the following two parameters.") + @doc(""" + A JSON object defining the input that should be passed to the function. The fields of this object are the following two parameters. + """) parameters?: FunctionParameters; - @doc("Whether the function is active. Default is `true`.") + @doc(""" + Whether the function is active. Default is `true`. + """) active?: boolean; @doc(""" @@ -28,7 +36,9 @@ model SWAIGFunction { ...TypeSpec.Record; }; - @doc("Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire.") + @doc(""" + Scoping token for meta_data. If not supplied, metadata will be scoped to function's `web_hook_url`. Default is set by SignalWire. + """) meta_data_token?: string; @doc(""" @@ -37,15 +47,21 @@ model SWAIGFunction { """) data_map?: DataMap; - @doc("Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.`") + @doc(""" + Function-specific URL to send status callbacks and reports to. Takes precedence over a default setting. Authentication can also be set in the url in the format of `username:password@url.` + """) @example("username:password:https://statuscallback.com") web_hook_url?: string; - @doc("A file to play while the function is running. `wait_file_loops` can specify the amount of times that files should continuously play. Default is not set.") + @doc(""" + A file to play while the function is running. `wait_file_loops` can specify the amount of times that files should continuously play. Default is not set. + """) @example("https://cdn.signalwire.com/default-music/welcome.mp3") wait_file?: url; - @doc("The number of times to loop playing the file. Default is not set.") + @doc(""" + The number of times to loop playing the file. Default is not set. + """) @example(5) wait_file_loops?: integer | string; } diff --git a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/main.tsp b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/main.tsp index 7fbe52125..0c532ee7c 100644 --- a/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/main.tsp +++ b/specs/signalwire-rest/fabric-api/ai-agent/models/ai/swaig/main.tsp @@ -5,10 +5,14 @@ import "./functions"; @summary("swaig") model SWAIG { - @doc("Default settings for all SWAIG functions. If `defaults` is not set, settings may be set in each function object. Default is not set.") + @doc(""" + Default settings for all SWAIG functions. If `defaults` is not set, settings may be set in each function object. Default is not set. + """) defaults?: SWAIGDefaults; - @doc("Prebuilt functions the AI agent is able to call from this list of available native functions") + @doc(""" + Prebuilt functions the AI agent is able to call from this list of available native functions + """) native_functions?: SWAIGNativeFunction[]; @doc(""" diff --git a/specs/signalwire-rest/fabric-api/call-flows/addresses/main.tsp b/specs/signalwire-rest/fabric-api/call-flows/addresses/main.tsp index 6e7fea224..406e43f5d 100644 --- a/specs/signalwire-rest/fabric-api/call-flows/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/call-flows/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.CallFlow.Addresses { @tag(CALL_FLOWS_TAG) interface CallFlowAddresses { @summary("List Call Flow Addresses") - @doc("This endpoint returns a list of addresses associated with a specific Call Flow.") + @doc(""" + This endpoint returns a list of addresses associated with a specific Call Flow. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...CallFlowAddressPathID): | CallFlowAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/call-flows/main.tsp b/specs/signalwire-rest/fabric-api/call-flows/main.tsp index a7dc1dba0..5b88bb1d2 100644 --- a/specs/signalwire-rest/fabric-api/call-flows/main.tsp +++ b/specs/signalwire-rest/fabric-api/call-flows/main.tsp @@ -18,7 +18,15 @@ namespace FabricAPI.CallFlows { @friendlyName("Call Flows") interface CallFlows { @summary("List Call Flows") - @doc("A list of Call Flows") + @doc(""" + A list of Call Flows + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | CallFlowListResponse | StatusCode401 @@ -26,7 +34,15 @@ namespace FabricAPI.CallFlows { | StatusCode500; @summary("Get Call Flow") - @doc("Returns a Call Flow by ID") + @doc(""" + Returns a Call Flow by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...CallFlowPathID): | { @statusCode statusCode: 200; @@ -37,7 +53,15 @@ namespace FabricAPI.CallFlows { | StatusCode500; @summary("Create Call Flow") - @doc("Creates a Call Flow") + @doc(""" + Creates a Call Flow + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(@body request: CallFlowCreateRequest): | { @@ -50,7 +74,15 @@ namespace FabricAPI.CallFlows { | StatusCode500; @summary("Update Call Flow") - @doc("Updates a Call Flow by ID") + @doc(""" + Updates a Call Flow by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update(...CallFlowPathID, @body request: CallFlowUpdateRequest): | { @@ -63,7 +95,15 @@ namespace FabricAPI.CallFlows { | StatusCode500; @summary("Delete Call Flow") - @doc("Deletes a Call Flow by ID") + @doc(""" + Deletes a Call Flow by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...CallFlowPathID): | { diff --git a/specs/signalwire-rest/fabric-api/call-flows/versions/main.tsp b/specs/signalwire-rest/fabric-api/call-flows/versions/main.tsp index 28d13f8da..577596ce9 100644 --- a/specs/signalwire-rest/fabric-api/call-flows/versions/main.tsp +++ b/specs/signalwire-rest/fabric-api/call-flows/versions/main.tsp @@ -14,7 +14,15 @@ namespace FabricAPI.CallFlow.Versions { @tag(CALL_FLOWS_TAG) interface CallFlowVersions { @summary("List Call Flow Versions") - @doc("Returns a list of versions of a Call Flow.") + @doc(""" + Returns a list of versions of a Call Flow. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...CallFlowVersionPathID): | CallFlowVersionListResponse | StatusCode401 @@ -22,7 +30,15 @@ namespace FabricAPI.CallFlow.Versions { | StatusCode500; @summary("Deploy a Call Flow Version") - @doc("Deploys a specific version of a Call Flow.") + @doc(""" + Deploys a specific version of a Call Flow. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post deploy( ...CallFlowVersionPathID, diff --git a/specs/signalwire-rest/fabric-api/conference-rooms/addresses/main.tsp b/specs/signalwire-rest/fabric-api/conference-rooms/addresses/main.tsp index bcfac1928..5d6311891 100644 --- a/specs/signalwire-rest/fabric-api/conference-rooms/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/conference-rooms/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.ConferenceRoom.Addresses { @tag(CONFERENCE_ROOM_TAG) interface ConferenceRoomAddresses { @summary("List Conference Room Addresses") - @doc("This endpoint returns a list of addresses associated with a specific Conference Room.") + @doc(""" + This endpoint returns a list of addresses associated with a specific Conference Room. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...ConferenceRoomAddressPathID): | ConferenceRoomAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/conference-rooms/main.tsp b/specs/signalwire-rest/fabric-api/conference-rooms/main.tsp index 96db39bea..dd8575bd4 100644 --- a/specs/signalwire-rest/fabric-api/conference-rooms/main.tsp +++ b/specs/signalwire-rest/fabric-api/conference-rooms/main.tsp @@ -17,7 +17,15 @@ namespace FabricAPI.ConferenceRooms { @friendlyName("Conference Rooms") interface ConferenceRooms { @summary("List Conference Rooms") - @doc("Returns a list of conference rooms.") + @doc(""" + Returns a list of conference rooms. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | ConferenceRoomListResponse | StatusCode401 @@ -25,7 +33,15 @@ namespace FabricAPI.ConferenceRooms { | StatusCode500; @summary("Get Conference Room") - @doc("Returns a Conference Room by ID") + @doc(""" + Returns a Conference Room by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...ConferenceRoomPathID): | { @statusCode statusCode: 200; @@ -36,7 +52,15 @@ namespace FabricAPI.ConferenceRooms { | StatusCode500; @summary("Create Conference Room") - @doc("Creates a Conference Room") + @doc(""" + Creates a Conference Room + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(@body request: ConferenceRoomCreateRequest): | { @@ -49,7 +73,15 @@ namespace FabricAPI.ConferenceRooms { | StatusCode500; @summary("Update Conference Room") - @doc("Updates a Conference Room by ID") + @doc(""" + Updates a Conference Room by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update( ...ConferenceRoomPathID, @@ -65,7 +97,15 @@ namespace FabricAPI.ConferenceRooms { | StatusCode500; @summary("Delete Conference Room") - @doc("Deletes a Conference Room by ID") + @doc(""" + Deletes a Conference Room by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...ConferenceRoomPathID): | { diff --git a/specs/signalwire-rest/fabric-api/cxml-applications/addresses/main.tsp b/specs/signalwire-rest/fabric-api/cxml-applications/addresses/main.tsp index ff6422757..a1905c370 100644 --- a/specs/signalwire-rest/fabric-api/cxml-applications/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/cxml-applications/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.CxmlApplication.Addresses { @tag(CXML_APPLICATIONS_TAG) interface CxmlApplicationAddresses { @summary("List cXML Application Addresses") - @doc("This endpoint returns a list of addresses associated with a specific LaML Application.") + @doc(""" + This endpoint returns a list of addresses associated with a specific LaML Application. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...CxmlApplicationAddressPathID): | CxmlApplicationAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/cxml-applications/main.tsp b/specs/signalwire-rest/fabric-api/cxml-applications/main.tsp index a78a7f2ba..6b5535651 100644 --- a/specs/signalwire-rest/fabric-api/cxml-applications/main.tsp +++ b/specs/signalwire-rest/fabric-api/cxml-applications/main.tsp @@ -17,7 +17,15 @@ namespace FabricAPI.CxmlApplications { @friendlyName("cXML Applications") interface CxmlApplications { @summary("List cXML Applications") - @doc("A list of cXML Applications") + @doc(""" + A list of cXML Applications + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | CxmlApplicationListResponse | StatusCode401 @@ -25,7 +33,15 @@ namespace FabricAPI.CxmlApplications { | StatusCode500; @summary("Get cXML Application") - @doc("Returns a cXML Application by ID") + @doc(""" + Returns a cXML Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...CxmlApplicationPathID): | { @statusCode statusCode: 200; @@ -36,7 +52,15 @@ namespace FabricAPI.CxmlApplications { | StatusCode500; @summary("Update cXML Application") - @doc("Updates a cXML Application by ID") + @doc(""" + Updates a cXML Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update( ...CxmlApplicationPathID, @@ -52,7 +76,15 @@ namespace FabricAPI.CxmlApplications { | StatusCode500; @summary("Delete LAML Application") - @doc("Deletes a LAML Application by ID") + @doc(""" + Deletes a LAML Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...CxmlApplicationPathID): | { diff --git a/specs/signalwire-rest/fabric-api/cxml-scripts/addresses/main.tsp b/specs/signalwire-rest/fabric-api/cxml-scripts/addresses/main.tsp index fdfec7815..d877d1ff5 100644 --- a/specs/signalwire-rest/fabric-api/cxml-scripts/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/cxml-scripts/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.CXMLScript.Addresses { @tag(CXML_SCRIPTS_TAG) interface CXMLScriptAddresses { @summary("List cXML Script Addresses") - @doc("This endpoint returns a list of addresses associated with a specific cXML Script.") + @doc(""" + This endpoint returns a list of addresses associated with a specific cXML Script. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...CXMLScriptAddressPathID): | CXMLScriptAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/cxml-scripts/main.tsp b/specs/signalwire-rest/fabric-api/cxml-scripts/main.tsp index 4c8ba64aa..b365d234e 100644 --- a/specs/signalwire-rest/fabric-api/cxml-scripts/main.tsp +++ b/specs/signalwire-rest/fabric-api/cxml-scripts/main.tsp @@ -18,7 +18,15 @@ namespace FabricAPI.CXMLScripts { @summary("CXML Scripts") interface CXMLScripts { @summary("List cXML Scripts") - @doc("A list of cXML Scripts") + @doc(""" + A list of cXML Scripts + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | CXMLScriptListResponse | StatusCode401 @@ -26,7 +34,15 @@ namespace FabricAPI.CXMLScripts { | StatusCode500; @summary("Get cXML Script") - @doc("Returns a cXML Script by ID") + @doc(""" + Returns a cXML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...CXMLScriptPathID): | { @statusCode statusCode: 200; @@ -37,7 +53,15 @@ namespace FabricAPI.CXMLScripts { | StatusCode500; @summary("Create cXML Script") - @doc("Creates a cXML Script") + @doc(""" + Creates a cXML Script + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(@body request: CXMLScriptCreateRequest): | { @@ -50,7 +74,15 @@ namespace FabricAPI.CXMLScripts { | StatusCode500; @summary("Update cXML Script") - @doc("Updates a cXML Script by ID") + @doc(""" + Updates a cXML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update(...CXMLScriptPathID, @body request: CXMLScriptUpdateRequest): | { @@ -63,7 +95,15 @@ namespace FabricAPI.CXMLScripts { | StatusCode500; @summary("Delete cXML Script") - @doc("Deletes a cXML Script by ID") + @doc(""" + Deletes a cXML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...CXMLScriptPathID): | { diff --git a/specs/signalwire-rest/fabric-api/cxml-webhooks/addresses/main.tsp b/specs/signalwire-rest/fabric-api/cxml-webhooks/addresses/main.tsp index fd8e4ed58..edbd8b568 100644 --- a/specs/signalwire-rest/fabric-api/cxml-webhooks/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/cxml-webhooks/addresses/main.tsp @@ -14,7 +14,15 @@ namespace FabricAPI.CXMLWebhook.Addresses { @friendlyName("cXML Webhooks") interface CXMLWebhookAddresses { @summary("List cXML Webhook Addresses") - @doc("This endpoint returns a list of addresses associated with a specific cXML Webhook.") + @doc(""" + This endpoint returns a list of addresses associated with a specific cXML Webhook. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...CXMLWebhookIDPath): | CXMLWebhookAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/cxml-webhooks/main.tsp b/specs/signalwire-rest/fabric-api/cxml-webhooks/main.tsp index b8d63ae10..ff0da54f6 100644 --- a/specs/signalwire-rest/fabric-api/cxml-webhooks/main.tsp +++ b/specs/signalwire-rest/fabric-api/cxml-webhooks/main.tsp @@ -17,7 +17,15 @@ namespace FabricAPI.CXMLWebhooks { @friendlyName("cXML Webhooks") interface CXMLWebhooks { @summary("List cXML Webhooks") - @doc("A list of cXML Webhooks") + @doc(""" + A list of cXML Webhooks + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | CXMLWebhookListResponse | StatusCode401 @@ -25,7 +33,15 @@ namespace FabricAPI.CXMLWebhooks { | StatusCode500; @summary("Get cXML Webhook") - @doc("Returns an cXML Webhook by ID") + @doc(""" + Returns an cXML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...CXMLWebhookID): | { @statusCode statusCode: 200; @@ -36,7 +52,15 @@ namespace FabricAPI.CXMLWebhooks { | StatusCode500; @summary("Create cXML Webhook") - @doc("Creates an cXML Webhook") + @doc(""" + Creates an cXML Webhook + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(...CXMLWebhookCreateRequest): | { @@ -49,7 +73,15 @@ namespace FabricAPI.CXMLWebhooks { | StatusCode500; @summary("Update cXML Webhook") - @doc("Updates an cXML Webhook by ID") + @doc(""" + Updates an cXML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @patch(#{ implicitOptionality: true }) update(...CXMLWebhookID, ...CXMLWebhookUpdateRequest): | { @@ -62,7 +94,15 @@ namespace FabricAPI.CXMLWebhooks { | StatusCode500; @summary("Delete cXML Webhook") - @doc("Deletes an cXML Webhook by ID") + @doc(""" + Deletes an cXML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...CXMLWebhookID): | { diff --git a/specs/signalwire-rest/fabric-api/dialogflow-agents/addresses/main.tsp b/specs/signalwire-rest/fabric-api/dialogflow-agents/addresses/main.tsp index 6808bc093..593668af8 100644 --- a/specs/signalwire-rest/fabric-api/dialogflow-agents/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/dialogflow-agents/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.DialogflowAgent.Addresses { @tag(AI_DIALOGFLOW_TAG) interface DialogflowAgentAddresses { @summary("List Dialogflow Agent Addresses") - @doc("This endpoint returns a list of addresses associated with a specific Dialogflow Agent.") + @doc(""" + This endpoint returns a list of addresses associated with a specific Dialogflow Agent. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...DialogflowAgentAddressPathID): | DialogflowAgentAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/dialogflow-agents/main.tsp b/specs/signalwire-rest/fabric-api/dialogflow-agents/main.tsp index afd3568e6..2fceafdc2 100644 --- a/specs/signalwire-rest/fabric-api/dialogflow-agents/main.tsp +++ b/specs/signalwire-rest/fabric-api/dialogflow-agents/main.tsp @@ -16,7 +16,15 @@ namespace FabricAPI.DialogflowAgents { @tag(AI_DIALOGFLOW_TAG) interface DialogflowAgents { @summary("List Dialogflow Agents") - @doc("A list of Dialogflow Agents") + @doc(""" + A list of Dialogflow Agents + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | DialogflowAgentListResponse | StatusCode401 @@ -24,7 +32,15 @@ namespace FabricAPI.DialogflowAgents { | StatusCode500; @summary("Get Dialogflow Agent") - @doc("Returns a Dialogflow Agent by ID") + @doc(""" + Returns a Dialogflow Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...DialogflowAgentPathID): | { @statusCode statusCode: 200; @@ -35,7 +51,15 @@ namespace FabricAPI.DialogflowAgents { | StatusCode500; @summary("Update Dialogflow Agent") - @doc("Updates a Dialogflow Agent by ID") + @doc(""" + Updates a Dialogflow Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update( ...DialogflowAgentPathID, @@ -51,7 +75,15 @@ namespace FabricAPI.DialogflowAgents { | StatusCode500; @summary("Delete Dialogflow Agent") - @doc("Deletes a Dialogflow Agent by ID") + @doc(""" + Deletes a Dialogflow Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...DialogflowAgentPathID): | { diff --git a/specs/signalwire-rest/fabric-api/domain-applications/main.tsp b/specs/signalwire-rest/fabric-api/domain-applications/main.tsp index 5e0884d64..80bc0cd1a 100644 --- a/specs/signalwire-rest/fabric-api/domain-applications/main.tsp +++ b/specs/signalwire-rest/fabric-api/domain-applications/main.tsp @@ -20,6 +20,13 @@ namespace FabricAPI.DomainApplications { :::important Currently only supports `calling` as a handler and automatically defaults to it. ::: + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) @post assign( diff --git a/specs/signalwire-rest/fabric-api/embeds-tokens/main.tsp b/specs/signalwire-rest/fabric-api/embeds-tokens/main.tsp index 3285cc61f..9994f3577 100644 --- a/specs/signalwire-rest/fabric-api/embeds-tokens/main.tsp +++ b/specs/signalwire-rest/fabric-api/embeds-tokens/main.tsp @@ -19,7 +19,15 @@ namespace FabricAPI.EmbedsTokens { @friendlyName("Embeds Tokens") interface EmbedsTokens { @summary("Create Embeds Tokens") - @doc("Exchanges a public Click-to-Call (C2C) token for a short-lived, private embed guest token used to authorize a call. This allows secure activation of the C2C widget without exposing sensitive credentials.") + @doc(""" + Exchanges a public Click-to-Call (C2C) token for a short-lived, private embed guest token used to authorize a call. This allows secure activation of the C2C widget without exposing sensitive credentials. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(@body body: EmbedsTokensRequest): | { diff --git a/specs/signalwire-rest/fabric-api/freeswitch-connectors/addresses/main.tsp b/specs/signalwire-rest/fabric-api/freeswitch-connectors/addresses/main.tsp index f21603331..e8dbf90ce 100644 --- a/specs/signalwire-rest/fabric-api/freeswitch-connectors/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/freeswitch-connectors/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.FreeswitchConnectorAddresses { @tag(FREESWITCH_CONNECTOR_TAG) interface FreeswitchConnectorAddresses { @summary("List FreeSWITCH Connector Addresses") - @doc("This endpoint returns a list of addresses associated with a specific FreeSWITCH Connector.") + @doc(""" + This endpoint returns a list of addresses associated with a specific FreeSWITCH Connector. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...FreeswitchConnectorAddressPathID): | FreeswitchConnectorAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/freeswitch-connectors/main.tsp b/specs/signalwire-rest/fabric-api/freeswitch-connectors/main.tsp index f2933eecd..28e6df543 100644 --- a/specs/signalwire-rest/fabric-api/freeswitch-connectors/main.tsp +++ b/specs/signalwire-rest/fabric-api/freeswitch-connectors/main.tsp @@ -17,7 +17,15 @@ namespace FabricAPI.FreeswitchConnectors { @friendlyName("FreeSWITCH Connectors") interface FreeswitchConnectors { @summary("List FreeSWITCH Connectors") - @doc("A list of FreeSWITCH Connectors") + @doc(""" + A list of FreeSWITCH Connectors + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | FreeswitchConnectorListResponse | StatusCode401 @@ -25,7 +33,15 @@ namespace FabricAPI.FreeswitchConnectors { | StatusCode500; @summary("Get FreeSWITCH Connector") - @doc("Returns a FreeSWITCH Connector by ID") + @doc(""" + Returns a FreeSWITCH Connector by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...FreeswitchConnectorPathID): | { @statusCode statusCode: 200; @@ -36,7 +52,15 @@ namespace FabricAPI.FreeswitchConnectors { | StatusCode500; @summary("Create FreeSWITCH Connector") - @doc("Creates a FreeSWITCH Connector") + @doc(""" + Creates a FreeSWITCH Connector + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(@body request: FreeswitchConnectorCreateRequest): | { @@ -49,7 +73,15 @@ namespace FabricAPI.FreeswitchConnectors { | StatusCode500; @summary("Update FreeSWITCH Connector") - @doc("Updates a FreeSWITCH Connector by ID") + @doc(""" + Updates a FreeSWITCH Connector by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update( ...FreeswitchConnectorPathID, @@ -65,7 +97,15 @@ namespace FabricAPI.FreeswitchConnectors { | StatusCode500; @summary("Delete FreeSWITCH Connector") - @doc("Deletes a FreeSWITCH Connector by ID") + @doc(""" + Deletes a FreeSWITCH Connector by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...FreeswitchConnectorPathID): | { diff --git a/specs/signalwire-rest/fabric-api/main.tsp b/specs/signalwire-rest/fabric-api/main.tsp index 8389886a8..2f8bac8af 100644 --- a/specs/signalwire-rest/fabric-api/main.tsp +++ b/specs/signalwire-rest/fabric-api/main.tsp @@ -69,5 +69,13 @@ using TypeSpec.OpenAPI; } ) @useAuth(BasicAuth) -@doc("API to access/manage SignalWire's Call Fabric objects.") +@doc(""" + API to access/manage SignalWire's Call Fabric objects. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) namespace FabricAPI; diff --git a/specs/signalwire-rest/fabric-api/phone-routes/main.tsp b/specs/signalwire-rest/fabric-api/phone-routes/main.tsp index 599f480ea..bb3cc8fa3 100644 --- a/specs/signalwire-rest/fabric-api/phone-routes/main.tsp +++ b/specs/signalwire-rest/fabric-api/phone-routes/main.tsp @@ -18,6 +18,13 @@ namespace FabricAPI.PhoneRoutes { @summary("Assign a Resource to a Phone Route") @doc(""" This endpoint assigns a specific resource to a phone route, allowing inbound calls & messages to be handled by the resource. + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) @post assign(...PhoneRoutePathID, @body request: PhoneRouteAssignRequest): diff --git a/specs/signalwire-rest/fabric-api/relay-applications/addresses/main.tsp b/specs/signalwire-rest/fabric-api/relay-applications/addresses/main.tsp index ae045c0a3..a425b7784 100644 --- a/specs/signalwire-rest/fabric-api/relay-applications/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/relay-applications/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.RelayApplication.Addresses { @tag(RELAY_APPLICATION_TAG) interface RelayApplicationAddresses { @summary("List Relay Application Addresses") - @doc("This endpoint returns a paginated list of addresses associated with a Relay Application.") + @doc(""" + This endpoint returns a paginated list of addresses associated with a Relay Application. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...RelayApplicationAddressPathID): | RelayApplicationAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/relay-applications/main.tsp b/specs/signalwire-rest/fabric-api/relay-applications/main.tsp index a4bb864a8..65ea300a2 100644 --- a/specs/signalwire-rest/fabric-api/relay-applications/main.tsp +++ b/specs/signalwire-rest/fabric-api/relay-applications/main.tsp @@ -17,7 +17,15 @@ namespace FabricAPI.RelayApplications { @friendlyName("Relay Applications") interface RelayApplications { @summary("List Relay Applications") - @doc("A list of Relay Applications") + @doc(""" + A list of Relay Applications + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | RelayApplicationListResponse | StatusCode401 @@ -25,7 +33,15 @@ namespace FabricAPI.RelayApplications { | StatusCode500; @summary("Get Relay Application") - @doc("Returns a Relay Application by ID") + @doc(""" + Returns a Relay Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...RelayApplicationPathID): | { @statusCode statusCode: 200; @@ -36,7 +52,15 @@ namespace FabricAPI.RelayApplications { | StatusCode500; @summary("Create Relay Application") - @doc("Creates a Relay Application") + @doc(""" + Creates a Relay Application + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(@body request: RelayApplicationCreateRequest): | { @@ -49,7 +73,15 @@ namespace FabricAPI.RelayApplications { | StatusCode500; @summary("Update Relay Application") - @doc("Updates a Relay Application by ID") + @doc(""" + Updates a Relay Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update( ...RelayApplicationPathID, @@ -65,7 +97,15 @@ namespace FabricAPI.RelayApplications { | StatusCode500; @summary("Delete Relay Application") - @doc("Deletes a Relay Application by ID") + @doc(""" + Deletes a Relay Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...RelayApplicationPathID): | { diff --git a/specs/signalwire-rest/fabric-api/resources/addresses/main.tsp b/specs/signalwire-rest/fabric-api/resources/addresses/main.tsp index 914e7603d..699289463 100644 --- a/specs/signalwire-rest/fabric-api/resources/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/resources/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.Resource.Addresses { @tag(RESOURCES_TAG) interface ResourceAddresses { @summary("List Resource Addresses") - @doc("This endpoint is used to retrieve addresses associated with a specific Resource.") + @doc(""" + This endpoint is used to retrieve addresses associated with a specific Resource. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...ResourceAddressPathID): | ResourceAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/resources/main.tsp b/specs/signalwire-rest/fabric-api/resources/main.tsp index f30332ab8..7827d5b30 100644 --- a/specs/signalwire-rest/fabric-api/resources/main.tsp +++ b/specs/signalwire-rest/fabric-api/resources/main.tsp @@ -17,7 +17,15 @@ namespace FabricAPI.Resources { @friendlyName("Resources") interface Resources { @summary("List Resources") - @doc("A list of Fabric Resources") + @doc(""" + A list of Fabric Resources + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | ResourceListResponse | StatusCode401 @@ -25,7 +33,15 @@ namespace FabricAPI.Resources { | StatusCode500; @summary("Get Resource") - @doc("Returns a Resource by ID") + @doc(""" + Returns a Resource by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...ResourcePathID): | { @statusCode statusCode: 200; @@ -36,7 +52,15 @@ namespace FabricAPI.Resources { | StatusCode500; @summary("Delete Resource") - @doc("Deletes a Resource by ID") + @doc(""" + Deletes a Resource by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...ResourcePathID): | { diff --git a/specs/signalwire-rest/fabric-api/sip-endpoints/addresses/main.tsp b/specs/signalwire-rest/fabric-api/sip-endpoints/addresses/main.tsp index 698635e8a..fd0fae003 100644 --- a/specs/signalwire-rest/fabric-api/sip-endpoints/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/sip-endpoints/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.SipEndpoint.Addresses { @tag(SIP_ENDPOINTS_TAG) interface SipEndpointAddresses { @summary("List SIP Endpoint Addresses") - @doc("A list of SIP Endpoint Addresses.") + @doc(""" + A list of SIP Endpoint Addresses. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...SipEndpointAddressPathID): | SipEndpointAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/sip-endpoints/main.tsp b/specs/signalwire-rest/fabric-api/sip-endpoints/main.tsp index 803110e3a..16c467be8 100644 --- a/specs/signalwire-rest/fabric-api/sip-endpoints/main.tsp +++ b/specs/signalwire-rest/fabric-api/sip-endpoints/main.tsp @@ -16,10 +16,26 @@ using Types.StatusCodes; namespace FabricAPI.SipEndpoints { @tag(SIP_ENDPOINTS_TAG) @friendlyName("SIP Endpoints") - @doc("SIP Endpoints API category.") + @doc(""" + SIP Endpoints API category. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) interface SipEndpoints { @summary("List SIP Endpoints") - @doc("A list of SIP Endpoints") + @doc(""" + A list of SIP Endpoints + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | SipEndpointListResponse[] | StatusCode401 @@ -27,7 +43,15 @@ namespace FabricAPI.SipEndpoints { | StatusCode500; @summary("Get SIP Endpoint") - @doc("Returns a SIP Endpoint by ID") + @doc(""" + Returns a SIP Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...SipEndpointPathID): | { @statusCode statusCode: 200; @@ -38,7 +62,15 @@ namespace FabricAPI.SipEndpoints { | StatusCode500; @summary("Create SIP Endpoint") - @doc("Creates a SIP Endpoint") + @doc(""" + Creates a SIP Endpoint + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(@body request: SipEndpointCreateRequest): | { @@ -51,7 +83,15 @@ namespace FabricAPI.SipEndpoints { | StatusCode500; @summary("Update SIP Endpoint") - @doc("Updates a SIP Endpoint by ID") + @doc(""" + Updates a SIP Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update(...SipEndpointPathID, @body request: SipEndpointUpdateRequest): | { @@ -64,7 +104,15 @@ namespace FabricAPI.SipEndpoints { | StatusCode500; @summary("Delete SIP Endpoint") - @doc("Deletes a SIP Endpoint by ID") + @doc(""" + Deletes a SIP Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...SipEndpointPathID): | { diff --git a/specs/signalwire-rest/fabric-api/sip-endpoints/resource/main.tsp b/specs/signalwire-rest/fabric-api/sip-endpoints/resource/main.tsp index 5f4685136..5c3801a4d 100644 --- a/specs/signalwire-rest/fabric-api/sip-endpoints/resource/main.tsp +++ b/specs/signalwire-rest/fabric-api/sip-endpoints/resource/main.tsp @@ -20,6 +20,13 @@ namespace FabricAPI.SipEndpoints.Resource { :::important Currently only supports `calling` as a handler and automatically defaults to it. ::: + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) @post assign( diff --git a/specs/signalwire-rest/fabric-api/sip_gateways/addresses/main.tsp b/specs/signalwire-rest/fabric-api/sip_gateways/addresses/main.tsp index 6d19b8a27..2d996292d 100644 --- a/specs/signalwire-rest/fabric-api/sip_gateways/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/sip_gateways/addresses/main.tsp @@ -14,7 +14,15 @@ namespace FabricAPI.SipGateways.Addresses { @friendlyName("SIP Gateway") interface RelayApplicationAddresses { @summary("List Fabric Addresses assigned to a SIP Gateway") - @doc("Returns a paginated list of Fabric Addresses associated with the specified SIP Gateway.") + @doc(""" + Returns a paginated list of Fabric Addresses associated with the specified SIP Gateway. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) readAddressesByResourceId(...SipGatewayAddressRequest): | SipGatewayAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/sip_gateways/main.tsp b/specs/signalwire-rest/fabric-api/sip_gateways/main.tsp index d926b6b10..9e4bd2b9e 100644 --- a/specs/signalwire-rest/fabric-api/sip_gateways/main.tsp +++ b/specs/signalwire-rest/fabric-api/sip_gateways/main.tsp @@ -16,7 +16,15 @@ namespace FabricAPI.SipGateways { @friendlyName("SIP Gateway") interface SipGateways { @summary("List SIP Gateways") - @doc("Returns a paginated list of SIP Gateways for the authenticated project.") + @doc(""" + Returns a paginated list of SIP Gateways for the authenticated project. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | SipGatewayListResponse | StatusCode401 @@ -24,7 +32,15 @@ namespace FabricAPI.SipGateways { | StatusCode500; @summary("Get SIP Gateway") - @doc("Returns an SIP Gateway by ID") + @doc(""" + Returns an SIP Gateway by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...SipGatewayID): | { @statusCode statusCode: 200; @@ -35,7 +51,15 @@ namespace FabricAPI.SipGateways { | StatusCode500; @summary("Create SIP Gateway") - @doc("Creates a SIP Gateway that can be used to dial external SIP entities.") + @doc(""" + Creates a SIP Gateway that can be used to dial external SIP entities. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(...SipGatewayRequest): | { @@ -48,7 +72,15 @@ namespace FabricAPI.SipGateways { | StatusCode500; @summary("Update SIP Gateway") - @doc("Updates a SIP Gateway by ID") + @doc(""" + Updates a SIP Gateway by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @patch(#{ implicitOptionality: true }) update(...SipGatewayID, ...SipGatewayRequest): | { @@ -61,7 +93,15 @@ namespace FabricAPI.SipGateways { | StatusCode500; @summary("Delete SIP Gateway") - @doc("Deletes a SIP Gateway} by ID") + @doc(""" + Deletes a SIP Gateway} by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...SipGatewayID): | { diff --git a/specs/signalwire-rest/fabric-api/subscribers/guest-tokens/main.tsp b/specs/signalwire-rest/fabric-api/subscribers/guest-tokens/main.tsp index 4f7bd6f9c..ded932e54 100644 --- a/specs/signalwire-rest/fabric-api/subscribers/guest-tokens/main.tsp +++ b/specs/signalwire-rest/fabric-api/subscribers/guest-tokens/main.tsp @@ -14,7 +14,15 @@ namespace FabricAPI.SubscriberGuestTokens { @friendlyName("Guest Token") interface GuestTokens { @summary("Create Subscriber Guest Token") - @doc("Creates a Subscriber Guest Token. The token is authorized using an existing API token.") + @doc(""" + Creates a Subscriber Guest Token. The token is authorized using an existing API token. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(...SubscriberGuestTokenCreateRequest): | { diff --git a/specs/signalwire-rest/fabric-api/subscribers/invite-tokens/main.tsp b/specs/signalwire-rest/fabric-api/subscribers/invite-tokens/main.tsp index 1587192c6..cf0a9ae28 100644 --- a/specs/signalwire-rest/fabric-api/subscribers/invite-tokens/main.tsp +++ b/specs/signalwire-rest/fabric-api/subscribers/invite-tokens/main.tsp @@ -14,7 +14,15 @@ namespace FabricAPI.SubscriberInviteTokens { @friendlyName("Invite Token") interface InviteTokens { @summary("Create a Subscriber Invite Token") - @doc("Creates a Subscriber Invite Token to be used for client-side API calls. The token is authorized using a subscriber's SAT (Subscriber Access Token)") + @doc(""" + Creates a Subscriber Invite Token to be used for client-side API calls. The token is authorized using a subscriber's SAT (Subscriber Access Token) + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(...SubscriberInviteTokenCreateRequest): | { diff --git a/specs/signalwire-rest/fabric-api/subscribers/main.tsp b/specs/signalwire-rest/fabric-api/subscribers/main.tsp index 580ab6e33..2e8d2128b 100644 --- a/specs/signalwire-rest/fabric-api/subscribers/main.tsp +++ b/specs/signalwire-rest/fabric-api/subscribers/main.tsp @@ -22,7 +22,15 @@ namespace FabricAPI.Subscribers { @friendlyName("Subscribers") interface Subscribers { @summary("List Subscribers") - @doc("Retrieve a list of all subscribers") + @doc(""" + Retrieve a list of all subscribers + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | SubscriberListResponse | StatusCode401 @@ -30,7 +38,15 @@ namespace FabricAPI.Subscribers { | StatusCode500; @summary("Create Subscriber") - @doc("Create a new Subscriber") + @doc(""" + Create a new Subscriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(@body body: SubscriberRequest): | { @@ -43,7 +59,15 @@ namespace FabricAPI.Subscribers { | StatusCode500; @summary("Get Subscriber") - @doc("Fetch an existing Subscriber") + @doc(""" + Fetch an existing Subscriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) get(...SubscriberPathID): | { @statusCode statusCode: 200; @@ -54,7 +78,15 @@ namespace FabricAPI.Subscribers { | StatusCode500; @summary("Update Subscriber") - @doc("Update an existing Subsriber") + @doc(""" + Update an existing Subsriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update(...SubscriberPathID, ...SubscriberRequest): | { @@ -67,7 +99,15 @@ namespace FabricAPI.Subscribers { | StatusCode500; @summary("Delete Subscriber") - @doc("Delete an existing Subscriber") + @doc(""" + Delete an existing Subscriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...SubscriberPathID): | { diff --git a/specs/signalwire-rest/fabric-api/subscribers/refresh-tokens/main.tsp b/specs/signalwire-rest/fabric-api/subscribers/refresh-tokens/main.tsp index a20f2fa51..d747a2213 100644 --- a/specs/signalwire-rest/fabric-api/subscribers/refresh-tokens/main.tsp +++ b/specs/signalwire-rest/fabric-api/subscribers/refresh-tokens/main.tsp @@ -14,7 +14,15 @@ namespace FabricAPI.SubscriberRefreshTokens { @friendlyName("Refresh Token") interface RefreshTokens { @summary("Exchange a refresh token for a new subscriber access token") - @doc("Exchanges a valid refresh token for a new subscriber access token and a new refresh token. The new access token is valid for 2 hours, and the new refresh token is valid for 2 hours and 5 minutes.") + @doc(""" + Exchanges a valid refresh token for a new subscriber access token and a new refresh token. The new access token is valid for 2 hours, and the new refresh token is valid for 2 hours and 5 minutes. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(...SubscriberRefreshTokenRequest): | { diff --git a/specs/signalwire-rest/fabric-api/subscribers/subscriber-addresses/main.tsp b/specs/signalwire-rest/fabric-api/subscribers/subscriber-addresses/main.tsp index c8580d55f..17cd950da 100644 --- a/specs/signalwire-rest/fabric-api/subscribers/subscriber-addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/subscribers/subscriber-addresses/main.tsp @@ -14,7 +14,15 @@ namespace FabricAPI.Subscribers.Addresses { @summary("Subscriber Addresses") interface SubscriberAddresses { @summary("List Subscriber Addresses") - @doc("List Subscriber Addresses") + @doc(""" + List Subscriber Addresses + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...SubscriberAddressID): | SubscriberAddressesResponse[] | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/subscribers/subscriber-sip-endpoint/main.tsp b/specs/signalwire-rest/fabric-api/subscribers/subscriber-sip-endpoint/main.tsp index 49f5f3a59..4ab855051 100644 --- a/specs/signalwire-rest/fabric-api/subscribers/subscriber-sip-endpoint/main.tsp +++ b/specs/signalwire-rest/fabric-api/subscribers/subscriber-sip-endpoint/main.tsp @@ -16,7 +16,15 @@ namespace FabricAPI.Subscribers.SipEndpoints { @friendlyName("SIP Endpoints") interface SubscriberSipEndpoint { @summary("List Subscriber SIP Endpoints") - @doc("A list of Sip Endpoints of the Subscriber") + @doc(""" + A list of Sip Endpoints of the Subscriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...FabricSubscriberID): | SubscriberSipEndpointListResponse | StatusCode401 @@ -24,7 +32,15 @@ namespace FabricAPI.Subscribers.SipEndpoints { | StatusCode500; @summary("Get Subscriber SIP Endpoint") - @doc("Returns a Subscriber Sip Endpoint by ID") + @doc(""" + Returns a Subscriber Sip Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...SIPEndpointID, ...FabricSubscriberID): | { @statusCode statusCode: 200; @@ -35,7 +51,15 @@ namespace FabricAPI.Subscribers.SipEndpoints { | StatusCode500; @summary("Create Subscriber SIP Endpoint") - @doc("Creates a Subscriber Sip Endpoint") + @doc(""" + Creates a Subscriber Sip Endpoint + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(...FabricSubscriberID, @body body: SubscriberSipEndpointRequest): | { @@ -48,7 +72,15 @@ namespace FabricAPI.Subscribers.SipEndpoints { | StatusCode500; @summary("Update Subscriber SIP Endpoint") - @doc("Updates a Subscriber Sip Endpoint by ID") + @doc(""" + Updates a Subscriber Sip Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @patch(#{ implicitOptionality: true }) update( ...SIPEndpointID, @@ -65,7 +97,15 @@ namespace FabricAPI.Subscribers.SipEndpoints { | StatusCode500; @summary("Delete Subscriber SIP Endpoint") - @doc("Deletes a Subscriber Sip Endpoint by ID") + @doc(""" + Deletes a Subscriber Sip Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...SIPEndpointID, ...FabricSubscriberID): | { diff --git a/specs/signalwire-rest/fabric-api/subscribers/subscriber-tokens/main.tsp b/specs/signalwire-rest/fabric-api/subscribers/subscriber-tokens/main.tsp index acd8b1b6a..a8160ef75 100644 --- a/specs/signalwire-rest/fabric-api/subscribers/subscriber-tokens/main.tsp +++ b/specs/signalwire-rest/fabric-api/subscribers/subscriber-tokens/main.tsp @@ -14,7 +14,15 @@ namespace FabricAPI.SubscriberTokens { @tag(SUBSCRIBERS_TAG) interface SubscriberTokens { @summary("Create Subscriber Token") - @doc("Create a Subscriber Token") + @doc(""" + Create a Subscriber Token + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) create(...SubscriberTokenRequest): | SubscriberTokenResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/swml-scripts/addresses/main.tsp b/specs/signalwire-rest/fabric-api/swml-scripts/addresses/main.tsp index acd26a3e9..5a0ccdeb4 100644 --- a/specs/signalwire-rest/fabric-api/swml-scripts/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/swml-scripts/addresses/main.tsp @@ -13,7 +13,15 @@ namespace FabricAPI.SWMLScript.Addresses { @tag(SWML_SCRIPTS_TAG) interface SWMLScriptAddresses { @summary("List SWML Script Addresses") - @doc("This endpoints returns a list of addresses associated with a specific SWML script.") + @doc(""" + This endpoints returns a list of addresses associated with a specific SWML script. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...SWMLScriptAddressPathID): | SWMLScriptAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/swml-scripts/main.tsp b/specs/signalwire-rest/fabric-api/swml-scripts/main.tsp index 0f47027af..d4789d21f 100644 --- a/specs/signalwire-rest/fabric-api/swml-scripts/main.tsp +++ b/specs/signalwire-rest/fabric-api/swml-scripts/main.tsp @@ -17,7 +17,15 @@ namespace FabricAPI.SwmlScripts { @friendlyName("SWML Scripts") interface SwmlScripts { @summary("List SWML Scripts") - @doc("A list of SWML Scripts") + @doc(""" + A list of SWML Scripts + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | SwmlScriptListResponse[] | StatusCode401 @@ -25,7 +33,15 @@ namespace FabricAPI.SwmlScripts { | StatusCode500; @summary("Get SWML Script") - @doc("Returns a SWML Script by ID") + @doc(""" + Returns a SWML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...SwmlScriptPathID): | { @statusCode statusCode: 200; @@ -36,7 +52,15 @@ namespace FabricAPI.SwmlScripts { | StatusCode500; @summary("Create SWML Script") - @doc("Creates a SWML Script") + @doc(""" + Creates a SWML Script + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(@body request: SwmlScriptCreateRequest): | { @@ -49,7 +73,15 @@ namespace FabricAPI.SwmlScripts { | StatusCode500; @summary("Update SWML Script") - @doc("Updates a SWML Script by ID") + @doc(""" + Updates a SWML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @put update(...SwmlScriptPathID, @body request: SwmlScriptUpdateRequest): | { @@ -62,7 +94,15 @@ namespace FabricAPI.SwmlScripts { | StatusCode500; @summary("Delete SWML Script") - @doc("Deletes a SWML Script by ID") + @doc(""" + Deletes a SWML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...SwmlScriptPathID): | { diff --git a/specs/signalwire-rest/fabric-api/swml-webhook/addresses/main.tsp b/specs/signalwire-rest/fabric-api/swml-webhook/addresses/main.tsp index 3cc8d2e79..959d152e1 100644 --- a/specs/signalwire-rest/fabric-api/swml-webhook/addresses/main.tsp +++ b/specs/signalwire-rest/fabric-api/swml-webhook/addresses/main.tsp @@ -14,7 +14,15 @@ namespace FabricAPI.SWMLWebhookAddresses { @friendlyName("SWML Webhooks") interface SWMLWebhookAddresses { @summary("List SWML Webhook Addresses") - @doc("This endpoint returns a list of addresses associated with a specific SWML webhook.") + @doc(""" + This endpoint returns a list of addresses associated with a specific SWML webhook. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(...SWMLWebhookIDPath): | SWMLWebhookAddressListResponse | StatusCode401 diff --git a/specs/signalwire-rest/fabric-api/swml-webhook/main.tsp b/specs/signalwire-rest/fabric-api/swml-webhook/main.tsp index 29456db3c..2f1db58e6 100644 --- a/specs/signalwire-rest/fabric-api/swml-webhook/main.tsp +++ b/specs/signalwire-rest/fabric-api/swml-webhook/main.tsp @@ -17,7 +17,15 @@ namespace FabricAPI.SWMLWebhooks { @friendlyName("SWML Webhooks") interface SWMLWebhooks { @summary("List SWML Webhooks") - @doc("A list of SWML Webhooks") + @doc(""" + A list of SWML Webhooks + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): | SWMLWebhookListResponse | StatusCode401 @@ -25,7 +33,15 @@ namespace FabricAPI.SWMLWebhooks { | StatusCode500; @summary("Get SWML Webhook") - @doc("Returns an SWML Webhook by ID") + @doc(""" + Returns an SWML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) read(...SWMLWebhookID): | { @statusCode statusCode: 200; @@ -36,7 +52,15 @@ namespace FabricAPI.SWMLWebhooks { | StatusCode500; @summary("Create SWML Webhook") - @doc("Creates an SWML Webhook") + @doc(""" + Creates an SWML Webhook + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @post create(...SWMLWebhookCreateRequest): | { @@ -49,7 +73,15 @@ namespace FabricAPI.SWMLWebhooks { | StatusCode500; @summary("Update SWML Webhook") - @doc("Updates an SWML Webhook by ID") + @doc(""" + Updates an SWML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @patch(#{ implicitOptionality: true }) update(...SWMLWebhookID, ...SWMLWebhookUpdateRequest): | { @@ -62,7 +94,15 @@ namespace FabricAPI.SWMLWebhooks { | StatusCode500; @summary("Delete SWML Webhook") - @doc("Deletes an SWML Webhook by ID") + @doc(""" + Deletes an SWML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) @delete delete(...SWMLWebhookID): | { diff --git a/specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml index b91705025..325481c97 100644 --- a/specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -10,7 +10,14 @@ info: name: MIT url: https://github.com/signalwire/docs/blob/main/LICENSE termsOfService: https://signalwire.com/legal/signalwire-cloud-agreement - description: API to access/manage SignalWire's Call Fabric objects. + description: |- + API to access/manage SignalWire's Call Fabric objects. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). externalDocs: url: https://developer.signalwire.com/rest/signalwire-rest/endpoints/fabric description: The Fabric API holds a collection of endpoints that will help you in managing and creating your SignalWire Resources. @@ -128,6 +135,13 @@ paths: description: |- A list of Fabric Addresses. This endpoint uses the bearer token authentication method with the SAT (Subscriber Access Token) which can be generated using the [Create Subscriber Token endpoint](/rest/signalwire-rest/endpoints/fabric/subscriber-tokens-create). + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -165,6 +179,13 @@ paths: description: |- Returns a Fabric Address by ID. This endpoint uses the bearer token authentication method with the SAT (Subscriber Access Token) which can be generated using the [Create Subscriber Token endpoint](/rest/signalwire-rest/endpoints/fabric/subscriber-tokens-create). + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/FabricAddressID' responses: @@ -200,7 +221,14 @@ paths: post: operationId: EmbedsTokens_create summary: Create Embeds Tokens - description: Exchanges a public Click-to-Call (C2C) token for a short-lived, private embed guest token used to authorize a call. This allows secure activation of the C2C widget without exposing sensitive credentials. + description: |- + Exchanges a public Click-to-Call (C2C) token for a short-lived, private embed guest token used to authorize a call. This allows secure activation of the C2C widget without exposing sensitive credentials. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -253,7 +281,14 @@ paths: post: operationId: GuestTokens_create summary: Create Subscriber Guest Token - description: Creates a Subscriber Guest Token. The token is authorized using an existing API token. + description: |- + Creates a Subscriber Guest Token. The token is authorized using an existing API token. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -298,7 +333,14 @@ paths: get: operationId: Resources_list summary: List Resources - description: A list of Fabric Resources + description: |- + A list of Fabric Resources + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -331,7 +373,14 @@ paths: get: operationId: AIAgents_list summary: List AI Agents - description: A list of AI Agents + description: |- + A list of AI Agents + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -363,7 +412,14 @@ paths: post: operationId: AIAgents_create summary: Create AI Agent - description: Creates an AI Agent + description: |- + Creates an AI Agent + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -408,7 +464,14 @@ paths: get: operationId: AIAgentAddresses_list summary: List AI Agent Addresses - description: This endpoint returns a list of addresses associated with a specific AI Agent. + description: |- + This endpoint returns a list of addresses associated with a specific AI Agent. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/AIAgentIDPath' responses: @@ -442,7 +505,14 @@ paths: get: operationId: AIAgents_read summary: Get AI Agent - description: Returns an AI Agent by ID + description: |- + Returns an AI Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/AIAgentPathID' responses: @@ -475,7 +545,14 @@ paths: patch: operationId: AIAgents_update summary: Update AI Agent - description: Updates an AI Agent by ID + description: |- + Updates an AI Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/AIAgentPathID' responses: @@ -520,7 +597,14 @@ paths: delete: operationId: AIAgents_delete summary: Delete AI Agent - description: Deletes an AI Agent by ID + description: |- + Deletes an AI Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/AIAgentPathID' responses: @@ -550,7 +634,14 @@ paths: get: operationId: CallFlowAddresses_list summary: List Call Flow Addresses - description: This endpoint returns a list of addresses associated with a specific Call Flow. + description: |- + This endpoint returns a list of addresses associated with a specific Call Flow. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CallFlowAddressPathID' responses: @@ -584,7 +675,14 @@ paths: get: operationId: CallFlowVersions_list summary: List Call Flow Versions - description: Returns a list of versions of a Call Flow. + description: |- + Returns a list of versions of a Call Flow. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CallFlowVersionPathID' responses: @@ -617,7 +715,14 @@ paths: post: operationId: CallFlowVersions_deploy summary: Deploy a Call Flow Version - description: Deploys a specific version of a Call Flow. + description: |- + Deploys a specific version of a Call Flow. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CallFlowVersionPathID' responses: @@ -663,7 +768,14 @@ paths: get: operationId: CallFlows_list summary: List Call Flows - description: A list of Call Flows + description: |- + A list of Call Flows + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -695,7 +807,14 @@ paths: post: operationId: CallFlows_create summary: Create Call Flow - description: Creates a Call Flow + description: |- + Creates a Call Flow + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -740,7 +859,14 @@ paths: get: operationId: CallFlows_read summary: Get Call Flow - description: Returns a Call Flow by ID + description: |- + Returns a Call Flow by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CallFlowPathID' responses: @@ -773,7 +899,14 @@ paths: put: operationId: CallFlows_update summary: Update Call Flow - description: Updates a Call Flow by ID + description: |- + Updates a Call Flow by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CallFlowPathID' responses: @@ -818,7 +951,14 @@ paths: delete: operationId: CallFlows_delete summary: Delete Call Flow - description: Deletes a Call Flow by ID + description: |- + Deletes a Call Flow by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CallFlowPathID' responses: @@ -848,7 +988,14 @@ paths: get: operationId: ConferenceRoomAddresses_list summary: List Conference Room Addresses - description: This endpoint returns a list of addresses associated with a specific Conference Room. + description: |- + This endpoint returns a list of addresses associated with a specific Conference Room. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ConferenceRoomAddressPathID' responses: @@ -882,7 +1029,14 @@ paths: get: operationId: ConferenceRooms_list summary: List Conference Rooms - description: Returns a list of conference rooms. + description: |- + Returns a list of conference rooms. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -914,7 +1068,14 @@ paths: post: operationId: ConferenceRooms_create summary: Create Conference Room - description: Creates a Conference Room + description: |- + Creates a Conference Room + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -959,7 +1120,14 @@ paths: get: operationId: ConferenceRooms_read summary: Get Conference Room - description: Returns a Conference Room by ID + description: |- + Returns a Conference Room by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ConferenceRoomPathID' responses: @@ -992,7 +1160,14 @@ paths: put: operationId: ConferenceRooms_update summary: Update Conference Room - description: Updates a Conference Room by ID + description: |- + Updates a Conference Room by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ConferenceRoomPathID' responses: @@ -1037,7 +1212,14 @@ paths: delete: operationId: ConferenceRooms_delete summary: Delete Conference Room - description: Deletes a Conference Room by ID + description: |- + Deletes a Conference Room by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ConferenceRoomPathID' responses: @@ -1067,7 +1249,14 @@ paths: get: operationId: CxmlApplications_list summary: List cXML Applications - description: A list of cXML Applications + description: |- + A list of cXML Applications + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -1100,7 +1289,14 @@ paths: get: operationId: CxmlApplications_read summary: Get cXML Application - description: Returns a cXML Application by ID + description: |- + Returns a cXML Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CxmlApplicationPathID' responses: @@ -1133,7 +1329,14 @@ paths: put: operationId: CxmlApplications_update summary: Update cXML Application - description: Updates a cXML Application by ID + description: |- + Updates a cXML Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CxmlApplicationPathID' responses: @@ -1178,7 +1381,14 @@ paths: delete: operationId: CxmlApplications_delete summary: Delete LAML Application - description: Deletes a LAML Application by ID + description: |- + Deletes a LAML Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CxmlApplicationPathID' responses: @@ -1208,7 +1418,14 @@ paths: get: operationId: CxmlApplicationAddresses_list summary: List cXML Application Addresses - description: This endpoint returns a list of addresses associated with a specific LaML Application. + description: |- + This endpoint returns a list of addresses associated with a specific LaML Application. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CxmlApplicationAddressPathID' responses: @@ -1242,7 +1459,14 @@ paths: get: operationId: CXMLScripts_list summary: List cXML Scripts - description: A list of cXML Scripts + description: |- + A list of cXML Scripts + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -1274,7 +1498,14 @@ paths: post: operationId: CXMLScripts_create summary: Create cXML Script - description: Creates a cXML Script + description: |- + Creates a cXML Script + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -1319,7 +1550,14 @@ paths: get: operationId: CXMLScripts_read summary: Get cXML Script - description: Returns a cXML Script by ID + description: |- + Returns a cXML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CXMLScriptPathID' responses: @@ -1352,7 +1590,14 @@ paths: put: operationId: CXMLScripts_update summary: Update cXML Script - description: Updates a cXML Script by ID + description: |- + Updates a cXML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CXMLScriptPathID' responses: @@ -1397,7 +1642,14 @@ paths: delete: operationId: CXMLScripts_delete summary: Delete cXML Script - description: Deletes a cXML Script by ID + description: |- + Deletes a cXML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CXMLScriptPathID' responses: @@ -1427,7 +1679,14 @@ paths: get: operationId: CXMLScriptAddresses_list summary: List cXML Script Addresses - description: This endpoint returns a list of addresses associated with a specific cXML Script. + description: |- + This endpoint returns a list of addresses associated with a specific cXML Script. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CXMLScriptAddressPathID' responses: @@ -1461,7 +1720,14 @@ paths: get: operationId: CXMLWebhooks_list summary: List cXML Webhooks - description: A list of cXML Webhooks + description: |- + A list of cXML Webhooks + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -1493,7 +1759,14 @@ paths: post: operationId: CXMLWebhooks_create summary: Create cXML Webhook - description: Creates an cXML Webhook + description: |- + Creates an cXML Webhook + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -1538,7 +1811,14 @@ paths: get: operationId: CXMLWebhookAddresses_list summary: List cXML Webhook Addresses - description: This endpoint returns a list of addresses associated with a specific cXML Webhook. + description: |- + This endpoint returns a list of addresses associated with a specific cXML Webhook. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CXMLWebhookIDPath' responses: @@ -1572,7 +1852,14 @@ paths: get: operationId: CXMLWebhooks_read summary: Get cXML Webhook - description: Returns an cXML Webhook by ID + description: |- + Returns an cXML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CXMLWebhookID' responses: @@ -1605,7 +1892,14 @@ paths: patch: operationId: CXMLWebhooks_update summary: Update cXML Webhook - description: Updates an cXML Webhook by ID + description: |- + Updates an cXML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CXMLWebhookID' responses: @@ -1650,7 +1944,14 @@ paths: delete: operationId: CXMLWebhooks_delete summary: Delete cXML Webhook - description: Deletes an cXML Webhook by ID + description: |- + Deletes an cXML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/CXMLWebhookID' responses: @@ -1680,7 +1981,14 @@ paths: get: operationId: DialogflowAgents_list summary: List Dialogflow Agents - description: A list of Dialogflow Agents + description: |- + A list of Dialogflow Agents + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -1713,7 +2021,14 @@ paths: get: operationId: DialogflowAgents_read summary: Get Dialogflow Agent - description: Returns a Dialogflow Agent by ID + description: |- + Returns a Dialogflow Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/DialogflowAgentPathID' responses: @@ -1746,7 +2061,14 @@ paths: put: operationId: DialogflowAgents_update summary: Update Dialogflow Agent - description: Updates a Dialogflow Agent by ID + description: |- + Updates a Dialogflow Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/DialogflowAgentPathID' responses: @@ -1791,7 +2113,14 @@ paths: delete: operationId: DialogflowAgents_delete summary: Delete Dialogflow Agent - description: Deletes a Dialogflow Agent by ID + description: |- + Deletes a Dialogflow Agent by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/DialogflowAgentPathID' responses: @@ -1821,7 +2150,14 @@ paths: get: operationId: DialogflowAgentAddresses_list summary: List Dialogflow Agent Addresses - description: This endpoint returns a list of addresses associated with a specific Dialogflow Agent. + description: |- + This endpoint returns a list of addresses associated with a specific Dialogflow Agent. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/DialogflowAgentAddressPathID' responses: @@ -1855,7 +2191,14 @@ paths: get: operationId: FreeswitchConnectors_list summary: List FreeSWITCH Connectors - description: A list of FreeSWITCH Connectors + description: |- + A list of FreeSWITCH Connectors + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -1887,7 +2230,14 @@ paths: post: operationId: FreeswitchConnectors_create summary: Create FreeSWITCH Connector - description: Creates a FreeSWITCH Connector + description: |- + Creates a FreeSWITCH Connector + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -1932,7 +2282,14 @@ paths: get: operationId: FreeswitchConnectors_read summary: Get FreeSWITCH Connector - description: Returns a FreeSWITCH Connector by ID + description: |- + Returns a FreeSWITCH Connector by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/FreeswitchConnectorPathID' responses: @@ -1965,7 +2322,14 @@ paths: put: operationId: FreeswitchConnectors_update summary: Update FreeSWITCH Connector - description: Updates a FreeSWITCH Connector by ID + description: |- + Updates a FreeSWITCH Connector by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/FreeswitchConnectorPathID' responses: @@ -2010,7 +2374,14 @@ paths: delete: operationId: FreeswitchConnectors_delete summary: Delete FreeSWITCH Connector - description: Deletes a FreeSWITCH Connector by ID + description: |- + Deletes a FreeSWITCH Connector by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/FreeswitchConnectorPathID' responses: @@ -2040,7 +2411,14 @@ paths: get: operationId: FreeswitchConnectorAddresses_list summary: List FreeSWITCH Connector Addresses - description: This endpoint returns a list of addresses associated with a specific FreeSWITCH Connector. + description: |- + This endpoint returns a list of addresses associated with a specific FreeSWITCH Connector. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/FreeswitchConnectorAddressPathID' responses: @@ -2074,7 +2452,14 @@ paths: get: operationId: RelayApplications_list summary: List Relay Applications - description: A list of Relay Applications + description: |- + A list of Relay Applications + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -2106,7 +2491,14 @@ paths: post: operationId: RelayApplications_create summary: Create Relay Application - description: Creates a Relay Application + description: |- + Creates a Relay Application + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -2151,7 +2543,14 @@ paths: get: operationId: RelayApplications_read summary: Get Relay Application - description: Returns a Relay Application by ID + description: |- + Returns a Relay Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/RelayApplicationPathID' responses: @@ -2184,7 +2583,14 @@ paths: put: operationId: RelayApplications_update summary: Update Relay Application - description: Updates a Relay Application by ID + description: |- + Updates a Relay Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/RelayApplicationPathID' responses: @@ -2229,7 +2635,14 @@ paths: delete: operationId: RelayApplications_delete summary: Delete Relay Application - description: Deletes a Relay Application by ID + description: |- + Deletes a Relay Application by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/RelayApplicationPathID' responses: @@ -2259,7 +2672,14 @@ paths: get: operationId: RelayApplicationAddresses_list summary: List Relay Application Addresses - description: This endpoint returns a paginated list of addresses associated with a Relay Application. + description: |- + This endpoint returns a paginated list of addresses associated with a Relay Application. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/RelayApplicationAddressPathID' responses: @@ -2293,7 +2713,14 @@ paths: get: operationId: SipEndpoints_list summary: List SIP Endpoints - description: A list of SIP Endpoints + description: |- + A list of SIP Endpoints + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -2327,7 +2754,14 @@ paths: post: operationId: SipEndpoints_create summary: Create SIP Endpoint - description: Creates a SIP Endpoint + description: |- + Creates a SIP Endpoint + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -2377,6 +2811,13 @@ paths: :::important Currently only supports `calling` as a handler and automatically defaults to it. ::: + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ResourceSipEndpointPathID' responses: @@ -2422,7 +2863,14 @@ paths: get: operationId: SipEndpoints_read summary: Get SIP Endpoint - description: Returns a SIP Endpoint by ID + description: |- + Returns a SIP Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SipEndpointPathID' responses: @@ -2455,7 +2903,14 @@ paths: put: operationId: SipEndpoints_update summary: Update SIP Endpoint - description: Updates a SIP Endpoint by ID + description: |- + Updates a SIP Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SipEndpointPathID' responses: @@ -2500,7 +2955,14 @@ paths: delete: operationId: SipEndpoints_delete summary: Delete SIP Endpoint - description: Deletes a SIP Endpoint by ID + description: |- + Deletes a SIP Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SipEndpointPathID' responses: @@ -2530,7 +2992,14 @@ paths: get: operationId: SipEndpointAddresses_list summary: List SIP Endpoint Addresses - description: A list of SIP Endpoint Addresses. + description: |- + A list of SIP Endpoint Addresses. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SipEndpointAddressPathID' responses: @@ -2564,7 +3033,14 @@ paths: get: operationId: SipGateways_list summary: List SIP Gateways - description: Returns a paginated list of SIP Gateways for the authenticated project. + description: |- + Returns a paginated list of SIP Gateways for the authenticated project. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -2596,7 +3072,14 @@ paths: post: operationId: SipGateways_create summary: Create SIP Gateway - description: Creates a SIP Gateway that can be used to dial external SIP entities. + description: |- + Creates a SIP Gateway that can be used to dial external SIP entities. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -2641,7 +3124,14 @@ paths: get: operationId: RelayApplicationAddresses_readAddressesByResourceId summary: List Fabric Addresses assigned to a SIP Gateway - description: Returns a paginated list of Fabric Addresses associated with the specified SIP Gateway. + description: |- + Returns a paginated list of Fabric Addresses associated with the specified SIP Gateway. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SipGatewayAddressRequest' responses: @@ -2675,7 +3165,14 @@ paths: get: operationId: SipGateways_read summary: Get SIP Gateway - description: Returns an SIP Gateway by ID + description: |- + Returns an SIP Gateway by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SipGatewayID' responses: @@ -2708,7 +3205,14 @@ paths: patch: operationId: SipGateways_update summary: Update SIP Gateway - description: Updates a SIP Gateway by ID + description: |- + Updates a SIP Gateway by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SipGatewayID' responses: @@ -2753,7 +3257,14 @@ paths: delete: operationId: SipGateways_delete summary: Delete SIP Gateway - description: Deletes a SIP Gateway} by ID + description: |- + Deletes a SIP Gateway} by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SipGatewayID' responses: @@ -2783,7 +3294,14 @@ paths: get: operationId: Subscribers_list summary: List Subscribers - description: Retrieve a list of all subscribers + description: |- + Retrieve a list of all subscribers + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -2815,7 +3333,14 @@ paths: post: operationId: Subscribers_create summary: Create Subscriber - description: Create a new Subscriber + description: |- + Create a new Subscriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -2860,7 +3385,14 @@ paths: get: operationId: SubscriberSipEndpoint_list summary: List Subscriber SIP Endpoints - description: A list of Sip Endpoints of the Subscriber + description: |- + A list of Sip Endpoints of the Subscriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/FabricSubscriberID' responses: @@ -2893,7 +3425,14 @@ paths: post: operationId: SubscriberSipEndpoint_create summary: Create Subscriber SIP Endpoint - description: Creates a Subscriber Sip Endpoint + description: |- + Creates a Subscriber Sip Endpoint + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/FabricSubscriberID' responses: @@ -2939,7 +3478,14 @@ paths: get: operationId: SubscriberSipEndpoint_read summary: Get Subscriber SIP Endpoint - description: Returns a Subscriber Sip Endpoint by ID + description: |- + Returns a Subscriber Sip Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SIPEndpointID' - $ref: '#/components/parameters/FabricSubscriberID' @@ -2973,7 +3519,14 @@ paths: patch: operationId: SubscriberSipEndpoint_update summary: Update Subscriber SIP Endpoint - description: Updates a Subscriber Sip Endpoint by ID + description: |- + Updates a Subscriber Sip Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SIPEndpointID' - $ref: '#/components/parameters/FabricSubscriberID' @@ -3019,7 +3572,14 @@ paths: delete: operationId: SubscriberSipEndpoint_delete summary: Delete Subscriber SIP Endpoint - description: Deletes a Subscriber Sip Endpoint by ID + description: |- + Deletes a Subscriber Sip Endpoint by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SIPEndpointID' - $ref: '#/components/parameters/FabricSubscriberID' @@ -3050,7 +3610,14 @@ paths: get: operationId: Subscribers_get summary: Get Subscriber - description: Fetch an existing Subscriber + description: |- + Fetch an existing Subscriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SubscriberPathID' responses: @@ -3083,7 +3650,14 @@ paths: put: operationId: Subscribers_update summary: Update Subscriber - description: Update an existing Subsriber + description: |- + Update an existing Subsriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SubscriberPathID' responses: @@ -3128,7 +3702,14 @@ paths: delete: operationId: Subscribers_delete summary: Delete Subscriber - description: Delete an existing Subscriber + description: |- + Delete an existing Subscriber + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SubscriberPathID' responses: @@ -3158,7 +3739,14 @@ paths: get: operationId: SubscriberAddresses_list summary: List Subscriber Addresses - description: List Subscriber Addresses + description: |- + List Subscriber Addresses + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SubscriberAddressID' responses: @@ -3194,7 +3782,14 @@ paths: get: operationId: SwmlScripts_list summary: List SWML Scripts - description: A list of SWML Scripts + description: |- + A list of SWML Scripts + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -3228,7 +3823,14 @@ paths: post: operationId: SwmlScripts_create summary: Create SWML Script - description: Creates a SWML Script + description: |- + Creates a SWML Script + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -3273,7 +3875,14 @@ paths: get: operationId: SwmlScripts_read summary: Get SWML Script - description: Returns a SWML Script by ID + description: |- + Returns a SWML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SwmlScriptPathID' responses: @@ -3306,7 +3915,14 @@ paths: put: operationId: SwmlScripts_update summary: Update SWML Script - description: Updates a SWML Script by ID + description: |- + Updates a SWML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SwmlScriptPathID' responses: @@ -3351,7 +3967,14 @@ paths: delete: operationId: SwmlScripts_delete summary: Delete SWML Script - description: Deletes a SWML Script by ID + description: |- + Deletes a SWML Script by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SwmlScriptPathID' responses: @@ -3381,7 +4004,14 @@ paths: get: operationId: SWMLScriptAddresses_list summary: List SWML Script Addresses - description: This endpoints returns a list of addresses associated with a specific SWML script. + description: |- + This endpoints returns a list of addresses associated with a specific SWML script. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SWMLScriptAddressPathID' responses: @@ -3415,7 +4045,14 @@ paths: get: operationId: SWMLWebhooks_list summary: List SWML Webhooks - description: A list of SWML Webhooks + description: |- + A list of SWML Webhooks + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -3447,7 +4084,14 @@ paths: post: operationId: SWMLWebhooks_create summary: Create SWML Webhook - description: Creates an SWML Webhook + description: |- + Creates an SWML Webhook + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -3492,7 +4136,14 @@ paths: get: operationId: SWMLWebhooks_read summary: Get SWML Webhook - description: Returns an SWML Webhook by ID + description: |- + Returns an SWML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SWMLWebhookID' responses: @@ -3525,7 +4176,14 @@ paths: patch: operationId: SWMLWebhooks_update summary: Update SWML Webhook - description: Updates an SWML Webhook by ID + description: |- + Updates an SWML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SWMLWebhookID' responses: @@ -3570,7 +4228,14 @@ paths: delete: operationId: SWMLWebhooks_delete summary: Delete SWML Webhook - description: Deletes an SWML Webhook by ID + description: |- + Deletes an SWML Webhook by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SWMLWebhookID' responses: @@ -3600,7 +4265,14 @@ paths: get: operationId: SWMLWebhookAddresses_list summary: List SWML Webhook Addresses - description: This endpoint returns a list of addresses associated with a specific SWML webhook. + description: |- + This endpoint returns a list of addresses associated with a specific SWML webhook. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/SWMLWebhookIDPath' responses: @@ -3634,7 +4306,14 @@ paths: get: operationId: Resources_read summary: Get Resource - description: Returns a Resource by ID + description: |- + Returns a Resource by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ResourcePathID' responses: @@ -3667,7 +4346,14 @@ paths: delete: operationId: Resources_delete summary: Delete Resource - description: Deletes a Resource by ID + description: |- + Deletes a Resource by ID + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ResourcePathID' responses: @@ -3697,7 +4383,14 @@ paths: get: operationId: ResourceAddresses_list summary: List Resource Addresses - description: This endpoint is used to retrieve addresses associated with a specific Resource. + description: |- + This endpoint is used to retrieve addresses associated with a specific Resource. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/ResourceAddressPathID' responses: @@ -3736,6 +4429,13 @@ paths: :::important Currently only supports `calling` as a handler and automatically defaults to it. ::: + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/DomainApplicationPathID' responses: @@ -3781,7 +4481,15 @@ paths: post: operationId: PhoneRoutes_assign summary: Assign a Resource to a Phone Route - description: This endpoint assigns a specific resource to a phone route, allowing inbound calls & messages to be handled by the resource. + description: |- + This endpoint assigns a specific resource to a phone route, allowing inbound calls & messages to be handled by the resource. + + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/PhoneRoutePathID' responses: @@ -3827,7 +4535,14 @@ paths: post: operationId: InviteTokens_create summary: Create a Subscriber Invite Token - description: Creates a Subscriber Invite Token to be used for client-side API calls. The token is authorized using a subscriber's SAT (Subscriber Access Token) + description: |- + Creates a Subscriber Invite Token to be used for client-side API calls. The token is authorized using a subscriber's SAT (Subscriber Access Token) + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': @@ -3872,7 +4587,14 @@ paths: post: operationId: SubscriberTokens_create summary: Create Subscriber Token - description: Create a Subscriber Token + description: |- + Create a Subscriber Token + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -3917,7 +4639,14 @@ paths: post: operationId: RefreshTokens_create summary: Exchange a refresh token for a new subscriber access token - description: Exchanges a valid refresh token for a new subscriber access token and a new refresh token. The new access token is valid for 2 hours, and the new refresh token is valid for 2 hours and 5 minutes. + description: |- + Exchanges a valid refresh token for a new subscriber access token and a new refresh token. The new access token is valid for 2 hours, and the new refresh token is valid for 2 hours and 5 minutes. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '201': diff --git a/specs/signalwire-rest/fax-api/_spec_.yaml b/specs/signalwire-rest/fax-api/_spec_.yaml index dae2c8be3..2da8588ce 100644 --- a/specs/signalwire-rest/fax-api/_spec_.yaml +++ b/specs/signalwire-rest/fax-api/_spec_.yaml @@ -90,7 +90,7 @@ paths: List the available logs. #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. tags: - Logs parameters: @@ -239,7 +239,7 @@ paths: Find a log by ID. #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. tags: - Logs parameters: diff --git a/specs/signalwire-rest/fax-api/logs/main.tsp b/specs/signalwire-rest/fax-api/logs/main.tsp index 9c167120c..40a7c9b12 100644 --- a/specs/signalwire-rest/fax-api/logs/main.tsp +++ b/specs/signalwire-rest/fax-api/logs/main.tsp @@ -21,7 +21,9 @@ namespace FaxAPI.Logs { #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) list(...LogListRequest): | LogListResponse @@ -35,7 +37,9 @@ namespace FaxAPI.Logs { #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) read(...LogPathID): | LogResponse diff --git a/specs/signalwire-rest/fax-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/fax-api/tsp-output/@typespec/openapi3/openapi.yaml index 10d8196e0..b64ecc54b 100644 --- a/specs/signalwire-rest/fax-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/fax-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -30,7 +30,9 @@ paths: #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/LogListRequest.include_deleted' - $ref: '#/components/parameters/LogListRequest.created_before' @@ -73,7 +75,9 @@ paths: #### Permissions - The API token must include the following scopes: _Fax_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/LogPathID' responses: diff --git a/specs/signalwire-rest/logs-api/conferences/main.tsp b/specs/signalwire-rest/logs-api/conferences/main.tsp index c6fc8d4bb..824c9cc25 100644 --- a/specs/signalwire-rest/logs-api/conferences/main.tsp +++ b/specs/signalwire-rest/logs-api/conferences/main.tsp @@ -14,7 +14,15 @@ namespace LogsAPI.Conferences { @friendlyName("Conferences") interface Conferences { @summary("List Conferences") - @doc("A list of Conferences.") + @doc(""" + A list of Conferences. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + """) list(): ConferencesResponse | StatusCode401 | StatusCode404; } } diff --git a/specs/signalwire-rest/logs-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/logs-api/tsp-output/@typespec/openapi3/openapi.yaml index 4de5af3f3..f38d87753 100644 --- a/specs/signalwire-rest/logs-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/logs-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -10,7 +10,14 @@ paths: get: operationId: Conferences_list summary: List Conferences - description: A list of Conferences. + description: |- + A list of Conferences. + + #### Permissions + + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': diff --git a/specs/signalwire-rest/message-api/_spec_.yaml b/specs/signalwire-rest/message-api/_spec_.yaml index 86a9dd049..53ab42ba5 100644 --- a/specs/signalwire-rest/message-api/_spec_.yaml +++ b/specs/signalwire-rest/message-api/_spec_.yaml @@ -45,7 +45,7 @@ paths: List the available logs. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. tags: - Logs parameters: @@ -184,7 +184,7 @@ paths: Find a log by ID. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. tags: - Logs parameters: diff --git a/specs/signalwire-rest/message-api/logs/main.tsp b/specs/signalwire-rest/message-api/logs/main.tsp index b92051e6e..060104881 100644 --- a/specs/signalwire-rest/message-api/logs/main.tsp +++ b/specs/signalwire-rest/message-api/logs/main.tsp @@ -20,7 +20,9 @@ namespace MessageAPI.Logs { #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) list(...LogListRequest): | LogListResponse @@ -34,7 +36,9 @@ namespace MessageAPI.Logs { #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) retrieve(...LogPathID): | LogRetrieveResponse diff --git a/specs/signalwire-rest/message-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/message-api/tsp-output/@typespec/openapi3/openapi.yaml index ffa465a00..ed2b70857 100644 --- a/specs/signalwire-rest/message-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/message-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -30,7 +30,9 @@ paths: #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/LogListRequest.include_deleted' - $ref: '#/components/parameters/LogListRequest.created_before' @@ -73,7 +75,9 @@ paths: #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/LogPathID' responses: diff --git a/specs/signalwire-rest/project-api/_spec_.yaml b/specs/signalwire-rest/project-api/_spec_.yaml index 19ed4f9cd..892e56acb 100644 --- a/specs/signalwire-rest/project-api/_spec_.yaml +++ b/specs/signalwire-rest/project-api/_spec_.yaml @@ -35,6 +35,13 @@ paths: #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + + + #### Token Permissions You must set the functions allowed by this API Token by selecting which types of requests this API Token is allowed to make. @@ -149,6 +156,13 @@ paths: #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). + + + #### Token Permissions You can modify the functions allowed by this API Token by selecting which types of requests this API Token is allowed to make. @@ -252,6 +266,12 @@ paths: summary: Delete an API Token description: | Delete an API Token. This action cannot be undone. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Management_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Tokens parameters: diff --git a/specs/signalwire-rest/pubsub-api/_spec_.yaml b/specs/signalwire-rest/pubsub-api/_spec_.yaml index fdeb089cb..4ee2eba10 100644 --- a/specs/signalwire-rest/pubsub-api/_spec_.yaml +++ b/specs/signalwire-rest/pubsub-api/_spec_.yaml @@ -36,7 +36,7 @@ paths: #### Permissions - The API token must include the following scopes: _PubSub_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _PubSub_. tags: - Tokens requestBody: diff --git a/specs/signalwire-rest/pubsub-api/tokens/main.tsp b/specs/signalwire-rest/pubsub-api/tokens/main.tsp index cc671317f..4dde23e79 100644 --- a/specs/signalwire-rest/pubsub-api/tokens/main.tsp +++ b/specs/signalwire-rest/pubsub-api/tokens/main.tsp @@ -22,7 +22,9 @@ namespace PubSubAPI.Tokens { #### Permissions - The API token must include the following scopes: _PubSub_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _PubSub_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) @post @operationId("create_token") diff --git a/specs/signalwire-rest/pubsub-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/pubsub-api/tsp-output/@typespec/openapi3/openapi.yaml index e1e55cc3d..74cc8b906 100644 --- a/specs/signalwire-rest/pubsub-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/pubsub-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -31,7 +31,9 @@ paths: #### Permissions - The API token must include the following scopes: _PubSub_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _PubSub_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': diff --git a/specs/signalwire-rest/space-api/_spec_.yaml b/specs/signalwire-rest/space-api/_spec_.yaml index 29f063072..c8c62f231 100644 --- a/specs/signalwire-rest/space-api/_spec_.yaml +++ b/specs/signalwire-rest/space-api/_spec_.yaml @@ -598,7 +598,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Addresses responses: @@ -724,7 +726,9 @@ paths: To create a new Address, make a POST request to the Address resource. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Addresses requestBody: @@ -920,7 +924,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Addresses parameters: @@ -1045,7 +1051,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Addresses parameters: @@ -1077,7 +1085,9 @@ paths: future.** #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) requestBody: @@ -1262,7 +1272,9 @@ paths: filterable by sending in any of the following parameters. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -1410,7 +1422,9 @@ paths: the specific Brand. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -1532,7 +1546,9 @@ paths: parameters. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -1819,7 +1835,9 @@ paths: and is no longer required.* #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -2254,7 +2272,9 @@ paths: identify the specific Campaign. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -2488,7 +2508,9 @@ paths: Allows updating the friendly name associated with a campaign #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -2739,7 +2761,9 @@ paths: following parameters. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -2832,7 +2856,9 @@ paths: following parameters. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -2917,7 +2943,9 @@ paths: A list of `phone_numbers` in E164 format is required. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -2998,7 +3026,9 @@ paths: Returns a phone number assignment order. #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -3063,7 +3093,9 @@ paths: #### Permissions - The API token must include the following scopes: _Messaging_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Messaging_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Campaign Registry (Beta) parameters: @@ -3088,7 +3120,9 @@ paths: of the following parameters. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Domain Applications parameters: @@ -3400,7 +3434,9 @@ paths: domain application resource. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Domain Applications requestBody: @@ -3929,7 +3965,9 @@ paths: request to identify the specific domain application. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Domain Applications parameters: @@ -4201,7 +4239,9 @@ paths: parameters passed in. Any parameters not provided will be unchanged. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Domain Applications parameters: @@ -4730,7 +4770,9 @@ paths: deregister any connections. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Domain Applications parameters: @@ -4754,7 +4796,9 @@ paths: filterable by sending in any of the following parameters. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Number Groups parameters: @@ -4837,7 +4881,9 @@ paths: Group resource. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Number Groups requestBody: @@ -4920,7 +4966,9 @@ paths: request to identify the specific Number Group. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Number Groups parameters: @@ -4983,7 +5031,9 @@ paths: parameters passed in. Any parameters not provided will be unchanged. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Number Groups parameters: @@ -5063,7 +5113,9 @@ paths: the Number Group. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Number Groups parameters: @@ -5087,7 +5139,9 @@ paths: first. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Number Group Membership parameters: @@ -5167,7 +5221,9 @@ paths: the Number Group Membership resource. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Number Group Membership parameters: @@ -5249,7 +5305,9 @@ paths: previous request to identify the specific Number Group Membership. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Number Group Membership parameters: @@ -5314,7 +5372,9 @@ paths: the Phone Number from the Number Group. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Number Group Membership parameters: @@ -5339,7 +5399,9 @@ paths: [Sales](https://signalwire.com/company/contact?utm_campaign=devex_sent_em). #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Imported Phone Numbers requestBody: @@ -5604,7 +5666,9 @@ paths: parameters. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Phone Numbers parameters: @@ -5938,7 +6002,9 @@ paths: Purchase a number and add it to your project. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Phone Numbers requestBody: @@ -6248,7 +6314,9 @@ paths: created. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Phone Numbers parameters: @@ -6541,7 +6609,9 @@ paths: parameters passed in. Any parameters not provided will be unchanged. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Phone Numbers parameters: @@ -7065,7 +7135,9 @@ paths: #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Phone Numbers parameters: @@ -7088,7 +7160,9 @@ paths: given search criteria parameters. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Phone Numbers parameters: @@ -7237,7 +7311,9 @@ paths: information about the number such as carrier and caller ID data. #### Permissions - The API token must include the following scopes: _Numbers_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Numbers_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Phone Number Lookup parameters: @@ -7418,8 +7494,9 @@ paths: parameters. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - SIP Endpoints responses: @@ -7696,8 +7773,9 @@ paths: Endpoint resource. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - SIP Endpoints requestBody: @@ -8192,8 +8270,9 @@ paths: request to identify the specific SIP Endpoint. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - SIP Endpoints parameters: @@ -8450,8 +8529,9 @@ paths: parameters passed in. Any parameters not provided will be unchanged. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - SIP Endpoints parameters: @@ -8949,7 +9029,9 @@ paths: any connections. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - SIP Endpoints parameters: @@ -8973,7 +9055,9 @@ paths: identify the specific SIP Profile. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - SIP Profile responses: @@ -9051,7 +9135,9 @@ paths: parameters passed in. Any parameters not provided will be unchanged. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - SIP Profile requestBody: @@ -9192,8 +9278,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Multi-Factor Authentication requestBody: @@ -9298,8 +9386,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Multi-Factor Authentication requestBody: @@ -9410,8 +9500,10 @@ paths: #### Permissions - The API token must include one of the following scopes: _Voice_ or + The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Multi-Factor Authentication parameters: @@ -9462,7 +9554,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Verified Caller IDs requestBody: @@ -9599,7 +9693,9 @@ paths: following parameters. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Verified Caller IDs parameters: @@ -9729,7 +9825,9 @@ paths: Caller ID. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Verified Caller IDs parameters: @@ -9834,7 +9932,9 @@ paths: a Verified Caller ID endpoint. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Verified Caller IDs parameters: @@ -9950,7 +10050,9 @@ paths: to place calls from this phone number. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Verified Caller IDs parameters: @@ -9977,7 +10079,9 @@ paths: - There is a limit of 5 attempts to enter a validation code for a number. Once exhausted, you may request a redial of the verification call to reset the code and try again. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Verified Caller IDs parameters: @@ -10100,7 +10204,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Verified Caller IDs parameters: @@ -10196,6 +10302,14 @@ paths: get: operationId: Recordings_list summary: List Relay Recordings + description: | + Returns a list of recordings. The recordings are returned sorted by creation date, with the most recent appearing first. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: [] responses: '200': @@ -10226,6 +10340,14 @@ paths: get: operationId: Recordings_get summary: Get Relay Recording + description: | + Retrieves the details of a recording. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/RecordingPathID' responses: @@ -10256,6 +10378,14 @@ paths: delete: operationId: Recordings_delete summary: Delete Relay Recording + description: | + Deletes a recording. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/RecordingPathID' responses: @@ -10284,7 +10414,14 @@ paths: tags: - Queues summary: List Queues - description: Returns a paginated list of queues. + description: | + Returns a paginated list of queues. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). responses: '200': description: A list of queues @@ -10296,7 +10433,14 @@ paths: tags: - Queues summary: Create a Queue - description: Creates a new queue. + description: | + Creates a new queue. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). requestBody: required: true content: @@ -10325,7 +10469,14 @@ paths: tags: - Queues summary: Retrieve a Queue - description: Returns information about a specific queue. + description: | + Returns information about a specific queue. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/QueuePathID' responses: @@ -10349,7 +10500,14 @@ paths: tags: - Queues summary: Update a Queue - description: Updates the properties of a specific queue. + description: | + Updates the properties of a specific queue. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/QueuePathID' requestBody: @@ -10381,7 +10539,14 @@ paths: tags: - Queues summary: Delete a Queue - description: Deletes a specific queue. + description: | + Deletes a specific queue. + + #### Permissions + + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/QueuePathID' responses: @@ -10406,7 +10571,9 @@ paths: description: | Retrieves a list of all members currently in the queue. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queue Members parameters: @@ -10445,7 +10612,9 @@ paths: description: | Retrieves the details of a queue member. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queue Members parameters: @@ -10477,7 +10646,9 @@ paths: description: | Retrieves the details of next member on the queue. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queue Members parameters: @@ -10502,7 +10673,9 @@ paths: description: | Dequeues next member on the queue. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queue Members parameters: @@ -10527,7 +10700,9 @@ paths: description: | Dequeues member on the queue. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Queue Members parameters: diff --git a/specs/signalwire-rest/video-api/_spec_.yaml b/specs/signalwire-rest/video-api/_spec_.yaml index 33ff46191..737fece65 100644 --- a/specs/signalwire-rest/video-api/_spec_.yaml +++ b/specs/signalwire-rest/video-api/_spec_.yaml @@ -97,7 +97,9 @@ paths: Create a room. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Rooms requestBody: @@ -421,7 +423,9 @@ paths: List rooms. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Rooms parameters: @@ -691,7 +695,9 @@ paths: Find a room by its unique name. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Rooms parameters: @@ -937,7 +943,9 @@ paths: Find a room by ID. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Rooms parameters: @@ -1175,7 +1183,9 @@ paths: Update a room. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Rooms parameters: @@ -1499,7 +1509,9 @@ paths: Delete a room. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Rooms parameters: @@ -1519,7 +1531,9 @@ paths: summary: List Streams by Room Id description: | #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Streams parameters: @@ -1582,7 +1596,9 @@ paths: summary: Create a Stream for a Room description: | #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Streams parameters: @@ -1657,7 +1673,9 @@ paths: A list of past and in-progress Room Sessions. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - name: room_id in: query @@ -1820,7 +1838,9 @@ paths: Find a Room Session by ID. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - name: id in: path @@ -1945,7 +1965,9 @@ paths: A list of Room Recordings for a particular Room Session. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - name: id in: path @@ -2043,7 +2065,9 @@ paths: A list of Members for a particular Room Session. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - name: id in: path @@ -2112,7 +2136,9 @@ paths: Generate a Room Token allowing a client to join a Room. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Room Tokens requestBody: @@ -2304,7 +2330,9 @@ paths: A list of all Room Recordings. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - name: media_ttl in: query @@ -2395,7 +2423,9 @@ paths: A detailed summary of a particular Room Recording. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - name: id in: path @@ -2476,7 +2506,9 @@ paths: Delete a Room Recording. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Room Recordings parameters: @@ -2498,7 +2530,9 @@ paths: Create a Video Conference. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conferences requestBody: @@ -2874,7 +2908,9 @@ paths: List Video Conferences. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conferences parameters: @@ -3172,7 +3208,9 @@ paths: Find a Video Conference by ID. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conferences parameters: @@ -3442,7 +3480,9 @@ paths: Update a Video conference. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conferences parameters: @@ -3826,7 +3866,9 @@ paths: Delete a Video Conference. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conferences parameters: @@ -3846,7 +3888,9 @@ paths: summary: List Streams by Conference description: | #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Streams parameters: @@ -3908,7 +3952,9 @@ paths: summary: Create a Stream for a Conference description: | #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Streams parameters: @@ -3982,7 +4028,9 @@ paths: List conference tokens. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conference Tokens parameters: @@ -4043,7 +4091,9 @@ paths: Find a conference token by ID. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conference Tokens parameters: @@ -4088,7 +4138,9 @@ paths: Reset a conference token by ID. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Conference Tokens parameters: @@ -4133,7 +4185,9 @@ paths: List the available logs. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Logs parameters: @@ -4266,7 +4320,9 @@ paths: Find a log by ID. #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Logs parameters: @@ -4350,7 +4406,9 @@ paths: summary: Find a Stream by ID description: | #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Streams parameters: @@ -4407,7 +4465,9 @@ paths: summary: Delete a Stream description: | #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Streams parameters: @@ -4426,7 +4486,9 @@ paths: summary: Update a Stream description: | #### Permissions - The API token must include the following scopes: _Video_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Video_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). tags: - Streams parameters: diff --git a/specs/signalwire-rest/voice-api/_spec_.yaml b/specs/signalwire-rest/voice-api/_spec_.yaml index 30e5e646b..621c10779 100644 --- a/specs/signalwire-rest/voice-api/_spec_.yaml +++ b/specs/signalwire-rest/voice-api/_spec_.yaml @@ -47,7 +47,7 @@ paths: List the available logs. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. tags: - Logs parameters: @@ -191,7 +191,7 @@ paths: Find a log by ID. #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. tags: - Logs parameters: diff --git a/specs/signalwire-rest/voice-api/logs/main.tsp b/specs/signalwire-rest/voice-api/logs/main.tsp index df717a592..bd50d0396 100644 --- a/specs/signalwire-rest/voice-api/logs/main.tsp +++ b/specs/signalwire-rest/voice-api/logs/main.tsp @@ -20,7 +20,9 @@ namespace VoiceAPI.Logs { #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) list(...LogListRequest): | LogListResponse @@ -34,7 +36,9 @@ namespace VoiceAPI.Logs { #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). """) retrieve(...LogPathID): | LogRetrieveResponse diff --git a/specs/signalwire-rest/voice-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/voice-api/tsp-output/@typespec/openapi3/openapi.yaml index 35726f95e..840cf860d 100644 --- a/specs/signalwire-rest/voice-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/voice-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -30,7 +30,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/LogListRequest.include_deleted' - $ref: '#/components/parameters/LogListRequest.created_before' @@ -73,7 +75,9 @@ paths: #### Permissions - The API token must include the following scopes: _Voice_. + The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_. + + [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes). parameters: - $ref: '#/components/parameters/LogPathID' responses: diff --git a/specs/swml/Methods/ai/ai_params.tsp b/specs/swml/Methods/ai/ai_params.tsp index 45fc9e0ac..290bfe7f7 100644 --- a/specs/swml/Methods/ai/ai_params.tsp +++ b/specs/swml/Methods/ai/ai_params.tsp @@ -386,7 +386,7 @@ model AIParams { max_response_tokens?: integer | SWMLVar; @doc("The ASR (Automatic Speech Recognition) engine to use. Common values include `deepgram:nova-2`, `deepgram:nova-3`, and other supported ASR engines.") - @example("deepgram:nova-3") + @example("nova-3") openai_asr_engine?: "nova-2" | "nova-3"; @doc("Sets a time duration for the outbound call recipient to respond to the AI agent before timeout, in a range from `10000` to `600000`. **Default:** `120000` ms (2 minutes).") diff --git a/specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json b/specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json index 00df89b53..6091a4a8d 100644 --- a/specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json +++ b/specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json @@ -178,34 +178,34 @@ 3600 ], "minimum": 7, - "description": "Maximum time in seconds to wait for an answer. Cannot be less than `7` seconds. Defaults to 14400 seconds." + "description": "Maximum duration in seconds for the call. Cannot be less than 7 seconds. Defaults to 14400 seconds (4 hours)." }, "codecs": { "type": "string", "examples": [ "PCMU,PCMA,OPUS" ], - "description": "Comma-seperated string of codecs to offer.\n Valid codecs are: [`PCMU,PCMA,G722,G729,AMR-WB,OPUS,VP8,H264`]" + "description": "Comma-separated string of codecs to offer. Valid codecs are: PCMU, PCMA, G722, G729, AMR-WB, OPUS, VP8, H264." }, "sip_auth_username": { "type": "string", "examples": [ "user123" ], - "description": "SIP authentication username" + "description": "Username to use for SIP authentication." }, "sip_auth_password": { "type": "string", "examples": [ "securepassword" ], - "description": "SIP authentication password" + "description": "Password to use for SIP authentication." } }, "unevaluatedProperties": { "not": {} }, - "description": "Answers an incoming call.", + "description": "Answer incoming call and set an optional maximum duration.", "title": "answer" } }, @@ -222,7 +222,7 @@ "properties": { "ai": { "$ref": "#/$defs/AIObject", - "description": "Creates a new AI agent.", + "description": "Creates an AI agent that conducts voice conversations using automatic speech recognition (ASR),\nlarge language models (LLMs), and text-to-speech (TTS) synthesis.\nThe agent processes caller speech in real-time, generates contextually appropriate responses,\nand can execute custom functions to interact with external systems through SignalWire AI Gateway (SWAIG).", "title": "ai" } }, @@ -326,7 +326,7 @@ "properties": { "enter_queue": { "$ref": "#/$defs/EnterQueueObject", - "description": "Place the call in a queue.", + "description": "Place the current call in a named queue where it will wait to be connected to an available agent or resource.\nWhile waiting, callers will hear music or custom audio.\nWhen an agent connects to the queue (using the connect method), the caller and agent are bridged together.\nAfter the bridge completes, execution continues with the SWML script specified in transfer_after_bridge.", "title": "enter_queue" } }, @@ -396,7 +396,7 @@ "title": "cond" } ], - "description": "`switch` on `return_value` if result is an object (`{}`), or use as a cond if result is an array (`[]`)" + "description": "Action to take based on the result of the call. This will run once the peer leg of the call has ended.\nWill use the switch method when the return_value is an object, and will use the cond method when the return_value is an array." } }, "required": [ @@ -405,7 +405,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Execute a section or URL as a subroutine and return back to current document." + "description": "Execute a specified section or URL as a subroutine, and upon completion, return to the current document.\nUse the return statement to pass any return values or objects back to the current document." } }, "required": [ @@ -427,14 +427,14 @@ "examples": [ "greeting" ], - "description": "The name of the label in the current section to jump to." + "description": "Mark any point of the SWML section with a label so that goto can jump to it." }, "when": { "type": "string", "examples": [ "vars.retry_count < 3" ], - "description": "The condition that triggers the `goto` jump." + "description": "JavaScript expression to evaluate. When the condition evaluates to true, the goto jump is triggered." }, "max": { "anyOf": [ @@ -471,7 +471,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Jump to a specified label in the current SWML document." + "description": "Jump to a label within the current section, optionally based on a condition.\nThe goto method will only navigate to a label within the same section." } }, "required": [ @@ -490,7 +490,7 @@ "examples": [ "greeting" ], - "description": "The name of the label in the current section to jump to." + "description": "Mark any point of the SWML section with a label so that goto can jump to it." } }, "required": [ @@ -518,7 +518,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Starts live transcription of the call. The transcription will be sent to the specified URL.", + "description": "Start live transcription of the call. The transcription will be sent to the specified webhook URL.", "title": "live_transcribe" } }, @@ -547,7 +547,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Starts a live translation session of the call. The translation will be sent to the specified URL.", + "description": "Start live translation of the call. The translation will be sent to the specified webhook URL.", "title": "live_translate" } }, @@ -589,7 +589,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Hangup the call.", + "description": "End the call with an optional reason.", "title": "hangup" } }, @@ -612,7 +612,7 @@ "examples": [ "my-video-room" ], - "description": "The name of the room to join." + "description": "Name of the room to join. Allowed characters: A-Z, a-z, 0-9, underscore, and hyphen." } }, "required": [ @@ -621,7 +621,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Joins a RELAY room.", + "description": "Join a RELAY room. If the room doesn't exist, it creates a new room.", "title": "join_room" } }, @@ -638,7 +638,7 @@ "properties": { "join_conference": { "$ref": "#/$defs/JoinConferenceObject", - "description": "Join an ad-hoc audio conference with RELAY and CXML calls.", + "description": "Join an ad-hoc audio conference started on either the SignalWire or Compatibility API.\nThis method allows you to connect the current call to a named conference where multiple participants can communicate simultaneously.", "title": "join_conference" } }, @@ -842,7 +842,7 @@ "billing" ] ], - "description": "Words or phrases to help the speech recognition." + "description": "Expected words or phrases to help the speech recognition." }, "speech_engine": { "type": "array", @@ -871,7 +871,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Play a prompt and wait for digit or speech input.\nSpeech detection is not enabled unless at least one speech parameter is set.\nIf only speech parameters are set (and no digit parameters), digit detection is not enabled.\nTo enable both digit and speech detection, set at least one parameter for each.", + "description": "Play a prompt and wait for input. The input can be received either as digits from the keypad,\nor from speech, or both depending on what parameters are set.\nBy default, only digit input is enabled. To enable speech input, set at least one speech parameter.\nTo enable both digit and speech input, set at least one parameter for each.", "title": "prompt" } }, @@ -998,7 +998,7 @@ "examples": [ 44 ], - "description": "Input sensitivity for the recording.\nDefault is `44.0`." + "description": "How sensitive the recording voice activity detector is to background noise.\nA larger value is more sensitive. Allowed values from 0.0 to 100.0.\nDefault is 44.0." }, "initial_timeout": { "anyOf": [ @@ -1053,7 +1053,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Record the call audio in the foreground. Use this, for example, to record voicemails.", + "description": "Record the call audio in the foreground, pausing further SWML execution until recording ends.\nUse this, for example, to record voicemails.\nTo record calls in the background in a non-blocking fashion, use the record_call method.", "title": "record" } }, @@ -1161,7 +1161,7 @@ "examples": [ 44 ], - "description": "Input sensitivity for the recording.\nDefault is `44.0`." + "description": "How sensitive the recording voice activity detector is to background noise.\nA larger value is more sensitive. Allowed values from 0.0 to 100.0.\nDefault is 44.0." }, "initial_timeout": { "anyOf": [ @@ -1217,7 +1217,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Record call in the background.\nUnlike the `record` method, the `record_call` method will start the recording and continue executing the SWML script without allowing the recording to happen in the background.\nTo stop call recordings started with `record_call`, use the `stop_call_record` method.", + "description": "Record call in the background.\nUnlike the record method, the record_call method will start the recording and continue executing\nthe SWML script while allowing the recording to happen in the background.\nTo stop call recordings started with record_call, use the stop_record_call method.", "title": "record_call" } }, @@ -1240,7 +1240,7 @@ "examples": [ "https://api.example.com/webhook" ], - "description": "The URL to which the request is to be sent." + "description": "URL to send the HTTPS request to. Authentication can also be set in the URL in the format of username:password@url." }, "method": { "anyOf": [ @@ -1276,7 +1276,7 @@ "Authorization": "Bearer token123" } ], - "description": "An object representing the headers to be included in the request." + "description": "Object containing HTTP headers to set. Valid header values are Accept, Authorization, Content-Type, Range, and custom X- headers." }, "body": { "anyOf": [ @@ -1295,7 +1295,7 @@ "message": "Call completed" } ], - "description": "The body of the request. Can be a `string` or an `object`." + "description": "Request body. Content-Type header should be explicitly set, but if not set, the most likely type\nwill be set based on the first non-whitespace character." }, "timeout": { "anyOf": [ @@ -1383,7 +1383,7 @@ "result": "completed" } ], - "description": "Return from `execute` or exit script. Takes user-defined key to be used to store the value.", + "description": "Return a value from an execute call or exit the script. The value can be any type.", "title": "return" } }, @@ -1406,7 +1406,7 @@ "examples": [ "1234#" ], - "description": "The DTMF digits to send." + "description": "The digits to send. Valid values are 0123456789*#ABCDWw. Character W is a 1 second delay, and w is a 500ms delay." } }, "required": [ @@ -1415,7 +1415,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Send DTMF digits.", + "description": "Send digit presses as DTMF tones.", "title": "send_digits" } }, @@ -1494,7 +1494,7 @@ "$ref": "#/$defs/SMSWithMedia" } ], - "description": "Send a text message to a PSTN phone number.", + "description": "Send an outbound SMS or MMS message to a PSTN phone number.", "title": "send_sms" } }, @@ -1520,7 +1520,7 @@ "is_valid": true } ], - "description": "Set script variables to the specified values.\nNo specific parameters.\nAccepts an object mapping variable names to values.", + "description": "Set script variables to the specified values.\nAccepts an object mapping variable names to values.\nVariables set using set can be removed using unset.", "title": "set" } }, @@ -1548,7 +1548,7 @@ 5000 ], "minimum": -1, - "description": "The amount of time to sleep in milliseconds. Must be a `positive integer`. Can also be set to a `-1` integer for the sleep to never end.", + "description": "The amount of time to sleep in milliseconds before continuing to the next action.\nMust be a positive integer. Can also be set to `-1` for the sleep to never end.", "title": "sleep" } }, @@ -1586,14 +1586,14 @@ "examples": [ "sipuser" ], - "description": "SIP authentication username" + "description": "Username to use for SIP authentication." }, "sip_auth_password": { "type": "string", "examples": [ "sippassword" ], - "description": "SIP authentication password" + "description": "Password to use for SIP authentication." } }, "required": [ @@ -1626,7 +1626,7 @@ "examples": [ {} ], - "description": "Stops the current denoise session.", + "description": "Stop noise reduction that was started with denoise.", "title": "stop_denoise" } }, @@ -1707,7 +1707,7 @@ "examples": [ "prompt_result" ], - "description": "Name of the variable whose value needs to be compared" + "description": "Name of the variable whose value needs to be compared." }, "case": { "type": "object", @@ -1718,14 +1718,14 @@ "$ref": "#/$defs/SWMLMethod" } }, - "description": "Object of values mapped to array of instructions to execute" + "description": "Object of key-mapped values to array of SWML methods to execute." }, "default": { "type": "array", "items": { "$ref": "#/$defs/SWMLMethod" }, - "description": "Array of instructions to execute if no cases match" + "description": "Array of SWML methods to execute if no cases match." } }, "required": [ @@ -1735,7 +1735,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Execute a sequence of instructions depending on which value matches a variable.", + "description": "Execute different instructions based on a variable's value.", "title": "switch" } }, @@ -1758,7 +1758,7 @@ "examples": [ "wss://example.com/tap-stream" ], - "description": "Destination of the tap media stream." + "description": "Destination of the tap media stream: rtp://IP:port, ws://example.com, or wss://example.com." }, "control_id": { "type": "string", @@ -1855,7 +1855,7 @@ "examples": [ "https://example.com/transfer-handler" ], - "description": "Specifies where to transfer the call. The value can be one of:\n- `` - section in the SWML document to jump to\n- A URL (http or https) that returns a SWML document - Sends HTTP POST\n- An inline SWML document (as a JSON string)" + "description": "Specifies where to transfer to. The value can be one of:\n- - section in the SWML document to jump to\n- A URL (http or https) - URL to fetch next document from. Sends HTTP POST.\n Authentication can also be set in the URL in the format of username:password@url.\n- An inline SWML document (as a JSON string)" }, "params": { "type": "object", @@ -1888,7 +1888,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Transfer the execution of the script to a new URL or SWML Section.", + "description": "Transfer the execution of the script to a different SWML section, URL, or Relay application.\nOnce the transfer is complete, the script will continue executing SWML from the new location.", "title": "transfer" } }, @@ -1933,7 +1933,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Un set a variable that as been `set`.", + "description": "Unset specified variables. The variables may have been set using the set method\nor as a byproduct of other statements or methods.", "title": "unset" } }, @@ -1993,7 +1993,7 @@ "examples": [ "en-US" ], - "description": "The language of the payment prompt. Default is `en-US`.\n\nSupported languages can be found here: https://developer.signalwire.com/swml/methods/pay/language" + "description": "Language to use for prompts being played to the caller by the `pay` method. Default is `en-US`." }, "max_attempts": { "anyOf": [ @@ -2139,7 +2139,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "The `pay` object. Enables secure payment processing during a call.\n When implemented, it handles the complete payment flow including data collection, validation, and processing through your configured\n payment gateway." + "description": "Enables secure payment processing during voice calls. When implemented, it manages the entire payment flow\nincluding data collection, validation, and processing through your configured payment gateway." } }, "required": [ @@ -2234,7 +2234,7 @@ 1.25 ], "minimum": 0, - "description": "How much voice in ms to decide MACHINE. Default 1.25." + "description": "The number of seconds of ongoing voice activity required to classify as MACHINE. Default 1.25." }, "machine_words_threshold": { "anyOf": [ @@ -2249,7 +2249,7 @@ 6 ], "minimum": 0, - "description": "How many words to count to decide MACHINE. Default 6." + "description": "The minimum number of words that must be detected in a single utterance before classifying the call as MACHINE. Default 6." }, "status_url": { "type": "string", @@ -2301,13 +2301,13 @@ "examples": [ true ], - "description": "If `false`, the detector will run asynchronously and `status_url` must be set. Default `true`." + "description": "If false, the detector will run asynchronously and status_url must be set.\nIf true, the detector will wait for detection to complete before moving to the next SWML instruction.\nDefault is true." } }, "unevaluatedProperties": { "not": {} }, - "description": "A detection method that is a combination of AMD (Answer Machine Detection) and Fax detection.\nDetect if the user on the other end of the call is a machine (fax, voicemail, etc.) or a `human`.\nThe detection result(s) will be sent to the declared `status_url` as a POST request." + "description": "A detection method that combines AMD (Answering Machine Detection) and fax detection.\nDetect whether the user on the other end of the call is a machine (fax, voicemail, etc.) or a human.\nThe detection result(s) will be sent to the specified status_url as a POST request\nand will also be saved in the detect_result variable." } }, "required": [ @@ -2372,7 +2372,7 @@ "support_hours": "9am-5pm EST" } ], - "description": "A powerful and flexible environmental variable which can accept arbitrary data that is set initially in the SWML script\nor from the SWML `set_global_data` action. This data can be referenced `globally`.\nAll contained information can be accessed and expanded within the prompt - for example, by using a template string." + "description": "A key-value object for storing data that persists throughout the AI session.\nCan be set initially in the SWML script or modified during the conversation using the set_global_data action.\nThe global_data object is accessible everywhere in the AI session: prompts, AI parameters,\nand SWML returned from SWAIG functions. Access properties using template strings (e.g. ${global_data.property_name})." }, "hints": { "type": "array", @@ -2426,7 +2426,7 @@ }, "prompt": { "$ref": "#/$defs/AIPrompt", - "description": "Establishes the initial set of instructions and settings to configure the agent." + "description": "Defines the AI agent's personality, goals, behaviors, and instructions for handling conversations.\nThe prompt establishes how the agent should interact with callers, what information it should gather,\nand how it should respond to various scenarios. It is recommended to write prompts using markdown formatting." } }, "required": [ @@ -2574,7 +2574,7 @@ "title": "cond" } ], - "description": "`switch` on `return_value` when object `{}` or `cond` when array `[]`" + "description": "Action to take based on the result of the call. This will run once the peer leg of the call has ended.\nWill use the switch method when the return_value is an object, and will use the cond method when the return_value is an array." }, "timeout": { "anyOf": [ @@ -2654,14 +2654,14 @@ "examples": [ "sipuser" ], - "description": "Username for authentication." + "description": "SIP username to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers." }, "password": { "type": "string", "examples": [ "sippassword" ], - "description": "Password for authentication." + "description": "SIP password to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers." }, "encryption": { "anyOf": [ @@ -2810,7 +2810,7 @@ "title": "cond" } ], - "description": "`switch` on `return_value` when object `{}` or `cond` when array `[]`" + "description": "Action to take based on the result of the call. This will run once the peer leg of the call has ended.\nWill use the switch method when the return_value is an object, and will use the cond method when the return_value is an array." }, "timeout": { "anyOf": [ @@ -2890,14 +2890,14 @@ "examples": [ "sipuser" ], - "description": "Username for authentication." + "description": "SIP username to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers." }, "password": { "type": "string", "examples": [ "sippassword" ], - "description": "Password for authentication." + "description": "SIP password to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers." }, "encryption": { "anyOf": [ @@ -3045,7 +3045,7 @@ "title": "cond" } ], - "description": "`switch` on `return_value` when object `{}` or `cond` when array `[]`" + "description": "Action to take based on the result of the call. This will run once the peer leg of the call has ended.\nWill use the switch method when the return_value is an object, and will use the cond method when the return_value is an array." }, "timeout": { "anyOf": [ @@ -3125,14 +3125,14 @@ "examples": [ "sipuser" ], - "description": "Username for authentication." + "description": "SIP username to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers." }, "password": { "type": "string", "examples": [ "sippassword" ], - "description": "Password for authentication." + "description": "SIP password to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers." }, "encryption": { "anyOf": [ @@ -3281,7 +3281,7 @@ "title": "cond" } ], - "description": "`switch` on `return_value` when object `{}` or `cond` when array `[]`" + "description": "Action to take based on the result of the call. This will run once the peer leg of the call has ended.\nWill use the switch method when the return_value is an object, and will use the cond method when the return_value is an array." }, "timeout": { "anyOf": [ @@ -3361,14 +3361,14 @@ "examples": [ "sipuser" ], - "description": "Username for authentication." + "description": "SIP username to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers." }, "password": { "type": "string", "examples": [ "sippassword" ], - "description": "Password for authentication." + "description": "SIP password to use for authentication when dialing a SIP URI. Has no effect on calls to phone numbers." }, "encryption": { "anyOf": [ @@ -3449,7 +3449,7 @@ "examples": [ "support-queue" ], - "description": "Name of the queue to enter." + "description": "Name of the queue to enter. If a queue with this name does not exist, it will be automatically created." }, "transfer_after_bridge": { "anyOf": [ @@ -3860,7 +3860,7 @@ "examples": [ "prompt_result" ], - "description": "Name of the variable whose value needs to be compared" + "description": "Name of the variable whose value needs to be compared." }, "case": { "type": "object", @@ -3871,14 +3871,14 @@ "$ref": "#/$defs/SWMLMethod" } }, - "description": "Object of values mapped to array of instructions to execute" + "description": "Object of key-mapped values to array of SWML methods to execute." }, "default": { "type": "array", "items": { "$ref": "#/$defs/SWMLMethod" }, - "description": "Array of instructions to execute if no cases match" + "description": "Array of SWML methods to execute if no cases match." } }, "required": [ @@ -3888,7 +3888,7 @@ "unevaluatedProperties": { "not": {} }, - "description": "Execute a sequence of instructions depending on which value matches a variable.", + "description": "Execute different instructions based on a variable's value.", "title": "switch" }, { @@ -4104,21 +4104,21 @@ "examples": [ "+15559876543" ], - "description": "The phone number to send the SMS to." + "description": "Phone number to send SMS message to in E.164 format." }, "from_number": { "type": "string", "examples": [ "+15551234567" ], - "description": "The phone number to send the SMS from.\nDefault is the calling party's caller ID number." + "description": "Phone number the SMS message will be sent from.\nDefault is the calling party's caller ID number." }, "region": { "type": "string", "examples": [ "us" ], - "description": "The region to use for the SMS." + "description": "Region of the world to originate the message from. Chosen based on account preferences or device location if not specified." }, "tags": { "type": "array", @@ -4159,21 +4159,21 @@ "examples": [ "+15559876543" ], - "description": "The phone number to send the SMS to." + "description": "Phone number to send SMS message to in E.164 format." }, "from_number": { "type": "string", "examples": [ "+15551234567" ], - "description": "The phone number to send the SMS from.\nDefault is the calling party's caller ID number." + "description": "Phone number the SMS message will be sent from.\nDefault is the calling party's caller ID number." }, "region": { "type": "string", "examples": [ "us" ], - "description": "The region to use for the SMS." + "description": "Region of the world to originate the message from. Chosen based on account preferences or device location if not specified." }, "tags": { "type": "array", @@ -5023,7 +5023,7 @@ "examples": [ "Analyze the conversation and provide insights to help the agent respond better." ], - "description": "The system prompt that guides the inner dialog AI's behavior. Only used when `enable_inner_dialog` is `true`." + "description": "The system prompt that guides the inner dialog AI's behavior. This prompt shapes how the background AI\nanalyzes the conversation and what kind of insights it provides to the main agent.\nOnly used when `enable_inner_dialog` is `true`." }, "inner_dialog_synced": { "anyOf": [ @@ -5038,7 +5038,7 @@ "examples": [ true ], - "description": "When enabled, synchronizes the inner dialog with the main conversation flow, waiting for user input before injection. Only used when `enable_inner_dialog` is `true`." + "description": "When enabled, synchronizes the inner dialog with the main conversation flow.\nThis ensures the inner dialog AI waits for the main conversation turn to complete\nbefore providing its analysis, rather than running fully asynchronously.\nOnly used when `enable_inner_dialog` is `true`." }, "initial_sleep_ms": { "anyOf": [ @@ -5165,7 +5165,7 @@ "examples": [ "nova-3" ], - "description": "The OpenAI ASR (Automatic Speech Recognition) engine to use. Allowed values are `nova-2` and `nova-3`. Defaults to `nova-3`." + "description": "The ASR (Automatic Speech Recognition) engine to use. Common values include `deepgram:nova-2`, `deepgram:nova-3`, and other supported ASR engines." }, "outbound_attention_timeout": { "anyOf": [ @@ -5290,7 +5290,7 @@ "examples": [ true ], - "description": "When enabled, the AI agent remains silent until directly addressed by name (using `ai_name`).\nThe user must say the agent's name to activate it for each interaction.\nCannot be used together with `enable_pause`." + "description": "When enabled, the AI agent remains silent until directly addressed by name (using `ai_name`).\nThis creates a \"push-to-talk\" style interaction where the agent only responds when explicitly\ncalled upon, useful for scenarios where the agent should listen but not interrupt.\nCannot be used together with `enable_pause`." }, "start_paused": { "anyOf": [ @@ -5305,7 +5305,7 @@ "examples": [ true ], - "description": "When enabled, the AI agent starts in a paused state and will not respond until the user\nspeaks the agent's name (set via `ai_name`). Automatically enables `enable_pause`." + "description": "When enabled, the AI agent starts in a paused state and will not respond until the user\nspeaks the agent's name (set via `ai_name`). Automatically enables `enable_pause`.\nThis is useful for scenarios where you want the agent to wait for explicit activation." }, "static_greeting": { "type": "string", @@ -5814,7 +5814,7 @@ "items": { "$ref": "#/$defs/SWAIGIncludes" }, - "description": "An array of objects to include remote function signatures.\nThe object fields are url to specify where the remote functions are defined and functions which is an array of the function names as strings." + "description": "An array of objects to include remote function signatures.\nThis allows you to include functions that are defined in a remote location.\nThe object fields are `url` to specify where the remote functions are defined and `functions` which is an array of the function names as strings." } }, "unevaluatedProperties": { @@ -5829,21 +5829,21 @@ "examples": [ "vars.digit == '1'" ], - "description": "The condition to be evaluated and act on." + "description": "The JavaScript condition to act on." }, "then": { "type": "array", "items": { "$ref": "#/$defs/SWMLMethod" }, - "description": "The list of SWML instructions to be executed if the condition is `true`" + "description": "Sequence of SWML methods to execute when the condition evaluates to true." }, "else": { "type": "array", "items": { "$ref": "#/$defs/SWMLMethod" }, - "description": "The list of SWML instructions to be executed if the condition is `false`." + "description": "Sequence of SWML methods to execute when none of the other conditions evaluate to true." } }, "required": [ @@ -5863,7 +5863,7 @@ "items": { "$ref": "#/$defs/SWMLMethod" }, - "description": "The list of SWML instructions to be executed if the condition is `false`." + "description": "Sequence of SWML methods to execute when none of the other conditions evaluate to true." } }, "required": [ @@ -6391,21 +6391,21 @@ "examples": [ "French" ], - "description": "Any arbirary name for the language object." + "description": "Name of the language (e.g., 'French', 'English'). This value is used in the system prompt to instruct the LLM what language is being spoken." }, "code": { "type": "string", "examples": [ "fr-FR" ], - "description": "The language code for the ai to hear. For example, 'fr-FR'." + "description": "The language code for ASR (Automatic Speech Recognition) purposes. By default, SignalWire uses Deepgram's\nNova-3 STT engine, so this value should match a code from Deepgram's Nova-3 language codes.\nIf a different STT model was selected using the `openai_asr_engine` parameter, you must select a code supported by that engine." }, "voice": { "type": "string", "examples": [ - "fr-FR-Neural2-B" + "gcloud.fr-FR-Neural2-B" ], - "description": "Voice to use for the language. For example, 'fr-FR-Neural2-B'." + "description": "Voice to use for the language. String format: `.`.\nSelect engine from `gcloud`, `polly`, `elevenlabs`, `cartesia`, or `deepgram`.\nFor example, `gcloud.fr-FR-Neural2-B`." }, "_model": { "type": "string", @@ -6471,21 +6471,21 @@ "examples": [ "French" ], - "description": "Any arbirary name for the language object." + "description": "Name of the language (e.g., 'French', 'English'). This value is used in the system prompt to instruct the LLM what language is being spoken." }, "code": { "type": "string", "examples": [ "fr-FR" ], - "description": "The language code for the ai to hear. For example, 'fr-FR'." + "description": "The language code for ASR (Automatic Speech Recognition) purposes. By default, SignalWire uses Deepgram's\nNova-3 STT engine, so this value should match a code from Deepgram's Nova-3 language codes.\nIf a different STT model was selected using the `openai_asr_engine` parameter, you must select a code supported by that engine." }, "voice": { "type": "string", "examples": [ - "fr-FR-Neural2-B" + "gcloud.fr-FR-Neural2-B" ], - "description": "Voice to use for the language. For example, 'fr-FR-Neural2-B'." + "description": "Voice to use for the language. String format: `.`.\nSelect engine from `gcloud`, `polly`, `elevenlabs`, `cartesia`, or `deepgram`.\nFor example, `gcloud.fr-FR-Neural2-B`." }, "_model": { "type": "string", @@ -6542,7 +6542,7 @@ "hmm" ] ], - "description": "An array of strings to be used as fillers in the conversation. This helps the AI break silence between responses." + "description": "An array of strings to be used as fillers in the conversation. This helps the AI break silence between responses.\nNote: `speech_fillers` are used between every 'turn' taken by the LLM, including at the beginning of the call.\nFor more targeted fillers, consider using `function_fillers`." } }, "required": [ @@ -7860,7 +7860,7 @@ "examples": [ "get_weather" ], - "description": "The unique name for the function." + "description": "A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation." } }, "required": [ @@ -7934,7 +7934,7 @@ "function": { "type": "string", "const": "startup_hook", - "description": "The unique name for the function. For the start_hook function, the function name is 'start_hook'." + "description": "A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation. For the start_hook function, the function name is 'start_hook'." } }, "required": [ @@ -8008,7 +8008,7 @@ "function": { "type": "string", "const": "hangup_hook", - "description": "The unique name for the function. For the stop_hook function, the function name is 'stop_hook'." + "description": "A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation. For the stop_hook function, the function name is 'stop_hook'." } }, "required": [ @@ -8082,7 +8082,7 @@ "function": { "type": "string", "const": "summarize_conversation", - "description": "The unique name for the function.. For the summarize_conversation function, the function name is 'summarize_conversation'." + "description": "A unique name for the function. This can be any user-defined string or can reference a reserved function. Reserved functions are SignalWire functions that will be executed at certain points in the conversation.. For the summarize_conversation function, the function name is 'summarize_conversation'." } }, "required": [ @@ -8310,7 +8310,7 @@ "items": { "$ref": "#/$defs/Expression" }, - "description": "An array of objects that define patterns and corresponding actions." + "description": "An array of objects that have pattern matching logic to process the user's input data. A user can define multiple expressions to match against the user's input data." }, "webhooks": { "type": "array", @@ -8333,7 +8333,7 @@ "items": { "$ref": "#/$defs/ContextSteps" }, - "description": "An array of objects that define the steps in the context. These steps are used to define the flow of the conversation.", + "description": "An array of step objects that define the conversation flow for this context. Steps execute sequentially unless otherwise specified.", "title": "steps" }, "isolated": { @@ -8341,21 +8341,21 @@ "examples": [ true ], - "description": "A boolean value, if set to `true`, the conversation history will be reset and the agent will only have the context of the original system prompt." + "description": "When `true`, resets conversation history to only the system prompt when entering this context. Useful for focused tasks that shouldn't be influenced by previous conversation." }, "enter_fillers": { "type": "array", "items": { "$ref": "#/$defs/FunctionFillers" }, - "description": "An array of objects that define the enter fillers for the context. Enter fillers are used when entering the context." + "description": "Language-specific filler phrases played when transitioning into this context. Helps provide smooth context switches." }, "exit_fillers": { "type": "array", "items": { "$ref": "#/$defs/FunctionFillers" }, - "description": "An array of objects that define the exit fillers for the context. Exit fillers are used when exiting the context." + "description": "Language-specific filler phrases played when leaving this context. Ensures natural transitions out of specialized modes." }, "pom": { "type": "array", @@ -8382,7 +8382,7 @@ "items": { "$ref": "#/$defs/ContextSteps" }, - "description": "An array of objects that define the steps in the context. These steps are used to define the flow of the conversation.", + "description": "An array of step objects that define the conversation flow for this context. Steps execute sequentially unless otherwise specified.", "title": "steps" }, "isolated": { @@ -8390,21 +8390,21 @@ "examples": [ true ], - "description": "A boolean value, if set to `true`, the conversation history will be reset and the agent will only have the context of the original system prompt." + "description": "When `true`, resets conversation history to only the system prompt when entering this context. Useful for focused tasks that shouldn't be influenced by previous conversation." }, "enter_fillers": { "type": "array", "items": { "$ref": "#/$defs/FunctionFillers" }, - "description": "An array of objects that define the enter fillers for the context. Enter fillers are used when entering the context." + "description": "Language-specific filler phrases played when transitioning into this context. Helps provide smooth context switches." }, "exit_fillers": { "type": "array", "items": { "$ref": "#/$defs/FunctionFillers" }, - "description": "An array of objects that define the exit fillers for the context. Exit fillers are used when exiting the context." + "description": "Language-specific filler phrases played when leaving this context. Ensures natural transitions out of specialized modes." }, "text": { "type": "string", @@ -10593,7 +10593,7 @@ "examples": [ "Customer wants to order Pizza" ], - "description": "The conditions that must be met for the conversation to proceed to the next step.\nIf a condition is not met, the conversation will not proceed to the next step.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior." + "description": "The criteria that must be met for the AI to proceed to the next step.\nThe criteria is an instruction given to the AI.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior." }, "functions": { "type": "array", @@ -10620,7 +10620,7 @@ "Confirm Order" ] ], - "description": "An array of valid contexts that the conversation can transition to from this step." + "description": "An array of context names that the AI can transition to from this step. This must be a valid `contexts.name` that is present in your `contexts` object." }, "skip_user_turn": { "anyOf": [ @@ -10641,7 +10641,7 @@ "examples": [ true ], - "description": "A boolean value, if set to `true`, will end the contexts conversation and transition to a normal interaction." + "description": "A boolean value that determines if the step is the last in the context. If `true`, the context ends after this step. Cannot be used along with the `valid_steps` parameter." }, "valid_steps": { "type": "array", @@ -10689,7 +10689,7 @@ "examples": [ "Customer wants to order Pizza" ], - "description": "The conditions that must be met for the conversation to proceed to the next step.\nIf a condition is not met, the conversation will not proceed to the next step.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior." + "description": "The criteria that must be met for the AI to proceed to the next step.\nThe criteria is an instruction given to the AI.\nIt's **highly** recommended you create a custom criteria for the step to get the intended behavior." }, "functions": { "type": "array", @@ -10716,7 +10716,7 @@ "Confirm Order" ] ], - "description": "An array of valid contexts that the conversation can transition to from this step." + "description": "An array of context names that the AI can transition to from this step. This must be a valid `contexts.name` that is present in your `contexts` object." }, "skip_user_turn": { "anyOf": [ @@ -10737,7 +10737,7 @@ "examples": [ true ], - "description": "A boolean value, if set to `true`, will end the contexts conversation and transition to a normal interaction." + "description": "A boolean value that determines if the step is the last in the context. If `true`, the context ends after this step. Cannot be used along with the `valid_steps` parameter." }, "valid_steps": { "type": "array",