Align link and error schemas with BRTC spec

Add method (enum: GET/POST/DELETE) to link schema and id, type, source
fields to error schema per the authoritative BRTC spec. Extract
LinkMethodEnum to its own file to match codebase conventions.

Generated from Claude9 with Claude Code

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: smoghe-bw

bandwidth.yml

@@ -2320,6 +2320,13 @@ components:
           type: string
         href:
           type: string
+        method:
+          type: string
+          enum:
+            - GET
+            - POST
+            - DELETE
+          description: The HTTP method to use when making the request.
     errorObject:
       type: object
       properties:
@@ -6672,6 +6679,13 @@ components:
     error:
       type: object
       properties:
+        id:
+          type: string
+          format: uuid
+          description: A unique identifier for the error.
+        type:
+          type: string
+          description: The type of error.
         code:
           type: integer
         description:
@@ -6680,6 +6694,21 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/telephoneNumber'
+        source:
+          type: object
+          properties:
+            parameter:
+              type: string
+              description: The URI parameter that caused the error.
+            field:
+              type: string
+              description: The request body field that caused the error.
+            header:
+              type: string
+              description: The header that caused the error.
+            reference:
+              type: string
+              description: A reference to the source of the error.
     telephoneNumber:
       type: object
       properties:

bandwidth/models/__init__.py

@@ -94,6 +94,7 @@
 from bandwidth.models.latest_message_delivery_status_enum import LatestMessageDeliveryStatusEnum
 from bandwidth.models.line_type_enum import LineTypeEnum
 from bandwidth.models.link import Link
+from bandwidth.models.link_method_enum import LinkMethodEnum
 from bandwidth.models.link_schema import LinkSchema
 from bandwidth.models.links_object import LinksObject
 from bandwidth.models.list_endpoints_response import ListEndpointsResponse

bandwidth/models/error.py

@@ -20,6 +20,7 @@
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from bandwidth.models.error_source import ErrorSource
 from bandwidth.models.telephone_number import TelephoneNumber
 from typing import Optional, Set
 from typing_extensions import Self
@@ -28,11 +29,14 @@ class Error(BaseModel):
     """
     Error
     """ # noqa: E501
+    id: Optional[StrictStr] = Field(default=None, description="A unique identifier for the error.")
+    type: Optional[StrictStr] = Field(default=None, description="The type of error.")
     code: Optional[StrictInt] = None
     description: Optional[StrictStr] = None
     telephone_numbers: Optional[List[TelephoneNumber]] = Field(default=None, alias="telephoneNumbers")
+    source: Optional[ErrorSource] = None
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["code", "description", "telephoneNumbers"]
+    __properties: ClassVar[List[str]] = ["id", "type", "code", "description", "telephoneNumbers", "source"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -82,6 +86,9 @@ def to_dict(self) -> Dict[str, Any]:
                 if _item_telephone_numbers:
                     _items.append(_item_telephone_numbers.to_dict())
             _dict['telephoneNumbers'] = _items
+        # override the default output from pydantic by calling `to_dict()` of source
+        if self.source:
+            _dict['source'] = self.source.to_dict()
         # puts key-value pairs in additional_properties in the top level
         if self.additional_properties is not None:
             for _key, _value in self.additional_properties.items():
@@ -99,9 +106,12 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "type": obj.get("type"),
             "code": obj.get("code"),
             "description": obj.get("description"),
-            "telephoneNumbers": [TelephoneNumber.from_dict(_item) for _item in obj["telephoneNumbers"]] if obj.get("telephoneNumbers") is not None else None
+            "telephoneNumbers": [TelephoneNumber.from_dict(_item) for _item in obj["telephoneNumbers"]] if obj.get("telephoneNumbers") is not None else None,
+            "source": ErrorSource.from_dict(obj["source"]) if obj.get("source") is not None else None
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

bandwidth/models/link.py

@@ -18,8 +18,9 @@
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from bandwidth.models.link_method_enum import LinkMethodEnum
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -29,8 +30,9 @@ class Link(BaseModel):
     """ # noqa: E501
     rel: Optional[StrictStr] = None
     href: Optional[StrictStr] = None
+    method: Optional[LinkMethodEnum] = Field(default=None, description="The HTTP method to use when making the request.")
     additional_properties: Dict[str, Any] = {}
-    __properties: ClassVar[List[str]] = ["rel", "href"]
+    __properties: ClassVar[List[str]] = ["rel", "href", "method"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -91,7 +93,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
 
         _obj = cls.model_validate({
             "rel": obj.get("rel"),
-            "href": obj.get("href")
+            "href": obj.get("href"),
+            "method": obj.get("method")
         })
         # store additional fields in additional_properties
         for _key in obj.keys():

bandwidth/models/link_method_enum.py

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+"""
+    Bandwidth
+
+    Bandwidth's Communication APIs
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: letstalk@bandwidth.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class LinkMethodEnum(str, Enum):
+    """
+    The HTTP method to use when making the request.
+    """
+
+    """
+    allowed enum values
+    """
+    GET = 'GET'
+    POST = 'POST'
+    DELETE = 'DELETE'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of LinkMethodEnum from a JSON string"""
+        return cls(json.loads(json_str))
+

test/unit/models/test_error.py

@@ -16,6 +16,7 @@
 import unittest
 
 from bandwidth.models.error import Error
+from bandwidth.models.error_source import ErrorSource
 from bandwidth.models.telephone_number import TelephoneNumber
 
 class TestError(unittest.TestCase):
@@ -27,35 +28,36 @@ def setUp(self):
     def tearDown(self):
         pass
 
-    def make_instance(self, include_optional) -> Error:
-        """Test Error
-            include_optional is a boolean, when False only required
-            params are included, when True both required and
-            optional params are included """
-        if include_optional:
-            return Error(
-                code = 56,
-                description = '',
-                telephone_numbers = [
-                    TelephoneNumber(
-                        telephone_number = '', )
-                    ]
+    def make_instance(self) -> Error:
+        """Test Error"""
+        return Error(
+            id = '59512d87-7a92-4040-8e4a-78fb772019b9',
+            type = 'resource.not_found',
+            code = 404,
+            description = 'The requested resource was not found.',
+            telephone_numbers = [
+                TelephoneNumber(
+                    telephone_number = '+15551234567', )
+                ],
+            source = ErrorSource(
+                parameter = 'accountId',
             )
-        else:
-            return Error(
         )
 
     def testError(self):
         """Test Error"""
-        instance = self.make_instance(True)
+        instance = self.make_instance()
         assert instance is not None
         assert isinstance(instance, Error)
-        assert instance.code == 56
-        assert instance.description == ''
+        assert instance.id == '59512d87-7a92-4040-8e4a-78fb772019b9'
+        assert instance.type == 'resource.not_found'
+        assert instance.code == 404
+        assert instance.description == 'The requested resource was not found.'
         assert isinstance(instance.telephone_numbers, list)
         assert len(instance.telephone_numbers) == 1
         assert isinstance(instance.telephone_numbers[0], TelephoneNumber)
-        assert instance.telephone_numbers[0].telephone_number == ''
+        assert instance.source is not None
+        assert instance.source.parameter == 'accountId'
 
 if __name__ == '__main__':
     unittest.main()

test/unit/models/test_error_source.py

@@ -26,25 +26,18 @@ def setUp(self):
     def tearDown(self):
         pass
 
-    def make_instance(self, include_optional) -> ErrorSource:
-        """Test ErrorSource
-            include_optional is a boolean, when False only required
-            params are included, when True both required and
-            optional params are included """
-        if include_optional:
-            return ErrorSource(
-                parameter = 'parameter',
-                var_field = 'var_field',
-                header = 'header',
-                reference = 'reference'
-            )
-        else:
-            return ErrorSource(
+    def make_instance(self) -> ErrorSource:
+        """Test ErrorSource"""
+        return ErrorSource(
+            parameter = 'parameter',
+            var_field = 'var_field',
+            header = 'header',
+            reference = 'reference'
         )
 
     def testErrorSource(self):
         """Test ErrorSource"""
-        instance = self.make_instance(True)
+        instance = self.make_instance()
         assert instance is not None
         assert isinstance(instance, ErrorSource)
         assert instance.parameter == 'parameter'

test/unit/models/test_link.py

@@ -26,27 +26,22 @@ def setUp(self):
     def tearDown(self):
         pass
 
-    def make_instance(self, include_optional) -> Link:
-        """Test Link
-            include_optional is a boolean, when False only required
-            params are included, when True both required and
-            optional params are included """
-        if include_optional:
-            return Link(
-                rel = 'rel',
-                href = 'href'
-            )
-        else:
-            return Link(
+    def make_instance(self) -> Link:
+        """Test Link"""
+        return Link(
+            rel = 'self',
+            href = 'https://api.bandwidth.com/v2/accounts/123/endpoints',
+            method = 'GET'
         )
 
     def testLink(self):
         """Test Link"""
-        instance = self.make_instance(True)
+        instance = self.make_instance()
         assert instance is not None
         assert isinstance(instance, Link)
-        assert instance.rel == 'rel'
-        assert instance.href == 'href'
+        assert instance.rel == 'self'
+        assert instance.href == 'https://api.bandwidth.com/v2/accounts/123/endpoints'
+        assert instance.method == 'GET'
 
 if __name__ == '__main__':
     unittest.main()