interface HaloPSANodeParameters {
additionalFields?:
| {
inactive?: boolean;
is_vip?: boolean;
notes?: string;
website?: string;
}
| {
agent_id?: string;
startdate?: string;
targetdate?: string;
}
| {
maincontact_name?: string;
notes?: string;
phonenumber?: string;
}
| {
emailaddress?: string;
inactive?: boolean;
notes?: string;
password?: string;
surname?: string;
};
clientId?: string;
clientName?: string;
details?: string;
filters?: {
activeStatus?: "all"
| "active"
| "inactive";
search?: string;
};
limit?: number;
operation?: | "create"
| "get"
| "getAll"
| "update"
| "delete";
resource?: "user"
| "client"
| "ticket"
| "site";
returnAll?: boolean;
selectOption?: boolean;
simplify?: boolean;
siteId?: string;
siteName?: string;
summary?: string;
ticketId?: string;
ticketType?: string;
updateFields?:
| {
inactive?: boolean;
is_vip?: boolean;
name?: string;
notes?: string;
website?: string;
}
| {
agent_id?: string;
details?: string;
startdate?: string;
summary?: string;
targetdate?: string;
}
| {
client_id?: string;
maincontact_name?: string;
name?: string;
notes?: string;
phonenumber?: string;
}
| {
emailaddress?: string;
inactive?: boolean;
name?: string;
notes?: string;
password?: string;
site_id?: string;
surname?: string;
};
userId?: string;
userName?: string;
}Properties§
Source§readonly additional
| {
inactive?: boolean;
is_vip?: boolean;
notes?: string;
website?: string;
}
| {
agent_id?: string;
startdate?: string;
targetdate?: string;
}
| {
maincontact_name?: string;
notes?: string;
phonenumber?: string;
}
| {
emailaddress?: string;
inactive?: boolean;
notes?: string;
password?: string;
surname?: string;
}
readonly additional
| {
inactive?: boolean;
is_vip?: boolean;
notes?: string;
website?: string;
}
| {
agent_id?: string;
startdate?: string;
targetdate?: string;
}
| {
maincontact_name?: string;
notes?: string;
phonenumber?: string;
}
| {
emailaddress?: string;
inactive?: boolean;
notes?: string;
password?: string;
surname?: string;
}
Source§readonly filters?: {
activeStatus?: "all" | "active" | "inactive";
search?: string;
}
readonly filters?: {
activeStatus?: "all" | "active" | "inactive";
search?: string;
}
Default: {}
Source§readonly limit?: number
readonly limit?: number
Max number of results to return Default: 50 Type options: {"minValue":1,"maxValue":1000}
Source§readonly simplify?: boolean
readonly simplify?: boolean
Whether to return a simplified version of the response instead of the raw data Default: true
Source§readonly ticket
readonly ticket
Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getHaloPSATicketsTypes"}
Source§readonly update
| {
inactive?: boolean;
is_vip?: boolean;
name?: string;
notes?: string;
website?: string;
}
| {
agent_id?: string;
details?: string;
startdate?: string;
summary?: string;
targetdate?: string;
}
| {
client_id?: string;
maincontact_name?: string;
name?: string;
notes?: string;
phonenumber?: string;
}
| {
emailaddress?: string;
inactive?: boolean;
name?: string;
notes?: string;
password?: string;
site_id?: string;
surname?: string;
}
readonly update
| {
inactive?: boolean;
is_vip?: boolean;
name?: string;
notes?: string;
website?: string;
}
| {
agent_id?: string;
details?: string;
startdate?: string;
summary?: string;
targetdate?: string;
}
| {
client_id?: string;
maincontact_name?: string;
name?: string;
notes?: string;
phonenumber?: string;
}
| {
emailaddress?: string;
inactive?: boolean;
name?: string;
notes?: string;
password?: string;
site_id?: string;
surname?: string;
}
Default: {}
Default: {}