api_keys

type APIKey struct {
	// API Key ID.
	ID string `json:"id" api:"required"`
	// When the API Key was created.
	CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
	// When the API Key expires and is no longer valid.
	ExpiresAt time.Time `json:"expires_at" api:"required" format:"date-time"`
	// Whether this API key is system-managed.
	Managed bool `json:"managed" api:"required"`
	// API Key name.
	Name string `json:"name" api:"required"`
	// Scoped permissions for this API key.
	Permissions []APIKeyPermission `json:"permissions" api:"required"`
	// Project IDs this API key is scoped to.
	ProjectIDs []string `json:"project_ids" api:"required"`
	// IP filter rules.
	SourceIPRule shared.SourceIPRuleResponse `json:"source_ip_rule" api:"required"`
	// Status of the API Key.
	//
	// Any of "active", "inactive", "expired".
	Status APIKeyStatus `json:"status" api:"required"`
	// Tags to attach to the API Key.
	Tags []string `json:"tags" api:"required"`
	// When the API Key was updated.
	UpdatedAt time.Time `json:"updated_at" api:"required" format:"date-time"`
	// API Key. Only returned on creation.
	Key string `json:"key"`
	// When the API Key starts to be valid.
	StartsAt time.Time `json:"starts_at" format:"date-time"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID           respjson.Field
		CreatedAt    respjson.Field
		ExpiresAt    respjson.Field
		Managed      respjson.Field
		Name         respjson.Field
		Permissions  respjson.Field
		ProjectIDs   respjson.Field
		SourceIPRule respjson.Field
		Status       respjson.Field
		Tags         respjson.Field
		UpdatedAt    respjson.Field
		Key          respjson.Field
		StartsAt     respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type APIKeyList struct {
	Items []APIKey `json:"items" api:"required"`
	// Pagination response details.
	Pagination shared.Pagination `json:"pagination" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Items       respjson.Field
		Pagination  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type APIKeyListParams struct {
	// Pagination cursor returned by a previous request
	Cursor param.Opt[string] `query:"cursor,omitzero" json:"-"`
	// Maximum number of items to return
	Limit param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// contains filtered or unexported fields
}

type APIKeyNewParams struct {
	// When the API Key expires and is no longer valid.
	ExpiresAt time.Time `json:"expires_at" api:"required" format:"date-time"`
	// API Key name.
	Name string `json:"name" api:"required"`
	// Scoped permissions for this API key. At least one is required.
	Permissions []APIKeyNewParamsPermission `json:"permissions,omitzero" api:"required"`
	// Project IDs this API key is scoped to. At least one is required.
	ProjectIDs []string `json:"project_ids,omitzero" api:"required"`
	// When the API Key starts to be valid.
	StartsAt param.Opt[time.Time] `json:"starts_at,omitzero" format:"date-time"`
	// IP filter rules.
	SourceIPRule shared.SourceIPRuleParam `json:"source_ip_rule,omitzero"`
	// Tags to attach to the API Key.
	Tags []string `json:"tags,omitzero"`
	// contains filtered or unexported fields
}

type APIKeyNewParamsPermission struct {
	// Permission level: "read" or "edit".
	//
	// Any of "read", "edit".
	Permission APIPermissionLevel `json:"permission,omitzero" api:"required"`
	// Resource type this permission applies to.
	//
	// Any of "vm", "vpc", "volume", "connect_connection", "rpc_node_dedicated",
	// "rpc_node_flex", "nks_cluster", "nks_node_pool", "project", "api_key",
	// "organization", "audit_log".
	ResourceType APIPermissionResourceType `json:"resource_type,omitzero" api:"required"`
	// contains filtered or unexported fields
}

type APIKeyPermission struct {
	// Permission level: "read" or "edit".
	//
	// Any of "read", "edit".
	Permission APIPermissionLevel `json:"permission" api:"required"`
	// Resource type this permission applies to.
	//
	// Any of "vm", "vpc", "volume", "connect_connection", "rpc_node_dedicated",
	// "rpc_node_flex", "nks_cluster", "nks_node_pool", "project", "api_key",
	// "organization", "audit_log".
	ResourceType APIPermissionResourceType `json:"resource_type" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Permission   respjson.Field
		ResourceType respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type APIKeyService struct {
	Options []option.RequestOption
}

type APIKeyStatus string

type APIKeyUpdateParams struct {
	// API Key name.
	Name param.Opt[string] `json:"name,omitzero"`
	// Scoped permissions for this API key. When provided, replaces the entire set. At
	// least one is required.
	Permissions []APIKeyUpdateParamsPermission `json:"permissions,omitzero"`
	// Project IDs this API key is scoped to. When provided, replaces the entire set.
	// At least one is required.
	ProjectIDs []string `json:"project_ids,omitzero"`
	// IP filter rules.
	SourceIPRule shared.SourceIPRuleParam `json:"source_ip_rule,omitzero"`
	// Tags to attach to the API Key.
	Tags []string `json:"tags,omitzero"`
	// contains filtered or unexported fields
}

type APIKeyUpdateParamsPermission struct {
	// Permission level: "read" or "edit".
	//
	// Any of "read", "edit".
	Permission APIPermissionLevel `json:"permission,omitzero" api:"required"`
	// Resource type this permission applies to.
	//
	// Any of "vm", "vpc", "volume", "connect_connection", "rpc_node_dedicated",
	// "rpc_node_flex", "nks_cluster", "nks_node_pool", "project", "api_key",
	// "organization", "audit_log".
	ResourceType APIPermissionResourceType `json:"resource_type,omitzero" api:"required"`
	// contains filtered or unexported fields
}

type APIPermissionLevel string

type APIPermissionResourceType string

type Error = apierror.Error

type Pagination = shared.Pagination

type RegionName = shared.RegionName

type ResourceStatus = shared.ResourceStatus

type SourceIPRuleParam = shared.SourceIPRuleParam

type SourceIPRuleResponse = shared.SourceIPRuleResponse