Evo Voice

<back to all web services

ListLogEntries



export class NodeParameterMap
{
    [key:string] : NodeParameter;

    public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}


export enum SortOrders
{
    Ascend = 'Ascend',
    Descend = 'Descend',
}

export class ListRequest<T> implements IGet
{
    /**
    * The page of data to retrieve
    */
    // @ApiMember(Description="The page of data to retrieve")
    public page?: number;

    /**
    * If you want all objects to be returned. This should be used with care
    */
    // @ApiMember(Description="If you want all objects to be returned. This should be used with care")
    public all?: boolean;

    /**
    * The number per page to retrieve
    */
    // @ApiMember(Description="The number per page to retrieve")
    public countPerPage?: number;

    /**
    * Specific IDs
    */
    // @ApiMember(Description="Specific IDs")
    public specificIds?: string[];

    /**
    * Specify a sort field
    */
    // @ApiMember(Description="Specify a sort field")
    public sortField?: string;

    /**
    * Specify a sort order
    */
    // @ApiMember(Description="Specify a sort order")
    public sortOrder?: SortOrders;

    /**
    * Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
    */
    // @ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")
    public simplifiedPaging?: boolean;

    public constructor(init?: Partial<ListRequest<T>>) { (Object as any).assign(this, init); }
}

export class EntityInfo
{
    /**
    * The ID of the object
    */
    // @ApiMember(Description="The ID of the object")
    public id?: string;

    /**
    * The date the object was created
    */
    // @ApiMember(Description="The date the object was created")
    public dateCreated?: string;

    /**
    * The date the object was last modified
    */
    // @ApiMember(Description="The date the object was last modified")
    public dateLastModified?: string;

    /**
    * The user that created this object
    */
    // @ApiMember(Description="The user that created this object")
    public createdBy?: string;

    /**
    * The user that last modified this object
    */
    // @ApiMember(Description="The user that last modified this object")
    public lastModifiedBy?: string;

    public constructor(init?: Partial<EntityInfo>) { (Object as any).assign(this, init); }
}

export class CustomerBreadcrumb
{
    public id?: string;
    public name?: string;

    public constructor(init?: Partial<CustomerBreadcrumb>) { (Object as any).assign(this, init); }
}

export class LogEntryInfo extends EntityInfo
{
    /**
    * The account ID this endpoint is associated with
    */
    // @ApiMember(Description="The account ID this endpoint is associated with")
    public accountId?: string;

    /**
    * The name of the account this endpoint is associated with
    */
    // @ApiMember(Description="The name of the account this endpoint is associated with")
    public accountName?: string;

    /**
    * The ID of the customer this endpoint is associated with
    */
    // @ApiMember(Description="The ID of the customer this endpoint is associated with")
    public customerId?: string;

    /**
    * The name of the customer this endpoint is associated with
    */
    // @ApiMember(Description="The name of the customer this endpoint is associated with")
    public customerName?: string;

    /**
    * The breadcrumb to the customer for this endpoint
    */
    // @ApiMember(Description="The breadcrumb to the customer for this endpoint")
    public customerBreadcrumb?: CustomerBreadcrumb[];

    public userName?: string;
    public description?: string;

    public constructor(init?: Partial<LogEntryInfo>) { super(init); (Object as any).assign(this, init); }
}

export class ListLogEntries extends ListRequest<LogEntryInfo>
{
    /**
    * The IDs of the account whose log entries you want to retrieve
    */
    // @ApiMember(Description="The IDs of the account whose log entries you want to retrieve")
    public accountIds?: string[];

    /**
    * The IDs of the customers whose log entries you want to retrieve
    */
    // @ApiMember(Description="The IDs of the customers whose log entries you want to retrieve")
    public customerIds?: string[];

    /**
    * The start date to retrieve usage records for (YYYY-MM-DD)
    */
    // @ApiMember(Description="The start date to retrieve usage records for (YYYY-MM-DD)")
    public startDate?: string;

    /**
    * The end date to retrieve logs for (YYYY-MM-DD)
    */
    // @ApiMember(Description="The end date to retrieve logs for (YYYY-MM-DD)")
    public endDate?: string;

    /**
    * Search by description
    */
    // @ApiMember(Description="Search by description")
    public description?: string;

    public constructor(init?: Partial<ListLogEntries>) { super(init); (Object as any).assign(this, init); }
}

export class BillingItem
{
    public baseCost?: number;
    public rawUnitMultiplier?: number;
    public unitCost?: number;
    public allowance?: number;

    public constructor(init?: Partial<BillingItem>) { (Object as any).assign(this, init); }
}

export class BillingSettings
{
    public base?: BillingItem;
    public localNumbers?: BillingItem;
    public tollFreeNumbers?: BillingItem;
    public inboundVoiceCalls?: BillingItem;
    public outboundVoiceCalls?: BillingItem;
    public inboundFaxes?: BillingItem;
    public outboundFaxes?: BillingItem;
    public inboundSmsMessages?: BillingItem;
    public outboundSmsMessages?: BillingItem;

    public constructor(init?: Partial<BillingSettings>) { (Object as any).assign(this, init); }
}

export class AccountInfo extends EntityInfo
{
    /**
    * The name of this account
    */
    // @ApiMember(Description="The name of this account")
    public name?: string;

    /**
    * The ID of this account's parent
    */
    // @ApiMember(Description="The ID of this account's parent")
    public parentAccountId?: string;

    /**
    * The twilio account SID
    */
    // @ApiMember(Description="The twilio account SID")
    public twilioAccountSid?: string;

    /**
    * The ancestors of this account. Useful for breadcrumbs
    */
    // @ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
    public ancestorIds?: string[];

    /**
    * The max number of phone numbers this account can have
    */
    // @ApiMember(Description="The max number of phone numbers this account can have")
    public maxPhoneNumbers?: number;

    /**
    * This account is BYOA
    */
    // @ApiMember(Description="This account is BYOA")
    public isBYOA?: boolean;

    /**
    * TrustHub Profile Sid
    */
    // @ApiMember(Description="TrustHub Profile Sid")
    public trustHubProfileSid?: string;

    /**
    * The ID of the logo file
    */
    // @ApiMember(Description="The ID of the logo file")
    public logoId?: string;

    /**
    * The URI of the logo file
    */
    // @ApiMember(Description="The URI of the logo file")
    public logoUri?: string;

    /**
    * The billing settings for this account
    */
    // @ApiMember(Description="The billing settings for this account")
    public billingSettings?: BillingSettings;

    public constructor(init?: Partial<AccountInfo>) { super(init); (Object as any).assign(this, init); }
}

export class ListResponse<AccountInfo>
{
    /**
    * The items
    */
    // @ApiMember(Description="The items")
    public items?: AccountInfo[];

    /**
    * The total number of items
    */
    // @ApiMember(Description="The total number of items")
    public totalCount?: number;

    /**
    * The total number of pages
    */
    // @ApiMember(Description="The total number of pages")
    public totalPages?: number;

    /**
    * Are there more pages of items? Used with simplified paging
    */
    // @ApiMember(Description="Are there more pages of items? Used with simplified paging")
    public hasMorePages?: boolean;

    public constructor(init?: Partial<ListResponse<AccountInfo>>) { (Object as any).assign(this, init); }
}

TypeScript ListLogEntries DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/ListLogEntries HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ListLogEntries xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Sys">
  <All xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">false</All>
  <CountPerPage xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">0</CountPerPage>
  <Page xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">0</Page>
  <SimplifiedPaging xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">false</SimplifiedPaging>
  <SortField xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</SortField>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">Ascend</SortOrder>
  <SpecificIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
    <d2p1:string>String</d2p1:string>
  </SpecificIds>
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountIds>
  <CustomerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CustomerIds>
  <Description>String</Description>
  <EndDate>String</EndDate>
  <StartDate>String</StartDate>
</ListLogEntries>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListResponseOfLogEntryInfo8IExZRHp 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.Sys">
    <d2p1:LogEntryInfo>
      <CreatedBy>String</CreatedBy>
      <DateCreated>String</DateCreated>
      <DateLastModified>String</DateLastModified>
      <Id>String</Id>
      <LastModifiedBy>String</LastModifiedBy>
      <d2p1:AccountId>String</d2p1:AccountId>
      <d2p1:AccountName>String</d2p1:AccountName>
      <d2p1:CustomerBreadcrumb xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Customers">
        <d4p1:CustomerBreadcrumb>
          <d4p1:Id>String</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
        </d4p1:CustomerBreadcrumb>
      </d2p1:CustomerBreadcrumb>
      <d2p1:CustomerId>String</d2p1:CustomerId>
      <d2p1:CustomerName>String</d2p1:CustomerName>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:LogEntryInfo>
  </Items>
  <TotalCount>0</TotalCount>
  <TotalPages>0</TotalPages>
</ListResponseOfLogEntryInfo8IExZRHp>