diff --git a/bandwidth.yml b/bandwidth.yml index e0b5f0dc..5362a7c5 100644 --- a/bandwidth.yml +++ b/bandwidth.yml @@ -377,7 +377,7 @@ paths: $ref: '#/components/requestBodies/updateCallRequest' responses: '200': - description: Call was successfully modified. + $ref: '#/components/responses/updateCallResponse' '400': $ref: '#/components/responses/voiceBadRequestError' '401': @@ -777,7 +777,7 @@ paths: $ref: '#/components/requestBodies/updateCallRecordingRequest' responses: '200': - description: Recording state was successfully modified. + $ref: '#/components/responses/updateRecordingResponse' '400': $ref: '#/components/responses/voiceBadRequestError' '401': @@ -1324,7 +1324,7 @@ paths: '403': $ref: '#/components/responses/tnLookupForbiddenError' '404': - description: Not Found + $ref: '#/components/responses/tnLookupNotFoundError' '429': $ref: '#/components/responses/tnLookupTooManyRequestsError' '500': @@ -2919,6 +2919,7 @@ components: $ref: '#/components/schemas/conferenceId' memberUrl: type: string + format: uri description: >- A URL that may be used to retrieve information about or update @@ -4276,6 +4277,7 @@ components: example: my-recording-name callUrl: type: string + format: uri description: The URL of the call associated with the event. example: >- https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85 @@ -4735,7 +4737,7 @@ components: schema: $ref: '#/components/schemas/messagingRequestError' createCallResponse: - description: Call Successfully Created + description: Created headers: Location: description: The URL for further interactions with this call @@ -4749,13 +4751,15 @@ components: createCall Response: $ref: '#/components/examples/createCallResponseExample' getCallStateResponse: - description: Call found + description: OK content: application/json: schema: $ref: '#/components/schemas/callState' + updateCallResponse: + description: OK listCallsResponse: - description: Calls retrieved successfully + description: OK content: application/json: schema: @@ -4763,13 +4767,15 @@ components: items: $ref: '#/components/schemas/callState' getStatisticsResponse: - description: Statistics Found + description: OK content: application/json: schema: $ref: '#/components/schemas/accountStatistics' + updateRecordingResponse: + description: OK listCallRecordingsResponse: - description: Recordings retrieved successfully + description: OK content: application/json: schema: @@ -4777,13 +4783,13 @@ components: items: $ref: '#/components/schemas/callRecordingMetadata' getCallRecordingResponse: - description: Recording found + description: OK content: application/json: schema: $ref: '#/components/schemas/callRecordingMetadata' downloadRecordingMediaResponse: - description: Media found + description: OK content: audio/vnd.wave: schema: @@ -4794,27 +4800,27 @@ components: type: string format: binary getRecordingTranscriptionResponse: - description: Transcription found. + description: OK content: application/json: schema: $ref: '#/components/schemas/recordingTranscriptions' listTranscriptionsResponse: - description: Transcription found. + description: OK content: application/json: schema: $ref: '#/components/schemas/callTranscriptionMetadataList' getCallTranscriptionResponse: - description: Transcription found. + description: OK content: application/json: schema: $ref: '#/components/schemas/callTranscriptionResponse' deleteCallTranscriptionResponse: - description: Transcription data was deleted. + description: No Content listConferencesResponse: - description: Conferences retrieved successfully + description: OK content: application/json: schema: @@ -4825,19 +4831,19 @@ components: listConferences Response: $ref: '#/components/examples/listConferencesResponseExample' getConferenceResponse: - description: Conferences retrieved successfully + description: OK content: application/json: schema: $ref: '#/components/schemas/conference' getConferenceMemberResponse: - description: Conference member found + description: OK content: application/json: schema: $ref: '#/components/schemas/conferenceMember' listConferenceRecordingsResponse: - description: Conference recordings retrieved successfully + description: OK content: application/json: schema: @@ -4845,7 +4851,7 @@ components: items: $ref: '#/components/schemas/conferenceRecordingMetadata' getConferenceRecordingResponse: - description: Conference recording found + description: OK content: application/json: schema: @@ -5068,6 +5074,8 @@ components: summary: Example Unsupported Media Type Error value: message: Content-Type must be application/json. + tnLookupNotFoundError: + description: Not Found tnLookupTooManyRequestsError: description: Too Many Requests content: diff --git a/docs/CallsApi.md b/docs/CallsApi.md index c4e23a13..5e4896bc 100644 --- a/docs/CallsApi.md +++ b/docs/CallsApi.md @@ -89,7 +89,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**201** | Call Successfully Created | * Location - The URL for further interactions with this call
| +**201** | Created | * Location - The URL for further interactions with this call
| **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -178,7 +178,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Call found | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -279,7 +279,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Calls retrieved successfully | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -368,7 +368,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Call was successfully modified. | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | diff --git a/docs/ConferencesApi.md b/docs/ConferencesApi.md index d840fa15..37a49db9 100644 --- a/docs/ConferencesApi.md +++ b/docs/ConferencesApi.md @@ -93,7 +93,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Media found | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -182,7 +182,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Conferences retrieved successfully | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -273,7 +273,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Conference member found | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -364,7 +364,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Conference recording found | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -453,7 +453,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Conference recordings retrieved successfully | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -550,7 +550,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Conferences retrieved successfully | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | diff --git a/docs/RecordingsApi.md b/docs/RecordingsApi.md index 82589940..6e367123 100644 --- a/docs/RecordingsApi.md +++ b/docs/RecordingsApi.md @@ -358,7 +358,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Media found | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -449,7 +449,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Recording found | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -540,7 +540,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Transcription found. | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -635,7 +635,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Recordings retrieved successfully | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -724,7 +724,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Recordings retrieved successfully | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -904,7 +904,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Recording state was successfully modified. | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | diff --git a/docs/StatisticsApi.md b/docs/StatisticsApi.md index 7eb594bd..3df9571f 100644 --- a/docs/StatisticsApi.md +++ b/docs/StatisticsApi.md @@ -82,7 +82,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Statistics Found | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | diff --git a/docs/TranscriptionsApi.md b/docs/TranscriptionsApi.md index 695660b6..3fa1f2ce 100644 --- a/docs/TranscriptionsApi.md +++ b/docs/TranscriptionsApi.md @@ -85,7 +85,7 @@ void (empty response body) | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Transcription data was deleted. | - | +**200** | No Content | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -176,7 +176,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Transcription found. | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - | @@ -265,7 +265,7 @@ Name | Type | Description | Notes | Status code | Description | Response headers | |-------------|-------------|------------------| -**200** | Transcription found. | - | +**200** | OK | - | **400** | Bad Request | - | **401** | Unauthorized | - | **403** | Forbidden | - |