get list_calls working

Author: maxkahan

users/src/vonage_users/__init__.py

@@ -1,11 +1,11 @@
 from .common import User
-from .requests import ListUsersRequest
+from .requests import ListUsersFilter
 from .responses import UserSummary
 from .users import Users
 
 __all__ = [
     'Users',
     'User',
-    'ListUsersRequest',
+    'ListUsersFilter',
     'UserSummary',
 ]

users/src/vonage_users/common.py

@@ -1,13 +1,10 @@
 from typing import List, Optional
 
 from pydantic import BaseModel, Field, model_validator
+from vonage_utils.models import Link
 from vonage_utils.types import PhoneNumber
 
 
-class Link(BaseModel):
-    href: str
-
-
 class ResourceLink(BaseModel):
     self: Link
 

users/src/vonage_users/requests.py

@@ -3,7 +3,7 @@
 from pydantic import BaseModel, Field
 
 
-class ListUsersRequest(BaseModel):
+class ListUsersFilter(BaseModel):
     """Request object for listing users."""
 
     page_size: Optional[int] = Field(100, ge=1, le=100)

users/src/vonage_users/responses.py

@@ -19,7 +19,6 @@ class UserSummary(BaseModel):
     link: Optional[str] = None
 
     @model_validator(mode='after')
-    @classmethod
     def get_link(self):
         if self.links is not None:
             self.link = self.links.self.href

users/src/vonage_users/users.py

@@ -5,7 +5,7 @@
 from vonage_http_client.http_client import HttpClient
 
 from .common import User
-from .requests import ListUsersRequest
+from .requests import ListUsersFilter
 from .responses import ListUsersResponse, UserSummary
 
 
@@ -22,23 +22,27 @@ def __init__(self, http_client: HttpClient) -> None:
 
     @validate_call
     def list_users(
-        self, params: ListUsersRequest = ListUsersRequest()
-    ) -> Tuple[List[UserSummary], str]:
+        self, filter: ListUsersFilter = ListUsersFilter()
+    ) -> Tuple[List[UserSummary], Optional[str]]:
         """List all users.
 
         Retrieves a list of all users. Gets 100 users by default.
-        If you want to see more information about a specific user, you can use the `Users.get_user` method.
+        If you want to see more information about a specific user, you can use the
+            `Users.get_user` method.
 
         Args:
-            params (ListUsersRequest, optional): An instance of the ListUsersRequest class that allows you to specify additional parameters for the user listing.
+            params (ListUsersFilter, optional): An instance of the `ListUsersFilter`
+                class that allows you to specify additional parameters for the user listing.
 
         Returns:
-            Tuple[List[UserSummary], str]: A tuple containing a list of UserSummary objects representing the users and a string representing the next cursor for pagination.
+            Tuple[List[UserSummary], Optional[str]]: A tuple containing a list of `UserSummary`
+                objects representing the users and a string representing the next cursor for
+                pagination, if there are more results than the specified `page_size`.
         """
         response = self._http_client.get(
             self._http_client.api_host,
             '/v1/users',
-            params.model_dump(exclude_none=True),
+            filter.model_dump(exclude_none=True),
             self._auth_type,
         )
 

users/tests/test_users.py

@@ -5,7 +5,7 @@
 from vonage_http_client.http_client import HttpClient
 from vonage_users import Users
 from vonage_users.common import *
-from vonage_users.requests import ListUsersRequest
+from vonage_users.requests import ListUsersFilter
 
 from testutils import build_response, get_mock_jwt_auth
 
@@ -21,7 +21,7 @@ def test_create_list_users_request():
         'cursor': '7EjDNQrAcipmOnc0HCzpQRkhBULzY44ljGUX4lXKyUIVfiZay5pv9wg=',
         'name': 'my_user',
     }
-    list_users_request = ListUsersRequest(**params)
+    list_users_request = ListUsersFilter(**params)
 
     assert list_users_request.model_dump() == params
 
@@ -52,7 +52,7 @@ def test_list_users_options():
         path, 'GET', 'https://api.nexmo.com/v1/users', 'list_users_options.json'
     )
 
-    params = ListUsersRequest(
+    params = ListUsersFilter(
         page_size=2,
         order='asc',
         cursor='zAmuSchIBsUF1QaaohGdaf32NgHOkP130XeQrZkoOPEuGPnIxFb0Xj3iqCfOzxSSq9Es/S/2h+HYumKt3HS0V9ewjis+j74oMcsvYBLN1PwFEupI6ENEWHYC7lk=',

voice/src/vonage_voice/models/common.py

@@ -1,6 +1,36 @@
 from typing import Literal, Optional
 
 from pydantic import BaseModel, Field
+from vonage_utils.types import Dtmf, PhoneNumber, SipUri
+from vonage_voice.models.enums import Channel
+
+
+class Phone(BaseModel):
+    number: PhoneNumber
+    type: Channel = Channel.PHONE
+
+
+class ToPhone(Phone):
+    dtmf_answer: Optional[Dtmf] = Field(None, serialization_alias='dtmfAnswer')
+
+
+class Sip(BaseModel):
+    uri: SipUri
+    type: Channel = Channel.SIP
+
+
+class Websocket(BaseModel):
+    uri: str = Field(..., min_length=1, max_length=50)
+    content_type: Literal['audio/l16;rate=8000', 'audio/l16;rate=16000'] = Field(
+        'audio/l16;rate=16000', serialization_alias='content-type'
+    )
+    type: Channel = Channel.WEBSOCKET
+    headers: Optional[dict] = None
+
+
+class Vbc(BaseModel):
+    extension: str
+    type: Channel = Channel.VBC
 
 
 class AdvancedMachineDetection(BaseModel):

voice/src/vonage_voice/models/ncco.py

@@ -1,4 +1,4 @@
-from typing import Annotated, List, Optional, Union
+from typing import List, Optional, Union
 
 from pydantic import BaseModel, Field, model_validator
 from typing_extensions import Literal

voice/src/vonage_voice/models/requests.py

@@ -1,40 +1,11 @@
 from typing import List, Literal, Optional, Union
 
 from pydantic import BaseModel, Field, model_validator
-from vonage_utils.types import Dtmf, PhoneNumber, SipUri
 
 from ..errors import VoiceError
-from .common import AdvancedMachineDetection
-from .enums import CallStatus, Channel
-from .ncco import Record, Conversation, Connect, Input, Talk, Stream, Notify
-
-
-class Phone(BaseModel):
-    number: PhoneNumber
-    type: Channel = Channel.PHONE
-
-
-class ToPhone(Phone):
-    dtmf_answer: Optional[Dtmf] = Field(None, serialization_alias='dtmfAnswer')
-
-
-class Sip(BaseModel):
-    uri: SipUri
-    type: Channel = Channel.SIP
-
-
-class Websocket(BaseModel):
-    uri: str = Field(..., min_length=1, max_length=50)
-    content_type: Literal['audio/l16;rate=8000', 'audio/l16;rate=16000'] = Field(
-        'audio/l16;rate=16000', serialization_alias='content-type'
-    )
-    type: Channel = Channel.WEBSOCKET
-    headers: Optional[dict] = None
-
-
-class Vbc(BaseModel):
-    extension: str
-    type: Channel = Channel.VBC
+from .common import AdvancedMachineDetection, Phone, Sip, ToPhone, Vbc, Websocket
+from .enums import CallStatus
+from .ncco import Connect, Conversation, Input, Notify, Record, Stream, Talk
 
 
 class CreateCallRequest(BaseModel):
@@ -73,7 +44,7 @@ class ListCallsFilter(BaseModel):
     status: Optional[CallStatus] = None
     date_start: Optional[str] = None
     date_end: Optional[str] = None
-    page_size: Optional[int] = Field(None, ge=1, le=100)
+    page_size: Optional[int] = Field(100, ge=1, le=100)
     record_index: Optional[int] = None
     order: Optional[Literal['asc', 'desc']] = None
     conversation_uuid: Optional[str] = None

voice/src/vonage_voice/models/responses.py

@@ -1,5 +1,9 @@
-from typing import List, Optional
+from typing import List, Optional, Union
+
 from pydantic import BaseModel, Field, model_validator
+from vonage_utils.models import Link
+
+from .common import Phone, Sip, ToPhone, Vbc, Websocket
 
 
 class CreateCallResponse(BaseModel):
@@ -14,27 +18,19 @@ class CallStatus(BaseModel):
     uuid: str
 
 
-class Link(BaseModel):
-    href: str
-
-
 class Links(BaseModel):
     self: Link
     first: Optional[Link] = None
-    next: Optional[Link] = None
+    last: Optional[Link] = None
     prev: Optional[Link] = None
-
-
-class Endpoint(BaseModel):
-    type: str
-    number: str
+    next: Optional[Link] = None
 
 
 class CallInfo(BaseModel):
     uuid: str
     conversation_uuid: str
-    to: Endpoint
-    from_: Endpoint = Field(..., alias='from')
+    to: ToPhone
+    from_: Union[Phone, Sip, Websocket, Vbc] = Field(..., validation_alias='from')
     status: str
     direction: str
     rate: Optional[str] = None
@@ -47,7 +43,6 @@ class CallInfo(BaseModel):
     link: Optional[str] = None
 
     @model_validator(mode='after')
-    @classmethod
     def get_link(self):
         self.link = self.links.self.href
         return self