Evo Voice

<back to all web services

ListCustomers

Retrieve customers

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 Value
{
    public boolValue?: boolean;
    public stringValue: string;
    public numberValue?: number;
    public listValue: Struct[];
    public structValue: Struct;

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

export class Struct
{

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

export enum TagColors
{
    Magenta = 'Magenta',
    Red = 'Red',
    Volcano = 'Volcano',
    Orange = 'Orange',
    Gold = 'Gold',
    Lime = 'Lime',
    Green = 'Green',
    Cyan = 'Cyan',
    Blue = 'Blue',
    GeekBlue = 'GeekBlue',
    Purple = 'Purple',
}

export class Tag
{
    public id: string;
    public name: string;
    public color: TagColors;

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

export enum SimpleSchedulingRuleTypes
{
    Always = 'Always',
    CustomerState = 'CustomerState',
    Time = 'Time',
}

export class ScheduleDay
{
    public offset: number;
    public dayOfWeek: DayOfWeek;

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

export enum SchedulingRuleFrequency
{
    None = 'None',
    Secondly = 'Secondly',
    Minutely = 'Minutely',
    Hourly = 'Hourly',
    Daily = 'Daily',
    Weekly = 'Weekly',
    Monthly = 'Monthly',
    Yearly = 'Yearly',
}

export class SchedulingRule
{
    public id: string;
    public name: string;
    public priority: number;
    public state: string;
    public source: string;
    public condition: string;
    public simpleRuleType: SimpleSchedulingRuleTypes;
    public customerState: string;
    public flowId: string;
    public flowParams: Struct;
    public isAllDay: boolean;
    public startDate: string;
    public startTime: string;
    public endTime: string;
    public bySetPosition: number[];
    public byMonth: number[];
    public byWeekNo: number[];
    public byYearDay: number[];
    public byMonthDay: number[];
    public byDay: ScheduleDay[];
    public byHour: number[];
    public byMinute: number[];
    public interval: number;
    public count: number;
    public untilDate: string;
    public frequency: SchedulingRuleFrequency;

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

export class Schedule
{
    public timeZoneId: string;
    public inherit: boolean;
    public forceClosed: boolean;
    public rules: SchedulingRule[];
    public defaultState: string;

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

export class IntegrationData
{
    public thirdPartyId: string;

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

export class Dictionary<T> { [Key: string]: T; }

export class EntityIntegrationData extends Dictionary<IntegrationData>
{

    public constructor(init?: Partial<EntityIntegrationData>) { super(); (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 aiMessages: BillingItem;

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

export class AppSettings
{
    public enablePhoneNumberManagement: boolean;
    public enableDeviceManagement: boolean;
    public enableDialer: boolean;
    public enableCallHistory: boolean;
    public enableAssistants: boolean;
    public showFileNameInMessageCenter: boolean;
    public chakraTheme: string;
    public customCss: string;
    public pageTitle: string;
    public stringMappings: string;
    public logoutUrl: string;
    public portMyNumberUrl: string;

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

export class CustomerInfo extends EntityInfo
{
    /** @description The ID of the account associated with this customer */
    // @ApiMember(Description="The ID of the account associated with this customer")
    public accountId: string;

    /** @description The parent customer ID for this customer */
    // @ApiMember(Description="The parent customer ID for this customer")
    public parentCustomerId: string;

    /** @description The breadcrumb to this customer */
    // @ApiMember(Description="The breadcrumb to this customer")
    public breadcrumb: CustomerBreadcrumb[];

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

    /** @description Is this customer staging or production? */
    // @ApiMember(Description="Is this customer staging or production?")
    public isStaging: boolean;

    /** @description The name of the company */
    // @ApiMember(Description="The name of the company")
    public name: string;

    /** @description The reference ID for this company */
    // @ApiMember(Description="The reference ID for this company")
    public referenceId: string;

    /** @description This customer's data values */
    // @ApiMember(Description="This customer's data values")
    public data: Struct;

    /** @description The list of tags for this customer */
    // @ApiMember(Description="The list of tags for this customer")
    public tags: Tag[];

    /** @description This customer's schedule */
    // @ApiMember(Description="This customer's schedule")
    public schedule: Schedule;

    /** @description Integration data for this customer */
    // @ApiMember(Description="Integration data for this customer")
    public integrationData: EntityIntegrationData;

    /** @description Override this customer's billing settings? Otherwise inherits from parent */
    // @ApiMember(Description="Override this customer's billing settings? Otherwise inherits from parent")
    public overrideBillingSettings: boolean;

    /** @description Billing settings for this customer */
    // @ApiMember(Description="Billing settings for this customer")
    public billingSettings: BillingSettings;

    /** @description Should this customer override the parent customer's app settings */
    // @ApiMember(Description="Should this customer override the parent customer's app settings")
    public overrideAppSettings: boolean;

    /** @description App / Portal settings for this customer */
    // @ApiMember(Description="App / Portal settings for this customer")
    public appSettings: AppSettings;

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

/** @description Retrieve customers */
// @Api(Description="Retrieve customers")
export class ListCustomers extends ListRequest<CustomerInfo>
{
    /** @description Filter by accounts */
    // @ApiMember(Description="Filter by accounts")
    public accountIds: string[];

    /** @description Filter by name */
    // @ApiMember(Description="Filter by name")
    public nameFilter: string;

    /** @description The IDs of the parent customers you want to filter by */
    // @ApiMember(Description="The IDs of the parent customers you want to filter by")
    public parentCustomerIds: string[];

    /** @description If you want a shall parent customer filter (e.g. no deep children) */
    // @ApiMember(Description="If you want a shall parent customer filter (e.g. no deep children)")
    public shallowParent: boolean;

    /** @description The list of tag IDs to filter by (must contain all) */
    // @ApiMember(Description="The list of tag IDs to filter by (must contain all)")
    public tagIds: string[];

    public constructor(init?: Partial<ListCustomers>) { super(init); (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 ListCustomers DTOs

GET /customers HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListResponseOfCustomerInfoznfKbIMc 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.Customers">
    <d2p1:CustomerInfo>
      <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:AppSettings>
        <d2p1:ChakraTheme>String</d2p1:ChakraTheme>
        <d2p1:CustomCss>String</d2p1:CustomCss>
        <d2p1:EnableAssistants>false</d2p1:EnableAssistants>
        <d2p1:EnableCallHistory>false</d2p1:EnableCallHistory>
        <d2p1:EnableDeviceManagement>false</d2p1:EnableDeviceManagement>
        <d2p1:EnableDialer>false</d2p1:EnableDialer>
        <d2p1:EnablePhoneNumberManagement>false</d2p1:EnablePhoneNumberManagement>
        <d2p1:LogoutUrl>String</d2p1:LogoutUrl>
        <d2p1:PageTitle>String</d2p1:PageTitle>
        <d2p1:PortMyNumberUrl>String</d2p1:PortMyNumberUrl>
        <d2p1:ShowFileNameInMessageCenter>false</d2p1:ShowFileNameInMessageCenter>
        <d2p1:StringMappings>String</d2p1:StringMappings>
      </d2p1:AppSettings>
      <d2p1:BillingSettings xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Accounts">
        <d4p1:AIInsights>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:AIInsights>
        <d4p1:AILiveMinutes>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:AILiveMinutes>
        <d4p1:AIMessages>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:AIMessages>
        <d4p1:Base>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:Base>
        <d4p1:InboundFaxes>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:InboundFaxes>
        <d4p1:InboundSmsMessages>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:InboundSmsMessages>
        <d4p1:InboundVoiceCalls>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:InboundVoiceCalls>
        <d4p1:LocalNumbers>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:LocalNumbers>
        <d4p1:OutboundFaxes>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:OutboundFaxes>
        <d4p1:OutboundSmsMessages>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:OutboundSmsMessages>
        <d4p1:OutboundVoiceCalls>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:OutboundVoiceCalls>
        <d4p1:TollFreeNumbers>
          <d4p1:Allowance>0</d4p1:Allowance>
          <d4p1:BaseCost>0</d4p1:BaseCost>
          <d4p1:RawUnitMultiplier>0</d4p1:RawUnitMultiplier>
          <d4p1:UnitCost>0</d4p1:UnitCost>
        </d4p1:TollFreeNumbers>
      </d2p1:BillingSettings>
      <d2p1:Breadcrumb>
        <d2p1:CustomerBreadcrumb>
          <d2p1:Id>String</d2p1:Id>
          <d2p1:Name>String</d2p1:Name>
        </d2p1:CustomerBreadcrumb>
      </d2p1:Breadcrumb>
      <d2p1:Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:IntegrationData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringIntegrationDataY_SkqLnhh>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value xmlns:d6p1="http://schemas.datacontract.org/2004/07/Voice.Api.Integrations">
            <d6p1:ThirdPartyId>String</d6p1:ThirdPartyId>
          </d4p1:Value>
        </d4p1:KeyValueOfstringIntegrationDataY_SkqLnhh>
      </d2p1:IntegrationData>
      <d2p1:IsStaging>false</d2p1:IsStaging>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:OverrideAppSettings>false</d2p1:OverrideAppSettings>
      <d2p1:OverrideBillingSettings>false</d2p1:OverrideBillingSettings>
      <d2p1:ParentCustomerId>String</d2p1:ParentCustomerId>
      <d2p1:ReferenceId>String</d2p1:ReferenceId>
      <d2p1:Schedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Scheduling">
        <d4p1:DefaultState>String</d4p1:DefaultState>
        <d4p1:ForceClosed>false</d4p1:ForceClosed>
        <d4p1:Inherit>false</d4p1:Inherit>
        <d4p1:Rules>
          <d4p1:SchedulingRule>
            <d4p1:ByDay>
              <d4p1:ScheduleDay>
                <d4p1:DayOfWeek>Sunday</d4p1:DayOfWeek>
                <d4p1:Offset>0</d4p1:Offset>
              </d4p1:ScheduleDay>
            </d4p1:ByDay>
            <d4p1:ByHour xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </d4p1:ByHour>
            <d4p1:ByMinute xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </d4p1:ByMinute>
            <d4p1:ByMonth xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </d4p1:ByMonth>
            <d4p1:ByMonthDay xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </d4p1:ByMonthDay>
            <d4p1:BySetPosition xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </d4p1:BySetPosition>
            <d4p1:ByWeekNo xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </d4p1:ByWeekNo>
            <d4p1:ByYearDay xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </d4p1:ByYearDay>
            <d4p1:Condition>String</d4p1:Condition>
            <d4p1:Count>0</d4p1:Count>
            <d4p1:CustomerState>String</d4p1:CustomerState>
            <d4p1:EndTime>String</d4p1:EndTime>
            <d4p1:FlowId>String</d4p1:FlowId>
            <d4p1:FlowParams xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
            <d4p1:Frequency>None</d4p1:Frequency>
            <d4p1:Id>String</d4p1:Id>
            <d4p1:Interval>0</d4p1:Interval>
            <d4p1:IsAllDay>false</d4p1:IsAllDay>
            <d4p1:Name>String</d4p1:Name>
            <d4p1:Priority>0</d4p1:Priority>
            <d4p1:SimpleRuleType>Always</d4p1:SimpleRuleType>
            <d4p1:Source>String</d4p1:Source>
            <d4p1:StartDate>String</d4p1:StartDate>
            <d4p1:StartTime>String</d4p1:StartTime>
            <d4p1:State>String</d4p1:State>
            <d4p1:UntilDate>String</d4p1:UntilDate>
          </d4p1:SchedulingRule>
        </d4p1:Rules>
        <d4p1:TimeZoneId>String</d4p1:TimeZoneId>
      </d2p1:Schedule>
      <d2p1:Tags xmlns:d4p1="http://schemas.datacontract.org/2004/07/Voice.Api.Settings">
        <d4p1:Tag>
          <d4p1:Color>Magenta</d4p1:Color>
          <d4p1:Id>String</d4p1:Id>
          <d4p1:Name>String</d4p1:Name>
        </d4p1:Tag>
      </d2p1:Tags>
    </d2p1:CustomerInfo>
  </Items>
  <TotalCount>0</TotalCount>
  <TotalPages>0</TotalPages>
</ListResponseOfCustomerInfoznfKbIMc>