| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /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 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); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers HTTP/1.1 Host: team.evovoice.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
items:
[
{
accountId: String,
parentCustomerId: String,
breadcrumb:
[
{
id: String,
name: String
}
],
accountName: String,
isStaging: False,
name: String,
referenceId: String,
tags:
[
{
id: String,
name: String,
color: Magenta
}
],
schedule:
{
timeZoneId: String,
inherit: False,
forceClosed: False,
rules:
[
{
id: String,
name: String,
priority: 0,
state: String,
source: String,
condition: String,
simpleRuleType: Always,
customerState: String,
flowId: String,
isAllDay: False,
startDate: String,
startTime: String,
endTime: String,
bySetPosition:
[
0
],
byMonth:
[
0
],
byWeekNo:
[
0
],
byYearDay:
[
0
],
byMonthDay:
[
0
],
byDay:
[
{
offset: 0,
dayOfWeek: Sunday
}
],
byHour:
[
0
],
byMinute:
[
0
],
interval: 0,
count: 0,
untilDate: String,
frequency: None
}
],
defaultState: String
},
integrationData:
{
String:
{
thirdPartyId: String
}
},
overrideBillingSettings: False,
billingSettings:
{
base:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
localNumbers:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
tollFreeNumbers:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
inboundVoiceCalls:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
outboundVoiceCalls:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
inboundFaxes:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
outboundFaxes:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
inboundSmsMessages:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
outboundSmsMessages:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
aiInsights:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
},
aiLiveMinutes:
{
baseCost: 0,
rawUnitMultiplier: 0,
unitCost: 0,
allowance: 0
}
},
overrideAppSettings: False,
appSettings:
{
enablePhoneNumberManagement: False,
enableDeviceManagement: False,
enableDialer: False,
enableCallHistory: False,
enableAssistants: False,
showFileNameInMessageCenter: False,
chakraTheme: String,
customCss: String,
pageTitle: String,
stringMappings: String,
logoutUrl: String,
portMyNumberUrl: String
},
id: String,
dateCreated: String,
dateLastModified: String,
createdBy: String,
lastModifiedBy: String
}
],
totalCount: 0,
totalPages: 0,
hasMorePages: False
}