Group

group

type Group implements Node {
  id: ID!
  name: String!
  code: String!
  active: Boolean!
  default: Boolean!
  enableRateProfile: Boolean!
  rateProfile: String
  createdAt: GQLTDate!
  updatedAt: GQLTDate!
  parentId: ID
  productGroupId: ID
  buildingId: ID
  children(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [GroupOrderBy] = []
    where: GQLTQueryGroupWhere
    include: [GQLTGroupIncludeObject] = []
  ): GroupHasManyChildrenList
  parent: Group
  users(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [UserOrderBy] = []
    where: GQLTQueryUserWhere
    include: [GQLTUserIncludeObject] = []
  ): UserBelongsToManyUsersList
  rooms(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [RoomOrderBy] = []
    where: GQLTQueryRoomWhere
    include: [GQLTRoomIncludeObject] = []
  ): RoomBelongsToManyRoomsList
  devices(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [DeviceOrderBy] = []
    where: GQLTQueryDeviceWhere
    include: [GQLTDeviceIncludeObject] = []
  ): DeviceBelongsToManyDevicesList
  productGroup: ProductGroup
  vouchers(
    after: String
    first: Int = 0
    before: String
    last: Int = 0
    orderBy: [VoucherOrderBy] = []
    where: GQLTQueryVoucherWhere
    include: [GQLTVoucherIncludeObject] = []
  ): VoucherHasManyVouchersList
  building: Building
}

Fields#

`id` (`ID!`)#

The ID of an object

`name` (`String!`)#

define the name of the group

`code` (`String!`)#

code is a unique identifier for each group

`active` (`Boolean!`)#

defines if the group is active or not

`default` (`Boolean!`)#

This is the default group assigned if the value is set to true

`enableRateProfile` (`Boolean!`)#

If set to true this will assign the value from the rateProfile field to the user

`rateProfile` (`String`)#

This is the rate profile to be assigned to the user on add

`createdAt` (`GQLTDate!`)#

`updatedAt` (`GQLTDate!`)#

`parentId` (`ID`)#

The ID of an object

`productGroupId` (`ID`)#

The ID of an object

`buildingId` (`ID`)#

The ID of an object

`children` (`GroupHasManyChildrenList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([GroupOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryGroupWhere)#
include ([GQLTGroupIncludeObject])#

`parent` (`Group`)#

`users` (`UserBelongsToManyUsersList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([UserOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryUserWhere)#
include ([GQLTUserIncludeObject])#

`rooms` (`RoomBelongsToManyRoomsList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([RoomOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryRoomWhere)#
include ([GQLTRoomIncludeObject])#

`devices` (`DeviceBelongsToManyDevicesList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([DeviceOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryDeviceWhere)#
include ([GQLTDeviceIncludeObject])#

`productGroup` (`ProductGroup`)#

`vouchers` (`VoucherHasManyVouchersList`)#

after (String)#

If provided it will return results after the provided cursor

first (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the first ${amount} of records.

before (String)#

If provided it will return results before the provided cursor

last (Int)#

If provided the results will be the first ${amount} of records from provided cursor, if a cursor is not provided the results will be the last ${amount} of records.

orderBy ([VoucherOrderBy])#

If provided this will sort the results by the supplied column and direction

where (GQLTQueryVoucherWhere)#
include ([GQLTVoucherIncludeObject])#

`building` (`Building`)#

The building associated to the group

Interfaces#

`Node`#

An object with an ID

Fields#

id (ID!)#

name (String!)#

code (String!)#

active (Boolean!)#

default (Boolean!)#

enableRateProfile (Boolean!)#

rateProfile (String)#

createdAt (GQLTDate!)#

updatedAt (GQLTDate!)#

parentId (ID)#

productGroupId (ID)#

buildingId (ID)#

children (GroupHasManyChildrenList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([GroupOrderBy])#

where (GQLTQueryGroupWhere)#

include ([GQLTGroupIncludeObject])#

parent (Group)#

users (UserBelongsToManyUsersList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([UserOrderBy])#

where (GQLTQueryUserWhere)#

include ([GQLTUserIncludeObject])#

rooms (RoomBelongsToManyRoomsList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([RoomOrderBy])#

where (GQLTQueryRoomWhere)#

include ([GQLTRoomIncludeObject])#

devices (DeviceBelongsToManyDevicesList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([DeviceOrderBy])#

where (GQLTQueryDeviceWhere)#

include ([GQLTDeviceIncludeObject])#

productGroup (ProductGroup)#

vouchers (VoucherHasManyVouchersList)#

after (String)#

first (Int)#

before (String)#

last (Int)#

orderBy ([VoucherOrderBy])#

where (GQLTQueryVoucherWhere)#

include ([GQLTVoucherIncludeObject])#

building (Building)#

Interfaces#

Node#

`id` (`ID!`)#

`name` (`String!`)#

`code` (`String!`)#

`active` (`Boolean!`)#

`default` (`Boolean!`)#

`enableRateProfile` (`Boolean!`)#

`rateProfile` (`String`)#

`createdAt` (`GQLTDate!`)#

`updatedAt` (`GQLTDate!`)#

`parentId` (`ID`)#

`productGroupId` (`ID`)#

`buildingId` (`ID`)#

`children` (`GroupHasManyChildrenList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[GroupOrderBy]`)#

`where` (`GQLTQueryGroupWhere`)#

`include` (`[GQLTGroupIncludeObject]`)#

`parent` (`Group`)#

`users` (`UserBelongsToManyUsersList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[UserOrderBy]`)#

`where` (`GQLTQueryUserWhere`)#

`include` (`[GQLTUserIncludeObject]`)#

`rooms` (`RoomBelongsToManyRoomsList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[RoomOrderBy]`)#

`where` (`GQLTQueryRoomWhere`)#

`include` (`[GQLTRoomIncludeObject]`)#

`devices` (`DeviceBelongsToManyDevicesList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[DeviceOrderBy]`)#

`where` (`GQLTQueryDeviceWhere`)#

`include` (`[GQLTDeviceIncludeObject]`)#

`productGroup` (`ProductGroup`)#

`vouchers` (`VoucherHasManyVouchersList`)#

`after` (`String`)#

`first` (`Int`)#

`before` (`String`)#

`last` (`Int`)#

`orderBy` (`[VoucherOrderBy]`)#

`where` (`GQLTQueryVoucherWhere`)#

`include` (`[GQLTVoucherIncludeObject]`)#

`building` (`Building`)#

`Node`#