tus

type Client struct {
	HeadEndpoint    goa.Endpoint
	PatchEndpoint   goa.Endpoint
	OptionsEndpoint goa.Endpoint
	PostEndpoint    goa.Endpoint
	DeleteEndpoint  goa.Endpoint
}

type DeletePayload struct {
	// IDs are generated using Xid: https://github.com/rs/xid
	ID string
	// tusResumable represents a tus protocol version.
	TusResumable string
}

type DeleteResult struct {
	// tusResumable represents a tus protocol version.
	TusResumable string
}

type Endpoints struct {
	Head    goa.Endpoint
	Patch   goa.Endpoint
	Options goa.Endpoint
	Post    goa.Endpoint
	Delete  goa.Endpoint
}

type ErrInvalidTUSResumable struct {
	// Comma separated list of supported versions.
	TusVersion string
}

type HeadPayload struct {
	// IDs are generated using Xid: https://github.com/rs/xid
	ID string
	// tusResumable represents a tus protocol version.
	TusResumable string
}

type HeadResult struct {
	// tusResumable represents a tus protocol version.
	TusResumable string
	// uploadOffset represents a byte offset within a resource.
	UploadOffset int64
	// uploadLength represents the size of the entire upload in bytes.
	UploadLength *int64
	// The Upload-Defer-Length request and response header indicates that the size
	// of the upload is not known currently and will be transferred later.
	UploadDeferLength *int
	// The Client MAY supply the Upload-Metadata header to add additional metadata
	// to the upload creation request.
	UploadMetadata *string
}

type OptionsResult struct {
	// tusResumable represents a tus protocol version.
	TusResumable string
	// tusVersion is a comma separated list of protocol versions supported by the
	// server. This implementation only supports 1.0.0.
	TusVersion string
	// tusExtension is a comma separated list of extensions supported by the
	// server. This implementation supports the creation, creation-with-upload,
	// expiration, checksum and termination extensions
	TusExtension string
	// tusMaxSize represents the maximum allowed size of an entire upload in bytes.
	TusMaxSize *int64
	// A Client MAY include the Upload-Checksum header in a PATCH request. Once the
	// entire request has been received, the Server MUST verify the uploaded chunk
	// against the provided checksum using the specified algorithm.
	TusChecksumAlgorithm string
}

type PatchPayload struct {
	// IDs are generated using Xid: https://github.com/rs/xid
	ID string
	// tusResumable represents a tus protocol version.
	TusResumable string
	// uploadOffset represents a byte offset within a resource.
	UploadOffset int64
	// A Client MAY include the Upload-Checksum header in a PATCH request. Once the
	// entire request has been received, the Server MUST verify the uploaded chunk
	// against the provided checksum using the specified algorithm.
	UploadChecksum *string
}

type PatchRequestData struct {
	// Payload is the method payload.
	Payload *PatchPayload
	// Body streams the HTTP request body.
	Body io.ReadCloser
}

type PatchResult struct {
	// tusResumable represents a tus protocol version.
	TusResumable string
	// uploadOffset represents a byte offset within a resource.
	UploadOffset int64
	// The Upload-Expires response header indicates the time after which the
	// unfinished upload expires.
	UploadExpires *string
}

type PostPayload struct {
	// tusResumable represents a tus protocol version.
	TusResumable string
	// uploadLength represents the size of the entire upload in bytes.
	UploadLength *int64
	// The Upload-Defer-Length request and response header indicates that the size
	// of the upload is not known currently and will be transferred later.
	UploadDeferLength *int
	// A Client MAY include the Upload-Checksum header in a PATCH request. Once the
	// entire request has been received, the Server MUST verify the uploaded chunk
	// against the provided checksum using the specified algorithm.
	UploadChecksum *string
	// The Client MAY supply the Upload-Metadata header to add additional metadata
	// to the upload creation request.
	UploadMetadata *string
	// Length of the upload
	TusMaxSize *int64
}

type PostRequestData struct {
	// Payload is the method payload.
	Payload *PostPayload
	// Body streams the HTTP request body.
	Body io.ReadCloser
}

type PostResult struct {
	// tusResumable represents a tus protocol version.
	TusResumable string
	// uploadOffset represents a byte offset within a resource.
	UploadOffset int64
	// The Upload-Expires response header indicates the time after which the
	// unfinished upload expires.
	UploadExpires *string
	// URL of created resource
	Location string
}

type Service interface {
	// Clients use the HEAD request to determine the offset at which the upload
	// should be continued.
	Head(context.Context, *HeadPayload) (res *HeadResult, err error)
	// Clients use the PATCH method to start or resume an upload.
	Patch(context.Context, *PatchPayload, io.ReadCloser) (res *PatchResult, err error)
	// Clients use the OPTIONS method to gather information about the Server’s
	// current configuration.
	Options(context.Context) (res *OptionsResult, err error)
	// Clients use the POST method against a known upload creation URL to request a
	// new upload resource.
	Post(context.Context, *PostPayload, io.ReadCloser) (res *PostResult, err error)
	// Clients use the DELETE method to terminate completed and unfinished uploads
	// allowing the Server to free up used resources.
	Delete(context.Context, *DeletePayload) (res *DeleteResult, err error)
}