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"`
	// Status of the API key.
	//
	// Any of "active", "inactive", "expired".
	Status APIKeyStatus `json:"status,required"`
	// When the API key was updated.
	UpdatedAt time.Time `json:"updated_at,required" format:"date-time"`
	// User ID that owns the API key.
	UserID string `json:"user_id,required"`
	// 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
		Status      respjson.Field
		UpdatedAt   respjson.Field
		UserID      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"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Items       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

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"`
	// contains filtered or unexported fields
}

type APIKeyService struct {
	Options []option.RequestOption
}

type APIKeyStatus string

type APIKeyUpdateParams struct {
	// API key name.
	Name param.Opt[string] `json:"name,omitzero"`
	// contains filtered or unexported fields
}

type Error = apierror.Error

type RegionName = shared.RegionName

type ResourceStatus = shared.ResourceStatus