devicegroups

type ApiErrorCauseRepresentation struct {
	// Error-specific code that can be used to identify localization string, etc.
	Code string `json:"code"`
	// A general description of error for troubleshooting/debugging. Generally this text should not be
	// displayed to a user; instead refer to errorCode and its localized text.
	Description string `json:"description"`
	// Name of the field that caused the error.
	Field string `json:"field"`
	// id of object with error. Optional.
	ID string `json:"id"`
}

type ApiErrorRepresentation struct {
	Errors []ApiErrorCauseRepresentation `json:"errors"`
	// HTTP status of the response.
	HttpStatus int    `json:"httpStatus"`
	TraceID    string `json:"traceId"`
}

type Client struct {
	// contains filtered or unexported fields
}

type DeviceGroupCreateRepresentationV1 struct {
	// The criteria used to calculate the group's members. Can only be used if `groupType` is `SMART`.
	Criteria *[]DeviceGroupCriteriaRepresentationV1 `json:"criteria,omitempty"`
	// Description of the device group.
	Description *string `json:"description,omitempty"`
	// Type of device.
	DeviceType DeviceTypeV1 `json:"deviceType"`
	// Type of the device group.
	GroupType GroupTypeV1 `json:"groupType"`
	// The IDs of the devices to be added to the group, in UUID format. Can only be used if `groupType` is
	// `STATIC`.
	Members *[]string `json:"members,omitempty"`
	// Name of the device group.
	Name string `json:"name"`
}

type DeviceGroupCriteriaRepresentationV1 struct {
	// Name of the attribute used in the criteria.
	AttributeName string `json:"attributeName"`
	// Value of the attribute used in the criteria.
	AttributeValue string `json:"attributeValue"`
	// Indicates if the criteria ends with a closing parenthesis.
	HasClosingParenthesis *bool `json:"hasClosingParenthesis,omitempty"`
	// Indicates if the criteria starts with an opening parenthesis.
	HasOpeningParenthesis *bool `json:"hasOpeningParenthesis,omitempty"`
	// Type of join for criteria.
	JoinType JoinTypeV1 `json:"joinType"`
	// Operator used for the criteria.
	Operator string `json:"operator"`
	// Order of the criteria in the group. All criteria must have a unique, sequential order starting from
	// 0.
	Order int `json:"order"`
}

type DeviceGroupListReadRepresentationV1 struct {
	// Description of the device group.
	Description string `json:"description"`
	// Type of device.
	DeviceType DeviceTypeV1 `json:"deviceType"`
	// Type of the device group.
	GroupType GroupTypeV1 `json:"groupType"`
	// The ID of the device group, in UUID format.
	ID string `json:"id"`
	// Number of devices in the group.
	MemberCount int `json:"memberCount"`
	// Name of the device group.
	Name string `json:"name"`
}

type DeviceGroupMemberOfRepresentationV1 struct {
	// The ID of the device group, in UUID format.
	GroupID string `json:"groupId"`
	// Name of the device group.
	GroupName string `json:"groupName"`
}

type DeviceGroupMemberPatchRepresentationV1 struct {
	// List of device IDs to be added to the group, in UUID format.
	Added *[]string `json:"added,omitempty"`
	// List of device IDs to be removed from the group, in UUID format.
	Removed *[]string `json:"removed,omitempty"`
}

type DeviceGroupReadRepresentationV1 struct {
	// Criteria used to calculate the group's members, if applicable.
	Criteria *[]DeviceGroupCriteriaRepresentationV1 `json:"criteria,omitempty"`
	// Description of the device group.
	Description string `json:"description"`
	// Type of device.
	DeviceType DeviceTypeV1 `json:"deviceType"`
	// Type of the device group.
	GroupType GroupTypeV1 `json:"groupType"`
	// The ID of the device group, in UUID format.
	ID string `json:"id"`
	// Number of devices in the group.
	MemberCount int `json:"memberCount"`
	// Name of the device group.
	Name string `json:"name"`
}

type DeviceGroupUpdateRepresentationV1 struct {
	// The criteria used to calculate the group's members. Can only be used if `groupType` is `SMART`.
	Criteria *[]DeviceGroupCriteriaRepresentationV1 `json:"criteria,omitempty"`
	// Description of the device group.
	Description *string `json:"description,omitempty"`
	// Name of the device group.
	Name *string `json:"name,omitempty"`
}

type DeviceTypeV1 = string

type GroupTypeV1 = string

type HrefRepresentation struct {
	// URL of the resource.
	Href string `json:"href"`
	// The ID of the resource, in UUID format.
	ID string `json:"id"`
}

type JoinTypeV1 = string

type ListDeviceGroupMemberOfResponseRepresentation struct {
	// List of device groups for the specified device.
	Results []DeviceGroupMemberOfRepresentationV1 `json:"results"`
	// Total number of results across all pages.
	TotalCount int `json:"totalCount"`
}

type ListDeviceGroupMemberReadRepresentation struct {
	// List of device group members.
	Results []string `json:"results"`
	// Total number of results across all pages.
	TotalCount int `json:"totalCount"`
}

type ListResponseRepresentation struct {
	// Total number of results across all pages.
	TotalCount int `json:"totalCount"`
}

type PaginatedDeviceGroupResponseRepresentation struct {
	// Whether there is a next page.
	HasNext bool `json:"hasNext"`
	// Whether there is a previous page.
	HasPrevious bool `json:"hasPrevious"`
	// Current page number (0-based).
	Page int `json:"page"`
	// Number of items per page.
	PageSize int `json:"pageSize"`
	// List of device groups for the current page.
	Results []DeviceGroupListReadRepresentationV1 `json:"results"`
	// Total number of results across all pages.
	TotalCount int `json:"totalCount"`
	// Total number of pages.
	TotalPages int `json:"totalPages"`
}

type PaginatedResponseRepresentation struct {
	// Whether there is a next page.
	HasNext bool `json:"hasNext"`
	// Whether there is a previous page.
	HasPrevious bool `json:"hasPrevious"`
	// Current page number (0-based).
	Page int `json:"page"`
	// Number of items per page.
	PageSize int `json:"pageSize"`
	// Total number of results across all pages.
	TotalCount int `json:"totalCount"`
	// Total number of pages.
	TotalPages int `json:"totalPages"`
}