CompanyContacts.idl

/**
 * @file   CompanyConacts.idl
 * @brief  Company contacts settings
 *
 * @author Miroslav Kroc
 *
 * @copyright Copyright © 2017 Kerio Technologies s.r.o.
 */

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

module kerio {
module jsonapi {
module admin {

struct CompanyContact {
   kerio::web::KId   id;
   string         name;    ///< name of company contact (caption of item in list of contacts)
   string         company;
   string         street;
   string         locality;
   string         state;
   string         zip;
   string         country;
   string         url;
   string         phone;
   string            fax;
   kerio::web::KId   domainId;   ///< id of domain associated with company contact
};

/**
 * List of company contacts
 */
typedef sequence<CompanyContact> CompanyContactList;

/**
 * Company contacts management
 */
interface CompanyContacts {

   /**
    * Create new company contacts.
    *
    * @param errors - error message list
    * @param result - particular results for all items
    * @param domains - new company contacts entities
    */
   void create(out kerio::web::ErrorList errors, out kerio::web::CreateResultList result, in CompanyContactList companyContacts);

   /**
    * Obtain a list of company contacts.
    *
    * @param list - list of company contacts
    * @param totalItems - amount of company contacts for given search condition, useful when limit is defined in kerio::web::SearchQuery
    * @param query - query conditions and limits
    */
   void get(out CompanyContactList list, out long totalItems, in kerio::web::SearchQuery query);

   /**
    * Obtain a list of company contacts capable to be used for user editor to specified domain (domainId).
    * This method is valid for an account admin and full admin.
    *  - Parameter "domainId" is optional for account admin.
    *  - Only company contacts for given domain and global company contacts are listed.
    *
    * @param companyContactList - list of user templates
    * @param domainId - Only company contacts for given domain and global company contacts are listed.
    */
   void getAvailable(out CompanyContactList companyContactList, in kerio::web::KId domainId);

   /**
    * Remove company contacts.
    *
    * @param errors - error message list
    * @param domainIds - list of global identifiers of company contacts to be deleted
    */
   void remove(out kerio::web::ErrorList errors, in kerio::web::KIdList companyContactsIds);

   /**
    * Set existing company contacts to given pattern.
    *
    * @param errors - error message list
    * @param companyContactsIds - list of the company contacts's global identifier(s)
    * @param pattern - pattern to use for new values
    */
   void set(out kerio::web::ErrorList errors, in kerio::web::KIdList companyContactsIds, in CompanyContact pattern);

};

}; }; };//end of namespace