Skip to content

Commit 48e4704

Browse files
band-swi-release-engineering[bot]DX-Bandwidthckoegel
authored
SWI-8614 Update SDK Based on Recent Spec Changes (#263)
* Generate SDK with OpenAPI Generator Version * update test --------- Co-authored-by: DX-Bandwidth <[email protected]> Co-authored-by: ckoegel <[email protected]>
1 parent 55cb21f commit 48e4704

13 files changed

+48
-49
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,9 @@ Class | Method | HTTP request | Description
143143
*TollFreeVerificationApi* | [**request_toll_free_verification**](docs/TollFreeVerificationApi.md#request_toll_free_verification) | **POST** /accounts/{accountId}/tollFreeVerification | Request Toll-Free Verification
144144
*TollFreeVerificationApi* | [**update_toll_free_verification_request**](docs/TollFreeVerificationApi.md#update_toll_free_verification_request) | **PUT** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Update Toll-Free Verification Request
145145
*TollFreeVerificationApi* | [**update_webhook_subscription**](docs/TollFreeVerificationApi.md#update_webhook_subscription) | **PUT** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Update Webhook Subscription
146-
*TranscriptionsApi* | [**delete_real_time_transcription**](docs/TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete a specific transcription
147-
*TranscriptionsApi* | [**get_real_time_transcription**](docs/TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Retrieve a specific transcription
148-
*TranscriptionsApi* | [**list_real_time_transcriptions**](docs/TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | Enumerate transcriptions made with StartTranscription
146+
*TranscriptionsApi* | [**delete_real_time_transcription**](docs/TranscriptionsApi.md#delete_real_time_transcription) | **DELETE** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Delete Real-time Transcription
147+
*TranscriptionsApi* | [**get_real_time_transcription**](docs/TranscriptionsApi.md#get_real_time_transcription) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions/{transcriptionId} | Get Real-time Transcription
148+
*TranscriptionsApi* | [**list_real_time_transcriptions**](docs/TranscriptionsApi.md#list_real_time_transcriptions) | **GET** /accounts/{accountId}/calls/{callId}/transcriptions | List Real-time Transcriptions
149149

150150

151151
## Documentation For Models

bandwidth.yml

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1157,9 +1157,9 @@ paths:
11571157
get:
11581158
tags:
11591159
- Transcriptions
1160-
summary: Enumerate transcriptions made with StartTranscription
1160+
summary: List Real-time Transcriptions
11611161
description: >-
1162-
Enumerates the transcriptions created on this call via
1162+
List the transcriptions created on this call via
11631163
[startTranscription](/docs/voice/bxml/startTranscription).
11641164
operationId: listRealTimeTranscriptions
11651165
parameters:
@@ -1189,7 +1189,7 @@ paths:
11891189
get:
11901190
tags:
11911191
- Transcriptions
1192-
summary: Retrieve a specific transcription
1192+
summary: Get Real-time Transcription
11931193
description: >-
11941194
Retrieve the specified transcription that was created on this call via
11951195
[startTranscription](/docs/voice/bxml/startTranscription).
@@ -1220,7 +1220,7 @@ paths:
12201220
delete:
12211221
tags:
12221222
- Transcriptions
1223-
summary: Delete a specific transcription
1223+
summary: Delete Real-time Transcription
12241224
description: >-
12251225
Delete the specified transcription that was created on this call via
12261226
[startTranscription](/docs/voice/bxml/startTranscription).
@@ -1929,7 +1929,7 @@ components:
19291929
required:
19301930
- type
19311931
- description
1932-
messageId:
1932+
id:
19331933
type: string
19341934
description: The ID of the message.
19351935
example: 1589228074636lm4k2je7j7jklbn2
@@ -2549,8 +2549,8 @@ components:
25492549
description: The data returned in a multichannel message response.
25502550
type: object
25512551
properties:
2552-
messageId:
2553-
$ref: '#/components/schemas/messageId'
2552+
id:
2553+
$ref: '#/components/schemas/id'
25542554
time:
25552555
description: The time the message was received by the Bandwidth API.
25562556
type: string
@@ -2586,7 +2586,7 @@ components:
25862586
expiration:
25872587
$ref: '#/components/schemas/expiration'
25882588
required:
2589-
- messageId
2589+
- id
25902590
- time
25912591
- direction
25922592
- to
@@ -3738,11 +3738,12 @@ components:
37383738
the state of this conference member. This is the URL of this
37393739
member's
37403740
3741-
[Get Conference Member](/apis/voice/#operation/getConferenceMember)
3741+
[Get Conference
3742+
Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember)
37423743
endpoint
37433744
37443745
and [Modify Conference
3745-
Member](/apis/voice/#operation/updateConferenceMember)
3746+
Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember)
37463747
37473748
endpoint.
37483749
example: >-
@@ -4094,7 +4095,7 @@ components:
40944095
points to the
40954096
40964097
[Get Call
4097-
Transcription](/apis/voice/#operation/getCallTranscription)
4098+
Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription)
40984099
endpoint.
40994100
example: >-
41004101
https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-fef240ff-5cfc9091-8069-4863-a8c0-a4dcbbf1f1a4/transcriptions/t-3f758f24-c7a2fc78-7c91-401a-8b2e-e542f9c40d6b

bandwidth/api/messages_api.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
from bandwidth.models.message_type_enum import MessageTypeEnum
2828
from bandwidth.models.messages_list import MessagesList
2929
from bandwidth.models.product_type_enum import ProductTypeEnum
30-
from bandwidth.models.product_type_enum import ProductTypeEnum
3130

3231
from bandwidth.api_client import ApiClient, RequestSerialized
3332
from bandwidth.api_response import ApiResponse

bandwidth/api/transcriptions_api.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def delete_real_time_transcription(
6060
_headers: Optional[Dict[StrictStr, Any]] = None,
6161
_host_index: Annotated[StrictInt, Field(ge=0, le=1)] = 0,
6262
) -> None:
63-
"""Delete a specific transcription
63+
"""Delete Real-time Transcription
6464
6565
Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
6666
@@ -143,7 +143,7 @@ def delete_real_time_transcription_with_http_info(
143143
_headers: Optional[Dict[StrictStr, Any]] = None,
144144
_host_index: Annotated[StrictInt, Field(ge=0, le=1)] = 0,
145145
) -> ApiResponse[None]:
146-
"""Delete a specific transcription
146+
"""Delete Real-time Transcription
147147
148148
Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
149149
@@ -226,7 +226,7 @@ def delete_real_time_transcription_without_preload_content(
226226
_headers: Optional[Dict[StrictStr, Any]] = None,
227227
_host_index: Annotated[StrictInt, Field(ge=0, le=1)] = 0,
228228
) -> RESTResponseType:
229-
"""Delete a specific transcription
229+
"""Delete Real-time Transcription
230230
231231
Delete the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription). Note: After the deletion is requested and a `200` is returned, the transcription will not be accessible anymore. However, it is not deleted immediately. This deletion process, while transparent and irreversible, can take an additional 24 to 48 hours.
232232
@@ -378,7 +378,7 @@ def get_real_time_transcription(
378378
_headers: Optional[Dict[StrictStr, Any]] = None,
379379
_host_index: Annotated[StrictInt, Field(ge=0, le=1)] = 0,
380380
) -> CallTranscriptionResponse:
381-
"""Retrieve a specific transcription
381+
"""Get Real-time Transcription
382382
383383
Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
384384
@@ -461,7 +461,7 @@ def get_real_time_transcription_with_http_info(
461461
_headers: Optional[Dict[StrictStr, Any]] = None,
462462
_host_index: Annotated[StrictInt, Field(ge=0, le=1)] = 0,
463463
) -> ApiResponse[CallTranscriptionResponse]:
464-
"""Retrieve a specific transcription
464+
"""Get Real-time Transcription
465465
466466
Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
467467
@@ -544,7 +544,7 @@ def get_real_time_transcription_without_preload_content(
544544
_headers: Optional[Dict[StrictStr, Any]] = None,
545545
_host_index: Annotated[StrictInt, Field(ge=0, le=1)] = 0,
546546
) -> RESTResponseType:
547-
"""Retrieve a specific transcription
547+
"""Get Real-time Transcription
548548
549549
Retrieve the specified transcription that was created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
550550
@@ -695,9 +695,9 @@ def list_real_time_transcriptions(
695695
_headers: Optional[Dict[StrictStr, Any]] = None,
696696
_host_index: Annotated[StrictInt, Field(ge=0, le=1)] = 0,
697697
) -> List[CallTranscriptionMetadata]:
698-
"""Enumerate transcriptions made with StartTranscription
698+
"""List Real-time Transcriptions
699699
700-
Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
700+
List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
701701
702702
:param account_id: Your Bandwidth Account ID. (required)
703703
:type account_id: str
@@ -774,9 +774,9 @@ def list_real_time_transcriptions_with_http_info(
774774
_headers: Optional[Dict[StrictStr, Any]] = None,
775775
_host_index: Annotated[StrictInt, Field(ge=0, le=1)] = 0,
776776
) -> ApiResponse[List[CallTranscriptionMetadata]]:
777-
"""Enumerate transcriptions made with StartTranscription
777+
"""List Real-time Transcriptions
778778
779-
Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
779+
List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
780780
781781
:param account_id: Your Bandwidth Account ID. (required)
782782
:type account_id: str
@@ -853,9 +853,9 @@ def list_real_time_transcriptions_without_preload_content(
853853
_headers: Optional[Dict[StrictStr, Any]] = None,
854854
_host_index: Annotated[StrictInt, Field(ge=0, le=1)] = 0,
855855
) -> RESTResponseType:
856-
"""Enumerate transcriptions made with StartTranscription
856+
"""List Real-time Transcriptions
857857
858-
Enumerates the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
858+
List the transcriptions created on this call via [startTranscription](/docs/voice/bxml/startTranscription).
859859
860860
:param account_id: Your Bandwidth Account ID. (required)
861861
:type account_id: str

bandwidth/models/call_transcription_metadata.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class CallTranscriptionMetadata(BaseModel):
2929
""" # noqa: E501
3030
transcription_id: Optional[StrictStr] = Field(default=None, description="The programmable voice API transcription ID.", alias="transcriptionId")
3131
transcription_name: Optional[StrictStr] = Field(default=None, description="The programmable voice API transcription name. This name could be provided by the user when creating the transcription.", alias="transcriptionName")
32-
transcription_url: Optional[StrictStr] = Field(default=None, description="A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint.", alias="transcriptionUrl")
32+
transcription_url: Optional[StrictStr] = Field(default=None, description="A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint.", alias="transcriptionUrl")
3333
additional_properties: Dict[str, Any] = {}
3434
__properties: ClassVar[List[str]] = ["transcriptionId", "transcriptionName", "transcriptionUrl"]
3535

bandwidth/models/conference_member.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class ConferenceMember(BaseModel):
2929
""" # noqa: E501
3030
call_id: Optional[StrictStr] = Field(default=None, description="The call id associated with the event.", alias="callId")
3131
conference_id: Optional[StrictStr] = Field(default=None, description="The unique, Bandwidth-generated ID of the conference that was recorded", alias="conferenceId")
32-
member_url: Optional[StrictStr] = Field(default=None, description="A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint.", alias="memberUrl")
32+
member_url: Optional[StrictStr] = Field(default=None, description="A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint.", alias="memberUrl")
3333
mute: Optional[StrictBool] = Field(default=None, description="Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member's mute status. Has no effect if omitted.")
3434
hold: Optional[StrictBool] = Field(default=None, description="Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member's hold status. Has no effect if omitted.")
3535
call_ids_to_coach: Optional[List[StrictStr]] = Field(default=None, description="If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join.", alias="callIdsToCoach")

bandwidth/models/multi_channel_message_response_data.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class MultiChannelMessageResponseData(BaseModel):
3232
"""
3333
The data returned in a multichannel message response.
3434
""" # noqa: E501
35-
message_id: StrictStr = Field(description="The ID of the message.", alias="messageId")
35+
id: StrictStr = Field(description="The ID of the message.")
3636
time: datetime = Field(description="The time the message was received by the Bandwidth API.")
3737
direction: MessageDirectionEnum
3838
to: List[StrictStr] = Field(description="The destination phone number(s) of the message, in E164 format.")
@@ -41,7 +41,7 @@ class MultiChannelMessageResponseData(BaseModel):
4141
priority: Optional[PriorityEnum] = None
4242
expiration: Optional[datetime] = Field(default=None, description="A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future.")
4343
additional_properties: Dict[str, Any] = {}
44-
__properties: ClassVar[List[str]] = ["messageId", "time", "direction", "to", "channelList", "tag", "priority", "expiration"]
44+
__properties: ClassVar[List[str]] = ["id", "time", "direction", "to", "channelList", "tag", "priority", "expiration"]
4545

4646
model_config = ConfigDict(
4747
populate_by_name=True,
@@ -108,7 +108,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
108108
return cls.model_validate(obj)
109109

110110
_obj = cls.model_validate({
111-
"messageId": obj.get("messageId"),
111+
"id": obj.get("id"),
112112
"time": obj.get("time"),
113113
"direction": obj.get("direction"),
114114
"to": obj.get("to"),

docs/CallTranscriptionMetadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**transcription_id** | **str** | The programmable voice API transcription ID. | [optional]
99
**transcription_name** | **str** | The programmable voice API transcription name. This name could be provided by the user when creating the transcription. | [optional]
10-
**transcription_url** | **str** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice/#operation/getCallTranscription) endpoint. | [optional]
10+
**transcription_url** | **str** | A URL that may be used to retrieve the transcription itself. This points to the [Get Call Transcription](/apis/voice-apis/voice/#tag/Transcriptions/operation/getRealTimeTranscription) endpoint. | [optional]
1111

1212
## Example
1313

docs/ConferenceMember.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
88
**call_id** | **str** | The call id associated with the event. | [optional]
99
**conference_id** | **str** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional]
10-
**member_url** | **str** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member&#39;s [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional]
10+
**member_url** | **str** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member&#39;s [Get Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice-apis/voice/#tag/Conferences/operation/updateConferenceMember) endpoint. | [optional]
1111
**mute** | **bool** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member&#39;s mute status. Has no effect if omitted. | [optional]
1212
**hold** | **bool** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member&#39;s hold status. Has no effect if omitted. | [optional]
1313
**call_ids_to_coach** | **List[str]** | If this member had a value set for &#x60;callIdsToCoach&#x60; in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional]

docs/MessagesApi.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ from bandwidth.models.message_status_enum import MessageStatusEnum
117117
from bandwidth.models.message_type_enum import MessageTypeEnum
118118
from bandwidth.models.messages_list import MessagesList
119119
from bandwidth.models.product_type_enum import ProductTypeEnum
120-
from bandwidth.models.product_type_enum import ProductTypeEnum
121120
from bandwidth.rest import ApiException
122121
from pprint import pprint
123122

0 commit comments

Comments
 (0)