reports

package
v6.7.0 Latest Latest
Warning

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

 Go to latest Published: Mar 4, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	NoOrderId    string = "NO_ORDER_ID"
	NoSection    string = "NO_SECTION"
	Available    string = "available"
	NoChannel    string = "NO_CHANNEL"
	NoCategory   string = "NO_CATEGORY"
	NotAvailable string = "not_available"
	NotForSale   string = "not_for_sale"
	Free         string = "free"
	Booked       string = "booked"
	Held         string = "reservedByToken"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ChartReport 

type ChartReport struct {
	Items map[string][]ChartReportItem
}

type ChartReportItem 

type ChartReportItem struct {
	Label                string        `json:"label,omitempty"`
	Labels               events.Labels `json:"labels,omitempty"`
	IDs                  events.IDs    `json:"ids,omitempty"`
	CategoryLabel        string        `json:"categoryLabel,omitempty"`
	CategoryKey          string        `json:"categoryKey,omitempty"`
	Section              string        `json:"section,omitempty"`
	Entrance             string        `json:"entrance,omitempty"`
	Capacity             int           `json:"capacity,omitempty"`
	ObjectType           string        `json:"objectType,omitempty"`
	LeftNeighbour        string        `json:"leftNeighbour,omitempty"`
	RightNeighbour       string        `json:"rightNeighbour,omitempty"`
	DistanceToFocalPoint float64       `json:"distanceToFocalPoint,omitempty"`
	BookAsAWhole         bool          `json:"bookAsAWhole,omitempty"`
	NumSeats             int           `json:"numSeats,omitempty"`
	IsAccessible         bool          `json:"isAccessible,omitempty"`
	IsCompanionSeat      bool          `json:"isCompanionSeat,omitempty"`
	HasRestrictedView    bool          `json:"hasRestrictedView,omitempty"`
}

type ChartReportOptionsNS 

type ChartReportOptionsNS struct{}
var ChartReportOptions ChartReportOptionsNS

func (ChartReportOptionsNS) BookWholeTablesChart 

func (ChartReportOptionsNS) BookWholeTablesChart() chartReportOptionsOption

func (ChartReportOptionsNS) BookWholeTablesFalse 

func (ChartReportOptionsNS) BookWholeTablesFalse() chartReportOptionsOption

func (ChartReportOptionsNS) BookWholeTablesTrue 

func (ChartReportOptionsNS) BookWholeTablesTrue() chartReportOptionsOption

func (ChartReportOptionsNS) UseDraftVersion 

func (ChartReportOptionsNS) UseDraftVersion() chartReportOptionsOption

type ChartReports 

type ChartReports struct {
	Client *req.Client
}

func (*ChartReports) ByCategoryKey 

func (reports *ChartReports) ByCategoryKey(chartKey string, chartReportOptions ...chartReportOptionsOption) (*ChartReport, error)

func (*ChartReports) ByCategoryLabel 

func (reports *ChartReports) ByCategoryLabel(chartKey string, chartReportOptions ...chartReportOptionsOption) (*ChartReport, error)

func (*ChartReports) ByLabel 

func (reports *ChartReports) ByLabel(chartKey string, chartReportOptions ...chartReportOptionsOption) (*ChartReport, error)

func (*ChartReports) ByObjectType 

func (reports *ChartReports) ByObjectType(chartKey string, chartReportOptions ...chartReportOptionsOption) (*ChartReport, error)

func (*ChartReports) BySection 

func (reports *ChartReports) BySection(chartKey string, chartReportOptions ...chartReportOptionsOption) (*ChartReport, error)

func (*ChartReports) SummaryByCategoryKey 

func (reports *ChartReports) SummaryByCategoryKey(chartKey string, chartReportOptions ...chartReportOptionsOption) (*ChartSummaryReport, error)

func (*ChartReports) SummaryByCategoryLabel 

func (reports *ChartReports) SummaryByCategoryLabel(chartKey string, chartReportOptions ...chartReportOptionsOption) (*ChartSummaryReport, error)

func (*ChartReports) SummaryByObjectType 

func (reports *ChartReports) SummaryByObjectType(chartKey string, chartReportOptions ...chartReportOptionsOption) (*ChartSummaryReport, error)

func (*ChartReports) SummaryBySection 

func (reports *ChartReports) SummaryBySection(chartKey string, chartReportOptions ...chartReportOptionsOption) (*ChartSummaryReport, error)

type ChartSummaryReport 

type ChartSummaryReport struct {
	Items map[string]ChartSummaryReportItem
}

type ChartSummaryReportItem 

type ChartSummaryReportItem struct {
	Count           int                    `json:"count,omitempty"`
	BySection       map[string]interface{} `json:"bySection,omitempty"`
	ByCategoryKey   map[string]interface{} `json:"byCategoryKey,omitempty"`
	ByCategoryLabel map[string]interface{} `json:"byCategoryLabel,omitempty"`
	ByObjectType    map[string]interface{} `json:"byObjectType,omitempty"`
}

type DetailedEventReport 

type DetailedEventReport struct {
	Items map[string][]EventObjectInfo
}

type EventDeepSummaryReport 

type EventDeepSummaryReport struct {
	Items map[string]EventDeepSummaryReportItem
}

type EventDeepSummaryReportItem 

type EventDeepSummaryReportItem struct {
	Count           int                               `json:"count,omitempty"`
	ByStatus        map[string]EventSummaryReportItem `json:"byStatus,omitempty"`
	ByCategoryKey   map[string]EventSummaryReportItem `json:"byCategoryKey,omitempty"`
	ByCategoryLabel map[string]EventSummaryReportItem `json:"byCategoryLabel,omitempty"`
	BySection       map[string]EventSummaryReportItem `json:"bySection,omitempty"`
	ByAvailability  map[string]EventSummaryReportItem `json:"byAvailability,omitempty"`
	ByChannel       map[string]EventSummaryReportItem `json:"byChannel,omitempty"`
}

type EventObjectInfo 

type EventObjectInfo struct {
	Status               string                    `json:"status,omitempty"`
	Label                string                    `json:"label,omitempty"`
	Labels               Labels                    `json:"labels,omitempty"`
	IDs                  IDs                       `json:"ids,omitempty"`
	CategoryLabel        string                    `json:"categoryLabel,omitempty"`
	CategoryKey          string                    `json:"categoryKey,omitempty"`
	TicketType           string                    `json:"ticketType,omitempty"`
	HoldToken            string                    `json:"holdToken,omitempty"`
	ObjectType           string                    `json:"objectType,omitempty"`
	BookAsAWhole         bool                      `json:"bookAsAWhole"`
	OrderId              string                    `json:"orderId,omitempty"`
	ForSale              bool                      `json:"forSale"`
	Section              string                    `json:"section,omitempty"`
	Entrance             string                    `json:"entrance,omitempty"`
	Capacity             int                       `json:"capacity"`
	NumBooked            int                       `json:"numBooked"`
	NumFree              int                       `json:"numFree"`
	NumHeld              int                       `json:"numHeld"`
	NumSeats             int                       `json:"numSeats"`
	ExtraData            map[string]interface{}    `json:"extraData,omitempty"`
	IsAccessible         bool                      `json:"isAccessible"`
	IsCompanionSeat      bool                      `json:"isCompanionSeat"`
	HasRestrictedView    bool                      `json:"hasRestrictedView"`
	DisplayedObjectType  string                    `json:"displayedObjectType,omitempty"`
	LeftNeighbour        string                    `json:"leftNeighbour,omitempty"`
	RightNeighbour       string                    `json:"rightNeighbour,omitempty"`
	IsAvailable          bool                      `json:"isAvailable"`
	AvailabilityReason   string                    `json:"availabilityReason,omitempty"`
	Channel              string                    `json:"channel,omitempty"`
	DistanceToFocalPoint float64                   `json:"distanceToFocalPoint"`
	Holds                map[string]map[string]int `json:"holds,omitempty"`
	VariableOccupancy    bool                      `json:"variableOccupancy"`
	MinOccupancy         int                       `json:"minOccupancy"`
	MaxOccupancy         int                       `json:"maxOccupancy"`
}

type EventReports 

type EventReports struct {
	Client *req.Client
}

func (*EventReports) ByAvailability 

func (reports *EventReports) ByAvailability(eventKey string) (*DetailedEventReport, error)

func (*EventReports) ByAvailabilityReason 

func (reports *EventReports) ByAvailabilityReason(eventKey string) (*DetailedEventReport, error)

func (*EventReports) ByCategoryKey 

func (reports *EventReports) ByCategoryKey(eventKey string) (*DetailedEventReport, error)

func (*EventReports) ByCategoryLabel 

func (reports *EventReports) ByCategoryLabel(eventKey string) (*DetailedEventReport, error)

func (*EventReports) ByChannel 

func (reports *EventReports) ByChannel(eventKey string) (*DetailedEventReport, error)

func (*EventReports) ByLabel 

func (reports *EventReports) ByLabel(eventKey string) (*DetailedEventReport, error)

func (*EventReports) ByObjectType 

func (reports *EventReports) ByObjectType(eventKey string) (*DetailedEventReport, error)

func (*EventReports) ByOrderId 

func (reports *EventReports) ByOrderId(eventKey string) (*DetailedEventReport, error)

func (*EventReports) BySection 

func (reports *EventReports) BySection(eventKey string) (*DetailedEventReport, error)

func (*EventReports) BySpecificAvailability 

func (reports *EventReports) BySpecificAvailability(eventKey string, availability string) ([]EventObjectInfo, error)

func (*EventReports) BySpecificAvailabilityReason 

func (reports *EventReports) BySpecificAvailabilityReason(eventKey string, reason string) ([]EventObjectInfo, error)

func (*EventReports) BySpecificCategoryKey 

func (reports *EventReports) BySpecificCategoryKey(eventKey string, key string) ([]EventObjectInfo, error)

func (*EventReports) BySpecificCategoryLabel 

func (reports *EventReports) BySpecificCategoryLabel(eventKey string, label string) ([]EventObjectInfo, error)

func (*EventReports) BySpecificChannel 

func (reports *EventReports) BySpecificChannel(eventKey string, channel string) ([]EventObjectInfo, error)

func (*EventReports) BySpecificLabel 

func (reports *EventReports) BySpecificLabel(eventKey string, label string) ([]EventObjectInfo, error)

func (*EventReports) BySpecificObjectType 

func (reports *EventReports) BySpecificObjectType(eventKey string, objectType string) ([]EventObjectInfo, error)

func (*EventReports) BySpecificOrderId 

func (reports *EventReports) BySpecificOrderId(eventKey string, orderId string) ([]EventObjectInfo, error)

func (*EventReports) BySpecificSection 

func (reports *EventReports) BySpecificSection(eventKey string, section string) ([]EventObjectInfo, error)

func (*EventReports) BySpecificStatus 

func (reports *EventReports) BySpecificStatus(eventKey string, status string) ([]EventObjectInfo, error)

func (*EventReports) ByStatus 

func (reports *EventReports) ByStatus(eventKey string) (*DetailedEventReport, error)

func (*EventReports) DeepSummaryByAvailability 

func (reports *EventReports) DeepSummaryByAvailability(eventKey string) (*EventDeepSummaryReport, error)

func (*EventReports) DeepSummaryByAvailabilityReason 

func (reports *EventReports) DeepSummaryByAvailabilityReason(eventKey string) (*EventDeepSummaryReport, error)

func (*EventReports) DeepSummaryByCategoryKey 

func (reports *EventReports) DeepSummaryByCategoryKey(eventKey string) (*EventDeepSummaryReport, error)

func (*EventReports) DeepSummaryByCategoryLabel 

func (reports *EventReports) DeepSummaryByCategoryLabel(eventKey string) (*EventDeepSummaryReport, error)

func (*EventReports) DeepSummaryByChannel 

func (reports *EventReports) DeepSummaryByChannel(eventKey string) (*EventDeepSummaryReport, error)

func (*EventReports) DeepSummaryByObjectType 

func (reports *EventReports) DeepSummaryByObjectType(eventKey string) (*EventDeepSummaryReport, error)

func (*EventReports) DeepSummaryBySection 

func (reports *EventReports) DeepSummaryBySection(eventKey string) (*EventDeepSummaryReport, error)

func (*EventReports) DeepSummaryByStatus 

func (reports *EventReports) DeepSummaryByStatus(eventKey string) (*EventDeepSummaryReport, error)

func (*EventReports) SummaryByAvailability 

func (reports *EventReports) SummaryByAvailability(eventKey string) (*EventSummaryReport, error)

func (*EventReports) SummaryByAvailabilityReason 

func (reports *EventReports) SummaryByAvailabilityReason(eventKey string) (*EventSummaryReport, error)

func (*EventReports) SummaryByCategoryKey 

func (reports *EventReports) SummaryByCategoryKey(eventKey string) (*EventSummaryReport, error)

func (*EventReports) SummaryByCategoryLabel 

func (reports *EventReports) SummaryByCategoryLabel(eventKey string) (*EventSummaryReport, error)

func (*EventReports) SummaryByChannel 

func (reports *EventReports) SummaryByChannel(eventKey string) (*EventSummaryReport, error)

func (*EventReports) SummaryByObjectType 

func (reports *EventReports) SummaryByObjectType(eventKey string) (*EventSummaryReport, error)

func (*EventReports) SummaryBySection 

func (reports *EventReports) SummaryBySection(eventKey string) (*EventSummaryReport, error)

func (*EventReports) SummaryByStatus 

func (reports *EventReports) SummaryByStatus(eventKey string) (*EventSummaryReport, error)

type EventSummaryReport 

type EventSummaryReport struct {
	Items map[string]EventSummaryReportItem
}

type EventSummaryReportItem 

type EventSummaryReportItem struct {
	Count                int            `json:"count,omitempty"`
	ByStatus             map[string]int `json:"byStatus,omitempty"`
	ByCategoryKey        map[string]int `json:"byCategoryKey,omitempty"`
	ByCategoryLabel      map[string]int `json:"byCategoryLabel,omitempty"`
	BySection            map[string]int `json:"bySection,omitempty"`
	ByAvailability       map[string]int `json:"byAvailability,omitempty"`
	ByAvailabilityReason map[string]int `json:"byAvailabilityReason,omitempty"`
	ByChannel            map[string]int `json:"byChannel,omitempty"`
}

type IDs 

type IDs struct {
	Own     string `json:"own,omitempty"`
	Parent  string `json:"parent,omitempty"`
	Section string `json:"section,omitempty"`
}

type LabelAndType 

type LabelAndType struct {
	Label     string `json:"label,omitempty"`
	LabelType string `json:"type,omitempty"`
}

type Labels 

type Labels struct {
	Own     LabelAndType `json:"own,omitempty"`
	Parent  LabelAndType `json:"parent,omitempty"`
	Section string       `json:"section,omitempty"`
}

type Month 

type Month struct {
	Month int `json:"month"`
	Year  int `json:"year"`
}

type UsageByChart 

type UsageByChart struct {
	Chart        UsageChart     `json:"chart"`
	UsageByEvent []UsageByEvent `json:"usageByEvent"`
}

type UsageByEvent 

type UsageByEvent struct {
	Event          UsageEvent `json:"event"`
	NumUsedObjects int        `json:"numUsedObjects"`
}

type UsageChart 

type UsageChart struct {
	Name string `json:"name"`
	Key  string `json:"key"`
}

type UsageDetails 

type UsageDetails struct {
	Workspace    int64          `json:"workspace"`
	UsageByChart []UsageByChart `json:"usageByChart"`
}

type UsageEvent 

type UsageEvent struct {
	Id  int64  `json:"id"`
	Key string `json:"key"`
}

type UsageForObjectV1 

type UsageForObjectV1 struct {
	Object                       string    `json:"object"`
	NumFirstBookings             int       `json:"numFirstBookings"`
	FirstBookingDate             time.Time `json:"firstBookingDate"`
	NumFirstSelections           int       `json:"numFirstSelections"`
	NumFirstBookingsOrSelections int       `json:"numFirstBookingsOrSelections"`
}

type UsageForObjectV2 

type UsageForObjectV2 struct {
	Object         string              `json:"object"`
	NumUsedObjects int                 `json:"numUsedObjects"`
	UsageByReason  map[UsageReason]int `json:"usageByReason"`
}

type UsageReason 

type UsageReason string
const (
	StatusChanged     UsageReason = "STATUS_CHANGED"
	Selected          UsageReason = "SELECTED"
	AssignedToChannel UsageReason = "ASSIGNED_TO_CHANNEL"
)

type UsageReports 

type UsageReports struct {
	Client *req.Client
}

func (*UsageReports) DetailsForEventInMonth 

func (usageReports *UsageReports) DetailsForEventInMonth(eventId int, year int, month int) ([]UsageForObjectV1, []UsageForObjectV2, error)

func (*UsageReports) DetailsForMonth 

func (usageReports *UsageReports) DetailsForMonth(year int, month int) ([]UsageDetails, error)

func (*UsageReports) SummaryForAllMonths 

func (usageReports *UsageReports) SummaryForAllMonths() (*UsageSummaryForAllMonths, error)

type UsageSummaryForAllMonths 

type UsageSummaryForAllMonths struct {
	Usage           []UsageSummaryForMonth `json:"usage"`
	UsageCutoffDate *time.Time             `json:"usageCutoffDate"`
}

type UsageSummaryForMonth 

type UsageSummaryForMonth struct {
	Month          Month `json:"month"`
	NumUsedObjects int   `json:"numUsedObjects"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.