api

type Attempt struct {
	Status  string `json:"status"`
	Message string `json:"message"`
}

type Award struct {
	ID           int           `json:"id"`
	TeamID       int           `json:"team_id"`
	Category     *string       `json:"category"`
	UserID       int           `json:"user_id"`
	Team         int           `json:"team"` // XXX may be duplicated with ID ?
	Date         string        `json:"date"`
	Description  *string       `json:"description"`
	User         int           `json:"user"` // XXX may be duplicated with UserID ?
	Type         string        `json:"type"`
	Value        int           `json:"value"`
	Requirements *Requirements `json:"requirements"`
	Name         string        `json:"name"`
	Icon         string        `json:"icon"`
}

type Bracket struct {
	ID          int    `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	Type        string `json:"type"`
}

type CUV struct {
	Create string  `json:"create"`
	Update string  `json:"update"`
	View   *string `json:"view,omitempty"`
}

type Challenge struct {
	ID             int               `json:"id"`
	Name           string            `json:"name"`
	Description    string            `json:"description"`
	Attribution    *string           `json:"attribution,omitempty"`
	ConnectionInfo *string           `json:"connection_info,omitempty"`
	MaxAttempts    *int              `json:"max_attempts,omitempty"`
	Function       *string           `json:"function,omitempty"`
	Value          int               `json:"value"`
	Initial        *int              `json:"initial,omitempty"`
	Decay          *int              `json:"decay,omitempty"`
	Minimum        *int              `json:"minimum,omitempty"`
	Logic          string            `json:"logic"`
	Category       string            `json:"category"`
	SolutionID     *int              `json:"solution_id,omitempty"`
	Type           string            `json:"type"`
	TypeData       *Type             `json:"type_data,omitempty"`
	State          string            `json:"state"`
	NextID         *int              `json:"next_id"`
	Requirements   *Requirements     `json:"requirements"` // List of challenge IDs to complete before
	Solves         int               `json:"solves"`
	SolvedByMe     bool              `json:"solved_by_me"`
	Rating         *Rating           `json:"rating,omitempty"`
	Ratings        *ChallengeRatings `json:"ratings,omitempty"`
}

type ChallengeRatings struct {
	Up    int `json:"up"`
	Down  int `json:"down"`
	Count int `json:"count"`
}

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

type Comment struct {
	ID       int     `json:"id"`
	AuthorID int     `json:"author_id"`
	Content  *string `json:"content"`
	Date     string  `json:"date"`
	HTML     *string `json:"html,omitempty"`
	Author   struct {
		Name string `json:"name"`
	} `json:"author"`
	Type string `json:"type"`
}

type Config struct {
	ID    int    `json:"id"`
	Key   string `json:"key"`
	Value string `json:"value"`
}

type ConfigField struct {
	FieldType   any     `json:"field_type"`
	Editable    bool    `json:"editable"`
	Type        string  `json:"type"`
	Required    bool    `json:"required"`
	Public      bool    `json:"public"`
	Name        *string `json:"name"`
	Description *string `json:"description"`
	ID          int     `json:"id"`
}

type DeleteTeamMembersParams struct {
	UserID int `json:"user_id"`
}

type DeleteTopicArgs struct {
	ID   string `schema:"target_id"`
	Type string `schema:"type"`
}

type Distribution struct {
	Brackets map[string]int `json:"brackets"`
}

type ExportRawArgsParams struct {
	// Table, if specified, exports the given table in the specified type.
	Table *string `json:"table,omitempty"`
}

type ExportRawParams struct {
	// Type could be "csv" (which returns the table dump in csv) or
	// anything (returns a zip).
	Type string `json:"type"`

	// Args contains all the arguments to export specific content.
	Args ExportRawArgsParams `json:"args"`
}

type Field struct {
	FieldID int    `json:"field_id"`
	Value   string `json:"value"` // seems could be int/bool/string, let CTFd interfer type
}

type File struct {
	ID       int    `json:"id"`
	Type     string `json:"type"`
	Location string `json:"location"`
	SHA1sum  string `json:"sha1sum"`
}

type Flag struct {
	ID          int    `json:"id"`
	ChallengeID int    `json:"challenge_id"`
	Content     string `json:"content"`
	Data        string `json:"data"`
	Type        string `json:"type"`
	Challenge   int    `json:"challenge"` // XXX may be duplicated with ChallengeID ?
}

type GetAwardsParams struct {
	UserID   *int    `schema:"user_id,omitempty"`
	TeamID   *int    `schema:"team_id,omitempty"`
	Type     *string `schema:"type,omitempty"`
	Value    *int    `schema:"value,omitempty"`
	Category *int    `schema:"category,omitempty"`
	Icon     *int    `schema:"icon,omitempty"`
	Q        *string `schema:"q,omitempty"`
	Field    *string `schema:"field,omitempty"`
}

type GetBracketsParams struct {
	Name        *string `schema:"name,omitempty"`
	Description *string `schema:"description,omitempty"`
	Type        *string `schema:"type,omitempty"`
	Q           *string `schema:"q,omitempty"`
}

type GetChallengesParams struct {
	Name        *string `schema:"name,omitempty"`
	MaxAttempts *int    `schema:"max_attempts,omitempty"`
	Value       *int    `schema:"value,omitempty"`
	Category    *int    `schema:"category,omitempty"`
	Type        *string `schema:"type,omitempty"`
	State       *string `schema:"state,omitempty"`
	Q           *string `schema:"q,omitempty"`
	// If view is set to admin, returns all challenges (not only the visible ones).
	View *string `schema:"view,omitempty"`
}

type GetCommentsParams struct {
	ChallengeID *int    `schema:"challenge_id,omitempty"`
	UserID      *int    `schema:"user_id,omitempty"`
	TeamID      *int    `schema:"team_id,omitempty"`
	PageID      *int    `schema:"page_id,omitempty"`
	Q           *string `schema:"q,omitempty"`
	Field       *string `schema:"field,omitempty"`
}

type GetConfigsFieldsParams struct {
	Type  *string `schema:"type,omitempty"`
	Q     *string `schema:"q,omitempty"`
	Field *string `schema:"field,omitempty"`
}

type GetConfigsParams struct {
	Key   *string `schema:"key,omitempty"`
	Value *string `schema:"value,omitempty"`
	Q     *string `schema:"q,omitempty"`
	Field *string `schema:"field,omitempty"`
}

type GetFilesParams struct {
	Type     *string `schema:"type,omitempty"`
	Location *string `schema:"location,omitempty"`
	Q        *string `schema:"q,omitempty"`
	Field    *string `schema:"field,omitempty"`
}

type GetFlagsParams struct {
	ChallengeID *int    `schema:"challenge_id,omitempty"`
	Type        *string `schema:"type,omitempty"`
	Content     *string `schema:"content,omitempty"`
	Data        *string `schema:"data,omitempty"`
	Q           *string `schema:"q,omitempty"`
	Field       *string `schema:"field,omitempty"`
}

type GetHintParams struct {
	// As per CTFd commit ed5dbb762a013800edb1c322cbe0779b25c7daec, you can only get the hint data
	// if you are admin and specify a "preview" argument in the request
	Preview *bool `schema:"preview,omitempty"`
}

type GetHintsParams struct {
	Type        *string `schema:"type,omitempty"`
	ChallengeID *int    `schema:"challenge_id,omitempty"`
	Content     *string `schema:"content,omitempty"`
	Cost        *int    `schema:"cost,omitempty"`
	Q           *string `schema:"q,omitempty"`
	Field       *string `schema:"field,omitempty"`
}

type GetNotificationsParams struct {
	Title   *string `schema:"title,omitempty"`
	Content *string `schema:"content,omitempty"`
	UserID  *int    `schema:"user_id,omitempty"`
	TeamID  *int    `schema:"team_id,omitempty"`
	Q       *string `schema:"q,omitempty"`
	Field   *string `schema:"field,omitempty"`
	SinceID *int    `schema:"since_id,omitempty"`
}

type GetPagesParams struct {
	ID           *int    `schema:"id,omitempty"`
	Title        *string `schema:"title,omitempty"`
	Route        *string `schema:"route,omitempty"`
	Draft        *bool   `schema:"draft,omitempty"`
	Hidden       *bool   `schema:"hidden,omitempty"`
	AuthRequired *bool   `schema:"auth_required,omitempty"`
	Q            *string `schema:"q,omitempty"`
	Field        *string `schema:"field,omitempty"`
}

type GetScoreboardTopParams struct {
	// Count is the top number of players to get the info.
	Count int `schema:"-"`

	// BracketID is an optional parameter to filter on a specific bracket.
	BracketID *int `schema:"bracket_id,omitempty"`
}

type GetSolutionsParams struct{}

type GetSubmissionsParams struct {
	ChallengeID *int    `schema:"challenge_id,omitempty"`
	UserID      *int    `schema:"user_id,omitempty"`
	TeamID      *int    `schema:"team_id,omitempty"`
	IP          *string `schema:"ip,omitempty"`
	Provided    *string `schema:"provided,omitempty"`
	Type        *string `schema:"type,omitempty"`
	Q           *string `schema:"q,omitempty"`
	Field       *string `schema:"field,omitempty"`
}

type GetTagsParams struct {
	ChallengeID *int    `schema:"challenge_id,omitempty"`
	Value       *string `schema:"value,omitempty"`
	Q           *string `schema:"q,omitempty"`
	Field       *string `schema:"field,omitempty"`
}

type GetTeamsParams struct {
	Affiliation *string `schema:"affiliation"`
	Country     *string `schema:"country"`
	Bracket     *string `schema:"bracket"`
	Q           *string `schema:"q"`
	Field       *string `schema:"field"`
}

type GetTopicsParams struct {
	Value *string `schema:"value,omitempty"`
	Q     *string `schema:"q,omitempty"`
	Field *string `schema:"field,omitempty"`
}

type GetUnlocksParams struct {
	UserID *int    `schema:"user_id,omitempty"`
	TeamID *int    `schema:"team_id,omitempty"`
	Target *int    `schema:"target,omitempty"`
	Type   *string `schema:"type,omitempty"`
	Q      *string `schema:"q,omitempty"`
	Field  *string `schema:"field,omitempty"`
}

type GetUsersParams struct {
	Affiliation *string `schema:"affiliation"`
	Country     *string `schema:"country"`
	Bracket     *string `schema:"bracket"`
	Q           *string `schema:"q"`
	Field       *string `schema:"field"`
}

type HeadNotificationsParams struct {
	Title   *string `schema:"title,omitempty"`
	Content *string `schema:"content,omitempty"`
	UserID  *int    `schema:"user_id,omitempty"`
	TeamID  *int    `schema:"team_id,omitempty"`
	Q       *string `schema:"q,omitempty"`
	Field   *string `schema:"field,omitempty"`
	SinceID *int    `schema:"since_id,omitempty"`
}

type Hint struct {
	ID           int           `json:"id"`
	HTML         *string       `json:"html,omitempty"`
	Title        *string       `json:"title,omitempty"`
	Content      *string       `json:"content,omitempty"`
	Cost         int           `json:"cost"`
	Type         string        `json:"type"`
	ChallengeID  int           `json:"challenge_id"`
	Challenge    int           `json:"challenge"` // XXX may be duplicated with ChallengeID ?
	Requirements *Requirements `json:"requirements,omitempty"`
}

type InputFile struct {
	Name    string
	Content []byte
}

type LoginParams struct {
	Name     string
	Password string
}

type Notification struct {
	ID      int     `json:"id"`
	TeamID  *int    `json:"team_id"` // XXX may be duplicated with Team ?
	HTML    string  `json:"html"`
	UserID  *int    `json:"user_id"` // XXX may be duplicated with User ?
	Team    *int    `json:"team"`
	Content string  `json:"content"`
	Date    string  `json:"date"`
	Title   string  `json:"title"`
	User    *int    `json:"user"`
	Type    *string `json:"type,omitempty"`
	Sound   *bool   `json:"sound,omitempty"`
}

type Option interface {
	// contains filtered or unexported methods
}

type Page struct {
	Files        []any   `json:"files"` // XXX find model
	ID           int     `json:"id"`
	Draft        bool    `json:"draft"`
	Route        string  `json:"route"`
	Title        string  `json:"title"`
	Hidden       bool    `json:"hidden"`
	Format       string  `json:"format"`
	AuthRequired bool    `json:"auth_required"`
	Content      *string `json:"content,omitempty"`
}

type PatchBracketsParams struct {
	Name        *string `json:"name,omitempty"`
	Description *string `json:"description,omitempty"`
	Type        *string `json:"type,omitempty"`
}

type PatchChallengeParams struct {
	Name           string  `json:"name"`
	Category       string  `json:"category"`
	Description    string  `json:"description"`
	Attribution    *string `json:"attribution,omitempty"`
	Function       *string `json:"function,omitempty"`
	ConnectionInfo *string `json:"connection_info,omitempty"`
	Value          *int    `json:"value,omitempty"`
	Initial        *int    `json:"initial,omitempty"`
	Decay          *int    `json:"decay,omitempty"`
	Minimum        *int    `json:"minimum,omitempty"`
	Logic          *string `json:"logic,omitempty"`
	MaxAttempts    *int    `json:"max_attempts,omitempty"`
	NextID         *int    `json:"next_id,omitempty"`
	// Requirements can update the challenge's behavior and prerequisites i.e.
	// the other challenges the team/user must have solved before.
	// WARNING: it won't return those in the response body, so updating this
	// field requires you to do it manually through *Client.GetChallengeRequirements
	Requirements *Requirements `json:"requirements,omitempty"`
	State        string        `json:"state"`
}

type PatchConfigsCTFLogo struct {
	Value *string `json:"value"`
}

type PatchConfigsFieldParams struct {
	ID          int    `json:"id"` // XXX duplicated with the ID in URL
	Name        string `json:"name"`
	Description string `json:"description"`
	FieldType   string `json:"field_type"`
	Type        string `json:"type"`
	Editable    bool   `json:"editable"`
	Public      bool   `json:"public"`
	Required    bool   `json:"required"`
}

type PatchConfigsParams struct {
	CTFDescription *string `json:"ctf_description,omitempty"`
	CTFName        *string `json:"ctf_name,omitempty"`

	CTFTheme      *string `json:"ctf_theme,omitempty"`
	ThemeFooter   *string `json:"theme_footer,omitempty"`
	ThemeHeader   *string `json:"theme_header,omitempty"`
	ThemeSettings *string `json:"theme_settings,omitempty"`

	DefaultLocale *string `json:"default_locale,omitempty"`

	DomainWhitelist            *string `json:"domain_whitelist,omitempty"`
	DomainBlacklist            *string `json:"domaine_blacklist,omitempty"`
	IncorrectSubmissionsPerMin *int    `json:"incorrect_submissions_per_min,omitempty"`
	NameChanges                *bool   `json:"name_changes,omitempty"`
	NumTeams                   *int    `json:"num_teams,omitempty"`
	NumUsers                   *int    `json:"num_users,omitempty"`
	TeamCreation               *bool   `json:"team_creation,omitempty"`
	TeamDisbanding             *string `json:"team_disbanding,omitempty"`
	TeamSize                   *int    `json:"team_size,omitempty"`
	PasswordMinLength          *int    `json:"password_min_length,omitempty"`
	VerifyEmails               *bool   `json:"verify_emails,omitempty"`

	ViewSelfSubmission    bool   `json:"view_self_submissions"`
	MaxAttemptsBehavior   string `json:"max_attempts_behavior"`
	MaxAttemptsTimeout    int    `json:"max_attempts_timeout"`
	HintsFreePublicAccess bool   `json:"hints_free_public_access"`
	ChallengeRatings      string `json:"challenge_ratings"`

	RobotsTxt *string `json:"robots_txt,omitempty"`

	OauthClientID     *string `json:"oauth_client_id,omitempty"`
	OauthClientSecret *string `json:"oauth_client_secret,omitempty"`

	AccountVisibility      *string `json:"account_visibility,omitempty"`
	ChallengeVisibility    *string `json:"challenge_visibility,omitempty"`
	Paused                 *bool   `json:"paused,omitempty"`
	RegistrationVisibility *string `json:"registration_visibility,omitempty"`
	ScoreVisibility        *string `json:"score_visibility,omitempty"`

	HTMLSanitization *bool   `json:"html_sanitization,omitempty"`
	RegistrationCode *string `json:"registration_code,omitempty"`

	MailPassword                       *string `json:"mail_password,omitempty"`
	MailPort                           *string `json:"mail_port,omitempty"`
	MailServer                         *string `json:"mail_server,omitempty"`
	MailSSL                            *bool   `json:"mail_ssl,omitempty"`
	MailTLS                            *bool   `json:"mail_tls,omitempty"`
	MailUseAuth                        *bool   `json:"mail_useauth,omitempty"`
	MailUsername                       *string `json:"mail_username,omitempty"`
	PasswordChangeAlertBody            *string `json:"password_change_alert_body,omitempty"`
	PasswordChangeAlertSubject         *string `json:"password_change_alert_subject,omitempty"`
	PasswordResetBody                  *string `json:"password_reset_body,omitempty"`
	PasswordResetSubject               *string `json:"password_reset_subject,omitempty"`
	SuccessfulRegistrationEmailBody    *string `json:"successful_registration_email_body,omitempty"`
	SuccessfulRegistrationEmailSubject *string `json:"successful_registration_email_subject,omitempty"`
	UserCreationEmailBody              *string `json:"user_creation_email_body,omitempty"`
	UserCreationEmailSubject           *string `json:"user_creation_email_subject,omitempty"`
	VerificationEmailBody              *string `json:"verification_email_body,omitempty"`
	VerificationEmailSubject           *string `json:"verification_email_subject,omitempty"`

	// DEPRECATED
	MailFromAddr *string `json:"mailfrom_addr,omitempty"`
	// DEPRECATED
	MailGunAPIKey *string `json:"mailgun_api_key,omitempty"`
	// DEPRECATED
	MailGunBaseURL *string `json:"mailgun_base_url,omitempty"`

	End          *string `json:"end,omitempty"`
	Freeze       *string `json:"freeze,omitempty"`
	Start        *string `json:"start,omitempty"`
	ViewAfterCTF *bool   `json:"view_after_ctf,omitempty"`

	SocialShares         *bool  `json:"social_shares,omitempty"`
	SocialSharesTemplate string `json:"social_share_solve_template"`

	PrivacyText *string `json:"privacy_text,omitempty"`
	PrivacyURL  *string `json:"privacy_url,omitempty"`
	TOSText     *string `json:"tos_text,omitempty"`
	TOSURL      *string `json:"tos_url,omitempty"`

	UserMode *string `json:"user_mode,omitempty"`
}

type PatchFlagParams struct {
	Content string `json:"content"`
	Data    string `json:"data"`
	ID      string `json:"id"` // XXX should be int + duplicated with id in URL
	Type    string `json:"type"`
}

type PatchHintsParams struct {
	ChallengeID  int          `json:"challenge_id"`
	Title        *string      `json:"title,omitempty"`
	Content      string       `json:"content"`
	Cost         int          `json:"cost"`
	Requirements Requirements `json:"requirements"`
}

type PatchPageParams struct {
	Title        string `json:"title"`
	Content      string `json:"content"`
	Format       string `json:"format"`
	Route        string `json:"route"`
	Nonce        string `json:"nonce"` // XXX API should not use the nonce as you need to parse HTML content to get it, going against the API workflow
	AuthRequired bool   `json:"auth_required"`
	Draft        bool   `json:"draft"`
	Hidden       bool   `json:"hidden"`
}

type PatchSolutionsParams struct {
	Content string `json:"content"`
	State   string `json:"state"`
}

type PatchTagsParams struct {
	Value string `json:"value"`
}

type PatchTeamsParams struct {
	CaptainID   *int    `json:"captain_id,omitempty"`
	Name        *string `json:"name,omitempty"`
	Email       *string `json:"email,omitempty"`
	Password    *string `json:"password,omitempty"`
	Website     *string `json:"website,omitempty"`
	Affiliation *string `json:"affiliation,omitempty"`
	Country     *string `json:"country,omitempty"`
	Banned      *bool   `json:"banned,omitempty"`
	Hidden      *bool   `json:"hidden,omitempty"`
	Fields      []Field `json:"fields"`
	BracketID   *string `json:"bracket_id,omitempty"`
}

type PatchUsersParams struct {
	Name           string  `json:"name"`
	Email          string  `json:"email"`
	Language       *string `json:"language,omitempty"`
	Password       *string `json:"password,omitempty"`
	Website        *string `json:"website,omitempty"`
	Affiliation    *string `json:"affiliation,omitempty"`
	Country        *string `json:"country,omitempty"`
	Type           *string `json:"type,omitempty"`
	Verified       *bool   `json:"verified,omitempty"`
	Hidden         *bool   `json:"hidden,omitempty"`
	Banned         *bool   `json:"banned,omitempty"`
	ChangePassword *bool   `json:"change_password,omitempty"`
	Fields         []Field `json:"fields"`
	BracketID      *string `json:"bracket_id,omitempty"`
}

type PostAwardsParams struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Category    string `json:"category"`
	Icon        string `json:"icon"`
	UserID      int    `json:"user_id"`
	Value       int    `json:"value"`
}

type PostBracketsParams struct {
	ID          float64 `json:"id"` // XXX Why is that a float64 ?? Why is it even sent by the client as CTFd will return a new one ?
	Name        string  `json:"name"`
	Description string  `json:"description"`
	Type        string  `json:"type"`
}

type PostChallengesAttemptParams struct {
	// TODO support parameter (e.g. "preview=true")
	ChallengeID int    `json:"challenge_id"`
	Submission  string `json:"submission"`
}

type PostChallengesParams struct {
	Name           string        `json:"name"`
	Category       string        `json:"category"`
	Description    string        `json:"description"`
	Attribution    *string       `json:"attribution,omitempty"`
	Function       *string       `json:"function,omitempty"`
	ConnectionInfo *string       `json:"connection_info,omitempty"`
	Value          int           `json:"value"`
	Initial        *int          `json:"initial,omitempty"`
	Decay          *int          `json:"decay,omitempty"`
	Minimum        *int          `json:"minimum,omitempty"`
	Logic          string        `json:"logic"`
	MaxAttempts    *int          `json:"max_attempts,omitempty"`
	NextID         *int          `json:"next_id,omitempty"`
	Requirements   *Requirements `json:"requirements,omitempty"`
	State          string        `json:"state"`
	Type           string        `json:"type"`
}

type PostCommentsParams struct {
	PageID  int    `json:"page_id"`
	Content string `json:"content"`
	Type    string `json:"type"`
}

type PostConfigFieldsParams struct {
	ID          float64 `json:"id"`
	Name        string  `json:"name"`
	Description string  `json:"description"`
	FieldType   string  `json:"field_type"`
	Editable    bool    `json:"editable"`
	Public      bool    `json:"public"`
	Required    bool    `json:"required"`
	Type        string  `json:"type"`
}

type PostConfigsParams struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type PostFilesParams struct {
	Files     []*InputFile // XXX backend code shows it could be a list, but not the doc
	Challenge *int
	Location  *string
}

type PostFlagsParams struct {
	Challenge int    `json:"challenge"`
	Content   string `json:"content"`
	Data      string `json:"data"`
	Type      string `json:"type"`
}

type PostHintsParams struct {
	ChallengeID  int          `json:"challenge_id"`
	Title        *string      `json:"title,omitempty"`
	Content      string       `json:"content"`
	Cost         int          `json:"cost"`
	Requirements Requirements `json:"requirements"`
}

type PostNotificationsParams struct {
	Content string `json:"content"`
	Sound   bool   `json:"sound"`
	Title   string `json:"title"`
	Type    string `json:"type"`
	UserID  *int   `schema:"user_id,omitempty"`
	TeamID  *int   `schema:"team_id,omitempty"`
}

type PostPagesParams struct {
	AuthRequired bool   `json:"auth_required"`
	Content      string `json:"content"`
	Draft        bool   `json:"draft"`
	Format       string `json:"format"`
	Hidden       bool   `json:"hidden"`
	Nonce        string `json:"nonce"` // XXX API should not use the nonce as you need to parse HTML content to get it, going against the API workflow
	Route        string `json:"route"`
	Title        string `json:"title"`
}

type PostSharesParams struct {
	ChallengeID int    `json:"challenge_id"`
	Type        string `json:"type"`
}

type PostSolutionsParams struct {
	ChallengeID int    `json:"challenge_id"`
	Content     string `json:"content"`
	State       string `json:"state"`
}

type PostTagsParams struct {
	Challenge int    `json:"challenge"`
	Value     string `json:"value"`
}

type PostTeamsMembersParams struct {
	UserID int `json:"user_id"`
}

type PostTeamsParams struct {
	Name        string  `json:"name"`
	Email       string  `json:"email"`
	Password    string  `json:"password"`
	Website     *string `json:"website,omitempty"`
	Affiliation *string `json:"affiliation,omitempty"`
	Country     *string `json:"country,omitempty"`
	Banned      bool    `json:"banned"`
	Hidden      bool    `json:"hidden"`
	Fields      []Field `json:"fields"`
	BracketID   *string `json:"bracket_id,omitempty"`
}

type PostTokensParams struct {
	Description string `json:"description"`
	Expiration  string `json:"expiration"`
}

type PostTopicsParams struct {
	Challenge int    `json:"challenge"`
	Type      string `json:"type"`
	Value     string `json:"value"`
}

type PostUnlocksParams struct {
	Target int    `json:"target"`
	Type   string `json:"type"`
}

type PostUserMailParams struct {
	Text string `json:"text"`
}

type PostUsersParams struct {
	Name           string  `json:"name"`
	Email          string  `json:"email"`
	Language       *string `json:"language,omitempty"`
	Password       string  `json:"password"`
	Website        *string `json:"website,omitempty"`
	Affiliation    *string `json:"affiliation,omitempty"`
	Country        *string `json:"country,omitempty"`
	Type           string  `json:"type"` // "user" or "admin"
	Verified       bool    `json:"verified"`
	Hidden         bool    `json:"hidden"`
	Banned         bool    `json:"banned"`
	ChangePassword bool    `json:"change_password"`
	Fields         []Field `json:"fields"`
	BracketID      *string `json:"bracket_id,omitempty"`
}

type PutChallengeRatingsParams struct {
	Value  int    `json:"value"` // either 1 for thumbsup or -1 for thumbsdown
	Review string `json:"review"`
}

type Rating struct {
	ID          int        `json:"id"`
	Date        string     `json:"date"`
	Value       int        `json:"value"`
	Review      string     `json:"review"`
	UserID      int        `json:"user_id"`
	User        *User      `json:"user"`
	ChallengeID int        `json:"challenge_id"`
	Challenge   *Challenge `json:"challenge"`
}

type RegisterParams struct {
	Name     string
	Email    string
	Password string
}

type Requirements struct {
	// Anonymize control the behavior of the resource if the prerequisites are
	// not validated:
	//  - if `nil`, defaults to `*false`
	//  - if `*false`, set the behavior as "hidden" (invisible until validated)
	//  - if `*true`, set the behavior to "anonymized" (visible but not much info)
	Anonymize *bool `json:"anonymize,omitempty"`

	// Prerequisites is the list of resources' ID that need to be validated in
	// order for the resource to meet its requirements.
	Prerequisites []int `json:"prerequisites"`
}

type ResetParams struct {
	Accounts      *string `schema:"accounts,omitempty"`
	Submissions   *string `schema:"submissions,omitempty"`
	Challenges    *string `schema:"challenges,omitempty"`
	Pages         *string `schema:"pages,omitempty"`
	Notifications *string `schema:"notifications,omitempty"`
	// Nonce is autofilled by the API wrapper.
	// XXX the "nonce" should not be part of the API call but rather be extracted from HTTP headers.
	Nonce string `schema:"nonce"`
}

type Response struct {
	Success bool    `json:"success"`
	Data    any     `json:"data,omitempty"`
	Errors  any     `json:"errors,omitempty"` // can't type it to []string due to API model instabilities
	Message *string `json:"message,omitempty"`
}

type Scoreboard struct {
	ID          int    `json:"id"`
	Pos         int    `json:"pos"`
	AccountId   int    `json:"account_id"`
	AccountURL  string `json:"account_url"`
	AccountType string `json:"account_type"`
	OauthID     any    `json:"oauth_id"`
	Name        string `json:"name"`
	Score       int    `json:"score"`
	Members     []struct {
		ID      int    `json:"id"`
		OauthID any    `json:"oauth_id"`
		Name    string `json:"name"`
		Score   int    `json:"score"`
	} `json:"members"`
	Solves      []*Submission `json:"solves"`
	BracketID   *string       `json:"bracket_id"`
	BracketName *string       `json:"bracket_name"`
}

type SetupParams struct {
	CTFName                string
	CTFDescription         string
	UserMode               string
	ChallengeVisibility    string
	AccountVisibility      string
	ScoreVisibility        string
	RegistrationVisibility string
	VerifyEmails           bool
	TeamSize               *int
	Name                   string
	Email                  string
	Password               string
	CTFLogo                *InputFile
	CTFBanner              *InputFile
	CTFSmallIcon           *InputFile
	CTFTheme               string
	ThemeColor             string
	Start                  string
	End                    string
}

type Shares struct {
	URL string `json:"url"`
}

type Solution struct {
	ID          int    `json:"id"`
	ChallengeID int    `json:"challenge_id"`
	State       string `json:"state"`
	Content     string `json:"content"`
	HTML        string `json:"html"`
}

type StatChallSubmission struct {
	ID         int      `json:"id"`
	Name       string   `json:"name"`
	Solves     *int     `json:"solves,omitempty"`
	Percentage *float64 `json:"percentage,omitempty"`
}

type StatTeams struct {
	Registered int `json:"registered"`
}

type StatUsers struct {
	Registered int `json:"registered"`
	Confirmed  int `json:"confirmed"`
}

type Submission struct {
	ID          int    `json:"id"`
	TeamID      int    `json:"team_id"` // XXX may be duplicated with team.id ?
	IP          string `json:"ip"`
	ChallengeID int    `json:"challenge_id"`
	AccountID   int    `json:"account_id"` // XXX introducted in 3.7.1, clearly a duplication of user_id...
	UserID      int    `json:"user_id"`    // XXX may be duplicated with user.id ?
	Value       int    `json:"value"`
	Team        struct {
		ID   int    `json:"id"`
		Name string `json:"name"`
	} `json:"team"`
	Date string `json:"date"`
	User struct {
		ID   int    `json:"id"`
		Name string `json:"name"`
	} `json:"user"`
	Type      string `json:"type"`
	Challenge struct {
		Value    int    `json:"value"`
		ID       int    `json:"id"`
		Name     string `json:"name"`
		Category string `json:"category"`
	} `json:"challenge"`
	Provided string `json:"provided"`
}

type Tag struct {
	ID          int    `json:"id"`
	Challenge   *int   `json:"challenge,omitempty"` // XXX This may be duplicated with ChallengeID ?
	ChallengeID int    `json:"challenge_id"`
	Value       string `json:"value"`
}

type Team struct {
	Members     []int    `json:"members,omitempty"`
	ID          int      `json:"id"`
	Created     string   `json:"created"`
	Country     *string  `json:"country,omitempty"`
	Email       *string  `json:"email,omitempty"`
	Affiliation *string  `json:"affiliation,omitempty"`
	CaptainID   *int     `json:"captain_id,omitempty"`
	Fields      []string `json:"fields"`
	Banned      bool     `json:"banned"`
	Website     *string  `json:"website,omitempty"`
	Hidden      bool     `json:"hidden"`
	Secret      *bool    `json:"secret,omitempty"`
	Name        string   `json:"name"`
	OauthID     *string  `json:"oauth_id,omitempty"`
	Place       *string  `json:"place,omitempty"`
	Score       *int     `json:"score,omitempty"`
	BracketID   *int     `json:"bracket_id,omitempty"`
}

type ThemeImage struct {
	ID    int     `json:"id"`
	Key   string  `json:"key"`
	Value *string `json:"value"`
}

type Token struct {
	Expiration  string  `json:"expiration"`
	ID          int     `json:"id"`
	Type        string  `json:"type"`
	Value       *string `json:"value,omitempty"`
	Description *string `json:"description,omitempty"`
	Created     *string `json:"created,omitempty"`
	UserID      *int    `json:"user_id,omitempty"`
}

type Topic struct {
	ID          int    `json:"id"`
	ChallengeID *int   `json:"challenge_id,omitempty"`
	Challenge   *int   `json:"challenge,omitempty"` // XXX may be duplicated with ChallengeID ?
	TopicID     *int   `json:"topic_id,omitempty"`  // XXX may be duplicated with ID ?
	Topic       *int   `json:"topic,omitempty"`     // XXX may be duplicated with ID ?
	Value       string `json:"value"`
}

type Type struct {
	ID        *string `json:"id,omitempty"`
	Name      string  `json:"name"`
	Templates CUV     `json:"templates"`
	Scripts   *CUV    `json:"scripts,omitempty"`
	Create    *string `json:"create,omitempty"`
}

type Unlock struct {
	Type   string `json:"type"`
	TeamID int    `json:"team_id"`
	Target int    `json:"target"`
	Date   string `json:"date"`
	UserID int    `json:"user_id"`
	ID     int    `json:"id"`
}

type User struct {
	ID          int     `json:"id"`
	TeamID      *int    `json:"team_id,omitempty"`
	Country     *string `json:"country,omitempty"`
	Language    *string `json:"language,omitempty"`
	Affiliation *string `json:"affiliation,omitempty"`
	Fields      []Field `json:"fields"`
	Website     *string `json:"website,omitempty"`
	Name        string  `json:"name"`
	Email       *string `json:"email,omitempty"`
	OauthID     *string `json:"oauth_id,omitempty"`
	Verified    *bool   `json:"verified,omitempty"`
	Banned      *bool   `json:"banned,omitempty"`
	Hidden      *bool   `json:"hidden,omitempty"`
	Type        *string `json:"type,omitempty"`
	Created     *string `json:"created,omitempty"`
	Secret      *string `json:"secret,omitempty"`
	BracketID   *int    `json:"bracket_id,omitempty"`
}