api_keys

type APIKey struct {
	// API Key ID.
	ID string `json:"id,required"`
	// When the API Key was created.
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// When the API Key expires and is no longer valid.
	ExpiresAt time.Time `json:"expires_at,required" format:"date-time"`
	// API Key name.
	Name string `json:"name,required"`
	// IP filter configuration for the API Key.
	SourceIPRule APIKeySourceIPRule `json:"source_ip_rule,required"`
	// Status of the API Key.
	//
	// Any of "active", "inactive", "expired".
	Status APIKeyStatus `json:"status,required"`
	// Tags to attach to the API Key.
	Tags []string `json:"tags,required"`
	// When the API Key was updated.
	UpdatedAt time.Time `json:"updated_at,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
		Name         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,required"`
	// Pagination response details.
	Pagination shared.Pagination `json:"pagination,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,required" format:"date-time"`
	// API Key name.
	Name string `json:"name,required"`
	// When the API Key starts to be valid.
	StartsAt param.Opt[time.Time] `json:"starts_at,omitzero" format:"date-time"`
	// IP filter configuration for the API Key.
	SourceIPRule APIKeyNewParamsSourceIPRule `json:"source_ip_rule,omitzero"`
	// Tags to attach to the API Key.
	Tags []string `json:"tags,omitzero"`
	// contains filtered or unexported fields
}

type APIKeyNewParamsSourceIPRule struct {
	// List of IPv4/IPv6 CIDR addresses to allow.
	Allowed []string `json:"allowed,omitzero"`
	// List of IPv4/IPv6 CIDR addresses to deny.
	Blocked []string `json:"blocked,omitzero"`
	// contains filtered or unexported fields
}

type APIKeyService struct {
	Options []option.RequestOption
}

type APIKeySourceIPRule struct {
	// List of IPv4/IPv6 CIDR addresses to allow.
	Allowed []string `json:"allowed,required"`
	// List of IPv4/IPv6 CIDR addresses to deny.
	Blocked []string `json:"blocked,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Allowed     respjson.Field
		Blocked     respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

type APIKeyStatus string

type APIKeyUpdateParams struct {
	// API Key name.
	Name param.Opt[string] `json:"name,omitzero"`
	// IP filter configuration for the API Key.
	SourceIPRule APIKeyUpdateParamsSourceIPRule `json:"source_ip_rule,omitzero"`
	// Tags to attach to the API Key.
	Tags []string `json:"tags,omitzero"`
	// contains filtered or unexported fields
}

type APIKeyUpdateParamsSourceIPRule struct {
	// List of IPv4/IPv6 CIDR addresses to allow.
	Allowed []string `json:"allowed,omitzero"`
	// List of IPv4/IPv6 CIDR addresses to deny.
	Blocked []string `json:"blocked,omitzero"`
	// contains filtered or unexported fields
}

type Error = apierror.Error

type Pagination = shared.Pagination

type RegionName = shared.RegionName

type ResourceStatus = shared.ResourceStatus