vault

type Client struct {
	// The WorkOS API Key. It can be found in https://dashboard.workos.com/api-keys.
	APIKey string

	// The http.Client that is used to get Vault records from WorkOS.
	// Defaults to http.Client.
	HTTPClient *retryablehttp.HttpClient

	// The endpoint to WorkOS API. Defaults to https://api.workos.com.
	Endpoint string

	// The function used to encode in JSON. Defaults to json.Marshal.
	JSONEncode func(v interface{}) ([]byte, error)
	// contains filtered or unexported fields
}

type CreateDataKeyOpts struct {
	// Map of values used to determine the encryption key used.
	KeyContext KeyContext `json:"context"`
}

type CreateObjectOpts struct {
	// Unique name of the object, used as the KV store key.
	Name string `json:"name"`

	// Plaintext data that will be stored in an encrypted format.
	Value string `json:"value"`

	// Map of values used to determine the encryption key used.
	KeyContext KeyContext `json:"key_context"`
}

type DataKey struct {
	// Unique ID of the data key.
	Id string `json:"id"`

	// Base64 encoded data key that can be used for encryption operations.
	Key string `json:"data_key"`
}

type DataKeyPair struct {
	// Map of values used to determine the encryption key used.
	KeyContext KeyContext `json:"context"`

	// Unique ID of the data key.
	Id string `json:"id"`

	// Base64 encoded data key that can be used for encryption operations.
	DataKey string `json:"data_key"`

	// An encrypted, Base64 encoded data key.
	EncryptedKeys string `json:"encrypted_keys"`
}

type Decoded struct {
	Iv         []byte
	Tag        []byte
	Keys       string
	Ciphertext []byte
}

type DecryptDataKeyOpts struct {
	// An encrypted, Base64 encoded data key.
	Keys string `json:"keys"`
}

type DecryptOpts struct {
	Data           string
	AssociatedData string
	NonceSize      int
}

type DeleteObjectOpts struct {
	// Unique string ID of the object.
	Id string `json:"id"`

	// ID of the expected version of the object.
	VersionCheck string `json:"version_check,omitempty"`
}

type DeleteObjectResponse struct {
	// Indicator of whether the operation succeeded.
	Success bool `json:"success"`

	// Unique name of the object, used as the KV store key.
	Name string `json:"name"`
}

type EncryptOpts struct {
	Data           string
	KeyContext     KeyContext
	AssociatedData string
}

type KeyContext map[string]interface{}

type ListObjectVersionsResponse struct {
	// List of verions for an encrypted Object.
	Data []ObjectVersion `json:"data"`
}

type ListObjectsOpts struct {
	// Maximum number of records to return.
	Limit int `url:"limit,omitempty"`

	// The order in which to paginate records.
	Order Order `url:"order,omitempty"`

	// Pagination cursor to receive records before a provided Object ID.
	Before string `url:"before,omitempty"`

	// Pagination cursor to receive records after a provided Object ID.
	After string `url:"after,omitempty"`
}

type ListObjectsResponse struct {
	// List of stored Objects.
	Data []ObjectDigest `json:"data"`

	// Cursor pagination options.
	ListMetadata common.ListMetadata `json:"list_metadata"`
}

type Object struct {
	// Unique string ID of the object.
	Id string `json:"id"`

	// Unique name of the object, used as the KV store key.
	Name string `json:"name"`

	// Plaintext data that will be stored in an encrypted format.
	Value string `json:"value"`

	// Extra information about the object.
	Metadata ObjectMetadata `json:"metadata"`
}

type ObjectDigest struct {
	// Unique string ID of the object.
	Id string `json:"id"`

	// Unique name of the object, used as the KV store key.
	Name string `json:"name"`

	// ISO 8601 timestamp of the last modification to the object.
	UpdatedAt time.Time `json:"updated_at"`
}

type ObjectMetadata struct {
	// Unique string ID of the object.
	Id string `json:"id"`

	// ID of the WorkOS environment where the object was created.
	EnvironmentId string `json:"environment_id"`

	// ID of the key used to encrypt the object.
	KeyId string `json:"key_id"`

	// ID of the specific version of the object.
	VersionId string `json:"version_id"`

	// Map of values used to determine the encryption key used.
	Context KeyContext `json:"context"`

	// ISO 8601 timestamp of the last modification to the object.
	UpdatedAt time.Time `json:"updated_at"`

	UpdatedBy struct {
		// ID of the user or API key that last wrote to the object.
		Id string `json:"id"`

		// Name of the user or API key that last wrote to the object.
		Name string `json:"name"`
	} `json:"updated_by"`
}

type ObjectVersion struct {
	// ID of the specific version of the object.
	Id string `json:"id"`

	// ISO 8601 timestamp of when the version was created.
	CreatedAt time.Time `json:"created_at"`

	// Indicator of whether this is the active, default version.
	CurrentVersion bool `json:"current_version"`

	// A hash of the value of the object.
	Etag string `json:"etag"`

	/// Number of bytes of data stored in the object.
	Size int `json:"size"`
}

type Order string

type ReadObjectOpts struct {
	// Unique string ID of the object.
	Id string `json:"id"`
}

type UpdateObjectOpts struct {
	// Unique string ID of the object.
	Id string `json:"id"`

	// Plaintext data that will be stored in an encrypted format.
	Value string `json:"value"`

	// ID of the expected version of the object.
	VersionCheck string `json:"version_check,omitempty"`
}