| GET | /accounts |
|---|
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: Optional[int] = None
"""
The page of data to retrieve
"""
# @ApiMember(Description="If you want all objects to be returned. This should be used with care")
all: Optional[bool] = None
"""
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: Optional[int] = None
"""
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: Optional[bool] = None
"""
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]
@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
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingItem:
base_cost: Optional[float] = None
raw_unit_multiplier: Optional[float] = None
unit_cost: Optional[float] = None
allowance: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingSettings:
base: Optional[BillingItem] = None
local_numbers: Optional[BillingItem] = None
toll_free_numbers: Optional[BillingItem] = None
inbound_voice_calls: Optional[BillingItem] = None
outbound_voice_calls: Optional[BillingItem] = None
inbound_faxes: Optional[BillingItem] = None
outbound_faxes: Optional[BillingItem] = None
inbound_sms_messages: Optional[BillingItem] = None
outbound_sms_messages: Optional[BillingItem] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccountInfo(EntityInfo):
# @ApiMember(Description="The name of this account")
name: Optional[str] = None
"""
The name of this account
"""
# @ApiMember(Description="The ID of this account's parent")
parent_account_id: Optional[str] = None
"""
The ID of this account's parent
"""
# @ApiMember(Description="The twilio account SID")
twilio_account_sid: Optional[str] = None
"""
The twilio account SID
"""
# @ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
ancestor_ids: Optional[List[str]] = None
"""
The ancestors of this account. Useful for breadcrumbs
"""
# @ApiMember(Description="The max number of phone numbers this account can have")
max_phone_numbers: Optional[int] = None
"""
The max number of phone numbers this account can have
"""
# @ApiMember(Description="This account is BYOA")
is_b_y_o_a: Optional[bool] = None
"""
This account is BYOA
"""
# @ApiMember(Description="TrustHub Profile Sid")
trust_hub_profile_sid: Optional[str] = None
"""
TrustHub Profile Sid
"""
# @ApiMember(Description="The ID of the logo file")
logo_id: Optional[str] = None
"""
The ID of the logo file
"""
# @ApiMember(Description="The URI of the logo file")
logo_uri: Optional[str] = None
"""
The URI of the logo file
"""
# @ApiMember(Description="The billing settings for this account")
billing_settings: Optional[BillingSettings] = None
"""
The billing settings for this account
"""
# @Api(Description="Retrieve a list of accounts")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListAccounts(ListRequest[AccountInfo]):
"""
Retrieve a list of accounts
"""
# @ApiMember(Description="Filter the results by name")
name_filter: Optional[str] = None
"""
Filter the results by name
"""
AccountInfo = TypeVar('AccountInfo')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListResponse(Generic[AccountInfo]):
# @ApiMember(Description="The items")
items: Optional[List[AccountInfo]] = None
"""
The items
"""
# @ApiMember(Description="The total number of items")
total_count: Optional[int] = None
"""
The total number of items
"""
# @ApiMember(Description="The total number of pages")
total_pages: Optional[int] = None
"""
The total number of pages
"""
# @ApiMember(Description="Are there more pages of items? Used with simplified paging")
has_more_pages: Optional[bool] = None
"""
Are there more pages of items? Used with simplified paging
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /accounts HTTP/1.1 Host: evovoice.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListResponseOfAccountInfoLIonMsk5 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
<HasMorePages>false</HasMorePages>
<Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Accounts">
<d2p1:AccountInfo>
<CreatedBy>String</CreatedBy>
<DateCreated>String</DateCreated>
<DateLastModified>String</DateLastModified>
<Id>String</Id>
<LastModifiedBy>String</LastModifiedBy>
<d2p1:AncestorIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:AncestorIds>
<d2p1:BillingSettings>
<d2p1:Base>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:Base>
<d2p1:InboundFaxes>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:InboundFaxes>
<d2p1:InboundSmsMessages>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:InboundSmsMessages>
<d2p1:InboundVoiceCalls>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:InboundVoiceCalls>
<d2p1:LocalNumbers>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:LocalNumbers>
<d2p1:OutboundFaxes>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:OutboundFaxes>
<d2p1:OutboundSmsMessages>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:OutboundSmsMessages>
<d2p1:OutboundVoiceCalls>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:OutboundVoiceCalls>
<d2p1:TollFreeNumbers>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:TollFreeNumbers>
</d2p1:BillingSettings>
<d2p1:IsBYOA>false</d2p1:IsBYOA>
<d2p1:LogoId>String</d2p1:LogoId>
<d2p1:LogoUri>String</d2p1:LogoUri>
<d2p1:MaxPhoneNumbers>0</d2p1:MaxPhoneNumbers>
<d2p1:Name>String</d2p1:Name>
<d2p1:ParentAccountId>String</d2p1:ParentAccountId>
<d2p1:TrustHubProfileSid>String</d2p1:TrustHubProfileSid>
<d2p1:TwilioAccountSid>String</d2p1:TwilioAccountSid>
</d2p1:AccountInfo>
</Items>
<TotalCount>0</TotalCount>
<TotalPages>0</TotalPages>
</ListResponseOfAccountInfoLIonMsk5>