syllable-sdk 0.38.20__py3-none-any.whl → 0.38.22__py3-none-any.whl

syllable_sdk/models/organizationchannelconfig.py

@@ -13,6 +13,7 @@ from syllable_sdk.types import (
     UNSET,
     UNSET_SENTINEL,
 )
+from typing import Dict
 from typing_extensions import NotRequired, TypedDict
 
 
@@ -23,6 +24,8 @@ class OrganizationChannelConfigTypedDict(TypedDict):
     r"""SID of the Twilio account"""
     auth_token: NotRequired[Nullable[str]]
     r"""The Twilio auth token"""
+    provider_credentials: NotRequired[Nullable[Dict[str, str]]]
+    r"""Provider-specific credentials. Initially to be used for AfricasTalking creds.In a future this would be used for Twilio creds too (removing the account_sid and auth_token fields)."""
     telephony: NotRequired[Nullable[TelephonyConfigurationsTypedDict]]
     r"""Telephony configurations to be applied to the targets under the channel"""
 
@@ -36,13 +39,26 @@ class OrganizationChannelConfig(BaseModel):
     auth_token: OptionalNullable[str] = UNSET
     r"""The Twilio auth token"""
 
+    provider_credentials: OptionalNullable[Dict[str, str]] = UNSET
+    r"""Provider-specific credentials. Initially to be used for AfricasTalking creds.In a future this would be used for Twilio creds too (removing the account_sid and auth_token fields)."""
+
     telephony: OptionalNullable[TelephonyConfigurations] = UNSET
     r"""Telephony configurations to be applied to the targets under the channel"""
 
     @model_serializer(mode="wrap")
     def serialize_model(self, handler):
-        optional_fields = ["account_sid", "auth_token", "telephony"]
-        nullable_fields = ["account_sid", "auth_token", "telephony"]
+        optional_fields = [
+            "account_sid",
+            "auth_token",
+            "provider_credentials",
+            "telephony",
+        ]
+        nullable_fields = [
+            "account_sid",
+            "auth_token",
+            "provider_credentials",
+            "telephony",
+        ]
         null_default_fields = []
 
         serialized = handler(self)

syllable_sdk/models/voice_groups_deleteop.py

@@ -0,0 +1,21 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from syllable_sdk.types import BaseModel
+from syllable_sdk.utils import FieldMetadata, PathParamMetadata, QueryParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class VoiceGroupsDeleteRequestTypedDict(TypedDict):
+    voice_group_id: int
+    reason: str
+
+
+class VoiceGroupsDeleteRequest(BaseModel):
+    voice_group_id: Annotated[
+        int, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]
+
+    reason: Annotated[
+        str, FieldMetadata(query=QueryParamMetadata(style="form", explode=True))
+    ]

syllable_sdk/models/voice_groups_get_by_idop.py

@@ -0,0 +1,16 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from syllable_sdk.types import BaseModel
+from syllable_sdk.utils import FieldMetadata, PathParamMetadata
+from typing_extensions import Annotated, TypedDict
+
+
+class VoiceGroupsGetByIDRequestTypedDict(TypedDict):
+    voice_group_id: int
+
+
+class VoiceGroupsGetByIDRequest(BaseModel):
+    voice_group_id: Annotated[
+        int, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
+    ]

syllable_sdk/models/voice_groups_listop.py

@@ -0,0 +1,140 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .orderbydirection import OrderByDirection
+from .voicegroupproperties import VoiceGroupProperties
+from pydantic import model_serializer
+from syllable_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from syllable_sdk.utils import FieldMetadata, QueryParamMetadata
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class VoiceGroupsListRequestTypedDict(TypedDict):
+    page: NotRequired[Nullable[int]]
+    r"""The page number from which to start (0-based)"""
+    limit: NotRequired[int]
+    r"""The maximum number of items to return"""
+    search_fields: NotRequired[List[VoiceGroupProperties]]
+    r"""String names of fields to search. Correspond by index to search field values"""
+    search_field_values: NotRequired[List[str]]
+    r"""Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"""
+    order_by: NotRequired[Nullable[VoiceGroupProperties]]
+    r"""The field whose value should be used to order the results"""
+    order_by_direction: NotRequired[Nullable[OrderByDirection]]
+    r"""The direction in which to order the results"""
+    fields: NotRequired[Nullable[List[VoiceGroupProperties]]]
+    r"""The fields to include in the response"""
+    start_datetime: NotRequired[Nullable[str]]
+    r"""The start datetime for filtering results"""
+    end_datetime: NotRequired[Nullable[str]]
+    r"""The end datetime for filtering results"""
+
+
+class VoiceGroupsListRequest(BaseModel):
+    page: Annotated[
+        OptionalNullable[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The page number from which to start (0-based)"""
+
+    limit: Annotated[
+        Optional[int],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = 25
+    r"""The maximum number of items to return"""
+
+    search_fields: Annotated[
+        Optional[List[VoiceGroupProperties]],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""String names of fields to search. Correspond by index to search field values"""
+
+    search_field_values: Annotated[
+        Optional[List[str]],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = None
+    r"""Values of fields to search. Correspond by index to search fields. Unless field name contains \"list\", an individual search field value cannot be a list"""
+
+    order_by: Annotated[
+        OptionalNullable[VoiceGroupProperties],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The field whose value should be used to order the results"""
+
+    order_by_direction: Annotated[
+        OptionalNullable[OrderByDirection],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The direction in which to order the results"""
+
+    fields: Annotated[
+        OptionalNullable[List[VoiceGroupProperties]],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The fields to include in the response"""
+
+    start_datetime: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The start datetime for filtering results"""
+
+    end_datetime: Annotated[
+        OptionalNullable[str],
+        FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
+    ] = UNSET
+    r"""The end datetime for filtering results"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = [
+            "page",
+            "limit",
+            "search_fields",
+            "search_field_values",
+            "order_by",
+            "order_by_direction",
+            "fields",
+            "start_datetime",
+            "end_datetime",
+        ]
+        nullable_fields = [
+            "page",
+            "order_by",
+            "order_by_direction",
+            "fields",
+            "start_datetime",
+            "end_datetime",
+        ]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

syllable_sdk/models/voicegroupcreaterequest.py

@@ -0,0 +1,73 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .languageconfig import LanguageConfig, LanguageConfigTypedDict
+from pydantic import model_serializer
+from syllable_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from typing import List
+from typing_extensions import NotRequired, TypedDict
+
+
+class VoiceGroupCreateRequestTypedDict(TypedDict):
+    r"""Request model to create a voice group."""
+
+    name: str
+    r"""The name of the language group."""
+    language_configs: List[LanguageConfigTypedDict]
+    r"""Voice and DTMF configurations for each language in the group."""
+    skip_current_language_in_message: bool
+    r"""Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu."""
+    description: NotRequired[Nullable[str]]
+    r"""Description of the language group."""
+
+
+class VoiceGroupCreateRequest(BaseModel):
+    r"""Request model to create a voice group."""
+
+    name: str
+    r"""The name of the language group."""
+
+    language_configs: List[LanguageConfig]
+    r"""Voice and DTMF configurations for each language in the group."""
+
+    skip_current_language_in_message: bool
+    r"""Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu."""
+
+    description: OptionalNullable[str] = UNSET
+    r"""Description of the language group."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["description"]
+        nullable_fields = ["description"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

syllable_sdk/models/voicegroupproperties.py

@@ -0,0 +1,14 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from enum import Enum
+
+
+class VoiceGroupProperties(str, Enum):
+    r"""Names of voice group fields supported for filtering/sorting on list endpoint."""
+
+    NAME = "name"
+    DESCRIPTION = "description"
+    SKIP_CURRENT_LANGUAGE_IN_MESSAGE = "skip_current_language_in_message"
+    UPDATED_AT = "updated_at"
+    LAST_UPDATED_BY = "last_updated_by"

syllable_sdk/models/voicegroupresponse.py

@@ -0,0 +1,111 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .languageconfig import LanguageConfig, LanguageConfigTypedDict
+from .languagegroupagentinfo import (
+    LanguageGroupAgentInfo,
+    LanguageGroupAgentInfoTypedDict,
+)
+from datetime import datetime
+from pydantic import model_serializer
+from syllable_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from typing import List
+from typing_extensions import NotRequired, TypedDict
+
+
+class VoiceGroupResponseTypedDict(TypedDict):
+    r"""Response model for voice group operations.
+    A voice group is a collection of language, voice, and DTMF configuration that can be
+    linked to an agent to define the languages and voices it supports. For more information, see
+    [Console docs](https://docs.syllable.ai/Resources/VoiceGroups).
+    """
+
+    name: str
+    r"""The name of the language group."""
+    language_configs: List[LanguageConfigTypedDict]
+    r"""Voice and DTMF configurations for each language in the group."""
+    skip_current_language_in_message: bool
+    r"""Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu."""
+    id: int
+    r"""The ID of the language group to update."""
+    updated_at: datetime
+    r"""Timestamp of the last update to the language group."""
+    last_updated_by: str
+    r"""Email of the user who last updated the language group."""
+    description: NotRequired[Nullable[str]]
+    r"""Description of the language group."""
+    edit_comments: NotRequired[Nullable[str]]
+    r"""Comments for the most recent edit to the language group."""
+    agents_info: NotRequired[Nullable[List[LanguageGroupAgentInfoTypedDict]]]
+    r"""IDs and names of the agents linked to the language group"""
+
+
+class VoiceGroupResponse(BaseModel):
+    r"""Response model for voice group operations.
+    A voice group is a collection of language, voice, and DTMF configuration that can be
+    linked to an agent to define the languages and voices it supports. For more information, see
+    [Console docs](https://docs.syllable.ai/Resources/VoiceGroups).
+    """
+
+    name: str
+    r"""The name of the language group."""
+
+    language_configs: List[LanguageConfig]
+    r"""Voice and DTMF configurations for each language in the group."""
+
+    skip_current_language_in_message: bool
+    r"""Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu."""
+
+    id: int
+    r"""The ID of the language group to update."""
+
+    updated_at: datetime
+    r"""Timestamp of the last update to the language group."""
+
+    last_updated_by: str
+    r"""Email of the user who last updated the language group."""
+
+    description: OptionalNullable[str] = UNSET
+    r"""Description of the language group."""
+
+    edit_comments: OptionalNullable[str] = UNSET
+    r"""Comments for the most recent edit to the language group."""
+
+    agents_info: OptionalNullable[List[LanguageGroupAgentInfo]] = UNSET
+    r"""IDs and names of the agents linked to the language group"""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["description", "edit_comments", "agents_info"]
+        nullable_fields = ["description", "edit_comments", "agents_info"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

syllable_sdk/models/voicegroupupdaterequest.py

@@ -0,0 +1,83 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .languageconfig import LanguageConfig, LanguageConfigTypedDict
+from pydantic import model_serializer
+from syllable_sdk.types import (
+    BaseModel,
+    Nullable,
+    OptionalNullable,
+    UNSET,
+    UNSET_SENTINEL,
+)
+from typing import List
+from typing_extensions import NotRequired, TypedDict
+
+
+class VoiceGroupUpdateRequestTypedDict(TypedDict):
+    r"""Request model to update an existing voice group."""
+
+    name: str
+    r"""The name of the language group."""
+    language_configs: List[LanguageConfigTypedDict]
+    r"""Voice and DTMF configurations for each language in the group."""
+    skip_current_language_in_message: bool
+    r"""Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu."""
+    id: int
+    r"""The ID of the language group to update."""
+    description: NotRequired[Nullable[str]]
+    r"""Description of the language group."""
+    edit_comments: NotRequired[Nullable[str]]
+    r"""Comments for the most recent edit to the language group."""
+
+
+class VoiceGroupUpdateRequest(BaseModel):
+    r"""Request model to update an existing voice group."""
+
+    name: str
+    r"""The name of the language group."""
+
+    language_configs: List[LanguageConfig]
+    r"""Voice and DTMF configurations for each language in the group."""
+
+    skip_current_language_in_message: bool
+    r"""Whether a custom message using the language group to generate a language DTMF menu should skip the agent's current language in the menu."""
+
+    id: int
+    r"""The ID of the language group to update."""
+
+    description: OptionalNullable[str] = UNSET
+    r"""Description of the language group."""
+
+    edit_comments: OptionalNullable[str] = UNSET
+    r"""Comments for the most recent edit to the language group."""
+
+    @model_serializer(mode="wrap")
+    def serialize_model(self, handler):
+        optional_fields = ["description", "edit_comments"]
+        nullable_fields = ["description", "edit_comments"]
+        null_default_fields = []
+
+        serialized = handler(self)
+
+        m = {}
+
+        for n, f in type(self).model_fields.items():
+            k = f.alias or n
+            val = serialized.get(k)
+            serialized.pop(k, None)
+
+            optional_nullable = k in optional_fields and k in nullable_fields
+            is_set = (
+                self.__pydantic_fields_set__.intersection({n})
+                or k in null_default_fields
+            )  # pylint: disable=no-member
+
+            if val is not None and val != UNSET_SENTINEL:
+                m[k] = val
+            elif val != UNSET_SENTINEL and (
+                not k in optional_fields or (optional_nullable and is_set)
+            ):
+                m[k] = val
+
+        return m

syllable_sdk/sdk.py

@@ -39,6 +39,7 @@ if TYPE_CHECKING:
     from syllable_sdk.tools import Tools
     from syllable_sdk.users import Users
     from syllable_sdk.v1 import V1
+    from syllable_sdk.voice_groups import VoiceGroups
 
 
 class SyllableSDK(BaseSDK):
@@ -118,6 +119,7 @@ class SyllableSDK(BaseSDK):
     outbound: "Outbound"
     language_groups: "LanguageGroups"
     r"""Operations related to language groups. A language group is a           collection of language, voice, and DTMF configuration that can be linked to an agent to           define the languages and voices it supports. For more information, see           [Console docs](https://docs.syllable.ai/Resources/LanguageGroups)."""
+    voice_groups: "VoiceGroups"
     takeouts: "Takeouts"
     users: "Users"
     v1: "V1"
@@ -143,6 +145,7 @@ class SyllableSDK(BaseSDK):
         "organizations": ("syllable_sdk.organizations", "Organizations"),
         "outbound": ("syllable_sdk.outbound", "Outbound"),
         "language_groups": ("syllable_sdk.language_groups", "LanguageGroups"),
+        "voice_groups": ("syllable_sdk.voice_groups", "VoiceGroups"),
         "takeouts": ("syllable_sdk.takeouts", "Takeouts"),
         "users": ("syllable_sdk.users", "Users"),
         "v1": ("syllable_sdk.v1", "V1"),