models.go

// Package sirv provides a Go SDK for the Sirv REST API.
package sirv

// TokenResponse represents the authentication token response.
type TokenResponse struct {
	Token     string   `json:"token"`
	ExpiresIn int      `json:"expiresIn"`
	Scope     []string `json:"scope"`
}

// AliasConfig represents alias configuration.
type AliasConfig struct {
	Prefix       string `json:"prefix,omitempty"`
	Cdn          *bool  `json:"cdn,omitempty"`
	CustomDomain string `json:"customDomain,omitempty"`
}

// AccountInfo represents account information.
type AccountInfo struct {
	Alias         string                  `json:"alias"`
	CdnURL        string                  `json:"cdnURL"`
	DateCreated   string                  `json:"dateCreated,omitempty"`
	Fetching      *FetchingOptions        `json:"fetching,omitempty"`
	Minify        *MinifyOptions          `json:"minify,omitempty"`
	Aliases       map[string]*AliasConfig `json:"aliases,omitempty"`
	FileSizeLimit int64                   `json:"fileSizeLimit,omitempty"`
}

// FetchingOptions represents HTTP fetching configuration.
type FetchingOptions struct {
	Enabled *bool              `json:"enabled,omitempty"`
	Type    string             `json:"type,omitempty"`
	HTTP    *HTTPFetchingConfig `json:"http,omitempty"`
}

// HTTPFetchingConfig represents HTTP fetching configuration details.
type HTTPFetchingConfig struct {
	Auth *HTTPFetchingAuth `json:"auth,omitempty"`
	URL  string            `json:"url,omitempty"`
}

// HTTPFetchingAuth represents HTTP fetching authentication settings.
type HTTPFetchingAuth struct {
	Enabled  bool   `json:"enabled"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

// MinifyOptions represents minification settings.
type MinifyOptions struct {
	Enabled *bool `json:"enabled,omitempty"`
}

// AccountUpdateOptions represents options for updating account settings.
type AccountUpdateOptions struct {
	Fetching *FetchingOptions `json:"fetching,omitempty"`
	Minify   *MinifyOptions   `json:"minify,omitempty"`
	Aliases  []string         `json:"aliases,omitempty"`
}

// RateLimitInfo represents rate limit information for a specific endpoint type.
type RateLimitInfo struct {
	Limit     int    `json:"limit"`
	Remaining int    `json:"remaining"`
	Reset     string `json:"reset,omitempty"`
	Count     int    `json:"count"`
}

// AccountLimits represents API rate limits for different endpoint types.
type AccountLimits struct {
	S3   *RateLimitInfo `json:"s3,omitempty"`
	Rest *RateLimitInfo `json:"rest,omitempty"`
	FTP  *RateLimitInfo `json:"ftp,omitempty"`
}

// StorageInfo represents storage usage information.
type StorageInfo struct {
	Allowance int64  `json:"allowance"`
	Used      int64  `json:"used"`
	Files     int64  `json:"files"`
	Burstable *int64 `json:"burstable,omitempty"`
}

// AccountUser represents account user information.
type AccountUser struct {
	UserID      string `json:"userId"`
	Email       string `json:"email"`
	FirstName   string `json:"firstName,omitempty"`
	LastName    string `json:"lastName,omitempty"`
	Role        string `json:"role"`
	DateCreated string `json:"dateCreated,omitempty"`
}

// PlanPrice represents plan price information.
type PlanPrice struct {
	Month   *float64 `json:"month,omitempty"`
	Year    *float64 `json:"year,omitempty"`
	Quarter *float64 `json:"quarter,omitempty"`
}

// BillingPlan represents billing plan information.
type BillingPlan struct {
	ID                string     `json:"id,omitempty"`
	Name              string     `json:"name"`
	Description       string     `json:"description,omitempty"`
	Period            string     `json:"period,omitempty"`
	Storage           int64      `json:"storage"`
	DataTransferLimit *int64     `json:"dataTransferLimit,omitempty"`
	Price             *PlanPrice `json:"price,omitempty"`
	DateActive        string     `json:"dateActive,omitempty"`
}

// AccountEvent represents an account event log entry.
type AccountEvent struct {
	ID        string `json:"id"`
	Module    string `json:"module"`
	Type      string `json:"type"`
	Level     string `json:"level"`
	Message   string `json:"message"`
	Filename  string `json:"filename,omitempty"`
	Timestamp string `json:"timestamp"`
	Seen      *bool  `json:"seen,omitempty"`
}

// EventSearchParams represents parameters for searching account events.
type EventSearchParams struct {
	Module   string `json:"module,omitempty"`
	Type     string `json:"type,omitempty"`
	Level    string `json:"level,omitempty"`
	Filename string `json:"filename,omitempty"`
	From     string `json:"from,omitempty"`
	To       string `json:"to,omitempty"`
}

// UserInfo represents user information.
type UserInfo struct {
	UserID      string `json:"userId"`
	Email       string `json:"email"`
	FirstName   string `json:"firstName,omitempty"`
	LastName    string `json:"lastName,omitempty"`
	DateCreated string `json:"dateCreated,omitempty"`
	S3Key       string `json:"s3Key,omitempty"`
	S3Secret    string `json:"s3Secret,omitempty"`
}

// FileMeta represents file metadata.
type FileMeta struct {
	Title       string   `json:"title,omitempty"`
	Description string   `json:"description,omitempty"`
	Tags        []string `json:"tags,omitempty"`
	Approved    *bool    `json:"approved,omitempty"`
}

// FileInfo represents file or folder information.
type FileInfo struct {
	Filename    string    `json:"filename"`
	Dirname     string    `json:"dirname,omitempty"`
	Basename    string    `json:"basename,omitempty"`
	IsDirectory bool      `json:"isDirectory"`
	Size        *int64    `json:"size,omitempty"`
	Ctime       string    `json:"ctime,omitempty"`
	Mtime       string    `json:"mtime,omitempty"`
	ContentType string    `json:"contentType,omitempty"`
	Meta        *FileMeta `json:"meta,omitempty"`
}

// ProductMeta represents product-specific metadata.
type ProductMeta struct {
	ID       string `json:"id,omitempty"`
	Name     string `json:"name,omitempty"`
	Brand    string `json:"brand,omitempty"`
	Category string `json:"category,omitempty"`
	SKU      string `json:"sku,omitempty"`
}

// FolderContents represents folder contents response.
type FolderContents struct {
	Contents     []FileInfo `json:"contents"`
	Continuation string     `json:"continuation,omitempty"`
}

// FolderOptions represents folder options/settings.
type FolderOptions struct {
	ScanSpins    *bool `json:"scanSpins,omitempty"`
	AllowListing *bool `json:"allowListing,omitempty"`
}

// SortOptions represents sort options for search.
type SortOptions struct {
	Field string `json:"field"`
	Order string `json:"order"` // "asc" or "desc"
}

// SearchFilters represents search filters.
type SearchFilters struct {
	Dirname     string      `json:"dirname,omitempty"`
	Filename    string      `json:"filename,omitempty"`
	Basename    string      `json:"basename,omitempty"`
	Extension   interface{} `json:"extension,omitempty"`   // string or []string
	ContentType interface{} `json:"contentType,omitempty"` // string or []string
	MinSize     *int64      `json:"minSize,omitempty"`
	MaxSize     *int64      `json:"maxSize,omitempty"`
	MinDate     string      `json:"minDate,omitempty"`
	MaxDate     string      `json:"maxDate,omitempty"`
}

// SearchParams represents parameters for file search.
type SearchParams struct {
	Query   string         `json:"query,omitempty"`
	From    *int           `json:"from,omitempty"`
	Size    *int           `json:"size,omitempty"`
	Sort    *SortOptions   `json:"sort,omitempty"`
	Filters *SearchFilters `json:"filters,omitempty"`
}

// SearchResult represents search results.
type SearchResult struct {
	Hits     []FileInfo `json:"hits"`
	Total    int64      `json:"total"`
	ScrollID string     `json:"scrollId,omitempty"`
}

// UploadOptions represents upload options.
type UploadOptions struct {
	Filename    string `json:"filename,omitempty"`
	ContentType string `json:"contentType,omitempty"`
}

// FetchURLParams represents parameters for fetching file from URL.
type FetchURLParams struct {
	URL      string `json:"url"`
	Filename string `json:"filename"`
	Wait     *bool  `json:"wait,omitempty"`
}

// CopyParams represents copy operation parameters.
type CopyParams struct {
	From string `json:"from"`
	To   string `json:"to"`
}

// RenameParams represents rename/move operation parameters.
type RenameParams struct {
	From string `json:"from"`
	To   string `json:"to"`
}

// BatchDeleteResult represents batch delete operation result.
type BatchDeleteResult struct {
	JobID   string               `json:"jobId,omitempty"`
	Status  string               `json:"status,omitempty"`
	Results []BatchDeleteItemResult `json:"results,omitempty"`
}

// BatchDeleteItemResult represents result for a single file in batch delete.
type BatchDeleteItemResult struct {
	Filename string `json:"filename"`
	Success  bool   `json:"success"`
	Error    string `json:"error,omitempty"`
}

// BatchZipParams represents batch ZIP operation parameters.
type BatchZipParams struct {
	Filenames []string `json:"filenames"`
	Filename  string   `json:"filename"`
}

// BatchZipResult represents batch ZIP operation result.
type BatchZipResult struct {
	JobID    string `json:"jobId,omitempty"`
	Status   string `json:"status,omitempty"`
	Filename string `json:"filename,omitempty"`
}

// JWTParams represents JWT generation parameters.
type JWTParams struct {
	Filename     string            `json:"filename"`
	ExpiresIn    *int              `json:"expiresIn,omitempty"`
	SecureParams map[string]string `json:"secureParams,omitempty"`
}

// JWTResponse represents JWT generation response.
type JWTResponse struct {
	URL   string `json:"url"`
	Token string `json:"token"`
}

// SpinConvertOptions represents spin conversion options.
type SpinConvertOptions struct {
	Width  *int   `json:"width,omitempty"`
	Height *int   `json:"height,omitempty"`
	Loops  *int   `json:"loops,omitempty"`
	Format string `json:"format,omitempty"`
}

// SpinConvertParams represents spin to video conversion parameters.
type SpinConvertParams struct {
	Filename string              `json:"filename"`
	Options  *SpinConvertOptions `json:"options,omitempty"`
}

// Video2SpinOptions represents video to spin conversion options.
type Video2SpinOptions struct {
	Frames   *int     `json:"frames,omitempty"`
	Start    *float64 `json:"start,omitempty"`
	Duration *float64 `json:"duration,omitempty"`
}

// Video2SpinParams represents video to spin conversion parameters.
type Video2SpinParams struct {
	Filename       string             `json:"filename"`
	TargetFilename string             `json:"targetFilename,omitempty"`
	Options        *Video2SpinOptions `json:"options,omitempty"`
}

// ExportSpinParams represents spin export parameters.
type ExportSpinParams struct {
	Filename  string `json:"filename"`
	ASIN      string `json:"asin,omitempty"`
	ProductID string `json:"productId,omitempty"`
}

// PointOfInterest represents a point of interest on a spin.
type PointOfInterest struct {
	Name  string  `json:"name"`
	X     float64 `json:"x"`
	Y     float64 `json:"y"`
	Frame *int    `json:"frame,omitempty"`
}

// StatsParams represents date range parameters for statistics.
type StatsParams struct {
	From string `json:"from"`
	To   string `json:"to"`
}

// HTTPStats represents HTTP transfer statistics entry.
type HTTPStats struct {
	Date     string `json:"date"`
	Transfer int64  `json:"transfer"`
	Requests *int64 `json:"requests,omitempty"`
}

// SpinViewStats represents spin view statistics entry.
type SpinViewStats struct {
	Date        string `json:"date"`
	Views       int64  `json:"views"`
	Spins       *int64 `json:"spins,omitempty"`
	Zooms       *int64 `json:"zooms,omitempty"`
	Fullscreens *int64 `json:"fullscreens,omitempty"`
	UserAgent   string `json:"userAgent,omitempty"`
	Country     string `json:"country,omitempty"`
}

// StorageStats represents storage statistics entry.
type StorageStats struct {
	Date    string `json:"date"`
	Storage int64  `json:"storage"`
	Files   *int64 `json:"files,omitempty"`
}

// Internal models for raw Elasticsearch responses.

type rawSearchHit struct {
	Source *rawFileSource `json:"_source,omitempty"`
}

type rawFileSource struct {
	Filename    string    `json:"filename"`
	Dirname     string    `json:"dirname,omitempty"`
	Basename    string    `json:"basename,omitempty"`
	IsDirectory bool      `json:"isDirectory"`
	Size        *int64    `json:"size,omitempty"`
	Ctime       string    `json:"ctime,omitempty"`
	Mtime       string    `json:"mtime,omitempty"`
	ContentType string    `json:"contentType,omitempty"`
	Meta        *FileMeta `json:"meta,omitempty"`
}

type rawSearchResult struct {
	Hits     []rawSearchHit `json:"hits,omitempty"`
	Total    interface{}    `json:"total,omitempty"`
	ScrollID string         `json:"scrollId,omitempty"`
}

type totalCount struct {
	Value int64 `json:"value"`
}