""" Options: Date: 2025-05-04 22:27:09 Version: 8.71 Tip: To override a DTO option, remove "#" prefix before updating BaseUrl: https://team.evovoice.io #GlobalNamespace: #AddServiceStackTypes: True #AddResponseStatus: False #AddImplicitVersion: #AddDescriptionAsComments: True IncludeTypes: ListNotifications.* #ExcludeTypes: #DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum #DataClass: #DataClassJson: """ import datetime import decimal from marshmallow.fields import * from servicestack import * from typing import * from dataclasses import dataclass, field from dataclasses_json import dataclass_json, LetterCase, Undefined, config from enum import Enum, IntEnum class SortOrders(str, Enum): ASCEND = 'Ascend' DESCEND = 'Descend' T = TypeVar('T') @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ListRequest(Generic[T], IReturn[ListResponse[T]], IGet): # @ApiMember(Description="The page of data to retrieve") page: int = 0 """ The page of data to retrieve """ # @ApiMember(Description="If you want all objects to be returned. This should be used with care") all: bool = False """ If you want all objects to be returned. This should be used with care """ # @ApiMember(Description="The number per page to retrieve") count_per_page: int = 0 """ The number per page to retrieve """ # @ApiMember(Description="Specific IDs") specific_ids: Optional[List[str]] = None """ Specific IDs """ # @ApiMember(Description="Specify a sort field") sort_field: Optional[str] = None """ Specify a sort field """ # @ApiMember(Description="Specify a sort order") sort_order: Optional[SortOrders] = None """ Specify a sort order """ # @ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array") simplified_paging: bool = False """ Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array """ @staticmethod def response_type(): return ListResponse[T] class NotificationTypes(str, Enum): EMAIL = 'Email' SMS = 'Sms' PUSH = 'Push' INCOMING_CALL = 'IncomingCall' OUTGOING_CALL = 'OutgoingCall' @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class EntityInfo: # @ApiMember(Description="The ID of the object") id: Optional[str] = None """ The ID of the object """ # @ApiMember(Description="The date the object was created") date_created: Optional[str] = None """ The date the object was created """ # @ApiMember(Description="The date the object was last modified") date_last_modified: Optional[str] = None """ The date the object was last modified """ # @ApiMember(Description="The user that created this object") created_by: Optional[str] = None """ The user that created this object """ # @ApiMember(Description="The user that last modified this object") last_modified_by: Optional[str] = None """ The user that last modified this object """ T = TypeVar('T') @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ListResponse(Generic[T]): # @ApiMember(Description="The items") items: Optional[List[T]] = None """ The items """ # @ApiMember(Description="The total number of items") total_count: int = 0 """ The total number of items """ # @ApiMember(Description="The total number of pages") total_pages: int = 0 """ The total number of pages """ # @ApiMember(Description="Are there more pages of items? Used with simplified paging") has_more_pages: bool = False """ Are there more pages of items? Used with simplified paging """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class CustomerBreadcrumb: id: Optional[str] = None name: Optional[str] = None @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class NotificationRecipientInfo: # @ApiMember(Description="The address of the recipient") address: Optional[str] = None """ The address of the recipient """ # @ApiMember(Description="Extra info about the recipient e.g. CC, BCC") extra: Optional[str] = None """ Extra info about the recipient e.g. CC, BCC """ # @ApiMember(Description="The name of the recipient") name: Optional[str] = None """ The name of the recipient """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class FileInfo(EntityInfo): # @ApiMember(Description="The type of file this is") type: Optional[FileTypes] = None """ The type of file this is """ # @ApiMember(Description="The account ID this file is associated with") account_id: Optional[str] = None """ The account ID this file is associated with """ # @ApiMember(Description="The name of the account this file is associated with") account_name: Optional[str] = None """ The name of the account this file is associated with """ # @ApiMember(Description="The ID of the customer this file is associated with") customer_id: Optional[str] = None """ The ID of the customer this file is associated with """ # @ApiMember(Description="The name of the customer this file is associated with") customer_name: Optional[str] = None """ The name of the customer this file is associated with """ # @ApiMember(Description="The breadcrumb to the customer for this file") customer_breadcrumb: Optional[List[CustomerBreadcrumb]] = None """ The breadcrumb to the customer for this file """ # @ApiMember(Description="The ID of the user this file is assocaited with") user_id: Optional[str] = None """ The ID of the user this file is assocaited with """ # @ApiMember(Description="The name of the user this file is associated with") user_name: Optional[str] = None """ The name of the user this file is associated with """ # @ApiMember(Description="The original file name for the file") file_name: Optional[str] = None """ The original file name for the file """ # @ApiMember(Description="The URI of the file") uri: Optional[str] = None """ The URI of the file """ # @ApiMember(Description="The Content type of the file") content_type: Optional[str] = None """ The Content type of the file """ # @ApiMember(Description="The size of the file") content_length: int = 0 """ The size of the file """ # @ApiMember(Description="The Twilio ID of the recording") recording_sid: Optional[str] = None """ The Twilio ID of the recording """ # @ApiMember(Description="The duration of the recording in seconds") recording_duration: int = 0 """ The duration of the recording in seconds """ # @ApiMember(Description="Who is the recording from?") recording_from: Optional[str] = None """ Who is the recording from? """ # @ApiMember(Description="Transcription (if available)") transcription: Optional[str] = None """ Transcription (if available) """ # @ApiMember(Description="From Address (e.g. caller ID) for incoming calls") from_address: Optional[str] = None """ From Address (e.g. caller ID) for incoming calls """ # @ApiMember(Description="To Address (e.g. dialed number) for outgoing calls") to_address: Optional[str] = None """ To Address (e.g. dialed number) for outgoing calls """ # @ApiMember(Description="The AI transcription for this call") ai_transcription: Optional[str] = None """ The AI transcription for this call """ @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class NotificationInfo(EntityInfo): # @ApiMember(Description="The account ID this endpoint is associated with") account_id: Optional[str] = None """ The account ID this endpoint is associated with """ # @ApiMember(Description="The name of the account this endpoint is associated with") account_name: Optional[str] = None """ The name of the account this endpoint is associated with """ # @ApiMember(Description="The ID of the customer this endpoint is associated with") customer_id: Optional[str] = None """ The ID of the customer this endpoint is associated with """ # @ApiMember(Description="The name of the customer this endpoint is associated with") customer_name: Optional[str] = None """ The name of the customer this endpoint is associated with """ # @ApiMember(Description="The breadcrumb to the customer for this endpoint") customer_breadcrumb: Optional[List[CustomerBreadcrumb]] = None """ The breadcrumb to the customer for this endpoint """ # @ApiMember(Description="The type of notification") type: Optional[NotificationTypes] = None """ The type of notification """ # @ApiMember(Description="The subject of the notification") subject: Optional[str] = None """ The subject of the notification """ # @ApiMember(Description="The body of the notification") body: Optional[str] = None """ The body of the notification """ # @ApiMember(Description="The recipients of this notification") recipients: Optional[List[NotificationRecipientInfo]] = None """ The recipients of this notification """ # @ApiMember(Description="The list of attachments") attachments: Optional[List[FileInfo]] = None """ The list of attachments """ # @ApiMember(Description="The original from for the session") from_: Optional[str] = field(metadata=config(field_name='from'), default=None) """ The original from for the session """ # @ApiMember(Description="The original To for the session") to: Optional[str] = None """ The original To for the session """ # @ApiMember(Description="Was there an error?") error: bool = False """ Was there an error? """ # @ApiMember(Description="The error message") error_message: Optional[str] = None """ The error message """ # @Route("/notifications", "GET") # @Api(Description="Lists all endpoints") @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ListNotifications(ListRequest[NotificationInfo], IReturn[ListResponse[NotificationInfo]]): """ Lists all endpoints """ # @ApiMember(Description="The IDs of the account whose notifications you want to retrieve") account_ids: Optional[List[str]] = None """ The IDs of the account whose notifications you want to retrieve """ # @ApiMember(Description="The IDs of the customers whose notifications you want to retrieve") customer_ids: Optional[List[str]] = None """ The IDs of the customers whose notifications you want to retrieve """ # @ApiMember(Description="Filter by From") from_filter: Optional[str] = None """ Filter by From """ # @ApiMember(Description="Filter by To") to_filter: Optional[str] = None """ Filter by To """ # @ApiMember(Description="Filter by Subject") subject_filter: Optional[str] = None """ Filter by Subject """ # @ApiMember(Description="The start date to retrieve usage records for (YYYY-MM-DD)") start_date: Optional[str] = None """ The start date to retrieve usage records for (YYYY-MM-DD) """ # @ApiMember(Description="The end date to retrieve usage records for (YYYY-MM-DD)") end_date: Optional[str] = None """ The end date to retrieve usage records for (YYYY-MM-DD) """ # @ApiMember(Description="Filter by type") type: Optional[NotificationTypes] = None """ Filter by type """