v1

package
v0.0.0-...-fa33765 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 15, 2017 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package v1 is a generated protocol buffer package.

It is generated from these files:

happyco/inspect/inspection/v1/inspection.proto

It has these top-level messages:

CreateDelegatedInspectionLinksRequest
CreateDelegatedInspectionLinkRequest
CreateDelegatedInspectionLinksResponse
CreateDelegatedInspectionLinkResponse
AddInspectionPhotosRequest
AddInspectionPhotoRequest
AddInspectionPhotosResponse
AddInspectionPhotoResponse
Inspection
ScheduledInspection
InspectionData
ListInspectionsRequest
ListInspectionsResponse
CreateInspectionsRequest
CreateInspectionsResponse
UpdateInspectionsRequest
UpdateInspectionsResponse
SetInspectionsArchivedRequest
SetInspectionsArchivedResponse
InspectionStatusChangesEventRequest
InspectionStatusChangesEvent
InspectionStatusChangesEventAck
InspectionStatusChangesEventAckResponse

Index

Constants

This section is empty.

Variables

View Source
var InspectionStatusChangesEvent_InspectionStatusChange_Status_name = map[int32]string{
	0: "SCHEDULED",
	1: "IN_PROGRESS",
	2: "COMPLETED",
}
View Source
var InspectionStatusChangesEvent_InspectionStatusChange_Status_value = map[string]int32{
	"SCHEDULED":   0,
	"IN_PROGRESS": 1,
	"COMPLETED":   2,
}

Functions

func RegisterInspectionEventServiceServer

func RegisterInspectionEventServiceServer(s *grpc.Server, srv InspectionEventServiceServer)

func RegisterInspectionServiceServer

func RegisterInspectionServiceServer(s *grpc.Server, srv InspectionServiceServer)

Types

type AddInspectionPhotoRequest

type AddInspectionPhotoRequest struct {
	FolderId     *happyco_type_v1.IntegrationID `protobuf:"bytes,1,opt,name=folder_id,json=folderId" json:"folder_id,omitempty"`
	InspectionId *happyco_type_v1.IntegrationID `protobuf:"bytes,2,opt,name=inspection_id,json=inspectionId" json:"inspection_id,omitempty"`
	// * File name must include a valid image extension.
	FileName string `protobuf:"bytes,3,opt,name=file_name,json=fileName" json:"file_name,omitempty"`
	// * Data should contain the image data.
	Data []byte `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
}

func (*AddInspectionPhotoRequest) Descriptor

func (*AddInspectionPhotoRequest) Descriptor() ([]byte, []int)

func (*AddInspectionPhotoRequest) GetData

func (m *AddInspectionPhotoRequest) GetData() []byte

func (*AddInspectionPhotoRequest) GetFileName

func (m *AddInspectionPhotoRequest) GetFileName() string

func (*AddInspectionPhotoRequest) GetFolderId

func (*AddInspectionPhotoRequest) GetInspectionId

func (*AddInspectionPhotoRequest) ProtoMessage

func (*AddInspectionPhotoRequest) ProtoMessage()

func (*AddInspectionPhotoRequest) Reset

func (m *AddInspectionPhotoRequest) Reset()

func (*AddInspectionPhotoRequest) String

func (m *AddInspectionPhotoRequest) String() string

type AddInspectionPhotoResponse

type AddInspectionPhotoResponse struct {
	PhotoId *happyco_type_v1.IntegrationID `protobuf:"bytes,1,opt,name=photo_id,json=photoId" json:"photo_id,omitempty"`
	// * Error contains an error response for a request or an empty string.
	Error string `protobuf:"bytes,2,opt,name=error" json:"error,omitempty"`
}

func (*AddInspectionPhotoResponse) Descriptor

func (*AddInspectionPhotoResponse) Descriptor() ([]byte, []int)

func (*AddInspectionPhotoResponse) GetError

func (m *AddInspectionPhotoResponse) GetError() string

func (*AddInspectionPhotoResponse) GetPhotoId

func (*AddInspectionPhotoResponse) ProtoMessage

func (*AddInspectionPhotoResponse) ProtoMessage()

func (*AddInspectionPhotoResponse) Reset

func (m *AddInspectionPhotoResponse) Reset()

func (*AddInspectionPhotoResponse) String

func (m *AddInspectionPhotoResponse) String() string

type AddInspectionPhotosRequest

type AddInspectionPhotosRequest struct {
	// * Account ID that the request applies to.
	AccountId *happyco_type_v1.IntegrationID `protobuf:"bytes,1,opt,name=account_id,json=accountId" json:"account_id,omitempty"`
	// * Requests to be performed. The responses will be an array of the
	// same length and order.
	Requests []*AddInspectionPhotoRequest `protobuf:"bytes,2,rep,name=requests" json:"requests,omitempty"`
}

func (*AddInspectionPhotosRequest) Descriptor

func (*AddInspectionPhotosRequest) Descriptor() ([]byte, []int)

func (*AddInspectionPhotosRequest) GetAccountId

func (*AddInspectionPhotosRequest) GetRequests

func (*AddInspectionPhotosRequest) ProtoMessage

func (*AddInspectionPhotosRequest) ProtoMessage()

func (*AddInspectionPhotosRequest) Reset

func (m *AddInspectionPhotosRequest) Reset()

func (*AddInspectionPhotosRequest) String

func (m *AddInspectionPhotosRequest) String() string

type AddInspectionPhotosResponse

type AddInspectionPhotosResponse struct {
	// * Responses is an array of the same length and order as the requests.
	Responses []*AddInspectionPhotoResponse `protobuf:"bytes,1,rep,name=responses" json:"responses,omitempty"`
}

func (*AddInspectionPhotosResponse) Descriptor

func (*AddInspectionPhotosResponse) Descriptor() ([]byte, []int)

func (*AddInspectionPhotosResponse) GetResponses

func (*AddInspectionPhotosResponse) ProtoMessage

func (*AddInspectionPhotosResponse) ProtoMessage()

func (*AddInspectionPhotosResponse) Reset

func (m *AddInspectionPhotosResponse) Reset()

func (*AddInspectionPhotosResponse) String

func (m *AddInspectionPhotosResponse) String() string

type CreateDelegatedInspectionLinkRequest

type CreateDelegatedInspectionLinkRequest struct {
	Email        string                         `protobuf:"bytes,1,opt,name=email" json:"email,omitempty"`
	FirstName    string                         `protobuf:"bytes,2,opt,name=first_name,json=firstName" json:"first_name,omitempty"`
	LastName     string                         `protobuf:"bytes,3,opt,name=last_name,json=lastName" json:"last_name,omitempty"`
	InspectionId *happyco_type_v1.IntegrationID `protobuf:"bytes,4,opt,name=inspection_id,json=inspectionId" json:"inspection_id,omitempty"`
	Expiry       *happyco_type_v11.DateTime     `protobuf:"bytes,5,opt,name=expiry" json:"expiry,omitempty"`
}

func (*CreateDelegatedInspectionLinkRequest) Descriptor

func (*CreateDelegatedInspectionLinkRequest) Descriptor() ([]byte, []int)

func (*CreateDelegatedInspectionLinkRequest) GetEmail

func (*CreateDelegatedInspectionLinkRequest) GetExpiry

func (*CreateDelegatedInspectionLinkRequest) GetFirstName

func (m *CreateDelegatedInspectionLinkRequest) GetFirstName() string

func (*CreateDelegatedInspectionLinkRequest) GetInspectionId

func (*CreateDelegatedInspectionLinkRequest) GetLastName

func (*CreateDelegatedInspectionLinkRequest) ProtoMessage

func (*CreateDelegatedInspectionLinkRequest) ProtoMessage()

func (*CreateDelegatedInspectionLinkRequest) Reset

func (*CreateDelegatedInspectionLinkRequest) String

type CreateDelegatedInspectionLinkResponse

type CreateDelegatedInspectionLinkResponse struct {
	Link  string `protobuf:"bytes,1,opt,name=link" json:"link,omitempty"`
	Error string `protobuf:"bytes,2,opt,name=error" json:"error,omitempty"`
}

func (*CreateDelegatedInspectionLinkResponse) Descriptor

func (*CreateDelegatedInspectionLinkResponse) Descriptor() ([]byte, []int)

func (*CreateDelegatedInspectionLinkResponse) GetError

func (*CreateDelegatedInspectionLinkResponse) ProtoMessage

func (*CreateDelegatedInspectionLinkResponse) ProtoMessage()

func (*CreateDelegatedInspectionLinkResponse) Reset

func (*CreateDelegatedInspectionLinkResponse) String

type CreateDelegatedInspectionLinksRequest

type CreateDelegatedInspectionLinksRequest struct {
	AccountId            *happyco_type_v1.IntegrationID          `protobuf:"bytes,1,opt,name=account_id,json=accountId" json:"account_id,omitempty"`
	Requests             []*CreateDelegatedInspectionLinkRequest `protobuf:"bytes,2,rep,name=requests" json:"requests,omitempty"`
	SendEmail            bool                                    `protobuf:"varint,3,opt,name=send_email,json=sendEmail" json:"send_email,omitempty"`
	EmailSubjectTemplate string                                  `protobuf:"bytes,4,opt,name=email_subject_template,json=emailSubjectTemplate" json:"email_subject_template,omitempty"`
	EmailTemplateHtml    string                                  `protobuf:"bytes,5,opt,name=email_template_html,json=emailTemplateHtml" json:"email_template_html,omitempty"`
	EmailTemplateText    string                                  `protobuf:"bytes,6,opt,name=email_template_text,json=emailTemplateText" json:"email_template_text,omitempty"`
}

func (*CreateDelegatedInspectionLinksRequest) Descriptor

func (*CreateDelegatedInspectionLinksRequest) Descriptor() ([]byte, []int)

func (*CreateDelegatedInspectionLinksRequest) GetAccountId

func (*CreateDelegatedInspectionLinksRequest) GetEmailSubjectTemplate

func (m *CreateDelegatedInspectionLinksRequest) GetEmailSubjectTemplate() string

func (*CreateDelegatedInspectionLinksRequest) GetEmailTemplateHtml

func (m *CreateDelegatedInspectionLinksRequest) GetEmailTemplateHtml() string

func (*CreateDelegatedInspectionLinksRequest) GetEmailTemplateText

func (m *CreateDelegatedInspectionLinksRequest) GetEmailTemplateText() string

func (*CreateDelegatedInspectionLinksRequest) GetRequests

func (*CreateDelegatedInspectionLinksRequest) GetSendEmail

func (m *CreateDelegatedInspectionLinksRequest) GetSendEmail() bool

func (*CreateDelegatedInspectionLinksRequest) ProtoMessage

func (*CreateDelegatedInspectionLinksRequest) ProtoMessage()

func (*CreateDelegatedInspectionLinksRequest) Reset

func (*CreateDelegatedInspectionLinksRequest) String

type CreateDelegatedInspectionLinksResponse

type CreateDelegatedInspectionLinksResponse struct {
	Responses []*CreateDelegatedInspectionLinkResponse `protobuf:"bytes,1,rep,name=responses" json:"responses,omitempty"`
}

func (*CreateDelegatedInspectionLinksResponse) Descriptor

func (*CreateDelegatedInspectionLinksResponse) Descriptor() ([]byte, []int)

func (*CreateDelegatedInspectionLinksResponse) GetResponses

func (*CreateDelegatedInspectionLinksResponse) ProtoMessage

func (*CreateDelegatedInspectionLinksResponse) Reset

func (*CreateDelegatedInspectionLinksResponse) String

type CreateInspectionsRequest

type CreateInspectionsRequest 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"`
	// * Inspections to be created.
	Inspections []*Inspection `protobuf:"bytes,2,rep,name=inspections" json:"inspections,omitempty"`
}

* Create Inspection request can be used to create new valid scheduled, in progress or completed inspections. Two inspections cannot have the same external ID and all must be valid for the request to complete. This includes archived inspection IDs.

func (*CreateInspectionsRequest) Descriptor

func (*CreateInspectionsRequest) Descriptor() ([]byte, []int)

func (*CreateInspectionsRequest) GetAccountId

func (*CreateInspectionsRequest) GetInspections

func (m *CreateInspectionsRequest) GetInspections() []*Inspection

func (*CreateInspectionsRequest) ProtoMessage

func (*CreateInspectionsRequest) ProtoMessage()

func (*CreateInspectionsRequest) Reset

func (m *CreateInspectionsRequest) Reset()

func (*CreateInspectionsRequest) String

func (m *CreateInspectionsRequest) String() string

type CreateInspectionsResponse

type CreateInspectionsResponse struct {
	InspectionIds []*happyco_type_v1.IntegrationID `protobuf:"bytes,1,rep,name=inspection_ids,json=inspectionIds" json:"inspection_ids,omitempty"`
}

* Create Inspection reposne contains a list of inspection ids (including happyco internal ids) for inspections created with a create inspection request.

func (*CreateInspectionsResponse) Descriptor

func (*CreateInspectionsResponse) Descriptor() ([]byte, []int)

func (*CreateInspectionsResponse) GetInspectionIds

func (m *CreateInspectionsResponse) GetInspectionIds() []*happyco_type_v1.IntegrationID

func (*CreateInspectionsResponse) ProtoMessage

func (*CreateInspectionsResponse) ProtoMessage()

func (*CreateInspectionsResponse) Reset

func (m *CreateInspectionsResponse) Reset()

func (*CreateInspectionsResponse) String

func (m *CreateInspectionsResponse) String() string

type Inspection

type Inspection struct {
	// * ID of inspection.
	Id *happyco_type_v1.IntegrationID `protobuf:"bytes,1,opt,name=id" json:"id,omitempty"`
	// * Account ID that the inspection belongs to.
	AccountId *happyco_type_v1.IntegrationID `protobuf:"bytes,2,opt,name=account_id,json=accountId" json:"account_id,omitempty"`
	FolderId  *happyco_type_v1.IntegrationID `protobuf:"bytes,3,opt,name=folder_id,json=folderId" json:"folder_id,omitempty"`
	// * Asset is 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,4,opt,name=asset_id,json=assetId" json:"asset_id,omitempty"`
	// * Template is the prototype of an inspection thats allow it to be
	// configured on the fly. This field must reference a non archived
	// template in the same folder as the parent asset referenced above.
	TemplateId *happyco_type_v1.IntegrationID `protobuf:"bytes,5,opt,name=template_id,json=templateId" json:"template_id,omitempty"`
	// * Template outline when set on a scheduled inspection forces a
	// different outline prototype to be used when the inspection moves
	// from scheduled to in_progress.
	TemplateOutline string `protobuf:"bytes,6,opt,name=template_outline,json=templateOutline" json:"template_outline,omitempty"`
	// * Status can be be one of scheduled, in_progress and completed.
	// Status message types ScheduleInspection and InspectionData include
	// the data relevant to the status. Transitioning an inspection from
	// in_progress or completed to scheduled will result in the loss of
	// data and therefore raises an error.
	//
	// Types that are valid to be assigned to Status:
	//	*Inspection_Scheduled
	//	*Inspection_InProgress
	//	*Inspection_Completed
	Status     isInspection_Status        `protobuf_oneof:"status"`
	UpdateTime *happyco_type_v11.DateTime `protobuf:"bytes,10,opt,name=update_time,json=updateTime" json:"update_time,omitempty"`
}

* Inspection represents an inspection in its 3 states: scheduled, in_progress and completed.

func (*Inspection) Descriptor

func (*Inspection) Descriptor() ([]byte, []int)

func (*Inspection) GetAccountId

func (m *Inspection) GetAccountId() *happyco_type_v1.IntegrationID

func (*Inspection) GetAssetId

func (m *Inspection) GetAssetId() *happyco_type_v1.IntegrationID

func (*Inspection) GetCompleted

func (m *Inspection) GetCompleted() *InspectionData

func (*Inspection) GetFolderId

func (m *Inspection) GetFolderId() *happyco_type_v1.IntegrationID

func (*Inspection) GetId

func (*Inspection) GetInProgress

func (m *Inspection) GetInProgress() *InspectionData

func (*Inspection) GetScheduled

func (m *Inspection) GetScheduled() *ScheduledInspection

func (*Inspection) GetStatus

func (m *Inspection) GetStatus() isInspection_Status

func (*Inspection) GetTemplateId

func (m *Inspection) GetTemplateId() *happyco_type_v1.IntegrationID

func (*Inspection) GetTemplateOutline

func (m *Inspection) GetTemplateOutline() string

func (*Inspection) GetUpdateTime

func (m *Inspection) GetUpdateTime() *happyco_type_v11.DateTime

func (*Inspection) ProtoMessage

func (*Inspection) ProtoMessage()

func (*Inspection) Reset

func (m *Inspection) Reset()

func (*Inspection) String

func (m *Inspection) String() string

func (*Inspection) XXX_OneofFuncs

func (*Inspection) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type InspectionData

type InspectionData struct {
	// * Started at is a non optional field that is set to the actual time
	// that an inspection transitions from scheduled to in_progress. This
	// time comes from the device where the transition occurs on as the
	// user may be offline.
	StartedAt *happyco_type_v11.DateTime `protobuf:"bytes,1,opt,name=started_at,json=startedAt" json:"started_at,omitempty"`
	// * Ended at is an optional field for in_progress inspections but
	// required for completed inspections. It is set to the actual time
	// that an inspection transtions from in_progress to complete. This
	// time comes from the device where the transition occurs as the suer
	// may be offline.
	EndedAt *happyco_type_v11.DateTime `protobuf:"bytes,2,opt,name=ended_at,json=endedAt" json:"ended_at,omitempty"`
	// * User started at is an optional field that can appear on reports.
	// This can be updated by the user to a specific time. When an
	// inspection transitions from scheduled to in_progress the
	// schedule_date becomes this field.
	UserStartedAt *happyco_type_v11.DateTime `protobuf:"bytes,3,opt,name=user_started_at,json=userStartedAt" json:"user_started_at,omitempty"`
	// * User ended at is an optional field that can appear on reports.
	// This can be updated by the user to a specific time.
	UserEndedAt *happyco_type_v11.DateTime `protobuf:"bytes,4,opt,name=user_ended_at,json=userEndedAt" json:"user_ended_at,omitempty"`
	// * HeaderFields are shown on the top of an inspection and reports
	// generated from it.
	HeaderFields []*happyco_inspect_type_v1.HeaderField `protobuf:"bytes,7,rep,name=header_fields,json=headerFields" json:"header_fields,omitempty"`
	// * Sections and their items hold most of the inspection data; selected
	// ratings, notes, and photos.
	Sections []*happyco_inspect_type_v1.Section `protobuf:"bytes,6,rep,name=sections" json:"sections,omitempty"`
	// * FooterFields are shown at the end of an inspection and reports
	// generated from it.
	FooterFields []*happyco_inspect_type_v1.FooterField `protobuf:"bytes,8,rep,name=footer_fields,json=footerFields" json:"footer_fields,omitempty"`
	// * Rating groups is a map of unique keys within an inspection to
	// rating groups. Each item within this inspection must reference a
	// rating group with a key in this map.
	RatingGroups map[string]*happyco_inspect_type_v1.RatingGroups `` /* 164-byte string literal not displayed */
}

* Inspection data has fields containing all of the inspection data for an inspection with a status of in_progress or completed.

func (*InspectionData) Descriptor

func (*InspectionData) Descriptor() ([]byte, []int)

func (*InspectionData) GetEndedAt

func (m *InspectionData) GetEndedAt() *happyco_type_v11.DateTime

func (*InspectionData) GetFooterFields

func (m *InspectionData) GetFooterFields() []*happyco_inspect_type_v1.FooterField

func (*InspectionData) GetHeaderFields

func (m *InspectionData) GetHeaderFields() []*happyco_inspect_type_v1.HeaderField

func (*InspectionData) GetRatingGroups

func (m *InspectionData) GetRatingGroups() map[string]*happyco_inspect_type_v1.RatingGroups

func (*InspectionData) GetSections

func (m *InspectionData) GetSections() []*happyco_inspect_type_v1.Section

func (*InspectionData) GetStartedAt

func (m *InspectionData) GetStartedAt() *happyco_type_v11.DateTime

func (*InspectionData) GetUserEndedAt

func (m *InspectionData) GetUserEndedAt() *happyco_type_v11.DateTime

func (*InspectionData) GetUserStartedAt

func (m *InspectionData) GetUserStartedAt() *happyco_type_v11.DateTime

func (*InspectionData) ProtoMessage

func (*InspectionData) ProtoMessage()

func (*InspectionData) Reset

func (m *InspectionData) Reset()

func (*InspectionData) String

func (m *InspectionData) String() string

type InspectionEventServiceClient

type InspectionEventServiceClient interface {
	// * On inspection status changes returns a stream that will be pushed
	// events as they occur
	OnInspectionStatusChanges(ctx context.Context, in *InspectionStatusChangesEventRequest, opts ...grpc.CallOption) (InspectionEventService_OnInspectionStatusChangesClient, error)
	// * On inspection status changes ack should be called when events have
	// been processed. Unless this is called events will be sent again
	// after the timeout period.
	OnInspectionStatusChangesAck(ctx context.Context, in *InspectionStatusChangesEventAck, opts ...grpc.CallOption) (*InspectionStatusChangesEventAckResponse, error)
}

func NewInspectionEventServiceClient

func NewInspectionEventServiceClient(cc *grpc.ClientConn) InspectionEventServiceClient

type InspectionEventServiceServer

type InspectionEventServiceServer interface {
	// * On inspection status changes returns a stream that will be pushed
	// events as they occur
	OnInspectionStatusChanges(*InspectionStatusChangesEventRequest, InspectionEventService_OnInspectionStatusChangesServer) error
	// * On inspection status changes ack should be called when events have
	// been processed. Unless this is called events will be sent again
	// after the timeout period.
	OnInspectionStatusChangesAck(context.Context, *InspectionStatusChangesEventAck) (*InspectionStatusChangesEventAckResponse, error)
}

type InspectionEventService_OnInspectionStatusChangesClient

type InspectionEventService_OnInspectionStatusChangesClient interface {
	Recv() (*InspectionStatusChangesEvent, error)
	grpc.ClientStream
}

type InspectionEventService_OnInspectionStatusChangesServer

type InspectionEventService_OnInspectionStatusChangesServer interface {
	Send(*InspectionStatusChangesEvent) error
	grpc.ServerStream
}

type InspectionServiceClient

type InspectionServiceClient interface {
	// * List inspections gets a paginated and optionally filtered list of
	// inspections from one or more folders.
	ListInspections(ctx context.Context, in *ListInspectionsRequest, opts ...grpc.CallOption) (*ListInspectionsResponse, error)
	// * Create inspections can create inspections with any status (normally
	// scheduled).
	CreateInspections(ctx context.Context, in *CreateInspectionsRequest, opts ...grpc.CallOption) (*CreateInspectionsResponse, error)
	// * Update inspections can change the contents of inspections.
	// Currently an inspection cannot have its asset_id or template_id
	// updated.
	UpdateInspections(ctx context.Context, in *UpdateInspectionsRequest, opts ...grpc.CallOption) (*UpdateInspectionsResponse, error)
	// * Archive inspections should be used to delete inspections that are no
	// longer wanted. No method for purging archived inspections is
	// available via the API.
	ArchiveInspections(ctx context.Context, in *SetInspectionsArchivedRequest, opts ...grpc.CallOption) (*SetInspectionsArchivedResponse, error)
	// * Unarchive inspections should be used if previously archived
	// inspections need to be restored.
	UnarchiveInspections(ctx context.Context, in *SetInspectionsArchivedRequest, opts ...grpc.CallOption) (*SetInspectionsArchivedResponse, error)
	// * Adds photos to inspections. The returned photo IDs must be inserted
	// into the inspection for them to be displayed. This inspection does
	// not occur in a transaction and you will receive a response for each
	// photo.
	AddInspectionPhotos(ctx context.Context, in *AddInspectionPhotosRequest, opts ...grpc.CallOption) (*AddInspectionPhotosResponse, error)
	CreateDelegatedInspectionLinks(ctx context.Context, in *CreateDelegatedInspectionLinksRequest, opts ...grpc.CallOption) (*CreateDelegatedInspectionLinksResponse, error)
}

func NewInspectionServiceClient

func NewInspectionServiceClient(cc *grpc.ClientConn) InspectionServiceClient

type InspectionServiceServer

type InspectionServiceServer interface {
	// * List inspections gets a paginated and optionally filtered list of
	// inspections from one or more folders.
	ListInspections(context.Context, *ListInspectionsRequest) (*ListInspectionsResponse, error)
	// * Create inspections can create inspections with any status (normally
	// scheduled).
	CreateInspections(context.Context, *CreateInspectionsRequest) (*CreateInspectionsResponse, error)
	// * Update inspections can change the contents of inspections.
	// Currently an inspection cannot have its asset_id or template_id
	// updated.
	UpdateInspections(context.Context, *UpdateInspectionsRequest) (*UpdateInspectionsResponse, error)
	// * Archive inspections should be used to delete inspections that are no
	// longer wanted. No method for purging archived inspections is
	// available via the API.
	ArchiveInspections(context.Context, *SetInspectionsArchivedRequest) (*SetInspectionsArchivedResponse, error)
	// * Unarchive inspections should be used if previously archived
	// inspections need to be restored.
	UnarchiveInspections(context.Context, *SetInspectionsArchivedRequest) (*SetInspectionsArchivedResponse, error)
	// * Adds photos to inspections. The returned photo IDs must be inserted
	// into the inspection for them to be displayed. This inspection does
	// not occur in a transaction and you will receive a response for each
	// photo.
	AddInspectionPhotos(context.Context, *AddInspectionPhotosRequest) (*AddInspectionPhotosResponse, error)
	CreateDelegatedInspectionLinks(context.Context, *CreateDelegatedInspectionLinksRequest) (*CreateDelegatedInspectionLinksResponse, error)
}

type InspectionStatusChangesEvent

type InspectionStatusChangesEvent struct {
	Event   *happyco_type_v13.Event                                `protobuf:"bytes,1,opt,name=event" json:"event,omitempty"`
	Changes []*InspectionStatusChangesEvent_InspectionStatusChange `protobuf:"bytes,2,rep,name=changes" json:"changes,omitempty"`
}

* Inspection status change events are emitted from streams requested with OnInspectionStatusChanges.

func (*InspectionStatusChangesEvent) Descriptor

func (*InspectionStatusChangesEvent) Descriptor() ([]byte, []int)

func (*InspectionStatusChangesEvent) GetChanges

func (*InspectionStatusChangesEvent) GetEvent

func (*InspectionStatusChangesEvent) ProtoMessage

func (*InspectionStatusChangesEvent) ProtoMessage()

func (*InspectionStatusChangesEvent) Reset

func (m *InspectionStatusChangesEvent) Reset()

func (*InspectionStatusChangesEvent) String

type InspectionStatusChangesEventAck

type InspectionStatusChangesEventAck struct {
	// * See EventAck for more details.
	Ack *happyco_type_v13.EventAck `protobuf:"bytes,1,opt,name=ack" json:"ack,omitempty"`
}

* Inspection status changes event ack is used to acknowledge or request time extensions for one or more events.

func (*InspectionStatusChangesEventAck) Descriptor

func (*InspectionStatusChangesEventAck) Descriptor() ([]byte, []int)

func (*InspectionStatusChangesEventAck) GetAck

func (*InspectionStatusChangesEventAck) ProtoMessage

func (*InspectionStatusChangesEventAck) ProtoMessage()

func (*InspectionStatusChangesEventAck) Reset

func (*InspectionStatusChangesEventAck) String

type InspectionStatusChangesEventAckResponse

type InspectionStatusChangesEventAckResponse struct {
}

* InspectionStatusChangeEventAckResponse contains no data but indicates successful acknowledgement.

func (*InspectionStatusChangesEventAckResponse) Descriptor

func (*InspectionStatusChangesEventAckResponse) Descriptor() ([]byte, []int)

func (*InspectionStatusChangesEventAckResponse) ProtoMessage

func (*InspectionStatusChangesEventAckResponse) Reset

func (*InspectionStatusChangesEventAckResponse) String

type InspectionStatusChangesEventRequest

type InspectionStatusChangesEventRequest 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"`
}

func (*InspectionStatusChangesEventRequest) Descriptor

func (*InspectionStatusChangesEventRequest) Descriptor() ([]byte, []int)

func (*InspectionStatusChangesEventRequest) GetAccountId

func (*InspectionStatusChangesEventRequest) GetOptions

func (*InspectionStatusChangesEventRequest) ProtoMessage

func (*InspectionStatusChangesEventRequest) ProtoMessage()

func (*InspectionStatusChangesEventRequest) Reset

func (*InspectionStatusChangesEventRequest) String

type InspectionStatusChangesEvent_InspectionStatusChange

type InspectionStatusChangesEvent_InspectionStatusChange struct {
	// * Inspection ID can be used to fetch the inspection with a
	// filtered list inspections request
	InspectionId *happyco_type_v1.IntegrationID `protobuf:"bytes,1,opt,name=inspection_id,json=inspectionId" json:"inspection_id,omitempty"`
	// * From status is the status prior to the change event.
	FromStatus InspectionStatusChangesEvent_InspectionStatusChange_Status `` /* 179-byte string literal not displayed */
	// * To status is the status post the change event.
	ToStatus InspectionStatusChangesEvent_InspectionStatusChange_Status `` /* 173-byte string literal not displayed */
}

func (*InspectionStatusChangesEvent_InspectionStatusChange) Descriptor

func (*InspectionStatusChangesEvent_InspectionStatusChange) GetFromStatus

func (*InspectionStatusChangesEvent_InspectionStatusChange) GetInspectionId

func (*InspectionStatusChangesEvent_InspectionStatusChange) GetToStatus

func (*InspectionStatusChangesEvent_InspectionStatusChange) ProtoMessage

func (*InspectionStatusChangesEvent_InspectionStatusChange) Reset

func (*InspectionStatusChangesEvent_InspectionStatusChange) String

type InspectionStatusChangesEvent_InspectionStatusChange_Status

type InspectionStatusChangesEvent_InspectionStatusChange_Status int32
const (
	InspectionStatusChangesEvent_InspectionStatusChange_SCHEDULED   InspectionStatusChangesEvent_InspectionStatusChange_Status = 0
	InspectionStatusChangesEvent_InspectionStatusChange_IN_PROGRESS InspectionStatusChangesEvent_InspectionStatusChange_Status = 1
	InspectionStatusChangesEvent_InspectionStatusChange_COMPLETED   InspectionStatusChangesEvent_InspectionStatusChange_Status = 2
)

func (InspectionStatusChangesEvent_InspectionStatusChange_Status) EnumDescriptor

func (InspectionStatusChangesEvent_InspectionStatusChange_Status) String

type Inspection_Completed

type Inspection_Completed struct {
	Completed *InspectionData `protobuf:"bytes,9,opt,name=completed,oneof"`
}

type Inspection_InProgress

type Inspection_InProgress struct {
	InProgress *InspectionData `protobuf:"bytes,8,opt,name=in_progress,json=inProgress,oneof"`
}

type Inspection_Scheduled

type Inspection_Scheduled struct {
	Scheduled *ScheduledInspection `protobuf:"bytes,7,opt,name=scheduled,oneof"`
}

type ListInspectionsRequest

type ListInspectionsRequest 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 inspections 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 inspections only for
	// specific assets.
	AssetIds []*happyco_type_v1.IntegrationID `protobuf:"bytes,3,rep,name=asset_ids,json=assetIds" json:"asset_ids,omitempty"`
	// * Inspection IDs  is an optional filter that lists only specific
	// inspections. This is commonly used to get a single inspection.
	InspectionIds []*happyco_type_v1.IntegrationID `protobuf:"bytes,4,rep,name=inspection_ids,json=inspectionIds" json:"inspection_ids,omitempty"`
	// * Archived when set to true returns archived inspections only.
	Archived bool `protobuf:"varint,5,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,6,opt,name=paging" json:"paging,omitempty"`
	MinUpdateTime *happyco_type_v11.DateTime `protobuf:"bytes,7,opt,name=min_update_time,json=minUpdateTime" json:"min_update_time,omitempty"`
	MaxUpdateTime *happyco_type_v11.DateTime `protobuf:"bytes,8,opt,name=max_update_time,json=maxUpdateTime" json:"max_update_time,omitempty"`
}

* List inspection request is used for fetching inspections. It can be filtered to specific inspections, assets or folders. If the intent is to be notified when an inspection undergoes a status transition please use the InspectionEventService.

func (*ListInspectionsRequest) Descriptor

func (*ListInspectionsRequest) Descriptor() ([]byte, []int)

func (*ListInspectionsRequest) GetAccountId

func (*ListInspectionsRequest) GetArchived

func (m *ListInspectionsRequest) GetArchived() bool

func (*ListInspectionsRequest) GetAssetIds

func (*ListInspectionsRequest) GetFolderIds

func (*ListInspectionsRequest) GetInspectionIds

func (m *ListInspectionsRequest) GetInspectionIds() []*happyco_type_v1.IntegrationID

func (*ListInspectionsRequest) GetMaxUpdateTime

func (m *ListInspectionsRequest) GetMaxUpdateTime() *happyco_type_v11.DateTime

func (*ListInspectionsRequest) GetMinUpdateTime

func (m *ListInspectionsRequest) GetMinUpdateTime() *happyco_type_v11.DateTime

func (*ListInspectionsRequest) GetPaging

func (*ListInspectionsRequest) ProtoMessage

func (*ListInspectionsRequest) ProtoMessage()

func (*ListInspectionsRequest) Reset

func (m *ListInspectionsRequest) Reset()

func (*ListInspectionsRequest) String

func (m *ListInspectionsRequest) String() string

type ListInspectionsResponse

type ListInspectionsResponse struct {
	// * Inspections contains the results for this page.
	Inspections []*Inspection `protobuf:"bytes,1,rep,name=inspections" json:"inspections,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"`
}

* List inspection response is a page of fetched inspection results. It includes a previous and next page token that can be passed into subsequent list inspection requests.

func (*ListInspectionsResponse) Descriptor

func (*ListInspectionsResponse) Descriptor() ([]byte, []int)

func (*ListInspectionsResponse) GetInspections

func (m *ListInspectionsResponse) GetInspections() []*Inspection

func (*ListInspectionsResponse) GetNextPage

func (*ListInspectionsResponse) GetPreviousPage

func (m *ListInspectionsResponse) GetPreviousPage() *happyco_type_v12.Paging

func (*ListInspectionsResponse) ProtoMessage

func (*ListInspectionsResponse) ProtoMessage()

func (*ListInspectionsResponse) Reset

func (m *ListInspectionsResponse) Reset()

func (*ListInspectionsResponse) String

func (m *ListInspectionsResponse) String() string

type ScheduledInspection

type ScheduledInspection struct {
	// * Schedule date is an optional field that contians the expected start
	// time or due date of the inspection.
	ScheduleDate *happyco_type_v11.DateTime `protobuf:"bytes,1,opt,name=schedule_date,json=scheduleDate" json:"schedule_date,omitempty"`
	// * Header notes is an optional override that will be used instead of
	// the header fields defined by the template.
	HeaderFields []*happyco_inspect_type_v1.HeaderField `protobuf:"bytes,2,rep,name=header_fields,json=headerFields" json:"header_fields,omitempty"`
	// * Footer notes is an optional override that will be used instead of
	// the footer fields defined by the template.
	FooterFields []*happyco_inspect_type_v1.FooterField `protobuf:"bytes,3,rep,name=footer_fields,json=footerFields" json:"footer_fields,omitempty"`
	Sections     []*happyco_inspect_type_v1.Section     `protobuf:"bytes,4,rep,name=sections" json:"sections,omitempty"`
}

* Scheduled inspection is the message type for inspection status scheduled. It can include a specific scheduled date for the inspection and overrides for header and footer fields when the inspection status transitions to in_progress.

func (*ScheduledInspection) Descriptor

func (*ScheduledInspection) Descriptor() ([]byte, []int)

func (*ScheduledInspection) GetFooterFields

func (*ScheduledInspection) GetHeaderFields

func (*ScheduledInspection) GetScheduleDate

func (m *ScheduledInspection) GetScheduleDate() *happyco_type_v11.DateTime

func (*ScheduledInspection) GetSections

func (*ScheduledInspection) ProtoMessage

func (*ScheduledInspection) ProtoMessage()

func (*ScheduledInspection) Reset

func (m *ScheduledInspection) Reset()

func (*ScheduledInspection) String

func (m *ScheduledInspection) String() string

type SetInspectionsArchivedRequest

type SetInspectionsArchivedRequest 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"`
	// * Inspection IDs that should be updated.
	InspectionIds []*happyco_type_v1.IntegrationID `protobuf:"bytes,3,rep,name=inspection_ids,json=inspectionIds" json:"inspection_ids,omitempty"`
}

* SetInspectionsArchivedRequest is used to archive and unarchive multiple inspections.

func (*SetInspectionsArchivedRequest) Descriptor

func (*SetInspectionsArchivedRequest) Descriptor() ([]byte, []int)

func (*SetInspectionsArchivedRequest) GetAccountId

func (*SetInspectionsArchivedRequest) GetInspectionIds

func (*SetInspectionsArchivedRequest) ProtoMessage

func (*SetInspectionsArchivedRequest) ProtoMessage()

func (*SetInspectionsArchivedRequest) Reset

func (m *SetInspectionsArchivedRequest) Reset()

func (*SetInspectionsArchivedRequest) String

type SetInspectionsArchivedResponse

type SetInspectionsArchivedResponse struct {
}

* SetInspectionsArchivedResponse contains no data and indicates success of the operation.

func (*SetInspectionsArchivedResponse) Descriptor

func (*SetInspectionsArchivedResponse) Descriptor() ([]byte, []int)

func (*SetInspectionsArchivedResponse) ProtoMessage

func (*SetInspectionsArchivedResponse) ProtoMessage()

func (*SetInspectionsArchivedResponse) Reset

func (m *SetInspectionsArchivedResponse) Reset()

func (*SetInspectionsArchivedResponse) String

type UpdateInspectionsRequest

type UpdateInspectionsRequest 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"`
	// * Inspection to be updated.
	Inspections []*Inspection `protobuf:"bytes,2,rep,name=inspections" json:"inspections,omitempty"`
}

* Create Inspection request can be used to update existing valid scheduled, in progress completed, and archived inspections. Two inspections cannot have the same external ID and all must be valid for the request to complete. This includes archived inspection IDs. An update cannot cause an inspection to transition from in_progress to scheduled.

func (*UpdateInspectionsRequest) Descriptor

func (*UpdateInspectionsRequest) Descriptor() ([]byte, []int)

func (*UpdateInspectionsRequest) GetAccountId

func (*UpdateInspectionsRequest) GetInspections

func (m *UpdateInspectionsRequest) GetInspections() []*Inspection

func (*UpdateInspectionsRequest) ProtoMessage

func (*UpdateInspectionsRequest) ProtoMessage()

func (*UpdateInspectionsRequest) Reset

func (m *UpdateInspectionsRequest) Reset()

func (*UpdateInspectionsRequest) String

func (m *UpdateInspectionsRequest) String() string

type UpdateInspectionsResponse

type UpdateInspectionsResponse struct {
}

* Update inspection response contains no data and indicates success of all updates.

func (*UpdateInspectionsResponse) Descriptor

func (*UpdateInspectionsResponse) Descriptor() ([]byte, []int)

func (*UpdateInspectionsResponse) ProtoMessage

func (*UpdateInspectionsResponse) ProtoMessage()

func (*UpdateInspectionsResponse) Reset

func (m *UpdateInspectionsResponse) Reset()

func (*UpdateInspectionsResponse) String

func (m *UpdateInspectionsResponse) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL