opendesk

1interface DocType {
2    name: string;
3    creation: string;
4    modified: string;
5    owner: string;
6    modified_by: string;
7  }
8
9  interface ChildDocType extends DocType {
10    parent?: string;
11    parentfield?: string;
12    parenttype?: string;
13    idx?: number;
14  }
15  
16// Last updated: 2026-06-26 18:18:39.871707
17export interface ODTicketStatus extends DocType {
18  /** Color: Select */
19  color?: 'Black' | 'Gray' | 'Blue' | 'Green' | 'Red' | 'Pink' | 'Orange' | 'Amber' | 'Yellow' | 'Cyan' | 'Teal' | 'Violet' | 'purple';
20  /** Label: Data */
21  label_agent: string;
22  /** Show end users a different view: Check */
23  different_view: 0 | 1;
24  /** Label (customer view): Data */
25  label_customer?: string;
26  /** Category: Select */
27  category: 'Open' | 'Paused' | 'Resolved';
28  /** Order: Int */
29  order?: number;
30  /** Enabled: Check */
31  enabled: 0 | 1;
32}
33
34// Last updated: 2026-10-18 16:20:00.000000
35export interface ODTicket extends DocType {
36  /** Subject: Data */
37  subject: string;
38  /** Raised By (Email): Data */
39  raised_by?: string;
40  /** Status: Link (OD Ticket Status) */
41  status: string;
42  /** Priority: Link (OD Ticket Priority) */
43  priority?: string;
44  /** Ticket Type: Link (OD Ticket Type) */
45  ticket_type?: string;
46  /** Team: Link (OD Team) */
47  agent_group?: string;
48  /** Ticket Split From: Link (OD Ticket) */
49  ticket_split_from?: string;
50  /** Description: Text Editor */
51  description?: string;
52  /** Template: Link (OD Ticket Template) */
53  template?: string;
54  /** SLA: Link (OD Service Level Agreement) */
55  sla?: string;
56  /** Response By: Datetime */
57  response_by?: string;
58  /** SLA Status: Select */
59  agreement_status?: '' | 'First Response Due' | 'Resolution Due' | 'Failed' | 'Fulfilled' | 'Paused';
60  /** Resolution By: Datetime */
61  resolution_by?: string;
62  /** SLA Creation: Datetime */
63  service_level_agreement_creation?: string;
64  /** On Hold Since: Datetime */
65  on_hold_since?: string;
66  /** Total Hold Time: Duration */
67  total_hold_time?: any;
68  /** First Response Time: Duration */
69  first_response_time?: any;
70  /** First Responded On: Datetime */
71  first_responded_on?: string;
72  /** Average Response Time: Duration */
73  avg_response_time?: any;
74  /** Resolution Details: Text Editor */
75  resolution_details?: string;
76  /** Opening Date: Date */
77  opening_date?: string;
78  /** Opening Time: Time */
79  opening_time?: any;
80  /** Resolution Date: Datetime */
81  resolution_date?: string;
82  /** Resolution Time: Duration */
83  resolution_time?: any;
84  /** User Resolution Time: Duration */
85  user_resolution_time?: any;
86  /** Contact: Link (Contact) */
87  contact?: string;
88  /** Customer: Link (OD Customer) */
89  customer?: string;
90  /** Email Account: Link (Email Account) */
91  email_account?: string;
92  /** Via Customer Portal: Check */
93  via_customer_portal: 0 | 1;
94  /** Feedback (Extra): Long Text */
95  feedback_extra?: any;
96  /** Feedback (Option): Link (OD Ticket Feedback Option) */
97  feedback?: string;
98  /** Rating: Rating */
99  feedback_rating?: any;
100  /** Summary: Text Editor */
101  summary?: string;
102  /** Entry Point: Select */
103  entry_point?: '' | 'Article' | 'Search' | 'Ticket List' | 'Closed Ticket' | 'Direct' | 'External';
104  /** Source Article: Link (OD Article) */
105  source_article?: string;
106  /** Source Search: Data */
107  source_search?: string;
108  /** UTM Source: Data */
109  utm_source?: string;
110  /** Ticket Merged: Check */
111  is_merged: 0 | 1;
112  /** Merged With: Link (OD Ticket) */
113  merged_with?: string;
114  /** Key: Data */
115  key?: string;
116  /** Status Category: Data */
117  status_category?: string;
118  /** Last Agent Response: Datetime */
119  last_agent_response?: string;
120  /** Last Customer Response: Datetime */
121  last_customer_response?: string;
122  /** Ticket raised outside working hours: Check */
123  raised_outside_working_hours: 0 | 1;
124  /** First Response Failed By: Duration */
125  first_response_failed_by?: any;
126  /** Resolution Failed By: Duration */
127  resolution_failed_by?: any;
128}
129
130// Last updated: 2026-03-03 12:30:01.394107
131export interface AssignmentRuleUser extends ChildDocType {
132  /** User: Link (User) */
133  user: string;
134  /** Weight: Int */
135  weight?: number;
136  /** Weight: Int */
137  weight?: number;
138}
139
140// Last updated: 2024-03-23 16:01:27.759155
141export interface AssignmentRuleDay extends ChildDocType {
142  /** Day: Select */
143  day?:
144    | "Monday"
145    | "Tuesday"
146    | "Wednesday"
147    | "Thursday"
148    | "Friday"
149    | "Saturday"
150    | "Sunday";
151}
152
153// Last updated: 2026-03-03 13:08:12.561504
154export interface AssignmentRule extends DocType {
155  /** Document Type: Link (DocType) */
156  document_type: string;
157  /** Priority: Int */
158  priority?: number;
159  /** Disabled: Check */
160  disabled: 0 | 1;
161  /** Description: Small Text */
162  description: string;
163  /** Assign Condition: Code */
164  assign_condition: string;
165  /** Unassign Condition: Code */
166  unassign_condition?: string;
167  /** Rule: Select */
168  rule:
169    | "Round Robin"
170    | "Load Balancing"
171    | "Based on Field"
172    | "Weighted Distribution";
173  /** Users: Table MultiSelect (Assignment Rule User) */
174  users: AssignmentRuleUser[];
175  /** Last User: Link (User) */
176  last_user?: string;
177  /** Close Condition: Code */
178  close_condition?: string;
179  /** Assignment Days: Table (Assignment Rule Day) */
180  assignment_days: AssignmentRuleDay[];
181  /** Due Date Based On: Select */
182  due_date_based_on?: any;
183  /** Field: Select */
184  field?: any;
185  /** Current Index: Int */
186  current_index?: number;
187  /** Users: Table (Assignment Rule User) */
188  weighted_users: AssignmentRuleUser[];
189}
190
191// Last updated: 2021-12-23 19:03:23.507845
192export interface ODHoliday extends ChildDocType {
193  /** Date: Date */
194  holiday_date: string;
195  /** Description: Text Editor */
196  description: string;
197  /** Weekly Off: Check */
198  weekly_off: 0 | 1;
199}
200
201// Last updated: 2026-02-02 12:46:20.573677
202export interface ODServiceHolidayList extends DocType {
203  /** Holiday List Name: Data */
204  holiday_list_name: string;
205  /** From Date: Date */
206  from_date: string;
207  /** To Date: Date */
208  to_date: string;
209  /** Total Holidays: Int */
210  total_holidays?: number;
211  /** Weekly Off: Select */
212  weekly_off?:
213    | ""
214    | "Sunday"
215    | "Monday"
216    | "Tuesday"
217    | "Wednesday"
218    | "Thursday"
219    | "Friday"
220    | "Saturday";
221  /** Holidays: Table (OD Holiday) */
222  holidays: ODHoliday[];
223  /** Color: Color */
224  color?: string;
225  /** Description: Data */
226  description?: string;
227  /** Recurring holidays: JSON */
228  recurring_holidays?: any;
229}
230
231// Last updated: 2021-10-21 14:27:08.190239
232export interface ODServiceDay extends ChildDocType {
233  /** Workday: Select */
234  workday:
235    | "Monday"
236    | "Tuesday"
237    | "Wednesday"
238    | "Thursday"
239    | "Friday"
240    | "Saturday"
241    | "Sunday";
242  /** Start Time: Time */
243  start_time: any;
244  /** End Time: Time */
245  end_time: any;
246}
247
248// Last updated: 2023-03-26 22:41:29.978960
249export interface ODServiceLevelPriority extends ChildDocType {
250  /** Priority: Link (OD Ticket Priority) */
251  priority: string;
252  /** Resolution Time: Duration */
253  resolution_time?: any;
254  /** Default Priority: Check */
255  default_priority: 0 | 1;
256  /** First Response Time: Duration */
257  response_time: any;
258}
259
260// Last updated: 2026-04-30 20:00:06.247098
261export interface ODServiceLevelAgreement extends DocType {
262  /** Service Level Name: Data */
263  service_level: string;
264  /** Holiday List: Link (OD Service Holiday List) */
265  holiday_list: string;
266  /** Start Date: Date */
267  start_date?: string;
268  /** End Date: Date */
269  end_date?: string;
270  /** Working Hours: Table (OD Service Day) */
271  support_and_resolution: ODServiceDay[];
272  /** Priorities: Table (OD Service Level Priority) */
273  priorities: ODServiceLevelPriority[];
274  /** Default SLA: Check */
275  default_sla: 0 | 1;
276  /** Rank: Int */
277  rank: number;
278  /** Default Priority: Link (OD Ticket Priority) */
279  default_priority?: string;
280  /** Enabled: Check */
281  enabled: 0 | 1;
282  /** Apply SLA for Resolution Time: Check */
283  apply_sla_for_resolution: 0 | 1;
284  /** Condition: Code */
285  condition?: string;
286  /** Description: Data */
287  description?: string;
288  /** Condition: Code */
289  condition_json?: string;
290  /** Ticket Reopen status: Link (OD Ticket Status) */
291  ticket_reopen_status?: string;
292  /** Default Ticket Status: Link (OD Ticket Status) */
293  default_ticket_status?: string;
294}
295
296// Last updated: 2026-09-28 12:00:00.000000
297export interface ODAgent extends DocType {
298  /** User: Link (User) */
299  user: string;
300  /** Agent Name: Data */
301  agent_name: string;
302  /** Is Active: Check */
303  is_active: 0 | 1;
304  /** Image: Attach Image */
305  user_image?: string;
306  /** Availability: Link (OD Agent Status) */
307  availability?: string;
308  /** Availability Changed On: Datetime */
309  availability_changed_on?: string;
310  /** Availability Changed By: Link (User) */
311  availability_changed_by?: string;
312}
313
314// Last updated: 2026-06-02 01:18:56.023594
315export interface ODAgentStatus extends DocType {
316  /** Agent Status: Data */
317  agent_status: string;
318  /** Status Order: Int */
319  status_order?: number;
320  /** Category: Select */
321  category?: 'Active' | 'Away' | 'Unavailable';
322  /** Color: Select */
323  color?: 'Black' | 'Gray' | 'Blue' | 'Green' | 'Red' | 'Pink' | 'Orange' | 'Amber' | 'Yellow' | 'Cyan' | 'Teal' | 'Violet' | 'purple';
324  /** Enabled: Check */
325  enabled: 0 | 1;
326}
327
328// Last updated: 2022-12-22 18:52:50.658355
329export interface ODTeamMember extends ChildDocType {
330  /** User: Link (User) */
331  user?: string;
332}
333
334// Last updated: 2026-10-14 15:52:16.630884
335export interface ODTeam extends DocType {
336  /** Name: Data */
337  team_name: string;
338  /** Assignment Rule: Link (Assignment Rule) */
339  assignment_rule?: string;
340  /** Users: Table MultiSelect (OD Team Member) */
341  users: ODTeamMember[];
342  /** Ignore Restrictions: Check */
343  ignore_restrictions: 0 | 1;
344  /** Disabled: Check */
345  disabled: 0 | 1;
346}
347
348// Last updated: 2026-02-20 17:04:23.230132
349export interface ODCustomerMember extends ChildDocType {
350  /** Is Manager: Check */
351  is_manager: 0 | 1;
352  /** Name: Link (Contact) */
353  contact_name: string;
354}
355
356// Last updated: 2026-10-09 12:00:00.000000
357export interface ODCustomer extends DocType {
358  /** Image: Attach Image */
359  image?: string;
360  /** Customer Name: Data */
361  customer_name?: string;
362  /** Customer Type: Select */
363  customer_type?: 'Company' | 'Individual' | 'Partnership';
364  /** Domain: Data */
365  domain?: string;
366  /** ERPNext Customer: Data */
367  erpnext_customer?: string;
368  /** Contacts: Table (OD Customer Member) */
369  contacts: ODCustomerMember[];
370  /** Mobile No: Data */
371  mobile_no?: string;
372  /** Email ID: Data */
373  email_id?: string;
374  /** Primary Contact: Link (Contact) */
375  primary_contact?: string;
376  /** Country: Link (Country) */
377  country?: string;
378}
379
380// Last updated: 2024-03-23 16:03:23.469424
381export interface DynamicLink extends ChildDocType {
382  /** Link Document Type: Link (DocType) */
383  link_doctype: string;
384  /** Link Name: Dynamic Link (link_doctype) */
385  link_name: string;
386  /** Link Title: Read Only */
387  link_title?: string;
388}
389
390// Last updated: 2024-03-23 16:01:31.173691
391export interface ContactEmail extends ChildDocType {
392  /** Email ID: Data */
393  email_id: string;
394  /** Is Primary: Check */
395  is_primary: 0 | 1;
396}
397
398// Last updated: 2024-03-23 16:01:31.293047
399export interface ContactPhone extends ChildDocType {
400  /** Number: Data */
401  phone: string;
402  /** Is Primary Phone: Check */
403  is_primary_phone: 0 | 1;
404  /** Is Primary Mobile: Check */
405  is_primary_mobile_no: 0 | 1;
406}
407
408// Last updated: 2026-07-31 16:01:30.937045
409export interface Contact extends DocType {
410  /** First Name: Data */
411  first_name?: string;
412  /** Last Name: Data */
413  last_name?: string;
414  /** Email Address: Data */
415  email_id?: string;
416  /** User Id: Link (User) */
417  user?: string;
418  /** Status: Select */
419  status?: 'Passive' | 'Open' | 'Replied';
420  /** Salutation: Link (Salutation) */
421  salutation?: string;
422  /** Gender: Link (Gender) */
423  gender?: string;
424  /** Phone: Data */
425  phone?: string;
426  /** Image: Attach Image */
427  image?: string;
428  /** Is Primary Contact: Check */
429  is_primary_contact: 0 | 1;
430  /** Links: Table (Dynamic Link) */
431  links: DynamicLink[];
432  /** Department: Data */
433  department?: string;
434  /** Designation: Data */
435  designation?: string;
436  /** Unsubscribed: Check */
437  unsubscribed: 0 | 1;
438  /** Middle Name: Data */
439  middle_name?: string;
440  /** Email IDs: Table (Contact Email) */
441  email_ids: ContactEmail[];
442  /** Address: Link (Address) */
443  address?: string;
444  /** Contact Numbers: Table (Contact Phone) */
445  phone_nos: ContactPhone[];
446  /** Mobile No: Data */
447  mobile_no?: string;
448  /** Pulled from Google Contacts: Check */
449  pulled_from_google_contacts: 0 | 1;
450  /** Sync with Google Contacts: Check */
451  sync_with_google_contacts: 0 | 1;
452  /** Google Contacts: Link (Google Contacts) */
453  google_contacts?: string;
454  /** Google Contacts Id: Data */
455  google_contacts_id?: string;
456  /** Company Name: Data */
457  company_name?: string;
458  /** Full Name: Data */
459  full_name?: string;
460}
461