Skip to content

Commit 9d95389

Browse files
DX-BandwidthDX-Bandwidth
committed
Generate SDK with OpenAPI Generator Version
1 parent 009e0d3 commit 9d95389

11 files changed

+56
-25
lines changed

‎bandwidth.yml‎

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,13 @@ paths:
163163
/users/{accountId}/messages:
164164
get:
165165
summary: List Messages
166-
description: Returns a list of messages based on query parameters.
166+
description: >
167+
Returns a list of messages based on query parameters.
168+
169+
170+
**Rate Limit:** This endpoint is rate limited to 3500 requests per 5
171+
minutes per Source IP address. Exceeding the limit returns HTTP 429 with
172+
a `Retry-After` header.
167173
operationId: listMessages
168174
tags:
169175
- Messages
@@ -207,10 +213,12 @@ paths:
207213
$ref: '#/components/responses/messagingForbiddenError'
208214
'404':
209215
$ref: '#/components/responses/messagingNotFoundError'
216+
'405':
217+
$ref: '#/components/responses/messagingMethodNotAllowedError'
210218
'415':
211219
$ref: '#/components/responses/messagingInvalidMediaTypeError'
212220
'429':
213-
$ref: '#/components/responses/messagingTooManyRequestsError'
221+
$ref: '#/components/responses/listMessagesTooManyRequestsError'
214222
'500':
215223
$ref: '#/components/responses/messagingInternalServerError'
216224
post:
@@ -2257,7 +2265,9 @@ components:
22572265
type: object
22582266
properties:
22592267
media:
2260-
$ref: '#/components/schemas/rbmMessageContentFile'
2268+
type: array
2269+
items:
2270+
$ref: '#/components/schemas/rbmMessageContentFile'
22612271
suggestions:
22622272
$ref: '#/components/schemas/multiChannelFullActions'
22632273
required:
@@ -5875,15 +5885,13 @@ components:
58755885
type: object
58765886
internalTicketNumber:
58775887
type: string
5878-
format: uuid
58795888
description: >-
58805889
Unique identifier (UUID) generated by Bandwidth to assist in tracking
58815890
the verification status of a toll-free number - included in all webhook
58825891
payloads.
58835892
example: acde070d-8c4c-4f0d-9d8a-162843c10333
58845893
internalTicketNumberForWebhook:
58855894
type: string
5886-
format: uuid
58875895
description: >-
58885896
Unique identifier (UUID) generated by Bandwidth to assist in tracking
58895897
the verification status of a toll-free number.
@@ -6752,6 +6760,23 @@ components:
67526760
- type: internal-server-error
67536761
description: Internal server error. No further information available
67546762
source: {}
6763+
listMessagesTooManyRequestsError:
6764+
description: Too Many Requests
6765+
headers:
6766+
Retry-After:
6767+
description: The number of seconds to wait before retrying the request.
6768+
schema:
6769+
type: integer
6770+
example: 300
6771+
content:
6772+
application/json:
6773+
schema:
6774+
$ref: '#/components/schemas/messagingRequestError'
6775+
example:
6776+
type: rate_limit_exceeded
6777+
description: >-
6778+
Rate limit exceeded. Wait for Retry-After time before sending
6779+
another request.
67556780
createCallResponse:
67566781
description: Created
67576782
headers:

‎bandwidth/api/messages_api.py‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ def list_messages(
412412
) -> MessagesList:
413413
"""List Messages
414414
415-
Returns a list of messages based on query parameters.
415+
Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
416416
417417
:param account_id: Your Bandwidth Account ID. (required)
418418
:type account_id: str
@@ -533,6 +533,7 @@ def list_messages(
533533
'401': "MessagingRequestError",
534534
'403': "MessagingRequestError",
535535
'404': "MessagingRequestError",
536+
'405': "MessagingRequestError",
536537
'415': "MessagingRequestError",
537538
'429': "MessagingRequestError",
538539
'500': "MessagingRequestError",
@@ -594,7 +595,7 @@ def list_messages_with_http_info(
594595
) -> ApiResponse[MessagesList]:
595596
"""List Messages
596597
597-
Returns a list of messages based on query parameters.
598+
Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
598599
599600
:param account_id: Your Bandwidth Account ID. (required)
600601
:type account_id: str
@@ -715,6 +716,7 @@ def list_messages_with_http_info(
715716
'401': "MessagingRequestError",
716717
'403': "MessagingRequestError",
717718
'404': "MessagingRequestError",
719+
'405': "MessagingRequestError",
718720
'415': "MessagingRequestError",
719721
'429': "MessagingRequestError",
720722
'500': "MessagingRequestError",
@@ -776,7 +778,7 @@ def list_messages_without_preload_content(
776778
) -> RESTResponseType:
777779
"""List Messages
778780
779-
Returns a list of messages based on query parameters.
781+
Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
780782
781783
:param account_id: Your Bandwidth Account ID. (required)
782784
:type account_id: str
@@ -897,6 +899,7 @@ def list_messages_without_preload_content(
897899
'401': "MessagingRequestError",
898900
'403': "MessagingRequestError",
899901
'404': "MessagingRequestError",
902+
'405': "MessagingRequestError",
900903
'415': "MessagingRequestError",
901904
'429': "MessagingRequestError",
902905
'500': "MessagingRequestError",

‎bandwidth/models/blocked_webhook.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
2222
from typing import Any, ClassVar, Dict, List, Optional
2323
from typing_extensions import Annotated
24-
from uuid import UUID
2524
from bandwidth.models.tfv_callback_status_enum import TfvCallbackStatusEnum
2625
from typing import Optional, Set
2726
from typing_extensions import Self
@@ -33,7 +32,7 @@ class BlockedWebhook(BaseModel):
3332
account_id: Optional[StrictStr] = Field(default=None, description="User's account ID.", alias="accountId")
3433
phone_number: Optional[Annotated[str, Field(min_length=12, strict=True, max_length=12)]] = Field(default=None, description="Toll-free telephone number in E.164 format.", alias="phoneNumber")
3534
status: Optional[TfvCallbackStatusEnum] = None
36-
internal_ticket_number: Optional[UUID] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.", alias="internalTicketNumber")
35+
internal_ticket_number: Optional[StrictStr] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.", alias="internalTicketNumber")
3736
blocked: Optional[StrictBool] = Field(default=None, description="Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.")
3837
blocked_reason: Optional[StrictStr] = Field(default=None, description="The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked.", alias="blockedReason")
3938
additional_properties: Dict[str, Any] = {}

‎bandwidth/models/failure_webhook.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
2222
from typing import Any, ClassVar, Dict, List, Optional
2323
from typing_extensions import Annotated
24-
from uuid import UUID
2524
from typing import Optional, Set
2625
from typing_extensions import Self
2726

@@ -34,7 +33,7 @@ class FailureWebhook(BaseModel):
3433
error_code: Optional[StrictStr] = Field(default=None, description="An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered.", alias="errorCode")
3534
error_message: Optional[StrictStr] = Field(default=None, description="A description of the error that was encountered.", alias="errorMessage")
3635
errors: Optional[List[StrictStr]] = Field(default=None, description="Details of the errors that were encountered when processing the request.")
37-
internal_ticket_number: Optional[UUID] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.", alias="internalTicketNumber")
36+
internal_ticket_number: Optional[StrictStr] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.", alias="internalTicketNumber")
3837
additional_properties: Dict[str, Any] = {}
3938
__properties: ClassVar[List[str]] = ["accountId", "phoneNumber", "errorCode", "errorMessage", "errors", "internalTicketNumber"]
4039

‎bandwidth/models/rbm_message_media.py‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class RbmMessageMedia(BaseModel):
3030
"""
3131
RbmMessageMedia
3232
""" # noqa: E501
33-
media: RbmMessageContentFile
33+
media: List[RbmMessageContentFile]
3434
suggestions: Optional[Annotated[List[MultiChannelAction], Field(max_length=11)]] = Field(default=None, description="An array of suggested actions for the recipient.")
3535
additional_properties: Dict[str, Any] = {}
3636
__properties: ClassVar[List[str]] = ["media", "suggestions"]
@@ -76,9 +76,13 @@ def to_dict(self) -> Dict[str, Any]:
7676
exclude=excluded_fields,
7777
exclude_none=True,
7878
)
79-
# override the default output from pydantic by calling `to_dict()` of media
79+
# override the default output from pydantic by calling `to_dict()` of each item in media (list)
80+
_items = []
8081
if self.media:
81-
_dict['media'] = self.media.to_dict()
82+
for _item_media in self.media:
83+
if _item_media:
84+
_items.append(_item_media.to_dict())
85+
_dict['media'] = _items
8286
# override the default output from pydantic by calling `to_dict()` of each item in suggestions (list)
8387
_items = []
8488
if self.suggestions:
@@ -103,7 +107,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
103107
return cls.model_validate(obj)
104108

105109
_obj = cls.model_validate({
106-
"media": RbmMessageContentFile.from_dict(obj["media"]) if obj.get("media") is not None else None,
110+
"media": [RbmMessageContentFile.from_dict(_item) for _item in obj["media"]] if obj.get("media") is not None else None,
107111
"suggestions": [MultiChannelAction.from_dict(_item) for _item in obj["suggestions"]] if obj.get("suggestions") is not None else None
108112
})
109113
# store additional fields in additional_properties

‎bandwidth/models/tfv_status.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
2323
from typing import Any, ClassVar, Dict, List, Optional
2424
from typing_extensions import Annotated
25-
from uuid import UUID
2625
from bandwidth.models.tfv_status_enum import TfvStatusEnum
2726
from bandwidth.models.tfv_submission_info import TfvSubmissionInfo
2827
from typing import Optional, Set
@@ -34,7 +33,7 @@ class TfvStatus(BaseModel):
3433
""" # noqa: E501
3534
phone_number: Optional[Annotated[str, Field(min_length=12, strict=True, max_length=12)]] = Field(default=None, description="Toll-free telephone number in E.164 format.", alias="phoneNumber")
3635
status: Optional[TfvStatusEnum] = None
37-
internal_ticket_number: Optional[UUID] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads.", alias="internalTicketNumber")
36+
internal_ticket_number: Optional[StrictStr] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads.", alias="internalTicketNumber")
3837
decline_reason_description: Optional[StrictStr] = Field(default=None, description="Explanation for why a verification request was declined.", alias="declineReasonDescription")
3938
resubmit_allowed: Optional[StrictBool] = Field(default=None, description="Whether a Toll-Free Verification request qualifies for resubmission via PUT.", alias="resubmitAllowed")
4039
created_date_time: Optional[datetime] = Field(default=None, description="Date and time the verification request was created.", alias="createdDateTime")

‎bandwidth/models/verification_denial_webhook.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
2222
from typing import Any, ClassVar, Dict, List, Optional
2323
from typing_extensions import Annotated
24-
from uuid import UUID
2524
from bandwidth.models.additional_denial_reason import AdditionalDenialReason
2625
from typing import Optional, Set
2726
from typing_extensions import Self
@@ -34,7 +33,7 @@ class VerificationDenialWebhook(BaseModel):
3433
additional_denial_reasons: Optional[List[AdditionalDenialReason]] = Field(default=None, description="An optional list of denial reasons in addition to declineReasonDescription when multiple reasons apply.", alias="additionalDenialReasons")
3534
decline_reason_description: Optional[StrictStr] = Field(default=None, description="Explanation for why a verification request was declined.", alias="declineReasonDescription")
3635
denial_status_code: Optional[StrictInt] = Field(default=None, description="Reason code for denial.", alias="denialStatusCode")
37-
internal_ticket_number: Optional[UUID] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.", alias="internalTicketNumber")
36+
internal_ticket_number: Optional[StrictStr] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.", alias="internalTicketNumber")
3837
phone_number: Optional[Annotated[str, Field(min_length=12, strict=True, max_length=12)]] = Field(default=None, description="Toll-free telephone number in E.164 format.", alias="phoneNumber")
3938
resubmit_allowed: Optional[StrictBool] = Field(default=None, description="Whether a Toll-Free Verification request qualifies for resubmission via PUT.", alias="resubmitAllowed")
4039
status: Optional[StrictStr] = 'UNVERIFIED'

‎bandwidth/models/verification_webhook.py‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
2222
from typing import Any, ClassVar, Dict, List, Optional
2323
from typing_extensions import Annotated
24-
from uuid import UUID
2524
from bandwidth.models.tfv_callback_status_enum import TfvCallbackStatusEnum
2625
from typing import Optional, Set
2726
from typing_extensions import Self
@@ -33,7 +32,7 @@ class VerificationWebhook(BaseModel):
3332
account_id: Optional[StrictStr] = Field(default=None, description="User's account ID.", alias="accountId")
3433
phone_number: Optional[Annotated[str, Field(min_length=12, strict=True, max_length=12)]] = Field(default=None, description="Toll-free telephone number in E.164 format.", alias="phoneNumber")
3534
status: Optional[TfvCallbackStatusEnum] = None
36-
internal_ticket_number: Optional[UUID] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.", alias="internalTicketNumber")
35+
internal_ticket_number: Optional[StrictStr] = Field(default=None, description="Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.", alias="internalTicketNumber")
3736
additional_properties: Dict[str, Any] = {}
3837
__properties: ClassVar[List[str]] = ["accountId", "phoneNumber", "status", "internalTicketNumber"]
3938

‎docs/MessagesApi.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,9 @@ List Messages
113113

114114
Returns a list of messages based on query parameters.
115115

116+
**Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
117+
118+
116119
### Example
117120

118121
* Basic Authentication (Basic):
@@ -251,8 +254,9 @@ Name | Type | Description | Notes
251254
**401** | Unauthorized | - |
252255
**403** | Forbidden | - |
253256
**404** | Not Found | - |
257+
**405** | Method Not Allowed | - |
254258
**415** | Unsupported Media Type | - |
255-
**429** | Too Many Requests | - |
259+
**429** | Too Many Requests | * Retry-After - The number of seconds to wait before retrying the request. <br> |
256260
**500** | Internal Server Error | - |
257261

258262
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

‎docs/MultiChannelChannelListRBMObjectAllOfContent.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
99
**text** | **str** | The text associated with the message. Must be 3270 characters or less |
1010
**suggestions** | [**List[MultiChannelAction]**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional]
11-
**media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | |
11+
**media** | [**List[RbmMessageContentFile]**](RbmMessageContentFile.md) | |
1212
**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | |
1313
**thumbnail_image_alignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | |
1414
**card_content** | [**RbmCardContent**](RbmCardContent.md) | |

0 commit comments

Comments
 (0)