blob

type Capability struct {
	// MaxSizeBlobSet is the maximum total size of a Blob/upload request.
	MaxSizeBlobSet uint64 `json:"maxSizeBlobSet"`

	// MaxDataSources is the maximum number of DataSourceObjects in a
	// single create.
	MaxDataSources uint64 `json:"maxDataSources"`

	// SupportedTypeNames lists the type names that support blob lookup.
	SupportedTypeNames []string `json:"supportedTypeNames"`

	// SupportedDigestAlgorithms lists the digest algorithms the server
	// supports for Blob/get.
	SupportedDigestAlgorithms []string `json:"supportedDigestAlgorithms"`
}

type Data struct {
	// ID is the blob identifier.
	ID jmap.ID `json:"id"`

	// Data is the base64-encoded blob content.
	Data *string `json:"data:asBase64,omitempty"`

	// IsEncodingProblem indicates whether the data could not be
	// faithfully represented as base64.
	IsEncodingProblem *bool `json:"isEncodingProblem,omitempty"`

	// IsTruncated indicates whether the data was truncated.
	IsTruncated *bool `json:"isTruncated,omitempty"`

	// Size is the total size of the blob in octets.
	Size *uint64 `json:"size,omitempty"`

	// Digest is the digest of the blob in the requested algorithm.
	Digest *string `json:"digest,omitempty"`
}

type DataSource struct {
	// DataAsBase64 is base64-encoded binary data.
	DataAsBase64 *string `json:"data:asBase64,omitempty"`

	// DataAsText is UTF-8 text data.
	DataAsText *string `json:"data:asText,omitempty"`

	// SourceBlobID references an existing blob to copy data from.
	SourceBlobID *jmap.ID `json:"blobId,omitempty"`

	// Offset is the byte offset into the source blob.
	Offset *uint64 `json:"offset,omitempty"`

	// Length is the number of bytes to copy from the source blob.
	Length *uint64 `json:"length,omitempty"`
}

type DataSourceObject struct {
	// Data is the list of data sources to concatenate.
	Data []DataSource `json:"data"`

	// Type is the optional media type of the resulting blob.
	Type *string `json:"type,omitempty"`
}

type Get struct {
	// AccountID is the account to retrieve blobs from.
	AccountID jmap.ID `json:"accountId"`

	// IDs is the list of blob identifiers to retrieve.
	IDs []jmap.ID `json:"ids"`

	// Properties lists the properties to return for each blob.
	Properties []string `json:"properties,omitempty"`

	// Offset is the byte offset to start reading from.
	Offset *uint64 `json:"offset,omitempty"`

	// Length is the number of bytes to return.
	Length *uint64 `json:"length,omitempty"`

	// DigestAlgorithm is the digest algorithm to use for computing a
	// digest of the blob data.
	DigestAlgorithm *string `json:"digestAlgorithm,omitempty"`
}

type GetResponse struct {
	// AccountID is the account the blobs were retrieved from.
	AccountID jmap.ID `json:"accountId"`

	// List contains the data for each found blob.
	List []*Data `json:"list,omitempty"`

	// NotFound lists blob IDs that were not found.
	NotFound []jmap.ID `json:"notFound,omitempty"`
}

type Info struct {
	// ID is the blob identifier.
	ID jmap.ID `json:"id"`

	// Type is the media type of the blob.
	Type *string `json:"type,omitempty"`

	// Size is the size of the blob in octets.
	Size uint64 `json:"size"`
}

type Lookup struct {
	// AccountID is the account to search in.
	AccountID jmap.ID `json:"accountId"`

	// TypeNames lists the object types to search for blob references.
	TypeNames []string `json:"typeNames"`

	// IDs is the list of blob identifiers to look up.
	IDs []jmap.ID `json:"ids"`
}

type LookupResponse struct {
	// AccountID is the account that was searched.
	AccountID jmap.ID `json:"accountId"`

	// List contains the lookup results for each found blob.
	List []*LookupResult `json:"list,omitempty"`

	// NotFound lists blob IDs that were not found.
	NotFound []jmap.ID `json:"notFound,omitempty"`
}

type LookupResult struct {
	// ID is the blob identifier.
	ID jmap.ID `json:"id"`

	// MatchedIDs maps type names to the IDs of objects that reference
	// this blob.
	MatchedIDs map[string][]jmap.ID `json:"matchedIds"`
}

type Upload struct {
	// AccountID is the account to upload the blob to.
	AccountID jmap.ID `json:"accountId"`

	// Create maps creation IDs to DataSourceObjects describing the blobs
	// to create.
	Create map[jmap.ID]*DataSourceObject `json:"create"`
}

type UploadResponse struct {
	// AccountID is the account the blobs were created in.
	AccountID jmap.ID `json:"accountId"`

	// Created maps creation IDs to the successfully created Info.
	Created map[jmap.ID]*Info `json:"created,omitempty"`

	// NotCreated maps creation IDs to SetErrors for failed creations.
	NotCreated map[jmap.ID]*jmap.SetError `json:"notCreated,omitempty"`
}