api

type ActionInterface interface {
	// GetByName gets an action by name.
	GetByName(ctx context.Context, actionName *name.Action) (*openv1alpha1resource.Action, error)

	// ListAllActions lists all actions in the current organization.
	ListAllActions(ctx context.Context, listOpts *ListActionsOptions) ([]*openv1alpha1resource.Action, error)

	// CreateActionRun creates an action run.
	CreateActionRun(ctx context.Context, action *openv1alpha1resource.Action, record *name.Record) error

	// ListAllActionRuns lists all action runs in the current organization.
	ListAllActionRuns(ctx context.Context, listOpts *ListActionRunsOptions) ([]*openv1alpha1resource.ActionRun, error)

	// ActionId2Name converts an action id or name to an action name.
	ActionId2Name(ctx context.Context, actionIdOrName string, projectNameStr *name.Project) (*name.Action, error)
}

type ContainerRegistryInterface interface {
	// CreateBasicCredential creates a basic docker credential (username+password).
	CreateBasicCredential(ctx context.Context) (*openv1alpha1service.BasicCredential, error)
}

type CreateProjectOptions struct {
	Slug        string
	DisplayName string
	Visibility  enums.ProjectVisibilityEnum_ProjectVisibility
	Description string
	FileSystem  string
}

type CreateProjectUsingTemplateOptions struct {
	Parent          string
	Slug            string
	DisplayName     string
	ProjectTemplate string
	TemplateScopes  []openv1alpha1service.CreateProjectUsingTemplateRequest_TemplateScope
	Visibility      enums.ProjectVisibilityEnum_ProjectVisibility
	Description     string
}

type CustomFieldInterface interface {
	GetRecordCustomFieldSchema(ctx context.Context, project *name.Project) (*commons.CustomFieldSchema, error)
}

type EventInterface interface {
	// ObtainEvent creates an event if not found, fetches otherwise.
	ObtainEvent(ctx context.Context, parent string, event *openv1alpha1resource.Event) (*openv1alpha1service.ObtainEventResponse, error)
}

type FileInterface interface {
	// GetFile gets a file by name.
	GetFile(ctx context.Context, fileResourceName string) (*openv1alpha1resource.File, error)

	// GenerateFileUploadUrls generates pre-signed URLs for file uploads.
	GenerateFileUploadUrls(ctx context.Context, parent string, files []*openv1alpha1resource.File) (map[string]string, error)

	// GenerateFileDownloadUrl generates a pre-signed URL for file download.
	GenerateFileDownloadUrl(ctx context.Context, fileResourceName string) (string, error)

	// DeleteFile deletes a file by name.
	DeleteFile(ctx context.Context, fileResourceName string) error

	// BatchDeleteFiles deletes multiple files under a parent.
	BatchDeleteFiles(ctx context.Context, parent string, names []string) error
}

type FileSystemInterface interface {
	ListAllFileSystems(ctx context.Context) ([]*openv1alpha1resource.FileSystem, error)
}

type LabelInterface interface {
	// GetByDisplayNameOrCreate gets a label by display name, creates it if not found.
	GetByDisplayNameOrCreate(ctx context.Context, displayName string, projectName *name.Project) (*openv1alpha1resource.Label, error)
}

type ListActionRunsOptions struct {
	Parent      string
	RecordNames []*name.Record
}

type ListActionsOptions struct {
	Parent string
}

type ListProjectsOptions struct {
	DisplayNames   []string
	IncludeArchive bool
}

type ListRolesOptions struct {
	Level     string
	PageSize  int32
	PageToken string
}

type ListRolesResult struct {
	Roles         []*openv1alpha1resource.Role
	NextPageToken string
	TotalSize     int64
}

type ListUsersOptions struct {
	Parent    string
	PageSize  int32
	PageToken string
	RoleCode  string
	Filter    string
}

type ListUsersResult struct {
	Users         []*openv1alpha1resource.User
	NextPageToken string
	TotalSize     int64
}

type Moment struct {
	Name              string            `json:"name"`
	Description       string            `json:"description"`
	TriggerTime       string            `json:"triggerTime"`
	Duration          string            `json:"duration"`
	Attribute         map[string]string `json:"attribute"`
	CustomFieldValues []map[string]any  `json:"customFieldValues"`
}

type OrganizationInterface interface {
	// Slug get org slug.
	Slug(ctx context.Context, org *name.Organization) (string, error)
}

type ProjectInterface interface {
	// Name gets the project resource name from the project slug.
	Name(ctx context.Context, projectSlug string) (*name.Project, error)

	// Get gets a project by name.
	Get(ctx context.Context, projectName *name.Project) (*openv1alpha1resource.Project, error)

	// ListAllUserProjects lists all projects in the current organization.
	ListAllUserProjects(ctx context.Context, listOpts *ListProjectsOptions) ([]*openv1alpha1resource.Project, error)

	// ListProjectsWithPagination lists projects with pagination.
	ListProjectsWithPagination(ctx context.Context, pageSize int, skip int, listOpts *ListProjectsOptions) ([]*openv1alpha1resource.Project, error)

	// CreateProject creates a project.
	CreateProject(ctx context.Context, opts *CreateProjectOptions) (*openv1alpha1resource.Project, error)

	// CreateProjectUsingTemplate creates a project using a template.
	CreateProjectUsingTemplate(ctx context.Context, opts *CreateProjectUsingTemplateOptions) (*openv1alpha1resource.Project, error)

	// ListAllFiles lists all files in a project.
	ListAllFiles(ctx context.Context, projectName *name.Project) ([]*openv1alpha1resource.File, error)

	// ListAllFilesWithFilter lists all files in a project with additional filter.
	ListAllFilesWithFilter(ctx context.Context, projectName *name.Project, additionalFilter string) ([]*openv1alpha1resource.File, error)

	// ListFilesWithPagination lists files in a project with pagination support.
	ListFilesWithPagination(ctx context.Context, projectName *name.Project, pageSize int, skip int) ([]*openv1alpha1resource.File, error)

	// ListFilesWithPaginationAndFilter lists files in a project with pagination support and additional filter.
	ListFilesWithPaginationAndFilter(ctx context.Context, projectName *name.Project, pageSize int, skip int, additionalFilter string) ([]*openv1alpha1resource.File, error)
}

type RecordInterface interface {
	// Get gets a record by name.
	Get(ctx context.Context, recordName *name.Record) (*openv1alpha1resource.Record, error)

	// Create creates a record.
	Create(ctx context.Context, parent *name.Project, title string, deviceNameStr string, description string, labelDisplayNames []*openv1alpha1resource.Label, customFieldValues []*commons.CustomFieldValue) (*openv1alpha1resource.Record, error)

	// Copy copies a record to target project.
	Copy(ctx context.Context, recordName *name.Record, targetProjectName *name.Project) (*openv1alpha1resource.Record, error)

	// Move moves a record to target project.
	Move(ctx context.Context, recordName *name.Record, targetProjectName *name.Project) (*openv1alpha1resource.Record, error)

	// CopyFiles copies files from src record to dst record.
	CopyFiles(ctx context.Context, srcRecordName *name.Record, dstRecordName *name.Record, files []*openv1alpha1resource.File) error

	// MoveFiles moves files from src record to dst record.
	MoveFiles(ctx context.Context, srcRecordName *name.Record, dstRecordName *name.Record, files []*openv1alpha1resource.File) error

	// ListAllFiles lists all files in a record.
	ListAllFiles(ctx context.Context, recordName *name.Record) ([]*openv1alpha1resource.File, error)

	// ListAllFilesWithFilter lists all files in a record with additional filter.
	ListAllFilesWithFilter(ctx context.Context, recordName *name.Record, additionalFilter string) ([]*openv1alpha1resource.File, error)

	// ListFilesWithPagination lists files in a record with pagination support.
	ListFilesWithPagination(ctx context.Context, recordName *name.Record, pageSize int, skip int) ([]*openv1alpha1resource.File, error)

	// ListFilesWithPaginationAndFilter lists files in a record with pagination support and additional filter.
	ListFilesWithPaginationAndFilter(ctx context.Context, recordName *name.Record, pageSize int, skip int, additionalFilter string) ([]*openv1alpha1resource.File, error)

	// Delete deletes a record by name.
	Delete(ctx context.Context, recordName *name.Record) error

	// DeleteFile deletes a file by name.
	DeleteFile(ctx context.Context, recordName *name.Record, fileName string) error

	// Update updates a record.
	Update(ctx context.Context, recordName *name.Record, title string, description string, labels []*openv1alpha1resource.Label, customFieldValues []*commons.CustomFieldValue, fieldMask []string) error

	// ListAllEvents lists all events in a record.
	ListAllEvents(ctx context.Context, recordName *name.Record) ([]*openv1alpha1resource.Event, error)

	// ListAllMoments lists all moments in a record.
	ListAllMoments(ctx context.Context, recordName *name.Record) ([]*Moment, error)

	// SearchAll searches all records in a project using the new SearchRecords API.
	SearchAll(ctx context.Context, options *SearchRecordsOptions) ([]*openv1alpha1resource.Record, error)

	// SearchWithPageToken searches records with page token support (new API).
	SearchWithPageToken(ctx context.Context, options *SearchRecordsOptions) (*SearchRecordsResult, error)

	// GenerateRecordThumbnailUploadUrl generates a pre-signed URL for uploading a record thumbnail.
	GenerateRecordThumbnailUploadUrl(ctx context.Context, recordName *name.Record) (string, error)

	// RecordId2Name converts a record id or name to a record name.
	RecordId2Name(ctx context.Context, recordIdOrName string, projectNameStr *name.Project) (*name.Record, error)
}

type RoleInterface interface {
	ListRoles(ctx context.Context, opts *ListRolesOptions) (*ListRolesResult, error)
}

type SearchRecordsOptions struct {
	Project        *name.Project
	Titles         []string
	Labels         []string
	IncludeArchive bool
	Search         string
	PageSize       int32
	PageToken      string
	OrderBy        string
}

type SearchRecordsResult struct {
	Records       []*openv1alpha1resource.Record
	NextPageToken string
	TotalSize     int64
}

type SecurityTokenInterface interface {
	GenerateSecurityToken(ctx context.Context, project string) (*openDssv1alphaservice.GenerateSecurityTokenResponse, error)
}

type TaskInterface interface {
	UpsertTask(ctx context.Context, parent string, task *openv1alpha1resource.Task) (*openv1alpha1resource.Task, error)
	SyncTask(ctx context.Context, taskName string) (*openv1alpha1resource.Task, error)
}

type UserInterface interface {
	BatchGetUsers(ctx context.Context, userNameList mapset.Set[name.User]) (map[string]*openv1alpha1resource.User, error)
	ListUsers(ctx context.Context, opts *ListUsersOptions) (*ListUsersResult, error)
	GetUser(ctx context.Context, userName string) (*openv1alpha1resource.User, error)
	FindUsersByNickname(ctx context.Context, nickname string) ([]*openv1alpha1resource.User, error)
}