telnyx 3.0.0a0__py3-none-any.whl → 3.1.0__py3-none-any.whl

telnyx/types/legacy/reporting/batch_detail_records/voice_delete_response.py

@@ -0,0 +1,91 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ....._models import BaseModel
+
+__all__ = ["VoiceDeleteResponse", "Data", "DataFilter"]
+
+
+class DataFilter(BaseModel):
+    billing_group: Optional[str] = None
+    """Billing group UUID to filter by"""
+
+    cld: Optional[str] = None
+    """Called line identification (destination number)"""
+
+    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLD matching"""
+
+    cli: Optional[str] = None
+    """Calling line identification (caller ID)"""
+
+    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLI matching"""
+
+    filter_type: Optional[Literal["and", "or"]] = None
+    """Logical operator for combining filters"""
+
+    tags_list: Optional[str] = None
+    """Tag name to filter by"""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Unique identifier for the report"""
+
+    call_types: Optional[List[int]] = None
+    """List of call types (Inbound = 1, Outbound = 2)"""
+
+    connections: Optional[List[int]] = None
+    """List of connections"""
+
+    created_at: Optional[str] = None
+    """Creation date of the report"""
+
+    end_time: Optional[str] = None
+    """End time in ISO format"""
+
+    filters: Optional[List[DataFilter]] = None
+    """List of filters"""
+
+    managed_accounts: Optional[List[str]] = None
+    """List of managed accounts"""
+
+    record_type: Optional[str] = None
+
+    record_types: Optional[List[int]] = None
+    """List of record types (Complete = 1, Incomplete = 2, Errors = 3)"""
+
+    report_name: Optional[str] = None
+    """Name of the report"""
+
+    report_url: Optional[str] = None
+    """URL to download the report"""
+
+    retry: Optional[int] = None
+    """Number of retries"""
+
+    source: Optional[str] = None
+    """Source of the report.
+
+    Valid values: calls (default), call-control, fax-api, webrtc
+    """
+
+    start_time: Optional[str] = None
+    """Start time in ISO format"""
+
+    status: Optional[int] = None
+    """Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)"""
+
+    timezone: Optional[str] = None
+    """Timezone for the report"""
+
+    updated_at: Optional[str] = None
+    """Last update date of the report"""
+
+
+class VoiceDeleteResponse(BaseModel):
+    data: Optional[Data] = None
+    """Response object for CDR detailed report"""

telnyx/types/legacy/reporting/batch_detail_records/voice_list_response.py

@@ -0,0 +1,102 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ....._models import BaseModel
+
+__all__ = ["VoiceListResponse", "Data", "DataFilter", "Meta"]
+
+
+class DataFilter(BaseModel):
+    billing_group: Optional[str] = None
+    """Billing group UUID to filter by"""
+
+    cld: Optional[str] = None
+    """Called line identification (destination number)"""
+
+    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLD matching"""
+
+    cli: Optional[str] = None
+    """Calling line identification (caller ID)"""
+
+    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLI matching"""
+
+    filter_type: Optional[Literal["and", "or"]] = None
+    """Logical operator for combining filters"""
+
+    tags_list: Optional[str] = None
+    """Tag name to filter by"""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Unique identifier for the report"""
+
+    call_types: Optional[List[int]] = None
+    """List of call types (Inbound = 1, Outbound = 2)"""
+
+    connections: Optional[List[int]] = None
+    """List of connections"""
+
+    created_at: Optional[str] = None
+    """Creation date of the report"""
+
+    end_time: Optional[str] = None
+    """End time in ISO format"""
+
+    filters: Optional[List[DataFilter]] = None
+    """List of filters"""
+
+    managed_accounts: Optional[List[str]] = None
+    """List of managed accounts"""
+
+    record_type: Optional[str] = None
+
+    record_types: Optional[List[int]] = None
+    """List of record types (Complete = 1, Incomplete = 2, Errors = 3)"""
+
+    report_name: Optional[str] = None
+    """Name of the report"""
+
+    report_url: Optional[str] = None
+    """URL to download the report"""
+
+    retry: Optional[int] = None
+    """Number of retries"""
+
+    source: Optional[str] = None
+    """Source of the report.
+
+    Valid values: calls (default), call-control, fax-api, webrtc
+    """
+
+    start_time: Optional[str] = None
+    """Start time in ISO format"""
+
+    status: Optional[int] = None
+    """Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)"""
+
+    timezone: Optional[str] = None
+    """Timezone for the report"""
+
+    updated_at: Optional[str] = None
+    """Last update date of the report"""
+
+
+class Meta(BaseModel):
+    page_number: Optional[int] = None
+
+    page_size: Optional[int] = None
+
+    total_pages: Optional[int] = None
+
+    total_results: Optional[int] = None
+
+
+class VoiceListResponse(BaseModel):
+    data: Optional[List[Data]] = None
+
+    meta: Optional[Meta] = None

telnyx/types/legacy/reporting/batch_detail_records/voice_retrieve_fields_response.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from ....._models import BaseModel
+
+__all__ = ["VoiceRetrieveFieldsResponse"]
+
+
+class VoiceRetrieveFieldsResponse(BaseModel):
+    billing: Optional[List[str]] = FieldInfo(alias="Billing", default=None)
+    """Cost and billing related information"""
+
+    interaction_data: Optional[List[str]] = FieldInfo(alias="Interaction Data", default=None)
+    """Fields related to call interaction and basic call information"""
+
+    number_information: Optional[List[str]] = FieldInfo(alias="Number Information", default=None)
+    """Geographic and routing information for phone numbers"""
+
+    telephony_data: Optional[List[str]] = FieldInfo(alias="Telephony Data", default=None)
+    """Technical telephony and call control information"""

telnyx/types/legacy/reporting/batch_detail_records/voice_retrieve_response.py

@@ -0,0 +1,91 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from ....._models import BaseModel
+
+__all__ = ["VoiceRetrieveResponse", "Data", "DataFilter"]
+
+
+class DataFilter(BaseModel):
+    billing_group: Optional[str] = None
+    """Billing group UUID to filter by"""
+
+    cld: Optional[str] = None
+    """Called line identification (destination number)"""
+
+    cld_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLD matching"""
+
+    cli: Optional[str] = None
+    """Calling line identification (caller ID)"""
+
+    cli_filter: Optional[Literal["contains", "starts_with", "ends_with"]] = None
+    """Filter type for CLI matching"""
+
+    filter_type: Optional[Literal["and", "or"]] = None
+    """Logical operator for combining filters"""
+
+    tags_list: Optional[str] = None
+    """Tag name to filter by"""
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Unique identifier for the report"""
+
+    call_types: Optional[List[int]] = None
+    """List of call types (Inbound = 1, Outbound = 2)"""
+
+    connections: Optional[List[int]] = None
+    """List of connections"""
+
+    created_at: Optional[str] = None
+    """Creation date of the report"""
+
+    end_time: Optional[str] = None
+    """End time in ISO format"""
+
+    filters: Optional[List[DataFilter]] = None
+    """List of filters"""
+
+    managed_accounts: Optional[List[str]] = None
+    """List of managed accounts"""
+
+    record_type: Optional[str] = None
+
+    record_types: Optional[List[int]] = None
+    """List of record types (Complete = 1, Incomplete = 2, Errors = 3)"""
+
+    report_name: Optional[str] = None
+    """Name of the report"""
+
+    report_url: Optional[str] = None
+    """URL to download the report"""
+
+    retry: Optional[int] = None
+    """Number of retries"""
+
+    source: Optional[str] = None
+    """Source of the report.
+
+    Valid values: calls (default), call-control, fax-api, webrtc
+    """
+
+    start_time: Optional[str] = None
+    """Start time in ISO format"""
+
+    status: Optional[int] = None
+    """Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)"""
+
+    timezone: Optional[str] = None
+    """Timezone for the report"""
+
+    updated_at: Optional[str] = None
+    """Last update date of the report"""
+
+
+class VoiceRetrieveResponse(BaseModel):
+    data: Optional[Data] = None
+    """Response object for CDR detailed report"""

telnyx/types/legacy/reporting/usage_report_retrieve_speech_to_text_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import datetime
+from typing_extensions import Annotated, TypedDict
+
+from ...._utils import PropertyInfo
+
+__all__ = ["UsageReportRetrieveSpeechToTextParams"]
+
+
+class UsageReportRetrieveSpeechToTextParams(TypedDict, total=False):
+    end_date: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+
+    start_date: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]

telnyx/types/legacy/reporting/usage_report_retrieve_speech_to_text_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ...._models import BaseModel
+
+__all__ = ["UsageReportRetrieveSpeechToTextResponse"]
+
+
+class UsageReportRetrieveSpeechToTextResponse(BaseModel):
+    data: Optional[object] = None

telnyx/types/legacy/reporting/usage_reports/__init__.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .voice_list_params import VoiceListParams as VoiceListParams
+from .voice_create_params import VoiceCreateParams as VoiceCreateParams
+from .voice_list_response import VoiceListResponse as VoiceListResponse
+from .messaging_list_params import MessagingListParams as MessagingListParams
+from .voice_create_response import VoiceCreateResponse as VoiceCreateResponse
+from .voice_delete_response import VoiceDeleteResponse as VoiceDeleteResponse
+from .messaging_create_params import MessagingCreateParams as MessagingCreateParams
+from .messaging_list_response import MessagingListResponse as MessagingListResponse
+from .voice_retrieve_response import VoiceRetrieveResponse as VoiceRetrieveResponse
+from .messaging_create_response import MessagingCreateResponse as MessagingCreateResponse
+from .messaging_delete_response import MessagingDeleteResponse as MessagingDeleteResponse
+from .number_lookup_list_params import NumberLookupListParams as NumberLookupListParams
+from .messaging_retrieve_response import MessagingRetrieveResponse as MessagingRetrieveResponse
+from .number_lookup_create_params import NumberLookupCreateParams as NumberLookupCreateParams

telnyx/types/legacy/reporting/usage_reports/messaging_create_params.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from ....._types import SequenceNotStr
+from ....._utils import PropertyInfo
+
+__all__ = ["MessagingCreateParams"]
+
+
+class MessagingCreateParams(TypedDict, total=False):
+    aggregation_type: Required[int]
+    """Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2"""
+
+    end_time: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+
+    managed_accounts: SequenceNotStr[str]
+    """List of managed accounts to include"""
+
+    profiles: SequenceNotStr[str]
+    """List of messaging profile IDs to filter by"""
+
+    select_all_managed_accounts: bool
+
+    start_time: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]

telnyx/types/legacy/reporting/usage_reports/messaging_create_response.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ....._models import BaseModel
+
+__all__ = ["MessagingCreateResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    aggregation_type: Optional[int] = None
+    """Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2"""
+
+    connections: Optional[List[int]] = None
+
+    created_at: Optional[datetime] = None
+
+    end_time: Optional[datetime] = None
+
+    profiles: Optional[List[str]] = None
+    """List of messaging profile IDs"""
+
+    record_type: Optional[str] = None
+
+    report_url: Optional[str] = None
+
+    result: Optional[object] = None
+
+    start_time: Optional[datetime] = None
+
+    status: Optional[int] = None
+    """Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)"""
+
+    updated_at: Optional[datetime] = None
+
+
+class MessagingCreateResponse(BaseModel):
+    data: Optional[Data] = None
+    """Legacy V2 MDR usage report response"""

telnyx/types/legacy/reporting/usage_reports/messaging_delete_response.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ....._models import BaseModel
+
+__all__ = ["MessagingDeleteResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    aggregation_type: Optional[int] = None
+    """Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2"""
+
+    connections: Optional[List[int]] = None
+
+    created_at: Optional[datetime] = None
+
+    end_time: Optional[datetime] = None
+
+    profiles: Optional[List[str]] = None
+    """List of messaging profile IDs"""
+
+    record_type: Optional[str] = None
+
+    report_url: Optional[str] = None
+
+    result: Optional[object] = None
+
+    start_time: Optional[datetime] = None
+
+    status: Optional[int] = None
+    """Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)"""
+
+    updated_at: Optional[datetime] = None
+
+
+class MessagingDeleteResponse(BaseModel):
+    data: Optional[Data] = None
+    """Legacy V2 MDR usage report response"""

telnyx/types/legacy/reporting/usage_reports/messaging_list_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["MessagingListParams"]
+
+
+class MessagingListParams(TypedDict, total=False):
+    page: int
+    """Page number"""
+
+    per_page: int
+    """Size of the page"""

telnyx/types/legacy/reporting/usage_reports/messaging_list_response.py

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ....._models import BaseModel
+
+__all__ = ["MessagingListResponse", "Data", "Meta"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    aggregation_type: Optional[int] = None
+    """Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2"""
+
+    connections: Optional[List[int]] = None
+
+    created_at: Optional[datetime] = None
+
+    end_time: Optional[datetime] = None
+
+    profiles: Optional[List[str]] = None
+    """List of messaging profile IDs"""
+
+    record_type: Optional[str] = None
+
+    report_url: Optional[str] = None
+
+    result: Optional[object] = None
+
+    start_time: Optional[datetime] = None
+
+    status: Optional[int] = None
+    """Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)"""
+
+    updated_at: Optional[datetime] = None
+
+
+class Meta(BaseModel):
+    page_number: Optional[int] = None
+
+    page_size: Optional[int] = None
+
+    total_pages: Optional[int] = None
+
+    total_results: Optional[int] = None
+
+
+class MessagingListResponse(BaseModel):
+    data: Optional[List[Data]] = None
+
+    meta: Optional[Meta] = None

telnyx/types/legacy/reporting/usage_reports/messaging_retrieve_response.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from ....._models import BaseModel
+
+__all__ = ["MessagingRetrieveResponse", "Data"]
+
+
+class Data(BaseModel):
+    id: Optional[str] = None
+    """Identifies the resource"""
+
+    aggregation_type: Optional[int] = None
+    """Aggregation type: No aggregation = 0, By Messaging Profile = 1, By Tags = 2"""
+
+    connections: Optional[List[int]] = None
+
+    created_at: Optional[datetime] = None
+
+    end_time: Optional[datetime] = None
+
+    profiles: Optional[List[str]] = None
+    """List of messaging profile IDs"""
+
+    record_type: Optional[str] = None
+
+    report_url: Optional[str] = None
+
+    result: Optional[object] = None
+
+    start_time: Optional[datetime] = None
+
+    status: Optional[int] = None
+    """Status of the report (Pending = 1, Complete = 2, Failed = 3, Expired = 4)"""
+
+    updated_at: Optional[datetime] = None
+
+
+class MessagingRetrieveResponse(BaseModel):
+    data: Optional[Data] = None
+    """Legacy V2 MDR usage report response"""

telnyx/types/legacy/reporting/usage_reports/number_lookup_create_params.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import date
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ....._types import SequenceNotStr
+from ....._utils import PropertyInfo
+
+__all__ = ["NumberLookupCreateParams"]
+
+
+class NumberLookupCreateParams(TypedDict, total=False):
+    aggregation_type: Annotated[Literal["ALL", "BY_ORGANIZATION_MEMBER"], PropertyInfo(alias="aggregationType")]
+    """Type of aggregation for the report"""
+
+    end_date: Annotated[Union[str, date], PropertyInfo(alias="endDate", format="iso8601")]
+    """End date for the usage report"""
+
+    managed_accounts: Annotated[SequenceNotStr[str], PropertyInfo(alias="managedAccounts")]
+    """List of managed accounts to include in the report"""
+
+    start_date: Annotated[Union[str, date], PropertyInfo(alias="startDate", format="iso8601")]
+    """Start date for the usage report"""

telnyx/types/legacy/reporting/usage_reports/number_lookup_list_params.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["NumberLookupListParams"]
+
+
+class NumberLookupListParams(TypedDict, total=False):
+    page: int
+
+    per_page: int

telnyx/types/legacy/reporting/usage_reports/voice_create_params.py

@@ -0,0 +1,40 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from ....._types import SequenceNotStr
+from ....._utils import PropertyInfo
+
+__all__ = ["VoiceCreateParams"]
+
+
+class VoiceCreateParams(TypedDict, total=False):
+    end_time: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """End time in ISO format"""
+
+    start_time: Required[Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]]
+    """Start time in ISO format"""
+
+    aggregation_type: int
+    """
+    Aggregation type: All = 0, By Connections = 1, By Tags = 2, By Billing Group = 3
+    """
+
+    connections: Iterable[int]
+    """List of connections to filter by"""
+
+    managed_accounts: SequenceNotStr[str]
+    """List of managed accounts to include"""
+
+    product_breakdown: int
+    """
+    Product breakdown type: No breakdown = 0, DID vs Toll-free = 1, Country = 2, DID
+    vs Toll-free per Country = 3
+    """
+
+    select_all_managed_accounts: bool
+    """Whether to select all managed accounts"""