Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type OrganizationDetails ¶
type OrganizationDetails struct {
ID uuid.UUID `json:"id"`
CreatedAt mo.Option[time.Time] `json:"created_at,omitzero"`
Name string `json:"name"`
MemberCounts *components.MemberCounts `json:"member_counts,omitempty"`
Preferences *components.OrganizationPreferences `json:"preferences,omitempty"`
}
type OrganizationDetailsResult ¶
type OrganizationDetailsResult struct {
Meta *responsemeta.ResponseMeta
Data OrganizationDetails
}
type OrganizationMember ¶
type OrganizationMember struct {
ID uuid.UUID `json:"id"`
CreatedAt mo.Option[time.Time] `json:"created_at,omitzero"`
Email mo.Option[string] `json:"email,omitzero"`
FirstName mo.Option[string] `json:"first_name,omitzero"`
LastName mo.Option[string] `json:"last_name,omitzero"`
Roles []string `json:"roles,omitempty"`
LatestLoginTime mo.Option[time.Time] `json:"latest_login_time,omitzero"`
FirstLoginTime mo.Option[time.Time] `json:"first_login_time,omitzero"`
}
type OrganizationMembers ¶
type OrganizationMembers struct {
Members []OrganizationMember `json:"members"`
}
type OrganizationMembersResult ¶
type OrganizationMembersResult struct {
Meta *responsemeta.ResponseMeta
Data OrganizationMembers
}
type Service ¶
type Service interface {
// GetOrganizationDetails retrieves the details for an organization.
GetOrganizationDetails(
ctx context.Context,
orgID identifiers.OrganizationID,
) (OrganizationDetailsResult, cenclierrors.CencliError)
// ListOrganizationMembers retrieves the members for an organization.
// If no pagination is provided, the client will return all members.
ListOrganizationMembers(
ctx context.Context,
orgID identifiers.OrganizationID,
pageSize mo.Option[uint],
maxPages mo.Option[uint],
) (OrganizationMembersResult, cenclierrors.CencliError)
}
Service provides organization and member details capabilities.
Click to show internal directories.
Click to hide internal directories.