models

Documentation

Index

• Constants
• func IsEmptyStringPointer(s *string) bool
• type BaseUser
• type ChildSpace
• type CredentialsDetail
• type OrganizationGroup
• type OrganizationMemberRole
  • func (e OrganizationMemberRole) IsValid() bool
  • func (e OrganizationMemberRole) String() string
• type ProjectMember
• type ProjectMemberRole
  • func (s ProjectMemberRole) IsValid() bool
  • func (s ProjectMemberRole) String() string
• type ProjectSchedulerSettings
  • func (s *ProjectSchedulerSettings) GetSchedulerTimezone() string
• type ProjectType
• type SpaceAccessGroup
• type SpaceAccessMember
• type SpaceDetails
  • func (s *SpaceDetails) GetDirectMemberAccess() []SpaceMemberAccess
  • func (s *SpaceDetails) GetGroupByUUID(groupUUID string) *SpaceAccessGroup
  • func (s *SpaceDetails) GetMemberByUUID(userUUID string) *SpaceMemberAccess
  • func (s *SpaceDetails) IsNestedSpace() bool
  • func (s *SpaceDetails) ResourceID() string
• type SpaceGroupAccess
• type SpaceMemberAccess
  • func (s *SpaceMemberAccess) GetSpaceAccessType() *string
  • func (s *SpaceMemberAccess) HasDirectSpaceMemberAccess() bool
• type SpaceMemberRole
  • func (s SpaceMemberRole) IsValid() bool
  • func (s SpaceMemberRole) String() string
• type WarehouseCredentials

Constants

const DefaultProjectSchedulerTimezone = "UTC"

The default timezone for the scheduler

Functions

func IsEmptyStringPointer

func IsEmptyStringPointer(s *string) bool

IsEmptyStringPointer returns true if the string pointer is nil or empty

Types

type BaseUser

type BaseUser struct {
	UserUUID string `json:"userUuid"`
}

type ChildSpace

type ChildSpace struct {
	SpaceUUID  string
	SpaceName  string
	IsPrivate  bool
	AccessList []SpaceMemberAccess
}

ChildSpace represents a nested space within a parent space

type CredentialsDetail

type CredentialsDetail struct {
	Type string `json:"type"`
	User string `json:"user,omitempty"`
}

type OrganizationGroup

type OrganizationGroup struct {
	OrganizationUUID string
	GroupUUID        string
	Name             string
	CreatedAt        string
}

type OrganizationMemberRole

type OrganizationMemberRole string

const (
	ORGANIZATION_MEMBER_ROLE             OrganizationMemberRole = "member"
	ORGANIZATION_VIEWER_ROLE             OrganizationMemberRole = "viewer"
	ORGANIZATION_INTERACTIVE_VIEWER_ROLE OrganizationMemberRole = "interactive_viewer"
	ORGANIZATION_EDITOR_ROLE             OrganizationMemberRole = "editor"
	ORGANIZATION_DEVELOPER_ROLE          OrganizationMemberRole = "developer"
	ORGANIZATION_ADMIN_ROLE              OrganizationMemberRole = "admin"
)

List of OrganizationMemberRole

func (OrganizationMemberRole) IsValid

func (e OrganizationMemberRole) IsValid() bool

Check if a given string is a valid OrganizationMemberRole

func (OrganizationMemberRole) String

func (e OrganizationMemberRole) String() string

default string

type ProjectMember

type ProjectMember struct {
	ProjectUUID string
	UserUUID    string
	Email       *string
	ProjectRole ProjectMemberRole
}

type ProjectMemberRole

type ProjectMemberRole string

const (
	PROJECT_VIEWER_ROLE             ProjectMemberRole = "viewer"
	PROJECT_INTERACTIVE_VIEWER_ROLE ProjectMemberRole = "interactive_viewer"
	PROJECT_EDITOR_ROLE             ProjectMemberRole = "editor"
	PROJECT_DEVELOPER_ROLE          ProjectMemberRole = "developer"
	PROJECT_ADMIN_ROLE              ProjectMemberRole = "admin"
)

List of ProjectMemberRole

func (ProjectMemberRole) IsValid

func (s ProjectMemberRole) IsValid() bool

Check if a given string is a valid ProjectMemberRole

func (ProjectMemberRole) String

func (s ProjectMemberRole) String() string

convert ProjectMemberRole to string

type ProjectSchedulerSettings

type ProjectSchedulerSettings struct {
	SchedulerTimezone string `json:"schedulerTimezone" validate:"required"`
}

SchedulerSettings represents the scheduler settings for a project

func (*ProjectSchedulerSettings) GetSchedulerTimezone

func (s *ProjectSchedulerSettings) GetSchedulerTimezone() string

GetSchedulerTimezone returns the scheduler timezone for the project

type ProjectType

type ProjectType string

const (
	DEFAULT_PROJECT_TYPE ProjectType = "DEFAULT"
	PREVIEW_PROJECT_TYPE ProjectType = "PREVIEW"
)

List of ProjectType

type SpaceAccessGroup

type SpaceAccessGroup struct {
	GroupUUID string
	SpaceRole SpaceMemberRole
}

SpaceAccessGroup represents a group's access to a space as returned by the API

type SpaceAccessMember

type SpaceAccessMember struct {
	UserUUID  string
	SpaceRole SpaceMemberRole
}

SpaceAccessMember represents the core information for a space access member used in requests.

type SpaceDetails

type SpaceDetails struct {
	ProjectUUID        string
	SpaceUUID          string
	ParentSpaceUUID    *string
	SpaceName          string
	IsPrivate          bool
	SpaceAccessMembers []SpaceMemberAccess // Full list from API for access_all
	SpaceAccessGroups  []SpaceAccessGroup  // Full list from API for group_access_all
	ChildSpaces        []ChildSpace        // Child spaces, if any
}

SpaceDetails contains all the details of a space returned by the GetSpace API. Note: For nested spaces, MemberAccess and GroupAccess lists will be empty as access is inherited.

func (*SpaceDetails) GetDirectMemberAccess

func (s *SpaceDetails) GetDirectMemberAccess() []SpaceMemberAccess

GetDirectMemberAccess returns only the members with direct access to the space

func (*SpaceDetails) GetGroupByUUID

func (s *SpaceDetails) GetGroupByUUID(groupUUID string) *SpaceAccessGroup

GetGroupByUUID returns a group by UUID, or nil if not found

func (*SpaceDetails) GetMemberByUUID

func (s *SpaceDetails) GetMemberByUUID(userUUID string) *SpaceMemberAccess

GetMemberByUUID returns a member by UUID, or nil if not found

func (*SpaceDetails) IsNestedSpace

func (s *SpaceDetails) IsNestedSpace() bool

IsNestedSpace returns true if the space is nested (has a parent)

func (*SpaceDetails) ResourceID

func (s *SpaceDetails) ResourceID() string

ResourceID returns the formatted resource ID for a space

type SpaceGroupAccess

type SpaceGroupAccess struct {
	GroupUUID string
	SpaceRole SpaceMemberRole
}

SpaceGroupAccess represents a group's access to a space

type SpaceMemberAccess

type SpaceMemberAccess struct {
	UserUUID  string
	SpaceRole SpaceMemberRole // Assuming SpaceMemberRole is also in models package
	// Fields from API response indicating how access is granted
	HasDirectAccess *bool   `json:"hasDirectAccess,omitempty"`
	InheritedRole   *string `json:"inheritedRole,omitempty"`
	InheritedFrom   *string `json:"inheritedFrom,omitempty"`
	ProjectRole     *string `json:"projectRole,omitempty"`
}

SpaceMemberAccess represents a user's access to a space as returned by the API

func (*SpaceMemberAccess) GetSpaceAccessType

func (s *SpaceMemberAccess) GetSpaceAccessType() *string

GetSpaceAccessType returns the type of space access for a member

func (*SpaceMemberAccess) HasDirectSpaceMemberAccess

func (s *SpaceMemberAccess) HasDirectSpaceMemberAccess() bool

HasDirectSpaceMemberAccess returns true if the member has direct access to the space

type SpaceMemberRole

type SpaceMemberRole string

const (
	SPACE_VIEWER_ROLE SpaceMemberRole = "viewer"
	SPACE_EDITOR_ROLE SpaceMemberRole = "editor"
	SPACE_ADMIN_ROLE  SpaceMemberRole = "admin"
)

List of ProjectMemberRole

func (SpaceMemberRole) IsValid

func (s SpaceMemberRole) IsValid() bool

Check if a given string is a valid SpaceMemberRole

func (SpaceMemberRole) String

func (s SpaceMemberRole) String() string

convert ProjectMemberRole to string

type WarehouseCredentials

type WarehouseCredentials struct {
	Credentials CredentialsDetail `json:"credentials"`
	UpdatedAt   time.Time         `json:"updatedAt"`
	CreatedAt   time.Time         `json:"createdAt"`
	Name        string            `json:"name"`
	UserUUID    string            `json:"userUuid,omitempty"`
	UUID        string            `json:"uuid"`
}