/**
 * Hostex Groups API types
 */

/**
 * A property group
 */
export interface Group {
  /** Unique identifier for the group */
  id: number;
  /** Name of the group */
  name: string;
  /** Property ids that belong to this group */
  property_ids: number[];
}

/**
 * Groups query parameters
 */
export interface GroupsQueryParams {
  /** The starting point from which to begin returning results */
  offset?: number;
  /** The maximum number of results to return, max 100 */
  limit?: number;
  /** The id of the group */
  id?: number;
}

/**
 * Groups response data
 */
export interface GroupsData {
  groups: Group[];
  /** Total number of groups */
  total: number;
}

/**
 * Create group parameters
 */
export interface CreateGroupParams {
  /** Group display name, max 50 chars, unique within the operator */
  name: string;
  /** Optional property ids to attach to the new group */
  property_ids?: number[];
}

/**
 * Create group response data
 */
export interface CreateGroupData {
  group: Group;
}

/**
 * Update group parameters
 */
export interface UpdateGroupParams {
  /** The id of the group to update */
  id: number;
  /** New display name (unique within the operator) */
  name?: string;
  /** Replaces the group's property list */
  property_ids?: number[];
}