Evo Voice

<back to all web services

EndpointsReport

This report returns all of the endpoints broken down by type per tab

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

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


export class ReportRequest implements IPost
{
    /**
    * The account ID this report should be run for
    */
    // @ApiMember(Description="The account ID this report should be run for")
    public accountId?: string;

    /**
    * The email address to notify after the report is run
    */
    // @ApiMember(Description="The email address to notify after the report is run")
    public emailAddressToNotify?: string;

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

export enum ReportStatuses
{
    Queued = 'Queued',
    Running = 'Running',
    Completed = 'Completed',
    Error = 'Error',
}

export class ReportInfo
{
    public id?: string;
    public name?: string;
    public status?: ReportStatuses;
    public statusMessage?: string;
    public dateCreated?: string;
    public dateUpdated?: string;
    public downloadLink?: string;
    public jobId?: string;
    public emailAddressToNotify?: string;
    public server?: string;

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

export enum EndpointTypes
{
    PhoneNumber = 'PhoneNumber',
    User = 'User',
    FaxNumber = 'FaxNumber',
    EmailAddress = 'EmailAddress',
    Unused_1 = 'Unused_1',
    Unused_2 = 'Unused_2',
    Unused_3 = 'Unused_3',
    Unused_4 = 'Unused_4',
    Unused_5 = 'Unused_5',
    Team = 'Team',
}

/**
* This report returns all of the endpoints broken down by type per tab
*/
// @Api(Description="This report returns all of the endpoints broken down by type per tab")
export class EndpointsReport extends ReportRequest
{
    /**
    * The types of endpoints to return
    */
    // @ApiMember(Description="The types of endpoints to return")
    public types?: EndpointTypes[];

    /**
    * Filter by specific customer
    */
    // @ApiMember(Description="Filter by specific customer")
    public customerId?: string;

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

TypeScript EndpointsReport DTOs

GET /reports/endpoints HTTP/1.1 
Host: evovoice.io 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":"String","name":"String","status":"Queued","statusMessage":"String","dateCreated":"String","dateUpdated":"String","downloadLink":"String","jobId":"String","emailAddressToNotify":"String","server":"String"}