cca

type Artifact struct {
	Type     string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Name     string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	MimeType string `protobuf:"bytes,3,opt,name=mimeType,proto3" json:"mimeType,omitempty"`
	Value    string `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type ConvertToDocumentReq struct {
	Newsml string `protobuf:"bytes,1,opt,name=newsml,proto3" json:"newsml,omitempty"` // required Full XML NewsML based document
	// contains filtered or unexported fields
}

type ConvertToDocumentRes struct {
	Document *rpc.Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

type ConvertToNewsmlReq struct {
	Document *rpc.Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"` // required A Naviga Doc in JSON
	// contains filtered or unexported fields
}

type ConvertToNewsmlRes struct {
	Newsml string `protobuf:"bytes,1,opt,name=newsml,proto3" json:"newsml,omitempty"` // Document as NewsML
	// contains filtered or unexported fields
}

type CreateDownloadReq struct {
	UUID       string       `protobuf:"bytes,1,opt,name=UUID,proto3" json:"UUID,omitempty"`                        // required UUID of document
	Type       DownloadType `protobuf:"varint,2,opt,name=type,proto3,enum=cca.DownloadType" json:"type,omitempty"` // optional with value 'original' or 'presentation', see DownloadType enum
	Repository string       `protobuf:"bytes,3,opt,name=repository,proto3" json:"repository,omitempty"`            // The repository we're downloading from, defaults to "editorial".
	// contains filtered or unexported fields
}

type CreateDownloadRes struct {
	DownloadId string    `protobuf:"bytes,1,opt,name=downloadId,proto3" json:"downloadId,omitempty"`
	Manifest   *Manifest `protobuf:"bytes,2,opt,name=manifest,proto3" json:"manifest,omitempty"` // optional, used when type is supplied in CreateDownloadReq
	// contains filtered or unexported fields
}

type CreateUploadReq struct {
	Filename   string `protobuf:"bytes,1,opt,name=filename,proto3" json:"filename,omitempty"`
	Unit       string `protobuf:"bytes,2,opt,name=unit,proto3" json:"unit,omitempty"`
	Repository string `protobuf:"bytes,3,opt,name=repository,proto3" json:"repository,omitempty"` // The repository we're uploading to, defaults to "editorial".
	// contains filtered or unexported fields
}

type CreateUploadRes struct {
	UploadId  string `protobuf:"bytes,1,opt,name=uploadId,proto3" json:"uploadId,omitempty"`
	UploadUrl string `protobuf:"bytes,2,opt,name=uploadUrl,proto3" json:"uploadUrl,omitempty"`
	// contains filtered or unexported fields
}

type CreateViewReq struct {
	UUID       string `protobuf:"bytes,1,opt,name=UUID,proto3" json:"UUID,omitempty"`             // required Document UUID
	Repository string `protobuf:"bytes,2,opt,name=repository,proto3" json:"repository,omitempty"` // The repository we're reading from, defaults to "editorial".
	// contains filtered or unexported fields
}

type CreateViewRes struct {
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

type DeleteDocumentReq struct {
	UUID       string `protobuf:"bytes,1,opt,name=UUID,proto3" json:"UUID,omitempty"`             // required The UUID of the document that will be removed
	Unit       string `protobuf:"bytes,2,opt,name=unit,proto3" json:"unit,omitempty"`             // required Under which unit are you performing this action
	Repository string `protobuf:"bytes,3,opt,name=repository,proto3" json:"repository,omitempty"` // The repository we're deleting from, defaults to "editorial".
	// contains filtered or unexported fields
}

type DeleteDocumentRes struct {
	Deleted bool `protobuf:"varint,1,opt,name=deleted,proto3" json:"deleted,omitempty"`
	// contains filtered or unexported fields
}

type DocumentExistsReq struct {
	UUID       string `protobuf:"bytes,1,opt,name=UUID,proto3" json:"UUID,omitempty"`             // required UUID of the document
	Unit       string `protobuf:"bytes,2,opt,name=unit,proto3" json:"unit,omitempty"`             // required Under which unit are you performing this action
	Repository string `protobuf:"bytes,3,opt,name=repository,proto3" json:"repository,omitempty"` // The repository we're performing the check against, defaults to "editorial".
	// contains filtered or unexported fields
}

type DocumentExistsRes struct {
	Exists bool `protobuf:"varint,1,opt,name=exists,proto3" json:"exists,omitempty"`
	// contains filtered or unexported fields
}

type Documents interface {
	//
	// WriteDocument is the method you would want to use when creating or updating documents.
	//
	// The method also contains functionality to handle optimistic locking. To use this you need to pass lockingMode and expectedRevision parameters.
	WriteDocument(context.Context, *WriteDocumentReq) (*WriteDocumentRes, error)

	// DeleteDocument deletes a document from repository.
	DeleteDocument(context.Context, *DeleteDocumentReq) (*DeleteDocumentRes, error)

	// Get document retreives a document from content repo
	GetDocument(context.Context, *GetDocumentReq) (*GetDocumentRes, error)

	// Method to check weather a document exists, Is cheaper to use than GetDocument
	DocumentExists(context.Context, *DocumentExistsReq) (*DocumentExistsRes, error)
}

type DownloadType int32

type ExternalUuidsHit struct {
	Uuid            string        `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`                       // uuid of the document
	ExternalUUID    string        `protobuf:"bytes,2,opt,name=externalUUID,proto3" json:"externalUUID,omitempty"`       // the external UUID property value
	ExternalURI     string        `protobuf:"bytes,3,opt,name=externalURI,proto3" json:"externalURI,omitempty"`         // the external URI property value
	ExternalVersion string        `protobuf:"bytes,4,opt,name=externalVersion,proto3" json:"externalVersion,omitempty"` // the external version property value
	Document        *rpc.Document `protobuf:"bytes,5,opt,name=document,proto3" json:"document,omitempty"`               // full Naviga document
	Error           string        `protobuf:"bytes,7,opt,name=error,proto3" json:"error,omitempty"`                     // if an error occurs fetching the document the error message
	// contains filtered or unexported fields
}

type ExternalUuidsReq struct {
	ExternalUuids   []string `protobuf:"bytes,1,rep,name=externalUuids,proto3" json:"externalUuids,omitempty"`      // list of UUIDs to lookup documents with ExternalUUIU property
	Start           int64    `protobuf:"varint,2,opt,name=start,proto3" json:"start,omitempty"`                     // an offset of the result set
	Limit           int64    `protobuf:"varint,3,opt,name=limit,proto3" json:"limit,omitempty"`                     // the maximum number of hits in the response
	IncludeDocument bool     `protobuf:"varint,4,opt,name=includeDocument,proto3" json:"includeDocument,omitempty"` // if documents should be included in result
	Repository      string   `protobuf:"bytes,5,opt,name=repository,proto3" json:"repository,omitempty"`            // The repository doing the lookup against, defaults to "editorial".
	// contains filtered or unexported fields
}

type ExternalUuidsRes struct {
	IncludedHits int64               `protobuf:"varint,1,opt,name=includedHits,proto3" json:"includedHits,omitempty"` // the number of hits in the response
	TotalHits    int64               `protobuf:"varint,2,opt,name=totalHits,proto3" json:"totalHits,omitempty"`       // the total number of hits
	Hits         []*ExternalUuidsHit `protobuf:"bytes,3,rep,name=hits,proto3" json:"hits,omitempty"`                  // list with the included hits in the response
	// contains filtered or unexported fields
}

type FeatureFlag struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

type Files interface {
	// Method to call at an interval to check status of an ongoing upload
	GetStatus(context.Context, *GetStatusReq) (*GetStatusRes, error)

	// Method returns content (as base64 encoded) from artifact file.
	GetArtifact(context.Context, *GetArtifactReq) (*GetArtifactRes, error)

	// Initiate a new upload.
	CreateUpload(context.Context, *CreateUploadReq) (*CreateUploadRes, error)

	// Initiate a new download
	CreateDownload(context.Context, *CreateDownloadReq) (*CreateDownloadRes, error)

	// Method to call at an interval to check status of downloadable image
	GetDownloadStatus(context.Context, *GetDownloadStatusReq) (*GetDownloadStatusRes, error)

	// Method to view
	CreateView(context.Context, *CreateViewReq) (*CreateViewRes, error)
}

type GetArtifactReq struct {
	UploadId string `protobuf:"bytes,1,opt,name=uploadId,proto3" json:"uploadId,omitempty"` // required The uploadid (Received when an upload is started)
	Name     string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`         // required Name of the file
	// contains filtered or unexported fields
}

type GetArtifactRes struct {
	Content []byte `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"` // Content as a BASE64 encoded string
	// contains filtered or unexported fields
}

type GetDocumentReq struct {
	UUID       string `protobuf:"bytes,1,opt,name=UUID,proto3" json:"UUID,omitempty"` // required Document UUID
	Version    int64  `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	Repository string `protobuf:"bytes,3,opt,name=repository,proto3" json:"repository,omitempty"` // The repository we're reading from, defaults to "editorial".
	// contains filtered or unexported fields
}

type GetDocumentRes struct {
	Document *rpc.Document `protobuf:"bytes,3,opt,name=document,proto3" json:"document,omitempty"` // required
	Revision string        `protobuf:"bytes,4,opt,name=revision,proto3" json:"revision,omitempty"`
	Version  int64         `protobuf:"varint,5,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

type GetDownloadStatusReq struct {
	DownloadId string `protobuf:"bytes,1,opt,name=downloadId,proto3" json:"downloadId,omitempty"` // required ID of the requested download
	// contains filtered or unexported fields
}

type GetDownloadStatusRes struct {
	Status   ProcessingStatus `protobuf:"varint,1,opt,name=status,proto3,enum=cca.ProcessingStatus" json:"status,omitempty"`
	Manifest *Manifest        `protobuf:"bytes,2,opt,name=manifest,proto3" json:"manifest,omitempty"`
	Message  string           `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

type GetNewsMLDocumentRes struct {
	Newsml     string `protobuf:"bytes,3,opt,name=newsml,proto3" json:"newsml,omitempty"` // required
	Revision   string `protobuf:"bytes,4,opt,name=revision,proto3" json:"revision,omitempty"`
	Version    int64  `protobuf:"varint,5,opt,name=version,proto3" json:"version,omitempty"`
	Repository string `protobuf:"bytes,6,opt,name=repository,proto3" json:"repository,omitempty"` // The repository we're reading from, defaults to "editorial".
	// contains filtered or unexported fields
}

type GetStatusReq struct {
	UploadId string `protobuf:"bytes,1,opt,name=uploadId,proto3" json:"uploadId,omitempty"` // required The uploadId (Received when an upload is started)
	// contains filtered or unexported fields
}

type GetStatusRes struct {
	Status   ProcessingStatus `protobuf:"varint,1,opt,name=status,proto3,enum=cca.ProcessingStatus" json:"status,omitempty"` // Current status of upload (See "enums")
	Manifest *Manifest        `protobuf:"bytes,2,opt,name=manifest,proto3" json:"manifest,omitempty"`
	Message  string           `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type LockingMode int32

type LookUp interface {
	GetSameAsUris(context.Context, *SameAsUrisReq) (*SameAsUrisRes, error)

	GetExternalUuids(context.Context, *ExternalUuidsReq) (*ExternalUuidsRes, error)
}

type Manifest struct {
	Uuid           string      `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`
	HashedFilename string      `protobuf:"bytes,2,opt,name=hashedFilename,proto3" json:"hashedFilename,omitempty"`
	Error          string      `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	Uri            string      `protobuf:"bytes,4,opt,name=uri,proto3" json:"uri,omitempty"`
	ContentClass   string      `protobuf:"bytes,5,opt,name=contentClass,proto3" json:"contentClass,omitempty"`
	Artifacts      []*Artifact `protobuf:"bytes,6,rep,name=artifacts,proto3" json:"artifacts,omitempty"`
	Warning        string      `protobuf:"bytes,7,opt,name=warning,proto3" json:"warning,omitempty"`
	Unit           string      `protobuf:"bytes,8,opt,name=unit,proto3" json:"unit,omitempty"`
	Repository     string      `protobuf:"bytes,9,opt,name=repository,proto3" json:"repository,omitempty"`
	// contains filtered or unexported fields
}

type NewsMLDocuments interface {
	WriteNewsMLDocument(context.Context, *WriteNewsMLDocumentReq) (*WriteNewsMLDocumentRes, error)

	DeleteNewsMLDocument(context.Context, *DeleteDocumentReq) (*DeleteDocumentRes, error)

	GetNewsMLDocument(context.Context, *GetDocumentReq) (*GetNewsMLDocumentRes, error)

	NewsMLDocumentExists(context.Context, *DocumentExistsReq) (*DocumentExistsRes, error)
}

type ProcessingStatus int32

type SameAsUrisHit struct {
	Uuid       string        `protobuf:"bytes,1,opt,name=uuid,proto3" json:"uuid,omitempty"`             // uuid of the document
	SameAsURIs []string      `protobuf:"bytes,2,rep,name=sameAsURIs,proto3" json:"sameAsURIs,omitempty"` // list of URI for the SameAs property
	Document   *rpc.Document `protobuf:"bytes,3,opt,name=document,proto3" json:"document,omitempty"`     // full Naviga document
	Error      string        `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`           // if an error occurs fetching the document the error message
	// contains filtered or unexported fields
}

type SameAsUrisReq struct {
	SameAsUris      []string `protobuf:"bytes,1,rep,name=sameAsUris,proto3" json:"sameAsUris,omitempty"`            // list of URIs to lookup documents with SameAsURIs property
	Start           int64    `protobuf:"varint,3,opt,name=start,proto3" json:"start,omitempty"`                     // an offset of the result set
	Limit           int64    `protobuf:"varint,4,opt,name=limit,proto3" json:"limit,omitempty"`                     // the maximum number of hits in the response
	IncludeDocument bool     `protobuf:"varint,5,opt,name=includeDocument,proto3" json:"includeDocument,omitempty"` // if documents should be included in result
	Repository      string   `protobuf:"bytes,6,opt,name=repository,proto3" json:"repository,omitempty"`            // The repository doing the lookup against, defaults to "editorial".
	// contains filtered or unexported fields
}

type SameAsUrisRes struct {
	IncludedHits int64            `protobuf:"varint,1,opt,name=includedHits,proto3" json:"includedHits,omitempty"` // the number of hits in the response
	TotalHits    int64            `protobuf:"varint,2,opt,name=totalHits,proto3" json:"totalHits,omitempty"`       // the total number of hits
	Hits         []*SameAsUrisHit `protobuf:"bytes,3,rep,name=hits,proto3" json:"hits,omitempty"`                  // list with the included hits in the response
	// contains filtered or unexported fields
}

type Tools interface {
	// Method to convert NewsML to Document
	ConvertToDocument(context.Context, *ConvertToDocumentReq) (*ConvertToDocumentRes, error)

	// Convert Document to NewsML
	ConvertToNewsml(context.Context, *ConvertToNewsmlReq) (*ConvertToNewsmlRes, error)

	// Validate NavigaDoc document JSON against JSON schema
	ValidateNavigaDoc(context.Context, *ValidateDocumentReq) (*ValidateDocumentRes, error)
}

type TwirpServer interface {
	http.Handler

	// ServiceDescriptor returns gzipped bytes describing the .proto file that
	// this service was generated from. Once unzipped, the bytes can be
	// unmarshalled as a
	// google.golang.org/protobuf/types/descriptorpb.FileDescriptorProto.
	//
	// The returned integer is the index of this particular service within that
	// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
	// low-level field, expected to be used for reflection.
	ServiceDescriptor() ([]byte, int)

	// ProtocGenTwirpVersion is the semantic version string of the version of
	// twirp used to generate this file.
	ProtocGenTwirpVersion() string

	// PathPrefix returns the HTTP URL path prefix for all methods handled by this
	// service. This can be used with an HTTP mux to route Twirp requests.
	// The path prefix is in the form: "/<prefix>/<package>.<Service>/"
	// that is, everything in a Twirp route except for the <Method> at the end.
	PathPrefix() string
}

type ValidateDocumentReq struct {
	Document *rpc.Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

type ValidateDocumentRes struct {
	SchemaErrors []string `protobuf:"bytes,1,rep,name=schemaErrors,proto3" json:"schemaErrors,omitempty"`
	// contains filtered or unexported fields
}

type WriteDocumentReq struct {
	UploadId         string         `protobuf:"bytes,1,opt,name=uploadId,proto3" json:"uploadId,omitempty"`
	Unit             string         `protobuf:"bytes,2,opt,name=unit,proto3" json:"unit,omitempty"`                                     // required
	Document         *rpc.Document  `protobuf:"bytes,3,opt,name=document,proto3" json:"document,omitempty"`                             // required
	ExpectedRevision string         `protobuf:"bytes,4,opt,name=expectedRevision,proto3" json:"expectedRevision,omitempty"`             // When lockingMode is used expected revision should also be posted
	LockingMode      LockingMode    `protobuf:"varint,5,opt,name=lockingMode,proto3,enum=cca.LockingMode" json:"lockingMode,omitempty"` // Enum to enable certain locking mode when saving documents (See "Enums")
	Features         []*FeatureFlag `protobuf:"bytes,6,rep,name=features,proto3" json:"features,omitempty"`
	Repository       string         `protobuf:"bytes,7,opt,name=repository,proto3" json:"repository,omitempty"` // The repository we're writing to, defaults to "editorial".
	// contains filtered or unexported fields
}

type WriteDocumentRes struct {
	Document *rpc.Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	Revision string        `protobuf:"bytes,2,opt,name=revision,proto3" json:"revision,omitempty"`
	Version  int64         `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

type WriteNewsMLDocumentReq struct {
	UploadId         string         `protobuf:"bytes,1,opt,name=uploadId,proto3" json:"uploadId,omitempty"`
	Unit             string         `protobuf:"bytes,2,opt,name=unit,proto3" json:"unit,omitempty"`     // required
	Newsml           string         `protobuf:"bytes,3,opt,name=newsml,proto3" json:"newsml,omitempty"` // required
	ExpectedRevision string         `protobuf:"bytes,4,opt,name=expectedRevision,proto3" json:"expectedRevision,omitempty"`
	LockingMode      LockingMode    `protobuf:"varint,5,opt,name=lockingMode,proto3,enum=cca.LockingMode" json:"lockingMode,omitempty"`
	Features         []*FeatureFlag `protobuf:"bytes,6,rep,name=features,proto3" json:"features,omitempty"`
	Repository       string         `protobuf:"bytes,7,opt,name=repository,proto3" json:"repository,omitempty"` // The repository we're writing to, defaults to "editorial".
	// contains filtered or unexported fields
}

type WriteNewsMLDocumentRes struct {
	Newsml   string `protobuf:"bytes,1,opt,name=newsml,proto3" json:"newsml,omitempty"`
	Revision string `protobuf:"bytes,2,opt,name=revision,proto3" json:"revision,omitempty"`
	Version  int64  `protobuf:"varint,3,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}