flags

type BulkRegisterFlagsApplicationVndAPIPlusJSONRequestBody = FlagBulkRequest

type BulkRegisterFlagsResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *FlagBulkResponse
}

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

type ClientInterface interface {
	// ListAllFlagSources request
	ListAllFlagSources(ctx context.Context, params *ListAllFlagSourcesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListFlags request
	ListFlags(ctx context.Context, params *ListFlagsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CreateFlagWithBody request with any body
	CreateFlagWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	CreateFlagWithApplicationVndAPIPlusJSONBody(ctx context.Context, body CreateFlagApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// BulkRegisterFlagsWithBody request with any body
	BulkRegisterFlagsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	BulkRegisterFlagsWithApplicationVndAPIPlusJSONBody(ctx context.Context, body BulkRegisterFlagsApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteFlag request
	DeleteFlag(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetFlag request
	GetFlag(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateFlagWithBody request with any body
	UpdateFlagWithBody(ctx context.Context, id string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateFlagWithApplicationVndAPIPlusJSONBody(ctx context.Context, id string, body UpdateFlagApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListFlagSources request
	ListFlagSources(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RemoveReferencesWithBody request with any body
	RemoveReferencesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RemoveReferencesWithApplicationVndAPIPlusJSONBody(ctx context.Context, body RemoveReferencesApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListFlagsUsage request
	ListFlagsUsage(ctx context.Context, params *ListFlagsUsageParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// ListAllFlagSourcesWithResponse request
	ListAllFlagSourcesWithResponse(ctx context.Context, params *ListAllFlagSourcesParams, reqEditors ...RequestEditorFn) (*ListAllFlagSourcesResponse, error)

	// ListFlagsWithResponse request
	ListFlagsWithResponse(ctx context.Context, params *ListFlagsParams, reqEditors ...RequestEditorFn) (*ListFlagsResponse, error)

	// CreateFlagWithBodyWithResponse request with any body
	CreateFlagWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateFlagResponse, error)

	CreateFlagWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, body CreateFlagApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateFlagResponse, error)

	// BulkRegisterFlagsWithBodyWithResponse request with any body
	BulkRegisterFlagsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*BulkRegisterFlagsResponse, error)

	BulkRegisterFlagsWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, body BulkRegisterFlagsApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*BulkRegisterFlagsResponse, error)

	// DeleteFlagWithResponse request
	DeleteFlagWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DeleteFlagResponse, error)

	// GetFlagWithResponse request
	GetFlagWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetFlagResponse, error)

	// UpdateFlagWithBodyWithResponse request with any body
	UpdateFlagWithBodyWithResponse(ctx context.Context, id string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateFlagResponse, error)

	UpdateFlagWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, id string, body UpdateFlagApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateFlagResponse, error)

	// ListFlagSourcesWithResponse request
	ListFlagSourcesWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*ListFlagSourcesResponse, error)

	// RemoveReferencesWithBodyWithResponse request with any body
	RemoveReferencesWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RemoveReferencesResponse, error)

	RemoveReferencesWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, body RemoveReferencesApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*RemoveReferencesResponse, error)

	// ListFlagsUsageWithResponse request
	ListFlagsUsageWithResponse(ctx context.Context, params *ListFlagsUsageParams, reqEditors ...RequestEditorFn) (*ListFlagsUsageResponse, error)
}

type CreateFlagApplicationVndAPIPlusJSONRequestBody = FlagRequest

type CreateFlagResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON201 *FlagResponse
}

type DeleteFlagResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

type Flag struct {
	// CreatedAt When the flag was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// Default Default value returned when no environment rule fires and the environment has no `default`. For constrained flags (non-null `values`), must equal one of the entries in the `values` array. For unconstrained flags, must match `type`.
	Default interface{} `json:"default"`

	// Description Human-readable description of the flag's purpose.
	Description *string `json:"description,omitempty"`

	// Environments Per-environment configuration keyed by environment name (`production`, `staging`, etc.). Environments not listed fall back to the flag's global `default`.
	Environments *map[string]FlagEnvironment `json:"environments,omitempty"`

	// Managed `true` when the flag was created through the API, `false` when it was auto-discovered from a bulk-register call. Auto-discovered flags can be edited and converted to managed by setting this to `true`.
	Managed *bool `json:"managed,omitempty"`

	// Name Human-readable display name for the flag.
	Name string `json:"name"`

	// Sources SDK-reported observations of this flag, grouped by service and environment. Populated automatically by the bulk-register endpoint.
	Sources *[]FlagSource `json:"sources,omitempty"`

	// Type Value type of the flag. Accepted case-insensitively. Changing the type cascades to `values`, `default`, and every environment's rules and default.
	Type FlagType `json:"type"`

	// UpdatedAt When the flag was last modified.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`

	// Values Ordered set of allowed values for a constrained flag, or `null` for an unconstrained flag. `BOOLEAN` flags, if constrained, must declare exactly two values.
	Values *[]FlagValue `json:"values,omitempty"`
}

type FlagBulkItem struct {
	// Default Default value the SDK declared for the flag. Used to create the flag if it does not already exist.
	Default interface{} `json:"default"`

	// Environment Environment reporting the declaration. Defaults to `unknown`.
	Environment *string `json:"environment,omitempty"`

	// Id Flag key as declared in code. URL-safe and stable for the lifetime of the flag.
	Id string `json:"id"`

	// Service Service reporting the declaration. Defaults to `unknown`.
	Service *string `json:"service,omitempty"`

	// Type Value type the SDK declared for the flag. Accepted case-insensitively.
	Type FlagBulkItemType `json:"type"`
}

type FlagBulkItemType string

type FlagBulkRequest struct {
	// Flags Flags reported by the SDK in this batch.
	Flags []FlagBulkItem `json:"flags"`
}

type FlagBulkResponse struct {
	// Registered Number of items in the batch that were registered or refreshed.
	Registered int `json:"registered"`
}

type FlagEnvironment struct {
	// Default Environment-level default returned when no rule fires. If `null`, evaluation falls back to the flag's global `default`.
	Default interface{} `json:"default,omitempty"`

	// Enabled Whether the flag is active in this environment. When `false`, evaluation skips rules and returns the flag's global `default`.
	Enabled *bool `json:"enabled,omitempty"`

	// Rules Targeting rules evaluated top-down. The first rule whose logic returns truthy provides the result.
	Rules *[]FlagRule `json:"rules,omitempty"`
}

type FlagListResponse struct {
	Data []FlagResource `json:"data"`
}

type FlagRequest struct {
	// Data JSON:API resource envelope for a flag.
	//
	// `id` is the flag key. For create requests, `id` is required and is
	// chosen by the caller. For update requests, `id` may be omitted (the
	// server reads the key from the URL) or supplied to rename the flag.
	Data FlagResource `json:"data"`
}

type FlagResource struct {
	// Attributes A feature flag whose value is resolved at runtime from environment
	// rules and a default.
	//
	// A flag has a value type (`BOOLEAN`, `STRING`, `NUMERIC`, or `JSON`)
	// and either a fixed set of allowed values (constrained) or accepts
	// any value matching the type (unconstrained). Each environment can
	// enable or disable the flag, set its own default, and define
	// targeting rules that override the default for specific evaluation
	// contexts.
	Attributes Flag             `json:"attributes"`
	Id         *string          `json:"id,omitempty"`
	Type       FlagResourceType `json:"type"`
}

type FlagResourceType string

type FlagResponse struct {
	// Data JSON:API resource envelope for a flag.
	//
	// `id` is the flag key. For create requests, `id` is required and is
	// chosen by the caller. For update requests, `id` may be omitted (the
	// server reads the key from the URL) or supplied to rename the flag.
	Data FlagResource `json:"data"`
}

type FlagRule struct {
	// Description Human-readable description of the rule.
	Description *string `json:"description,omitempty"`

	// Logic JSON Logic expression evaluated against the evaluation context. The rule fires when the expression is truthy.
	Logic map[string]interface{} `json:"logic"`

	// Value Value returned when the rule fires. Must reference a value from the flag's `values` array (constrained flags) or match the flag's `type` (unconstrained flags).
	Value interface{} `json:"value"`
}

type FlagSource struct {
	// CreatedAt When the source record was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`

	// DeclaredDefault Default value the SDK reported when registering the flag from this service/environment. May differ from the flag's authoritative `default` if the service is running stale code.
	DeclaredDefault interface{} `json:"declared_default,omitempty"`

	// DeclaredType Value type the SDK reported when registering the flag from this service/environment. May differ from the flag's authoritative `type` if the service is running stale code.
	DeclaredType *FlagSourceDeclaredType `json:"declared_type,omitempty"`

	// Environment Environment in which the service declared the flag.
	Environment *string `json:"environment,omitempty"`

	// FirstObserved When this source was first observed.
	FirstObserved *time.Time `json:"first_observed,omitempty"`

	// LastSeen Most recent time the SDK re-registered this source.
	LastSeen *time.Time `json:"last_seen,omitempty"`

	// Service Service that declared the flag.
	Service *string `json:"service,omitempty"`

	// UpdatedAt When the source record was last modified.
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
}

type FlagSourceDeclaredType string

type FlagSourceListResponse struct {
	Data []FlagSourceResource `json:"data"`
}

type FlagSourceResource struct {
	// Attributes A record of an SDK observing a feature flag from a particular
	// service and environment.
	//
	// The flags service auto-registers a source the first time an SDK
	// reports a flag from a given service/environment pair and refreshes
	// `last_seen` on every subsequent report. Each source captures the
	// value type and default value the SDK declared in source code at
	// that location, which makes it possible to detect when service code
	// has drifted from the flag's authoritative configuration.
	Attributes FlagSource             `json:"attributes"`
	Id         *string                `json:"id,omitempty"`
	Type       FlagSourceResourceType `json:"type"`
}

type FlagSourceResourceType string

type FlagType string

type FlagValue struct {
	// Name Human-readable label for the value.
	Name string `json:"name"`

	// Value The value itself. Must match the flag's `type`.
	Value interface{} `json:"value"`
}

type GetFlagResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *FlagResponse
}

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type ListAllFlagSourcesParams struct {
	FilterEnvironment *string `form:"filter[environment],omitempty" json:"filter[environment],omitempty"`
	FilterService     *string `form:"filter[service],omitempty" json:"filter[service],omitempty"`
}

type ListAllFlagSourcesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *FlagSourceListResponse
}

type ListFlagSourcesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *FlagSourceListResponse
}

type ListFlagsParams struct {
	FilterType    *string `form:"filter[type],omitempty" json:"filter[type],omitempty"`
	FilterManaged *bool   `form:"filter[managed],omitempty" json:"filter[managed],omitempty"`

	// FilterReferencesContext Return flags whose rules reference this context instance. Format: {type}:{key}
	FilterReferencesContext *string `form:"filter[references_context],omitempty" json:"filter[references_context],omitempty"`

	// FilterReferencesContextType Return flags whose rules reference any attribute of the given context type.
	FilterReferencesContextType *string `form:"filter[references_context_type],omitempty" json:"filter[references_context_type],omitempty"`
}

type ListFlagsResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *FlagListResponse
}

type ListFlagsUsageParams struct {
	FilterPeriod *string `form:"filter[period],omitempty" json:"filter[period],omitempty"`
}

type ListFlagsUsageResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *UsageListResponse
}

type ManualReviewItem struct {
	// Environment Environment containing the rule.
	Environment string `json:"environment"`

	// Flag Key of the flag containing the rule.
	Flag string `json:"flag"`

	// Reason Why the rule needs manual review.
	Reason string `json:"reason"`

	// RuleIndex Position of the rule within the environment's `rules` array.
	RuleIndex int `json:"rule_index"`
}

type RemoveReferencesApplicationVndAPIPlusJSONRequestBody = RemoveReferencesRequest

type RemoveReferencesAttributes struct {
	// FlagsModified Keys of flags whose rules were modified.
	FlagsModified []string `json:"flags_modified"`

	// RulesNeedingManualReview Rules that referenced the context but could not be removed automatically (typically because the reference is inside an `and` expression where removal would broaden the rule).
	RulesNeedingManualReview []ManualReviewItem `json:"rules_needing_manual_review"`

	// RulesRemoved Total number of rules removed across all flags.
	RulesRemoved int `json:"rules_removed"`
}

type RemoveReferencesRequest struct {
	// Context Identifier of the context instance to remove references to, formatted as `{type}:{key}` (e.g. `customer:c-123`).
	Context *string `json:"context,omitempty"`

	// ContextType Context type to remove all references to (any attribute of this type).
	ContextType *string `json:"context_type,omitempty"`
}

type RemoveReferencesResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *RemoveReferencesResultEnvelope
}

type RemoveReferencesResultEnvelope struct {
	// Data JSON:API resource envelope for the remove-references result.
	Data RemoveReferencesResultResource `json:"data"`
}

type RemoveReferencesResultResource struct {
	// Attributes Counts and follow-ups returned by the remove-references action.
	Attributes RemoveReferencesAttributes          `json:"attributes"`
	Type       *RemoveReferencesResultResourceType `json:"type,omitempty"`
}

type RemoveReferencesResultResourceType string

type RequestEditorFn func(ctx context.Context, req *http.Request) error

type UpdateFlagApplicationVndAPIPlusJSONRequestBody = FlagRequest

type UpdateFlagResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *FlagResponse
}

type UsageAttributes struct {
	// LimitKey Identifier of the metered limit, e.g. `flags.items`.
	LimitKey string `json:"limit_key"`

	// Period Period the counter covers. `current` is the only supported value.
	Period string `json:"period"`

	// Value Count for the period.
	Value int `json:"value"`
}

type UsageListResponse struct {
	Data []UsageResource `json:"data"`
}

type UsageResource struct {
	// Attributes Usage counter for a single metered limit.
	Attributes UsageAttributes   `json:"attributes"`
	Id         string            `json:"id"`
	Type       UsageResourceType `json:"type"`
}

type UsageResourceType string