cased

type AuditEvent map[string]interface{}

type AuditEventPayload struct {
	DotCased   DotCased `json:".cased"`
	AuditEvent AuditEvent
}

type AvailableEndpoint string

type Client struct {
	// contains filtered or unexported fields
}

type DotCased struct {
	PII                map[string][]*SensitiveRange `json:"pii,omitempty"`
	ID                 string                       `json:"id,omitempty"`
	Event              AuditEvent                   `json:"event,omitempty"`
	PublisherUserAgent string                       `json:"publisher_user_agent,omitempty"`
	ProcessedAt        *time.Time                   `json:"processed_at,omitempty"`
	ReceivedAt         *time.Time                   `json:"received_at,omitempty"`
	PublishedAt        time.Time                    `json:"published_at"`
}

type Endpoint interface {
	Call(method, path string, params ParamsContainer, i interface{}) error
}

type EndpointConfig struct {
	HTTPClient *http.Client
	APIKey     *string
	URL        *string
}

type EndpointImplementation struct {
	Endpoint   AvailableEndpoint
	HTTPClient *http.Client
	URL        string
	APIKey     string
}

type Endpoints struct {
	API         Endpoint
	AuditTrails Endpoint
	Workflows   Endpoint
	// contains filtered or unexported fields
}

type Error struct {
	Code    ErrorCode       `json:"error,omitempty"`
	Message string          `json:"message"`
	Errors  []*ErrorMessage `json:"errors,omitempty"`

	Err error `json:"-"`
}

type ErrorCode string

type ErrorMessage struct {
	Resource string `json:"resource"`
	Path     string `json:"path"`
	Code     string `json:"code"`
}

type Event struct {
	// The Event ID
	ID string `json:"id"`

	// The API URL for the workflow.
	APIURL string `json:"api_url"`

	// Result contains information about the workflow run. If a workflow was not
	// specified or detected, it will be empty.
	Result Result `json:"result"`

	// Event has been processed.
	Event EventPayload `json:"event"`

	// OriginalEvent contains the original event published to Cased.
	OriginalEvent EventPayload `json:"original_event"`

	// UpdatedAt is when the event was last updated.
	UpdatedAt time.Time `json:"updated_at"`

	// CreatedAt is when the event was published.
	CreatedAt time.Time `json:"created_at"`
}

type EventParams struct {
	Params

	// WorkflowID is optional and only required if the workflow is known ahead of
	// time.
	WorkflowID *string

	// Event is the event that is published to Cased.
	Event EventPayload
}

type EventPayload map[string]interface{}

type HTTPSyncTransport struct {
	// contains filtered or unexported fields
}

type HTTPTransport struct {
	BufferSize int
	// contains filtered or unexported fields
}

type MockPublisher struct {
	Events []AuditEvent
	// contains filtered or unexported fields
}

type NoopHTTPTransport struct{}

type Params struct {
	Context context.Context `json:"-"`
}

type ParamsContainer interface {
	GetParams() *Params
}

type Processor func(*AuditEventPayload) *AuditEventPayload

type Publisher interface {
	Publish(event AuditEvent) error
	Options() PublisherOptions
	Flush(timeout time.Duration) bool
}

type PublisherOption func(opts *PublisherOptions)

type PublisherOptions struct {
	// PublishURL contains the URL to published Cased events to.
	PublishURL string `envconfig:"CASED_PUBLISH_URL" default:"https://publish.cased.com"`

	// PublishKey is the publish API key used to publish to an audit trail.
	//
	// A publish key is associated with a single audit trail and is required if
	// you intend to publish events to Cased in your application.
	PublishKey string `envconfig:"CASED_PUBLISH_KEY"`

	Debug bool `envconfig:"CASED_DEBUG" default:"false"`

	// Silence to determine if new events are published to Cased.
	Silence bool `envconfig:"CASED_SILENCE" default:"false"`

	HTTPClient    *http.Client
	HTTPTransport *http.Transport
	HTTPTimeout   time.Duration `envconfig:"CASED_HTTP_TIMEOUT" default:"5s"`

	Transport Transporter
}

type Result struct {
	// The Result ID
	ID string `json:"id"`

	// The API URL for the result.
	APIURL string `json:"api_url"`

	// State contains the workflow run state.
	State WorkflowState `json:"state"`

	// Controls contains the controls specified by the workflow that was triggered.
	Controls ResultControls `json:"controls"`

	// Workflow contains the workflow that was detected or specified with the
	// event.
	Workflow *Workflow `json:"workflow"`

	// UpdatedAt is when the result was last updated.
	UpdatedAt time.Time `json:"updated_at"`

	// CreatedAt is when the result was originally created.
	CreatedAt time.Time `json:"created_at"`
}

type ResultControls struct {
	Authentication *ResultControlsAuthentication `json:"authentication,omitempty"`
	Reason         *ResultControlsReason         `json:"reason,omitempty"`
	Approval       *ResultControlsApproval       `json:"approval,omitempty"`
}

type ResultControlsApproval struct {
	// ID is the approval result control identifier
	ID string `json:"id"`

	// State reflects the workflow result's approval state.
	State ResultControlsApprovalState `json:"state"`

	// URL where user can approve the request in the UI.
	URL string `json:"url"`

	// Requests contains all approval requests sent. Feature is not yet enabled.
	Requests []ResultControlsApprovalRequest `json:"requests"`

	// Source contains the approval sources.
	Source ResultControlsApprovalSource `json:"source"`
}

type ResultControlsApprovalRequest struct {
	ID    string                            `json:"id"`
	State WorkflowState                     `json:"state"`
	Type  ResultControlsApprovalRequestType `json:"type"`
}

type ResultControlsApprovalRequestType string

type ResultControlsApprovalSource struct {
	// Email indicates if the workflow approval request notified users via email.
	Email bool `json:"email"`

	// Slack indicates if the workflow approval request notified users via Slack.
	Slack ResultControlsApprovalSourceSlack `json:"slack"`
}

type ResultControlsApprovalSourceSlack struct {
	// Channel indicates the Slack channel the approval request was published to.
	Channel string `json:"channel"`
}

type ResultControlsApprovalState string

type ResultControlsAuthentication struct {
	// State contains the authentication request state.
	State WorkflowState `json:"state"`

	// User contains the user information if the user has authenticated
	// successfully.
	User *ResultControlsAuthenticationUser `json:"user"`

	// URL contains the ephemeral URL for the user to authenticate with their
	// Cased account for this particular workflow run. If running in a headless
	// environment present the URL to the user to visit manually, otherwise
	// redirect the user to the URL.
	URL string `json:"url"`

	// ApiURL contains the URL to check the status of the authentication request.
	APIURL string `json:"api_url"`
}

type ResultControlsAuthenticationUser struct {
	// ID contains the authenticated Cased user ID.
	ID string `json:"id"`

	// Email contains the authenticated Cased user email address.
	Email string `json:"email"`
}

type ResultControlsReason struct {
	State WorkflowState `json:"state"`
}

type SensitiveRange struct {
	Begin int    `json:"begin"`
	End   int    `json:"end"`
	Label string `json:"label"`
}

type SensitiveValue struct {
	Value  string
	Ranges []SensitiveRange
}

type Transporter interface {
	Configure(options PublisherOptions)
	Publish(event *AuditEventPayload) error
	Flush(timeout time.Duration) bool
}

type WebhooksEndpoint struct {
	// The Webhook Endpoint ID
	ID string `json:"id"`

	// URL to deliver webhook events to.
	URL string `json:"url"`

	// The API URL for the webhook endpoint.
	APIURL string `json:"api_url"`

	// Secret used to sign payloads.
	Secret string `json:"secret"`

	// EventTypes to deliver to the webhook endpoint. If none are specified, all
	// event types will deliver events.
	EventTypes []string `json:"event_types"`

	// UpdatedAt is when the webhook endpoint was last updated.
	UpdatedAt time.Time `json:"updated_at"`

	// CreatedAt is when the webhook endpoint was created.
	CreatedAt time.Time `json:"created_at"`
}

type WebhooksEndpointParams struct {
	Params `json:"-"`

	// URL to deliver webhook events to.
	URL *string `json:"url,omitempty"`

	// EventTypes to deliver to the webhook endpoint. If none are specified, all
	// event types will deliver events.
	EventTypes *[]string `json:"event_types,omitempty"`
}

type Workflow struct {
	// The Workflow ID
	ID string `json:"id"`

	// Name of the workflow to be used to trigger the workflow.
	Name *string `json:"name,omitempty"`

	// The API URL for the workflow.
	APIURL string `json:"api_url"`

	// Conditions are how Cased determines which workflow should run when an event
	// is published and a workflow is not specified.
	Conditions []WorkflowCondition `json:"conditions"`

	// Controls specifies the controls enabled for this workflow.
	Controls WorkflowControls `json:"controls"`

	// UpdatedAt is when the workflow was last updated.
	UpdatedAt time.Time `json:"updated_at"`

	// CreatedAt is when the workflow was created.
	CreatedAt time.Time `json:"created_at"`
}

type WorkflowCondition struct {
	// The path to the field on the event to evaluate this condition for.
	Field string `json:"field"`

	// Operator specifies the operator use to evaluate the condition. See
	// `ConditionOperator` for all available operators.
	Operator WorkflowConditionOperator `json:"operator"`

	// Value contains the value to be used to evaluate the condition based on its
	// configured operator.
	Value string `json:"value"`
}

type WorkflowConditionOperator string

type WorkflowConditionParams struct {
	// The path to the field on the event to evaluate this condition for.
	Field *string `json:"field"`

	// Operator specifies the operator use to evaluate the condition. See
	// `ConditionOperator` for all available operators.
	Operator *string `json:"operator"`

	// Value contains the value to be used to evaluate the condition based on its
	// configured operator.
	Value *string `json:"value"`
}

type WorkflowControls struct {
	// Require a user to provide a reason to continue the workflow.
	Reason *bool `json:"reason,omitempty"`

	// Require a user to authenticate with Cased to continue the workflow.
	Authentication *bool `json:"authentication,omitempty"`

	// Require a user to receive approval before a workflow is fulfilled or
	// rejected.
	Approval *WorkflowControlsApproval `json:"approval,omitempty"`
}

type WorkflowControlsApproval struct {
	// The number of approvals required to fulfill the approval requirement.
	//
	// Approval count cannot exceed the number of users on your account,
	// otherwise an error will be returned.
	Count int `json:"count"`

	// Permit an approval request to allow user requesting approval the ability
	// to approve their own request. If the Authentication control is disabled,
	// any user can approve the request and this setting is ignored.
	SelfApproval bool `json:"self_approval"`

	// Determine how long the approval lasts for.
	Duration int `json:"duration"`

	// Control how long the approval request is valid for. If not supplied,
	// approval requests can be responded to indefinitely.
	Timeout *int `json:"timeout"`

	// List of responders that can include individual users and groups of users
	// who are authorized to respond to the approval request.
	Responders *WorkflowControlsApprovalResponders `json:"responders,omitempty"`

	// Sources where to obtain the approval from. If not provided, defaults to
	// email.
	Sources *WorkflowControlsApprovalSources `json:"sources,omitempty"`
}

type WorkflowControlsApprovalParams struct {
	// The number of approvals required to fulfill the approval requirement.
	//
	// Approval count cannot exceed the number of users on your account,
	// otherwise an error will be returned.
	Count *int `json:"count,omitempty"`

	// Permit an approval request to allow user requesting approval the ability
	// to approve their own request. If the Authentication control is disabled,
	// any user can approve the request and this setting is ignored.
	SelfApproval *bool `json:"self_approval,omitempty"`

	// Determine how long the approval lasts for.
	Duration *int `json:"duration,omitempty"`

	// Control how long the approval request is valid for. If not supplied,
	// approval requests can be responded to indefinitely.
	Timeout *int `json:"timeout,omitempty"`

	// List of responders that can include individual users and groups of users
	// who are authorized to respond to the approval request.
	Responders *WorkflowControlsApprovalResponders `json:"responders,omitempty"`

	// Sources where to obtain the approval from. If not provided, defaults to
	// email.
	Sources *WorkflowControlsApprovalSourcesParams `json:"sources,omitempty"`
}

type WorkflowControlsApprovalResponders map[string]string

type WorkflowControlsApprovalSources struct {
	// Email determines if an email is delivered for the approval request.
	Email bool `json:"email"`

	// Slack when provided, publishes a Slack message which users can respond to
	// the request.
	Slack *WorkflowControlsApprovalSourcesSlack `json:"slack,omitempty"`
}

type WorkflowControlsApprovalSourcesParams struct {
	// Email determines if an email is delivered for the approval request.
	Email *bool `json:"email,omitempty"`

	// Slack when provided, publishes a Slack message which users can respond to
	// the request.
	Slack *WorkflowControlsApprovalSourcesSlackParams `json:"slack,omitempty"`
}

type WorkflowControlsApprovalSourcesSlack struct {
	// The fully qualified Slack channel name (ie: #security).
	Channel string `json:"channel"`
}

type WorkflowControlsApprovalSourcesSlackParams struct {
	// The fully qualified Slack channel name (ie: #security).
	Channel *string `json:"channel,omitempty"`
}

type WorkflowControlsParams struct {
	// Require a user to provide a reason to continue the workflow.
	Reason *bool `json:"reason,omitempty"`

	// Require a user to authenticate with Cased to continue the workflow.
	Authentication *bool `json:"authentication,omitempty"`

	// Require a user to receive approval before a workflow is fulfilled or
	// rejected.
	Approval *WorkflowControlsApprovalParams `json:"approval,omitempty"`
}

type WorkflowParams struct {
	Params `json:"-"`

	// Name is optional and only required if you intend to trigger workflows
	// by publishing events directly to them.
	Name *string `json:"name,omitempty"`

	// Conditions specify the conditions the workflow should match when events
	// are not published directly to a workflow.
	Conditions *[]WorkflowConditionParams `json:"conditions,omitempty"`

	// Configure the controls necessary for the workflow to reach the fulfilled
	// state.
	Controls *WorkflowControlsParams `json:"controls,omitempty"`
}

type WorkflowState string