TechnicalSupport.idl

Go to the documentation of this file.

/**
 * @file   TechnicalSupport.idl
 * @brief  Ensures support-communication with Kayako
 *
 * @author Bures Frantisek
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

#import <kerio/web/idl/SharedStructures.idl>

module kerio {
module web {

/**
 * A contact to user
 */
struct UserInfo   {
   string name;
   string email;
};

/**
 * Product identification
 */
struct ProductInfo   {
   string productVersion;
   string productName;
   string operatingSystem;
   string licenseNumber; // first 11 chars only
};

/**
 * List of files attached to the ticket
 */
typedef sequence<string>   AdditionalFiles;

struct SystemInfo {
   AdditionalFiles files;
   string description;
};

/**
 * Interface for support incidents
 */
interface TechnicalSupport {
   /**
   *  Get information from running product
   * 
   *  @param userInfo (out UserInfo) User information 
   *  @param productInfo (out ProductInfo) Product information
   *  @param systemInfo (out SystemInfo) System information
   *  @param isUploadServerAvailable (out boolean) Is possible to upload attachment ?
   *  @return (void)
   */
   void getInfo(out UserInfo userInfo, out ProductInfo productInfo, out SystemInfo systemInfo, out boolean isUploadServerAvailable);

   /**
   *  Add system info to the ticket
   * 
   *  @param ticketId (in string) tickedId of target ticket
   *  @param email (in string) email of the customer
   *  @return (void)
   */
   void addSystemInfoToTicket(in string ticketId, in string email);
};

};
};