All Classes Files Functions Variables Enumerations Enumerator Groups Pages
TechnicalSupport.idl
Go to the documentation of this file.
1 /**
2  * @file TechnicalSupport.idl
3  * @brief Ensures support-communication with Kayako
4  *
5  * @author Bures Frantisek
6  *
7  * @copyright Copyright © 2017 Kerio Technologies s.r.o.
8  */
9 
10 #import <kerio/web/idl/SharedStructures.idl>
11 
12 module kerio {
13 module web {
14 
15 /**
16  * A contact to user
17  */
18 struct UserInfo {
19  string name;
20  string email;
21 };
22 
23 /**
24  * Product identification
25  */
26 struct ProductInfo {
27  string productVersion;
28  string productName;
29  string operatingSystem;
30  string licenseNumber; // first 11 chars only
31 };
32 
33 /**
34  * List of files attached to the ticket
35  */
36 typedef sequence<string> AdditionalFiles;
37 
38 struct SystemInfo {
39  AdditionalFiles files;
40  string description;
41 };
42 
43 /**
44  * Interface for support incidents
45  */
46 interface TechnicalSupport {
47  /**
48  * Get information from running product
49  *
50  * @param userInfo (out UserInfo) User information
51  * @param productInfo (out ProductInfo) Product information
52  * @param systemInfo (out SystemInfo) System information
53  * @param isUploadServerAvailable (out boolean) Is possible to upload attachment ?
54  * @return (void)
55  */
56  void getInfo(out UserInfo userInfo, out ProductInfo productInfo, out SystemInfo systemInfo, out boolean isUploadServerAvailable);
57 
58  /**
59  * Add system info to the ticket
60  *
61  * @param ticketId (in string) tickedId of target ticket
62  * @param email (in string) email of the customer
63  * @return (void)
64  */
65  void addSystemInfoToTicket(in string ticketId, in string email);
66 };
67 
68 };
69 };