config

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 {
	// ListConfigs request
	ListConfigs(ctx context.Context, params *ListConfigsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	CreateConfigWithApplicationVndAPIPlusJSONBody(ctx context.Context, body CreateConfigApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

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

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

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

type ClientOption func(*Client) error

type ClientWithResponses struct {
	ClientInterface
}

type ClientWithResponsesInterface interface {
	// ListConfigsWithResponse request
	ListConfigsWithResponse(ctx context.Context, params *ListConfigsParams, reqEditors ...RequestEditorFn) (*ListConfigsResponse, error)

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

	CreateConfigWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, body CreateConfigApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateConfigResponse, error)

	// DeleteConfigWithResponse request
	DeleteConfigWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*DeleteConfigResponse, error)

	// GetConfigWithResponse request
	GetConfigWithResponse(ctx context.Context, id string, reqEditors ...RequestEditorFn) (*GetConfigResponse, error)

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

	UpdateConfigWithApplicationVndAPIPlusJSONBodyWithResponse(ctx context.Context, id string, body UpdateConfigApplicationVndAPIPlusJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateConfigResponse, error)

	// ListConfigUsageWithResponse request
	ListConfigUsageWithResponse(ctx context.Context, params *ListConfigUsageParams, reqEditors ...RequestEditorFn) (*ListConfigUsageResponse, error)
}

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

	// Description Optional human-readable description of what this config holds.
	Description *string `json:"description,omitempty"`

	// Environments Map of environment keys to per-environment override sets. An environment override applies when this config is resolved against that environment.
	Environments *map[string]EnvironmentOverride `json:"environments,omitempty"`

	// Items Map of item keys to item definitions declared on this config. Keys must be unique within the config; declared types are immutable once set and must match any type declared for the same key on an ancestor.
	Items *map[string]ConfigItemDefinition `json:"items,omitempty"`

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

	// Parent Key of another config to inherit items from. Inherited items appear as if declared on this config; locally declared items with the same key shadow them. Omit or set to `null` for a standalone config with no parent.
	Parent *string `json:"parent,omitempty"`

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

type ConfigItemDefinition struct {
	// Description Optional human-readable explanation of what this item controls.
	Description *string `json:"description,omitempty"`

	// Type Declared value type. Constrains the JSON shape of `value` and of every override of this key in the `environments` map.
	Type *ConfigItemDefinitionType `json:"type,omitempty"`

	// Value Current value for the item. May be `null` to represent a cleared (typed but unset) slot — for example, after a type change where the prior value could not be coerced.
	Value interface{} `json:"value,omitempty"`
}

type ConfigItemDefinitionType string

type ConfigItemOverride struct {
	// Value Override value for this environment. Must conform to the type declared for the item in the inheritance chain.
	Value interface{} `json:"value,omitempty"`
}

type ConfigListResponse struct {
	Data []ConfigResource `json:"data"`

	// Meta Top-level “meta“ block included on every JSON:API list response.
	Meta ListMeta `json:"meta"`
}

type ConfigRequest struct {
	// Data JSON:API resource envelope for a config.
	//
	// `id` is the human-readable key for the config and must be supplied
	// by the caller on create. It is unique within the account.
	Data ConfigResource `json:"data"`
}

type ConfigResource struct {
	// Attributes A named bag of configuration items, optionally inheriting from another config.
	//
	// Items are typed key/value pairs (`STRING`, `NUMBER`, `BOOLEAN`,
	// `JSON`). Configs may declare per-environment overrides for any item
	// declared on the config itself or anywhere in its inheritance chain;
	// resolving a config against an environment merges the chain top-down
	// and then applies the matching overrides.
	Attributes Config             `json:"attributes"`
	Id         *string            `json:"id,omitempty"`
	Type       ConfigResourceType `json:"type"`
}

type ConfigResourceType string

type ConfigResponse struct {
	// Data JSON:API resource envelope for a config.
	//
	// `id` is the human-readable key for the config and must be supplied
	// by the caller on create. It is unique within the account.
	Data ConfigResource `json:"data"`
}

type CreateConfigApplicationVndAPIPlusJSONRequestBody = ConfigRequest

type CreateConfigResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON201 *ConfigResponse
}

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

type EnvironmentOverride struct {
	// Values Map of item keys to override values that apply when this environment is resolved. Each key must already be declared (with a type) on this config or one of its ancestors.
	Values *map[string]ConfigItemOverride `json:"values,omitempty"`
}

type GetConfigResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ConfigResponse
}

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

type ListConfigUsageParams struct {
	// FilterPeriod Period to report. `current` is the only supported value.
	FilterPeriod *string `form:"filter[period],omitempty" json:"filter[period],omitempty"`

	// PageNumber 1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error.
	PageNumber *int `form:"page[number],omitempty" json:"page[number],omitempty"`

	// PageSize Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error.
	PageSize *int `form:"page[size],omitempty" json:"page[size],omitempty"`

	// MetaTotal When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`.
	MetaTotal *bool `form:"meta[total],omitempty" json:"meta[total],omitempty"`
}

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

type ListConfigsParams struct {
	FilterParent *string `form:"filter[parent],omitempty" json:"filter[parent],omitempty"`

	// FilterSearch Case-insensitive substring match against the config `key` and `name`. A config is returned if either field contains the search term.
	FilterSearch *string `form:"filter[search],omitempty" json:"filter[search],omitempty"`

	// Sort Field to sort by. Prefix with `-` for descending order. Default: `key`. Allowed values: `created_at`, `-created_at`, `key`, `-key`, `name`, `-name`, `updated_at`, `-updated_at`.
	Sort *ListConfigsParamsSort `form:"sort,omitempty" json:"sort,omitempty"`

	// PageNumber 1-based page number to return. Optional; defaults to `1` when omitted. Must be `>= 1` — requests with a smaller value are rejected with a 400 error.
	PageNumber *int `form:"page[number],omitempty" json:"page[number],omitempty"`

	// PageSize Number of items per page. Optional; defaults to `1000` when omitted. Must be between `1` and `1000` inclusive — requests outside that range are rejected with a 400 error.
	PageSize *int `form:"page[size],omitempty" json:"page[size],omitempty"`

	// MetaTotal When `true`, the response's `meta.pagination` block includes `total` (the total number of matching items across all pages) and `total_pages`. Computing these requires an extra `COUNT` query, so omit (or pass `false`) when the totals are not needed. Defaults to `false`.
	MetaTotal *bool `form:"meta[total],omitempty" json:"meta[total],omitempty"`
}

type ListConfigsParamsSort string

type ListConfigsResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ConfigListResponse
}

type ListMeta struct {
	// Pagination Pagination block returned inside “meta“ on every list response.
	//
	// “page“ and “size“ are always present and echo the parameters that
	// served the response (their defaults when the client omitted them).
	// “total“ and “total_pages“ are present only when the request included
	// “meta[total]=true“.
	Pagination PaginationMeta `json:"pagination"`
}

type PaginationMeta struct {
	// Page 1-based page number returned.
	Page int `json:"page"`

	// Size Number of items per page.
	Size int `json:"size"`

	// Total Total number of matching items across all pages. Present only when the request included `meta[total]=true`.
	Total *int `json:"total,omitempty"`

	// TotalPages Total number of pages at the requested page size. Present only when the request included `meta[total]=true`.
	TotalPages *int `json:"total_pages,omitempty"`
}

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

type UpdateConfigApplicationVndAPIPlusJSONRequestBody = ConfigRequest

type UpdateConfigResponse struct {
	Body                     []byte
	HTTPResponse             *http.Response
	ApplicationvndApiJSON200 *ConfigResponse
}

type UsageAttributes struct {
	// LimitKey Identifier of the metered limit, e.g. `config.managed_configurations` or `config.inheritance_depth`.
	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"`

	// Meta Top-level “meta“ block included on every JSON:API list response.
	Meta ListMeta `json:"meta"`
}

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