sdk

type Cert struct {
	ThingID        string    `json:"thing_id,omitempty"`
	Certificate    string    `json:"certificate,omitempty"`
	PrivateKey     string    `json:"private_key,omitempty"`
	IssuingCA      string    `json:"issuing_ca,omitempty"`
	CAChain        []string  `json:"ca_chain,omitempty"`
	PrivateKeyType string    `json:"private_key_type,omitempty"`
	Serial         string    `json:"serial,omitempty"`
	ExpiresAt      time.Time `json:"expires_at,omitempty"`
}

type CertSerial struct {
	ThingID    string    `json:"thing_id"`
	CertSerial string    `json:"cert_serial"`
	ExpiresAt  time.Time `json:"expires_at"`
}

type CertsPage struct {
	Total  uint64       `json:"total"`
	Offset uint64       `json:"offset"`
	Limit  uint64       `json:"limit"`
	Certs  []CertSerial `json:"certs"`
}

type Config struct {
	AuthURL        string
	CertsURL       string
	HTTPAdapterURL string
	ReaderURL      string
	ThingsURL      string
	UsersURL       string
	WebhooksURL    string

	MsgContentType  ContentType
	TLSVerification bool
}

type ContentType string

type Group struct {
	ID          string         `json:"id,omitempty"`
	Name        string         `json:"name,omitempty"`
	OwnerID     string         `json:"owner_id,omitempty"`
	OrgID       string         `json:"org_id,omitempty"`
	Description string         `json:"description,omitempty"`
	Metadata    map[string]any `json:"metadata,omitempty"`
	CreatedAt   time.Time      `json:"created_at,omitempty"`
	UpdatedAt   time.Time      `json:"updated_at,omitempty"`
}

type GroupMembership struct {
	MemberID string `json:"member_id,omitempty"`
	Role     string `json:"role,omitempty"`
	Email    string `json:"email,omitempty"`
}

type GroupMembershipsPage struct {
	GroupMemberships []GroupMembership `json:"group_memberships"`
	// contains filtered or unexported fields
}

type GroupsPage struct {
	Groups []Group `json:"groups"`
	// contains filtered or unexported fields
}

type Invite struct {
	ID           string    `json:"id"`
	InviteeID    string    `json:"invitee_id"`
	InviteeEmail string    `json:"invitee_email"`
	InviterID    string    `json:"inviter_id"`
	OrgID        string    `json:"org_id"`
	InviteeRole  string    `json:"invitee_role"`
	CreatedAt    time.Time `json:"created_at"`
	ExpiresAt    time.Time `json:"expires_at"`
}

type InvitesPage struct {
	Invites []Invite `json:"invites,omitempty"`
	// contains filtered or unexported fields
}

type JSONPageMetadata struct {
	Offset      uint64   `json:"offset"`
	Limit       uint64   `json:"limit"`
	Subtopic    string   `json:"subtopic,omitempty"`
	Publisher   string   `json:"publisher,omitempty"`
	Protocol    string   `json:"protocol,omitempty"`
	From        int64    `json:"from,omitempty"`
	To          int64    `json:"to,omitempty"`
	Filter      string   `json:"filter,omitempty"`
	AggInterval string   `json:"agg_interval,omitempty"`
	AggValue    uint64   `json:"agg_value,omitempty"`
	AggType     string   `json:"agg_type,omitempty"`
	AggFields   []string `json:"agg_fields,omitempty"`
	Dir         string   `json:"dir,omitempty"`
}

type Key struct {
	ID        string
	Type      uint32
	IssuerID  string
	Subject   string
	IssuedAt  time.Time
	ExpiresAt time.Time
}

type KeyRes struct {
	ID        string     `json:"id,omitempty"`
	Value     string     `json:"value,omitempty"`
	IssuedAt  time.Time  `json:"issued_at,omitempty"`
	ExpiresAt *time.Time `json:"expires_at,omitempty"`
}

type MessagesPage struct {
	Messages []senml.Message `json:"messages,omitempty"`
	// contains filtered or unexported fields
}

type Metadata map[string]any

type Org struct {
	ID          string         `json:"id,omitempty"`
	OwnerID     string         `json:"owner_id,omitempty"`
	Name        string         `json:"name,omitempty"`
	Description string         `json:"description,omitempty"`
	Metadata    map[string]any `json:"metadata,omitempty"`
	CreatedAt   time.Time      `json:"created_at,omitempty"`
	UpdatedAt   time.Time      `json:"updated_at,omitempty"`
}

type OrgMembership struct {
	MemberID  string    `json:"member_id,omitempty"`
	OrgID     string    `json:"org_id,omitempty"`
	Role      string    `json:"role,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	Email     string    `json:"email,omitempty"`
}

type OrgMembershipsPage struct {
	OrgMemberships []OrgMembership `json:"org_memberships"`
	// contains filtered or unexported fields
}

type OrgsPage struct {
	Orgs []Org `json:"orgs"`
	// contains filtered or unexported fields
}

type PageMetadata struct {
	Total    uint64         `json:"total"`
	Offset   uint64         `json:"offset"`
	Limit    uint64         `json:"limit"`
	Order    string         `json:"order"`
	Dir      string         `json:"dir"`
	Subtopic string         `json:"subtopic,omitempty"`
	Format   string         `json:"format,omitempty"`
	Email    string         `json:"email,omitempty"`
	Name     string         `json:"name,omitempty"`
	Metadata map[string]any `json:"metadata,omitempty"`
}

type Profile struct {
	ID       string         `json:"id,omitempty"`
	GroupID  string         `json:"group_id,omitempty"`
	Name     string         `json:"name,omitempty"`
	Config   map[string]any `json:"config,omitempty"`
	Metadata map[string]any `json:"metadata,omitempty"`
}

type ProfilesPage struct {
	Profiles []Profile `json:"profiles"`
	// contains filtered or unexported fields
}

type SDK interface {
	// CreateUser creates mainflux user.
	CreateUser(user User, token string) (string, error)

	// GetUser returns user object by id.
	GetUser(id, token string) (User, error)

	// ListUsers returns list of users.
	ListUsers(pm PageMetadata, token string) (UsersPage, error)

	// CreateToken receives credentials and returns user token.
	CreateToken(user User) (string, error)

	// RegisterUser registers mainflux user.
	RegisterUser(user User) (string, error)

	// UpdateUser updates existing user.
	UpdateUser(user User, token string) error

	// UpdatePassword updates user password.
	UpdatePassword(oldPass, newPass, token string) error

	// CreateThing registers new thing and returns its id.
	CreateThing(thing Thing, profileID, token string) (string, error)

	// CreateThings registers new things and returns their ids.
	CreateThings(things []Thing, profileID, token string) ([]Thing, error)

	// ListThings returns page of things.
	ListThings(pm PageMetadata, token string) (ThingsPage, error)

	// ListThingsByProfile returns page of things assigned to the specified profile.
	ListThingsByProfile(profileID string, pm PageMetadata, token string) (ThingsPage, error)

	// GetThing returns thing object by id.
	GetThing(id, token string) (Thing, error)

	// GetThingMetadataByKey retrieves metadata about the thing identified by the given key.
	GetThingMetadataByKey(key domain.ThingKey) (Metadata, error)

	// UpdateThing updates existing thing.
	UpdateThing(thing Thing, thingID, token string) error

	// DeleteThing removes existing thing.
	DeleteThing(id, token string) error

	// DeleteThings removes existing things.
	DeleteThings(ids []string, token string) error

	// IdentifyThing validates thing's key and returns its ID
	IdentifyThing(key domain.ThingKey) (string, error)

	// UpdateExternalThingKey sets the external key of the Thing identified by `thingID`.`
	UpdateExternalThingKey(key, thingID, token string) error

	// CreateGroup creates new group and returns its id.
	CreateGroup(group Group, orgID, token string) (string, error)

	// DeleteGroup deletes users group.
	DeleteGroup(id, token string) error

	// DeleteGroups delete users groups.
	DeleteGroups(ids []string, token string) error

	// ListGroups returns page of groups.
	ListGroups(meta PageMetadata, token string) (GroupsPage, error)

	// ListGroupsByOrg returns a page of all Groups belonging to the spcified Org.
	ListGroupsByOrg(orgID string, meta PageMetadata, token string) (GroupsPage, error)

	// GetGroup returns users group object by id.
	GetGroup(id, token string) (Group, error)

	// ListThingsByGroup lists things that are members of specified group.
	ListThingsByGroup(groupID string, meta PageMetadata, token string) (ThingsPage, error)

	// GetGroupByThing retrieves a group that the specified thing is a member of.
	GetGroupByThing(thingID, token string) (Group, error)

	// UpdateGroup updates existing group.
	UpdateGroup(group Group, groupID, token string) error

	// CreateProfile creates new profile and returns its id.
	CreateProfile(profile Profile, groupID, token string) (string, error)

	// CreateProfiles registers new profiles and returns their ids.
	CreateProfiles(profiles []Profile, groupID, token string) ([]Profile, error)

	// ListProfiles returns page of profiles.
	ListProfiles(pm PageMetadata, token string) (ProfilesPage, error)

	// GetProfileByThing returns profile that are assigned to specified thing.
	GetProfileByThing(thingID, token string) (Profile, error)

	// GetProfile returns profile data by id.
	GetProfile(id, token string) (Profile, error)

	// UpdateProfile updates existing profile.
	UpdateProfile(profile Profile, profileID, token string) error

	// DeleteProfile removes existing profile.
	DeleteProfile(id, token string) error

	// DeleteProfiles removes existing profile.
	DeleteProfiles(ids []string, token string) error

	// ListProfilesByGroup lists profiles that are members of specified group.
	ListProfilesByGroup(groupID string, pm PageMetadata, token string) (ProfilesPage, error)

	// GetGroupByProfile retrieves a group that the specified profile is a member of.
	GetGroupByProfile(profileID, token string) (Group, error)

	// CreateGroupMemberships creates memberships to the specified group.
	CreateGroupMemberships(gms []GroupMembership, groupID, token string) error

	// UpdateGroupMemberships updates existing memberships.
	UpdateGroupMemberships(gms []GroupMembership, groupID, token string) error

	// RemoveGroupMemberships removes memberships from the specified group.
	RemoveGroupMemberships(ids []string, groupID, token string) error

	// ListGroupMemberships lists memberships created for a specified group.
	ListGroupMemberships(groupID string, pm PageMetadata, token string) (GroupMembershipsPage, error)

	// CreateOrg registers a new Org and returns its ID.
	CreateOrg(org Org, token string) (string, error)

	// GetOrg returns org data by id.
	GetOrg(id, token string) (Org, error)

	// UpdateOrg updates existing org.
	UpdateOrg(o Org, orgID, token string) error

	// DeleteOrg removes existing org.
	DeleteOrg(id, token string) error

	// ListOrgs returns page of orgs.
	ListOrgs(meta PageMetadata, token string) (OrgsPage, error)

	// CreateOrgMemberships creates memberships to the specified org.
	CreateOrgMemberships(oms []OrgMembership, orgID, token string) error

	// GetOrgMembership retrieves a membership for the specified org and member.
	GetOrgMembership(memberID, orgID, token string) (OrgMembership, error)

	// ListOrgMemberships lists memberships created for a specified org.
	ListOrgMemberships(orgID string, meta PageMetadata, token string) (OrgMembershipsPage, error)

	// UpdateOrgMemberships updates existing memberships.
	UpdateOrgMemberships(oms []OrgMembership, orgID, token string) error

	// RemoveOrgMemberships removes memberships from the specified org.
	RemoveOrgMemberships(memberIDs []string, orgID, token string) error

	// SendMessage send message.
	SendMessage(subtopic, msg string, key domain.ThingKey) error

	// ReadMessages read messages.
	ReadMessages(isAdmin bool, pm PageMetadata, keyType, token string) (map[string]any, error)

	// ListJSONMessages lists JSON messages with filtering.
	ListJSONMessages(pm JSONPageMetadata, token string, key domain.ThingKey) (map[string]any, error)

	// ListSenMLMessages lists SenML messages with filtering.
	ListSenMLMessages(pm SenMLPageMetadata, token string, key domain.ThingKey) (map[string]any, error)

	// DeleteJSONMessages deletes JSON messages by publisher.
	DeleteJSONMessages(publisherID, token string, pm JSONPageMetadata) error

	// DeleteSenMLMessages deletes SenML messages by publisher.
	DeleteSenMLMessages(publisherID, token string, pm SenMLPageMetadata) error

	// DeleteAllJSONMessages deletes all JSON messages (admin only).
	DeleteAllJSONMessages(token string, pm JSONPageMetadata) error

	// DeleteAllSenMLMessages deletes all SenML messages (admin only).
	DeleteAllSenMLMessages(token string, pm SenMLPageMetadata) error

	// ExportJSONMessages exports JSON messages.
	ExportJSONMessages(token string, pm JSONPageMetadata, convert, timeFormat string) ([]byte, error)

	// ExportSenMLMessages exports SenML messages.
	ExportSenMLMessages(token string, pm SenMLPageMetadata, convert, timeFormat string) ([]byte, error)

	// BackupMessages backs up all messages (admin only).
	BackupMessages(token string) ([]byte, error)

	// RestoreMessages restores messages from backup data (admin only).
	RestoreMessages(token string, data []byte) error

	// ValidateContentType sets message content type.
	ValidateContentType(ct ContentType) error

	// Health returns things service health check.
	Health() (mainflux.HealthInfo, error)

	// IssueCert issues a certificate for a thing required for mtls.
	IssueCert(thingID string, keyBits int, keyType, valid, token string) (Cert, error)

	// ViewCert retrieves a certificate by its serial number.
	ViewCert(serial, token string) (Cert, error)

	// RevokeCert revokes a certificate by its serial number.
	RevokeCert(serial, token string) error

	// RenewCert renews a certificate by its serial number.
	RenewCert(serial, token string) (Cert, error)

	// ListSerials lists certificate serial numbers for a given thing.
	ListSerials(thingID string, offset, limit uint64, token string) (CertsPage, error)

	// RemoveCert removes a certificate.
	RemoveCert(id, token string) error

	// Issue issues a new key, returning its token value alongside.
	Issue(duration time.Duration, token string) (KeyRes, error)

	// Revoke removes the key with the provided ID that is issued by the user identified by the provided key.
	Revoke(id, token string) error

	// RetrieveKey retrieves data for the key identified by the provided ID, that is issued by the user identified by the provided key.
	RetrieveKey(id, token string) (retrieveKeyRes, error)

	// CreateInvite creates and sends a new Invite.
	CreateInvite(orgID string, om OrgMembership, token string) (Invite, error)

	// RevokeInvite revokes a specific Invite.
	RevokeInvite(inviteID string, token string) error

	// InviteRespond responds to a specific Invite either accepting or declining it.
	InviteRespond(inviteID string, accept bool, token string) error

	// GetInvite retrieves a specific Invite.
	GetInvite(inviteID string, token string) (Invite, error)

	// ListInvitesByUser retrieves a list of Invites either sent out by, or sent to the user identifed by
	// the specific userID.
	ListInvitesByUser(userID string, userType string, pm PageMetadata, token string) (InvitesPage, error)

	// CreateWebhooks creates new webhooks.
	CreateWebhooks(whs []Webhook, groupID, token string) ([]Webhook, error)

	// ListWebhooksByGroup lists webhooks who belong to a specified group.
	ListWebhooksByGroup(groupID, token string) (WebhooksPage, error)

	// ListWebhooksByThing lists webhooks who belong to a specified thing.
	ListWebhooksByThing(thingID, token string) (WebhooksPage, error)

	// GetWebhook returns webhook data by id.
	GetWebhook(webhookID, token string) (Webhook, error)

	// UpdateWebhook updates existing webhook.
	UpdateWebhook(wh Webhook, webhookID, token string) error

	// DeleteWebhooks removes existing webhooks.
	DeleteWebhooks(ids []string, token string) error
}

type SenMLPageMetadata struct {
	Offset      uint64   `json:"offset"`
	Limit       uint64   `json:"limit"`
	Subtopic    string   `json:"subtopic,omitempty"`
	Publisher   string   `json:"publisher,omitempty"`
	Protocol    string   `json:"protocol,omitempty"`
	Name        string   `json:"name,omitempty"`
	Value       float64  `json:"v,omitempty"`
	Comparator  string   `json:"comparator,omitempty"`
	BoolValue   bool     `json:"vb,omitempty"`
	StringValue string   `json:"vs,omitempty"`
	DataValue   string   `json:"vd,omitempty"`
	From        int64    `json:"from,omitempty"`
	To          int64    `json:"to,omitempty"`
	AggInterval string   `json:"agg_interval,omitempty"`
	AggValue    uint64   `json:"agg_value,omitempty"`
	AggType     string   `json:"agg_type,omitempty"`
	AggFields   []string `json:"agg_fields,omitempty"`
	Dir         string   `json:"dir,omitempty"`
}

type Thing struct {
	ID        string         `json:"id,omitempty"`
	GroupID   string         `json:"group_id,omitempty"`
	ProfileID string         `json:"profile_id,omitempty"`
	Name      string         `json:"name,omitempty"`
	Type      string         `json:"type,omitempty"`
	Key       string         `json:"key,omitempty"`
	Metadata  map[string]any `json:"metadata,omitempty"`
}

type ThingsPage struct {
	Things []Thing `json:"things"`
	// contains filtered or unexported fields
}

type User struct {
	ID       string         `json:"id,omitempty"`
	Email    string         `json:"email,omitempty"`
	Groups   []string       `json:"groups,omitempty"`
	Password string         `json:"password,omitempty"`
	Metadata map[string]any `json:"metadata,omitempty"`
}

type UserPasswordReq struct {
	OldPassword string `json:"old_password,omitempty"`
	Password    string `json:"password,omitempty"`
}

type UsersPage struct {
	Users []User `json:"users"`
	// contains filtered or unexported fields
}

type Webhook struct {
	ID      string            `json:"id"`
	GroupID string            `json:"group_id"`
	Name    string            `json:"name"`
	Url     string            `json:"url"`
	Headers map[string]string `json:"headers"`
}

type WebhooksPage struct {
	Webhooks []Webhook `json:"webhooks"`
	// contains filtered or unexported fields
}