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
{
/** @description The page of data to retrieve */
// @ApiMember(Description="The page of data to retrieve")
public page: number;
/** @description 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;
/** @description The number per page to retrieve */
// @ApiMember(Description="The number per page to retrieve")
public countPerPage: number;
/** @description Specific IDs */
// @ApiMember(Description="Specific IDs")
public specificIds: string[];
/** @description Specify a sort field */
// @ApiMember(Description="Specify a sort field")
public sortField: string;
/** @description Specify a sort order */
// @ApiMember(Description="Specify a sort order")
public sortOrder: SortOrders;
/** @description 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
{
/** @description The ID of the object */
// @ApiMember(Description="The ID of the object")
public id: string;
/** @description The date the object was created */
// @ApiMember(Description="The date the object was created")
public dateCreated: string;
/** @description The date the object was last modified */
// @ApiMember(Description="The date the object was last modified")
public dateLastModified: string;
/** @description The user that created this object */
// @ApiMember(Description="The user that created this object")
public createdBy: string;
/** @description 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
{
/** @description The account ID this endpoint is associated with */
// @ApiMember(Description="The account ID this endpoint is associated with")
public accountId: string;
/** @description 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;
/** @description 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;
/** @description 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;
/** @description 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>
{
/** @description 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[];
/** @description 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[];
/** @description 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;
/** @description 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;
/** @description 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 aiInsights: BillingItem;
public aiLiveMinutes: BillingItem;
public constructor(init?: Partial<BillingSettings>) { (Object as any).assign(this, init); }
}
export class AccountInfo extends EntityInfo
{
/** @description The name of this account */
// @ApiMember(Description="The name of this account")
public name: string;
/** @description The ID of this account's parent */
// @ApiMember(Description="The ID of this account's parent")
public parentAccountId: string;
/** @description The twilio account SID */
// @ApiMember(Description="The twilio account SID")
public twilioAccountSid: string;
/** @description The ancestors of this account. Useful for breadcrumbs */
// @ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
public ancestorIds: string[];
/** @description 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;
/** @description This account is BYOA */
// @ApiMember(Description="This account is BYOA")
public isBYOA: boolean;
/** @description TrustHub Profile Sid */
// @ApiMember(Description="TrustHub Profile Sid")
public trustHubProfileSid: string;
/** @description The ID of the logo file */
// @ApiMember(Description="The ID of the logo file")
public logoId: string;
/** @description The URI of the logo file */
// @ApiMember(Description="The URI of the logo file")
public logoUri: string;
/** @description 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<T>
{
/** @description The items */
// @ApiMember(Description="The items")
public items: AccountInfo[];
/** @description The total number of items */
// @ApiMember(Description="The total number of items")
public totalCount: number;
/** @description The total number of pages */
// @ApiMember(Description="The total number of pages")
public totalPages: number;
/** @description 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<T>>) { (Object as any).assign(this, init); }
}
TypeScript ListLogEntries DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/ListLogEntries HTTP/1.1
Host: team.evovoice.io
Accept: application/json
Content-Type: application/json
Content-Length: length
{"accountIds":["String"],"customerIds":["String"],"startDate":"String","endDate":"String","description":"String","page":0,"all":false,"countPerPage":0,"specificIds":["String"],"sortField":"String","sortOrder":"Ascend","simplifiedPaging":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"items":[{"accountId":"String","accountName":"String","customerId":"String","customerName":"String","customerBreadcrumb":[{"id":"String","name":"String"}],"userName":"String","description":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}],"totalCount":0,"totalPages":0,"hasMorePages":false}