models

type AAGUID []byte

type Address struct {
	// Line1 is the first line of the address
	Line1 string `json:"line1"`
	// Line2 is the second line of the address
	Line2 string `json:"line2"`
	// City is the city of the address
	City string `json:"city"`
	// State is the state of the address
	State string `json:"state"`
	// PostalCode is the postal code of the address
	PostalCode string `json:"postalCode"`
	// Country is the country of the address
	Country string `json:"country"`
}

type AssessmentMethod struct {
	// ID is the unique identifier for the assessment method
	ID string `json:"id,omitempty"`
	// Type is the type of assessment being performed, e.g. Interview, Test, etc.
	Type string `json:"type,omitempty"`
	// Method is the associated language describing the assessment method
	Method string `json:"method,omitempty"`
}

type AssessmentObjective struct {
	// Class is the class of the assessment objective which is typically what framework it origins from
	Class string `json:"class,omitempty"`
	// ID is the unique identifier for the assessment objective
	ID string `json:"id,omitempty"`
	// Objective is the associated language describing the assessment objective
	Objective string `json:"objective,omitempty" `
}

type AuditLogOrderField string

type Billing struct {
	// Prices is a list of price options for the feature, each with its own billing interval and amount
	Prices []ItemPrice `json:"prices" yaml:"prices" jsonschema:"description=List of price options for this feature"`
}

type Catalog struct {
	// Version is the version of the catalog, following semantic versioning
	// It is used to track changes and updates to the catalog structure and content.
	// Example: "1.0.0", "2.3.1"
	Version string `json:"version" yaml:"version" jsonschema:"description=Catalog version,example=1.0.0"`
	// SHA is the SHA256 hash of the catalog version string, used to verify integrity
	SHA string `json:"sha" yaml:"sha" jsonschema:"description=SHA of the catalog version"`
	// Modules is a set of purchasable modules available in the catalog
	// Each module has its own set of features, pricing, and audience targeting.
	// Example: "compliance", "reporting", "analytics"
	Modules FeatureSet `json:"modules" yaml:"modules" jsonschema:"description=Set of modules available in the catalog"`
	// Addons is a set of purchasable addons available in the catalog
	Addons FeatureSet `json:"addons" yaml:"addons" jsonschema:"description=Set of addons available in the catalog"`
}

type Change struct {
	// FieldName is the name of the field that changed.
	FieldName string
	// Old is the old value of the field.
	Old any
	// New is the new value of the field.
	New any
}

type CredentialSet struct {
	// AccessKeyID for cloud providers
	AccessKeyID string `json:"accessKeyID"`
	// SecretAccessKey for cloud providers
	SecretAccessKey string `json:"secretAccessKey"`
	// SessionToken for temporary cloud credentials
	SessionToken string `json:"sessionToken"`
	// ProjectID for GCS
	ProjectID string `json:"projectID"`
	// AccountID for Cloudflare R2
	AccountID string `json:"accountID"`
	// APIToken for Cloudflare R2
	APIToken string `json:"apiToken"`
	// ProviderData stores provider-specific metadata or attributes
	ProviderData map[string]any `json:"providerData,omitempty"`
	// OAuthAccessToken holds the OAuth access token when applicable
	OAuthAccessToken string `json:"oauthAccessToken,omitempty"`
	// OAuthRefreshToken holds the OAuth refresh token when applicable
	OAuthRefreshToken string `json:"oauthRefreshToken,omitempty"`
	// OAuthTokenType stores the OAuth token type (e.g., Bearer)
	OAuthTokenType string `json:"oauthTokenType,omitempty"`
	// OAuthExpiry stores the token expiry timestamp
	OAuthExpiry *time.Time `json:"oauthExpiry,omitempty"`
	// Claims stores serialized ID token claims if available
	Claims map[string]any `json:"claims,omitempty"`
}

type Cron string

type DateTime time.Time

type Days []enums.JobWeekday

type EmailBranding struct {
	BrandName       string `json:"brandName,omitempty"`
	LogoURL         string `json:"logoURL,omitempty"`
	PrimaryColor    string `json:"primaryColor,omitempty"`
	SecondaryColor  string `json:"secondaryColor,omitempty"`
	BackgroundColor string `json:"backgroundColor,omitempty"`
	TextColor       string `json:"textColor,omitempty"`
	ButtonColor     string `json:"buttonColor,omitempty"`
	ButtonTextColor string `json:"buttonTextColor,omitempty"`
	LinkColor       string `json:"linkColor,omitempty"`
	FontFamily      string `json:"fontFamily,omitempty"`
}

type EvidenceRequests struct {
	// EvidenceRequestID is the unique identifier for where the evidence requests were sourced from
	EvidenceRequestID string `json:"evidenceRequestID,omitempty"`
	// DocumentationArtifact is a description of the documentation you'd produce as evidence
	DocumentationArtifact string `json:"documentationArtifact,omitempty"`
	// ArtifactDescription is a description of the evidence artifact
	ArtifactDescription string `json:"artifactDescription,omitempty"`
	// AreaOfFocus is the area of focus for the evidence request
	AreaOfFocus string `json:"areaOfFocus,omitempty"`
}

type ExampleEvidence struct {
	// DocumentationType is the documentation artifact type for the example evidence
	DocumentationType string `json:"documentationType,omitempty"`
	// Description is the description of the example documentation artifact for the evidence
	Description string `json:"description,omitempty"`
}

type Feature struct {
	// DisplayName is the human-readable name for the feature
	DisplayName string `` /* 127-byte string literal not displayed */
	// LookupKey is a stable identifier for the feature, used for referencing in Stripe
	// and other systems. It should be lowercase, alphanumeric, and can include underscores or dashes.
	// Example: "compliance", "advanced_reporting"
	// Pattern: ^[a-z0-9_-]+$
	LookupKey string `` /* 155-byte string literal not displayed */
	// Description provides additional context about the feature
	Description string `` /* 171-byte string literal not displayed */
	// MarketingDescription is a longer description of the feature used for marketing material
	MarketingDescription string `` /* 263-byte string literal not displayed */
	// Billing contains the pricing information for the feature
	Billing Billing `json:"billing" yaml:"billing" jsonschema:"description=Billing information for the feature"`
	// Audience indicates the intended audience for the feature - it can either be "public", "private", or "beta".
	// - "public" features are available to all users
	// - "private" features are restricted to specific users or organizations
	// - "beta" features are in testing and may not be fully stable
	Audience string `` /* 140-byte string literal not displayed */
	// Usage defines the usage limits granted by the feature, such as storage or record counts
	Usage *Usage `json:"usage,omitempty" yaml:"usage,omitempty" jsonschema:"description=Usage limits granted by the feature"`
	// ProductID is the Stripe product ID associated with this feature
	ProductID string `json:"product_id,omitempty" yaml:"product_id,omitempty" jsonschema:"description=Stripe product ID"`
	// PersonalOrg indicates if the feature should be automatically added to personal organizations
	PersonalOrg bool `` /* 126-byte string literal not displayed */
	// IncludeWithTrial indicates if the feature should be automatically included with trial subscriptions
	IncludeWithTrial bool `` /* 137-byte string literal not displayed */
}

type FeatureSet map[string]Feature

type ImplementationGuidance struct {
	// ReferenceID is the unique identifier for where the guidance was sourced from
	ReferenceID string `json:"referenceId,omitempty"`
	// Guidance are the steps to take to implement the control
	Guidance []string `json:"guidance,omitempty"`
}

type ItemPrice struct {
	Interval   string            `json:"interval" yaml:"interval" jsonschema:"enum=year,enum=month,description=Billing interval for the price,example=month"`
	UnitAmount int64             `json:"unit_amount" yaml:"unit_amount" jsonschema:"description=Amount to be charged per interval,example=1000"`
	Nickname   string            `` /* 141-byte string literal not displayed */
	LookupKey  string            `` /* 180-byte string literal not displayed */
	Metadata   map[string]string `` /* 141-byte string literal not displayed */
	PriceID    string            `json:"price_id,omitempty" yaml:"price_id,omitempty" jsonschema:"description=Stripe price ID,example=price_1N2Yw2A1b2c3d4e5"`
}

type JobCadence struct {
	Days      Days                      `json:"days,omitempty"`
	Time      string                    `json:"time,omitempty"`
	Frequency enums.JobCadenceFrequency `json:"frequency,omitempty"`
}

type JobConfiguration json.RawMessage

type OrgModule string

type Price struct {
	// Amount is the dollar amount of the price (e.g 100)
	Amount float64 `json:"amount"`
	// Interval is the interval of the price (e.g monthly, yearly)
	Interval string `json:"interval"`
	// Currency is the currency of the price that is being charged (e.g USD)
	Currency string `json:"currency"`
}

type Reference struct {
	// Name is the name of the reference
	Name string `json:"name,omitempty"`
	// URL is the link to the reference
	URL string `json:"url,omitempty"`
}

type SSOAuthorizationMap map[string]time.Time

type SearchContext struct {
	EntityID      string           `json:"entityID"`
	EntityType    string           `json:"entityType"`
	MatchedFields []string         `json:"matchedFields"`
	Snippets      []*SearchSnippet `json:"snippets,omitempty"`
}

type SearchSnippet struct {
	Field string `json:"field"`
	Text  string `json:"text"`
}

type SemverVersion struct {
	// Major is the major version
	Major int `json:"major,omitempty"`
	// Minor is the minor version
	Minor int `json:"minor,omitempty"`
	// Patch is the patch version
	Patch int `json:"patch,omitempty"`
	// PreRelease is the pre-release version (used for draft versions)
	PreRelease string `json:"preRelease,omitempty"`
}

type Sortable interface {
	GetSortField() string
}

type TestingProcedures struct {
	// ReferenceID is the unique identifier for where the procedures were sourced from
	ReferenceID string `json:"referenceId,omitempty"`
	// Procedures are the steps to take to test the control
	Procedures []string `json:"procedures,omitempty"`
}

type Usage struct {
	// EvidenceStorageGB is the storage limit in GB for evidence related to the feature
	EvidenceStorageGB int64 `` /* 142-byte string literal not displayed */
	// RecordCount is the maximum number of records allowed for the feature
	RecordCount int64 `` /* 131-byte string literal not displayed */
}

type VersionBump string

type WorkflowAction struct {
	// Key is the unique action key within the workflow
	Key string `json:"key,omitempty"`
	// Type is the action type such as REQUEST_APPROVAL or NOTIFY
	Type string `json:"type,omitempty"`
	// Params contains action-specific configuration payload
	Params json.RawMessage `json:"params,omitempty"`
	// When is an optional CEL expression that conditionally executes the action
	When string `json:"when,omitempty"`
	// Description is a human-readable action description
	Description string `json:"description,omitempty"`
}

type WorkflowAssignmentApproval struct {
	// ActionKey is the workflow action key this assignment belongs to
	ActionKey string `json:"action_key,omitempty"`
	// Required indicates if this assignment is required for workflow progression
	Required bool `json:"required,omitempty"`
	// RequiredCount is the quorum count needed if using count-based approval
	RequiredCount int `json:"required_count,omitempty"`
	// Label is an optional human-readable label for the assignment
	Label string `json:"label,omitempty"`
	// ProposedHash is the hash of the proposal changes when this assignment was created
	ProposedHash string `json:"proposed_hash,omitempty"`
	// ApprovedAt captures when the assignment was approved
	ApprovedAt string `json:"approved_at,omitempty"`
	// ApprovedByUserID is the user who approved the assignment
	ApprovedByUserID string `json:"approved_by_user_id,omitempty"`
}

type WorkflowAssignmentContext struct {
	// AssignmentKey is the workflow action key that produced this assignment
	AssignmentKey string `json:"assignmentKey,omitempty"`
	// Status is the current assignment status
	Status enums.WorkflowAssignmentStatus `json:"status,omitempty"`
	// ActorUserID is the user actor associated with the decision when available
	ActorUserID string `json:"actorUserId,omitempty"`
	// ActorGroupID is the group actor associated with the decision when available
	ActorGroupID string `json:"actorGroupId,omitempty"`
	// DecidedAt is when the assignment transitioned to a decided state
	DecidedAt *time.Time `json:"decidedAt,omitempty"`
	// Notes stores optional assignment decision notes
	Notes string `json:"notes,omitempty"`
}

type WorkflowAssignmentInvalidation struct {
	// Reason explains why the approval was invalidated
	Reason string `json:"reason,omitempty"`
	// PreviousStatus is the status before invalidation such as APPROVED
	PreviousStatus string `json:"previous_status,omitempty"`
	// InvalidatedAt is when the invalidation occurred
	InvalidatedAt string `json:"invalidated_at,omitempty"`
	// InvalidatedByUserID is the user who made the change that triggered invalidation
	InvalidatedByUserID string `json:"invalidated_by_user_id,omitempty"`
	// ApprovedHash is the hash that was approved before invalidation
	ApprovedHash string `json:"approved_hash,omitempty"`
	// NewProposedHash is the new hash after the changes that triggered invalidation
	NewProposedHash string `json:"new_proposed_hash,omitempty"`
}

type WorkflowAssignmentRejection struct {
	// ActionKey is the workflow action key this assignment belongs to
	ActionKey string `json:"action_key,omitempty"`
	// RejectionReason stores an optional rejection reason
	RejectionReason string `json:"rejection_reason,omitempty"`
	// RejectedAt is when the rejection occurred
	RejectedAt string `json:"rejected_at,omitempty"`
	// RejectedByUserID is the user who made the rejection decision
	RejectedByUserID string `json:"rejected_by_user_id,omitempty"`
	// RejectedHash is the hash that was rejected encapsulating the changes that were not merged
	RejectedHash string `json:"rejected_hash,omitempty"`
	// ChangeRequestInputs stores optional structured inputs for change requests
	ChangeRequestInputs map[string]any `json:"change_request_inputs,omitempty"`
}

type WorkflowCondition struct {
	// Expression is the CEL condition that must evaluate to true
	Expression string `json:"expression,omitempty"`
	// Description is a human-readable condition description
	Description string `json:"description,omitempty"`
}

type WorkflowDefinitionDocument struct {
	// Name is the workflow definition name
	Name string `json:"name,omitempty"`
	// Description describes what the workflow does
	Description string `json:"description,omitempty"`
	// SchemaType is the primary schema/object type targeted by the workflow
	SchemaType string `json:"schemaType,omitempty"`
	// WorkflowKind selects the workflow execution behavior
	WorkflowKind enums.WorkflowKind `json:"workflowKind,omitempty"`
	// ApprovalSubmissionMode controls draft vs auto-submit behavior for approval domains
	ApprovalSubmissionMode enums.WorkflowApprovalSubmissionMode `json:"approvalSubmissionMode,omitempty"`
	// ApprovalTiming controls whether approvals block changes or happen after commit
	ApprovalTiming enums.WorkflowApprovalTiming `json:"approvalTiming,omitempty"`
	// Version tracks the definition document version
	Version string `json:"version,omitempty"`
	// Targets scopes which objects are eligible for this definition
	Targets WorkflowSelector `json:"targets,omitempty"`
	// Triggers defines which events start workflow evaluation
	Triggers []WorkflowTrigger `json:"triggers,omitempty"`
	// Conditions defines CEL predicates that must pass for execution
	Conditions []WorkflowCondition `json:"conditions,omitempty"`
	// Actions defines the ordered workflow steps to execute
	Actions []WorkflowAction `json:"actions,omitempty"`
	// Metadata stores optional extensible workflow metadata
	Metadata map[string]any `json:"metadata,omitempty"`
}

type WorkflowDefinitionSchema struct {
	// Version tracks the schema document version
	Version string `json:"version,omitempty"`
	// Schema contains the optional JSONSchema used to validate definitions
	Schema json.RawMessage `json:"schema,omitempty"`
}

type WorkflowEventPayload struct {
	// EventType identifies the workflow event kind
	EventType enums.WorkflowEventType `json:"eventType,omitempty"`
	// ActionKey identifies the related action when applicable
	ActionKey string `json:"actionKey,omitempty"`
	// Details stores event-specific payload data
	Details json.RawMessage `json:"details,omitempty"`
}

type WorkflowInstanceContext struct {
	// WorkflowDefinitionID is the definition that produced this instance
	WorkflowDefinitionID string `json:"workflowDefinitionId,omitempty"`
	// ObjectType is the workflow object type under evaluation
	ObjectType enums.WorkflowObjectType `json:"objectType,omitempty"`
	// ObjectID is the concrete object identifier under evaluation
	ObjectID string `json:"objectId,omitempty"`
	// Version increments as instance context evolves
	Version int `json:"version,omitempty"`
	// Assignments snapshots assignment decisions for context-aware evaluation
	Assignments []WorkflowAssignmentContext `json:"assignments,omitempty"`
	// TriggerEventType is the source event type that triggered this instance
	TriggerEventType string `json:"triggerEventType,omitempty"`
	// TriggerChangedFields lists fields changed by the triggering mutation
	TriggerChangedFields []string `json:"triggerChangedFields,omitempty"`
	// TriggerChangedEdges lists relationships changed by the triggering mutation
	TriggerChangedEdges []string `json:"triggerChangedEdges,omitempty"`
	// TriggerAddedIDs maps relationship names to added identifiers from the triggering mutation
	TriggerAddedIDs map[string][]string `json:"triggerAddedIds,omitempty"`
	// TriggerRemovedIDs maps relationship names to removed identifiers from the triggering mutation
	TriggerRemovedIDs map[string][]string `json:"triggerRemovedIds,omitempty"`
	// TriggerUserID is the actor that initiated the triggering mutation
	TriggerUserID string `json:"triggerUserId,omitempty"`
	// TriggerProposedChanges contains normalized proposed field values from the triggering mutation
	TriggerProposedChanges map[string]any `json:"triggerProposedChanges,omitempty"`
	// ParallelApprovalKeys tracks approval action keys that can execute concurrently
	ParallelApprovalKeys []string `json:"parallelApprovalKeys,omitempty"`
	// Data carries optional runtime payload captured with the instance
	Data json.RawMessage `json:"data,omitempty"`
}

type WorkflowSelector struct {
	// TagIDs scopes matching to objects carrying any of these tags
	TagIDs []string `json:"tagIds,omitempty"`
	// GroupIDs scopes matching to objects associated with any of these groups
	GroupIDs []string `json:"groupIds,omitempty"`
	// ObjectTypes scopes matching to specific workflow object types
	ObjectTypes []enums.WorkflowObjectType `json:"objectTypes,omitempty"`
}

type WorkflowTrigger struct {
	// Operation is the mutation operation that triggers evaluation such as CREATE UPDATE or DELETE
	Operation string `json:"operation,omitempty"`
	// Interval is the schedule interval for periodic triggers such as 1h
	Interval string `json:"interval,omitempty"`
	// ObjectType is the schema/object type targeted by this trigger
	ObjectType enums.WorkflowObjectType `json:"objectType,omitempty"`
	// Fields limits evaluation to changes on specific fields
	Fields []string `json:"fields,omitempty"`
	// Edges limits evaluation to changes on specific relationships
	Edges []string `json:"edges,omitempty"`
	// Selector further scopes trigger matching using tags groups or object types
	Selector WorkflowSelector `json:"selector,omitempty"`
	// Expression is an optional CEL expression gate for trigger matching
	Expression string `json:"expression,omitempty"`
	// Description is a human-readable trigger description
	Description string `json:"description,omitempty"`
}