v1

type ListReportsRequest struct {
	// * Account ID that the request applies to. For custom integrations
	// (i.e. not integration partners) it can be omitted.
	AccountId *happyco_type_v1.IntegrationID `protobuf:"bytes,1,opt,name=account_id,json=accountId" json:"account_id,omitempty"`
	// * Folder IDs is an optional filter that lists reports only for
	// specific folders.
	FolderIds []*happyco_type_v1.IntegrationID `protobuf:"bytes,2,rep,name=folder_ids,json=folderIds" json:"folder_ids,omitempty"`
	// * Asset IDs is an optional filter that lists reports only for
	// specific assets.
	AssetIds []*happyco_type_v1.IntegrationID `protobuf:"bytes,3,rep,name=asset_ids,json=assetIds" json:"asset_ids,omitempty"`
	// * Inspections IDs is an optional filter that lists reports only for
	// specific inspections.
	InspectionIds []*happyco_type_v1.IntegrationID `protobuf:"bytes,4,rep,name=inspection_ids,json=inspectionIds" json:"inspection_ids,omitempty"`
	// * Report IDs is an optional filter that lists reports only for
	// specific reports.
	ReportIds []*happyco_type_v1.IntegrationID `protobuf:"bytes,5,rep,name=report_ids,json=reportIds" json:"report_ids,omitempty"`
	// * Archived when set to true returns archived reports only.
	Archived bool `protobuf:"varint,6,opt,name=archived" json:"archived,omitempty"`
	// * Paging message that contains information about the page being
	// requested. This message is usually copied from a previous list
	// request's response.
	Paging *happyco_type_v12.Paging `protobuf:"bytes,7,opt,name=paging" json:"paging,omitempty"`
}

type ListReportsResponse struct {
	// * Reports contains the results for this page.
	Reports []*Report `protobuf:"bytes,1,rep,name=reports" json:"reports,omitempty"`
	// * Previous page is an token that will be present for all pages after
	// the first.
	PreviousPage *happyco_type_v12.Paging `protobuf:"bytes,2,opt,name=previous_page,json=previousPage" json:"previous_page,omitempty"`
	// * Next page is an token that will be present for all pages except the
	// last.
	NextPage *happyco_type_v12.Paging `protobuf:"bytes,3,opt,name=next_page,json=nextPage" json:"next_page,omitempty"`
}

type Report struct {
	// * ID of report.
	Id *happyco_type_v1.IntegrationID `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// * Public URL can be used to share the inspection. It contains a UUID
	// to provide security.
	PublicUrl string `protobuf:"bytes,2,opt,name=public_url,json=publicUrl" json:"public_url,omitempty"`
	// * Name of the asset that was inspected. This is typically the address
	// of the unit or house that was inspected.
	Name string `protobuf:"bytes,3,opt,name=name" json:"name,omitempty"`
	// * Title of the report. This can be overriden by the user in the
	// report settings but typically comes from the template name used to
	// perform the inspection.
	Title string `protobuf:"bytes,4,opt,name=title" json:"title,omitempty"`
	// * The revision of the report. This will increment when a change
	// occurs. Reports are limited to changes being archive/unarchive
	// operations or new signatures being added.
	Revision int32 `protobuf:"varint,5,opt,name=revision" json:"revision,omitempty"`
	// * Account ID that the report belongs to. For custom integrations
	// (i.e. not integration partners) it may be omitted.
	AccountId *happyco_type_v1.IntegrationID `protobuf:"bytes,6,opt,name=account_id,json=accountId" json:"account_id,omitempty"`
	// * TODO: TBD if we should keep this -- inspection does not have it
	FolderId *happyco_type_v1.IntegrationID `protobuf:"bytes,7,opt,name=folder_id,json=folderId" json:"folder_id,omitempty"`
	// * Asset ID references the parent that inspection is attached to. This field must
	// reference a non archived asset in the same folder as the template
	// referenced below.
	AssetId *happyco_type_v1.IntegrationID `protobuf:"bytes,8,opt,name=asset_id,json=assetId" json:"asset_id,omitempty"`
	// * Inspection IDs references one or more inspection(s) used to
	// generate the report.
	InspectionIds []*happyco_type_v1.IntegrationID `protobuf:"bytes,9,rep,name=inspection_ids,json=inspectionIds" json:"inspection_ids,omitempty"`
	// * Generated at is the time (as reported by the mobile device) that the
	// report was generated at.
	GeneratedAt *happyco_type_v11.Date `protobuf:"bytes,10,opt,name=generated_at,json=generatedAt" json:"generated_at,omitempty"`
	// * Finalized is the time (as reported by the mobile device) that the
	// report was locked. Until the report is locked the display settings
	// can be changed. Signing a report locks it immediately.
	FinalizedAt *happyco_type_v11.Date `protobuf:"bytes,11,opt,name=finalized_at,json=finalizedAt" json:"finalized_at,omitempty"`
	// * TODO: Inspector ID references the user who created the report. TBD
	// whether to include this (where is it coming from)
	InspectorId *happyco_type_v1.IntegrationID `protobuf:"bytes,12,opt,name=inspector_id,json=inspectorId" json:"inspector_id,omitempty"`
	// * Inspector name taken from on the most recently complete inspection.
	InspectorName string `protobuf:"bytes,13,opt,name=inspector_name,json=inspectorName" json:"inspector_name,omitempty"`
	// * All of the report data (this structure is still subject to change
	// so at the moment this is just a json blob)
	Data string `protobuf:"bytes,14,opt,name=data" json:"data,omitempty"`
	// * A map of signatories added to the report. Each key in the map only
	// needs to be unique to this report.
	Signatories map[string]*Signatory `` /* 143-byte string literal not displayed */
}

type ReportEventServiceClient interface {
	// * On reports created returns a stream that will be pushed events as
	// they occur
	OnReportsCreated(ctx context.Context, in *ReportsCreatedEventRequest, opts ...grpc.CallOption) (ReportEventService_OnReportsCreatedClient, error)
	// * On reports created ack should be called when events have
	// been processed. Unless this is called events will be sent again
	// after the timeout period.
	OnReportsCreatedAck(ctx context.Context, in *ReportsCreatedEventAck, opts ...grpc.CallOption) (*ReportsCreatedEventAckResponse, error)
}

type ReportEventServiceServer interface {
	// * On reports created returns a stream that will be pushed events as
	// they occur
	OnReportsCreated(*ReportsCreatedEventRequest, ReportEventService_OnReportsCreatedServer) error
	// * On reports created ack should be called when events have
	// been processed. Unless this is called events will be sent again
	// after the timeout period.
	OnReportsCreatedAck(context.Context, *ReportsCreatedEventAck) (*ReportsCreatedEventAckResponse, error)
}

type ReportEventService_OnReportsCreatedClient interface {
	Recv() (*ReportsCreatedEvent, error)
	grpc.ClientStream
}

type ReportEventService_OnReportsCreatedServer interface {
	Send(*ReportsCreatedEvent) error
	grpc.ServerStream
}

type ReportServiceClient interface {
	// * List reports gets a paginated and optionally filtered list of
	// reports from one or more folders.
	ListReports(ctx context.Context, in *ListReportsRequest, opts ...grpc.CallOption) (*ListReportsResponse, error)
}

type ReportServiceServer interface {
	// * List reports gets a paginated and optionally filtered list of
	// reports from one or more folders.
	ListReports(context.Context, *ListReportsRequest) (*ListReportsResponse, error)
}

type ReportsCreatedEvent struct {
	Event   *happyco_type_v13.Event              `protobuf:"bytes,1,opt,name=event" json:"event,omitempty"`
	Reports []*ReportsCreatedEvent_ReportCreated `protobuf:"bytes,2,rep,name=reports" json:"reports,omitempty"`
}

type ReportsCreatedEventAck struct {
	Ack *happyco_type_v13.EventAck `protobuf:"bytes,1,opt,name=ack" json:"ack,omitempty"`
}

type ReportsCreatedEventAckResponse struct {
}

type ReportsCreatedEventRequest struct {
	// * Account ID that the request applies to. For custom integrations
	// (i.e. not integration partners) it can be omitted.
	AccountId *happyco_type_v1.IntegrationID `protobuf:"bytes,1,opt,name=account_id,json=accountId" json:"account_id,omitempty"`
	// * Options the client can set to configure the returned event stream.
	// See EventHandlerOptions for more details.
	Options *happyco_type_v13.EventHandlerOptions `protobuf:"bytes,2,opt,name=options" json:"options,omitempty"`
}

type ReportsCreatedEvent_ReportCreated struct {
	// * Report ID can be used to fetch the report with a filtered
	// list reports request
	ReportId *happyco_type_v1.IntegrationID `protobuf:"bytes,1,opt,name=report_id,json=reportId" json:"report_id,omitempty"`
	// * TODO: should we remove this? I feel like is only useful if we have an updated event stream too
	Version int32 `protobuf:"varint,2,opt,name=version" json:"version,omitempty"`
}

type Signatory struct {
	// * Name of the signatory. e.g. Mafalda Hopkirk.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// * TODO: should this be included? Its not included in the report.
	Role string `protobuf:"bytes,2,opt,name=role" json:"role,omitempty"`
	// * Generated is the time when the signatory box was generated and
	// attached to the report.
	GeneratedAt *happyco_type_v11.Date `protobuf:"bytes,3,opt,name=generated_at,json=generatedAt" json:"generated_at,omitempty"`
	// * Signed at is the time (as reported by the mobile device) that the
	// user physically signed the report.
	SignedAt *happyco_type_v11.Date `protobuf:"bytes,4,opt,name=signed_at,json=signedAt" json:"signed_at,omitempty"`
	// * User signed at is a user adjustable signed at time (similar to the
	// date field often found on paper reports).
	UserSignedAt *happyco_type_v11.Date `protobuf:"bytes,5,opt,name=user_signed_at,json=userSignedAt" json:"user_signed_at,omitempty"`
}