magistrala/pkg/sdk/responses.go

// Copyright (c) Abstract Machines
// SPDX-License-Identifier: Apache-2.0

package sdk

import "github.com/absmach/magistrala/pkg/transformers/senml"

type createClientsRes struct {
	Clients []Client `json:"clients"`
}

type createChannelsRes struct {
	Channels []Channel `json:"channels"`
}

type PageRes struct {
	Total  uint64 `json:"total"`
	Offset uint64 `json:"offset"`
	Limit  uint64 `json:"limit"`
}

// ClientsPage contains list of clients in a page with proper metadata.
type ClientsPage struct {
	Clients []Client `json:"clients"`
	PageRes
}

// ChannelsPage contains list of channels in a page with proper metadata.
type ChannelsPage struct {
	Channels []Channel `json:"channels"`
	PageRes
}

// MessagesPage contains list of messages in a page with proper metadata.
type MessagesPage struct {
	Messages []senml.Message `json:"messages,omitempty"`
	PageRes
}

type GroupsPage struct {
	Groups []Group `json:"groups"`
	PageRes
}

type UsersPage struct {
	Users []User `json:"users"`
	PageRes
}

type MembersPage struct {
	Members []User `json:"members"`
	PageRes
}

// MembershipsPage contains page related metadata as well as list of memberships that
// belong to this page.
type MembershipsPage struct {
	PageRes
	Memberships []Group `json:"memberships"`
}

type DomainsPage struct {
	Domains []Domain `json:"domains"`
	PageRes
}

// BootstrapPage contains list of bootstrap configs in a page with proper metadata.
type BootstrapPage struct {
	Configs []BootstrapConfig `json:"configs"`
	PageRes
}

// BootstrapProfilesPage contains list of bootstrap profiles in a page with proper metadata.
type BootstrapProfilesPage struct {
	Profiles []BootstrapProfile `json:"profiles"`
	PageRes
}

// SubscriptionPage contains list of subscriptions in a page with proper metadata.
type SubscriptionPage struct {
	Subscriptions []Subscription `json:"subscriptions"`
	PageRes
}

type roleActionsRes struct {
	Actions []string `json:"actions"`
}

type availableRoleActionsRes struct {
	AvailableActions []string `json:"available_actions"`
}

type roleMembersRes struct {
	Members []string `json:"members"`
}

type GroupsHierarchyPage struct {
	Level     uint64  `json:"level"`
	Direction int64   `json:"direction"`
	Groups    []Group `json:"groups"`
}

type RoleMembersPage struct {
	Total   uint64   `json:"total"`
	Offset  uint64   `json:"offset"`
	Limit   uint64   `json:"limit"`
	Members []string `json:"members"`
}

type MemberRole struct {
	Actions            []string `json:"actions,omitempty"`
	RoleName           string   `json:"role_name,omitempty"`
	RoleID             string   `json:"role_id,omitempty"`
	AccessType         string   `json:"access_type,omitempty"`
	AccessProviderID   string   `json:"access_provider_id,omitempty"`
	AccessProviderPath string   `json:"access_provider_path,omitempty"`
}
type MemberRoles struct {
	MemberID string       `json:"member_id"`
	Roles    []MemberRole `json:"roles"`
}
type EntityMembersPage struct {
	Total   uint64        `json:"total"`
	Offset  uint64        `json:"offset"`
	Limit   uint64        `json:"limit"`
	Members []MemberRoles `json:"members"`
}